103 lines
4.0 KiB
TypeScript
Executable File
103 lines
4.0 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 UserMultiSelectDoc: VitruvioComponentDoc = {
|
|
component: "UserMultiSelect",
|
|
summary: "Documentacao do componente UserMultiSelect mapeada a partir de exemplos reais de XML.",
|
|
status: "draft",
|
|
context: {
|
|
module: "Vitruvio",
|
|
family: "EntradaDeDados",
|
|
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
|
|
occurrences: { total: 35, paineis: 6, processos: 29 }
|
|
},
|
|
sections: {
|
|
purpose: "Componente de captura e edicao de dados em formularios e filtros.",
|
|
basicUsage: "Usar UserMultiSelect no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
|
|
properties: [
|
|
"caption",
|
|
"description",
|
|
"enabled",
|
|
"expandRatio",
|
|
"height",
|
|
"id",
|
|
"multivalue",
|
|
"required",
|
|
"type",
|
|
"width"
|
|
],
|
|
propertyValues: {
|
|
"caption": ["", "Adicione Usuários irão receber a notificação em cópia do e-mail", "Adicione Usuários para receberem notificação por e-mail", "Destinatários", "Enviar relatório de divergências para"],
|
|
"description": ["Adicione Usuários irão receber a notificação em cópia do e-mail", "Adicione Usuários para receberem notificação por e-mail"],
|
|
"enabled": ["false"],
|
|
"expandRatio": ["1.0"],
|
|
"height": ["100%", "300px"],
|
|
"id": ["destinatariosExpiracao", "divergenciaCorredorDest", "divergencias1ConfDest", "divergenciasCorredor2ConfDest", "divergenciasItens2ConfDest", "notificarRelatorioUser", "umsCopiarUsuarios", "umsNotificarUsuarios"],
|
|
"multivalue": ["true"],
|
|
"required": ["true"],
|
|
"type": ["string"],
|
|
"width": ["100%"]
|
|
},
|
|
propertyValueTypes: {
|
|
"caption": "text",
|
|
"description": "text",
|
|
"enabled": "boolean",
|
|
"expandRatio": "numeric",
|
|
"height": "numeric",
|
|
"id": "enum",
|
|
"multivalue": "boolean",
|
|
"required": "boolean",
|
|
"type": "enum",
|
|
"width": "numeric"
|
|
},
|
|
events: [
|
|
|
|
],
|
|
examples: [
|
|
"Vitruvio/Paineis/Cadastro de Contagem - Produtos e Agenda.xml:2899",
|
|
"Vitruvio/Paineis/Cadastro de Contagem - Produtos e Agenda.xml:2937",
|
|
"Vitruvio/Paineis/configuracao_ws.xml:585",
|
|
"Vitruvio/Paineis/configuracao_ws.xml:589",
|
|
"Vitruvio/Paineis/Configurações WS Senior.xml:585",
|
|
"Vitruvio/Paineis/Configurações WS Senior.xml:589",
|
|
"Vitruvio/Processos/Ruptura - Produtos Sem Giro/form_web_desktop.xml:232",
|
|
"Vitruvio/Processos/Ruptura - Produtos Sem Giro/form_web_desktop.xml:278",
|
|
"Vitruvio/Processos/Ruptura - Produtos Sem Giro/form_web_desktop.xml:333",
|
|
"Vitruvio/Processos/Ruptura - Produtos Sem Giro/form_web_desktop.xml:380",
|
|
"Vitruvio/Processos/Ruptura - Produtos Sem Giro/form_web_desktop.xml:431",
|
|
"Vitruvio/Processos/Auditoria Troca de Placa Meu Verdemar/form_web_desktop.xml:244"
|
|
],
|
|
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 UserMultiSelectDoc;
|