@muni-sanfer/types-gestor-documental 0.0.1-beta.14 → 0.0.1-beta.16

package/src/contracts/index.ts

@@ -2,6 +2,8 @@ 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 { 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';
@@ -18,6 +20,8 @@ export * from './partsOffice.contract';
 export * from './registerBook.contract';
 export * from './signatureBatch.contract';
 export * from './workFolder.contract';
+export * from './scan.contract';
+export * from './archivalSeries.contract';
 
 /** Patrones NATS de gestor-documental-ms, por recurso: `gestorDocumental.<recurso>.<acción>`. */
 export const GestorDocumentalPatterns = {
@@ -30,6 +34,8 @@ export const GestorDocumentalPatterns = {
   registerBook: RegisterBookPatterns,
   signatureBatch: SignatureBatchPatterns,
   workFolder: WorkFolderPatterns,
+  scan: ScanPatterns,
+  archivalSeries: ArchivalSeriesPatterns,
 } as const;
 
 /** Contrato completo de gestor-documental-ms: la unión de los contratos de sus recursos. */
@@ -41,4 +47,6 @@ export type GestorDocumentalContract = DocumentTypeContract &
   PartsOfficeContract &
   RegisterBookContract &
   SignatureBatchContract &
-  WorkFolderContract;
+  WorkFolderContract &
+  ScanContract &
+  ArchivalSeriesContract;

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/entities/archivalSeries/archivalSeries.entity.ts

@@ -0,0 +1,32 @@
+import { ArchivalSeriesEntity } from '../../base/entities';
+
+export interface ArchivalSeriesGetAllResponseEntity {
+  id: ArchivalSeriesEntity['id'];
+  code: ArchivalSeriesEntity['code'];
+  name: ArchivalSeriesEntity['name'];
+  section: ArchivalSeriesEntity['section'];
+  description: ArchivalSeriesEntity['description'];
+  enabled: ArchivalSeriesEntity['enabled'];
+  /** Cuántos tipos documentales y expedientes la usan. */
+  documentTypes: number;
+  caseFiles: number;
+}
+
+export type ArchivalSeriesGetByIdResponseEntity = ArchivalSeriesGetAllResponseEntity;
+
+/** Cómo se cita una serie donde se usa: código y nombre. */
+export interface ArchivalSeriesSummaryEntity {
+  id: string;
+  code: string;
+  name: string;
+}
+
+export interface ArchivalSeriesCreateResponseEntity {
+  id: ArchivalSeriesEntity['id'];
+  ok: boolean;
+}
+
+export interface ArchivalSeriesUpdateResponseEntity {
+  id: ArchivalSeriesEntity['id'];
+  ok: boolean;
+}

package/src/entities/archivalSeries/index.ts

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

package/src/entities/caseFile/caseFile.entity.ts

@@ -121,7 +121,10 @@ export interface CaseFileAccessResponseEntity {
   entryId: CaseFileAccessEntity['entryId'];
   /** Título del documento que se abrió, si el acceso fue a uno. */
   entryTitle: string | null;
+  /** El funcionario o, si fue por un enlace temporal, su destinatario externo. */
   employeeFullName: CaseFileAccessEntity['employeeFullName'];
+  /** Fue por un enlace temporal, sin sesión. */
+  external: boolean;
   createdAt: CaseFileAccessEntity['createdAt'];
 }
 
@@ -137,6 +140,10 @@ export interface CaseFileGetByIdResponseEntity extends CaseFileGetAllResponseEnt
   closingNote: CaseFileEntity['closingNote'];
   /** Expediente híbrido: tiene documentos en papel que no se pudieron digitalizar. */
   isHybrid: boolean;
+  /** MGDEE1_2: serie del Cuadro de Clasificación. */
+  archivalSeries: { id: string; code: string; name: string } | null;
+  /** MGDEE8_2: fin de la restricción de acceso. */
+  restrictionEndsAt: string | null;
   index: CaseFileEntryResponseEntity[];
   sharedWith: CaseFileParticipantResponseEntity[];
   actors: CaseFileActorResponseEntity[];
@@ -210,3 +217,79 @@ export interface CaseFileExportResponseEntity {
 
 /** Expediente en que está incorporado un documento, visto desde el documento. */
 export type DocumentCaseFileEntity = CaseFileLinkEntity;
+
+/** Estado de un enlace temporal: vigente, vencido o revocado. */
+export type CaseFileShareLinkStatus = 'Active' | 'Expired' | 'Revoked';
+
+/** Enlace temporal de un expediente, como lo ve su responsable. El token no se vuelve a mostrar. */
+export interface CaseFileShareLinkResponseEntity {
+  id: string;
+  recipient: string;
+  recipientEmail: string | null;
+  purpose: string | null;
+  allowExport: boolean;
+  expiresAt: string;
+  status: CaseFileShareLinkStatus;
+  createdByFullName: string;
+  createdAt: string;
+  revokedAt: string | null;
+  revokedByFullName: string | null;
+  /** Cuántas consultas, descargas y exportaciones se hicieron con él. */
+  accessCount: number;
+  lastAccessAt: string | null;
+}
+
+/** Enlace recién creado: el token va solo aquí; la dirección la arma quien lo muestra. */
+export interface CaseFileShareLinkCreateResponseEntity {
+  id: string;
+  token: string;
+  recipient: string;
+  recipientEmail: string | null;
+  purpose: string | null;
+  expiresAt: string;
+  /** Para avisarle al destinatario: qué expediente, de qué órgano y quién se lo comparte. */
+  caseFile: { code: string; title: string };
+  organName: string;
+  createdByFullName: string;
+}
+
+/** Actuación del índice como la ve el destinatario externo. */
+export interface CaseFileSharedEntryEntity {
+  id: string;
+  sequence: number;
+  folder: string | null;
+  kind: CaseFileEntryEntity['kind'];
+  actuationType: CaseFileEntryEntity['actuationType'];
+  title: string;
+  /** Tipo y número del documento («D.E. N° 590/2026») o el tipo declarado del archivo. */
+  reference: string | null;
+  originDate: string | null;
+  createdAt: string;
+  hasFile: boolean;
+  sha256: string | null;
+  hasAdvancedSignature: boolean;
+  physicalLocation: string | null;
+  pageCount: number | null;
+  voidedAt: string | null;
+  voidReason: string | null;
+}
+
+/** Expediente abierto con un enlace temporal: metadatos e índice, sin participantes ni registros internos. */
+export interface CaseFileSharedResponseEntity {
+  code: string;
+  title: string;
+  subject: string;
+  summary: string | null;
+  procedureName: string;
+  status: CaseFileEntity['status'];
+  organName: string;
+  responsibleFullName: string;
+  responsiblePosition: string | null;
+  createdAt: string;
+  closedAt: string | null;
+  recipient: string;
+  purpose: string | null;
+  expiresAt: string;
+  allowExport: boolean;
+  entries: CaseFileSharedEntryEntity[];
+}

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

@@ -138,6 +138,10 @@ export interface DocumentGetByIdResponseEntity {
   id: DocumentEntity['id'];
   // Quién lo emite: la entidad emisora del tipo (Educación, Salud, Juzgado) o la municipalidad.
   issuerName: string;
+  // Serie documental del Cuadro de Clasificación (la de su tipo documental; MGDDE1_2).
+  archivalSeries: { id: string; code: string; name: string } | null;
+  // Fin de la restricción de acceso: desde entonces se consulta como público si no tiene datos sensibles.
+  restrictionEndsAt: string | null;
   subject: DocumentEntity['subject'];
   keywords: DocumentEntity['keywords'];
   accessLevel: DocumentEntity['accessLevel'];
@@ -199,6 +203,8 @@ export interface DocumentGetByIdResponseEntity {
   /** Instituciones de DocDigital a quienes va dirigido, y su despacho por Oficina de Partes. */
   externalRecipients: DocumentExternalRecipientResponseEntity[];
   dispatch: DocumentDispatchResponseEntity | null;
+  // Copias por correo a quienes están fuera del Estado, con su envío y apertura.
+  emailCopies: DocumentEmailCopyResponseEntity[];
   documentType: DocumentTypeSummaryEntity;
   participants: DocumentParticipantResponseEntity[];
   attachments: {
@@ -450,3 +456,42 @@ export interface DocumentComposeResponseEntity {
   fileId?: string;
   contentBase64?: string;
 }
+
+/** Copia por correo de un documento, como la ve quien lo consulta en el gestor. */
+export interface DocumentEmailCopyResponseEntity {
+  id: string;
+  name: string;
+  email: string;
+  /** Cuándo se envió (sin valor: aún no corresponde). */
+  issuedAt: string | null;
+  expiresAt: string | null;
+  openedAt: string | null;
+  downloadCount: number;
+}
+
+/** Copia recién emitida: el gateway le envía el enlace a su destinatario. El token viaja solo aquí. */
+export interface DocumentEmailCopyIssuedEntity {
+  copyId: string;
+  documentId: string;
+  name: string;
+  email: string;
+  token: string;
+  expiresAt: string;
+  /** Cómo se cita: «D.E. N° 590/2026», o el tipo si no lleva número. */
+  folio: string;
+  subject: string;
+  issuerName: string;
+}
+
+/** El documento como lo ve quien abre su copia por correo. */
+export interface DocumentEmailCopyViewEntity {
+  recipientName: string;
+  expiresAt: string;
+  documentTypeName: string;
+  folio: string;
+  subject: string;
+  issuerName: string;
+  finishedAt: string | null;
+  verificationCode: string | null;
+  signers: { fullName: string; position: string | null; signedAt: string | null }[];
+}

package/src/entities/documentType/documentType.entity.ts

@@ -27,6 +27,8 @@ export interface DocumentTypeGetAllResponseEntity {
   // Sin numeración, sus documentos solo llevan fecha, código de verificación y QR.
   numbered: DocumentTypeEntity['numbered'];
   directorateCodeReference: DocumentTypeEntity['directorateCodeReference'];
+  // Serie documental del Cuadro de Clasificación a la que van sus documentos (MGDDE1_2).
+  archivalSeries: { id: string; code: string; name: string } | null;
   // Entidad que emite sus documentos (Educación, Salud, Juzgado). `null`: la municipalidad.
   issuingEntity: { id: string; name: string; shortName: string | null } | null;
   // Tipo cuyo correlativo comparte: sus números salen de esa serie (y `nextCorrelative`, `correlativeYear` y

package/src/entities/index.ts

@@ -7,3 +7,5 @@ export * from './partsOffice';
 export * from './registerBook';
 export * from './signatureBatch';
 export * from './workFolder';
+export * from './scan';
+export * from './archivalSeries';

package/src/entities/scan/index.ts

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

package/src/entities/scan/scan.entity.ts

@@ -0,0 +1,32 @@
+/** Sesión recién abierta: el token y el QR viajan solo aquí. */
+export interface ScanSessionCreateResponseEntity {
+  id: string;
+  token: string;
+  /** Dirección que abre el celular, con el token. */
+  url: string;
+  /** El QR de esa dirección, como imagen PNG en data URL. */
+  qrDataUrl: string;
+  expiresAt: string;
+}
+
+/** Estado de la sesión, como lo ve en el escritorio quien la abrió. */
+export interface ScanSessionResponseEntity {
+  id: string;
+  status: 'Open' | 'Ready';
+  pageCount: number;
+  expiresAt: string;
+  fileName: string | null;
+}
+
+export interface ScanSessionFileResponseEntity {
+  fileId: string;
+  fileName: string;
+}
+
+/** La sesión como la ve el celular. */
+export interface ScanSessionPublicEntity {
+  status: 'Open' | 'Ready';
+  pageCount: number;
+  maxPages: number;
+  expiresAt: string;
+}