victor
97 lines
3.8 KiB
TypeScript
Executable File
97 lines
3.8 KiB
TypeScript
Executable File
export type VitruvioComponentDoc = {
|
|
component: string;
|
|
summary: string;
|
|
status: "draft" | "review" | "ready";
|
|
context: {
|
|
module: string;
|
|
family: string;
|
|
mappedFrom: string[];
|
|
occurrences: {
|
|
total: number;
|
|
paineis: number;
|
|
processos: number;
|
|
};
|
|
};
|
|
sections: {
|
|
purpose: string;
|
|
basicUsage: string;
|
|
properties: string[];
|
|
propertyValues: { [property: string]: string[] };
|
|
propertyValueTypes: { [property: string]: "boolean" | "enum" | "numeric" | "text" | "mixed" };
|
|
events: string[];
|
|
examples: string[];
|
|
notes: string[];
|
|
};
|
|
};
|
|
|
|
const UserPropertyFieldDoc: VitruvioComponentDoc = {
|
|
component: "UserPropertyField",
|
|
summary: "Documentacao do componente UserPropertyField mapeada a partir de exemplos reais de XML.",
|
|
status: "draft",
|
|
context: {
|
|
module: "Vitruvio",
|
|
family: "EntradaDeDados",
|
|
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
|
|
occurrences: { total: 13, paineis: 0, processos: 13 }
|
|
},
|
|
sections: {
|
|
purpose: "Componente de captura e edicao de dados em formularios e filtros.",
|
|
basicUsage: "Usar UserPropertyField no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
|
|
properties: [
|
|
"caption",
|
|
"expandRatio",
|
|
"id",
|
|
"modelMember",
|
|
"propertyKey",
|
|
"readOnly",
|
|
"type",
|
|
"width"
|
|
],
|
|
propertyValues: {
|
|
"caption": ["Função", "Loja", "Matrícula", "Setor"],
|
|
"expandRatio": ["0.3", "0.4", "0.5"],
|
|
"id": ["analistaFuncao", "analistaLoja", "funcao", "loja", "loja_func", "matricula", "setor_func"],
|
|
"modelMember": ["false"],
|
|
"propertyKey": ["cargo", "loja", "matricula", "setor"],
|
|
"readOnly": ["true"],
|
|
"type": ["string"],
|
|
"width": ["100%"]
|
|
},
|
|
propertyValueTypes: {
|
|
"caption": "text",
|
|
"expandRatio": "numeric",
|
|
"id": "enum",
|
|
"modelMember": "boolean",
|
|
"propertyKey": "enum",
|
|
"readOnly": "boolean",
|
|
"type": "enum",
|
|
"width": "numeric"
|
|
},
|
|
events: [
|
|
|
|
],
|
|
examples: [
|
|
"Vitruvio/Processos/Registro de Observações de Cliente/form_web_desktop.xml:17",
|
|
"Vitruvio/Processos/Registro de Observações de Cliente/form_web_desktop.xml:20",
|
|
"Vitruvio/Processos/Registro de Observações de Cliente/form_web_desktop.xml:23",
|
|
"Vitruvio/Processos/Registro de Observações de Cliente/form_web_desktop.xml:1249",
|
|
"Vitruvio/Processos/Registro de Observações de Cliente/form_web_desktop.xml:1252",
|
|
"Vitruvio/Processos/Registro de Observações de Cliente/form_web_desktop.xml:1626",
|
|
"Vitruvio/Processos/Registro de Observações de Cliente/form_web_desktop.xml:1629",
|
|
"Vitruvio/Processos/Registro de Observações de Cliente/form_web_desktop.xml:1900",
|
|
"Vitruvio/Processos/Registro de Observações de Cliente/form_web_desktop.xml:1903",
|
|
"Vitruvio/Processos/Registro de Observações de Cliente/form_web_desktop.xml:2196",
|
|
"Vitruvio/Processos/Registro de Observações de Cliente/form_web_desktop.xml:2199",
|
|
"Vitruvio/Processos/Registro de Observações de Cliente/form_web_desktop.xml:2326"
|
|
],
|
|
notes: [
|
|
"Mapeamento automatico baseado em uso observado nos XMLs de paineis e processos.",
|
|
"Valores ruidosos/textos muito longos sao filtrados para facilitar consulta.",
|
|
"propertyValueTypes classifica o perfil observado da propriedade (boolean, enum, numeric, text ou mixed).",
|
|
"Validar com documentacao oficial do Vitruvio quando houver divergencia funcional."
|
|
]
|
|
}
|
|
};
|
|
|
|
export default UserPropertyFieldDoc;
|