youeduc-sdk-messaging 0.0.0 → 0.5.0

package/dist/contracts/schemas.d.ts

@@ -0,0 +1,570 @@
+/** Schemas empacotados: `bundledSchemas[domínio][slug][versão]` (cópia de `contracts/schemas`). */
+export declare const bundledSchemas: {
+    readonly usuarios: {
+        readonly "usuario-atualizado": {
+            readonly v1: {
+                readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+                readonly title: "usuario.atualizado (v1)";
+                readonly description: "Cadastro alterado. Carrega o cadastro COMPLETO (snapshot) e a lista dos campos alterados.";
+                readonly type: "object";
+                readonly required: readonly ["versao", "ocorrido_em", "usuario", "campos_alterados"];
+                readonly additionalProperties: false;
+                readonly properties: {
+                    readonly versao: {
+                        readonly $ref: "#/$defs/versao";
+                    };
+                    readonly ocorrido_em: {
+                        readonly $ref: "#/$defs/ocorrido_em";
+                    };
+                    readonly usuario: {
+                        readonly $ref: "#/$defs/usuario";
+                    };
+                    readonly campos_alterados: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly uniqueItems: true;
+                        readonly items: {
+                            readonly enum: readonly ["ativo", "idunica", "cpf", "nis", "nome", "nome_civil", "data_nascimento", "genero", "email", "telefone", "nome_pai", "nome_mae", "responsavel_legal_nome", "responsavel_legal_tipo", "endereco_cep", "endereco_uf", "endereco_cidade", "endereco_bairro", "endereco_tipo_logradouro", "endereco_logradouro", "endereco_numero", "raca_cor", "bolsa_familia", "tipo_usuario"];
+                        };
+                        readonly description: "Atributos que mudaram nesta versão (informativo; o estado é o snapshot).";
+                    };
+                };
+                readonly $defs: {
+                    readonly login: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 255;
+                        readonly pattern: "^\\S+$";
+                        readonly description: "YRN do usuário: identificador estável e chave da mensagem no Kafka. Sem espaços; comparação exata (sensível a maiúsculas).";
+                    };
+                    readonly versao: {
+                        readonly type: "integer";
+                        readonly minimum: 1;
+                        readonly description: "Contador monotônico por usuário (continua após login-alterado). O consumidor ignora eventos com versão menor ou igual à que já aplicou.";
+                    };
+                    readonly ocorrido_em: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Quando a mudança aconteceu no sistema de origem (RFC 3339, com fuso).";
+                    };
+                    readonly usuario: {
+                        readonly type: "object";
+                        readonly required: readonly ["login", "ativo", "idunica", "cpf", "nis", "nome", "nome_civil", "data_nascimento", "genero", "email", "telefone", "nome_pai", "nome_mae", "responsavel_legal_nome", "responsavel_legal_tipo", "endereco_cep", "endereco_uf", "endereco_cidade", "endereco_bairro", "endereco_tipo_logradouro", "endereco_logradouro", "endereco_numero", "raca_cor", "bolsa_familia", "tipo_usuario"];
+                        readonly additionalProperties: false;
+                        readonly properties: {
+                            readonly login: {
+                                readonly $ref: "#/$defs/login";
+                            };
+                            readonly ativo: {
+                                readonly type: "boolean";
+                                readonly description: "Situação do cadastro. false após usuario.desativado; true após usuario.reativado.";
+                            };
+                            readonly idunica: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Identificador único entre os sistemas (nem todo usuário tem).";
+                            };
+                            readonly cpf: {
+                                readonly type: readonly ["string", "null"];
+                                readonly pattern: "^[0-9]{11}$";
+                                readonly description: "CPF, 11 dígitos, sem máscara.";
+                            };
+                            readonly nis: {
+                                readonly type: readonly ["string", "null"];
+                                readonly pattern: "^[0-9]{11}$";
+                                readonly description: "NIS/PIS, 11 dígitos, sem máscara.";
+                            };
+                            readonly nome: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Nome social, quando houver; senão o nome civil.";
+                            };
+                            readonly nome_civil: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Nome civil (de registro); nunca o nome social.";
+                            };
+                            readonly data_nascimento: {
+                                readonly type: readonly ["string", "null"];
+                                readonly format: "date";
+                                readonly description: "AAAA-MM-DD.";
+                            };
+                            readonly genero: {
+                                readonly enum: readonly ["MASCULINO", "FEMININO", "OUTROS", null];
+                                readonly description: "Gênero.";
+                            };
+                            readonly email: {
+                                readonly type: readonly ["string", "null"];
+                                readonly format: "email";
+                                readonly maxLength: 254;
+                                readonly description: "E-mail.";
+                            };
+                            readonly telefone: {
+                                readonly type: readonly ["string", "null"];
+                                readonly pattern: "^[0-9]{10,11}$";
+                                readonly description: "Só dígitos, com DDD (10 ou 11 dígitos).";
+                            };
+                            readonly nome_pai: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Nome do pai.";
+                            };
+                            readonly nome_mae: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Nome da mãe.";
+                            };
+                            readonly responsavel_legal_nome: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Nome do responsável legal.";
+                            };
+                            readonly responsavel_legal_tipo: {
+                                readonly enum: readonly ["PAI", "MAE", "OUTROS", null];
+                                readonly description: "Tipo do responsável legal.";
+                            };
+                            readonly endereco_cep: {
+                                readonly type: readonly ["string", "null"];
+                                readonly pattern: "^[0-9]{8}$";
+                                readonly description: "CEP, 8 dígitos, sem máscara.";
+                            };
+                            readonly endereco_uf: {
+                                readonly enum: readonly ["AC", "AL", "AP", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RJ", "RN", "RS", "RO", "RR", "SC", "SP", "SE", "TO", null];
+                                readonly description: "Sigla da UF.";
+                            };
+                            readonly endereco_cidade: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Cidade.";
+                            };
+                            readonly endereco_bairro: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Bairro.";
+                            };
+                            readonly endereco_tipo_logradouro: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Tipo do logradouro (Rua, Avenida...).";
+                            };
+                            readonly endereco_logradouro: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Logradouro.";
+                            };
+                            readonly endereco_numero: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 20;
+                                readonly description: "Número (texto: aceita 'S/N', '12A').";
+                            };
+                            readonly raca_cor: {
+                                readonly enum: readonly ["BRANCA", "PRETA", "PARDA", "AMARELA", "INDIGENA", null];
+                                readonly description: "Raça/cor (dado sensível, LGPD art. 11).";
+                            };
+                            readonly bolsa_familia: {
+                                readonly type: readonly ["boolean", "null"];
+                                readonly description: "Beneficiário do Bolsa Família (dado sensível).";
+                            };
+                            readonly tipo_usuario: {
+                                readonly enum: readonly ["PROFESSOR", "ALUNO", "OPERACIONAL", null];
+                                readonly description: "Tipo do usuário (um único tipo por usuário).";
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        readonly "usuario-criado": {
+            readonly v1: {
+                readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+                readonly title: "usuario.criado (v1)";
+                readonly description: "Usuário criado no sistema de origem. Carrega o cadastro completo.";
+                readonly type: "object";
+                readonly required: readonly ["versao", "ocorrido_em", "usuario"];
+                readonly additionalProperties: false;
+                readonly properties: {
+                    readonly versao: {
+                        readonly $ref: "#/$defs/versao";
+                    };
+                    readonly ocorrido_em: {
+                        readonly $ref: "#/$defs/ocorrido_em";
+                    };
+                    readonly usuario: {
+                        readonly $ref: "#/$defs/usuario";
+                    };
+                };
+                readonly $defs: {
+                    readonly login: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 255;
+                        readonly pattern: "^\\S+$";
+                        readonly description: "YRN do usuário: identificador estável e chave da mensagem no Kafka. Sem espaços; comparação exata (sensível a maiúsculas).";
+                    };
+                    readonly versao: {
+                        readonly type: "integer";
+                        readonly minimum: 1;
+                        readonly description: "Contador monotônico por usuário (continua após login-alterado). O consumidor ignora eventos com versão menor ou igual à que já aplicou.";
+                    };
+                    readonly ocorrido_em: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Quando a mudança aconteceu no sistema de origem (RFC 3339, com fuso).";
+                    };
+                    readonly usuario: {
+                        readonly type: "object";
+                        readonly required: readonly ["login", "ativo", "idunica", "cpf", "nis", "nome", "nome_civil", "data_nascimento", "genero", "email", "telefone", "nome_pai", "nome_mae", "responsavel_legal_nome", "responsavel_legal_tipo", "endereco_cep", "endereco_uf", "endereco_cidade", "endereco_bairro", "endereco_tipo_logradouro", "endereco_logradouro", "endereco_numero", "raca_cor", "bolsa_familia", "tipo_usuario"];
+                        readonly additionalProperties: false;
+                        readonly properties: {
+                            readonly login: {
+                                readonly $ref: "#/$defs/login";
+                            };
+                            readonly ativo: {
+                                readonly type: "boolean";
+                                readonly description: "Situação do cadastro. false após usuario.desativado; true após usuario.reativado.";
+                            };
+                            readonly idunica: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Identificador único entre os sistemas (nem todo usuário tem).";
+                            };
+                            readonly cpf: {
+                                readonly type: readonly ["string", "null"];
+                                readonly pattern: "^[0-9]{11}$";
+                                readonly description: "CPF, 11 dígitos, sem máscara.";
+                            };
+                            readonly nis: {
+                                readonly type: readonly ["string", "null"];
+                                readonly pattern: "^[0-9]{11}$";
+                                readonly description: "NIS/PIS, 11 dígitos, sem máscara.";
+                            };
+                            readonly nome: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Nome social, quando houver; senão o nome civil.";
+                            };
+                            readonly nome_civil: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Nome civil (de registro); nunca o nome social.";
+                            };
+                            readonly data_nascimento: {
+                                readonly type: readonly ["string", "null"];
+                                readonly format: "date";
+                                readonly description: "AAAA-MM-DD.";
+                            };
+                            readonly genero: {
+                                readonly enum: readonly ["MASCULINO", "FEMININO", "OUTROS", null];
+                                readonly description: "Gênero.";
+                            };
+                            readonly email: {
+                                readonly type: readonly ["string", "null"];
+                                readonly format: "email";
+                                readonly maxLength: 254;
+                                readonly description: "E-mail.";
+                            };
+                            readonly telefone: {
+                                readonly type: readonly ["string", "null"];
+                                readonly pattern: "^[0-9]{10,11}$";
+                                readonly description: "Só dígitos, com DDD (10 ou 11 dígitos).";
+                            };
+                            readonly nome_pai: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Nome do pai.";
+                            };
+                            readonly nome_mae: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Nome da mãe.";
+                            };
+                            readonly responsavel_legal_nome: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Nome do responsável legal.";
+                            };
+                            readonly responsavel_legal_tipo: {
+                                readonly enum: readonly ["PAI", "MAE", "OUTROS", null];
+                                readonly description: "Tipo do responsável legal.";
+                            };
+                            readonly endereco_cep: {
+                                readonly type: readonly ["string", "null"];
+                                readonly pattern: "^[0-9]{8}$";
+                                readonly description: "CEP, 8 dígitos, sem máscara.";
+                            };
+                            readonly endereco_uf: {
+                                readonly enum: readonly ["AC", "AL", "AP", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RJ", "RN", "RS", "RO", "RR", "SC", "SP", "SE", "TO", null];
+                                readonly description: "Sigla da UF.";
+                            };
+                            readonly endereco_cidade: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Cidade.";
+                            };
+                            readonly endereco_bairro: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Bairro.";
+                            };
+                            readonly endereco_tipo_logradouro: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Tipo do logradouro (Rua, Avenida...).";
+                            };
+                            readonly endereco_logradouro: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 255;
+                                readonly description: "Logradouro.";
+                            };
+                            readonly endereco_numero: {
+                                readonly type: readonly ["string", "null"];
+                                readonly minLength: 1;
+                                readonly maxLength: 20;
+                                readonly description: "Número (texto: aceita 'S/N', '12A').";
+                            };
+                            readonly raca_cor: {
+                                readonly enum: readonly ["BRANCA", "PRETA", "PARDA", "AMARELA", "INDIGENA", null];
+                                readonly description: "Raça/cor (dado sensível, LGPD art. 11).";
+                            };
+                            readonly bolsa_familia: {
+                                readonly type: readonly ["boolean", "null"];
+                                readonly description: "Beneficiário do Bolsa Família (dado sensível).";
+                            };
+                            readonly tipo_usuario: {
+                                readonly enum: readonly ["PROFESSOR", "ALUNO", "OPERACIONAL", null];
+                                readonly description: "Tipo do usuário (um único tipo por usuário).";
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        readonly "usuario-desativado": {
+            readonly v1: {
+                readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+                readonly title: "usuario.desativado (v1)";
+                readonly description: "Cadastro inativado (exclusão lógica). Os dados continuam existindo.";
+                readonly type: "object";
+                readonly required: readonly ["versao", "ocorrido_em", "login"];
+                readonly additionalProperties: false;
+                readonly properties: {
+                    readonly versao: {
+                        readonly $ref: "#/$defs/versao";
+                    };
+                    readonly ocorrido_em: {
+                        readonly $ref: "#/$defs/ocorrido_em";
+                    };
+                    readonly login: {
+                        readonly $ref: "#/$defs/login";
+                    };
+                };
+                readonly $defs: {
+                    readonly login: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 255;
+                        readonly pattern: "^\\S+$";
+                        readonly description: "YRN do usuário: identificador estável e chave da mensagem no Kafka. Sem espaços; comparação exata (sensível a maiúsculas).";
+                    };
+                    readonly versao: {
+                        readonly type: "integer";
+                        readonly minimum: 1;
+                        readonly description: "Contador monotônico por usuário (continua após login-alterado). O consumidor ignora eventos com versão menor ou igual à que já aplicou.";
+                    };
+                    readonly ocorrido_em: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Quando a mudança aconteceu no sistema de origem (RFC 3339, com fuso).";
+                    };
+                };
+            };
+        };
+        readonly "usuario-login-alterado": {
+            readonly v1: {
+                readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+                readonly title: "usuario.login-alterado (v1)";
+                readonly description: "O login (YRN do usuário) mudou. Publicado com a chave do login ANTERIOR; eventos seguintes usam o novo.";
+                readonly type: "object";
+                readonly required: readonly ["versao", "ocorrido_em", "login_anterior", "login_novo"];
+                readonly additionalProperties: false;
+                readonly properties: {
+                    readonly versao: {
+                        readonly $ref: "#/$defs/versao";
+                    };
+                    readonly ocorrido_em: {
+                        readonly $ref: "#/$defs/ocorrido_em";
+                    };
+                    readonly login_anterior: {
+                        readonly $ref: "#/$defs/login";
+                    };
+                    readonly login_novo: {
+                        readonly $ref: "#/$defs/login";
+                    };
+                };
+                readonly $defs: {
+                    readonly login: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 255;
+                        readonly pattern: "^\\S+$";
+                        readonly description: "YRN do usuário: identificador estável e chave da mensagem no Kafka. Sem espaços; comparação exata (sensível a maiúsculas).";
+                    };
+                    readonly versao: {
+                        readonly type: "integer";
+                        readonly minimum: 1;
+                        readonly description: "Contador monotônico por usuário (continua após login-alterado). O consumidor ignora eventos com versão menor ou igual à que já aplicou.";
+                    };
+                    readonly ocorrido_em: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Quando a mudança aconteceu no sistema de origem (RFC 3339, com fuso).";
+                    };
+                };
+            };
+        };
+        readonly "usuario-mesclado": {
+            readonly v1: {
+                readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+                readonly title: "usuario.mesclado (v1)";
+                readonly description: "Dois cadastros do mesmo usuário foram unificados: login_origem deixa de existir e passa a ser login_destino. Publicado com a chave de login_origem.";
+                readonly type: "object";
+                readonly required: readonly ["versao", "ocorrido_em", "login_origem", "login_destino"];
+                readonly additionalProperties: false;
+                readonly properties: {
+                    readonly versao: {
+                        readonly $ref: "#/$defs/versao";
+                    };
+                    readonly ocorrido_em: {
+                        readonly $ref: "#/$defs/ocorrido_em";
+                    };
+                    readonly login_origem: {
+                        readonly $ref: "#/$defs/login";
+                    };
+                    readonly login_destino: {
+                        readonly $ref: "#/$defs/login";
+                    };
+                };
+                readonly $defs: {
+                    readonly login: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 255;
+                        readonly pattern: "^\\S+$";
+                        readonly description: "YRN do usuário: identificador estável e chave da mensagem no Kafka. Sem espaços; comparação exata (sensível a maiúsculas).";
+                    };
+                    readonly versao: {
+                        readonly type: "integer";
+                        readonly minimum: 1;
+                        readonly description: "Contador monotônico por usuário (continua após login-alterado). O consumidor ignora eventos com versão menor ou igual à que já aplicou.";
+                    };
+                    readonly ocorrido_em: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Quando a mudança aconteceu no sistema de origem (RFC 3339, com fuso).";
+                    };
+                };
+            };
+        };
+        readonly "usuario-reativado": {
+            readonly v1: {
+                readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+                readonly title: "usuario.reativado (v1)";
+                readonly description: "Cadastro inativado voltou a ficar ativo.";
+                readonly type: "object";
+                readonly required: readonly ["versao", "ocorrido_em", "login"];
+                readonly additionalProperties: false;
+                readonly properties: {
+                    readonly versao: {
+                        readonly $ref: "#/$defs/versao";
+                    };
+                    readonly ocorrido_em: {
+                        readonly $ref: "#/$defs/ocorrido_em";
+                    };
+                    readonly login: {
+                        readonly $ref: "#/$defs/login";
+                    };
+                };
+                readonly $defs: {
+                    readonly login: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 255;
+                        readonly pattern: "^\\S+$";
+                        readonly description: "YRN do usuário: identificador estável e chave da mensagem no Kafka. Sem espaços; comparação exata (sensível a maiúsculas).";
+                    };
+                    readonly versao: {
+                        readonly type: "integer";
+                        readonly minimum: 1;
+                        readonly description: "Contador monotônico por usuário (continua após login-alterado). O consumidor ignora eventos com versão menor ou igual à que já aplicou.";
+                    };
+                    readonly ocorrido_em: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Quando a mudança aconteceu no sistema de origem (RFC 3339, com fuso).";
+                    };
+                };
+            };
+        };
+        readonly "usuario-removido": {
+            readonly v1: {
+                readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+                readonly title: "usuario.removido (v1)";
+                readonly description: "Remoção definitiva do cadastro no sistema de origem.";
+                readonly type: "object";
+                readonly required: readonly ["versao", "ocorrido_em", "login"];
+                readonly additionalProperties: false;
+                readonly properties: {
+                    readonly versao: {
+                        readonly $ref: "#/$defs/versao";
+                    };
+                    readonly ocorrido_em: {
+                        readonly $ref: "#/$defs/ocorrido_em";
+                    };
+                    readonly login: {
+                        readonly $ref: "#/$defs/login";
+                    };
+                };
+                readonly $defs: {
+                    readonly login: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 255;
+                        readonly pattern: "^\\S+$";
+                        readonly description: "YRN do usuário: identificador estável e chave da mensagem no Kafka. Sem espaços; comparação exata (sensível a maiúsculas).";
+                    };
+                    readonly versao: {
+                        readonly type: "integer";
+                        readonly minimum: 1;
+                        readonly description: "Contador monotônico por usuário (continua após login-alterado). O consumidor ignora eventos com versão menor ou igual à que já aplicou.";
+                    };
+                    readonly ocorrido_em: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Quando a mudança aconteceu no sistema de origem (RFC 3339, com fuso).";
+                    };
+                };
+            };
+        };
+    };
+};