@muni-sanfer/types-gestor-documental 0.0.1-beta.22 → 0.0.1-beta.23

package/dist/base/entities.d.ts

@@ -205,7 +205,7 @@ export declare const DocumentAccessAction: {
     FileDownloaded: "FileDownloaded";
     TrailExported: "TrailExported";
 };
-export type AuditEntity = 'DocumentType' | 'IssuingEntity' | 'ArchivalSeries' | 'TextSnippet' | 'Holiday' | 'Procedure' | 'QualityMetric' | 'ServiceOutage';
+export type AuditEntity = 'DocumentType' | 'IssuingEntity' | 'ArchivalSeries' | 'TextSnippet' | 'Holiday' | 'Procedure' | 'QualityMetric' | 'ServiceOutage' | 'Repository';
 export declare const AuditEntity: {
     DocumentType: "DocumentType";
     IssuingEntity: "IssuingEntity";
@@ -215,14 +215,16 @@ export declare const AuditEntity: {
     Procedure: "Procedure";
     QualityMetric: "QualityMetric";
     ServiceOutage: "ServiceOutage";
+    Repository: "Repository";
 };
-export type AuditAction = 'Created' | 'Updated' | 'Enabled' | 'Disabled' | 'Removed';
+export type AuditAction = 'Created' | 'Updated' | 'Enabled' | 'Disabled' | 'Removed' | 'Exported';
 export declare const AuditAction: {
     Created: "Created";
     Updated: "Updated";
     Enabled: "Enabled";
     Disabled: "Disabled";
     Removed: "Removed";
+    Exported: "Exported";
 };
 export interface DocumentTypeEntity {
     id: string;

package/dist/base/entities.js

@@ -190,6 +190,7 @@ exports.AuditEntity = {
     Procedure: 'Procedure',
     QualityMetric: 'QualityMetric',
     ServiceOutage: 'ServiceOutage',
+    Repository: 'Repository',
 };
 exports.AuditAction = {
     Created: 'Created',
@@ -197,4 +198,5 @@ exports.AuditAction = {
     Enabled: 'Enabled',
     Disabled: 'Disabled',
     Removed: 'Removed',
+    Exported: 'Exported',
 };

package/dist/contracts/index.d.ts

@@ -8,6 +8,7 @@ import { type HolidayContract } from './holiday.contract';
 import { type IndicatorsContract } from './indicators.contract';
 import { type AuditContract } from './audit.contract';
 import { type SignatureCheckContract } from './signatureCheck.contract';
+import { type RepositoryExportContract } from './repositoryExport.contract';
 import { type ScanContract } from './scan.contract';
 import { type PartsOfficeContract } from './partsOffice.contract';
 import { type ProcedureContract } from './procedure.contract';
@@ -31,6 +32,7 @@ export * from './holiday.contract';
 export * from './indicators.contract';
 export * from './audit.contract';
 export * from './signatureCheck.contract';
+export * from './repositoryExport.contract';
 /** Patrones NATS de gestor-documental-ms, por recurso: `gestorDocumental.<recurso>.<acción>`. */
 export declare const GestorDocumentalPatterns: {
     readonly documentType: {
@@ -190,6 +192,12 @@ export declare const GestorDocumentalPatterns: {
     readonly signatureCheck: {
         readonly check: "gestorDocumental.signatureCheck.check";
     };
+    readonly repositoryExport: {
+        readonly getSummary: "gestorDocumental.repositoryExport.getSummary";
+        readonly getDocuments: "gestorDocumental.repositoryExport.getDocuments";
+        readonly getCaseFiles: "gestorDocumental.repositoryExport.getCaseFiles";
+        readonly record: "gestorDocumental.repositoryExport.record";
+    };
 };
 /** Contrato completo de gestor-documental-ms: la unión de los contratos de sus recursos. */
-export type GestorDocumentalContract = DocumentTypeContract & DocumentContract & ProcedureContract & IssuingEntityContract & CaseFileContract & PartsOfficeContract & RegisterBookContract & SignatureBatchContract & WorkFolderContract & ScanContract & ArchivalSeriesContract & TextSnippetContract & HolidayContract & IndicatorsContract & AuditContract & SignatureCheckContract;
+export type GestorDocumentalContract = DocumentTypeContract & DocumentContract & ProcedureContract & IssuingEntityContract & CaseFileContract & PartsOfficeContract & RegisterBookContract & SignatureBatchContract & WorkFolderContract & ScanContract & ArchivalSeriesContract & TextSnippetContract & HolidayContract & IndicatorsContract & AuditContract & SignatureCheckContract & RepositoryExportContract;

package/dist/contracts/index.js

@@ -25,6 +25,7 @@ const holiday_contract_1 = require("./holiday.contract");
 const indicators_contract_1 = require("./indicators.contract");
 const audit_contract_1 = require("./audit.contract");
 const signatureCheck_contract_1 = require("./signatureCheck.contract");
+const repositoryExport_contract_1 = require("./repositoryExport.contract");
 const scan_contract_1 = require("./scan.contract");
 const partsOffice_contract_1 = require("./partsOffice.contract");
 const procedure_contract_1 = require("./procedure.contract");
@@ -48,6 +49,7 @@ __exportStar(require("./holiday.contract"), exports);
 __exportStar(require("./indicators.contract"), exports);
 __exportStar(require("./audit.contract"), exports);
 __exportStar(require("./signatureCheck.contract"), exports);
+__exportStar(require("./repositoryExport.contract"), exports);
 /** Patrones NATS de gestor-documental-ms, por recurso: `gestorDocumental.<recurso>.<acción>`. */
 exports.GestorDocumentalPatterns = {
     documentType: documentType_contract_1.DocumentTypePatterns,
@@ -66,4 +68,5 @@ exports.GestorDocumentalPatterns = {
     indicators: indicators_contract_1.IndicatorsPatterns,
     audit: audit_contract_1.AuditPatterns,
     signatureCheck: signatureCheck_contract_1.SignatureCheckPatterns,
+    repositoryExport: repositoryExport_contract_1.RepositoryExportPatterns,
 };

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

@@ -0,0 +1,55 @@
+import { type RepositoryExportCaseFilesPageEntity, type RepositoryExportRecordResponseEntity, type RepositoryExportDocumentsPageEntity, type RepositoryExportScope, type RepositoryExportSummaryEntity } from '../entities';
+/**
+ * Patrones NATS de `repositoryExport`: exportación completa del repositorio (portabilidad). El ms entrega los datos
+ * por páginas, porque un mensaje NATS no admite más de 1 MB; el gateway arma el ZIP con ellos y los archivos.
+ */
+export declare const RepositoryExportPatterns: {
+    readonly getSummary: "gestorDocumental.repositoryExport.getSummary";
+    readonly getDocuments: "gestorDocumental.repositoryExport.getDocuments";
+    readonly getCaseFiles: "gestorDocumental.repositoryExport.getCaseFiles";
+    readonly record: "gestorDocumental.repositoryExport.record";
+};
+/** Período por fecha de creación (días de Chile «AAAA-MM-DD»); sin él, todo. */
+export interface RepositoryExportQuery {
+    from?: string | null;
+    to?: string | null;
+    scope?: RepositoryExportScope;
+}
+export interface RepositoryExportContract {
+    [RepositoryExportPatterns.getSummary]: {
+        payload: RepositoryExportQuery;
+        response: RepositoryExportSummaryEntity;
+    };
+    /** Hasta 50 documentos por página, en orden de creación. */
+    [RepositoryExportPatterns.getDocuments]: {
+        payload: RepositoryExportQuery & {
+            cursor?: string | null;
+            limit?: number;
+        };
+        response: RepositoryExportDocumentsPageEntity;
+    };
+    /** Hasta 10 expedientes por página; cada uno queda con «Exportó» en su trazabilidad, a nombre de quien exporta. */
+    [RepositoryExportPatterns.getCaseFiles]: {
+        payload: Omit<RepositoryExportQuery, 'scope'> & {
+            cursor?: string | null;
+            limit?: number;
+            actor: {
+                employeeId: string | null;
+                fullName: string;
+            };
+        };
+        response: RepositoryExportCaseFilesPageEntity;
+    };
+    /** Deja la exportación en la bitácora: quién, qué período y si llevó archivos. */
+    [RepositoryExportPatterns.record]: {
+        payload: RepositoryExportQuery & {
+            includeFiles: boolean;
+            complete: boolean;
+            actor: {
+                employeeId: string | null;
+                fullName: string;
+            };
+        };
+        response: RepositoryExportRecordResponseEntity;
+    };
+}

package/dist/contracts/repositoryExport.contract.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RepositoryExportPatterns = void 0;
+/**
+ * Patrones NATS de `repositoryExport`: exportación completa del repositorio (portabilidad). El ms entrega los datos
+ * por páginas, porque un mensaje NATS no admite más de 1 MB; el gateway arma el ZIP con ellos y los archivos.
+ */
+exports.RepositoryExportPatterns = {
+    getSummary: 'gestorDocumental.repositoryExport.getSummary',
+    getDocuments: 'gestorDocumental.repositoryExport.getDocuments',
+    getCaseFiles: 'gestorDocumental.repositoryExport.getCaseFiles',
+    record: 'gestorDocumental.repositoryExport.record',
+};

package/dist/entities/index.d.ts

@@ -14,3 +14,4 @@ export * from './holiday';
 export * from './indicators';
 export * from './audit';
 export * from './signatureCheck';
+export * from './repositoryExport';

package/dist/entities/index.js

@@ -30,3 +30,4 @@ __exportStar(require("./holiday"), exports);
 __exportStar(require("./indicators"), exports);
 __exportStar(require("./audit"), exports);
 __exportStar(require("./signatureCheck"), exports);
+__exportStar(require("./repositoryExport"), exports);

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

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

package/dist/entities/repositoryExport/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("./repositoryExport.entity"), exports);

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

@@ -0,0 +1,124 @@
+import { type CaseFileExportResponseEntity } from '../caseFile';
+/** Qué documentos: los oficiales (finalizados y anulados) o todos, también borradores y en tramitación. */
+export type RepositoryExportScope = 'official' | 'all';
+/** Un archivo que el gateway descarga y pone en el ZIP, en la ruta indicada. */
+export interface RepositoryExportFile {
+    fileId: string;
+    path: string;
+    kind: 'document' | 'attachment';
+}
+/** Un documento con todos sus datos, como va en `documentos/*.jsonl`. Claves en castellano, como `expediente.json`. */
+export interface RepositoryDocumentRecord {
+    id: string;
+    tipo: {
+        nombre: string;
+        sigla: string | null;
+        serie: {
+            codigo: string;
+            nombre: string;
+        } | null;
+    };
+    entidadEmisora: string;
+    folio: string | null;
+    numero: number | null;
+    anio: number | null;
+    materia: string;
+    palabrasClave: string[];
+    nivelAcceso: string;
+    datosSensibles: boolean;
+    finRestriccion: string | null;
+    estado: string;
+    origen: string;
+    codigoVerificacion: string | null;
+    redactor: {
+        id: string;
+        nombre: string;
+    };
+    unidadEmisora: {
+        codigoDireccion: number | null;
+        departamentoId: string | null;
+    };
+    creado: string;
+    enviado: string | null;
+    finalizado: string | null;
+    anulacion: {
+        fecha: string;
+        motivo: string | null;
+    } | null;
+    numerosAnulados: {
+        numero: number;
+        anio: number;
+        motivo: string;
+        registradoPor: string;
+        fecha: string;
+    }[];
+    participantes: {
+        rol: string;
+        orden: number;
+        etapa: number;
+        nombre: string;
+        cargo: string | null;
+        estado: string;
+        resueltoEl: string | null;
+        observacion: string | null;
+    }[];
+    destinatarios: {
+        tipo: string;
+        nombre: string;
+        cargo: string | null;
+    }[];
+    destinatariosExternos: {
+        entidad: string;
+        usuario: string | null;
+    }[];
+    despacho: {
+        estado: string;
+        folio: string | null;
+        despachadoEl: string | null;
+        idDocDigital: string | null;
+    } | null;
+    ingreso: {
+        folio: string | null;
+        remitente: string | null;
+        folioDeOrigen: string | null;
+    } | null;
+    anexos: {
+        nombre: string;
+        enlace: string | null;
+        archivo: string | null;
+    }[];
+    trazabilidad: {
+        accion: string;
+        quien: string | null;
+        cuando: string;
+        observacion: string | null;
+        sha256: string | null;
+    }[];
+    /** Ruta del PDF vigente (firmado) dentro del ZIP. */
+    archivo: string;
+}
+export interface RepositoryExportSummaryEntity {
+    /** Órgano que exporta (`ORGAN_NAME`). */
+    organ: string;
+    from: string | null;
+    to: string | null;
+    scope: RepositoryExportScope;
+    documents: number;
+    caseFiles: number;
+    /** Catálogos completos: tipos documentales, series, procedimientos, entidades emisoras y feriados. */
+    catalogs: Record<string, unknown[]>;
+}
+export interface RepositoryExportDocumentsPageEntity {
+    items: {
+        record: RepositoryDocumentRecord;
+        files: RepositoryExportFile[];
+    }[];
+    nextCursor: string | null;
+}
+export interface RepositoryExportCaseFilesPageEntity {
+    items: CaseFileExportResponseEntity[];
+    nextCursor: string | null;
+}
+export interface RepositoryExportRecordResponseEntity {
+    ok: boolean;
+}

package/dist/entities/repositoryExport/repositoryExport.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.22",
+  "version": "0.0.1-beta.23",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {

package/src/base/entities.ts

@@ -318,7 +318,8 @@ export type AuditEntity =
   | 'Holiday'
   | 'Procedure'
   | 'QualityMetric'
-  | 'ServiceOutage';
+  | 'ServiceOutage'
+  | 'Repository';
 
 export const AuditEntity = {
   DocumentType: 'DocumentType',
@@ -329,9 +330,10 @@ export const AuditEntity = {
   Procedure: 'Procedure',
   QualityMetric: 'QualityMetric',
   ServiceOutage: 'ServiceOutage',
+  Repository: 'Repository',
 } satisfies Record<string, AuditEntity>;
 
-export type AuditAction = 'Created' | 'Updated' | 'Enabled' | 'Disabled' | 'Removed';
+export type AuditAction = 'Created' | 'Updated' | 'Enabled' | 'Disabled' | 'Removed' | 'Exported';
 
 export const AuditAction = {
   Created: 'Created',
@@ -339,6 +341,7 @@ export const AuditAction = {
   Enabled: 'Enabled',
   Disabled: 'Disabled',
   Removed: 'Removed',
+  Exported: 'Exported',
 } satisfies Record<string, AuditAction>;
 
 export interface DocumentTypeEntity {

package/src/contracts/index.ts

@@ -8,6 +8,7 @@ import { HolidayPatterns, type HolidayContract } from './holiday.contract';
 import { IndicatorsPatterns, type IndicatorsContract } from './indicators.contract';
 import { AuditPatterns, type AuditContract } from './audit.contract';
 import { SignatureCheckPatterns, type SignatureCheckContract } from './signatureCheck.contract';
+import { RepositoryExportPatterns, type RepositoryExportContract } from './repositoryExport.contract';
 import { ScanPatterns, type ScanContract } from './scan.contract';
 import { PartsOfficePatterns, type PartsOfficeContract } from './partsOffice.contract';
 import { ProcedurePatterns, type ProcedureContract } from './procedure.contract';
@@ -32,6 +33,7 @@ export * from './holiday.contract';
 export * from './indicators.contract';
 export * from './audit.contract';
 export * from './signatureCheck.contract';
+export * from './repositoryExport.contract';
 
 /** Patrones NATS de gestor-documental-ms, por recurso: `gestorDocumental.<recurso>.<acción>`. */
 export const GestorDocumentalPatterns = {
@@ -51,6 +53,7 @@ export const GestorDocumentalPatterns = {
   indicators: IndicatorsPatterns,
   audit: AuditPatterns,
   signatureCheck: SignatureCheckPatterns,
+  repositoryExport: RepositoryExportPatterns,
 } as const;
 
 /** Contrato completo de gestor-documental-ms: la unión de los contratos de sus recursos. */
@@ -69,4 +72,5 @@ export type GestorDocumentalContract = DocumentTypeContract &
   HolidayContract &
   IndicatorsContract &
   AuditContract &
-  SignatureCheckContract;
+  SignatureCheckContract &
+  RepositoryExportContract;

package/src/contracts/repositoryExport.contract.ts

@@ -0,0 +1,52 @@
+import {
+  type RepositoryExportCaseFilesPageEntity,
+  type RepositoryExportRecordResponseEntity,
+  type RepositoryExportDocumentsPageEntity,
+  type RepositoryExportScope,
+  type RepositoryExportSummaryEntity,
+} from '../entities';
+
+/**
+ * Patrones NATS de `repositoryExport`: exportación completa del repositorio (portabilidad). El ms entrega los datos
+ * por páginas, porque un mensaje NATS no admite más de 1 MB; el gateway arma el ZIP con ellos y los archivos.
+ */
+export const RepositoryExportPatterns = {
+  getSummary: 'gestorDocumental.repositoryExport.getSummary',
+  getDocuments: 'gestorDocumental.repositoryExport.getDocuments',
+  getCaseFiles: 'gestorDocumental.repositoryExport.getCaseFiles',
+  record: 'gestorDocumental.repositoryExport.record',
+} as const;
+
+/** Período por fecha de creación (días de Chile «AAAA-MM-DD»); sin él, todo. */
+export interface RepositoryExportQuery {
+  from?: string | null;
+  to?: string | null;
+  scope?: RepositoryExportScope;
+}
+
+export interface RepositoryExportContract {
+  [RepositoryExportPatterns.getSummary]: { payload: RepositoryExportQuery; response: RepositoryExportSummaryEntity };
+  /** Hasta 50 documentos por página, en orden de creación. */
+  [RepositoryExportPatterns.getDocuments]: {
+    payload: RepositoryExportQuery & { cursor?: string | null; limit?: number };
+    response: RepositoryExportDocumentsPageEntity;
+  };
+  /** Hasta 10 expedientes por página; cada uno queda con «Exportó» en su trazabilidad, a nombre de quien exporta. */
+  [RepositoryExportPatterns.getCaseFiles]: {
+    payload: Omit<RepositoryExportQuery, 'scope'> & {
+      cursor?: string | null;
+      limit?: number;
+      actor: { employeeId: string | null; fullName: string };
+    };
+    response: RepositoryExportCaseFilesPageEntity;
+  };
+  /** Deja la exportación en la bitácora: quién, qué período y si llevó archivos. */
+  [RepositoryExportPatterns.record]: {
+    payload: RepositoryExportQuery & {
+      includeFiles: boolean;
+      complete: boolean;
+      actor: { employeeId: string | null; fullName: string };
+    };
+    response: RepositoryExportRecordResponseEntity;
+  };
+}

package/src/entities/index.ts

@@ -14,3 +14,4 @@ export * from './holiday';
 export * from './indicators';
 export * from './audit';
 export * from './signatureCheck';
+export * from './repositoryExport';

package/src/entities/repositoryExport/index.ts

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

package/src/entities/repositoryExport/repositoryExport.entity.ts

@@ -0,0 +1,86 @@
+import { type CaseFileExportResponseEntity } from '../caseFile';
+
+/** Qué documentos: los oficiales (finalizados y anulados) o todos, también borradores y en tramitación. */
+export type RepositoryExportScope = 'official' | 'all';
+
+/** Un archivo que el gateway descarga y pone en el ZIP, en la ruta indicada. */
+export interface RepositoryExportFile {
+  fileId: string;
+  path: string;
+  kind: 'document' | 'attachment';
+}
+
+/** Un documento con todos sus datos, como va en `documentos/*.jsonl`. Claves en castellano, como `expediente.json`. */
+export interface RepositoryDocumentRecord {
+  id: string;
+  tipo: { nombre: string; sigla: string | null; serie: { codigo: string; nombre: string } | null };
+  entidadEmisora: string;
+  folio: string | null;
+  numero: number | null;
+  anio: number | null;
+  materia: string;
+  palabrasClave: string[];
+  nivelAcceso: string;
+  datosSensibles: boolean;
+  finRestriccion: string | null;
+  estado: string;
+  origen: string;
+  codigoVerificacion: string | null;
+  redactor: { id: string; nombre: string };
+  unidadEmisora: { codigoDireccion: number | null; departamentoId: string | null };
+  creado: string;
+  enviado: string | null;
+  finalizado: string | null;
+  anulacion: { fecha: string; motivo: string | null } | null;
+  numerosAnulados: { numero: number; anio: number; motivo: string; registradoPor: string; fecha: string }[];
+  participantes: {
+    rol: string;
+    orden: number;
+    etapa: number;
+    nombre: string;
+    cargo: string | null;
+    estado: string;
+    resueltoEl: string | null;
+    observacion: string | null;
+  }[];
+  destinatarios: { tipo: string; nombre: string; cargo: string | null }[];
+  destinatariosExternos: { entidad: string; usuario: string | null }[];
+  despacho: { estado: string; folio: string | null; despachadoEl: string | null; idDocDigital: string | null } | null;
+  ingreso: { folio: string | null; remitente: string | null; folioDeOrigen: string | null } | null;
+  anexos: { nombre: string; enlace: string | null; archivo: string | null }[];
+  trazabilidad: {
+    accion: string;
+    quien: string | null;
+    cuando: string;
+    observacion: string | null;
+    sha256: string | null;
+  }[];
+  /** Ruta del PDF vigente (firmado) dentro del ZIP. */
+  archivo: string;
+}
+
+export interface RepositoryExportSummaryEntity {
+  /** Órgano que exporta (`ORGAN_NAME`). */
+  organ: string;
+  from: string | null;
+  to: string | null;
+  scope: RepositoryExportScope;
+  documents: number;
+  caseFiles: number;
+  /** Catálogos completos: tipos documentales, series, procedimientos, entidades emisoras y feriados. */
+  catalogs: Record<string, unknown[]>;
+}
+
+export interface RepositoryExportDocumentsPageEntity {
+  items: { record: RepositoryDocumentRecord; files: RepositoryExportFile[] }[];
+  nextCursor: string | null;
+}
+
+export interface RepositoryExportCaseFilesPageEntity {
+  items: CaseFileExportResponseEntity[];
+  nextCursor: string | null;
+}
+
+export interface RepositoryExportRecordResponseEntity {
+  ok: boolean;
+}