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

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';
 export declare const DocumentTrackingAction: {
     Created: "Created";
     Updated: "Updated";
@@ -42,6 +43,9 @@ export declare const DocumentTrackingAction: {
     Rejected: "Rejected";
     Finished: "Finished";
     Discarded: "Discarded";
+    Numbered: "Numbered";
+    NumberAnnulled: "NumberAnnulled";
+    Annulled: "Annulled";
 };
 export type DocumentAttachmentType = 'File' | 'Link';
 export declare const DocumentAttachmentType: {
@@ -60,6 +64,7 @@ export interface DocumentTypeEntity {
     directorateCodeReference?: number | null;
     enabled: boolean;
     documents?: DocumentEntity[];
+    annulledNumbers?: DocumentAnnulledNumberEntity[];
     deleted: boolean;
     createdAt: string;
     updatedAt: string;
@@ -74,6 +79,10 @@ export interface DocumentEntity {
     correlative?: number | null;
     correlativeYear?: number | null;
     numberedAt?: string | null;
+    verificationCode?: string | null;
+    signatureSheet: boolean;
+    annulledAt?: string | null;
+    annulmentReason?: string | null;
     directorateCodeReference?: number | null;
     departmentId?: string | null;
     createdByEmployeeId: string;
@@ -89,6 +98,7 @@ export interface DocumentEntity {
     participants?: DocumentParticipantEntity[];
     attachments?: DocumentAttachmentEntity[];
     trackings?: DocumentTrackingEntity[];
+    annulledNumbers?: DocumentAnnulledNumberEntity[];
     deleted: boolean;
     createdAt: string;
     updatedAt: string;
@@ -130,3 +140,16 @@ 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;
+}

package/dist/base/entities.js

@@ -14,6 +14,7 @@ exports.DocumentStatus = {
     Finished: 'Finished',
     Rejected: 'Rejected',
     Discarded: 'Discarded',
+    Annulled: 'Annulled',
 };
 exports.DocumentAccessLevel = {
     Public: 'Public',
@@ -40,6 +41,9 @@ exports.DocumentTrackingAction = {
     Rejected: 'Rejected',
     Finished: 'Finished',
     Discarded: 'Discarded',
+    Numbered: 'Numbered',
+    NumberAnnulled: 'NumberAnnulled',
+    Annulled: 'Annulled',
 };
 exports.DocumentAttachmentType = {
     File: 'File',

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

@@ -1,5 +1,5 @@
 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 DocumentAnnulResponseEntity, type DocumentCreateResponseEntity, type DocumentDiscardResponseEntity, type DocumentGetAllResponseEntity, type DocumentGetByIdResponseEntity, type DocumentGetSummaryResponseEntity, 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: {
@@ -10,6 +10,9 @@ export declare const DocumentPatterns: {
     readonly update: "gestorDocumental.document.update";
     readonly review: "gestorDocumental.document.review";
     readonly discard: "gestorDocumental.document.discard";
+    readonly annul: "gestorDocumental.document.annul";
+    readonly verify: "gestorDocumental.document.verify";
+    readonly getPublicFile: "gestorDocumental.document.getPublicFile";
     readonly getFilesFolder: "gestorDocumental.document.getFilesFolder";
 };
 /**
@@ -42,6 +45,7 @@ export interface DocumentWritePayload extends Pick<DocumentEntity, 'subject' | '
     attachments?: Pick<DocumentAttachmentEntity, 'name' | 'type' | 'fileId' | 'url'>[];
     visaEmployeeIds: string[];
     signatureEmployeeIds: string[];
+    signatureSheet?: boolean;
     action?: 'Submit';
     actor: DocumentActor;
 }
@@ -109,6 +113,28 @@ 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;
+    };
+    /** 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

@@ -10,5 +10,8 @@ exports.DocumentPatterns = {
     update: 'gestorDocumental.document.update',
     review: 'gestorDocumental.document.review',
     discard: 'gestorDocumental.document.discard',
+    annul: 'gestorDocumental.document.annul',
+    verify: 'gestorDocumental.document.verify',
+    getPublicFile: 'gestorDocumental.document.getPublicFile',
     getFilesFolder: 'gestorDocumental.document.getFilesFolder',
 };

package/dist/contracts/index.d.ts

@@ -20,6 +20,9 @@ export declare const GestorDocumentalPatterns: {
         readonly update: "gestorDocumental.document.update";
         readonly review: "gestorDocumental.document.review";
         readonly discard: "gestorDocumental.document.discard";
+        readonly annul: "gestorDocumental.document.annul";
+        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, DocumentEntity, DocumentParticipantEntity, DocumentTrackingEntity, DocumentTypeEntity } from '../../base/entities';
 /** Tipo documental de un documento, con lo necesario para citarlo. */
 export interface DocumentTypeSummaryEntity {
     id: DocumentTypeEntity['id'];
@@ -52,6 +52,18 @@ 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'];
+    }[];
     documentType: DocumentTypeSummaryEntity;
     participants: DocumentParticipantResponseEntity[];
     attachments: {
@@ -104,3 +116,40 @@ 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;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@muni-sanfer/types-gestor-documental",
-  "version": "0.0.1-beta.0",
+  "version": "0.0.1-beta.1",
   "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,17 @@ 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';
 
 export const DocumentTrackingAction = {
   Created: 'Created',
@@ -56,6 +68,9 @@ export const DocumentTrackingAction = {
   Rejected: 'Rejected',
   Finished: 'Finished',
   Discarded: 'Discarded',
+  Numbered: 'Numbered',
+  NumberAnnulled: 'NumberAnnulled',
+  Annulled: 'Annulled',
 } satisfies Record<string, DocumentTrackingAction>;
 
 export type DocumentAttachmentType = 'File' | 'Link';
@@ -77,6 +92,7 @@ export interface DocumentTypeEntity {
   directorateCodeReference?: number | null;
   enabled: boolean;
   documents?: DocumentEntity[];
+  annulledNumbers?: DocumentAnnulledNumberEntity[];
   deleted: boolean;
   createdAt: string;
   updatedAt: string;
@@ -92,6 +108,10 @@ export interface DocumentEntity {
   correlative?: number | null;
   correlativeYear?: number | null;
   numberedAt?: string | null;
+  verificationCode?: string | null;
+  signatureSheet: boolean;
+  annulledAt?: string | null;
+  annulmentReason?: string | null;
   directorateCodeReference?: number | null;
   departmentId?: string | null;
   createdByEmployeeId: string;
@@ -107,6 +127,7 @@ export interface DocumentEntity {
   participants?: DocumentParticipantEntity[];
   attachments?: DocumentAttachmentEntity[];
   trackings?: DocumentTrackingEntity[];
+  annulledNumbers?: DocumentAnnulledNumberEntity[];
   deleted: boolean;
   createdAt: string;
   updatedAt: string;
@@ -151,3 +172,17 @@ 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;
+}

package/src/contracts/document.contract.ts

@@ -5,13 +5,16 @@ import {
   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 RpcPage } from './contract';
 
@@ -24,6 +27,9 @@ export const DocumentPatterns = {
   update: 'gestorDocumental.document.update',
   review: 'gestorDocumental.document.review',
   discard: 'gestorDocumental.document.discard',
+  annul: 'gestorDocumental.document.annul',
+  verify: 'gestorDocumental.document.verify',
+  getPublicFile: 'gestorDocumental.document.getPublicFile',
   getFilesFolder: 'gestorDocumental.document.getFilesFolder',
 } as const;
 
@@ -64,6 +70,8 @@ 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;
   action?: 'Submit';
   actor: DocumentActor;
 }
@@ -125,6 +133,21 @@ 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;
+  };
+  /** 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,4 +1,5 @@
 import {
+  DocumentAnnulledNumberEntity,
   DocumentAttachmentEntity,
   DocumentEntity,
   DocumentParticipantEntity,
@@ -64,6 +65,23 @@ 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'];
+  }[];
   documentType: DocumentTypeSummaryEntity;
   participants: DocumentParticipantResponseEntity[];
   attachments: {
@@ -124,3 +142,46 @@ 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;
+}