Files

76 lines
3.3 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 ComplexComponentDoc: VitruvioComponentDoc = {
component: "ComplexComponent",
summary: "Documentacao do componente ComplexComponent mapeada a partir de exemplos reais de XML.",
status: "draft",
context: {
module: "Vitruvio",
family: "Infraestrutura",
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
occurrences: { total: 917, paineis: 0, processos: 917 }
},
sections: {
purpose: "Componente de suporte para configuracao, integracao e comportamento da tela.",
basicUsage: "Usar ComplexComponent no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
properties: [
"ref"
],
propertyValues: {
"ref": ["acompanhamentoAuds", "AnexosEcommerce", "AnexosEcommerceProdComposto", "baseAbertura", "baseAberturaManutencao", "baseAberturaSuporte", "baseAtender", "baseCadastroComprador", "baseCompradorBalanca", "baseDados", "baseDadosPagamentos", "baseObs", "baseReprovaSolicitacao", "Caracteristica", "Caracteristica1", "__TRUNCADO__"]
},
propertyValueTypes: {
"ref": "text"
},
events: [
],
examples: [
"Vitruvio/Processos/Classificação de Notas Fiscais/form_web_desktop.xml:1053",
"Vitruvio/Processos/Classificação de Notas Fiscais/form_web_desktop.xml:1160",
"Vitruvio/Processos/Classificação de Notas Fiscais/form_web_desktop.xml:1561",
"Vitruvio/Processos/Classificação de Notas Fiscais/form_web_desktop.xml:2537",
"Vitruvio/Processos/Classificação de Notas Fiscais/form_web_desktop.xml:4826",
"Vitruvio/Processos/Classificação de Notas Fiscais/form_web_desktop.xml:5002",
"Vitruvio/Processos/Classificação de Notas Fiscais/form_web_desktop.xml:5674",
"Vitruvio/Processos/Classificação de Notas Fiscais/form_web_desktop.xml:5690",
"Vitruvio/Processos/Classificação de Notas Fiscais/form_web_desktop.xml:6211",
"Vitruvio/Processos/Classificação de Notas Fiscais/form_web_desktop.xml:7021",
"Vitruvio/Processos/Classificação de Notas Fiscais/form_web_desktop.xml:8117",
"Vitruvio/Processos/Classificação de Notas Fiscais/form_web_desktop.xml:9168"
],
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 ComplexComponentDoc;