@muni-sanfer/types-gestor-documental 0.0.1-beta.5 → 0.0.1-beta.6

package/dist/base/entities.d.ts

@@ -199,6 +199,8 @@ export interface DocumentEntity {
     externalFolio?: string | null;
     externalSender?: string | null;
     externalDate?: string | null;
+    contentText?: string | null;
+    textExtractedAt?: string | null;
     replyTo?: DocumentEntity | null;
     replyToDocumentId?: string | null;
     replies?: DocumentEntity[];

package/dist/contracts/document.contract.d.ts

@@ -99,6 +99,12 @@ export interface DocumentContract {
                 documentTypeId?: string;
                 dateFrom?: string;
                 dateTo?: string;
+                number?: number;
+                year?: number;
+                signerEmployeeId?: string;
+                authorEmployeeId?: string;
+                directorateCodeReference?: number;
+                text?: string;
             };
             actor?: DocumentActor;
         };

package/dist/contracts/index.d.ts

@@ -3,12 +3,14 @@ import { type DocumentContract } from './document.contract';
 import { type DocumentTypeContract } from './documentType.contract';
 import { type PartsOfficeContract } from './partsOffice.contract';
 import { type ProcedureContract } from './procedure.contract';
+import { type RegisterBookContract } from './registerBook.contract';
 export * from './contract';
 export * from './document.contract';
 export * from './documentType.contract';
 export * from './procedure.contract';
 export * from './caseFile.contract';
 export * from './partsOffice.contract';
+export * from './registerBook.contract';
 /** Patrones NATS de gestor-documental-ms, por recurso: `gestorDocumental.<recurso>.<acción>`. */
 export declare const GestorDocumentalPatterns: {
     readonly documentType: {
@@ -73,6 +75,10 @@ export declare const GestorDocumentalPatterns: {
         readonly returnInbound: "gestorDocumental.partsOffice.returnInbound";
         readonly getInboundFile: "gestorDocumental.partsOffice.getInboundFile";
     };
+    readonly registerBook: {
+        readonly get: "gestorDocumental.registerBook.get";
+        readonly export: "gestorDocumental.registerBook.export";
+    };
 };
 /** Contrato completo de gestor-documental-ms: la unión de los contratos de sus recursos. */
-export type GestorDocumentalContract = DocumentTypeContract & DocumentContract & ProcedureContract & CaseFileContract & PartsOfficeContract;
+export type GestorDocumentalContract = DocumentTypeContract & DocumentContract & ProcedureContract & CaseFileContract & PartsOfficeContract & RegisterBookContract;

package/dist/contracts/index.js

@@ -20,12 +20,14 @@ const document_contract_1 = require("./document.contract");
 const documentType_contract_1 = require("./documentType.contract");
 const partsOffice_contract_1 = require("./partsOffice.contract");
 const procedure_contract_1 = require("./procedure.contract");
+const registerBook_contract_1 = require("./registerBook.contract");
 __exportStar(require("./contract"), exports);
 __exportStar(require("./document.contract"), exports);
 __exportStar(require("./documentType.contract"), exports);
 __exportStar(require("./procedure.contract"), exports);
 __exportStar(require("./caseFile.contract"), exports);
 __exportStar(require("./partsOffice.contract"), exports);
+__exportStar(require("./registerBook.contract"), exports);
 /** Patrones NATS de gestor-documental-ms, por recurso: `gestorDocumental.<recurso>.<acción>`. */
 exports.GestorDocumentalPatterns = {
     documentType: documentType_contract_1.DocumentTypePatterns,
@@ -33,4 +35,5 @@ exports.GestorDocumentalPatterns = {
     procedure: procedure_contract_1.ProcedurePatterns,
     caseFile: caseFile_contract_1.CaseFilePatterns,
     partsOffice: partsOffice_contract_1.PartsOfficePatterns,
+    registerBook: registerBook_contract_1.RegisterBookPatterns,
 };

package/dist/contracts/registerBook.contract.d.ts

@@ -0,0 +1,27 @@
+import { type RegisterBookEntity, type RegisterBookExportEntity, type RegisterBookKind } from '../entities';
+/** Patrones NATS de `registerBook` (libros de registro): `<servicio>.<recurso>.<acción>`. */
+export declare const RegisterBookPatterns: {
+    readonly get: "gestorDocumental.registerBook.get";
+    readonly export: "gestorDocumental.registerBook.export";
+};
+/** Qué libro y qué período: un año y, si se indica, un mes. El de un tipo documental exige el tipo. */
+export interface RegisterBookQuery {
+    kind: RegisterBookKind;
+    documentTypeId?: string;
+    year: number;
+    month?: number | null;
+}
+export interface RegisterBookContract {
+    [RegisterBookPatterns.get]: {
+        payload: RegisterBookQuery;
+        response: RegisterBookEntity;
+    };
+    /** El libro en Excel o PDF. `generatedBy`: quién lo descarga (va en el encabezado). */
+    [RegisterBookPatterns.export]: {
+        payload: RegisterBookQuery & {
+            format: 'xlsx' | 'pdf';
+            generatedBy: string;
+        };
+        response: RegisterBookExportEntity;
+    };
+}

package/dist/contracts/registerBook.contract.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegisterBookPatterns = void 0;
+/** Patrones NATS de `registerBook` (libros de registro): `<servicio>.<recurso>.<acción>`. */
+exports.RegisterBookPatterns = {
+    get: 'gestorDocumental.registerBook.get',
+    export: 'gestorDocumental.registerBook.export',
+};

package/dist/entities/document/document.entity.d.ts

@@ -97,6 +97,8 @@ export interface DocumentGetAllResponseEntity {
     intakeNumber: DocumentEntity['intakeNumber'];
     intakeYear: DocumentEntity['intakeYear'];
     origin: DocumentEntity['origin'];
+    /** Con búsqueda de texto completo: el fragmento donde aparece lo buscado, con lo encontrado entre ⟦ y ⟧. */
+    snippet?: string | null;
     currentParticipant: Pick<DocumentParticipantResponseEntity, 'role' | 'employeeId' | 'fullName'> | null;
     distribution: {
         total: number;

package/dist/entities/index.d.ts

@@ -3,3 +3,4 @@ export * from './document';
 export * from './procedure';
 export * from './caseFile';
 export * from './partsOffice';
+export * from './registerBook';

package/dist/entities/index.js

@@ -19,3 +19,4 @@ __exportStar(require("./document"), exports);
 __exportStar(require("./procedure"), exports);
 __exportStar(require("./caseFile"), exports);
 __exportStar(require("./partsOffice"), exports);
+__exportStar(require("./registerBook"), exports);

package/dist/entities/registerBook/index.d.ts

@@ -0,0 +1 @@
+export * from './registerBook.entity';

package/dist/entities/registerBook/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./registerBook.entity"), exports);

package/dist/entities/registerBook/registerBook.entity.d.ts

@@ -0,0 +1,42 @@
+/** Libro de registro: el de un tipo documental (sus números) o el de ingresos de Oficina de Partes. */
+export type RegisterBookKind = 'documentType' | 'intake';
+/**
+ * Estado de un número en el libro: vigente, en tramitación (numerado con la primera firma, aún sin todas las firmas),
+ * documento anulado, número anulado por un rechazo, o número sin registro en el gestor (un salto en la numeración).
+ */
+export type RegisterBookRowState = 'Valid' | 'InProgress' | 'Annulled' | 'NumberAnnulled' | 'Unused';
+export interface RegisterBookRowEntity {
+    number: number;
+    /** Fecha del número (o del ingreso), en ISO 8601. `null` en un salto. */
+    date: string | null;
+    state: RegisterBookRowState;
+    documentId: string | null;
+    subject: string | null;
+    /** Quién redactó el documento (o, en el libro de ingresos, quién lo ingresó). */
+    author: string | null;
+    signers: string[];
+    /** Libro de ingresos: institución que lo envió y su folio. */
+    sender: string | null;
+    externalFolio: string | null;
+    /** Libro de ingresos: a quiénes se derivó. */
+    recipients: string[];
+    /** Despacho por DocDigital: «DocDigital N° 777001 · 14-10-2026». */
+    dispatch: string | null;
+    /** Motivo de la anulación (del documento o del número). */
+    observation: string | null;
+}
+export interface RegisterBookEntity {
+    kind: RegisterBookKind;
+    /** «Decreto alcaldicio exento» o «Ingresos de Oficina de Partes». */
+    title: string;
+    year: number;
+    month: number | null;
+    rows: RegisterBookRowEntity[];
+    totals: Record<RegisterBookRowState, number>;
+}
+/** Libro exportado, listo para descargar. */
+export interface RegisterBookExportEntity {
+    fileName: string;
+    contentType: string;
+    contentBase64: string;
+}

package/dist/entities/registerBook/registerBook.entity.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@muni-sanfer/types-gestor-documental",
-  "version": "0.0.1-beta.5",
+  "version": "0.0.1-beta.6",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {

package/src/base/entities.ts

@@ -281,6 +281,8 @@ export interface DocumentEntity {
   externalFolio?: string | null;
   externalSender?: string | null;
   externalDate?: string | null;
+  contentText?: string | null;
+  textExtractedAt?: string | null;
   replyTo?: DocumentEntity | null;
   replyToDocumentId?: string | null;
   replies?: DocumentEntity[];

package/src/contracts/document.contract.ts

@@ -129,6 +129,14 @@ export interface DocumentContract {
         // Rango de fechas de creación (ISO 8601).
         dateFrom?: string;
         dateTo?: string;
+        // Búsqueda avanzada: número (del documento o folio de ingreso) y año, firmante, redactor y unidad emisora.
+        number?: number;
+        year?: number;
+        signerEmployeeId?: string;
+        authorEmployeeId?: string;
+        directorateCodeReference?: number;
+        // Texto completo, en el asunto y en el contenido del PDF.
+        text?: string;
       };
       // Obligatorio en todas las bandejas salvo `all`.
       actor?: DocumentActor;

package/src/contracts/index.ts

@@ -3,6 +3,7 @@ import { DocumentPatterns, type DocumentContract } from './document.contract';
 import { DocumentTypePatterns, type DocumentTypeContract } from './documentType.contract';
 import { PartsOfficePatterns, type PartsOfficeContract } from './partsOffice.contract';
 import { ProcedurePatterns, type ProcedureContract } from './procedure.contract';
+import { RegisterBookPatterns, type RegisterBookContract } from './registerBook.contract';
 
 export * from './contract';
 export * from './document.contract';
@@ -10,6 +11,7 @@ export * from './documentType.contract';
 export * from './procedure.contract';
 export * from './caseFile.contract';
 export * from './partsOffice.contract';
+export * from './registerBook.contract';
 
 /** Patrones NATS de gestor-documental-ms, por recurso: `gestorDocumental.<recurso>.<acción>`. */
 export const GestorDocumentalPatterns = {
@@ -18,6 +20,7 @@ export const GestorDocumentalPatterns = {
   procedure: ProcedurePatterns,
   caseFile: CaseFilePatterns,
   partsOffice: PartsOfficePatterns,
+  registerBook: RegisterBookPatterns,
 } as const;
 
 /** Contrato completo de gestor-documental-ms: la unión de los contratos de sus recursos. */
@@ -25,4 +28,5 @@ export type GestorDocumentalContract = DocumentTypeContract &
   DocumentContract &
   ProcedureContract &
   CaseFileContract &
-  PartsOfficeContract;
+  PartsOfficeContract &
+  RegisterBookContract;

package/src/contracts/registerBook.contract.ts

@@ -0,0 +1,24 @@
+import { type RegisterBookEntity, type RegisterBookExportEntity, type RegisterBookKind } from '../entities';
+
+/** Patrones NATS de `registerBook` (libros de registro): `<servicio>.<recurso>.<acción>`. */
+export const RegisterBookPatterns = {
+  get: 'gestorDocumental.registerBook.get',
+  export: 'gestorDocumental.registerBook.export',
+} as const;
+
+/** Qué libro y qué período: un año y, si se indica, un mes. El de un tipo documental exige el tipo. */
+export interface RegisterBookQuery {
+  kind: RegisterBookKind;
+  documentTypeId?: string;
+  year: number;
+  month?: number | null;
+}
+
+export interface RegisterBookContract {
+  [RegisterBookPatterns.get]: { payload: RegisterBookQuery; response: RegisterBookEntity };
+  /** El libro en Excel o PDF. `generatedBy`: quién lo descarga (va en el encabezado). */
+  [RegisterBookPatterns.export]: {
+    payload: RegisterBookQuery & { format: 'xlsx' | 'pdf'; generatedBy: string };
+    response: RegisterBookExportEntity;
+  };
+}

package/src/entities/document/document.entity.ts

@@ -117,6 +117,8 @@ export interface DocumentGetAllResponseEntity {
   intakeNumber: DocumentEntity['intakeNumber'];
   intakeYear: DocumentEntity['intakeYear'];
   origin: DocumentEntity['origin'];
+  /** Con búsqueda de texto completo: el fragmento donde aparece lo buscado, con lo encontrado entre ⟦ y ⟧. */
+  snippet?: string | null;
   // A quién le toca visar o firmar (null si el documento no está en tramitación).
   currentParticipant: Pick<DocumentParticipantResponseEntity, 'role' | 'employeeId' | 'fullName'> | null;
   // A cuántos funcionarios llegó y cuántos ya lo abrieron (null si aún no se distribuye a nadie).

package/src/entities/index.ts

@@ -3,3 +3,4 @@ export * from './document';
 export * from './procedure';
 export * from './caseFile';
 export * from './partsOffice';
+export * from './registerBook';

package/src/entities/registerBook/index.ts

@@ -0,0 +1 @@
+export * from './registerBook.entity';

package/src/entities/registerBook/registerBook.entity.ts

@@ -0,0 +1,46 @@
+/** Libro de registro: el de un tipo documental (sus números) o el de ingresos de Oficina de Partes. */
+export type RegisterBookKind = 'documentType' | 'intake';
+
+/**
+ * Estado de un número en el libro: vigente, en tramitación (numerado con la primera firma, aún sin todas las firmas),
+ * documento anulado, número anulado por un rechazo, o número sin registro en el gestor (un salto en la numeración).
+ */
+export type RegisterBookRowState = 'Valid' | 'InProgress' | 'Annulled' | 'NumberAnnulled' | 'Unused';
+
+export interface RegisterBookRowEntity {
+  number: number;
+  /** Fecha del número (o del ingreso), en ISO 8601. `null` en un salto. */
+  date: string | null;
+  state: RegisterBookRowState;
+  documentId: string | null;
+  subject: string | null;
+  /** Quién redactó el documento (o, en el libro de ingresos, quién lo ingresó). */
+  author: string | null;
+  signers: string[];
+  /** Libro de ingresos: institución que lo envió y su folio. */
+  sender: string | null;
+  externalFolio: string | null;
+  /** Libro de ingresos: a quiénes se derivó. */
+  recipients: string[];
+  /** Despacho por DocDigital: «DocDigital N° 777001 · 14-10-2026». */
+  dispatch: string | null;
+  /** Motivo de la anulación (del documento o del número). */
+  observation: string | null;
+}
+
+export interface RegisterBookEntity {
+  kind: RegisterBookKind;
+  /** «Decreto alcaldicio exento» o «Ingresos de Oficina de Partes». */
+  title: string;
+  year: number;
+  month: number | null;
+  rows: RegisterBookRowEntity[];
+  totals: Record<RegisterBookRowState, number>;
+}
+
+/** Libro exportado, listo para descargar. */
+export interface RegisterBookExportEntity {
+  fileName: string;
+  contentType: string;
+  contentBase64: string;
+}