@muni-sanfer/types-gestor-documental 0.0.1-beta.30 → 0.0.1-beta.31

package/dist/base/entities.d.ts

@@ -473,6 +473,8 @@ export interface DocumentEntity {
     redactedFileName?: string | null;
     accessRequestResponses?: AccessRequestEntity[];
     dataRightsResponses?: DataRightsRequestEntity[];
+    versions?: DocumentVersionEntity[];
+    comments?: DocumentCommentEntity[];
     accessRequestDeliveries?: AccessRequestDocumentEntity[];
     dispatch?: DocumentDispatchEntity | null;
     docDigitalInbound?: DocDigitalInboundEntity | null;
@@ -1204,6 +1206,38 @@ export interface DeskFileEntity {
     createdAt: string;
     updatedAt: string;
 }
+export interface DocumentVersionEntity {
+    id: string;
+    documentId: string;
+    document?: DocumentEntity;
+    number: number;
+    subject: string;
+    fileId: string;
+    fileName: string;
+    sha256?: string | null;
+    composition?: JsonValue | null;
+    note?: string | null;
+    status: DocumentStatus;
+    createdByEmployeeId: string;
+    createdByFullName: string;
+    createdAt: string;
+}
+export interface DocumentCommentEntity {
+    id: string;
+    documentId: string;
+    document?: DocumentEntity;
+    versionNumber: number;
+    section?: string | null;
+    quote?: string | null;
+    text: string;
+    authorEmployeeId: string;
+    authorFullName: string;
+    authorRole: string;
+    resolvedAt?: string | null;
+    resolvedByFullName?: string | null;
+    resolutionNote?: string | null;
+    createdAt: string;
+}
 type JsonValue = string | number | boolean | {
     [key in string]?: JsonValue;
 } | Array<JsonValue> | null;

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

@@ -1,5 +1,5 @@
 import { type DocumentAccessAction, 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 DocumentEmailCopyIssuedEntity, type DocumentEmailCopyViewEntity, type DocumentReminderEntity, type DocumentGetAllResponseEntity, type DocumentGetByIdResponseEntity, type DocumentGetSummaryResponseEntity, type DocumentInboxItemEntity, type DocumentPublicFileResponseEntity, type DocumentReassignResponseEntity, type DocumentReviewResponseEntity, type DocumentSignManyResponseEntity, type DocumentAgendaResponseEntity, type DocumentComposeResponseEntity, type DocumentComposition, type DocumentTrailExportEntity, type DocumentUpdateResponseEntity, type DocumentVerifyResponseEntity } from '../entities';
+import { type DocumentAnnulResponseEntity, type DocumentCloseDeliveryResponseEntity, type DocumentCreateResponseEntity, type DocumentDeriveResponseEntity, type DocumentDiscardResponseEntity, type DocumentEmailCopyIssuedEntity, type DocumentEmailCopyViewEntity, type DocumentReminderEntity, type DocumentGetAllResponseEntity, type DocumentGetByIdResponseEntity, type DocumentGetSummaryResponseEntity, type DocumentInboxItemEntity, type DocumentPublicFileResponseEntity, type DocumentReassignResponseEntity, type DocumentReviewResponseEntity, type DocumentSignManyResponseEntity, type DocumentAgendaResponseEntity, type DocumentComposeResponseEntity, type DocumentComposition, type DocumentTrailExportEntity, type DocumentUpdateResponseEntity, type DocumentVerifyResponseEntity, type DocumentCommentResponseEntity, type DocumentCommentsResponseEntity, type DocumentVersionResponseEntity } from '../entities';
 import { type RpcPage } from './contract';
 /** Patrones NATS de `document`: `<servicio>.<recurso>.<acción>`. */
 export declare const DocumentPatterns: {
@@ -17,6 +17,11 @@ export declare const DocumentPatterns: {
     readonly derive: "gestorDocumental.document.derive";
     readonly closeDelivery: "gestorDocumental.document.closeDelivery";
     readonly verify: "gestorDocumental.document.verify";
+    readonly getVersions: "gestorDocumental.document.getVersions";
+    readonly getVersionFile: "gestorDocumental.document.getVersionFile";
+    readonly getComments: "gestorDocumental.document.getComments";
+    readonly addComment: "gestorDocumental.document.addComment";
+    readonly resolveComment: "gestorDocumental.document.resolveComment";
     readonly getPublicFile: "gestorDocumental.document.getPublicFile";
     readonly getFilesFolder: "gestorDocumental.document.getFilesFolder";
     readonly getAgenda: "gestorDocumental.document.getAgenda";
@@ -66,6 +71,8 @@ export type DocumentReviewAction = 'Visa' | 'Sign' | 'Reject';
  */
 export interface DocumentWritePayload extends Pick<DocumentEntity, 'subject' | 'documentTypeId'> {
     keywords: string[];
+    /** Qué cambió, si el guardado crea una versión nueva (otro PDF, otro texto u otro asunto). */
+    versionNote?: string | null;
     accessLevel?: DocumentAccessLevel;
     hasSensitiveData?: boolean;
     directorateCodeReference?: number | null;
@@ -299,6 +306,58 @@ export interface DocumentContract {
         };
         response: DocumentCloseDeliveryResponseEntity;
     };
+    /** Versiones del documento, de la más reciente a la primera, con quién visó o firmó cada una. */
+    [DocumentPatterns.getVersions]: {
+        payload: {
+            id: string;
+            actor?: DocumentActor;
+            viewAll?: boolean;
+        };
+        response: DocumentVersionResponseEntity[];
+    };
+    /** El PDF original de una versión (sin estampar), con las mismas reglas de acceso. */
+    [DocumentPatterns.getVersionFile]: {
+        payload: {
+            id: string;
+            number: number;
+            actor?: DocumentActor;
+            viewAll?: boolean;
+        };
+        response: DocumentPublicFileResponseEntity;
+    };
+    /** Comentarios de redacción: los ven el redactor y quienes tienen un turno (y quien ve todo el historial). */
+    [DocumentPatterns.getComments]: {
+        payload: {
+            id: string;
+            actor?: DocumentActor;
+            viewAll?: boolean;
+        };
+        response: DocumentCommentsResponseEntity;
+    };
+    /** Comenta el redactor o quien tiene un turno, mientras el documento no termina, sobre la versión vigente. */
+    [DocumentPatterns.addComment]: {
+        payload: {
+            id: string;
+            section?: string | null;
+            quote?: string | null;
+            text: string;
+            actor: DocumentActor & {
+                fullName: string;
+            };
+        };
+        response: DocumentCommentResponseEntity;
+    };
+    /** Lo marca como resuelto el redactor o quien lo escribió, con una nota opcional. */
+    [DocumentPatterns.resolveComment]: {
+        payload: {
+            commentId: string;
+            note?: string | null;
+            actor: DocumentActor & {
+                fullName: string;
+            };
+        };
+        response: DocumentCommentResponseEntity;
+    };
     /** 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

@@ -17,6 +17,11 @@ exports.DocumentPatterns = {
     derive: 'gestorDocumental.document.derive',
     closeDelivery: 'gestorDocumental.document.closeDelivery',
     verify: 'gestorDocumental.document.verify',
+    getVersions: 'gestorDocumental.document.getVersions',
+    getVersionFile: 'gestorDocumental.document.getVersionFile',
+    getComments: 'gestorDocumental.document.getComments',
+    addComment: 'gestorDocumental.document.addComment',
+    resolveComment: 'gestorDocumental.document.resolveComment',
     getPublicFile: 'gestorDocumental.document.getPublicFile',
     getFilesFolder: 'gestorDocumental.document.getFilesFolder',
     getAgenda: 'gestorDocumental.document.getAgenda',

package/dist/contracts/index.d.ts

@@ -67,6 +67,11 @@ export declare const GestorDocumentalPatterns: {
         readonly derive: "gestorDocumental.document.derive";
         readonly closeDelivery: "gestorDocumental.document.closeDelivery";
         readonly verify: "gestorDocumental.document.verify";
+        readonly getVersions: "gestorDocumental.document.getVersions";
+        readonly getVersionFile: "gestorDocumental.document.getVersionFile";
+        readonly getComments: "gestorDocumental.document.getComments";
+        readonly addComment: "gestorDocumental.document.addComment";
+        readonly resolveComment: "gestorDocumental.document.resolveComment";
         readonly getPublicFile: "gestorDocumental.document.getPublicFile";
         readonly getFilesFolder: "gestorDocumental.document.getFilesFolder";
         readonly getAgenda: "gestorDocumental.document.getAgenda";

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

@@ -1,4 +1,4 @@
-import { type CommunicationMeans, DocumentAnnulledNumberEntity, DocumentAttachmentEntity, DocumentDeliveryEntity, DocumentEntity, DocumentParticipantEntity, DocumentRecipientEntity, DocumentTrackingEntity, DocumentTypeEntity } from '../../base/entities';
+import { type CommunicationMeans, DocumentAnnulledNumberEntity, DocumentAttachmentEntity, DocumentDeliveryEntity, DocumentEntity, DocumentParticipantEntity, DocumentRecipientEntity, type DocumentStatus, DocumentTrackingEntity, DocumentTypeEntity } from '../../base/entities';
 /** Tipo documental de un documento, con lo necesario para citarlo. */
 export interface DocumentTypeSummaryEntity {
     id: DocumentTypeEntity['id'];
@@ -482,3 +482,47 @@ export interface DocumentReminderEntity {
     instruction: DocumentDeliveryEntity['instruction'];
     sentByFullName: string | null;
 }
+/** Quien visó, firmó o rechazó una versión, según la trazabilidad. */
+export interface DocumentVersionReviewEntity {
+    action: 'Visaed' | 'Signed' | 'Rejected';
+    employeeFullName: string;
+    createdAt: string;
+}
+/** Una versión de un documento: lo que se guardó cada vez que cambió su PDF, su texto o su asunto. */
+export interface DocumentVersionResponseEntity {
+    number: number;
+    subject: string;
+    fileName: string;
+    sha256: string | null;
+    /** Lo redactado con plantilla, para compararla con otra versión. `null` si se subió un PDF. */
+    composition: DocumentComposition | null;
+    note: string | null;
+    status: DocumentStatus;
+    createdByFullName: string;
+    createdAt: string;
+    /** Visaciones, firmas y rechazos mientras fue la versión vigente. */
+    reviews: DocumentVersionReviewEntity[];
+}
+/** Comentario de redacción de un visador, un firmante o el redactor. */
+export interface DocumentCommentResponseEntity {
+    id: string;
+    versionNumber: number;
+    section: string | null;
+    quote: string | null;
+    text: string;
+    authorEmployeeId: string;
+    authorFullName: string;
+    authorRole: 'Author' | 'Visa' | 'Signature';
+    createdAt: string;
+    resolvedAt: string | null;
+    resolvedByFullName: string | null;
+    resolutionNote: string | null;
+    /** Quien consulta lo puede marcar como resuelto: el redactor o quien lo escribió, mientras el documento se tramita. */
+    canResolve: boolean;
+}
+export interface DocumentCommentsResponseEntity {
+    comments: DocumentCommentResponseEntity[];
+    /** Quien consulta puede comentar: es el redactor o tiene un turno, y el documento no ha terminado. */
+    canComment: boolean;
+    currentVersion: number;
+}

package/package.json

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

package/src/base/entities.ts

@@ -661,6 +661,8 @@ export interface DocumentEntity {
   redactedFileName?: string | null;
   accessRequestResponses?: AccessRequestEntity[];
   dataRightsResponses?: DataRightsRequestEntity[];
+  versions?: DocumentVersionEntity[];
+  comments?: DocumentCommentEntity[];
   accessRequestDeliveries?: AccessRequestDocumentEntity[];
   dispatch?: DocumentDispatchEntity | null;
   docDigitalInbound?: DocDigitalInboundEntity | null;
@@ -1439,4 +1441,38 @@ export interface DeskFileEntity {
   updatedAt: string;
 }
 
+export interface DocumentVersionEntity {
+  id: string;
+  documentId: string;
+  document?: DocumentEntity;
+  number: number;
+  subject: string;
+  fileId: string;
+  fileName: string;
+  sha256?: string | null;
+  composition?: JsonValue | null;
+  note?: string | null;
+  status: DocumentStatus;
+  createdByEmployeeId: string;
+  createdByFullName: string;
+  createdAt: string;
+}
+
+export interface DocumentCommentEntity {
+  id: string;
+  documentId: string;
+  document?: DocumentEntity;
+  versionNumber: number;
+  section?: string | null;
+  quote?: string | null;
+  text: string;
+  authorEmployeeId: string;
+  authorFullName: string;
+  authorRole: string;
+  resolvedAt?: string | null;
+  resolvedByFullName?: string | null;
+  resolutionNote?: string | null;
+  createdAt: string;
+}
+
 type JsonValue = string | number | boolean | { [key in string]?: JsonValue } | Array<JsonValue> | null;

package/src/contracts/document.contract.ts

@@ -31,6 +31,9 @@ import {
   type DocumentTrailExportEntity,
   type DocumentUpdateResponseEntity,
   type DocumentVerifyResponseEntity,
+  type DocumentCommentResponseEntity,
+  type DocumentCommentsResponseEntity,
+  type DocumentVersionResponseEntity,
 } from '../entities';
 import { type RpcPage } from './contract';
 
@@ -50,6 +53,11 @@ export const DocumentPatterns = {
   derive: 'gestorDocumental.document.derive',
   closeDelivery: 'gestorDocumental.document.closeDelivery',
   verify: 'gestorDocumental.document.verify',
+  getVersions: 'gestorDocumental.document.getVersions',
+  getVersionFile: 'gestorDocumental.document.getVersionFile',
+  getComments: 'gestorDocumental.document.getComments',
+  addComment: 'gestorDocumental.document.addComment',
+  resolveComment: 'gestorDocumental.document.resolveComment',
   getPublicFile: 'gestorDocumental.document.getPublicFile',
   getFilesFolder: 'gestorDocumental.document.getFilesFolder',
   getAgenda: 'gestorDocumental.document.getAgenda',
@@ -101,6 +109,8 @@ export type DocumentReviewAction = 'Visa' | 'Sign' | 'Reject';
  */
 export interface DocumentWritePayload extends Pick<DocumentEntity, 'subject' | 'documentTypeId'> {
   keywords: string[];
+  /** Qué cambió, si el guardado crea una versión nueva (otro PDF, otro texto u otro asunto). */
+  versionNote?: string | null;
   accessLevel?: DocumentAccessLevel;
   hasSensitiveData?: boolean;
   directorateCodeReference?: number | null;
@@ -320,6 +330,37 @@ export interface DocumentContract {
     payload: { deliveryId: DocumentDeliveryEntity['id']; note?: string | null; actor: DocumentActor };
     response: DocumentCloseDeliveryResponseEntity;
   };
+  /** Versiones del documento, de la más reciente a la primera, con quién visó o firmó cada una. */
+  [DocumentPatterns.getVersions]: {
+    payload: { id: string; actor?: DocumentActor; viewAll?: boolean };
+    response: DocumentVersionResponseEntity[];
+  };
+  /** El PDF original de una versión (sin estampar), con las mismas reglas de acceso. */
+  [DocumentPatterns.getVersionFile]: {
+    payload: { id: string; number: number; actor?: DocumentActor; viewAll?: boolean };
+    response: DocumentPublicFileResponseEntity;
+  };
+  /** Comentarios de redacción: los ven el redactor y quienes tienen un turno (y quien ve todo el historial). */
+  [DocumentPatterns.getComments]: {
+    payload: { id: string; actor?: DocumentActor; viewAll?: boolean };
+    response: DocumentCommentsResponseEntity;
+  };
+  /** Comenta el redactor o quien tiene un turno, mientras el documento no termina, sobre la versión vigente. */
+  [DocumentPatterns.addComment]: {
+    payload: {
+      id: string;
+      section?: string | null;
+      quote?: string | null;
+      text: string;
+      actor: DocumentActor & { fullName: string };
+    };
+    response: DocumentCommentResponseEntity;
+  };
+  /** Lo marca como resuelto el redactor o quien lo escribió, con una nota opcional. */
+  [DocumentPatterns.resolveComment]: {
+    payload: { commentId: string; note?: string | null; actor: DocumentActor & { fullName: string } };
+    response: DocumentCommentResponseEntity;
+  };
   /** 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/entities/document/document.entity.ts

@@ -6,6 +6,7 @@ import {
   DocumentEntity,
   DocumentParticipantEntity,
   DocumentRecipientEntity,
+  type DocumentStatus,
   DocumentTrackingEntity,
   DocumentTypeEntity,
 } from '../../base/entities';
@@ -530,3 +531,51 @@ export interface DocumentReminderEntity {
   instruction: DocumentDeliveryEntity['instruction'];
   sentByFullName: string | null;
 }
+
+/** Quien visó, firmó o rechazó una versión, según la trazabilidad. */
+export interface DocumentVersionReviewEntity {
+  action: 'Visaed' | 'Signed' | 'Rejected';
+  employeeFullName: string;
+  createdAt: string;
+}
+
+/** Una versión de un documento: lo que se guardó cada vez que cambió su PDF, su texto o su asunto. */
+export interface DocumentVersionResponseEntity {
+  number: number;
+  subject: string;
+  fileName: string;
+  sha256: string | null;
+  /** Lo redactado con plantilla, para compararla con otra versión. `null` si se subió un PDF. */
+  composition: DocumentComposition | null;
+  note: string | null;
+  status: DocumentStatus;
+  createdByFullName: string;
+  createdAt: string;
+  /** Visaciones, firmas y rechazos mientras fue la versión vigente. */
+  reviews: DocumentVersionReviewEntity[];
+}
+
+/** Comentario de redacción de un visador, un firmante o el redactor. */
+export interface DocumentCommentResponseEntity {
+  id: string;
+  versionNumber: number;
+  section: string | null;
+  quote: string | null;
+  text: string;
+  authorEmployeeId: string;
+  authorFullName: string;
+  authorRole: 'Author' | 'Visa' | 'Signature';
+  createdAt: string;
+  resolvedAt: string | null;
+  resolvedByFullName: string | null;
+  resolutionNote: string | null;
+  /** Quien consulta lo puede marcar como resuelto: el redactor o quien lo escribió, mientras el documento se tramita. */
+  canResolve: boolean;
+}
+
+export interface DocumentCommentsResponseEntity {
+  comments: DocumentCommentResponseEntity[];
+  /** Quien consulta puede comentar: es el redactor o tiene un turno, y el documento no ha terminado. */
+  canComment: boolean;
+  currentVersion: number;
+}