victor
103 lines
3.6 KiB
TypeScript
Executable File
103 lines
3.6 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 PasswordFieldDoc: VitruvioComponentDoc = {
|
|
component: "PasswordField",
|
|
summary: "Documentacao do componente PasswordField mapeada a partir de exemplos reais de XML.",
|
|
status: "draft",
|
|
context: {
|
|
module: "Vitruvio",
|
|
family: "EntradaDeDados",
|
|
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
|
|
occurrences: { total: 17, paineis: 10, processos: 7 }
|
|
},
|
|
sections: {
|
|
purpose: "Componente de captura e edicao de dados em formularios e filtros.",
|
|
basicUsage: "Usar PasswordField no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
|
|
properties: [
|
|
"align",
|
|
"caption",
|
|
"height",
|
|
"id",
|
|
"immediate",
|
|
"keyCode",
|
|
"required",
|
|
"type",
|
|
"visible",
|
|
"width"
|
|
],
|
|
propertyValues: {
|
|
"align": ["MIDDLE_CENTER", "TOP_CENTER", "TOP_LEFT", "TOP_RIGHT"],
|
|
"caption": ["Confirmar Senha", "Nova Senha", "Senha", "Senha do responsável"],
|
|
"height": ["30px"],
|
|
"id": ["confirmaSenha", "novaSenha", "passField", "pwfSenha", "pwResp", "senha"],
|
|
"immediate": ["true"],
|
|
"keyCode": ["ENTER"],
|
|
"required": ["false"],
|
|
"type": ["string"],
|
|
"visible": ["false"],
|
|
"width": ["100%", "150px"]
|
|
},
|
|
propertyValueTypes: {
|
|
"align": "enum",
|
|
"caption": "text",
|
|
"height": "numeric",
|
|
"id": "enum",
|
|
"immediate": "boolean",
|
|
"keyCode": "enum",
|
|
"required": "boolean",
|
|
"type": "enum",
|
|
"visible": "boolean",
|
|
"width": "numeric"
|
|
},
|
|
events: [
|
|
|
|
],
|
|
examples: [
|
|
"Vitruvio/Paineis/Cadastro de Usuários.xml:675",
|
|
"Vitruvio/Paineis/Cadastro de Usuários.xml:718",
|
|
"Vitruvio/Paineis/Notificação - Mobile.xml:43",
|
|
"Vitruvio/Paineis/Gestão de acesso - Região.xml:1208",
|
|
"Vitruvio/Paineis/Voucher Panela.xml:2281",
|
|
"Vitruvio/Paineis/Visualização de Funcionarios CD.xml:594",
|
|
"Vitruvio/Paineis/Prioridade - Processos expedição.xml:1011",
|
|
"Vitruvio/Paineis/voucher panela - TESTE.xml:2171",
|
|
"Vitruvio/Paineis/Cadastro de usuários para agendamento de fornecedores.xml:608",
|
|
"Vitruvio/Paineis/Cadastro de usuários para agendamento de fornecedores.xml:651",
|
|
"Vitruvio/Processos/Reforço Promocional/form_web_desktop.xml:1276",
|
|
"Vitruvio/Processos/Devolução de Clientes Via Voucher/form_web_desktop.xml:2331"
|
|
],
|
|
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 PasswordFieldDoc;
|