@muni-sanfer/types-gestor-documental 0.0.1-beta.3 → 0.0.1-beta.4

package/dist/base/entities.d.ts

@@ -78,6 +78,68 @@ export declare const DocumentInstruction: {
     Respond: "Respond";
     Archive: "Archive";
 };
+export type CaseFileStatus = 'Open' | 'Closed';
+export declare const CaseFileStatus: {
+    Open: "Open";
+    Closed: "Closed";
+};
+export type CaseFileIncorporationMechanism = 'Manual' | 'WebService' | 'Mixed' | 'CitizenRepository' | 'Interoperability';
+export declare const CaseFileIncorporationMechanism: {
+    Manual: "Manual";
+    WebService: "WebService";
+    Mixed: "Mixed";
+    CitizenRepository: "CitizenRepository";
+    Interoperability: "Interoperability";
+};
+export type CaseFileActuationType = 'AdministrativeAct' | 'Notification' | 'OfficialCommunication' | 'Interoperability' | 'RequestReception' | 'Subfolder' | 'PowerRegistration';
+export declare const CaseFileActuationType: {
+    AdministrativeAct: "AdministrativeAct";
+    Notification: "Notification";
+    OfficialCommunication: "OfficialCommunication";
+    Interoperability: "Interoperability";
+    RequestReception: "RequestReception";
+    Subfolder: "Subfolder";
+    PowerRegistration: "PowerRegistration";
+};
+export type CaseFileEntryKind = 'Document' | 'File' | 'CaseFile';
+export declare const CaseFileEntryKind: {
+    Document: "Document";
+    File: "File";
+    CaseFile: "CaseFile";
+};
+export type CaseFileActorRelation = 'Responsible' | 'Interested' | 'Author' | 'Referred' | 'Recipient' | 'MinisterOfFaith';
+export declare const CaseFileActorRelation: {
+    Responsible: "Responsible";
+    Interested: "Interested";
+    Author: "Author";
+    Referred: "Referred";
+    Recipient: "Recipient";
+    MinisterOfFaith: "MinisterOfFaith";
+};
+export type CaseFileActorType = 'Citizen' | 'Foreigner' | 'PrivateInstitution' | 'Official';
+export declare const CaseFileActorType: {
+    Citizen: "Citizen";
+    Foreigner: "Foreigner";
+    PrivateInstitution: "PrivateInstitution";
+    Official: "Official";
+};
+export type CaseFileTrackingAction = 'Created' | 'Updated' | 'EntryAdded' | 'EntryVoided' | 'ParticipantAdded' | 'ParticipantRemoved' | 'Closed' | 'Exported';
+export declare const CaseFileTrackingAction: {
+    Created: "Created";
+    Updated: "Updated";
+    EntryAdded: "EntryAdded";
+    EntryVoided: "EntryVoided";
+    ParticipantAdded: "ParticipantAdded";
+    ParticipantRemoved: "ParticipantRemoved";
+    Closed: "Closed";
+    Exported: "Exported";
+};
+export type CaseFileAccessAction = 'Viewed' | 'FileDownloaded' | 'Exported';
+export declare const CaseFileAccessAction: {
+    Viewed: "Viewed";
+    FileDownloaded: "FileDownloaded";
+    Exported: "Exported";
+};
 export interface DocumentTypeEntity {
     id: string;
     name: string;
@@ -132,6 +194,7 @@ export interface DocumentEntity {
     annulledNumbers?: DocumentAnnulledNumberEntity[];
     recipients?: DocumentRecipientEntity[];
     deliveries?: DocumentDeliveryEntity[];
+    caseFileEntries?: CaseFileEntryEntity[];
     deleted: boolean;
     createdAt: string;
     updatedAt: string;
@@ -231,3 +294,134 @@ export interface DocumentTypeFlowStepEntity {
     documentTypeId: string;
     createdAt: string;
 }
+export interface ProcedureEntity {
+    id: string;
+    name: string;
+    cpatId?: string | null;
+    cpatCode?: string | null;
+    description?: string | null;
+    enabled: boolean;
+    caseFiles?: CaseFileEntity[];
+    deleted: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CaseFileSequenceEntity {
+    year: number;
+    next: number;
+}
+export interface CaseFileEntity {
+    id: string;
+    code: string;
+    year: number;
+    number: number;
+    title: string;
+    subject: string;
+    summary?: string | null;
+    status: CaseFileStatus;
+    accessLevel: DocumentAccessLevel;
+    hasSensitiveData: boolean;
+    incorporationMechanism: CaseFileIncorporationMechanism;
+    schemaVersion: string;
+    procedure?: ProcedureEntity;
+    procedureId: string;
+    responsibleEmployeeId: string;
+    responsibleFullName: string;
+    responsiblePosition?: string | null;
+    closedAt?: string | null;
+    closedByEmployeeId?: string | null;
+    closedByFullName?: string | null;
+    closingNote?: string | null;
+    participants?: CaseFileParticipantEntity[];
+    actors?: CaseFileActorEntity[];
+    entries?: CaseFileEntryEntity[];
+    linkedFrom?: CaseFileEntryEntity[];
+    trackings?: CaseFileTrackingEntity[];
+    metadataChanges?: CaseFileMetadataChangeEntity[];
+    accesses?: CaseFileAccessEntity[];
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CaseFileParticipantEntity {
+    id: string;
+    employeeId: string;
+    fullName: string;
+    position?: string | null;
+    addedByEmployeeId: string;
+    addedByFullName: string;
+    caseFile?: CaseFileEntity;
+    caseFileId: string;
+    createdAt: string;
+}
+export interface CaseFileActorEntity {
+    id: string;
+    relation: CaseFileActorRelation;
+    actorType: CaseFileActorType;
+    identifier?: string | null;
+    name: string;
+    caseFile?: CaseFileEntity;
+    caseFileId: string;
+    createdAt: string;
+}
+export interface CaseFileEntryEntity {
+    id: string;
+    sequence: number;
+    kind: CaseFileEntryKind;
+    actuationType: CaseFileActuationType;
+    title: string;
+    document?: DocumentEntity | null;
+    documentId?: string | null;
+    fileId?: string | null;
+    fileName?: string | null;
+    documentTypeName?: string | null;
+    originDate?: string | null;
+    author?: string | null;
+    keywords: string[];
+    accessLevel?: DocumentAccessLevel | null;
+    hasSensitiveData?: boolean | null;
+    linkedCaseFile?: CaseFileEntity | null;
+    linkedCaseFileId?: string | null;
+    sha256?: string | null;
+    size?: number | null;
+    hasAdvancedSignature: boolean;
+    incorporatedByEmployeeId: string;
+    incorporatedByFullName: string;
+    voidedAt?: string | null;
+    voidedByEmployeeId?: string | null;
+    voidedByFullName?: string | null;
+    voidReason?: string | null;
+    caseFile?: CaseFileEntity;
+    caseFileId: string;
+    createdAt: string;
+}
+export interface CaseFileTrackingEntity {
+    id: string;
+    action: CaseFileTrackingAction;
+    observation?: string | null;
+    employeeId?: string | null;
+    employeeFullName?: string | null;
+    caseFile?: CaseFileEntity;
+    caseFileId: string;
+    createdAt: string;
+}
+export interface CaseFileMetadataChangeEntity {
+    id: string;
+    field: string;
+    previousValue?: string | null;
+    newValue?: string | null;
+    employeeId: string;
+    employeeFullName: string;
+    caseFile?: CaseFileEntity;
+    caseFileId: string;
+    createdAt: string;
+}
+export interface CaseFileAccessEntity {
+    id: string;
+    action: CaseFileAccessAction;
+    entryId?: string | null;
+    employeeId: string;
+    employeeFullName: string;
+    caseFile?: CaseFileEntity;
+    caseFileId: string;
+    createdAt: string;
+}

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.DocumentFlowStepType = exports.DocumentTrackingAction = exports.DocumentParticipantStatus = exports.DocumentParticipantRole = exports.DocumentAccessLevel = exports.DocumentStatus = exports.DocumentCategory = void 0;
+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.DocumentTrackingAction = exports.DocumentParticipantStatus = exports.DocumentParticipantRole = exports.DocumentAccessLevel = exports.DocumentStatus = exports.DocumentCategory = void 0;
 exports.DocumentCategory = {
     Decree: 'Decree',
     Communication: 'Communication',
@@ -71,3 +71,57 @@ 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',
+};
+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',
+    ParticipantAdded: 'ParticipantAdded',
+    ParticipantRemoved: 'ParticipantRemoved',
+    Closed: 'Closed',
+    Exported: 'Exported',
+};
+exports.CaseFileAccessAction = {
+    Viewed: 'Viewed',
+    FileDownloaded: 'FileDownloaded',
+    Exported: 'Exported',
+};

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

@@ -0,0 +1,149 @@
+import { type CaseFileActorRelation, type CaseFileActorType, type CaseFileActuationType, type CaseFileEntity, type CaseFileStatus, type DocumentAccessLevel } from '../base/entities';
+import { type CaseFileAddEntryResponseEntity, type CaseFileCreateResponseEntity, type CaseFileEntryFileResponseEntity, type CaseFileExportResponseEntity, type CaseFileGetAllResponseEntity, type CaseFileGetByIdResponseEntity, type CaseFileUpdateResponseEntity } 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 voidEntry: "gestorDocumental.caseFile.voidEntry";
+    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";
+};
+/** 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;
+    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;
+};
+/** 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;
+    };
+    [CaseFilePatterns.addEntry]: {
+        payload: Pick<CaseFileEntity, 'id'> & {
+            entry: CaseFileEntryInput;
+        } & CaseFileActorPayload;
+        response: CaseFileAddEntryResponseEntity;
+    };
+    /** Deja una actuación sin efecto, con su motivo. No se elimina del índice. */
+    [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;
+    };
+}
+export {};

package/dist/contracts/caseFile.contract.js

@@ -0,0 +1,17 @@
+"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',
+    voidEntry: 'gestorDocumental.caseFile.voidEntry',
+    share: 'gestorDocumental.caseFile.share',
+    unshare: 'gestorDocumental.caseFile.unshare',
+    close: 'gestorDocumental.caseFile.close',
+    getEntryFile: 'gestorDocumental.caseFile.getEntryFile',
+    getExport: 'gestorDocumental.caseFile.getExport',
+};

package/dist/contracts/index.d.ts

@@ -1,8 +1,12 @@
+import { type CaseFileContract } from './caseFile.contract';
 import { type DocumentContract } from './document.contract';
 import { type DocumentTypeContract } from './documentType.contract';
+import { type ProcedureContract } from './procedure.contract';
 export * from './contract';
 export * from './document.contract';
 export * from './documentType.contract';
+export * from './procedure.contract';
+export * from './caseFile.contract';
 /** Patrones NATS de gestor-documental-ms, por recurso: `gestorDocumental.<recurso>.<acción>`. */
 export declare const GestorDocumentalPatterns: {
     readonly documentType: {
@@ -29,6 +33,26 @@ export declare const GestorDocumentalPatterns: {
         readonly getPublicFile: "gestorDocumental.document.getPublicFile";
         readonly getFilesFolder: "gestorDocumental.document.getFilesFolder";
     };
+    readonly procedure: {
+        readonly getAll: "gestorDocumental.procedure.getAll";
+        readonly getById: "gestorDocumental.procedure.getById";
+        readonly create: "gestorDocumental.procedure.create";
+        readonly update: "gestorDocumental.procedure.update";
+        readonly setEnabled: "gestorDocumental.procedure.setEnabled";
+    };
+    readonly caseFile: {
+        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 voidEntry: "gestorDocumental.caseFile.voidEntry";
+        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";
+    };
 };
 /** Contrato completo de gestor-documental-ms: la unión de los contratos de sus recursos. */
-export type GestorDocumentalContract = DocumentTypeContract & DocumentContract;
+export type GestorDocumentalContract = DocumentTypeContract & DocumentContract & ProcedureContract & CaseFileContract;

package/dist/contracts/index.js

@@ -15,13 +15,19 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GestorDocumentalPatterns = void 0;
+const caseFile_contract_1 = require("./caseFile.contract");
 const document_contract_1 = require("./document.contract");
 const documentType_contract_1 = require("./documentType.contract");
+const procedure_contract_1 = require("./procedure.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);
 /** Patrones NATS de gestor-documental-ms, por recurso: `gestorDocumental.<recurso>.<acción>`. */
 exports.GestorDocumentalPatterns = {
     documentType: documentType_contract_1.DocumentTypePatterns,
     document: document_contract_1.DocumentPatterns,
+    procedure: procedure_contract_1.ProcedurePatterns,
+    caseFile: caseFile_contract_1.CaseFilePatterns,
 };

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

@@ -0,0 +1,50 @@
+import { type ProcedureEntity } from '../base/entities';
+import { type ProcedureCreateResponseEntity, type ProcedureGetAllResponseEntity, type ProcedureGetByIdResponseEntity, type ProcedureUpdateResponseEntity } from '../entities';
+import { type RpcPage } from './contract';
+/** Patrones NATS de `procedure`: `<servicio>.<recurso>.<acción>`. */
+export declare const ProcedurePatterns: {
+    readonly getAll: "gestorDocumental.procedure.getAll";
+    readonly getById: "gestorDocumental.procedure.getById";
+    readonly create: "gestorDocumental.procedure.create";
+    readonly update: "gestorDocumental.procedure.update";
+    readonly setEnabled: "gestorDocumental.procedure.setEnabled";
+};
+/** Datos de un procedimiento administrativo al crearlo o editarlo. */
+export interface ProcedureWritePayload {
+    name: string;
+    cpatId?: string | null;
+    cpatCode?: string | null;
+    description?: string | null;
+    enabled?: boolean;
+}
+export interface ProcedureContract {
+    [ProcedurePatterns.getAll]: {
+        payload: {
+            pagination?: {
+                page?: number;
+                limit?: number;
+            };
+            filters?: {
+                search?: string;
+                enabled?: boolean;
+            };
+        };
+        response: RpcPage<ProcedureGetAllResponseEntity[]>;
+    };
+    [ProcedurePatterns.getById]: {
+        payload: Pick<ProcedureEntity, 'id'>;
+        response: ProcedureGetByIdResponseEntity;
+    };
+    [ProcedurePatterns.create]: {
+        payload: ProcedureWritePayload;
+        response: ProcedureCreateResponseEntity;
+    };
+    [ProcedurePatterns.update]: {
+        payload: ProcedureWritePayload & Pick<ProcedureEntity, 'id'>;
+        response: ProcedureUpdateResponseEntity;
+    };
+    [ProcedurePatterns.setEnabled]: {
+        payload: Pick<ProcedureEntity, 'id' | 'enabled'>;
+        response: ProcedureUpdateResponseEntity;
+    };
+}

package/dist/contracts/procedure.contract.js

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