@muni-sanfer/types-gestor-documental 0.0.1-beta.2 → 0.0.1-beta.21

package/dist/base/entities.js

@@ -1,7 +1,7 @@
 "use strict";
 // This file was auto-generated by prisma-generator-typescript-interfaces
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocumentInstruction = exports.DocumentDeliveryOrigin = exports.DocumentRecipientType = exports.DocumentAttachmentType = exports.DocumentTrackingAction = exports.DocumentParticipantStatus = exports.DocumentParticipantRole = exports.DocumentAccessLevel = exports.DocumentStatus = exports.DocumentCategory = void 0;
+exports.AuditAction = exports.AuditEntity = exports.DocumentAccessAction = exports.QualityMetricKey = exports.ServiceOutageKind = exports.WorkFolderItemKind = exports.TextSnippetSection = exports.ScanSessionStatus = exports.CaseFileAccessAction = exports.CaseFileTrackingAction = exports.CaseFileActorType = exports.CaseFileActorRelation = exports.CaseFileEntryKind = exports.CaseFileActuationType = exports.CaseFileIncorporationMechanism = exports.CaseFileStatus = exports.DocumentInstruction = exports.DocumentDeliveryOrigin = exports.DocumentRecipientType = exports.DocumentAttachmentType = exports.DocumentFlowStepType = exports.DocDigitalInboundStatus = exports.DocumentDispatchStatus = exports.DocumentOrigin = exports.DocumentTrackingAction = exports.DocumentParticipantStatus = exports.DocumentParticipantRole = exports.DocumentAccessLevel = exports.DocumentStatus = exports.DocumentCategory = void 0;
 exports.DocumentCategory = {
     Decree: 'Decree',
     Communication: 'Communication',
@@ -46,6 +46,30 @@ exports.DocumentTrackingAction = {
     Annulled: 'Annulled',
     Delivered: 'Delivered',
     Derived: 'Derived',
+    Reassigned: 'Reassigned',
+    Dispatched: 'Dispatched',
+    DispatchReturned: 'DispatchReturned',
+    Received: 'Received',
+    EmailCopySent: 'EmailCopySent',
+    EmailCopyOpened: 'EmailCopyOpened',
+};
+exports.DocumentOrigin = {
+    Internal: 'Internal',
+    DocDigital: 'DocDigital',
+};
+exports.DocumentDispatchStatus = {
+    Pending: 'Pending',
+    Dispatched: 'Dispatched',
+    Returned: 'Returned',
+};
+exports.DocDigitalInboundStatus = {
+    Pending: 'Pending',
+    Registered: 'Registered',
+    Returned: 'Returned',
+};
+exports.DocumentFlowStepType = {
+    Employee: 'Employee',
+    DirectorateHead: 'DirectorateHead',
 };
 exports.DocumentAttachmentType = {
     File: 'File',
@@ -66,3 +90,111 @@ exports.DocumentInstruction = {
     Respond: 'Respond',
     Archive: 'Archive',
 };
+exports.CaseFileStatus = {
+    Open: 'Open',
+    Closed: 'Closed',
+};
+exports.CaseFileIncorporationMechanism = {
+    Manual: 'Manual',
+    WebService: 'WebService',
+    Mixed: 'Mixed',
+    CitizenRepository: 'CitizenRepository',
+    Interoperability: 'Interoperability',
+};
+exports.CaseFileActuationType = {
+    AdministrativeAct: 'AdministrativeAct',
+    Notification: 'Notification',
+    OfficialCommunication: 'OfficialCommunication',
+    Interoperability: 'Interoperability',
+    RequestReception: 'RequestReception',
+    Subfolder: 'Subfolder',
+    PowerRegistration: 'PowerRegistration',
+};
+exports.CaseFileEntryKind = {
+    Document: 'Document',
+    File: 'File',
+    CaseFile: 'CaseFile',
+    Physical: 'Physical',
+};
+exports.CaseFileActorRelation = {
+    Responsible: 'Responsible',
+    Interested: 'Interested',
+    Author: 'Author',
+    Referred: 'Referred',
+    Recipient: 'Recipient',
+    MinisterOfFaith: 'MinisterOfFaith',
+};
+exports.CaseFileActorType = {
+    Citizen: 'Citizen',
+    Foreigner: 'Foreigner',
+    PrivateInstitution: 'PrivateInstitution',
+    Official: 'Official',
+};
+exports.CaseFileTrackingAction = {
+    Created: 'Created',
+    Updated: 'Updated',
+    EntryAdded: 'EntryAdded',
+    EntryVoided: 'EntryVoided',
+    EntryMoved: 'EntryMoved',
+    ParticipantAdded: 'ParticipantAdded',
+    ParticipantRemoved: 'ParticipantRemoved',
+    Closed: 'Closed',
+    Exported: 'Exported',
+    ShareLinkCreated: 'ShareLinkCreated',
+    ShareLinkRevoked: 'ShareLinkRevoked',
+};
+exports.CaseFileAccessAction = {
+    Viewed: 'Viewed',
+    FileDownloaded: 'FileDownloaded',
+    Exported: 'Exported',
+};
+exports.ScanSessionStatus = {
+    Open: 'Open',
+    Ready: 'Ready',
+};
+exports.TextSnippetSection = {
+    Vistos: 'Vistos',
+    Considerando: 'Considerando',
+    Resolutive: 'Resolutive',
+    Body: 'Body',
+    Closing: 'Closing',
+};
+exports.WorkFolderItemKind = {
+    Document: 'Document',
+    File: 'File',
+};
+exports.ServiceOutageKind = {
+    Unplanned: 'Unplanned',
+    Planned: 'Planned',
+};
+exports.QualityMetricKey = {
+    Effectiveness: 'Effectiveness',
+    Efficiency: 'Efficiency',
+    Availability: 'Availability',
+    ResponseTime: 'ResponseTime',
+    Accessibility: 'Accessibility',
+    FunctionalCompleteness: 'FunctionalCompleteness',
+    Interoperability: 'Interoperability',
+};
+exports.DocumentAccessAction = {
+    Viewed: 'Viewed',
+    FileDownloaded: 'FileDownloaded',
+    TrailExported: 'TrailExported',
+};
+exports.AuditEntity = {
+    DocumentType: 'DocumentType',
+    IssuingEntity: 'IssuingEntity',
+    ArchivalSeries: 'ArchivalSeries',
+    TextSnippet: 'TextSnippet',
+    Holiday: 'Holiday',
+    Procedure: 'Procedure',
+    QualityMetric: 'QualityMetric',
+    ServiceOutage: 'ServiceOutage',
+};
+exports.AuditAction = {
+    Created: 'Created',
+    Updated: 'Updated',
+    Enabled: 'Enabled',
+    Disabled: 'Disabled',
+    Removed: 'Removed',
+};

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

@@ -0,0 +1,50 @@
+import { type ArchivalSeriesEntity } from '../base/entities';
+import { type ArchivalSeriesCreateResponseEntity, type ArchivalSeriesGetAllResponseEntity, type ArchivalSeriesGetByIdResponseEntity, type ArchivalSeriesUpdateResponseEntity } from '../entities';
+import { type RpcPage } from './contract';
+/** Patrones NATS de `archivalSeries` (series del Cuadro de Clasificación): `<servicio>.<recurso>.<acción>`. */
+export declare const ArchivalSeriesPatterns: {
+    readonly getAll: "gestorDocumental.archivalSeries.getAll";
+    readonly getById: "gestorDocumental.archivalSeries.getById";
+    readonly create: "gestorDocumental.archivalSeries.create";
+    readonly update: "gestorDocumental.archivalSeries.update";
+    readonly setEnabled: "gestorDocumental.archivalSeries.setEnabled";
+};
+/** Datos de una serie documental al crearla o editarla. */
+export interface ArchivalSeriesWritePayload {
+    code: string;
+    name: string;
+    section?: string | null;
+    description?: string | null;
+    enabled?: boolean;
+}
+export interface ArchivalSeriesContract {
+    [ArchivalSeriesPatterns.getAll]: {
+        payload: {
+            pagination?: {
+                page?: number;
+                limit?: number;
+            };
+            filters?: {
+                search?: string;
+                enabled?: boolean;
+            };
+        };
+        response: RpcPage<ArchivalSeriesGetAllResponseEntity[]>;
+    };
+    [ArchivalSeriesPatterns.getById]: {
+        payload: Pick<ArchivalSeriesEntity, 'id'>;
+        response: ArchivalSeriesGetByIdResponseEntity;
+    };
+    [ArchivalSeriesPatterns.create]: {
+        payload: ArchivalSeriesWritePayload;
+        response: ArchivalSeriesCreateResponseEntity;
+    };
+    [ArchivalSeriesPatterns.update]: {
+        payload: ArchivalSeriesWritePayload & Pick<ArchivalSeriesEntity, 'id'>;
+        response: ArchivalSeriesUpdateResponseEntity;
+    };
+    [ArchivalSeriesPatterns.setEnabled]: {
+        payload: Pick<ArchivalSeriesEntity, 'id' | 'enabled'>;
+        response: ArchivalSeriesUpdateResponseEntity;
+    };
+}

package/dist/contracts/archivalSeries.contract.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArchivalSeriesPatterns = void 0;
+/** Patrones NATS de `archivalSeries` (series del Cuadro de Clasificación): `<servicio>.<recurso>.<acción>`. */
+exports.ArchivalSeriesPatterns = {
+    getAll: 'gestorDocumental.archivalSeries.getAll',
+    getById: 'gestorDocumental.archivalSeries.getById',
+    create: 'gestorDocumental.archivalSeries.create',
+    update: 'gestorDocumental.archivalSeries.update',
+    setEnabled: 'gestorDocumental.archivalSeries.setEnabled',
+};

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

@@ -0,0 +1,32 @@
+import { type AuditEventEntity, type AuditSource, type IndicatorsFileEntity } from '../entities';
+import { type RpcPage } from './contract';
+/** Patrones NATS de `audit`: la auditoría reúne todos los registros del gestor en una sola vista. */
+export declare const AuditPatterns: {
+    readonly getEvents: "gestorDocumental.audit.getEvents";
+    readonly export: "gestorDocumental.audit.export";
+};
+/** Qué hechos: período (días de Chile «AAAA-MM-DD», hasta un año) y filtros optativos. */
+export interface AuditQuery {
+    from: string;
+    to: string;
+    sources?: AuditSource[];
+    /** Parte del nombre de quien actuó. */
+    person?: string;
+    /** Parte del folio, materia, IUIe, título o nombre de lo afectado. */
+    reference?: string;
+    page?: number;
+    limit?: number;
+}
+export interface AuditContract {
+    [AuditPatterns.getEvents]: {
+        payload: AuditQuery;
+        response: RpcPage<AuditEventEntity[]>;
+    };
+    /** Los hechos filtrados (hasta 10.000) en Excel. `generatedBy`: quién la descarga. */
+    [AuditPatterns.export]: {
+        payload: Omit<AuditQuery, 'page' | 'limit'> & {
+            generatedBy: string;
+        };
+        response: IndicatorsFileEntity;
+    };
+}

package/dist/contracts/audit.contract.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditPatterns = void 0;
+/** Patrones NATS de `audit`: la auditoría reúne todos los registros del gestor en una sola vista. */
+exports.AuditPatterns = {
+    getEvents: 'gestorDocumental.audit.getEvents',
+    export: 'gestorDocumental.audit.export',
+};

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

@@ -0,0 +1,262 @@
+import { type CaseFileActorRelation, type CaseFileActorType, type CaseFileActuationType, type CaseFileEntity, type CaseFileStatus, type DocumentAccessLevel } from '../base/entities';
+import { type CaseFileAddBatchResponseEntity, type CaseFileAddEntryResponseEntity, type CaseFileCreateResponseEntity, type CaseFileEntryFileResponseEntity, type CaseFileExportResponseEntity, type CaseFileGetAllResponseEntity, type CaseFileGetByIdResponseEntity, type CaseFileShareLinkCreateResponseEntity, type CaseFileShareLinkResponseEntity, type CaseFileSharedResponseEntity, type CaseFileUpdateResponseEntity, type CaseFileVerifyExportResponseEntity } from '../entities';
+import { type RpcPage } from './contract';
+import { type DocumentActor } from './document.contract';
+/** Patrones NATS de `caseFile`: `<servicio>.<recurso>.<acción>`. */
+export declare const CaseFilePatterns: {
+    readonly getAll: "gestorDocumental.caseFile.getAll";
+    readonly getById: "gestorDocumental.caseFile.getById";
+    readonly create: "gestorDocumental.caseFile.create";
+    readonly update: "gestorDocumental.caseFile.update";
+    readonly addEntry: "gestorDocumental.caseFile.addEntry";
+    readonly addBatch: "gestorDocumental.caseFile.addBatch";
+    readonly voidEntry: "gestorDocumental.caseFile.voidEntry";
+    readonly moveEntry: "gestorDocumental.caseFile.moveEntry";
+    readonly share: "gestorDocumental.caseFile.share";
+    readonly unshare: "gestorDocumental.caseFile.unshare";
+    readonly close: "gestorDocumental.caseFile.close";
+    readonly getEntryFile: "gestorDocumental.caseFile.getEntryFile";
+    readonly getExport: "gestorDocumental.caseFile.getExport";
+    readonly createShareLink: "gestorDocumental.caseFile.createShareLink";
+    readonly getShareLinks: "gestorDocumental.caseFile.getShareLinks";
+    readonly revokeShareLink: "gestorDocumental.caseFile.revokeShareLink";
+    readonly getShared: "gestorDocumental.caseFile.getShared";
+    readonly getSharedEntryFile: "gestorDocumental.caseFile.getSharedEntryFile";
+    readonly getSharedExport: "gestorDocumental.caseFile.getSharedExport";
+    readonly verifyExport: "gestorDocumental.caseFile.verifyExport";
+};
+/** Enlace temporal para que alguien de fuera consulte el expediente sin sesión. */
+export interface CaseFileShareLinkPayload {
+    /** A quién se entrega. Ej: «Contraloría Regional». */
+    recipient: string;
+    /** Si se indica, el gateway le envía el enlace por correo. */
+    recipientEmail?: string | null;
+    purpose?: string | null;
+    /** Cuántos días dura: de 1 a 30. */
+    days: number;
+    /** Puede descargar el expediente completo (ZIP). Por omisión, sí. */
+    allowExport?: boolean;
+}
+/** Persona u organización relacionada con el expediente (MGDEE54). */
+export interface CaseFileActorInput {
+    relation: CaseFileActorRelation;
+    actorType: CaseFileActorType;
+    identifier?: string | null;
+    name: string;
+}
+/** Metadatos del expediente que se ingresan a mano. */
+export interface CaseFileWritePayload {
+    title: string;
+    subject: string;
+    summary?: string | null;
+    procedureId: string;
+    accessLevel: DocumentAccessLevel;
+    hasSensitiveData: boolean;
+    /** MGDEE8_2: fin de la restricción de acceso (ISO 8601), si no es público. */
+    restrictionEndsAt?: string | null;
+    /** MGDEE1_2: serie del Cuadro de Clasificación. */
+    archivalSeriesId?: string | null;
+    actors?: CaseFileActorInput[];
+}
+/** Actuación que se incorpora al índice: un documento del gestor, un archivo subido u otro expediente. */
+export type CaseFileEntryInput = {
+    kind: 'Document';
+    actuationType: CaseFileActuationType;
+    documentId: string;
+} | {
+    kind: 'File';
+    actuationType: CaseFileActuationType;
+    fileId: string;
+    fileName: string;
+    title: string;
+    documentTypeName?: string | null;
+    originDate?: string | null;
+    author?: string | null;
+    keywords: string[];
+    accessLevel: DocumentAccessLevel;
+    hasSensitiveData: boolean;
+} | {
+    kind: 'CaseFile';
+    actuationType: CaseFileActuationType;
+    linkedCaseFileId: string;
+} | {
+    kind: 'Physical';
+    actuationType: CaseFileActuationType;
+    title: string;
+    documentTypeName?: string | null;
+    originDate?: string | null;
+    author?: string | null;
+    /** Dónde está el papel: oficina, archivador, caja (MGDDE5_5). */
+    physicalLocation: string;
+    /** Por qué no se pudo digitalizar. */
+    physicalReason: string;
+    pageCount?: number | null;
+    keywords: string[];
+    accessLevel: DocumentAccessLevel;
+    hasSensitiveData: boolean;
+};
+/** Quién hace la operación (de la sesión) y si puede ver todos los expedientes. */
+interface CaseFileActorPayload {
+    actor: DocumentActor;
+    viewAll?: boolean;
+}
+/** Ámbito del listado: los expedientes del funcionario (responsable o compartidos con él) o todos. */
+export type CaseFileScope = 'mine' | 'all';
+export interface CaseFileContract {
+    [CaseFilePatterns.getAll]: {
+        payload: {
+            pagination?: {
+                page?: number;
+                limit?: number;
+            };
+            filters?: {
+                search?: string;
+                status?: CaseFileStatus;
+                procedureId?: string;
+                scope?: CaseFileScope;
+            };
+        } & CaseFileActorPayload;
+        response: RpcPage<CaseFileGetAllResponseEntity[]>;
+    };
+    /** Por id o por su identificador (`EXP-2026-00001`), que es el del enlace persistente. Queda en el registro de accesos. */
+    [CaseFilePatterns.getById]: {
+        payload: {
+            id: string;
+        } & CaseFileActorPayload;
+        response: CaseFileGetByIdResponseEntity;
+    };
+    [CaseFilePatterns.create]: {
+        payload: CaseFileWritePayload & {
+            actor: DocumentActor;
+        };
+        response: CaseFileCreateResponseEntity;
+    };
+    [CaseFilePatterns.update]: {
+        payload: CaseFileWritePayload & Pick<CaseFileEntity, 'id'> & {
+            actor: DocumentActor;
+        };
+        response: CaseFileUpdateResponseEntity;
+    };
+    /** Incorpora los documentos finalizados de un lote de firma, en su orden; omite los que ya están en el expediente. */
+    [CaseFilePatterns.addBatch]: {
+        payload: {
+            id: string;
+            batchId: string;
+            actuationType: CaseFileActuationType;
+        } & CaseFileActorPayload;
+        response: CaseFileAddBatchResponseEntity;
+    };
+    [CaseFilePatterns.addEntry]: {
+        payload: Pick<CaseFileEntity, 'id'> & {
+            entry: CaseFileEntryInput;
+            folder?: string | null;
+        } & CaseFileActorPayload;
+        response: CaseFileAddEntryResponseEntity;
+    };
+    /** Deja una actuación sin efecto, con su motivo. No se elimina del índice. */
+    /** Pasa una actuación a otra subcarpeta del índice (`null`: a la raíz). El orden de incorporación no cambia. */
+    [CaseFilePatterns.moveEntry]: {
+        payload: {
+            id: string;
+            entryId: string;
+            folder: string | null;
+        } & CaseFileActorPayload;
+        response: CaseFileUpdateResponseEntity;
+    };
+    [CaseFilePatterns.voidEntry]: {
+        payload: Pick<CaseFileEntity, 'id'> & {
+            entryId: string;
+            reason: string;
+            actor: DocumentActor;
+        };
+        response: CaseFileUpdateResponseEntity;
+    };
+    [CaseFilePatterns.share]: {
+        payload: Pick<CaseFileEntity, 'id'> & {
+            employeeIds: string[];
+            actor: DocumentActor;
+        };
+        response: CaseFileUpdateResponseEntity;
+    };
+    [CaseFilePatterns.unshare]: {
+        payload: Pick<CaseFileEntity, 'id'> & {
+            participantId: string;
+            actor: DocumentActor;
+        };
+        response: CaseFileUpdateResponseEntity;
+    };
+    [CaseFilePatterns.close]: {
+        payload: Pick<CaseFileEntity, 'id'> & {
+            note?: string | null;
+            actor: DocumentActor;
+        };
+        response: CaseFileUpdateResponseEntity;
+    };
+    /** Archivo de una actuación del índice. Queda en el registro de accesos. */
+    [CaseFilePatterns.getEntryFile]: {
+        payload: Pick<CaseFileEntity, 'id'> & {
+            entryId: string;
+        } & CaseFileActorPayload;
+        response: CaseFileEntryFileResponseEntity;
+    };
+    /** Metadatos y archivos para exportar el expediente completo. Queda en la trazabilidad y en el registro de accesos. */
+    [CaseFilePatterns.getExport]: {
+        payload: Pick<CaseFileEntity, 'id'> & CaseFileActorPayload;
+        response: CaseFileExportResponseEntity;
+    };
+    /** Crea un enlace temporal: solo su responsable. El token viaja solo en esta respuesta. */
+    [CaseFilePatterns.createShareLink]: {
+        payload: Pick<CaseFileEntity, 'id'> & CaseFileShareLinkPayload & {
+            actor: DocumentActor;
+        };
+        response: CaseFileShareLinkCreateResponseEntity;
+    };
+    /** Enlaces del expediente, vigentes o no, con cuántas veces se usaron: su responsable o quien ve todos. */
+    [CaseFilePatterns.getShareLinks]: {
+        payload: Pick<CaseFileEntity, 'id'> & CaseFileActorPayload;
+        response: CaseFileShareLinkResponseEntity[];
+    };
+    [CaseFilePatterns.revokeShareLink]: {
+        payload: Pick<CaseFileEntity, 'id'> & {
+            linkId: string;
+            actor: DocumentActor;
+        };
+        response: CaseFileUpdateResponseEntity;
+    };
+    /** Sin sesión, con el token del enlace: metadatos e índice. Queda en el registro de accesos. */
+    [CaseFilePatterns.getShared]: {
+        payload: {
+            token: string;
+        };
+        response: CaseFileSharedResponseEntity;
+    };
+    [CaseFilePatterns.getSharedEntryFile]: {
+        payload: {
+            token: string;
+            entryId: string;
+        };
+        response: CaseFileEntryFileResponseEntity;
+    };
+    /** El expediente completo, si el enlace lo permite. Queda en la trazabilidad y en el registro de accesos. */
+    /**
+     * Verificador público del ZIP exportado: sin sesión, con el identificador del expediente y la huella SHA-256 que
+     * calculó el navegador para cada actuación (el ZIP no se sube). Se compara con las huellas registradas al incorporar.
+     */
+    [CaseFilePatterns.verifyExport]: {
+        payload: {
+            code: string;
+            entries: {
+                sequence: number;
+                sha256: string;
+            }[];
+        };
+        response: CaseFileVerifyExportResponseEntity;
+    };
+    [CaseFilePatterns.getSharedExport]: {
+        payload: {
+            token: string;
+        };
+        response: CaseFileExportResponseEntity;
+    };
+}
+export {};

package/dist/contracts/caseFile.contract.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CaseFilePatterns = void 0;
+/** Patrones NATS de `caseFile`: `<servicio>.<recurso>.<acción>`. */
+exports.CaseFilePatterns = {
+    getAll: 'gestorDocumental.caseFile.getAll',
+    getById: 'gestorDocumental.caseFile.getById',
+    create: 'gestorDocumental.caseFile.create',
+    update: 'gestorDocumental.caseFile.update',
+    addEntry: 'gestorDocumental.caseFile.addEntry',
+    addBatch: 'gestorDocumental.caseFile.addBatch',
+    voidEntry: 'gestorDocumental.caseFile.voidEntry',
+    moveEntry: 'gestorDocumental.caseFile.moveEntry',
+    share: 'gestorDocumental.caseFile.share',
+    unshare: 'gestorDocumental.caseFile.unshare',
+    close: 'gestorDocumental.caseFile.close',
+    getEntryFile: 'gestorDocumental.caseFile.getEntryFile',
+    getExport: 'gestorDocumental.caseFile.getExport',
+    createShareLink: 'gestorDocumental.caseFile.createShareLink',
+    getShareLinks: 'gestorDocumental.caseFile.getShareLinks',
+    revokeShareLink: 'gestorDocumental.caseFile.revokeShareLink',
+    getShared: 'gestorDocumental.caseFile.getShared',
+    getSharedEntryFile: 'gestorDocumental.caseFile.getSharedEntryFile',
+    getSharedExport: 'gestorDocumental.caseFile.getSharedExport',
+    verifyExport: 'gestorDocumental.caseFile.verifyExport',
+};