Files

80 lines
2.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 ProcessInstanceIdFieldDoc: VitruvioComponentDoc = {
component: "ProcessInstanceIdField",
summary: "Documentacao do componente ProcessInstanceIdField mapeada a partir de exemplos reais de XML.",
status: "draft",
context: {
module: "Vitruvio",
family: "EntradaDeDados",
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
occurrences: { total: 1, paineis: 0, processos: 1 }
},
sections: {
purpose: "Componente de captura e edicao de dados em formularios e filtros.",
basicUsage: "Usar ProcessInstanceIdField no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
properties: [
"caption",
"id",
"modelMember",
"readOnly",
"type",
"value"
],
propertyValues: {
"caption": ["Código"],
"id": ["processInstanceId"],
"modelMember": ["false"],
"readOnly": ["true"],
"type": ["string"],
"value": ["businessKey"]
},
propertyValueTypes: {
"caption": "text",
"id": "enum",
"modelMember": "boolean",
"readOnly": "boolean",
"type": "enum",
"value": "enum"
},
events: [
],
examples: [
"Vitruvio/Processos/Registro de Observações de Cliente/form_web_desktop.xml:404"
],
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 ProcessInstanceIdFieldDoc;