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

package/dist/base/entities.d.ts

@@ -4,7 +4,7 @@ export declare const DocumentCategory: {
     Communication: "Communication";
     Other: "Other";
 };
-export type DocumentStatus = 'Drafted' | 'PendingVisa' | 'PendingSignature' | 'Finished' | 'Rejected' | 'Discarded';
+export type DocumentStatus = 'Drafted' | 'PendingVisa' | 'PendingSignature' | 'Finished' | 'Rejected' | 'Discarded' | 'Annulled';
 export declare const DocumentStatus: {
     Drafted: "Drafted";
     PendingVisa: "PendingVisa";
@@ -12,6 +12,7 @@ export declare const DocumentStatus: {
     Finished: "Finished";
     Rejected: "Rejected";
     Discarded: "Discarded";
+    Annulled: "Annulled";
 };
 export type DocumentAccessLevel = 'Public' | 'Restricted' | 'Secret' | 'Reserved';
 export declare const DocumentAccessLevel: {
@@ -32,7 +33,7 @@ export declare const DocumentParticipantStatus: {
     Resolved: "Resolved";
     Rejected: "Rejected";
 };
-export type DocumentTrackingAction = 'Created' | 'Updated' | 'Submitted' | 'Visaed' | 'Signed' | 'Rejected' | 'Finished' | 'Discarded';
+export type DocumentTrackingAction = 'Created' | 'Updated' | 'Submitted' | 'Visaed' | 'Signed' | 'Rejected' | 'Finished' | 'Discarded' | 'Numbered' | 'NumberAnnulled' | 'Annulled' | 'Delivered' | 'Derived';
 export declare const DocumentTrackingAction: {
     Created: "Created";
     Updated: "Updated";
@@ -42,12 +43,35 @@ export declare const DocumentTrackingAction: {
     Rejected: "Rejected";
     Finished: "Finished";
     Discarded: "Discarded";
+    Numbered: "Numbered";
+    NumberAnnulled: "NumberAnnulled";
+    Annulled: "Annulled";
+    Delivered: "Delivered";
+    Derived: "Derived";
 };
 export type DocumentAttachmentType = 'File' | 'Link';
 export declare const DocumentAttachmentType: {
     File: "File";
     Link: "Link";
 };
+export type DocumentRecipientType = 'Employee' | 'Directorate' | 'Department';
+export declare const DocumentRecipientType: {
+    Employee: "Employee";
+    Directorate: "Directorate";
+    Department: "Department";
+};
+export type DocumentDeliveryOrigin = 'Recipient' | 'Derivation';
+export declare const DocumentDeliveryOrigin: {
+    Recipient: "Recipient";
+    Derivation: "Derivation";
+};
+export type DocumentInstruction = 'Knowledge' | 'Inform' | 'Respond' | 'Archive';
+export declare const DocumentInstruction: {
+    Knowledge: "Knowledge";
+    Inform: "Inform";
+    Respond: "Respond";
+    Archive: "Archive";
+};
 export interface DocumentTypeEntity {
     id: string;
     name: string;
@@ -60,6 +84,7 @@ export interface DocumentTypeEntity {
     directorateCodeReference?: number | null;
     enabled: boolean;
     documents?: DocumentEntity[];
+    annulledNumbers?: DocumentAnnulledNumberEntity[];
     deleted: boolean;
     createdAt: string;
     updatedAt: string;
@@ -74,6 +99,14 @@ export interface DocumentEntity {
     correlative?: number | null;
     correlativeYear?: number | null;
     numberedAt?: string | null;
+    verificationCode?: string | null;
+    signatureSheet: boolean;
+    annulledAt?: string | null;
+    annulmentReason?: string | null;
+    responseDueAt?: string | null;
+    replyTo?: DocumentEntity | null;
+    replyToDocumentId?: string | null;
+    replies?: DocumentEntity[];
     directorateCodeReference?: number | null;
     departmentId?: string | null;
     createdByEmployeeId: string;
@@ -89,6 +122,9 @@ export interface DocumentEntity {
     participants?: DocumentParticipantEntity[];
     attachments?: DocumentAttachmentEntity[];
     trackings?: DocumentTrackingEntity[];
+    annulledNumbers?: DocumentAnnulledNumberEntity[];
+    recipients?: DocumentRecipientEntity[];
+    deliveries?: DocumentDeliveryEntity[];
     deleted: boolean;
     createdAt: string;
     updatedAt: string;
@@ -130,3 +166,48 @@ export interface DocumentTrackingEntity {
     documentId: string;
     createdAt: string;
 }
+export interface DocumentAnnulledNumberEntity {
+    id: string;
+    correlative: number;
+    correlativeYear: number;
+    reason: string;
+    employeeId: string;
+    employeeFullName: string;
+    documentType?: DocumentTypeEntity;
+    documentTypeId: string;
+    document?: DocumentEntity;
+    documentId: string;
+    createdAt: string;
+}
+export interface DocumentRecipientEntity {
+    id: string;
+    type: DocumentRecipientType;
+    employeeId?: string | null;
+    directorateCodeReference?: number | null;
+    departmentId?: string | null;
+    name: string;
+    position?: string | null;
+    document?: DocumentEntity;
+    documentId: string;
+    createdAt: string;
+}
+export interface DocumentDeliveryEntity {
+    id: string;
+    origin: DocumentDeliveryOrigin;
+    employeeId: string;
+    fullName: string;
+    position?: string | null;
+    areaName?: string | null;
+    sentByEmployeeId?: string | null;
+    sentByFullName?: string | null;
+    instruction?: DocumentInstruction | null;
+    note?: string | null;
+    dueAt?: string | null;
+    deliveredAt?: string | null;
+    readAt?: string | null;
+    closedAt?: string | null;
+    closingNote?: string | null;
+    document?: DocumentEntity;
+    documentId: 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.DocumentAttachmentType = exports.DocumentTrackingAction = exports.DocumentParticipantStatus = exports.DocumentParticipantRole = exports.DocumentAccessLevel = exports.DocumentStatus = exports.DocumentCategory = void 0;
+exports.DocumentInstruction = exports.DocumentDeliveryOrigin = exports.DocumentRecipientType = exports.DocumentAttachmentType = exports.DocumentTrackingAction = exports.DocumentParticipantStatus = exports.DocumentParticipantRole = exports.DocumentAccessLevel = exports.DocumentStatus = exports.DocumentCategory = void 0;
 exports.DocumentCategory = {
     Decree: 'Decree',
     Communication: 'Communication',
@@ -14,6 +14,7 @@ exports.DocumentStatus = {
     Finished: 'Finished',
     Rejected: 'Rejected',
     Discarded: 'Discarded',
+    Annulled: 'Annulled',
 };
 exports.DocumentAccessLevel = {
     Public: 'Public',
@@ -40,8 +41,28 @@ exports.DocumentTrackingAction = {
     Rejected: 'Rejected',
     Finished: 'Finished',
     Discarded: 'Discarded',
+    Numbered: 'Numbered',
+    NumberAnnulled: 'NumberAnnulled',
+    Annulled: 'Annulled',
+    Delivered: 'Delivered',
+    Derived: 'Derived',
 };
 exports.DocumentAttachmentType = {
     File: 'File',
     Link: 'Link',
 };
+exports.DocumentRecipientType = {
+    Employee: 'Employee',
+    Directorate: 'Directorate',
+    Department: 'Department',
+};
+exports.DocumentDeliveryOrigin = {
+    Recipient: 'Recipient',
+    Derivation: 'Derivation',
+};
+exports.DocumentInstruction = {
+    Knowledge: 'Knowledge',
+    Inform: 'Inform',
+    Respond: 'Respond',
+    Archive: 'Archive',
+};

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

@@ -1,15 +1,21 @@
-import { type DocumentAccessLevel, type DocumentAttachmentEntity, type DocumentEntity, type DocumentStatus } from '../base/entities';
-import { type DocumentCreateResponseEntity, type DocumentDiscardResponseEntity, type DocumentGetAllResponseEntity, type DocumentGetByIdResponseEntity, type DocumentGetSummaryResponseEntity, type DocumentReviewResponseEntity, type DocumentUpdateResponseEntity } from '../entities';
+import { type DocumentAccessLevel, type DocumentAttachmentEntity, type DocumentDeliveryEntity, type DocumentEntity, type DocumentInstruction, type DocumentStatus } from '../base/entities';
+import { type DocumentAnnulResponseEntity, type DocumentCloseDeliveryResponseEntity, type DocumentCreateResponseEntity, type DocumentDeriveResponseEntity, type DocumentDiscardResponseEntity, type DocumentGetAllResponseEntity, type DocumentGetByIdResponseEntity, type DocumentGetSummaryResponseEntity, type DocumentInboxItemEntity, type DocumentPublicFileResponseEntity, type DocumentReviewResponseEntity, type DocumentUpdateResponseEntity, type DocumentVerifyResponseEntity } from '../entities';
 import { type RpcPage } from './contract';
 /** Patrones NATS de `document`: `<servicio>.<recurso>.<acción>`. */
 export declare const DocumentPatterns: {
     readonly getAll: "gestorDocumental.document.getAll";
+    readonly getInbox: "gestorDocumental.document.getInbox";
     readonly getSummary: "gestorDocumental.document.getSummary";
     readonly getById: "gestorDocumental.document.getById";
     readonly create: "gestorDocumental.document.create";
     readonly update: "gestorDocumental.document.update";
     readonly review: "gestorDocumental.document.review";
     readonly discard: "gestorDocumental.document.discard";
+    readonly annul: "gestorDocumental.document.annul";
+    readonly derive: "gestorDocumental.document.derive";
+    readonly closeDelivery: "gestorDocumental.document.closeDelivery";
+    readonly verify: "gestorDocumental.document.verify";
+    readonly getPublicFile: "gestorDocumental.document.getPublicFile";
     readonly getFilesFolder: "gestorDocumental.document.getFilesFolder";
 };
 /**
@@ -22,7 +28,27 @@ export interface DocumentActor {
     departmentIds: string[];
 }
 /** Bandeja desde la que se lista. Todas son del funcionario (`actor`), salvo `all`. */
-export type DocumentBucket = 'created' | 'toVisa' | 'toSign' | 'participated' | 'all';
+export type DocumentBucket = 'created' | 'sent' | 'toVisa' | 'toSign' | 'participated' | 'all';
+/**
+ * Destinatario de un documento o de una derivación: una persona o un área completa. El gateway resuelve el nombre del
+ * área y quiénes la integran hoy; el navegador solo indica cuál es.
+ */
+export type DocumentRecipientInput = {
+    type: 'Employee';
+    employeeId: string;
+} | {
+    type: 'Directorate';
+    directorateCodeReference: number;
+    name: string;
+    memberEmployeeIds: string[];
+} | {
+    type: 'Department';
+    departmentId: string;
+    name: string;
+    memberEmployeeIds: string[];
+};
+/** Qué parte de la bandeja de recibidos se lista: lo que falta atender, lo ya atendido, o todo. */
+export type DocumentInboxState = 'pending' | 'closed' | 'all';
 /** Qué hace con el documento quien tiene el turno. */
 export type DocumentReviewAction = 'Visa' | 'Sign' | 'Reject';
 /**
@@ -42,6 +68,10 @@ export interface DocumentWritePayload extends Pick<DocumentEntity, 'subject' | '
     attachments?: Pick<DocumentAttachmentEntity, 'name' | 'type' | 'fileId' | 'url'>[];
     visaEmployeeIds: string[];
     signatureEmployeeIds: string[];
+    signatureSheet?: boolean;
+    recipients?: DocumentRecipientInput[];
+    responseDueAt?: string | null;
+    replyToDocumentId?: string | null;
     action?: 'Submit';
     actor: DocumentActor;
 }
@@ -67,6 +97,21 @@ export interface DocumentContract {
         };
         response: RpcPage<DocumentGetAllResponseEntity[]>;
     };
+    /** Bandeja de recibidos de un funcionario: lo que le llegó como destinatario o por derivación. */
+    [DocumentPatterns.getInbox]: {
+        payload: {
+            pagination?: {
+                page?: number;
+                limit?: number;
+            };
+            filters?: {
+                search?: string;
+                state?: DocumentInboxState;
+            };
+            actor: DocumentActor;
+        };
+        response: RpcPage<DocumentInboxItemEntity[]>;
+    };
     [DocumentPatterns.getSummary]: {
         payload: {
             actor: DocumentActor;
@@ -109,6 +154,53 @@ export interface DocumentContract {
         };
         response: DocumentDiscardResponseEntity;
     };
+    /** Deja sin efecto un documento ya finalizado. Conserva su número, que no se reutiliza. */
+    [DocumentPatterns.annul]: {
+        payload: Pick<DocumentEntity, 'id'> & {
+            reason: string;
+            actor: DocumentActor;
+        };
+        response: DocumentAnnulResponseEntity;
+    };
+    /**
+     * Deriva un documento finalizado a otros funcionarios o áreas, con su providencia (qué se espera de ellos) y,
+     * si corresponde, un plazo. Puede hacerlo quien lo tiene a su alcance: su redactor, quien lo visó o firmó, quien lo
+     * recibió y, con `viewAll`, quien consulta el historial.
+     */
+    [DocumentPatterns.derive]: {
+        payload: Pick<DocumentEntity, 'id'> & {
+            recipients: DocumentRecipientInput[];
+            instruction: DocumentInstruction;
+            note?: string | null;
+            dueAt?: string | null;
+            actor: DocumentActor;
+            viewAll?: boolean;
+        };
+        response: DocumentDeriveResponseEntity;
+    };
+    /** Quien recibió un documento lo marca como atendido, con una nota opcional. */
+    [DocumentPatterns.closeDelivery]: {
+        payload: {
+            deliveryId: DocumentDeliveryEntity['id'];
+            note?: string | null;
+            actor: DocumentActor;
+        };
+        response: DocumentCloseDeliveryResponseEntity;
+    };
+    /** Comprobación pública de un documento con el código que lleva impreso. No exige sesión. */
+    [DocumentPatterns.verify]: {
+        payload: {
+            code: string;
+        };
+        response: DocumentVerifyResponseEntity;
+    };
+    /** Archivo de un documento finalizado y de acceso público, para quien lo verificó con su código. */
+    [DocumentPatterns.getPublicFile]: {
+        payload: {
+            code: string;
+        };
+        response: DocumentPublicFileResponseEntity;
+    };
     /** Carpeta de Drive de los documentos y sus anexos: el gateway la pide antes de subir cada archivo. */
     [DocumentPatterns.getFilesFolder]: {
         payload: Record<string, never>;

package/dist/contracts/document.contract.js

@@ -4,11 +4,17 @@ exports.DocumentPatterns = void 0;
 /** Patrones NATS de `document`: `<servicio>.<recurso>.<acción>`. */
 exports.DocumentPatterns = {
     getAll: 'gestorDocumental.document.getAll',
+    getInbox: 'gestorDocumental.document.getInbox',
     getSummary: 'gestorDocumental.document.getSummary',
     getById: 'gestorDocumental.document.getById',
     create: 'gestorDocumental.document.create',
     update: 'gestorDocumental.document.update',
     review: 'gestorDocumental.document.review',
     discard: 'gestorDocumental.document.discard',
+    annul: 'gestorDocumental.document.annul',
+    derive: 'gestorDocumental.document.derive',
+    closeDelivery: 'gestorDocumental.document.closeDelivery',
+    verify: 'gestorDocumental.document.verify',
+    getPublicFile: 'gestorDocumental.document.getPublicFile',
     getFilesFolder: 'gestorDocumental.document.getFilesFolder',
 };

package/dist/contracts/index.d.ts

@@ -14,12 +14,18 @@ export declare const GestorDocumentalPatterns: {
     };
     readonly document: {
         readonly getAll: "gestorDocumental.document.getAll";
+        readonly getInbox: "gestorDocumental.document.getInbox";
         readonly getSummary: "gestorDocumental.document.getSummary";
         readonly getById: "gestorDocumental.document.getById";
         readonly create: "gestorDocumental.document.create";
         readonly update: "gestorDocumental.document.update";
         readonly review: "gestorDocumental.document.review";
         readonly discard: "gestorDocumental.document.discard";
+        readonly annul: "gestorDocumental.document.annul";
+        readonly derive: "gestorDocumental.document.derive";
+        readonly closeDelivery: "gestorDocumental.document.closeDelivery";
+        readonly verify: "gestorDocumental.document.verify";
+        readonly getPublicFile: "gestorDocumental.document.getPublicFile";
         readonly getFilesFolder: "gestorDocumental.document.getFilesFolder";
     };
 };

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

@@ -1,4 +1,4 @@
-import { DocumentAttachmentEntity, DocumentEntity, DocumentParticipantEntity, DocumentTrackingEntity, DocumentTypeEntity } from '../../base/entities';
+import { DocumentAnnulledNumberEntity, DocumentAttachmentEntity, DocumentDeliveryEntity, DocumentEntity, DocumentParticipantEntity, DocumentRecipientEntity, DocumentTrackingEntity, DocumentTypeEntity } from '../../base/entities';
 /** Tipo documental de un documento, con lo necesario para citarlo. */
 export interface DocumentTypeSummaryEntity {
     id: DocumentTypeEntity['id'];
@@ -17,6 +17,45 @@ export interface DocumentParticipantResponseEntity {
     observation: DocumentParticipantEntity['observation'];
     resolvedAt: DocumentParticipantEntity['resolvedAt'];
 }
+/** Destinatario de un documento, como lo eligió el redactor: una persona o un área completa. */
+export interface DocumentRecipientResponseEntity {
+    id: DocumentRecipientEntity['id'];
+    type: DocumentRecipientEntity['type'];
+    employeeId: DocumentRecipientEntity['employeeId'];
+    directorateCodeReference: DocumentRecipientEntity['directorateCodeReference'];
+    departmentId: DocumentRecipientEntity['departmentId'];
+    name: DocumentRecipientEntity['name'];
+    position: DocumentRecipientEntity['position'];
+}
+/** Un documento en la bandeja de un funcionario: como destinatario o porque se lo derivaron. */
+export interface DocumentDeliveryResponseEntity {
+    id: DocumentDeliveryEntity['id'];
+    origin: DocumentDeliveryEntity['origin'];
+    employeeId: DocumentDeliveryEntity['employeeId'];
+    fullName: DocumentDeliveryEntity['fullName'];
+    position: DocumentDeliveryEntity['position'];
+    areaName: DocumentDeliveryEntity['areaName'];
+    sentByEmployeeId: DocumentDeliveryEntity['sentByEmployeeId'];
+    sentByFullName: DocumentDeliveryEntity['sentByFullName'];
+    instruction: DocumentDeliveryEntity['instruction'];
+    note: DocumentDeliveryEntity['note'];
+    dueAt: DocumentDeliveryEntity['dueAt'];
+    deliveredAt: DocumentDeliveryEntity['deliveredAt'];
+    readAt: DocumentDeliveryEntity['readAt'];
+    closedAt: DocumentDeliveryEntity['closedAt'];
+    closingNote: DocumentDeliveryEntity['closingNote'];
+}
+/** Lo necesario para citar otro documento y enlazarlo (el que se responde, o las respuestas). */
+export interface DocumentLinkEntity {
+    id: DocumentEntity['id'];
+    subject: DocumentEntity['subject'];
+    status: DocumentEntity['status'];
+    correlative: DocumentEntity['correlative'];
+    correlativeYear: DocumentEntity['correlativeYear'];
+    createdByFullName: DocumentEntity['createdByFullName'];
+    finishedAt: DocumentEntity['finishedAt'];
+    documentType: DocumentTypeSummaryEntity;
+}
 export interface DocumentGetAllResponseEntity {
     id: DocumentEntity['id'];
     subject: DocumentEntity['subject'];
@@ -31,6 +70,14 @@ export interface DocumentGetAllResponseEntity {
     createdByFullName: DocumentEntity['createdByFullName'];
     documentType: DocumentTypeSummaryEntity;
     currentParticipant: Pick<DocumentParticipantResponseEntity, 'role' | 'employeeId' | 'fullName'> | null;
+    distribution: {
+        total: number;
+        read: number;
+    } | null;
+}
+/** Una entrada de la bandeja de recibidos: la entrega y el documento al que corresponde. */
+export interface DocumentInboxItemEntity extends DocumentDeliveryResponseEntity {
+    document: DocumentLinkEntity;
 }
 export interface DocumentGetByIdResponseEntity {
     id: DocumentEntity['id'];
@@ -52,6 +99,23 @@ export interface DocumentGetByIdResponseEntity {
     createdAt: DocumentEntity['createdAt'];
     submittedAt: DocumentEntity['submittedAt'];
     finishedAt: DocumentEntity['finishedAt'];
+    verificationCode: DocumentEntity['verificationCode'];
+    verificationUrl: string | null;
+    signatureSheet: DocumentEntity['signatureSheet'];
+    annulledAt: DocumentEntity['annulledAt'];
+    annulmentReason: DocumentEntity['annulmentReason'];
+    annulledNumbers: {
+        correlative: DocumentAnnulledNumberEntity['correlative'];
+        correlativeYear: DocumentAnnulledNumberEntity['correlativeYear'];
+        reason: DocumentAnnulledNumberEntity['reason'];
+        employeeFullName: DocumentAnnulledNumberEntity['employeeFullName'];
+        createdAt: DocumentAnnulledNumberEntity['createdAt'];
+    }[];
+    responseDueAt: DocumentEntity['responseDueAt'];
+    recipients: DocumentRecipientResponseEntity[];
+    deliveries: DocumentDeliveryResponseEntity[];
+    replyTo: DocumentLinkEntity | null;
+    replies: DocumentLinkEntity[];
     documentType: DocumentTypeSummaryEntity;
     participants: DocumentParticipantResponseEntity[];
     attachments: {
@@ -73,6 +137,9 @@ export interface DocumentGetByIdResponseEntity {
         turn: Pick<DocumentParticipantResponseEntity, 'id' | 'role'> | null;
         canEdit: boolean;
         canDiscard: boolean;
+        canDerive: boolean;
+        canReply: boolean;
+        inbox: DocumentDeliveryResponseEntity[];
     };
     signatureRequiresOtp: boolean;
 }
@@ -86,6 +153,11 @@ export interface DocumentGetSummaryResponseEntity {
         rejected: number;
         finished: number;
     };
+    received: {
+        unread: number;
+        pending: number;
+        overdue: number;
+    };
 }
 export interface DocumentCreateResponseEntity {
     id: DocumentEntity['id'];
@@ -104,3 +176,49 @@ export interface DocumentDiscardResponseEntity {
     id: DocumentEntity['id'];
     ok: boolean;
 }
+export interface DocumentAnnulResponseEntity {
+    id: DocumentEntity['id'];
+    ok: boolean;
+}
+/**
+ * Qué se le dice a quien comprueba un documento con su código, sin sesión:
+ *  - `Finished`: es un documento oficial vigente;
+ *  - `Annulled`: lo fue, pero quedó sin efecto;
+ *  - `InProgress`: todavía se está firmando, así que la copia que tiene no es el documento oficial.
+ */
+export type DocumentVerificationState = 'Finished' | 'Annulled' | 'InProgress';
+/**
+ * Respuesta pública de la verificación. Dice lo necesario para comprobar la autenticidad (tipo, número, fecha y
+ * quiénes firmaron); la materia y la descarga solo se entregan si el documento es de acceso público.
+ */
+export interface DocumentVerifyResponseEntity {
+    state: DocumentVerificationState;
+    verificationCode: string;
+    documentType: Pick<DocumentTypeSummaryEntity, 'name' | 'abbreviation'>;
+    correlative: DocumentEntity['correlative'];
+    correlativeYear: DocumentEntity['correlativeYear'];
+    numberedAt: DocumentEntity['numberedAt'];
+    finishedAt: DocumentEntity['finishedAt'];
+    annulledAt: DocumentEntity['annulledAt'];
+    signers: {
+        fullName: DocumentParticipantEntity['fullName'];
+        position: DocumentParticipantEntity['position'];
+        signedAt: DocumentParticipantEntity['resolvedAt'];
+    }[];
+    subject: DocumentEntity['subject'] | null;
+    canDownload: boolean;
+}
+/** Archivo de un documento público, para que el gateway lo entregue a quien lo verifica. */
+export interface DocumentPublicFileResponseEntity {
+    fileId: string;
+    fileName: string;
+}
+export interface DocumentDeriveResponseEntity {
+    id: DocumentEntity['id'];
+    ok: boolean;
+    delivered: number;
+}
+export interface DocumentCloseDeliveryResponseEntity {
+    id: DocumentDeliveryEntity['id'];
+    ok: boolean;
+}

package/package.json

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

package/src/base/entities.ts

@@ -8,7 +8,8 @@ export const DocumentCategory = {
   Other: 'Other',
 } satisfies Record<string, DocumentCategory>;
 
-export type DocumentStatus = 'Drafted' | 'PendingVisa' | 'PendingSignature' | 'Finished' | 'Rejected' | 'Discarded';
+export type DocumentStatus =
+  'Drafted' | 'PendingVisa' | 'PendingSignature' | 'Finished' | 'Rejected' | 'Discarded' | 'Annulled';
 
 export const DocumentStatus = {
   Drafted: 'Drafted',
@@ -17,6 +18,7 @@ export const DocumentStatus = {
   Finished: 'Finished',
   Rejected: 'Rejected',
   Discarded: 'Discarded',
+  Annulled: 'Annulled',
 } satisfies Record<string, DocumentStatus>;
 
 export type DocumentAccessLevel = 'Public' | 'Restricted' | 'Secret' | 'Reserved';
@@ -45,7 +47,19 @@ export const DocumentParticipantStatus = {
 } satisfies Record<string, DocumentParticipantStatus>;
 
 export type DocumentTrackingAction =
-  'Created' | 'Updated' | 'Submitted' | 'Visaed' | 'Signed' | 'Rejected' | 'Finished' | 'Discarded';
+  | 'Created'
+  | 'Updated'
+  | 'Submitted'
+  | 'Visaed'
+  | 'Signed'
+  | 'Rejected'
+  | 'Finished'
+  | 'Discarded'
+  | 'Numbered'
+  | 'NumberAnnulled'
+  | 'Annulled'
+  | 'Delivered'
+  | 'Derived';
 
 export const DocumentTrackingAction = {
   Created: 'Created',
@@ -56,6 +70,11 @@ export const DocumentTrackingAction = {
   Rejected: 'Rejected',
   Finished: 'Finished',
   Discarded: 'Discarded',
+  Numbered: 'Numbered',
+  NumberAnnulled: 'NumberAnnulled',
+  Annulled: 'Annulled',
+  Delivered: 'Delivered',
+  Derived: 'Derived',
 } satisfies Record<string, DocumentTrackingAction>;
 
 export type DocumentAttachmentType = 'File' | 'Link';
@@ -65,6 +84,30 @@ export const DocumentAttachmentType = {
   Link: 'Link',
 } satisfies Record<string, DocumentAttachmentType>;
 
+export type DocumentRecipientType = 'Employee' | 'Directorate' | 'Department';
+
+export const DocumentRecipientType = {
+  Employee: 'Employee',
+  Directorate: 'Directorate',
+  Department: 'Department',
+} satisfies Record<string, DocumentRecipientType>;
+
+export type DocumentDeliveryOrigin = 'Recipient' | 'Derivation';
+
+export const DocumentDeliveryOrigin = {
+  Recipient: 'Recipient',
+  Derivation: 'Derivation',
+} satisfies Record<string, DocumentDeliveryOrigin>;
+
+export type DocumentInstruction = 'Knowledge' | 'Inform' | 'Respond' | 'Archive';
+
+export const DocumentInstruction = {
+  Knowledge: 'Knowledge',
+  Inform: 'Inform',
+  Respond: 'Respond',
+  Archive: 'Archive',
+} satisfies Record<string, DocumentInstruction>;
+
 export interface DocumentTypeEntity {
   id: string;
   name: string;
@@ -77,6 +120,7 @@ export interface DocumentTypeEntity {
   directorateCodeReference?: number | null;
   enabled: boolean;
   documents?: DocumentEntity[];
+  annulledNumbers?: DocumentAnnulledNumberEntity[];
   deleted: boolean;
   createdAt: string;
   updatedAt: string;
@@ -92,6 +136,14 @@ export interface DocumentEntity {
   correlative?: number | null;
   correlativeYear?: number | null;
   numberedAt?: string | null;
+  verificationCode?: string | null;
+  signatureSheet: boolean;
+  annulledAt?: string | null;
+  annulmentReason?: string | null;
+  responseDueAt?: string | null;
+  replyTo?: DocumentEntity | null;
+  replyToDocumentId?: string | null;
+  replies?: DocumentEntity[];
   directorateCodeReference?: number | null;
   departmentId?: string | null;
   createdByEmployeeId: string;
@@ -107,6 +159,9 @@ export interface DocumentEntity {
   participants?: DocumentParticipantEntity[];
   attachments?: DocumentAttachmentEntity[];
   trackings?: DocumentTrackingEntity[];
+  annulledNumbers?: DocumentAnnulledNumberEntity[];
+  recipients?: DocumentRecipientEntity[];
+  deliveries?: DocumentDeliveryEntity[];
   deleted: boolean;
   createdAt: string;
   updatedAt: string;
@@ -151,3 +206,51 @@ export interface DocumentTrackingEntity {
   documentId: string;
   createdAt: string;
 }
+
+export interface DocumentAnnulledNumberEntity {
+  id: string;
+  correlative: number;
+  correlativeYear: number;
+  reason: string;
+  employeeId: string;
+  employeeFullName: string;
+  documentType?: DocumentTypeEntity;
+  documentTypeId: string;
+  document?: DocumentEntity;
+  documentId: string;
+  createdAt: string;
+}
+
+export interface DocumentRecipientEntity {
+  id: string;
+  type: DocumentRecipientType;
+  employeeId?: string | null;
+  directorateCodeReference?: number | null;
+  departmentId?: string | null;
+  name: string;
+  position?: string | null;
+  document?: DocumentEntity;
+  documentId: string;
+  createdAt: string;
+}
+
+export interface DocumentDeliveryEntity {
+  id: string;
+  origin: DocumentDeliveryOrigin;
+  employeeId: string;
+  fullName: string;
+  position?: string | null;
+  areaName?: string | null;
+  sentByEmployeeId?: string | null;
+  sentByFullName?: string | null;
+  instruction?: DocumentInstruction | null;
+  note?: string | null;
+  dueAt?: string | null;
+  deliveredAt?: string | null;
+  readAt?: string | null;
+  closedAt?: string | null;
+  closingNote?: string | null;
+  document?: DocumentEntity;
+  documentId: string;
+  createdAt: string;
+}

package/src/contracts/document.contract.ts

@@ -1,29 +1,43 @@
 import {
   type DocumentAccessLevel,
   type DocumentAttachmentEntity,
+  type DocumentDeliveryEntity,
   type DocumentEntity,
+  type DocumentInstruction,
   type DocumentStatus,
 } from '../base/entities';
 import {
+  type DocumentAnnulResponseEntity,
+  type DocumentCloseDeliveryResponseEntity,
   type DocumentCreateResponseEntity,
+  type DocumentDeriveResponseEntity,
   type DocumentDiscardResponseEntity,
   type DocumentGetAllResponseEntity,
   type DocumentGetByIdResponseEntity,
   type DocumentGetSummaryResponseEntity,
+  type DocumentInboxItemEntity,
+  type DocumentPublicFileResponseEntity,
   type DocumentReviewResponseEntity,
   type DocumentUpdateResponseEntity,
+  type DocumentVerifyResponseEntity,
 } from '../entities';
 import { type RpcPage } from './contract';
 
 /** Patrones NATS de `document`: `<servicio>.<recurso>.<acción>`. */
 export const DocumentPatterns = {
   getAll: 'gestorDocumental.document.getAll',
+  getInbox: 'gestorDocumental.document.getInbox',
   getSummary: 'gestorDocumental.document.getSummary',
   getById: 'gestorDocumental.document.getById',
   create: 'gestorDocumental.document.create',
   update: 'gestorDocumental.document.update',
   review: 'gestorDocumental.document.review',
   discard: 'gestorDocumental.document.discard',
+  annul: 'gestorDocumental.document.annul',
+  derive: 'gestorDocumental.document.derive',
+  closeDelivery: 'gestorDocumental.document.closeDelivery',
+  verify: 'gestorDocumental.document.verify',
+  getPublicFile: 'gestorDocumental.document.getPublicFile',
   getFilesFolder: 'gestorDocumental.document.getFilesFolder',
 } as const;
 
@@ -40,11 +54,24 @@ export interface DocumentActor {
 /** Bandeja desde la que se lista. Todas son del funcionario (`actor`), salvo `all`. */
 export type DocumentBucket =
   | 'created' // los que redactó
+  | 'sent' // de los que redactó, los ya finalizados que tienen destinatarios
   | 'toVisa' // le toca visarlos
   | 'toSign' // le toca firmarlos
   | 'participated' // ya los visó, firmó o rechazó
   | 'all'; // todos los que están en tramitación o finalizados (historial)
 
+/**
+ * Destinatario de un documento o de una derivación: una persona o un área completa. El gateway resuelve el nombre del
+ * área y quiénes la integran hoy; el navegador solo indica cuál es.
+ */
+export type DocumentRecipientInput =
+  | { type: 'Employee'; employeeId: string }
+  | { type: 'Directorate'; directorateCodeReference: number; name: string; memberEmployeeIds: string[] }
+  | { type: 'Department'; departmentId: string; name: string; memberEmployeeIds: string[] };
+
+/** Qué parte de la bandeja de recibidos se lista: lo que falta atender, lo ya atendido, o todo. */
+export type DocumentInboxState = 'pending' | 'closed' | 'all';
+
 /** Qué hace con el documento quien tiene el turno. */
 export type DocumentReviewAction = 'Visa' | 'Sign' | 'Reject';
 
@@ -64,6 +91,14 @@ export interface DocumentWritePayload extends Pick<DocumentEntity, 'subject' | '
   // Funcionarios que visan y que firman, en el orden en que les toca. Primero visan todos y después firman.
   visaEmployeeIds: string[];
   signatureEmployeeIds: string[];
+  // Firmas y visaciones en una hoja aparte al final, en vez de al pie de la última página.
+  signatureSheet?: boolean;
+  // A quién va dirigido: le llega a su bandeja cuando el documento termina su tramitación.
+  recipients?: DocumentRecipientInput[];
+  // Plazo en que se espera respuesta de los destinatarios (ISO 8601).
+  responseDueAt?: string | null;
+  // Documento al que este responde.
+  replyToDocumentId?: string | null;
   action?: 'Submit';
   actor: DocumentActor;
 }
@@ -89,6 +124,15 @@ export interface DocumentContract {
     };
     response: RpcPage<DocumentGetAllResponseEntity[]>;
   };
+  /** Bandeja de recibidos de un funcionario: lo que le llegó como destinatario o por derivación. */
+  [DocumentPatterns.getInbox]: {
+    payload: {
+      pagination?: { page?: number; limit?: number };
+      filters?: { search?: string; state?: DocumentInboxState };
+      actor: DocumentActor;
+    };
+    response: RpcPage<DocumentInboxItemEntity[]>;
+  };
   [DocumentPatterns.getSummary]: {
     payload: { actor: DocumentActor };
     response: DocumentGetSummaryResponseEntity;
@@ -125,6 +169,43 @@ export interface DocumentContract {
     payload: Pick<DocumentEntity, 'id'> & { actor: DocumentActor };
     response: DocumentDiscardResponseEntity;
   };
+  /** Deja sin efecto un documento ya finalizado. Conserva su número, que no se reutiliza. */
+  [DocumentPatterns.annul]: {
+    payload: Pick<DocumentEntity, 'id'> & { reason: string; actor: DocumentActor };
+    response: DocumentAnnulResponseEntity;
+  };
+  /**
+   * Deriva un documento finalizado a otros funcionarios o áreas, con su providencia (qué se espera de ellos) y,
+   * si corresponde, un plazo. Puede hacerlo quien lo tiene a su alcance: su redactor, quien lo visó o firmó, quien lo
+   * recibió y, con `viewAll`, quien consulta el historial.
+   */
+  [DocumentPatterns.derive]: {
+    payload: Pick<DocumentEntity, 'id'> & {
+      recipients: DocumentRecipientInput[];
+      instruction: DocumentInstruction;
+      note?: string | null;
+      // Plazo para atenderlo (ISO 8601).
+      dueAt?: string | null;
+      actor: DocumentActor;
+      viewAll?: boolean;
+    };
+    response: DocumentDeriveResponseEntity;
+  };
+  /** Quien recibió un documento lo marca como atendido, con una nota opcional. */
+  [DocumentPatterns.closeDelivery]: {
+    payload: { deliveryId: DocumentDeliveryEntity['id']; note?: string | null; actor: DocumentActor };
+    response: DocumentCloseDeliveryResponseEntity;
+  };
+  /** Comprobación pública de un documento con el código que lleva impreso. No exige sesión. */
+  [DocumentPatterns.verify]: {
+    payload: { code: string };
+    response: DocumentVerifyResponseEntity;
+  };
+  /** Archivo de un documento finalizado y de acceso público, para quien lo verificó con su código. */
+  [DocumentPatterns.getPublicFile]: {
+    payload: { code: string };
+    response: DocumentPublicFileResponseEntity;
+  };
   /** Carpeta de Drive de los documentos y sus anexos: el gateway la pide antes de subir cada archivo. */
   [DocumentPatterns.getFilesFolder]: {
     payload: Record<string, never>;

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

@@ -1,7 +1,10 @@
 import {
+  DocumentAnnulledNumberEntity,
   DocumentAttachmentEntity,
+  DocumentDeliveryEntity,
   DocumentEntity,
   DocumentParticipantEntity,
+  DocumentRecipientEntity,
   DocumentTrackingEntity,
   DocumentTypeEntity,
 } from '../../base/entities';
@@ -26,6 +29,51 @@ export interface DocumentParticipantResponseEntity {
   resolvedAt: DocumentParticipantEntity['resolvedAt'];
 }
 
+/** Destinatario de un documento, como lo eligió el redactor: una persona o un área completa. */
+export interface DocumentRecipientResponseEntity {
+  id: DocumentRecipientEntity['id'];
+  type: DocumentRecipientEntity['type'];
+  employeeId: DocumentRecipientEntity['employeeId'];
+  directorateCodeReference: DocumentRecipientEntity['directorateCodeReference'];
+  departmentId: DocumentRecipientEntity['departmentId'];
+  name: DocumentRecipientEntity['name'];
+  position: DocumentRecipientEntity['position'];
+}
+
+/** Un documento en la bandeja de un funcionario: como destinatario o porque se lo derivaron. */
+export interface DocumentDeliveryResponseEntity {
+  id: DocumentDeliveryEntity['id'];
+  origin: DocumentDeliveryEntity['origin'];
+  employeeId: DocumentDeliveryEntity['employeeId'];
+  fullName: DocumentDeliveryEntity['fullName'];
+  position: DocumentDeliveryEntity['position'];
+  // Área por la que le llegó, si el documento iba dirigido a un área.
+  areaName: DocumentDeliveryEntity['areaName'];
+  // Quién se lo derivó. Null si es uno de los destinatarios originales.
+  sentByEmployeeId: DocumentDeliveryEntity['sentByEmployeeId'];
+  sentByFullName: DocumentDeliveryEntity['sentByFullName'];
+  instruction: DocumentDeliveryEntity['instruction'];
+  note: DocumentDeliveryEntity['note'];
+  dueAt: DocumentDeliveryEntity['dueAt'];
+  // Null mientras el documento no termina su tramitación.
+  deliveredAt: DocumentDeliveryEntity['deliveredAt'];
+  readAt: DocumentDeliveryEntity['readAt'];
+  closedAt: DocumentDeliveryEntity['closedAt'];
+  closingNote: DocumentDeliveryEntity['closingNote'];
+}
+
+/** Lo necesario para citar otro documento y enlazarlo (el que se responde, o las respuestas). */
+export interface DocumentLinkEntity {
+  id: DocumentEntity['id'];
+  subject: DocumentEntity['subject'];
+  status: DocumentEntity['status'];
+  correlative: DocumentEntity['correlative'];
+  correlativeYear: DocumentEntity['correlativeYear'];
+  createdByFullName: DocumentEntity['createdByFullName'];
+  finishedAt: DocumentEntity['finishedAt'];
+  documentType: DocumentTypeSummaryEntity;
+}
+
 export interface DocumentGetAllResponseEntity {
   id: DocumentEntity['id'];
   subject: DocumentEntity['subject'];
@@ -41,6 +89,13 @@ export interface DocumentGetAllResponseEntity {
   documentType: DocumentTypeSummaryEntity;
   // 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).
+  distribution: { total: number; read: number } | null;
+}
+
+/** Una entrada de la bandeja de recibidos: la entrega y el documento al que corresponde. */
+export interface DocumentInboxItemEntity extends DocumentDeliveryResponseEntity {
+  document: DocumentLinkEntity;
 }
 
 export interface DocumentGetByIdResponseEntity {
@@ -64,6 +119,32 @@ export interface DocumentGetByIdResponseEntity {
   createdAt: DocumentEntity['createdAt'];
   submittedAt: DocumentEntity['submittedAt'];
   finishedAt: DocumentEntity['finishedAt'];
+  // Código con que se comprueba el documento en la página pública. Null mientras no se envía a tramitación.
+  verificationCode: DocumentEntity['verificationCode'];
+  // Dirección de esa página para este documento. Null si el servicio no la tiene configurada.
+  verificationUrl: string | null;
+  // El redactor pidió una hoja aparte para firmas y visaciones.
+  signatureSheet: DocumentEntity['signatureSheet'];
+  // Anulación de un documento ya finalizado.
+  annulledAt: DocumentEntity['annulledAt'];
+  annulmentReason: DocumentEntity['annulmentReason'];
+  // Números que el documento tuvo y perdió: lo rechazaron cuando ya estaba numerado.
+  annulledNumbers: {
+    correlative: DocumentAnnulledNumberEntity['correlative'];
+    correlativeYear: DocumentAnnulledNumberEntity['correlativeYear'];
+    reason: DocumentAnnulledNumberEntity['reason'];
+    employeeFullName: DocumentAnnulledNumberEntity['employeeFullName'];
+    createdAt: DocumentAnnulledNumberEntity['createdAt'];
+  }[];
+  // Plazo en que el redactor espera respuesta de los destinatarios.
+  responseDueAt: DocumentEntity['responseDueAt'];
+  // A quién va dirigido, como lo indicó el redactor (personas y áreas).
+  recipients: DocumentRecipientResponseEntity[];
+  // En la bandeja de quién está: destinatarios y derivaciones, con su lectura y atención.
+  deliveries: DocumentDeliveryResponseEntity[];
+  // Documento al que este responde, y los que le responden (solo los ya finalizados, más los propios de quien consulta).
+  replyTo: DocumentLinkEntity | null;
+  replies: DocumentLinkEntity[];
   documentType: DocumentTypeSummaryEntity;
   participants: DocumentParticipantResponseEntity[];
   attachments: {
@@ -87,6 +168,11 @@ export interface DocumentGetByIdResponseEntity {
     turn: Pick<DocumentParticipantResponseEntity, 'id' | 'role'> | null;
     canEdit: boolean;
     canDiscard: boolean;
+    // Puede derivarlo a otros funcionarios y responderlo: el documento ya es oficial y está a su alcance.
+    canDerive: boolean;
+    canReply: boolean;
+    // Sus propias entregas de este documento (puede tener más de una si además se lo derivaron).
+    inbox: DocumentDeliveryResponseEntity[];
   };
   // Firmar exige el código OTP de quien firma (firma atendida).
   signatureRequiresOtp: boolean;
@@ -102,6 +188,12 @@ export interface DocumentGetSummaryResponseEntity {
     rejected: number;
     finished: number;
   };
+  // Su bandeja de recibidos: sin abrir, sin atender y, de estos, con el plazo vencido.
+  received: {
+    unread: number;
+    pending: number;
+    overdue: number;
+  };
 }
 
 export interface DocumentCreateResponseEntity {
@@ -124,3 +216,58 @@ export interface DocumentDiscardResponseEntity {
   id: DocumentEntity['id'];
   ok: boolean;
 }
+
+export interface DocumentAnnulResponseEntity {
+  id: DocumentEntity['id'];
+  ok: boolean;
+}
+
+/**
+ * Qué se le dice a quien comprueba un documento con su código, sin sesión:
+ *  - `Finished`: es un documento oficial vigente;
+ *  - `Annulled`: lo fue, pero quedó sin efecto;
+ *  - `InProgress`: todavía se está firmando, así que la copia que tiene no es el documento oficial.
+ */
+export type DocumentVerificationState = 'Finished' | 'Annulled' | 'InProgress';
+
+/**
+ * Respuesta pública de la verificación. Dice lo necesario para comprobar la autenticidad (tipo, número, fecha y
+ * quiénes firmaron); la materia y la descarga solo se entregan si el documento es de acceso público.
+ */
+export interface DocumentVerifyResponseEntity {
+  state: DocumentVerificationState;
+  verificationCode: string;
+  documentType: Pick<DocumentTypeSummaryEntity, 'name' | 'abbreviation'>;
+  correlative: DocumentEntity['correlative'];
+  correlativeYear: DocumentEntity['correlativeYear'];
+  numberedAt: DocumentEntity['numberedAt'];
+  finishedAt: DocumentEntity['finishedAt'];
+  annulledAt: DocumentEntity['annulledAt'];
+  // Quiénes firmaron (o deben firmar, si aún está en tramitación), en su orden.
+  signers: {
+    fullName: DocumentParticipantEntity['fullName'];
+    position: DocumentParticipantEntity['position'];
+    signedAt: DocumentParticipantEntity['resolvedAt'];
+  }[];
+  // Solo en documentos de acceso público y sin datos sensibles.
+  subject: DocumentEntity['subject'] | null;
+  canDownload: boolean;
+}
+
+/** Archivo de un documento público, para que el gateway lo entregue a quien lo verifica. */
+export interface DocumentPublicFileResponseEntity {
+  fileId: string;
+  fileName: string;
+}
+
+export interface DocumentDeriveResponseEntity {
+  id: DocumentEntity['id'];
+  ok: boolean;
+  // A cuántos funcionarios llegó la derivación.
+  delivered: number;
+}
+
+export interface DocumentCloseDeliveryResponseEntity {
+  id: DocumentDeliveryEntity['id'];
+  ok: boolean;
+}