@muni-sanfer/types-gestor-documental 0.0.1-beta.2 → 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' | 'Delivered' | 'Derived';
+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";
@@ -48,6 +48,12 @@ export declare const DocumentTrackingAction: {
     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: {
@@ -85,6 +91,7 @@ export interface DocumentTypeEntity {
     enabled: boolean;
     documents?: DocumentEntity[];
     annulledNumbers?: DocumentAnnulledNumberEntity[];
+    flowSteps?: DocumentTypeFlowStepEntity[];
     deleted: boolean;
     createdAt: string;
     updatedAt: string;
@@ -211,3 +218,16 @@ export interface DocumentDeliveryEntity {
     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.DocumentInstruction = exports.DocumentDeliveryOrigin = exports.DocumentRecipientType = 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',
@@ -46,6 +46,11 @@ exports.DocumentTrackingAction = {
     Annulled: 'Annulled',
     Delivered: 'Delivered',
     Derived: 'Derived',
+    Reassigned: 'Reassigned',
+};
+exports.DocumentFlowStepType = {
+    Employee: 'Employee',
+    DirectorateHead: 'DirectorateHead',
 };
 exports.DocumentAttachmentType = {
     File: 'File',

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

@@ -1,5 +1,5 @@
-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 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: {
@@ -10,6 +10,7 @@ export declare const DocumentPatterns: {
     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";
@@ -148,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;

package/dist/contracts/document.contract.js

@@ -10,6 +10,7 @@ exports.DocumentPatterns = {
     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',

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

@@ -20,6 +20,7 @@ export declare const GestorDocumentalPatterns: {
         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";

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

@@ -139,6 +139,7 @@ export interface DocumentGetByIdResponseEntity {
         canDiscard: boolean;
         canDerive: boolean;
         canReply: boolean;
+        canReassign: boolean;
         inbox: DocumentDeliveryResponseEntity[];
     };
     signatureRequiresOtp: boolean;
@@ -222,3 +223,7 @@ 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.2",
+  "version": "0.0.1-beta.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {

package/src/base/entities.ts

@@ -59,7 +59,8 @@ export type DocumentTrackingAction =
   | 'NumberAnnulled'
   | 'Annulled'
   | 'Delivered'
-  | 'Derived';
+  | 'Derived'
+  | 'Reassigned';
 
 export const DocumentTrackingAction = {
   Created: 'Created',
@@ -75,8 +76,16 @@ export const DocumentTrackingAction = {
   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 = {
@@ -121,6 +130,7 @@ export interface DocumentTypeEntity {
   enabled: boolean;
   documents?: DocumentEntity[];
   annulledNumbers?: DocumentAnnulledNumberEntity[];
+  flowSteps?: DocumentTypeFlowStepEntity[];
   deleted: boolean;
   createdAt: string;
   updatedAt: string;
@@ -254,3 +264,17 @@ export interface DocumentDeliveryEntity {
   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

@@ -4,6 +4,7 @@ import {
   type DocumentDeliveryEntity,
   type DocumentEntity,
   type DocumentInstruction,
+  type DocumentParticipantEntity,
   type DocumentStatus,
 } from '../base/entities';
 import {
@@ -17,6 +18,7 @@ import {
   type DocumentGetSummaryResponseEntity,
   type DocumentInboxItemEntity,
   type DocumentPublicFileResponseEntity,
+  type DocumentReassignResponseEntity,
   type DocumentReviewResponseEntity,
   type DocumentUpdateResponseEntity,
   type DocumentVerifyResponseEntity,
@@ -32,6 +34,7 @@ export const DocumentPatterns = {
   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',
@@ -165,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;

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

@@ -171,6 +171,8 @@ export interface DocumentGetByIdResponseEntity {
     // 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[];
   };
@@ -271,3 +273,8 @@ 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 {