Files

85 lines
3.5 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 SignaturePadFieldDoc: VitruvioComponentDoc = {
component: "SignaturePadField",
summary: "Documentacao do componente SignaturePadField mapeada a partir de exemplos reais de XML.",
status: "draft",
context: {
module: "Vitruvio",
family: "EntradaDeDados",
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
occurrences: { total: 37, paineis: 0, processos: 37 }
},
sections: {
purpose: "Componente de captura e edicao de dados em formularios e filtros.",
basicUsage: "Usar SignaturePadField no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
properties: [
"caption",
"id",
"required",
"visible"
],
propertyValues: {
"caption": ["Assinatura", "Assinatura Colaborador", "Assinatura Fiscal de Loja", "Assinatura Gerente de Loja", "Assinatura Motorista", "Fiscal de Loja", "Responsável", "Responsável Pelo Recolhimento", "Responsável que Acompanhou", "Usuário executor"],
"id": ["assinatura", "assinatura_fiscal", "assinatura_Fiscal", "assinatura_gerente", "assinatura_motorista", "assinaturaAuditor", "assinaturaColaborador", "assinaturaFiscal", "assinaturaResponsavel"],
"required": ["false", "true"],
"visible": ["false", "true"]
},
propertyValueTypes: {
"caption": "text",
"id": "enum",
"required": "boolean",
"visible": "boolean"
},
events: [
],
examples: [
"Vitruvio/Processos/Romaneio Eletrônico/form_web_mobile.xml:358",
"Vitruvio/Processos/Checklist Manutenção/form_web_mobile.xml:660",
"Vitruvio/Processos/Checklist Manutenção/form_web_mobile.xml:661",
"Vitruvio/Processos/Checklist Manutenção/form_web_mobile.xml:2011",
"Vitruvio/Processos/Checklist Manutenção/form_web_mobile.xml:2013",
"Vitruvio/Processos/Devolução de Produtos Impróprios/form_web_mobile.xml:1653",
"Vitruvio/Processos/Checklist Fab. Própria/form_web_mobile.xml:707",
"Vitruvio/Processos/Checklist Fab. Própria/form_web_mobile.xml:709",
"Vitruvio/Processos/Checklist Fab. Própria/form_web_mobile.xml:2140",
"Vitruvio/Processos/Checklist Fab. Própria/form_web_mobile.xml:2142",
"Vitruvio/Processos/Checklist/form_web_mobile.xml:1193",
"Vitruvio/Processos/Checklist/form_web_mobile.xml:1194"
],
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 SignaturePadFieldDoc;