@muni-sanfer/types-gestor-documental 0.0.1-beta.37 → 0.0.1-beta.38

package/dist/base/entities.d.ts

@@ -220,7 +220,7 @@ export declare const DocumentAccessAction: {
     FileDownloaded: "FileDownloaded";
     TrailExported: "TrailExported";
 };
-export type AuditEntity = 'DocumentType' | 'IssuingEntity' | 'ArchivalSeries' | 'TextSnippet' | 'Holiday' | 'Procedure' | 'QualityMetric' | 'ServiceOutage' | 'Repository' | 'DataTreatment';
+export type AuditEntity = 'DocumentType' | 'IssuingEntity' | 'ArchivalSeries' | 'TextSnippet' | 'Holiday' | 'Procedure' | 'QualityMetric' | 'ServiceOutage' | 'Repository' | 'DataTreatment' | 'DocumentTemplate';
 export declare const AuditEntity: {
     DocumentType: "DocumentType";
     IssuingEntity: "IssuingEntity";
@@ -232,6 +232,7 @@ export declare const AuditEntity: {
     ServiceOutage: "ServiceOutage";
     Repository: "Repository";
     DataTreatment: "DataTreatment";
+    DocumentTemplate: "DocumentTemplate";
 };
 export type AuditAction = 'Created' | 'Updated' | 'Enabled' | 'Disabled' | 'Removed' | 'Exported';
 export declare const AuditAction: {
@@ -887,6 +888,29 @@ export interface TextSnippetEntity {
     createdAt: string;
     updatedAt: string;
 }
+export interface DocumentTemplateEntity {
+    id: string;
+    name: string;
+    description?: string | null;
+    documentTypeIds: string[];
+    content: JsonValue;
+    version: number;
+    enabled: boolean;
+    updatedByFullName?: string | null;
+    versions?: DocumentTemplateVersionEntity[];
+    deleted: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface DocumentTemplateVersionEntity {
+    id: string;
+    templateId: string;
+    template?: DocumentTemplateEntity;
+    version: number;
+    content: JsonValue;
+    createdByFullName?: string | null;
+    createdAt: string;
+}
 export interface ArchivalSeriesEntity {
     id: string;
     code: string;

package/dist/base/entities.js

@@ -207,6 +207,7 @@ exports.AuditEntity = {
     ServiceOutage: 'ServiceOutage',
     Repository: 'Repository',
     DataTreatment: 'DataTreatment',
+    DocumentTemplate: 'DocumentTemplate',
 };
 exports.AuditAction = {
     Created: 'Created',

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

@@ -0,0 +1,58 @@
+import { type DocumentTemplateEntity } from '../base/entities';
+import { type DocumentTemplateAvailableResponseEntity, type DocumentTemplateContent, type DocumentTemplateCreateResponseEntity, type DocumentTemplateGetAllResponseEntity, type DocumentTemplateGetByIdResponseEntity, type DocumentTemplateUpdateResponseEntity } from '../entities';
+import { type RpcPage } from './contract';
+/** Patrones NATS de `documentTemplate` (plantillas propias del editor): `<servicio>.<recurso>.<acción>`. */
+export declare const DocumentTemplatePatterns: {
+    readonly getAll: "gestorDocumental.documentTemplate.getAll";
+    readonly getById: "gestorDocumental.documentTemplate.getById";
+    readonly create: "gestorDocumental.documentTemplate.create";
+    readonly update: "gestorDocumental.documentTemplate.update";
+    readonly setEnabled: "gestorDocumental.documentTemplate.setEnabled";
+    readonly getAvailable: "gestorDocumental.documentTemplate.getAvailable";
+};
+/** Datos de una plantilla propia al crearla o editarla. */
+export interface DocumentTemplateWritePayload {
+    name: string;
+    description?: string | null;
+    documentTypeIds?: string[];
+    content: DocumentTemplateContent;
+    enabled?: boolean;
+}
+export interface DocumentTemplateContract {
+    [DocumentTemplatePatterns.getAll]: {
+        payload: {
+            pagination?: {
+                page?: number;
+                limit?: number;
+            };
+            filters?: {
+                search?: string;
+                enabled?: boolean;
+            };
+        };
+        response: RpcPage<DocumentTemplateGetAllResponseEntity[]>;
+    };
+    [DocumentTemplatePatterns.getById]: {
+        payload: Pick<DocumentTemplateEntity, 'id'>;
+        response: DocumentTemplateGetByIdResponseEntity;
+    };
+    [DocumentTemplatePatterns.create]: {
+        payload: DocumentTemplateWritePayload;
+        response: DocumentTemplateCreateResponseEntity;
+    };
+    [DocumentTemplatePatterns.update]: {
+        payload: DocumentTemplateWritePayload & Pick<DocumentTemplateEntity, 'id'>;
+        response: DocumentTemplateUpdateResponseEntity;
+    };
+    [DocumentTemplatePatterns.setEnabled]: {
+        payload: Pick<DocumentTemplateEntity, 'id' | 'enabled'>;
+        response: DocumentTemplateUpdateResponseEntity;
+    };
+    /** Las habilitadas que se ofrecen al redactar un documento del tipo (las de todos los tipos y las suyas). */
+    [DocumentTemplatePatterns.getAvailable]: {
+        payload: {
+            documentTypeId: string;
+        };
+        response: DocumentTemplateAvailableResponseEntity[];
+    };
+}

package/dist/contracts/documentTemplate.contract.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentTemplatePatterns = void 0;
+/** Patrones NATS de `documentTemplate` (plantillas propias del editor): `<servicio>.<recurso>.<acción>`. */
+exports.DocumentTemplatePatterns = {
+    getAll: 'gestorDocumental.documentTemplate.getAll',
+    getById: 'gestorDocumental.documentTemplate.getById',
+    create: 'gestorDocumental.documentTemplate.create',
+    update: 'gestorDocumental.documentTemplate.update',
+    setEnabled: 'gestorDocumental.documentTemplate.setEnabled',
+    getAvailable: 'gestorDocumental.documentTemplate.getAvailable',
+};

package/dist/contracts/index.d.ts

@@ -4,6 +4,7 @@ import { type DocumentTypeContract } from './documentType.contract';
 import { type IssuingEntityContract } from './issuingEntity.contract';
 import { type ArchivalSeriesContract } from './archivalSeries.contract';
 import { type TextSnippetContract } from './textSnippet.contract';
+import { type DocumentTemplateContract } from './documentTemplate.contract';
 import { type HolidayContract } from './holiday.contract';
 import { type IndicatorsContract } from './indicators.contract';
 import { type AuditContract } from './audit.contract';
@@ -35,6 +36,7 @@ export * from './workFolder.contract';
 export * from './scan.contract';
 export * from './archivalSeries.contract';
 export * from './textSnippet.contract';
+export * from './documentTemplate.contract';
 export * from './holiday.contract';
 export * from './indicators.contract';
 export * from './audit.contract';
@@ -192,6 +194,14 @@ export declare const GestorDocumentalPatterns: {
         readonly update: "gestorDocumental.textSnippet.update";
         readonly setEnabled: "gestorDocumental.textSnippet.setEnabled";
     };
+    readonly documentTemplate: {
+        readonly getAll: "gestorDocumental.documentTemplate.getAll";
+        readonly getById: "gestorDocumental.documentTemplate.getById";
+        readonly create: "gestorDocumental.documentTemplate.create";
+        readonly update: "gestorDocumental.documentTemplate.update";
+        readonly setEnabled: "gestorDocumental.documentTemplate.setEnabled";
+        readonly getAvailable: "gestorDocumental.documentTemplate.getAvailable";
+    };
     readonly holiday: {
         readonly getAll: "gestorDocumental.holiday.getAll";
         readonly create: "gestorDocumental.holiday.create";
@@ -288,4 +298,4 @@ export declare const GestorDocumentalPatterns: {
     };
 };
 /** Contrato completo de gestor-documental-ms: la unión de los contratos de sus recursos. */
-export type GestorDocumentalContract = DocumentTypeContract & DocumentContract & ProcedureContract & IssuingEntityContract & CaseFileContract & PartsOfficeContract & RegisterBookContract & SignatureBatchContract & WorkFolderContract & ScanContract & ArchivalSeriesContract & TextSnippetContract & HolidayContract & IndicatorsContract & AuditContract & SignatureCheckContract & RepositoryExportContract & RetentionContract & AccessRequestContract & TransparencyContract & DataProtectionContract & DeskContract & MailIntakeContract & PushContract;
+export type GestorDocumentalContract = DocumentTypeContract & DocumentContract & ProcedureContract & IssuingEntityContract & CaseFileContract & PartsOfficeContract & RegisterBookContract & SignatureBatchContract & WorkFolderContract & ScanContract & ArchivalSeriesContract & TextSnippetContract & DocumentTemplateContract & HolidayContract & IndicatorsContract & AuditContract & SignatureCheckContract & RepositoryExportContract & RetentionContract & AccessRequestContract & TransparencyContract & DataProtectionContract & DeskContract & MailIntakeContract & PushContract;

package/dist/contracts/index.js

@@ -21,6 +21,7 @@ const documentType_contract_1 = require("./documentType.contract");
 const issuingEntity_contract_1 = require("./issuingEntity.contract");
 const archivalSeries_contract_1 = require("./archivalSeries.contract");
 const textSnippet_contract_1 = require("./textSnippet.contract");
+const documentTemplate_contract_1 = require("./documentTemplate.contract");
 const holiday_contract_1 = require("./holiday.contract");
 const indicators_contract_1 = require("./indicators.contract");
 const audit_contract_1 = require("./audit.contract");
@@ -52,6 +53,7 @@ __exportStar(require("./workFolder.contract"), exports);
 __exportStar(require("./scan.contract"), exports);
 __exportStar(require("./archivalSeries.contract"), exports);
 __exportStar(require("./textSnippet.contract"), exports);
+__exportStar(require("./documentTemplate.contract"), exports);
 __exportStar(require("./holiday.contract"), exports);
 __exportStar(require("./indicators.contract"), exports);
 __exportStar(require("./audit.contract"), exports);
@@ -78,6 +80,7 @@ exports.GestorDocumentalPatterns = {
     scan: scan_contract_1.ScanPatterns,
     archivalSeries: archivalSeries_contract_1.ArchivalSeriesPatterns,
     textSnippet: textSnippet_contract_1.TextSnippetPatterns,
+    documentTemplate: documentTemplate_contract_1.DocumentTemplatePatterns,
     holiday: holiday_contract_1.HolidayPatterns,
     indicators: indicators_contract_1.IndicatorsPatterns,
     audit: audit_contract_1.AuditPatterns,

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

@@ -0,0 +1,51 @@
+import { type DocumentTemplateEntity } from '../../base/entities';
+import { type RichBlock, type RichField } from '../document/document.entity';
+/**
+ * Contenido de una plantilla propia: los bloques del editor (con sus partes fijas) y los campos que completa quien
+ * redacta (en la plantilla, sin valor).
+ */
+export interface DocumentTemplateContent {
+    blocks: RichBlock[];
+    fields: RichField[];
+}
+/** Plantilla propia en el listado de quien las administra. */
+export interface DocumentTemplateGetAllResponseEntity {
+    id: DocumentTemplateEntity['id'];
+    name: DocumentTemplateEntity['name'];
+    description: string | null;
+    /** Tipos documentales donde se ofrece; vacío, en todos. */
+    documentTypeIds: DocumentTemplateEntity['documentTypeIds'];
+    documentTypeNames: string[];
+    version: DocumentTemplateEntity['version'];
+    enabled: DocumentTemplateEntity['enabled'];
+    updatedAt: DocumentTemplateEntity['updatedAt'];
+    updatedByFullName: string | null;
+}
+/** Una versión del contenido de una plantilla. */
+export interface DocumentTemplateVersionResponseEntity {
+    version: number;
+    createdAt: string;
+    createdByFullName: string | null;
+}
+export interface DocumentTemplateGetByIdResponseEntity extends DocumentTemplateGetAllResponseEntity {
+    content: DocumentTemplateContent;
+    versions: DocumentTemplateVersionResponseEntity[];
+}
+/** Plantilla que se ofrece al redactar un documento de un tipo: con su contenido, lista para usar. */
+export interface DocumentTemplateAvailableResponseEntity {
+    id: DocumentTemplateEntity['id'];
+    name: DocumentTemplateEntity['name'];
+    description: string | null;
+    version: DocumentTemplateEntity['version'];
+    content: DocumentTemplateContent;
+}
+export interface DocumentTemplateCreateResponseEntity {
+    id: DocumentTemplateEntity['id'];
+    ok: boolean;
+}
+export interface DocumentTemplateUpdateResponseEntity {
+    id: DocumentTemplateEntity['id'];
+    ok: boolean;
+    /** Versión vigente: sube solo si cambió el contenido. */
+    version: number;
+}

package/dist/entities/documentTemplate/documentTemplate.entity.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/entities/documentTemplate/index.d.ts

@@ -0,0 +1 @@
+export * from './documentTemplate.entity';

package/dist/entities/documentTemplate/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./documentTemplate.entity"), exports);

package/dist/entities/index.d.ts

@@ -22,3 +22,4 @@ export * from './dataProtection';
 export * from './desk';
 export * from './mailIntake';
 export * from './push';
+export * from './documentTemplate';

package/dist/entities/index.js

@@ -38,3 +38,4 @@ __exportStar(require("./dataProtection"), exports);
 __exportStar(require("./desk"), exports);
 __exportStar(require("./mailIntake"), exports);
 __exportStar(require("./push"), exports);
+__exportStar(require("./documentTemplate"), exports);

package/package.json

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

package/src/base/entities.ts

@@ -344,7 +344,8 @@ export type AuditEntity =
   | 'QualityMetric'
   | 'ServiceOutage'
   | 'Repository'
-  | 'DataTreatment';
+  | 'DataTreatment'
+  | 'DocumentTemplate';
 
 export const AuditEntity = {
   DocumentType: 'DocumentType',
@@ -357,6 +358,7 @@ export const AuditEntity = {
   ServiceOutage: 'ServiceOutage',
   Repository: 'Repository',
   DataTreatment: 'DataTreatment',
+  DocumentTemplate: 'DocumentTemplate',
 } satisfies Record<string, AuditEntity>;
 
 export type AuditAction = 'Created' | 'Updated' | 'Enabled' | 'Disabled' | 'Removed' | 'Exported';
@@ -1106,6 +1108,31 @@ export interface TextSnippetEntity {
   updatedAt: string;
 }
 
+export interface DocumentTemplateEntity {
+  id: string;
+  name: string;
+  description?: string | null;
+  documentTypeIds: string[];
+  content: JsonValue;
+  version: number;
+  enabled: boolean;
+  updatedByFullName?: string | null;
+  versions?: DocumentTemplateVersionEntity[];
+  deleted: boolean;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface DocumentTemplateVersionEntity {
+  id: string;
+  templateId: string;
+  template?: DocumentTemplateEntity;
+  version: number;
+  content: JsonValue;
+  createdByFullName?: string | null;
+  createdAt: string;
+}
+
 export interface ArchivalSeriesEntity {
   id: string;
   code: string;

package/src/contracts/documentTemplate.contract.ts

@@ -0,0 +1,61 @@
+import { type DocumentTemplateEntity } from '../base/entities';
+import {
+  type DocumentTemplateAvailableResponseEntity,
+  type DocumentTemplateContent,
+  type DocumentTemplateCreateResponseEntity,
+  type DocumentTemplateGetAllResponseEntity,
+  type DocumentTemplateGetByIdResponseEntity,
+  type DocumentTemplateUpdateResponseEntity,
+} from '../entities';
+import { type RpcPage } from './contract';
+
+/** Patrones NATS de `documentTemplate` (plantillas propias del editor): `<servicio>.<recurso>.<acción>`. */
+export const DocumentTemplatePatterns = {
+  getAll: 'gestorDocumental.documentTemplate.getAll',
+  getById: 'gestorDocumental.documentTemplate.getById',
+  create: 'gestorDocumental.documentTemplate.create',
+  update: 'gestorDocumental.documentTemplate.update',
+  setEnabled: 'gestorDocumental.documentTemplate.setEnabled',
+  getAvailable: 'gestorDocumental.documentTemplate.getAvailable',
+} as const;
+
+/** Datos de una plantilla propia al crearla o editarla. */
+export interface DocumentTemplateWritePayload {
+  name: string;
+  description?: string | null;
+  documentTypeIds?: string[];
+  content: DocumentTemplateContent;
+  enabled?: boolean;
+}
+
+export interface DocumentTemplateContract {
+  [DocumentTemplatePatterns.getAll]: {
+    // sin `page` y `limit` responde todas en una sola página
+    payload: {
+      pagination?: { page?: number; limit?: number };
+      filters?: { search?: string; enabled?: boolean };
+    };
+    response: RpcPage<DocumentTemplateGetAllResponseEntity[]>;
+  };
+  [DocumentTemplatePatterns.getById]: {
+    payload: Pick<DocumentTemplateEntity, 'id'>;
+    response: DocumentTemplateGetByIdResponseEntity;
+  };
+  [DocumentTemplatePatterns.create]: {
+    payload: DocumentTemplateWritePayload;
+    response: DocumentTemplateCreateResponseEntity;
+  };
+  [DocumentTemplatePatterns.update]: {
+    payload: DocumentTemplateWritePayload & Pick<DocumentTemplateEntity, 'id'>;
+    response: DocumentTemplateUpdateResponseEntity;
+  };
+  [DocumentTemplatePatterns.setEnabled]: {
+    payload: Pick<DocumentTemplateEntity, 'id' | 'enabled'>;
+    response: DocumentTemplateUpdateResponseEntity;
+  };
+  /** Las habilitadas que se ofrecen al redactar un documento del tipo (las de todos los tipos y las suyas). */
+  [DocumentTemplatePatterns.getAvailable]: {
+    payload: { documentTypeId: string };
+    response: DocumentTemplateAvailableResponseEntity[];
+  };
+}

package/src/contracts/index.ts

@@ -4,6 +4,7 @@ import { DocumentTypePatterns, type DocumentTypeContract } from './documentType.
 import { IssuingEntityPatterns, type IssuingEntityContract } from './issuingEntity.contract';
 import { ArchivalSeriesPatterns, type ArchivalSeriesContract } from './archivalSeries.contract';
 import { TextSnippetPatterns, type TextSnippetContract } from './textSnippet.contract';
+import { DocumentTemplatePatterns, type DocumentTemplateContract } from './documentTemplate.contract';
 import { HolidayPatterns, type HolidayContract } from './holiday.contract';
 import { IndicatorsPatterns, type IndicatorsContract } from './indicators.contract';
 import { AuditPatterns, type AuditContract } from './audit.contract';
@@ -36,6 +37,7 @@ export * from './workFolder.contract';
 export * from './scan.contract';
 export * from './archivalSeries.contract';
 export * from './textSnippet.contract';
+export * from './documentTemplate.contract';
 export * from './holiday.contract';
 export * from './indicators.contract';
 export * from './audit.contract';
@@ -63,6 +65,7 @@ export const GestorDocumentalPatterns = {
   scan: ScanPatterns,
   archivalSeries: ArchivalSeriesPatterns,
   textSnippet: TextSnippetPatterns,
+  documentTemplate: DocumentTemplatePatterns,
   holiday: HolidayPatterns,
   indicators: IndicatorsPatterns,
   audit: AuditPatterns,
@@ -90,6 +93,7 @@ export type GestorDocumentalContract = DocumentTypeContract &
   ScanContract &
   ArchivalSeriesContract &
   TextSnippetContract &
+  DocumentTemplateContract &
   HolidayContract &
   IndicatorsContract &
   AuditContract &

package/src/entities/documentTemplate/documentTemplate.entity.ts

@@ -0,0 +1,58 @@
+import { type DocumentTemplateEntity } from '../../base/entities';
+import { type RichBlock, type RichField } from '../document/document.entity';
+
+/**
+ * Contenido de una plantilla propia: los bloques del editor (con sus partes fijas) y los campos que completa quien
+ * redacta (en la plantilla, sin valor).
+ */
+export interface DocumentTemplateContent {
+  blocks: RichBlock[];
+  fields: RichField[];
+}
+
+/** Plantilla propia en el listado de quien las administra. */
+export interface DocumentTemplateGetAllResponseEntity {
+  id: DocumentTemplateEntity['id'];
+  name: DocumentTemplateEntity['name'];
+  description: string | null;
+  /** Tipos documentales donde se ofrece; vacío, en todos. */
+  documentTypeIds: DocumentTemplateEntity['documentTypeIds'];
+  documentTypeNames: string[];
+  version: DocumentTemplateEntity['version'];
+  enabled: DocumentTemplateEntity['enabled'];
+  updatedAt: DocumentTemplateEntity['updatedAt'];
+  updatedByFullName: string | null;
+}
+
+/** Una versión del contenido de una plantilla. */
+export interface DocumentTemplateVersionResponseEntity {
+  version: number;
+  createdAt: string;
+  createdByFullName: string | null;
+}
+
+export interface DocumentTemplateGetByIdResponseEntity extends DocumentTemplateGetAllResponseEntity {
+  content: DocumentTemplateContent;
+  versions: DocumentTemplateVersionResponseEntity[];
+}
+
+/** Plantilla que se ofrece al redactar un documento de un tipo: con su contenido, lista para usar. */
+export interface DocumentTemplateAvailableResponseEntity {
+  id: DocumentTemplateEntity['id'];
+  name: DocumentTemplateEntity['name'];
+  description: string | null;
+  version: DocumentTemplateEntity['version'];
+  content: DocumentTemplateContent;
+}
+
+export interface DocumentTemplateCreateResponseEntity {
+  id: DocumentTemplateEntity['id'];
+  ok: boolean;
+}
+
+export interface DocumentTemplateUpdateResponseEntity {
+  id: DocumentTemplateEntity['id'];
+  ok: boolean;
+  /** Versión vigente: sube solo si cambió el contenido. */
+  version: number;
+}

package/src/entities/documentTemplate/index.ts

@@ -0,0 +1 @@
+export * from './documentTemplate.entity';

package/src/entities/index.ts

@@ -22,3 +22,4 @@ export * from './dataProtection';
 export * from './desk';
 export * from './mailIntake';
 export * from './push';
+export * from './documentTemplate';