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

package/dist/base/entities.d.ts

@@ -33,7 +33,7 @@ export declare const DocumentParticipantStatus: {
     Resolved: "Resolved";
     Rejected: "Rejected";
 };
-export type DocumentTrackingAction = 'Created' | 'Updated' | 'Submitted' | 'Visaed' | 'Signed' | 'Rejected' | 'Finished' | 'Discarded' | 'Numbered' | 'NumberAnnulled' | 'Annulled';
+export type DocumentTrackingAction = 'Created' | 'Updated' | 'Submitted' | 'Visaed' | 'Signed' | 'Rejected' | 'Finished' | 'Discarded' | 'Numbered' | 'NumberAnnulled' | 'Annulled' | 'Delivered' | 'Derived' | 'Reassigned';
 export declare const DocumentTrackingAction: {
     Created: "Created";
     Updated: "Updated";
@@ -46,12 +46,38 @@ export declare const DocumentTrackingAction: {
     Numbered: "Numbered";
     NumberAnnulled: "NumberAnnulled";
     Annulled: "Annulled";
+    Delivered: "Delivered";
+    Derived: "Derived";
+    Reassigned: "Reassigned";
+};
+export type DocumentFlowStepType = 'Employee' | 'DirectorateHead';
+export declare const DocumentFlowStepType: {
+    Employee: "Employee";
+    DirectorateHead: "DirectorateHead";
 };
 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;
@@ -65,6 +91,7 @@ export interface DocumentTypeEntity {
     enabled: boolean;
     documents?: DocumentEntity[];
     annulledNumbers?: DocumentAnnulledNumberEntity[];
+    flowSteps?: DocumentTypeFlowStepEntity[];
     deleted: boolean;
     createdAt: string;
     updatedAt: string;
@@ -83,6 +110,10 @@ export interface DocumentEntity {
     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;
@@ -99,6 +130,8 @@ export interface DocumentEntity {
     attachments?: DocumentAttachmentEntity[];
     trackings?: DocumentTrackingEntity[];
     annulledNumbers?: DocumentAnnulledNumberEntity[];
+    recipients?: DocumentRecipientEntity[];
+    deliveries?: DocumentDeliveryEntity[];
     deleted: boolean;
     createdAt: string;
     updatedAt: string;
@@ -153,3 +186,48 @@ export interface DocumentAnnulledNumberEntity {
     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;
+}
+export interface DocumentTypeFlowStepEntity {
+    id: string;
+    role: DocumentParticipantRole;
+    order: number;
+    type: DocumentFlowStepType;
+    employeeId?: string | null;
+    directorateCodeReference?: number | null;
+    name: string;
+    position?: string | null;
+    documentType?: DocumentTypeEntity;
+    documentTypeId: 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.DocumentFlowStepType = exports.DocumentTrackingAction = exports.DocumentParticipantStatus = exports.DocumentParticipantRole = exports.DocumentAccessLevel = exports.DocumentStatus = exports.DocumentCategory = void 0;
 exports.DocumentCategory = {
     Decree: 'Decree',
     Communication: 'Communication',
@@ -44,8 +44,30 @@ exports.DocumentTrackingAction = {
     Numbered: 'Numbered',
     NumberAnnulled: 'NumberAnnulled',
     Annulled: 'Annulled',
+    Delivered: 'Delivered',
+    Derived: 'Derived',
+    Reassigned: 'Reassigned',
+};
+exports.DocumentFlowStepType = {
+    Employee: 'Employee',
+    DirectorateHead: 'DirectorateHead',
 };
 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,16 +1,20 @@
-import { type DocumentAccessLevel, type DocumentAttachmentEntity, type DocumentEntity, type DocumentStatus } from '../base/entities';
-import { type DocumentAnnulResponseEntity, type DocumentCreateResponseEntity, type DocumentDiscardResponseEntity, type DocumentGetAllResponseEntity, type DocumentGetByIdResponseEntity, type DocumentGetSummaryResponseEntity, type DocumentPublicFileResponseEntity, type DocumentReviewResponseEntity, type DocumentUpdateResponseEntity, type DocumentVerifyResponseEntity } from '../entities';
+import { type DocumentAccessLevel, type DocumentAttachmentEntity, type DocumentDeliveryEntity, type DocumentEntity, type DocumentInstruction, type DocumentParticipantEntity, 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 DocumentReassignResponseEntity, 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 reassign: "gestorDocumental.document.reassign";
     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";
@@ -25,7 +29,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';
 /**
@@ -46,6 +70,9 @@ export interface DocumentWritePayload extends Pick<DocumentEntity, 'subject' | '
     visaEmployeeIds: string[];
     signatureEmployeeIds: string[];
     signatureSheet?: boolean;
+    recipients?: DocumentRecipientInput[];
+    responseDueAt?: string | null;
+    replyToDocumentId?: string | null;
     action?: 'Submit';
     actor: DocumentActor;
 }
@@ -71,6 +98,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;
@@ -107,6 +149,20 @@ export interface DocumentContract {
         };
         response: DocumentReviewResponseEntity;
     };
+    /**
+     * Pasa un turno pendiente (de visación o de firma) a otro funcionario, por ausencia o por error, y lo deja en la
+     * trazabilidad con su motivo. Puede hacerlo quien redactó el documento; con `anyDocument`, quien lleva el registro.
+     */
+    [DocumentPatterns.reassign]: {
+        payload: Pick<DocumentEntity, 'id'> & {
+            participantId: DocumentParticipantEntity['id'];
+            employeeId: string;
+            reason: string;
+            actor: DocumentActor;
+            anyDocument?: boolean;
+        };
+        response: DocumentReassignResponseEntity;
+    };
     [DocumentPatterns.discard]: {
         payload: Pick<DocumentEntity, 'id'> & {
             actor: DocumentActor;
@@ -121,6 +177,31 @@ export interface DocumentContract {
         };
         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: {

package/dist/contracts/document.contract.js

@@ -4,13 +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',
+    reassign: 'gestorDocumental.document.reassign',
     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/documentType.contract.d.ts

@@ -1,4 +1,4 @@
-import { type DocumentCategory, type DocumentTypeEntity } from '../base/entities';
+import { type DocumentCategory, type DocumentParticipantRole, type DocumentTypeEntity } from '../base/entities';
 import { type DocumentTypeCreateResponseEntity, type DocumentTypeGetAllResponseEntity, type DocumentTypeGetByIdResponseEntity, type DocumentTypeUpdateResponseEntity } from '../entities';
 import { type RpcPage } from './contract';
 /** Patrones NATS de `documentType`: `<servicio>.<recurso>.<acción>`. */
@@ -9,6 +9,21 @@ export declare const DocumentTypePatterns: {
     readonly update: "gestorDocumental.documentType.update";
     readonly setEnabled: "gestorDocumental.documentType.setEnabled";
 };
+/**
+ * Paso del flujo sugerido de un tipo documental: un funcionario en particular, o quien dirija una dirección al
+ * momento de redactar (su jefatura o, con subrogancia activa, el subrogante). El nombre de la dirección lo resuelve
+ * el gateway; el navegador solo indica cuál es.
+ */
+export type DocumentFlowStepInput = {
+    role: DocumentParticipantRole;
+    type: 'Employee';
+    employeeId: string;
+} | {
+    role: DocumentParticipantRole;
+    type: 'DirectorateHead';
+    directorateCodeReference: number;
+    name: string;
+};
 /** Datos de un tipo documental al crearlo o editarlo. */
 export interface DocumentTypeWritePayload {
     name: string;
@@ -19,6 +34,7 @@ export interface DocumentTypeWritePayload {
     resetsYearly?: boolean;
     directorateCodeReference?: number | null;
     enabled?: boolean;
+    flowSteps?: DocumentFlowStepInput[];
 }
 /**
  * Qué se envía y qué se responde en cada patrón. Generado desde los handlers y los DTO del microservicio.

package/dist/contracts/index.d.ts

@@ -14,13 +14,17 @@ 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 reassign: "gestorDocumental.document.reassign";
         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 { DocumentAnnulledNumberEntity, 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'];
@@ -64,6 +111,11 @@ export interface DocumentGetByIdResponseEntity {
         employeeFullName: DocumentAnnulledNumberEntity['employeeFullName'];
         createdAt: DocumentAnnulledNumberEntity['createdAt'];
     }[];
+    responseDueAt: DocumentEntity['responseDueAt'];
+    recipients: DocumentRecipientResponseEntity[];
+    deliveries: DocumentDeliveryResponseEntity[];
+    replyTo: DocumentLinkEntity | null;
+    replies: DocumentLinkEntity[];
     documentType: DocumentTypeSummaryEntity;
     participants: DocumentParticipantResponseEntity[];
     attachments: {
@@ -85,6 +137,10 @@ export interface DocumentGetByIdResponseEntity {
         turn: Pick<DocumentParticipantResponseEntity, 'id' | 'role'> | null;
         canEdit: boolean;
         canDiscard: boolean;
+        canDerive: boolean;
+        canReply: boolean;
+        canReassign: boolean;
+        inbox: DocumentDeliveryResponseEntity[];
     };
     signatureRequiresOtp: boolean;
 }
@@ -98,6 +154,11 @@ export interface DocumentGetSummaryResponseEntity {
         rejected: number;
         finished: number;
     };
+    received: {
+        unread: number;
+        pending: number;
+        overdue: number;
+    };
 }
 export interface DocumentCreateResponseEntity {
     id: DocumentEntity['id'];
@@ -153,3 +214,16 @@ 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;
+}
+export interface DocumentReassignResponseEntity {
+    id: DocumentEntity['id'];
+    ok: boolean;
+}

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

@@ -1,4 +1,15 @@
-import { DocumentTypeEntity } from '../../base/entities';
+import { DocumentTypeEntity, DocumentTypeFlowStepEntity } from '../../base/entities';
+/** Paso del flujo sugerido de un tipo documental: quién visa o firma, en su orden. */
+export interface DocumentTypeFlowStepResponseEntity {
+    id: DocumentTypeFlowStepEntity['id'];
+    role: DocumentTypeFlowStepEntity['role'];
+    order: DocumentTypeFlowStepEntity['order'];
+    type: DocumentTypeFlowStepEntity['type'];
+    employeeId: DocumentTypeFlowStepEntity['employeeId'];
+    directorateCodeReference: DocumentTypeFlowStepEntity['directorateCodeReference'];
+    name: DocumentTypeFlowStepEntity['name'];
+    position: DocumentTypeFlowStepEntity['position'];
+}
 export interface DocumentTypeGetAllResponseEntity {
     id: DocumentTypeEntity['id'];
     name: DocumentTypeEntity['name'];
@@ -10,9 +21,14 @@ export interface DocumentTypeGetAllResponseEntity {
     resetsYearly: DocumentTypeEntity['resetsYearly'];
     directorateCodeReference: DocumentTypeEntity['directorateCodeReference'];
     enabled: DocumentTypeEntity['enabled'];
+    flow: {
+        visa: number;
+        signature: number;
+    };
 }
 export interface DocumentTypeGetByIdResponseEntity extends DocumentTypeGetAllResponseEntity {
     lastCorrelative: number | null;
+    flowSteps: DocumentTypeFlowStepResponseEntity[];
 }
 export interface DocumentTypeCreateResponseEntity {
     id: DocumentTypeEntity['id'];

package/package.json

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

package/src/base/entities.ts

@@ -57,7 +57,10 @@ export type DocumentTrackingAction =
   | 'Discarded'
   | 'Numbered'
   | 'NumberAnnulled'
-  | 'Annulled';
+  | 'Annulled'
+  | 'Delivered'
+  | 'Derived'
+  | 'Reassigned';
 
 export const DocumentTrackingAction = {
   Created: 'Created',
@@ -71,8 +74,18 @@ export const DocumentTrackingAction = {
   Numbered: 'Numbered',
   NumberAnnulled: 'NumberAnnulled',
   Annulled: 'Annulled',
+  Delivered: 'Delivered',
+  Derived: 'Derived',
+  Reassigned: 'Reassigned',
 } satisfies Record<string, DocumentTrackingAction>;
 
+export type DocumentFlowStepType = 'Employee' | 'DirectorateHead';
+
+export const DocumentFlowStepType = {
+  Employee: 'Employee',
+  DirectorateHead: 'DirectorateHead',
+} satisfies Record<string, DocumentFlowStepType>;
+
 export type DocumentAttachmentType = 'File' | 'Link';
 
 export const DocumentAttachmentType = {
@@ -80,6 +93,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;
@@ -93,6 +130,7 @@ export interface DocumentTypeEntity {
   enabled: boolean;
   documents?: DocumentEntity[];
   annulledNumbers?: DocumentAnnulledNumberEntity[];
+  flowSteps?: DocumentTypeFlowStepEntity[];
   deleted: boolean;
   createdAt: string;
   updatedAt: string;
@@ -112,6 +150,10 @@ export interface DocumentEntity {
   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;
@@ -128,6 +170,8 @@ export interface DocumentEntity {
   attachments?: DocumentAttachmentEntity[];
   trackings?: DocumentTrackingEntity[];
   annulledNumbers?: DocumentAnnulledNumberEntity[];
+  recipients?: DocumentRecipientEntity[];
+  deliveries?: DocumentDeliveryEntity[];
   deleted: boolean;
   createdAt: string;
   updatedAt: string;
@@ -186,3 +230,51 @@ export interface DocumentAnnulledNumberEntity {
   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;
+}
+
+export interface DocumentTypeFlowStepEntity {
+  id: string;
+  role: DocumentParticipantRole;
+  order: number;
+  type: DocumentFlowStepType;
+  employeeId?: string | null;
+  directorateCodeReference?: number | null;
+  name: string;
+  position?: string | null;
+  documentType?: DocumentTypeEntity;
+  documentTypeId: string;
+  createdAt: string;
+}

package/src/contracts/document.contract.ts

@@ -1,17 +1,24 @@
 import {
   type DocumentAccessLevel,
   type DocumentAttachmentEntity,
+  type DocumentDeliveryEntity,
   type DocumentEntity,
+  type DocumentInstruction,
+  type DocumentParticipantEntity,
   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 DocumentReassignResponseEntity,
   type DocumentReviewResponseEntity,
   type DocumentUpdateResponseEntity,
   type DocumentVerifyResponseEntity,
@@ -21,13 +28,17 @@ 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',
+  reassign: 'gestorDocumental.document.reassign',
   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',
@@ -46,11 +57,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';
 
@@ -72,6 +96,12 @@ export interface DocumentWritePayload extends Pick<DocumentEntity, 'subject' | '
   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;
 }
@@ -97,6 +127,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;
@@ -129,6 +168,21 @@ export interface DocumentContract {
     };
     response: DocumentReviewResponseEntity;
   };
+  /**
+   * Pasa un turno pendiente (de visación o de firma) a otro funcionario, por ausencia o por error, y lo deja en la
+   * trazabilidad con su motivo. Puede hacerlo quien redactó el documento; con `anyDocument`, quien lleva el registro.
+   */
+  [DocumentPatterns.reassign]: {
+    payload: Pick<DocumentEntity, 'id'> & {
+      participantId: DocumentParticipantEntity['id'];
+      // Funcionario que toma el turno.
+      employeeId: string;
+      reason: string;
+      actor: DocumentActor;
+      anyDocument?: boolean;
+    };
+    response: DocumentReassignResponseEntity;
+  };
   [DocumentPatterns.discard]: {
     payload: Pick<DocumentEntity, 'id'> & { actor: DocumentActor };
     response: DocumentDiscardResponseEntity;
@@ -138,6 +192,28 @@ export interface DocumentContract {
     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 };

package/src/contracts/documentType.contract.ts

@@ -1,4 +1,4 @@
-import { type DocumentCategory, type DocumentTypeEntity } from '../base/entities';
+import { type DocumentCategory, type DocumentParticipantRole, type DocumentTypeEntity } from '../base/entities';
 import {
   type DocumentTypeCreateResponseEntity,
   type DocumentTypeGetAllResponseEntity,
@@ -16,6 +16,15 @@ export const DocumentTypePatterns = {
   setEnabled: 'gestorDocumental.documentType.setEnabled',
 } as const;
 
+/**
+ * Paso del flujo sugerido de un tipo documental: un funcionario en particular, o quien dirija una dirección al
+ * momento de redactar (su jefatura o, con subrogancia activa, el subrogante). El nombre de la dirección lo resuelve
+ * el gateway; el navegador solo indica cuál es.
+ */
+export type DocumentFlowStepInput =
+  | { role: DocumentParticipantRole; type: 'Employee'; employeeId: string }
+  | { role: DocumentParticipantRole; type: 'DirectorateHead'; directorateCodeReference: number; name: string };
+
 /** Datos de un tipo documental al crearlo o editarlo. */
 export interface DocumentTypeWritePayload {
   name: string;
@@ -27,6 +36,8 @@ export interface DocumentTypeWritePayload {
   resetsYearly?: boolean;
   directorateCodeReference?: number | null;
   enabled?: boolean;
+  // Flujo sugerido, en el orden en que les toca dentro de cada rol. Al editar, si no viene, el flujo no cambia.
+  flowSteps?: DocumentFlowStepInput[];
 }
 
 /**

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

@@ -1,8 +1,10 @@
 import {
   DocumentAnnulledNumberEntity,
   DocumentAttachmentEntity,
+  DocumentDeliveryEntity,
   DocumentEntity,
   DocumentParticipantEntity,
+  DocumentRecipientEntity,
   DocumentTrackingEntity,
   DocumentTypeEntity,
 } from '../../base/entities';
@@ -27,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'];
@@ -42,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 {
@@ -82,6 +136,15 @@ export interface DocumentGetByIdResponseEntity {
     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: {
@@ -105,6 +168,13 @@ 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;
+    // Es quien redactó un documento en tramitación: puede pasar un turno pendiente a otro funcionario.
+    canReassign: 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;
@@ -120,6 +190,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 {
@@ -185,3 +261,20 @@ 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;
+}
+
+export interface DocumentReassignResponseEntity {
+  id: DocumentEntity['id'];
+  ok: boolean;
+}

package/src/entities/documentType/documentType.entity.ts

@@ -1,4 +1,17 @@
-import { DocumentTypeEntity } from '../../base/entities';
+import { DocumentTypeEntity, DocumentTypeFlowStepEntity } from '../../base/entities';
+
+/** Paso del flujo sugerido de un tipo documental: quién visa o firma, en su orden. */
+export interface DocumentTypeFlowStepResponseEntity {
+  id: DocumentTypeFlowStepEntity['id'];
+  role: DocumentTypeFlowStepEntity['role'];
+  order: DocumentTypeFlowStepEntity['order'];
+  type: DocumentTypeFlowStepEntity['type'];
+  employeeId: DocumentTypeFlowStepEntity['employeeId'];
+  directorateCodeReference: DocumentTypeFlowStepEntity['directorateCodeReference'];
+  // Nombre del funcionario o de la dirección, como estaba al definir el flujo.
+  name: DocumentTypeFlowStepEntity['name'];
+  position: DocumentTypeFlowStepEntity['position'];
+}
 
 export interface DocumentTypeGetAllResponseEntity {
   id: DocumentTypeEntity['id'];
@@ -11,12 +24,16 @@ export interface DocumentTypeGetAllResponseEntity {
   resetsYearly: DocumentTypeEntity['resetsYearly'];
   directorateCodeReference: DocumentTypeEntity['directorateCodeReference'];
   enabled: DocumentTypeEntity['enabled'];
+  // Cuántos visadores y firmantes tiene su flujo sugerido.
+  flow: { visa: number; signature: number };
 }
 
 export interface DocumentTypeGetByIdResponseEntity extends DocumentTypeGetAllResponseEntity {
   // Último número ya asignado en el año vigente del correlativo (null si aún no se numera ninguno): el próximo
   // correlativo no puede quedar por debajo de él.
   lastCorrelative: number | null;
+  // Flujo sugerido: primero los visadores y después los firmantes, cada grupo en su orden.
+  flowSteps: DocumentTypeFlowStepResponseEntity[];
 }
 
 export interface DocumentTypeCreateResponseEntity {