Adicionado documentação dos componentes de Vitruvio.

2026-05-14 11:32:24 -03:00
parent dbe669d03e
commit 7410422af7
79 changed files with 8180 additions and 0 deletions
@@ -0,0 +1,102 @@
+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 RoleComboBoxDoc: VitruvioComponentDoc = {
+   component: "RoleComboBox",
+   summary: "Documentacao do componente RoleComboBox mapeada a partir de exemplos reais de XML.",
+   status: "draft",
+   context: {
+      module: "Vitruvio",
+      family: "EntradaDeDados",
+      mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
+      occurrences: { total: 75, paineis: 49, processos: 26 }
+   },
+   sections: {
+      purpose: "Componente de captura e edicao de dados em formularios e filtros.",
+      basicUsage: "Usar RoleComboBox no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
+      properties: [
+         "align",
+         "caption",
+         "description",
+         "expandRatio",
+         "height",
+         "id",
+         "required",
+         "type",
+         "visible",
+         "width"
+      ],
+      propertyValues: {
+         "align": ["TOP_LEFT"],
+         "caption": ["Dispara Alerta m3 para o Grupo", "Dispara Alerta não execução para o Grupo", "Executor", "Grupo", "Grupo abertura", "Grupo Aprovador", "Grupo Aprovação", "Grupo executor", "Grupo para Receber email de processamento", "Grupo para Receber Emails", "Grupo Permissão", "Grupo Responsável", "Grupo responsável"],
+         "description": ["Grupo de usuários que poderá realizar o evento", "Selecione o grupo que irá realizar a atividade", "Selecione o grupo que irá realizar a tarefa", "Selecione o grupo que poderá abrir e agendar os checklist's", "Selecione o grupo responsável pela tarefa"],
+         "expandRatio": ["0.2", "0.3", "0.35", "0.4", "1", "1.0"],
+         "height": ["100%"],
+         "id": ["destinatariosGrp", "grupo", "grupo_responsavel", "grupoAprovacao", "grupoexecutar", "grupoExpira", "grupogerar", "grupoPermissao", "gruporesp", "grupoResponsavel", "grupoResponsavel2Conf", "grupoResponsavel3Conf", "grupoResponsavel4Conf", "grupoResponsavelMalote", "grupos_candidatos", "__TRUNCADO__"],
+         "required": ["false", "true"],
+         "type": ["string"],
+         "visible": ["false", "true"],
+         "width": ["100%", "20%"]
+      },
+      propertyValueTypes: {
+         "align": "enum",
+         "caption": "text",
+         "description": "text",
+         "expandRatio": "numeric",
+         "height": "numeric",
+         "id": "mixed",
+         "required": "boolean",
+         "type": "enum",
+         "visible": "boolean",
+         "width": "numeric"
+      },
+      events: [
+
+      ],
+      examples: [
+         "Vitruvio/Paineis/3 - Cadastro de Checklist - Seg-Trabalho.xml:664",
+         "Vitruvio/Paineis/3 - Cadastro de Checklist - Seg-Trabalho.xml:3088",
+         "Vitruvio/Paineis/3 - Cadastro de Checklist - Seg-Trabalho.xml:3183",
+         "Vitruvio/Paineis/3 - Cadastro de Checklist - Seg-Trabalho.xml:3304",
+         "Vitruvio/Paineis/3 - Cadastro de Checklist - Seg-Trabalho.xml:3846",
+         "Vitruvio/Paineis/Compra de Utensílios - Cadastro de Liberação.xml:591",
+         "Vitruvio/Paineis/13 - Contratos - Cadastro de Eventos.xml:733",
+         "Vitruvio/Paineis/13 - Contratos - Cadastro de Eventos.xml:755",
+         "Vitruvio/Paineis/Cadastro de Contagem - Produtos e Agenda.xml:2374",
+         "Vitruvio/Paineis/Cadastro de Geração de Informações - Abastecimento.xml:1583",
+         "Vitruvio/Paineis/Agendamento - Auditoria da Seg. Trabalho.xml:835",
+         "Vitruvio/Paineis/3 - Cadastro de Checklist - TI.xml:795"
+      ],
+      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 RoleComboBoxDoc;