@muni-sanfer/types-gestor-documental 0.0.1-beta.47 → 0.0.1-beta.49

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

@@ -1,54 +1,13 @@
-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>`. */
+import { type DocumentTemplateAvailableResponseEntity } from '../entities';
+/**
+ * Patrones NATS de `documentTemplate`. La plantilla de cada tipo documental se define y edita con el tipo
+ * (`documentType.create` y `documentType.update`); aquí solo se consulta al redactar.
+ */
 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). */
+    /** La plantilla habilitada del tipo documental, si tiene (una lista de a lo sumo una). */
     [DocumentTemplatePatterns.getAvailable]: {
         payload: {
             documentTypeId: string;

package/dist/contracts/documentTemplate.contract.js

@@ -1,12 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocumentTemplatePatterns = void 0;
-/** Patrones NATS de `documentTemplate` (plantillas propias del editor): `<servicio>.<recurso>.<acción>`. */
+/**
+ * Patrones NATS de `documentTemplate`. La plantilla de cada tipo documental se define y edita con el tipo
+ * (`documentType.create` y `documentType.update`); aquí solo se consulta al redactar.
+ */
 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

@@ -202,11 +202,6 @@ export declare const GestorDocumentalPatterns: {
         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: {

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

@@ -128,9 +128,35 @@ export interface RichPage {
 }
 /** Página de siempre: Carta, con el espacio del membrete y los sellos, en Roboto 11. */
 export declare const RICH_DEFAULT_PAGE: RichPage;
+/**
+ * Una imagen del encabezado (logo, escudo, sello) en el diseño libre: imagen registrada en el gestor, con su lugar y su
+ * tamaño en puntos desde la esquina superior izquierda de la hoja. Cabe en el margen superior.
+ */
+export interface RichLetterheadImage {
+    imageId: string;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export type RichLetterheadAlign = 'left' | 'center' | 'right';
+/** El texto del membrete (nombre de la municipalidad, unidad y líneas propias) en el diseño libre. */
+export interface RichLetterheadText {
+    x: number;
+    y: number;
+    width: number;
+    align: RichLetterheadAlign;
+    /** Tamaño del nombre de la municipalidad, en puntos (sin valor, 10). */
+    organSize?: number;
+    /** Tamaño de la unidad y de las líneas propias, en puntos (sin valor, 8). */
+    lineSize?: number;
+}
 /**
  * Membrete de la plantilla, en el margen superior de cada página: un logo o escudo (opcional) y el nombre de la
  * municipalidad y de la unidad que emite. Va a la izquierda: a la derecha el sistema estampa el número y la fecha.
+ *
+ * Con `text`, el diseño es libre: las imágenes de `images` y el texto van donde se ubicaron (y `imageId` e
+ * `imageHeight` no se usan). Sin `text`, el de siempre: el logo de `imageId` y, a su lado, el texto.
  */
 export interface RichLetterhead {
     /** Imagen registrada en el gestor (`RichImage`), no un archivo de Drive. */
@@ -141,7 +167,33 @@ export interface RichLetterhead {
     showUnitName: boolean;
     /** Líneas propias bajo el nombre, como la dirección o el teléfono. */
     lines?: string[];
+    /** Diseño libre: las imágenes del encabezado, donde se ubicaron. */
+    images?: RichLetterheadImage[];
+    /** Diseño libre: dónde va el texto y con qué tamaño. */
+    text?: RichLetterheadText;
+    /** Línea divisoria bajo el encabezado, de margen a margen. */
+    rule?: boolean;
 }
+/** Límites del diseño libre del encabezado. */
+export declare const RICH_LETTERHEAD_LIMITS: {
+    readonly maxImages: 4;
+    /** Lado mínimo de una imagen, en puntos. */
+    readonly minImageSize: 12;
+    /** Ancho mínimo del texto, en puntos. */
+    readonly minTextWidth: 60;
+    readonly organSizes: readonly [8, 9, 10, 11, 12, 13, 14, 16];
+    readonly lineSizes: readonly [6, 7, 8, 9, 10, 11, 12];
+};
+/**
+ * Lo que ocupa en la primera página el número y la fecha que estampa el sistema, arriba a la derecha: el encabezado no
+ * debe taparlo. En puntos; `right` es la distancia al borde derecho.
+ */
+export declare const RICH_NUMBER_ZONE: {
+    readonly right: 36;
+    readonly top: 18;
+    readonly height: 30;
+    readonly width: 230;
+};
 export declare const RICH_DEFAULT_LETTERHEAD: RichLetterhead;
 /** Límites de una imagen: formatos, peso y tamaño en el texto. */
 export declare const RICH_IMAGE_LIMITS: {

package/dist/entities/document/richStyle.js

@@ -4,7 +4,7 @@
  * márgenes. Todo lo que el PDF muestra sale de aquí, así que el editor y el documento oficial se ven igual.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RICH_IMAGE_LIMITS = exports.RICH_DEFAULT_LETTERHEAD = exports.RICH_DEFAULT_PAGE = exports.RICH_MAX_MARGIN = exports.RICH_MIN_MARGINS = exports.RICH_PAGE_SIZES = exports.RICH_SPACING_LIMITS = exports.RICH_HIGHLIGHTS = exports.RICH_COLORS = exports.RICH_FONT_SIZES = exports.RICH_FONTS = void 0;
+exports.RICH_IMAGE_LIMITS = exports.RICH_DEFAULT_LETTERHEAD = exports.RICH_NUMBER_ZONE = exports.RICH_LETTERHEAD_LIMITS = exports.RICH_DEFAULT_PAGE = exports.RICH_MAX_MARGIN = exports.RICH_MIN_MARGINS = exports.RICH_PAGE_SIZES = exports.RICH_SPACING_LIMITS = exports.RICH_HIGHLIGHTS = exports.RICH_COLORS = exports.RICH_FONT_SIZES = exports.RICH_FONTS = void 0;
 /**
  * Tipografías incrustadas en el PDF (PDF/A exige fuentes incrustadas). Liberation Sans, Liberation Serif y Carlito
  * miden igual que Arial, Times New Roman y Calibri: lo que se pegó desde Word ocupa lo mismo.
@@ -56,6 +56,21 @@ exports.RICH_DEFAULT_PAGE = {
     fontSize: 11,
     lineHeight: 1.2,
 };
+/** Límites del diseño libre del encabezado. */
+exports.RICH_LETTERHEAD_LIMITS = {
+    maxImages: 4,
+    /** Lado mínimo de una imagen, en puntos. */
+    minImageSize: 12,
+    /** Ancho mínimo del texto, en puntos. */
+    minTextWidth: 60,
+    organSizes: [8, 9, 10, 11, 12, 13, 14, 16],
+    lineSizes: [6, 7, 8, 9, 10, 11, 12],
+};
+/**
+ * Lo que ocupa en la primera página el número y la fecha que estampa el sistema, arriba a la derecha: el encabezado no
+ * debe taparlo. En puntos; `right` es la distancia al borde derecho.
+ */
+exports.RICH_NUMBER_ZONE = { right: 36, top: 18, height: 30, width: 230 };
 exports.RICH_DEFAULT_LETTERHEAD = { imageId: null, showOrganName: true, showUnitName: true };
 /** Límites de una imagen: formatos, peso y tamaño en el texto. */
 exports.RICH_IMAGE_LIMITS = {

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

@@ -2,8 +2,8 @@ import { type DocumentTemplateEntity } from '../../base/entities';
 import { type RichBlock, type RichField } from '../document/document.entity';
 import { type RichLetterhead, type RichPage } from '../document/richStyle';
 /**
- * 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).
+ * Contenido de la plantilla de un tipo documental: 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[];
@@ -13,30 +13,7 @@ export interface DocumentTemplateContent {
     /** Membrete con logo. Sin valor, el nombre de la municipalidad y de la unidad. */
     letterhead?: RichLetterhead;
 }
-/** 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. */
+/** La plantilla de un tipo documental, que se aplica al redactar uno de sus documentos: lista para usar. */
 export interface DocumentTemplateAvailableResponseEntity {
     id: DocumentTemplateEntity['id'];
     name: DocumentTemplateEntity['name'];
@@ -46,13 +23,3 @@ export interface DocumentTemplateAvailableResponseEntity {
     /** Es la plantilla del tipo documental pedido: se aplica sola al redactar. */
     ownedByType: boolean;
 }
-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/package.json

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

package/src/contracts/documentTemplate.contract.ts

@@ -1,59 +1,15 @@
-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';
+import { type DocumentTemplateAvailableResponseEntity } from '../entities';
 
-/** Patrones NATS de `documentTemplate` (plantillas propias del editor): `<servicio>.<recurso>.<acción>`. */
+/**
+ * Patrones NATS de `documentTemplate`. La plantilla de cada tipo documental se define y edita con el tipo
+ * (`documentType.create` y `documentType.update`); aquí solo se consulta al redactar.
+ */
 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). */
+  /** La plantilla habilitada del tipo documental, si tiene (una lista de a lo sumo una). */
   [DocumentTemplatePatterns.getAvailable]: {
     payload: { documentTypeId: string };
     response: DocumentTemplateAvailableResponseEntity[];

package/src/entities/document/richStyle.ts

@@ -106,9 +106,38 @@ export const RICH_DEFAULT_PAGE: RichPage = {
   lineHeight: 1.2,
 };
 
+/**
+ * Una imagen del encabezado (logo, escudo, sello) en el diseño libre: imagen registrada en el gestor, con su lugar y su
+ * tamaño en puntos desde la esquina superior izquierda de la hoja. Cabe en el margen superior.
+ */
+export interface RichLetterheadImage {
+  imageId: string;
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+}
+
+export type RichLetterheadAlign = 'left' | 'center' | 'right';
+
+/** El texto del membrete (nombre de la municipalidad, unidad y líneas propias) en el diseño libre. */
+export interface RichLetterheadText {
+  x: number;
+  y: number;
+  width: number;
+  align: RichLetterheadAlign;
+  /** Tamaño del nombre de la municipalidad, en puntos (sin valor, 10). */
+  organSize?: number;
+  /** Tamaño de la unidad y de las líneas propias, en puntos (sin valor, 8). */
+  lineSize?: number;
+}
+
 /**
  * Membrete de la plantilla, en el margen superior de cada página: un logo o escudo (opcional) y el nombre de la
  * municipalidad y de la unidad que emite. Va a la izquierda: a la derecha el sistema estampa el número y la fecha.
+ *
+ * Con `text`, el diseño es libre: las imágenes de `images` y el texto van donde se ubicaron (y `imageId` e
+ * `imageHeight` no se usan). Sin `text`, el de siempre: el logo de `imageId` y, a su lado, el texto.
  */
 export interface RichLetterhead {
   /** Imagen registrada en el gestor (`RichImage`), no un archivo de Drive. */
@@ -119,8 +148,31 @@ export interface RichLetterhead {
   showUnitName: boolean;
   /** Líneas propias bajo el nombre, como la dirección o el teléfono. */
   lines?: string[];
+  /** Diseño libre: las imágenes del encabezado, donde se ubicaron. */
+  images?: RichLetterheadImage[];
+  /** Diseño libre: dónde va el texto y con qué tamaño. */
+  text?: RichLetterheadText;
+  /** Línea divisoria bajo el encabezado, de margen a margen. */
+  rule?: boolean;
 }
 
+/** Límites del diseño libre del encabezado. */
+export const RICH_LETTERHEAD_LIMITS = {
+  maxImages: 4,
+  /** Lado mínimo de una imagen, en puntos. */
+  minImageSize: 12,
+  /** Ancho mínimo del texto, en puntos. */
+  minTextWidth: 60,
+  organSizes: [8, 9, 10, 11, 12, 13, 14, 16],
+  lineSizes: [6, 7, 8, 9, 10, 11, 12],
+} as const;
+
+/**
+ * Lo que ocupa en la primera página el número y la fecha que estampa el sistema, arriba a la derecha: el encabezado no
+ * debe taparlo. En puntos; `right` es la distancia al borde derecho.
+ */
+export const RICH_NUMBER_ZONE = { right: 36, top: 18, height: 30, width: 230 } as const;
+
 export const RICH_DEFAULT_LETTERHEAD: RichLetterhead = { imageId: null, showOrganName: true, showUnitName: true };
 
 /** Límites de una imagen: formatos, peso y tamaño en el texto. */

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

@@ -3,8 +3,8 @@ import { type RichBlock, type RichField } from '../document/document.entity';
 import { type RichLetterhead, type RichPage } from '../document/richStyle';
 
 /**
- * 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).
+ * Contenido de la plantilla de un tipo documental: 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[];
@@ -15,33 +15,7 @@ export interface DocumentTemplateContent {
   letterhead?: RichLetterhead;
 }
 
-/** 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. */
+/** La plantilla de un tipo documental, que se aplica al redactar uno de sus documentos: lista para usar. */
 export interface DocumentTemplateAvailableResponseEntity {
   id: DocumentTemplateEntity['id'];
   name: DocumentTemplateEntity['name'];
@@ -51,15 +25,3 @@ export interface DocumentTemplateAvailableResponseEntity {
   /** Es la plantilla del tipo documental pedido: se aplica sola al redactar. */
   ownedByType: boolean;
 }
-
-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;
-}