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

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

@@ -390,6 +390,77 @@ export interface DocumentTrailExportEntity {
 }
 /** Plantilla oficial con que se redacta un documento en el sistema. */
 export type DocumentTemplateKind = 'Decree' | 'Office' | 'Memorandum' | 'General';
+/** Formato de un trozo de texto en el editor del gestor. */
+export type RichMark = 'bold' | 'italic' | 'underline';
+/**
+ * Texto con su formato, o un campo de la plantilla (`field`: su clave), que se reemplaza por su valor al armar el PDF.
+ * Un salto de línea dentro del texto (`\n`) es un salto de línea del párrafo.
+ */
+export type RichInline = {
+    text: string;
+    marks?: RichMark[];
+} | {
+    field: string;
+};
+export type RichAlign = 'left' | 'center' | 'right' | 'justify';
+/** Numeración de una lista: viñetas, «1.» o la de los decretos, «1.-». */
+export type RichListStyle = 'bullet' | 'decimal' | 'decree';
+/**
+ * Cómo se ve una tabla: con bordes (`grid`), o como las líneas «DE:», «A:», «MAT.:» de un oficio, con la etiqueta en
+ * negrita y sin bordes (`labels`, o `labelsRight`, en la mitad derecha, como «ANT.» y «MAT.» de un oficio).
+ */
+export type RichTableVariant = 'grid' | 'labels' | 'labelsRight';
+/**
+ * Un bloque del texto. Los de una plantilla pueden ser fijos (`locked`): quien redacta no los cambia. Las listas son
+ * bloques seguidos del mismo estilo (su nivel es la sangría, desde 0); un título o un párrafo reinicia la numeración.
+ */
+export type RichBlock = {
+    id: string;
+    type: 'paragraph';
+    align?: RichAlign;
+    locked?: boolean;
+    content: RichInline[];
+} | {
+    id: string;
+    type: 'heading';
+    level: 1 | 2;
+    align?: RichAlign;
+    locked?: boolean;
+    content: RichInline[];
+} | {
+    id: string;
+    type: 'listItem';
+    list: RichListStyle;
+    level: number;
+    locked?: boolean;
+    content: RichInline[];
+}
+/** `rows[fila][columna]`: el contenido de cada celda. */
+ | {
+    id: string;
+    type: 'table';
+    variant: RichTableVariant;
+    locked?: boolean;
+    rows: RichInline[][][];
+} | {
+    id: string;
+    type: 'rule';
+    locked?: boolean;
+} | {
+    id: string;
+    type: 'pageBreak';
+    locked?: boolean;
+};
+/**
+ * Campo de una plantilla, con el valor que le dio quien redacta. `materia` es el asunto del documento: no se escribe
+ * aparte.
+ */
+export interface RichField {
+    key: string;
+    label: string;
+    value: string;
+    required?: boolean;
+}
 /**
  * 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.
@@ -426,6 +497,18 @@ export type DocumentComposition = {
     title: string;
     body: string[];
     closing?: string | null;
+}
+/**
+ * Redactado con el editor del gestor: los bloques del texto, los campos de la plantilla con su valor y la
+ * distribución. `templateKey` y `templateVersion`: de qué plantilla salió, si salió de una.
+ */
+ | {
+    template: 'Rich';
+    templateKey?: string | null;
+    templateVersion?: number | null;
+    blocks: RichBlock[];
+    fields: RichField[];
+    distribution: string[];
 };
 /** PDF armado con una plantilla: para la vista previa (`contentBase64`) o ya subido (`fileId`). */
 export interface DocumentComposeResponseEntity {

package/package.json

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

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

@@ -439,6 +439,50 @@ export interface DocumentTrailExportEntity {
 /** Plantilla oficial con que se redacta un documento en el sistema. */
 export type DocumentTemplateKind = 'Decree' | 'Office' | 'Memorandum' | 'General';
 
+/** Formato de un trozo de texto en el editor del gestor. */
+export type RichMark = 'bold' | 'italic' | 'underline';
+
+/**
+ * Texto con su formato, o un campo de la plantilla (`field`: su clave), que se reemplaza por su valor al armar el PDF.
+ * Un salto de línea dentro del texto (`\n`) es un salto de línea del párrafo.
+ */
+export type RichInline = { text: string; marks?: RichMark[] } | { field: string };
+
+export type RichAlign = 'left' | 'center' | 'right' | 'justify';
+
+/** Numeración de una lista: viñetas, «1.» o la de los decretos, «1.-». */
+export type RichListStyle = 'bullet' | 'decimal' | 'decree';
+
+/**
+ * Cómo se ve una tabla: con bordes (`grid`), o como las líneas «DE:», «A:», «MAT.:» de un oficio, con la etiqueta en
+ * negrita y sin bordes (`labels`, o `labelsRight`, en la mitad derecha, como «ANT.» y «MAT.» de un oficio).
+ */
+export type RichTableVariant = 'grid' | 'labels' | 'labelsRight';
+
+/**
+ * Un bloque del texto. Los de una plantilla pueden ser fijos (`locked`): quien redacta no los cambia. Las listas son
+ * bloques seguidos del mismo estilo (su nivel es la sangría, desde 0); un título o un párrafo reinicia la numeración.
+ */
+export type RichBlock =
+  | { id: string; type: 'paragraph'; align?: RichAlign; locked?: boolean; content: RichInline[] }
+  | { id: string; type: 'heading'; level: 1 | 2; align?: RichAlign; locked?: boolean; content: RichInline[] }
+  | { id: string; type: 'listItem'; list: RichListStyle; level: number; locked?: boolean; content: RichInline[] }
+  /** `rows[fila][columna]`: el contenido de cada celda. */
+  | { id: string; type: 'table'; variant: RichTableVariant; locked?: boolean; rows: RichInline[][][] }
+  | { id: string; type: 'rule'; locked?: boolean }
+  | { id: string; type: 'pageBreak'; locked?: boolean };
+
+/**
+ * Campo de una plantilla, con el valor que le dio quien redacta. `materia` es el asunto del documento: no se escribe
+ * aparte.
+ */
+export interface RichField {
+  key: string;
+  label: string;
+  value: string;
+  required?: boolean;
+}
+
 /**
  * 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.
@@ -474,7 +518,19 @@ export type DocumentComposition =
       closing?: string | null;
       distribution: string[];
     }
-  | { template: 'General'; title: string; body: string[]; closing?: string | null };
+  | { template: 'General'; title: string; body: string[]; closing?: string | null }
+  /**
+   * Redactado con el editor del gestor: los bloques del texto, los campos de la plantilla con su valor y la
+   * distribución. `templateKey` y `templateVersion`: de qué plantilla salió, si salió de una.
+   */
+  | {
+      template: 'Rich';
+      templateKey?: string | null;
+      templateVersion?: number | null;
+      blocks: RichBlock[];
+      fields: RichField[];
+      distribution: string[];
+    };
 
 /** PDF armado con una plantilla: para la vista previa (`contentBase64`) o ya subido (`fileId`). */
 export interface DocumentComposeResponseEntity {