@muni-sanfer/types-gestor-documental 0.0.1-beta.2 → 0.0.1-beta.21

package/src/contracts/index.ts

@@ -1,15 +1,72 @@
+import { CaseFilePatterns, type CaseFileContract } from './caseFile.contract';
 import { DocumentPatterns, type DocumentContract } from './document.contract';
 import { DocumentTypePatterns, type DocumentTypeContract } from './documentType.contract';
+import { IssuingEntityPatterns, type IssuingEntityContract } from './issuingEntity.contract';
+import { ArchivalSeriesPatterns, type ArchivalSeriesContract } from './archivalSeries.contract';
+import { TextSnippetPatterns, type TextSnippetContract } from './textSnippet.contract';
+import { HolidayPatterns, type HolidayContract } from './holiday.contract';
+import { IndicatorsPatterns, type IndicatorsContract } from './indicators.contract';
+import { AuditPatterns, type AuditContract } from './audit.contract';
+import { SignatureCheckPatterns, type SignatureCheckContract } from './signatureCheck.contract';
+import { ScanPatterns, type ScanContract } from './scan.contract';
+import { PartsOfficePatterns, type PartsOfficeContract } from './partsOffice.contract';
+import { ProcedurePatterns, type ProcedureContract } from './procedure.contract';
+import { RegisterBookPatterns, type RegisterBookContract } from './registerBook.contract';
+import { SignatureBatchPatterns, type SignatureBatchContract } from './signatureBatch.contract';
+import { WorkFolderPatterns, type WorkFolderContract } from './workFolder.contract';
 
 export * from './contract';
 export * from './document.contract';
 export * from './documentType.contract';
+export * from './procedure.contract';
+export * from './issuingEntity.contract';
+export * from './caseFile.contract';
+export * from './partsOffice.contract';
+export * from './registerBook.contract';
+export * from './signatureBatch.contract';
+export * from './workFolder.contract';
+export * from './scan.contract';
+export * from './archivalSeries.contract';
+export * from './textSnippet.contract';
+export * from './holiday.contract';
+export * from './indicators.contract';
+export * from './audit.contract';
+export * from './signatureCheck.contract';
 
 /** Patrones NATS de gestor-documental-ms, por recurso: `gestorDocumental.<recurso>.<acción>`. */
 export const GestorDocumentalPatterns = {
   documentType: DocumentTypePatterns,
   document: DocumentPatterns,
+  procedure: ProcedurePatterns,
+  issuingEntity: IssuingEntityPatterns,
+  caseFile: CaseFilePatterns,
+  partsOffice: PartsOfficePatterns,
+  registerBook: RegisterBookPatterns,
+  signatureBatch: SignatureBatchPatterns,
+  workFolder: WorkFolderPatterns,
+  scan: ScanPatterns,
+  archivalSeries: ArchivalSeriesPatterns,
+  textSnippet: TextSnippetPatterns,
+  holiday: HolidayPatterns,
+  indicators: IndicatorsPatterns,
+  audit: AuditPatterns,
+  signatureCheck: SignatureCheckPatterns,
 } as const;
 
 /** Contrato completo de gestor-documental-ms: la unión de los contratos de sus recursos. */
-export type GestorDocumentalContract = DocumentTypeContract & DocumentContract;
+export type GestorDocumentalContract = DocumentTypeContract &
+  DocumentContract &
+  ProcedureContract &
+  IssuingEntityContract &
+  CaseFileContract &
+  PartsOfficeContract &
+  RegisterBookContract &
+  SignatureBatchContract &
+  WorkFolderContract &
+  ScanContract &
+  ArchivalSeriesContract &
+  TextSnippetContract &
+  HolidayContract &
+  IndicatorsContract &
+  AuditContract &
+  SignatureCheckContract;

package/src/contracts/indicators.contract.ts

@@ -0,0 +1,80 @@
+import {
+  type IndicatorsFileEntity,
+  type ManagementIndicatorsEntity,
+  type QualityMetricSettingResponseEntity,
+  type QualityReportEntity,
+  type ServiceOutageRemoveResponseEntity,
+  type ServiceOutageResponseEntity,
+} from '../entities';
+import { type QualityMetricKey, type ServiceOutageKind } from '../base/entities';
+
+/** Patrones NATS de `indicators`: indicadores de gestión y Plan de Mejora Continua (DS 11/2023). */
+export const IndicatorsPatterns = {
+  getManagement: 'gestorDocumental.indicators.getManagement',
+  getQuality: 'gestorDocumental.indicators.getQuality',
+  export: 'gestorDocumental.indicators.export',
+  updateQualityMetric: 'gestorDocumental.indicators.updateQualityMetric',
+  getOutages: 'gestorDocumental.indicators.getOutages',
+  createOutage: 'gestorDocumental.indicators.createOutage',
+  updateOutage: 'gestorDocumental.indicators.updateOutage',
+  removeOutage: 'gestorDocumental.indicators.removeOutage',
+  getOutageCertificate: 'gestorDocumental.indicators.getOutageCertificate',
+} as const;
+
+/** Período: días de Chile «AAAA-MM-DD», hasta dos años. */
+export interface IndicatorsPeriodQuery {
+  from: string;
+  to: string;
+}
+
+export interface ManagementIndicatorsQuery extends IndicatorsPeriodQuery {
+  documentTypeId?: string | null;
+  directorateCode?: number | null;
+}
+
+export interface ServiceOutageInput {
+  kind: ServiceOutageKind;
+  startedAt: string;
+  endedAt?: string | null;
+  cause: string;
+  affectedServices?: string | null;
+}
+
+export interface IndicatorsContract {
+  [IndicatorsPatterns.getManagement]: { payload: ManagementIndicatorsQuery; response: ManagementIndicatorsEntity };
+  [IndicatorsPatterns.getQuality]: { payload: IndicatorsPeriodQuery; response: QualityReportEntity };
+  /**
+   * Indicadores y Plan de Mejora en una planilla Excel. `generatedBy`: quién la descarga. `unitNames`: nombre de cada
+   * unidad (`c:<código de dirección>` o `d:<id de departamento>`), que el ms no conoce.
+   */
+  [IndicatorsPatterns.export]: {
+    payload: ManagementIndicatorsQuery & { generatedBy: string; unitNames?: Record<string, string> };
+    response: IndicatorsFileEntity;
+  };
+  /** Umbral y, en las métricas declaradas, su valor y respaldo. */
+  [IndicatorsPatterns.updateQualityMetric]: {
+    payload: {
+      key: QualityMetricKey;
+      threshold: number;
+      declaredValue?: number | null;
+      declaredNote?: string | null;
+      actor: { fullName: string };
+    };
+    response: QualityMetricSettingResponseEntity;
+  };
+  [IndicatorsPatterns.getOutages]: { payload: { year: number }; response: ServiceOutageResponseEntity[] };
+  [IndicatorsPatterns.createOutage]: {
+    payload: ServiceOutageInput & { actor: { employeeId: string; fullName: string } };
+    response: ServiceOutageResponseEntity;
+  };
+  [IndicatorsPatterns.updateOutage]: {
+    payload: ServiceOutageInput & { id: string; actor: { employeeId: string; fullName: string } };
+    response: ServiceOutageResponseEntity;
+  };
+  [IndicatorsPatterns.removeOutage]: { payload: { id: string }; response: ServiceOutageRemoveResponseEntity };
+  /** Certificado de indisponibilidad (DS 10/2023) en PDF, de una caída ya terminada. */
+  [IndicatorsPatterns.getOutageCertificate]: {
+    payload: { id: string; generatedBy: string };
+    response: IndicatorsFileEntity;
+  };
+}

package/src/contracts/issuingEntity.contract.ts

@@ -0,0 +1,55 @@
+import { type IssuingEntityEntity } from '../base/entities';
+import {
+  type IssuingEntityCreateResponseEntity,
+  type IssuingEntityGetAllResponseEntity,
+  type IssuingEntityGetByIdResponseEntity,
+  type IssuingEntityUpdateResponseEntity,
+} from '../entities';
+import { type RpcPage } from './contract';
+
+/** Patrones NATS de `issuingEntity`: `<servicio>.<recurso>.<acción>`. */
+export const IssuingEntityPatterns = {
+  getAll: 'gestorDocumental.issuingEntity.getAll',
+  getById: 'gestorDocumental.issuingEntity.getById',
+  create: 'gestorDocumental.issuingEntity.create',
+  update: 'gestorDocumental.issuingEntity.update',
+  setEnabled: 'gestorDocumental.issuingEntity.setEnabled',
+} as const;
+
+/** Datos de una entidad emisora al crearla o editarla. */
+export interface IssuingEntityWritePayload {
+  name: string;
+  shortName?: string | null;
+  /** Direcciones (código de caschile) cuyos funcionarios actúan por la entidad. */
+  directorateCodeReferences: number[];
+  /** Su entidad en DocDigital, entre las asociadas a las credenciales del gestor. */
+  docDigitalEntityId?: number | null;
+  enabled?: boolean;
+}
+
+export interface IssuingEntityContract {
+  [IssuingEntityPatterns.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<IssuingEntityGetAllResponseEntity[]>;
+  };
+  [IssuingEntityPatterns.getById]: {
+    payload: Pick<IssuingEntityEntity, 'id'>;
+    response: IssuingEntityGetByIdResponseEntity;
+  };
+  [IssuingEntityPatterns.create]: {
+    payload: IssuingEntityWritePayload;
+    response: IssuingEntityCreateResponseEntity;
+  };
+  [IssuingEntityPatterns.update]: {
+    payload: IssuingEntityWritePayload & Pick<IssuingEntityEntity, 'id'>;
+    response: IssuingEntityUpdateResponseEntity;
+  };
+  [IssuingEntityPatterns.setEnabled]: {
+    payload: Pick<IssuingEntityEntity, 'id' | 'enabled'>;
+    response: IssuingEntityUpdateResponseEntity;
+  };
+}

package/src/contracts/partsOffice.contract.ts

@@ -0,0 +1,123 @@
+import { type DocumentAccessLevel, type DocumentInstruction } from '../base/entities';
+import {
+  type DocDigitalDocumentTypeEntity,
+  type DocDigitalEntityEntity,
+  type PartsOfficeInboundEntity,
+  type DocDigitalUserEntity,
+  type PartsOfficeDispatchEntity,
+  type PartsOfficeFileEntity,
+  type PartsOfficeOkResponseEntity,
+  type PartsOfficeRegisterResponseEntity,
+  type PartsOfficeStatusEntity,
+  type PartsOfficeSummaryEntity,
+  type PartsOfficeSyncResponseEntity,
+} from '../entities';
+import { type RpcPage } from './contract';
+import { type DocumentActor, type DocumentExternalRecipientInput } from './document.contract';
+
+/** Patrones NATS de `partsOffice` (Oficina de Partes y DocDigital): `<servicio>.<recurso>.<acción>`. */
+export const PartsOfficePatterns = {
+  getStatus: 'gestorDocumental.partsOffice.getStatus',
+  getSummary: 'gestorDocumental.partsOffice.getSummary',
+  getEntities: 'gestorDocumental.partsOffice.getEntities',
+  getOwnEntities: 'gestorDocumental.partsOffice.getOwnEntities',
+  getUsers: 'gestorDocumental.partsOffice.getUsers',
+  getDocumentTypes: 'gestorDocumental.partsOffice.getDocumentTypes',
+  getDispatches: 'gestorDocumental.partsOffice.getDispatches',
+  dispatch: 'gestorDocumental.partsOffice.dispatch',
+  returnDispatch: 'gestorDocumental.partsOffice.returnDispatch',
+  resendDispatch: 'gestorDocumental.partsOffice.resendDispatch',
+  getDispatchFile: 'gestorDocumental.partsOffice.getDispatchFile',
+  getInbound: 'gestorDocumental.partsOffice.getInbound',
+  syncInbound: 'gestorDocumental.partsOffice.syncInbound',
+  registerInbound: 'gestorDocumental.partsOffice.registerInbound',
+  acknowledgeInbound: 'gestorDocumental.partsOffice.acknowledgeInbound',
+  returnInbound: 'gestorDocumental.partsOffice.returnInbound',
+  getInboundFile: 'gestorDocumental.partsOffice.getInboundFile',
+} as const;
+
+/** Destinatario interno de un ingreso, ya resuelto por el gateway (las áreas con sus integrantes). */
+export type PartsOfficeRecipientInput =
+  | { type: 'Employee'; employeeId: string }
+  | { type: 'Directorate'; directorateCodeReference: number; name: string; memberEmployeeIds: string[] }
+  | { type: 'Department'; departmentId: string; name: string; memberEmployeeIds: string[] };
+
+interface IListPayload<S> {
+  pagination?: { page?: number; limit?: number };
+  filters?: { search?: string; status?: S };
+}
+
+export interface PartsOfficeContract {
+  [PartsOfficePatterns.getStatus]: { payload: Record<string, never>; response: PartsOfficeStatusEntity };
+  [PartsOfficePatterns.getSummary]: { payload: Record<string, never>; response: PartsOfficeSummaryEntity };
+  /** Directorio de DocDigital: instituciones por nombre. */
+  [PartsOfficePatterns.getEntities]: { payload: { search?: string }; response: DocDigitalEntityEntity[] };
+  /** Entidades asociadas a las credenciales del gestor: la del municipio y las de sus entidades emisoras. */
+  [PartsOfficePatterns.getOwnEntities]: { payload: Record<string, never>; response: DocDigitalEntityEntity[] };
+  [PartsOfficePatterns.getUsers]: {
+    payload: { entityId: number; search?: string };
+    response: DocDigitalUserEntity[];
+  };
+  [PartsOfficePatterns.getDocumentTypes]: { payload: Record<string, never>; response: DocDigitalDocumentTypeEntity[] };
+  [PartsOfficePatterns.getDispatches]: {
+    payload: IListPayload<'Pending' | 'Dispatched' | 'Returned'>;
+    response: RpcPage<PartsOfficeDispatchEntity[]>;
+  };
+  /** Despacha por DocDigital, con el número del documento como folio. `operatorRun`: RUN de quien despacha. */
+  [PartsOfficePatterns.dispatch]: {
+    payload: { id: string; docDigitalTypeId: number; operatorRun?: string | null; actor: DocumentActor };
+    response: PartsOfficeOkResponseEntity & { docDigitalDocumentId: string };
+  };
+  /** Devuelve el despacho al redactor, con el motivo (por ejemplo, un destinatario equivocado). */
+  [PartsOfficePatterns.returnDispatch]: {
+    payload: { id: string; reason: string; actor: DocumentActor };
+    response: PartsOfficeOkResponseEntity;
+  };
+  /** El redactor corrige las instituciones de destino de un despacho devuelto y lo envía de nuevo a Partes. */
+  [PartsOfficePatterns.resendDispatch]: {
+    payload: { id: string; externalRecipients: DocumentExternalRecipientInput[]; actor: DocumentActor };
+    response: PartsOfficeOkResponseEntity;
+  };
+  /** PDF firmado de un documento por despachar, para que Oficina de Partes lo revise. */
+  [PartsOfficePatterns.getDispatchFile]: { payload: { id: string }; response: PartsOfficeFileEntity };
+  [PartsOfficePatterns.getInbound]: {
+    payload: IListPayload<'Pending' | 'Registered' | 'Returned'>;
+    response: RpcPage<PartsOfficeInboundEntity[]>;
+  };
+  /** Trae de DocDigital lo recibido que aún no tiene acuse de recibo. */
+  [PartsOfficePatterns.syncInbound]: { payload: Record<string, never>; response: PartsOfficeSyncResponseEntity };
+  /**
+   * Ingresa un recibido al gestor: le da folio de ingreso, lo deriva a quienes corresponda y da el acuse de recibo
+   * en DocDigital.
+   */
+  [PartsOfficePatterns.registerInbound]: {
+    payload: {
+      id: string;
+      documentTypeId: string;
+      keywords: string[];
+      accessLevel: DocumentAccessLevel;
+      hasSensitiveData: boolean;
+      recipients: PartsOfficeRecipientInput[];
+      instruction: DocumentInstruction;
+      note?: string | null;
+      dueAt?: string | null;
+      actor: DocumentActor;
+    };
+    response: PartsOfficeRegisterResponseEntity;
+  };
+  /** Reintenta el acuse de recibo de un recibido ya ingresado. */
+  [PartsOfficePatterns.acknowledgeInbound]: {
+    payload: { id: string; actor: DocumentActor };
+    response: PartsOfficeOkResponseEntity;
+  };
+  /** Devuelve el recibido a la institución que lo envió, con el motivo (entre 3 y 255 caracteres). */
+  [PartsOfficePatterns.returnInbound]: {
+    payload: { id: string; reason: string; actor: DocumentActor };
+    response: PartsOfficeOkResponseEntity;
+  };
+  /** Archivo de un recibido: el principal o, con `attachment`, uno de sus anexos (por su posición). */
+  [PartsOfficePatterns.getInboundFile]: {
+    payload: { id: string; attachment?: number };
+    response: PartsOfficeFileEntity;
+  };
+}

package/src/contracts/procedure.contract.ts

@@ -0,0 +1,53 @@
+import { type ProcedureEntity } from '../base/entities';
+import {
+  type ProcedureCreateResponseEntity,
+  type ProcedureGetAllResponseEntity,
+  type ProcedureGetByIdResponseEntity,
+  type ProcedureUpdateResponseEntity,
+} from '../entities';
+import { type RpcPage } from './contract';
+
+/** Patrones NATS de `procedure`: `<servicio>.<recurso>.<acción>`. */
+export const ProcedurePatterns = {
+  getAll: 'gestorDocumental.procedure.getAll',
+  getById: 'gestorDocumental.procedure.getById',
+  create: 'gestorDocumental.procedure.create',
+  update: 'gestorDocumental.procedure.update',
+  setEnabled: 'gestorDocumental.procedure.setEnabled',
+} as const;
+
+/** Datos de un procedimiento administrativo al crearlo o editarlo. */
+export interface ProcedureWritePayload {
+  name: string;
+  cpatId?: string | null;
+  cpatCode?: string | null;
+  description?: string | null;
+  enabled?: boolean;
+}
+
+export interface ProcedureContract {
+  [ProcedurePatterns.getAll]: {
+    // sin `page` y `limit` responde todos en una sola página
+    payload: {
+      pagination?: { page?: number; limit?: number };
+      filters?: { search?: string; enabled?: boolean };
+    };
+    response: RpcPage<ProcedureGetAllResponseEntity[]>;
+  };
+  [ProcedurePatterns.getById]: {
+    payload: Pick<ProcedureEntity, 'id'>;
+    response: ProcedureGetByIdResponseEntity;
+  };
+  [ProcedurePatterns.create]: {
+    payload: ProcedureWritePayload;
+    response: ProcedureCreateResponseEntity;
+  };
+  [ProcedurePatterns.update]: {
+    payload: ProcedureWritePayload & Pick<ProcedureEntity, 'id'>;
+    response: ProcedureUpdateResponseEntity;
+  };
+  [ProcedurePatterns.setEnabled]: {
+    payload: Pick<ProcedureEntity, 'id' | 'enabled'>;
+    response: ProcedureUpdateResponseEntity;
+  };
+}

package/src/contracts/registerBook.contract.ts

@@ -0,0 +1,24 @@
+import { type RegisterBookEntity, type RegisterBookExportEntity, type RegisterBookKind } from '../entities';
+
+/** Patrones NATS de `registerBook` (libros de registro): `<servicio>.<recurso>.<acción>`. */
+export const RegisterBookPatterns = {
+  get: 'gestorDocumental.registerBook.get',
+  export: 'gestorDocumental.registerBook.export',
+} as const;
+
+/** Qué libro y qué período: un año y, si se indica, un mes. El de un tipo documental exige el tipo. */
+export interface RegisterBookQuery {
+  kind: RegisterBookKind;
+  documentTypeId?: string;
+  year: number;
+  month?: number | null;
+}
+
+export interface RegisterBookContract {
+  [RegisterBookPatterns.get]: { payload: RegisterBookQuery; response: RegisterBookEntity };
+  /** El libro en Excel o PDF. `generatedBy`: quién lo descarga (va en el encabezado). */
+  [RegisterBookPatterns.export]: {
+    payload: RegisterBookQuery & { format: 'xlsx' | 'pdf'; generatedBy: string };
+    response: RegisterBookExportEntity;
+  };
+}

package/src/contracts/scan.contract.ts

@@ -0,0 +1,52 @@
+import {
+  type ScanSessionCreateResponseEntity,
+  type ScanSessionFileResponseEntity,
+  type ScanSessionPublicEntity,
+  type ScanSessionResponseEntity,
+} from '../entities';
+import { type DocumentActor } from './document.contract';
+
+/** Patrones NATS de `scan`: escanear con el celular. */
+export const ScanPatterns = {
+  create: 'gestorDocumental.scan.create',
+  getById: 'gestorDocumental.scan.getById',
+  getFile: 'gestorDocumental.scan.getFile',
+  getByToken: 'gestorDocumental.scan.getByToken',
+  addPage: 'gestorDocumental.scan.addPage',
+  finish: 'gestorDocumental.scan.finish',
+} as const;
+
+export interface ScanContract {
+  /**
+   * Abre una sesión de escaneo para el funcionario. `url` es la dirección pública del celular (sin el token): con ella
+   * se arma el QR que se muestra en el escritorio.
+   */
+  [ScanPatterns.create]: {
+    payload: { url: string; actor: DocumentActor };
+    response: ScanSessionCreateResponseEntity;
+  };
+  /** Estado de la sesión, para quien la abrió: el escritorio la consulta hasta que el PDF esté listo. */
+  [ScanPatterns.getById]: {
+    payload: { id: string; actor: DocumentActor };
+    response: ScanSessionResponseEntity;
+  };
+  [ScanPatterns.getFile]: {
+    payload: { id: string; actor: DocumentActor };
+    response: ScanSessionFileResponseEntity;
+  };
+  /** Sin sesión, desde el celular, con el token del QR. */
+  [ScanPatterns.getByToken]: {
+    payload: { token: string };
+    response: ScanSessionPublicEntity;
+  };
+  /** Agrega una foto ya subida al gestor de archivos (la sube el gateway). */
+  [ScanPatterns.addPage]: {
+    payload: { token: string; fileId: string; contentType: string; size: number };
+    response: ScanSessionPublicEntity;
+  };
+  /** Junta las fotos en un PDF y cierra la sesión. */
+  [ScanPatterns.finish]: {
+    payload: { token: string };
+    response: ScanSessionPublicEntity;
+  };
+}

package/src/contracts/signatureBatch.contract.ts

@@ -0,0 +1,96 @@
+import { type DocumentAccessLevel } from '../base/entities';
+import {
+  type SignatureBatchCreateResponseEntity,
+  type SignatureBatchGetAllResponseEntity,
+  type SignatureBatchGetByIdResponseEntity,
+  type SignatureBatchRejectResponseEntity,
+  type SignatureBatchSignResponseEntity,
+  type SignatureBatchTab,
+  type SignatureBatchVisaResponseEntity,
+} from '../entities';
+import { type RpcPage } from './contract';
+import { type DocumentActor } from './document.contract';
+
+/** Patrones NATS de `signatureBatch` (lotes de firma): `<servicio>.<recurso>.<acción>`. */
+export const SignatureBatchPatterns = {
+  getAll: 'gestorDocumental.signatureBatch.getAll',
+  getById: 'gestorDocumental.signatureBatch.getById',
+  create: 'gestorDocumental.signatureBatch.create',
+  visa: 'gestorDocumental.signatureBatch.visa',
+  sign: 'gestorDocumental.signatureBatch.sign',
+  reject: 'gestorDocumental.signatureBatch.reject',
+} as const;
+
+/** Datos de quien firma, para el sello de la firma (los resuelve el gateway desde la sesión). */
+export interface SignatureBatchSigner {
+  rut: string;
+  fullName: string;
+  role: string;
+  areaName: string;
+}
+
+export interface SignatureBatchContract {
+  [SignatureBatchPatterns.getAll]: {
+    payload: {
+      pagination?: { page?: number; limit?: number };
+      filters?: { search?: string; tab?: SignatureBatchTab };
+      actor: DocumentActor;
+    };
+    response: RpcPage<SignatureBatchGetAllResponseEntity[]>;
+  };
+  /** Lo ven su redactor y quienes visan o firman sus documentos; con `viewAll`, quien lleva el registro. */
+  [SignatureBatchPatterns.getById]: {
+    payload: { id: string; actor: DocumentActor; viewAll?: boolean };
+    response: SignatureBatchGetByIdResponseEntity;
+  };
+  /**
+   * Crea el lote y lo envía a tramitación: un documento por cada PDF, todos del mismo tipo y con el mismo flujo.
+   * Cada documento recibe su código de verificación y, con su primera firma, su número (si el tipo lo lleva).
+   */
+  [SignatureBatchPatterns.create]: {
+    payload: {
+      name: string;
+      documentTypeId: string;
+      keywords: string[];
+      accessLevel?: DocumentAccessLevel;
+      hasSensitiveData?: boolean;
+      directorateCodeReference?: number | null;
+      departmentId?: string | null;
+      visaEmployeeIds?: string[];
+      // Etapa de cada visador: los de una misma etapa visan a la vez.
+      visaStages?: number[] | null;
+      signatureEmployeeIds: string[];
+      signatureSheet?: boolean;
+      documents: { subject: string; file: { fileId: string; name: string } }[];
+      actor: DocumentActor;
+    };
+    response: SignatureBatchCreateResponseEntity;
+  };
+  /** Visa de una vez los documentos del lote que el funcionario tiene en su turno de visación. */
+  [SignatureBatchPatterns.visa]: {
+    payload: { id: string; observation?: string | null; actor: DocumentActor };
+    response: SignatureBatchVisaResponseEntity;
+  };
+  /**
+   * Firma con un solo OTP los documentos del lote que el funcionario tiene en su turno de firma. FirmaGob admite 5 MB
+   * por solicitud: los que no caben quedan en `remaining`, para firmarlos con un OTP nuevo.
+   */
+  [SignatureBatchPatterns.sign]: {
+    payload: {
+      id: string;
+      observation?: string | null;
+      signer: SignatureBatchSigner;
+      otp?: string;
+      actor: DocumentActor;
+    };
+    response: SignatureBatchSignResponseEntity;
+  };
+  /**
+   * Devuelve a su redactor los documentos del lote que el funcionario tiene en su turno: todos, o los indicados en
+   * `documentIds`. Los demás siguen su curso.
+   */
+  [SignatureBatchPatterns.reject]: {
+    payload: { id: string; observation: string; documentIds?: string[]; actor: DocumentActor };
+    response: SignatureBatchRejectResponseEntity;
+  };
+}

package/src/contracts/signatureCheck.contract.ts

@@ -0,0 +1,11 @@
+import { type PdfSignatureReportEntity } from '../entities';
+
+/** Patrones NATS de `signatureCheck`: revisión de las firmas electrónicas de un PDF. */
+export const SignatureCheckPatterns = {
+  check: 'gestorDocumental.signatureCheck.check',
+} as const;
+
+export interface SignatureCheckContract {
+  /** Revisa un PDF ya subido al gestor de archivos (la herramienta «Validar firmas» lo sube antes). */
+  [SignatureCheckPatterns.check]: { payload: { fileId: string }; response: PdfSignatureReportEntity };
+}

package/src/contracts/textSnippet.contract.ts

@@ -0,0 +1,53 @@
+import { type TextSnippetEntity, type TextSnippetSection } from '../base/entities';
+import {
+  type TextSnippetCreateResponseEntity,
+  type TextSnippetGetAllResponseEntity,
+  type TextSnippetGetByIdResponseEntity,
+  type TextSnippetUpdateResponseEntity,
+} from '../entities';
+import { type RpcPage } from './contract';
+
+/** Patrones NATS de `textSnippet` (biblioteca de vistos y cláusulas): `<servicio>.<recurso>.<acción>`. */
+export const TextSnippetPatterns = {
+  getAll: 'gestorDocumental.textSnippet.getAll',
+  getById: 'gestorDocumental.textSnippet.getById',
+  create: 'gestorDocumental.textSnippet.create',
+  update: 'gestorDocumental.textSnippet.update',
+  setEnabled: 'gestorDocumental.textSnippet.setEnabled',
+} as const;
+
+/** Datos de un texto de la biblioteca al crearlo o editarlo. */
+export interface TextSnippetWritePayload {
+  title: string;
+  text: string;
+  section: TextSnippetSection;
+  keywords?: string[];
+  enabled?: boolean;
+}
+
+export interface TextSnippetContract {
+  [TextSnippetPatterns.getAll]: {
+    // sin `page` y `limit` responde todas en una sola página
+    payload: {
+      pagination?: { page?: number; limit?: number };
+      filters?: { search?: string; enabled?: boolean; section?: TextSnippetSection };
+    };
+    response: RpcPage<TextSnippetGetAllResponseEntity[]>;
+  };
+  [TextSnippetPatterns.getById]: {
+    payload: Pick<TextSnippetEntity, 'id'>;
+    response: TextSnippetGetByIdResponseEntity;
+  };
+  [TextSnippetPatterns.create]: {
+    payload: TextSnippetWritePayload;
+    response: TextSnippetCreateResponseEntity;
+  };
+  [TextSnippetPatterns.update]: {
+    payload: TextSnippetWritePayload & Pick<TextSnippetEntity, 'id'>;
+    response: TextSnippetUpdateResponseEntity;
+  };
+  [TextSnippetPatterns.setEnabled]: {
+    payload: Pick<TextSnippetEntity, 'id' | 'enabled'>;
+    response: TextSnippetUpdateResponseEntity;
+  };
+}