@muni-sanfer/types-gestor-documental 0.0.1-beta.10 → 0.0.1-beta.11

package/dist/base/entities.d.ts

@@ -206,6 +206,7 @@ export interface DocumentEntity {
     externalFolio?: string | null;
     externalSender?: string | null;
     externalDate?: string | null;
+    composition?: JsonValue | null;
     contentText?: string | null;
     textExtractedAt?: string | null;
     batch?: SignatureBatchEntity | null;

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

@@ -1,5 +1,5 @@
 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 DocumentSignManyResponseEntity, type DocumentAgendaResponseEntity, type DocumentTrailExportEntity, type DocumentUpdateResponseEntity, type DocumentVerifyResponseEntity } from '../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 DocumentSignManyResponseEntity, type DocumentAgendaResponseEntity, type DocumentComposeResponseEntity, type DocumentComposition, type DocumentTrailExportEntity, type DocumentUpdateResponseEntity, type DocumentVerifyResponseEntity } from '../entities';
 import { type RpcPage } from './contract';
 /** Patrones NATS de `document`: `<servicio>.<recurso>.<acción>`. */
 export declare const DocumentPatterns: {
@@ -21,6 +21,7 @@ export declare const DocumentPatterns: {
     readonly getFilesFolder: "gestorDocumental.document.getFilesFolder";
     readonly getAgenda: "gestorDocumental.document.getAgenda";
     readonly exportTrail: "gestorDocumental.document.exportTrail";
+    readonly compose: "gestorDocumental.document.compose";
 };
 /**
  * Funcionario que hace la operación y sus áreas (direcciones y departamentos a los que pertenece o que dirige). Lo
@@ -73,6 +74,7 @@ export interface DocumentWritePayload extends Pick<DocumentEntity, 'subject' | '
     visaEmployeeIds: string[];
     visaStages?: number[] | null;
     restartFlow?: boolean;
+    composition?: DocumentComposition | null;
     signatureEmployeeIds: string[];
     signatureSheet?: boolean;
     recipients?: DocumentRecipientInput[];
@@ -91,6 +93,26 @@ export interface DocumentExternalRecipientInput {
  * Qué se envía y qué se responde en cada patrón. Generado desde los handlers y los DTO del microservicio.
  */
 export interface DocumentContract {
+    /**
+     * Arma el PDF de un documento redactado con una plantilla oficial: membrete, estructura y espacio libre para el
+     * número, las visaciones, las firmas y el QR. Con `preview` lo entrega para verlo; si no, lo sube y entrega su
+     * `fileId` para guardarlo como el PDF del documento.
+     */
+    [DocumentPatterns.compose]: {
+        payload: {
+            documentTypeId: string;
+            subject: string;
+            composition: DocumentComposition;
+            visaCount: number;
+            signatureCount: number;
+            signatureSheet?: boolean;
+            /** Unidad que emite, para el membrete. */
+            issuingUnitName?: string | null;
+            preview?: boolean;
+            actor: DocumentActor;
+        };
+        response: DocumentComposeResponseEntity;
+    };
     /** Plazos del funcionario entre `from` y `to` (hasta 62 días), y lo que tiene vencido sin atender. */
     [DocumentPatterns.getAgenda]: {
         payload: {

package/dist/contracts/document.contract.js

@@ -21,4 +21,5 @@ exports.DocumentPatterns = {
     getFilesFolder: 'gestorDocumental.document.getFilesFolder',
     getAgenda: 'gestorDocumental.document.getAgenda',
     exportTrail: 'gestorDocumental.document.exportTrail',
+    compose: 'gestorDocumental.document.compose',
 };

package/dist/contracts/index.d.ts

@@ -43,6 +43,7 @@ export declare const GestorDocumentalPatterns: {
         readonly getFilesFolder: "gestorDocumental.document.getFilesFolder";
         readonly getAgenda: "gestorDocumental.document.getAgenda";
         readonly exportTrail: "gestorDocumental.document.exportTrail";
+        readonly compose: "gestorDocumental.document.compose";
     };
     readonly procedure: {
         readonly getAll: "gestorDocumental.procedure.getAll";

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

@@ -153,6 +153,8 @@ export interface DocumentGetByIdResponseEntity {
         id: string;
         name: string;
     } | null;
+    /** Contenido redactado en el sistema con una plantilla, para volver a editarlo (sin valor si se subió un PDF). */
+    composition: DocumentComposition | null;
     replies: DocumentLinkEntity[];
     /** Expedientes en que está incorporado y que quien consulta puede ver. */
     caseFiles: {
@@ -353,3 +355,48 @@ export interface DocumentTrailExportEntity {
     contentType: string;
     contentBase64: string;
 }
+/** Plantilla oficial con que se redacta un documento en el sistema. */
+export type DocumentTemplateKind = 'Decree' | 'Office' | 'Memorandum' | 'General';
+/**
+ * Contenido de un documento redactado en el sistema. Cada plantilla tiene su estructura; los párrafos son texto
+ * (un salto de línea dentro de un párrafo se respeta). La materia es el asunto del documento.
+ */
+export type DocumentComposition = {
+    template: 'Decree';
+    /** VISTOS: las normas y antecedentes. */
+    vistos: string[];
+    /** CONSIDERANDO: cada fundamento, numerado. */
+    considerando: string[];
+    /** DECRETO: cada punto resolutivo, numerado. */
+    resolutive: string[];
+    /** Fórmula de cierre: «Anótese, comuníquese y archívese». */
+    closing: string;
+    distribution: string[];
+} | {
+    template: 'Office';
+    /** ANT.: antecedentes (otro oficio, una solicitud). */
+    antecedents?: string | null;
+    from: string;
+    to: string;
+    body: string[];
+    closing: string;
+    distribution: string[];
+} | {
+    template: 'Memorandum';
+    from: string;
+    to: string;
+    body: string[];
+    closing?: string | null;
+    distribution: string[];
+} | {
+    template: 'General';
+    title: string;
+    body: string[];
+    closing?: string | null;
+};
+/** PDF armado con una plantilla: para la vista previa (`contentBase64`) o ya subido (`fileId`). */
+export interface DocumentComposeResponseEntity {
+    fileName: string;
+    fileId?: string;
+    contentBase64?: string;
+}

package/package.json

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

package/src/base/entities.ts

@@ -290,6 +290,7 @@ export interface DocumentEntity {
   externalFolio?: string | null;
   externalSender?: string | null;
   externalDate?: string | null;
+  composition?: JsonValue | null;
   contentText?: string | null;
   textExtractedAt?: string | null;
   batch?: SignatureBatchEntity | null;

package/src/contracts/document.contract.ts

@@ -22,6 +22,8 @@ import {
   type DocumentReviewResponseEntity,
   type DocumentSignManyResponseEntity,
   type DocumentAgendaResponseEntity,
+  type DocumentComposeResponseEntity,
+  type DocumentComposition,
   type DocumentTrailExportEntity,
   type DocumentUpdateResponseEntity,
   type DocumentVerifyResponseEntity,
@@ -48,6 +50,7 @@ export const DocumentPatterns = {
   getFilesFolder: 'gestorDocumental.document.getFilesFolder',
   getAgenda: 'gestorDocumental.document.getAgenda',
   exportTrail: 'gestorDocumental.document.exportTrail',
+  compose: 'gestorDocumental.document.compose',
 } as const;
 
 /**
@@ -103,6 +106,8 @@ export interface DocumentWritePayload extends Pick<DocumentEntity, 'subject' | '
   visaStages?: number[] | null;
   // Al reenviar un documento rechazado, pedir de nuevo las visaciones ya hechas en vez de seguir donde quedó.
   restartFlow?: boolean;
+  // Contenido redactado con una plantilla (el PDF ya armado va en `file`): se guarda para volver a editarlo.
+  composition?: DocumentComposition | null;
   signatureEmployeeIds: string[];
   // Firmas y visaciones en una hoja aparte al final, en vez de al pie de la última página.
   signatureSheet?: boolean;
@@ -128,6 +133,26 @@ export interface DocumentExternalRecipientInput {
  * Qué se envía y qué se responde en cada patrón. Generado desde los handlers y los DTO del microservicio.
  */
 export interface DocumentContract {
+  /**
+   * Arma el PDF de un documento redactado con una plantilla oficial: membrete, estructura y espacio libre para el
+   * número, las visaciones, las firmas y el QR. Con `preview` lo entrega para verlo; si no, lo sube y entrega su
+   * `fileId` para guardarlo como el PDF del documento.
+   */
+  [DocumentPatterns.compose]: {
+    payload: {
+      documentTypeId: string;
+      subject: string;
+      composition: DocumentComposition;
+      visaCount: number;
+      signatureCount: number;
+      signatureSheet?: boolean;
+      /** Unidad que emite, para el membrete. */
+      issuingUnitName?: string | null;
+      preview?: boolean;
+      actor: DocumentActor;
+    };
+    response: DocumentComposeResponseEntity;
+  };
   /** Plazos del funcionario entre `from` y `to` (hasta 62 días), y lo que tiene vencido sin atender. */
   [DocumentPatterns.getAgenda]: {
     payload: { from: string; to: string; actor: DocumentActor };

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

@@ -182,6 +182,8 @@ export interface DocumentGetByIdResponseEntity {
   replyTo: DocumentLinkEntity | null;
   /** Lote de firma al que pertenece. */
   batch: { id: string; name: string } | null;
+  /** Contenido redactado en el sistema con una plantilla, para volver a editarlo (sin valor si se subió un PDF). */
+  composition: DocumentComposition | null;
   replies: DocumentLinkEntity[];
   /** Expedientes en que está incorporado y que quien consulta puede ver. */
   caseFiles: { id: string; code: string; title: string; status: 'Open' | 'Closed' }[];
@@ -395,3 +397,50 @@ export interface DocumentTrailExportEntity {
   contentType: string;
   contentBase64: string;
 }
+
+/** Plantilla oficial con que se redacta un documento en el sistema. */
+export type DocumentTemplateKind = 'Decree' | 'Office' | 'Memorandum' | 'General';
+
+/**
+ * Contenido de un documento redactado en el sistema. Cada plantilla tiene su estructura; los párrafos son texto
+ * (un salto de línea dentro de un párrafo se respeta). La materia es el asunto del documento.
+ */
+export type DocumentComposition =
+  | {
+      template: 'Decree';
+      /** VISTOS: las normas y antecedentes. */
+      vistos: string[];
+      /** CONSIDERANDO: cada fundamento, numerado. */
+      considerando: string[];
+      /** DECRETO: cada punto resolutivo, numerado. */
+      resolutive: string[];
+      /** Fórmula de cierre: «Anótese, comuníquese y archívese». */
+      closing: string;
+      distribution: string[];
+    }
+  | {
+      template: 'Office';
+      /** ANT.: antecedentes (otro oficio, una solicitud). */
+      antecedents?: string | null;
+      from: string;
+      to: string;
+      body: string[];
+      closing: string;
+      distribution: string[];
+    }
+  | {
+      template: 'Memorandum';
+      from: string;
+      to: string;
+      body: string[];
+      closing?: string | null;
+      distribution: string[];
+    }
+  | { template: 'General'; title: string; body: string[]; closing?: string | null };
+
+/** PDF armado con una plantilla: para la vista previa (`contentBase64`) o ya subido (`fileId`). */
+export interface DocumentComposeResponseEntity {
+  fileName: string;
+  fileId?: string;
+  contentBase64?: string;
+}