@muni-sanfer/types-gestor-documental 0.0.1-beta.3 → 0.0.1-beta.5

package/dist/entities/procedure/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("./procedure.entity"), exports);

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

@@ -0,0 +1,20 @@
+import { ProcedureEntity } from '../../base/entities';
+export interface ProcedureGetAllResponseEntity {
+    id: ProcedureEntity['id'];
+    name: ProcedureEntity['name'];
+    cpatId: ProcedureEntity['cpatId'];
+    cpatCode: ProcedureEntity['cpatCode'];
+    description: ProcedureEntity['description'];
+    enabled: ProcedureEntity['enabled'];
+    /** Cuántos expedientes pertenecen a este procedimiento. */
+    caseFiles: number;
+}
+export type ProcedureGetByIdResponseEntity = ProcedureGetAllResponseEntity;
+export interface ProcedureCreateResponseEntity {
+    id: ProcedureEntity['id'];
+    ok: boolean;
+}
+export interface ProcedureUpdateResponseEntity {
+    id: ProcedureEntity['id'];
+    ok: boolean;
+}

package/dist/entities/procedure/procedure.entity.js

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

package/package.json

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

package/src/base/entities.ts

@@ -60,7 +60,10 @@ export type DocumentTrackingAction =
   | 'Annulled'
   | 'Delivered'
   | 'Derived'
-  | 'Reassigned';
+  | 'Reassigned'
+  | 'Dispatched'
+  | 'DispatchReturned'
+  | 'Received';
 
 export const DocumentTrackingAction = {
   Created: 'Created',
@@ -77,8 +80,34 @@ export const DocumentTrackingAction = {
   Delivered: 'Delivered',
   Derived: 'Derived',
   Reassigned: 'Reassigned',
+  Dispatched: 'Dispatched',
+  DispatchReturned: 'DispatchReturned',
+  Received: 'Received',
 } satisfies Record<string, DocumentTrackingAction>;
 
+export type DocumentOrigin = 'Internal' | 'DocDigital';
+
+export const DocumentOrigin = {
+  Internal: 'Internal',
+  DocDigital: 'DocDigital',
+} satisfies Record<string, DocumentOrigin>;
+
+export type DocumentDispatchStatus = 'Pending' | 'Dispatched' | 'Returned';
+
+export const DocumentDispatchStatus = {
+  Pending: 'Pending',
+  Dispatched: 'Dispatched',
+  Returned: 'Returned',
+} satisfies Record<string, DocumentDispatchStatus>;
+
+export type DocDigitalInboundStatus = 'Pending' | 'Registered' | 'Returned';
+
+export const DocDigitalInboundStatus = {
+  Pending: 'Pending',
+  Registered: 'Registered',
+  Returned: 'Returned',
+} satisfies Record<string, DocDigitalInboundStatus>;
+
 export type DocumentFlowStepType = 'Employee' | 'DirectorateHead';
 
 export const DocumentFlowStepType = {
@@ -117,6 +146,101 @@ export const DocumentInstruction = {
   Archive: 'Archive',
 } satisfies Record<string, DocumentInstruction>;
 
+export type CaseFileStatus = 'Open' | 'Closed';
+
+export const CaseFileStatus = {
+  Open: 'Open',
+  Closed: 'Closed',
+} satisfies Record<string, CaseFileStatus>;
+
+export type CaseFileIncorporationMechanism =
+  'Manual' | 'WebService' | 'Mixed' | 'CitizenRepository' | 'Interoperability';
+
+export const CaseFileIncorporationMechanism = {
+  Manual: 'Manual',
+  WebService: 'WebService',
+  Mixed: 'Mixed',
+  CitizenRepository: 'CitizenRepository',
+  Interoperability: 'Interoperability',
+} satisfies Record<string, CaseFileIncorporationMechanism>;
+
+export type CaseFileActuationType =
+  | 'AdministrativeAct'
+  | 'Notification'
+  | 'OfficialCommunication'
+  | 'Interoperability'
+  | 'RequestReception'
+  | 'Subfolder'
+  | 'PowerRegistration';
+
+export const CaseFileActuationType = {
+  AdministrativeAct: 'AdministrativeAct',
+  Notification: 'Notification',
+  OfficialCommunication: 'OfficialCommunication',
+  Interoperability: 'Interoperability',
+  RequestReception: 'RequestReception',
+  Subfolder: 'Subfolder',
+  PowerRegistration: 'PowerRegistration',
+} satisfies Record<string, CaseFileActuationType>;
+
+export type CaseFileEntryKind = 'Document' | 'File' | 'CaseFile';
+
+export const CaseFileEntryKind = {
+  Document: 'Document',
+  File: 'File',
+  CaseFile: 'CaseFile',
+} satisfies Record<string, CaseFileEntryKind>;
+
+export type CaseFileActorRelation =
+  'Responsible' | 'Interested' | 'Author' | 'Referred' | 'Recipient' | 'MinisterOfFaith';
+
+export const CaseFileActorRelation = {
+  Responsible: 'Responsible',
+  Interested: 'Interested',
+  Author: 'Author',
+  Referred: 'Referred',
+  Recipient: 'Recipient',
+  MinisterOfFaith: 'MinisterOfFaith',
+} satisfies Record<string, CaseFileActorRelation>;
+
+export type CaseFileActorType = 'Citizen' | 'Foreigner' | 'PrivateInstitution' | 'Official';
+
+export const CaseFileActorType = {
+  Citizen: 'Citizen',
+  Foreigner: 'Foreigner',
+  PrivateInstitution: 'PrivateInstitution',
+  Official: 'Official',
+} satisfies Record<string, CaseFileActorType>;
+
+export type CaseFileTrackingAction =
+  | 'Created'
+  | 'Updated'
+  | 'EntryAdded'
+  | 'EntryVoided'
+  | 'ParticipantAdded'
+  | 'ParticipantRemoved'
+  | 'Closed'
+  | 'Exported';
+
+export const CaseFileTrackingAction = {
+  Created: 'Created',
+  Updated: 'Updated',
+  EntryAdded: 'EntryAdded',
+  EntryVoided: 'EntryVoided',
+  ParticipantAdded: 'ParticipantAdded',
+  ParticipantRemoved: 'ParticipantRemoved',
+  Closed: 'Closed',
+  Exported: 'Exported',
+} satisfies Record<string, CaseFileTrackingAction>;
+
+export type CaseFileAccessAction = 'Viewed' | 'FileDownloaded' | 'Exported';
+
+export const CaseFileAccessAction = {
+  Viewed: 'Viewed',
+  FileDownloaded: 'FileDownloaded',
+  Exported: 'Exported',
+} satisfies Record<string, CaseFileAccessAction>;
+
 export interface DocumentTypeEntity {
   id: string;
   name: string;
@@ -151,6 +275,12 @@ export interface DocumentEntity {
   annulledAt?: string | null;
   annulmentReason?: string | null;
   responseDueAt?: string | null;
+  origin: DocumentOrigin;
+  intakeNumber?: number | null;
+  intakeYear?: number | null;
+  externalFolio?: string | null;
+  externalSender?: string | null;
+  externalDate?: string | null;
   replyTo?: DocumentEntity | null;
   replyToDocumentId?: string | null;
   replies?: DocumentEntity[];
@@ -172,6 +302,10 @@ export interface DocumentEntity {
   annulledNumbers?: DocumentAnnulledNumberEntity[];
   recipients?: DocumentRecipientEntity[];
   deliveries?: DocumentDeliveryEntity[];
+  caseFileEntries?: CaseFileEntryEntity[];
+  externalRecipients?: DocumentExternalRecipientEntity[];
+  dispatch?: DocumentDispatchEntity | null;
+  docDigitalInbound?: DocDigitalInboundEntity | null;
   deleted: boolean;
   createdAt: string;
   updatedAt: string;
@@ -278,3 +412,216 @@ export interface DocumentTypeFlowStepEntity {
   documentTypeId: string;
   createdAt: string;
 }
+
+export interface ProcedureEntity {
+  id: string;
+  name: string;
+  cpatId?: string | null;
+  cpatCode?: string | null;
+  description?: string | null;
+  enabled: boolean;
+  caseFiles?: CaseFileEntity[];
+  deleted: boolean;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface CaseFileSequenceEntity {
+  year: number;
+  next: number;
+}
+
+export interface CaseFileEntity {
+  id: string;
+  code: string;
+  year: number;
+  number: number;
+  title: string;
+  subject: string;
+  summary?: string | null;
+  status: CaseFileStatus;
+  accessLevel: DocumentAccessLevel;
+  hasSensitiveData: boolean;
+  incorporationMechanism: CaseFileIncorporationMechanism;
+  schemaVersion: string;
+  procedure?: ProcedureEntity;
+  procedureId: string;
+  responsibleEmployeeId: string;
+  responsibleFullName: string;
+  responsiblePosition?: string | null;
+  closedAt?: string | null;
+  closedByEmployeeId?: string | null;
+  closedByFullName?: string | null;
+  closingNote?: string | null;
+  participants?: CaseFileParticipantEntity[];
+  actors?: CaseFileActorEntity[];
+  entries?: CaseFileEntryEntity[];
+  linkedFrom?: CaseFileEntryEntity[];
+  trackings?: CaseFileTrackingEntity[];
+  metadataChanges?: CaseFileMetadataChangeEntity[];
+  accesses?: CaseFileAccessEntity[];
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface CaseFileParticipantEntity {
+  id: string;
+  employeeId: string;
+  fullName: string;
+  position?: string | null;
+  addedByEmployeeId: string;
+  addedByFullName: string;
+  caseFile?: CaseFileEntity;
+  caseFileId: string;
+  createdAt: string;
+}
+
+export interface CaseFileActorEntity {
+  id: string;
+  relation: CaseFileActorRelation;
+  actorType: CaseFileActorType;
+  identifier?: string | null;
+  name: string;
+  caseFile?: CaseFileEntity;
+  caseFileId: string;
+  createdAt: string;
+}
+
+export interface CaseFileEntryEntity {
+  id: string;
+  sequence: number;
+  kind: CaseFileEntryKind;
+  actuationType: CaseFileActuationType;
+  title: string;
+  document?: DocumentEntity | null;
+  documentId?: string | null;
+  fileId?: string | null;
+  fileName?: string | null;
+  documentTypeName?: string | null;
+  originDate?: string | null;
+  author?: string | null;
+  keywords: string[];
+  accessLevel?: DocumentAccessLevel | null;
+  hasSensitiveData?: boolean | null;
+  linkedCaseFile?: CaseFileEntity | null;
+  linkedCaseFileId?: string | null;
+  sha256?: string | null;
+  size?: number | null;
+  hasAdvancedSignature: boolean;
+  incorporatedByEmployeeId: string;
+  incorporatedByFullName: string;
+  voidedAt?: string | null;
+  voidedByEmployeeId?: string | null;
+  voidedByFullName?: string | null;
+  voidReason?: string | null;
+  caseFile?: CaseFileEntity;
+  caseFileId: string;
+  createdAt: string;
+}
+
+export interface CaseFileTrackingEntity {
+  id: string;
+  action: CaseFileTrackingAction;
+  observation?: string | null;
+  employeeId?: string | null;
+  employeeFullName?: string | null;
+  caseFile?: CaseFileEntity;
+  caseFileId: string;
+  createdAt: string;
+}
+
+export interface CaseFileMetadataChangeEntity {
+  id: string;
+  field: string;
+  previousValue?: string | null;
+  newValue?: string | null;
+  employeeId: string;
+  employeeFullName: string;
+  caseFile?: CaseFileEntity;
+  caseFileId: string;
+  createdAt: string;
+}
+
+export interface CaseFileAccessEntity {
+  id: string;
+  action: CaseFileAccessAction;
+  entryId?: string | null;
+  employeeId: string;
+  employeeFullName: string;
+  caseFile?: CaseFileEntity;
+  caseFileId: string;
+  createdAt: string;
+}
+
+export interface DocumentExternalRecipientEntity {
+  id: string;
+  entityId: number;
+  entityName: string;
+  userId?: number | null;
+  userName?: string | null;
+  userPosition?: string | null;
+  document?: DocumentEntity;
+  documentId: string;
+  createdAt: string;
+}
+
+export interface DocumentDispatchEntity {
+  id: string;
+  status: DocumentDispatchStatus;
+  folio?: string | null;
+  docDigitalTypeId?: number | null;
+  docDigitalTypeName?: string | null;
+  docDigitalDocumentId?: string | null;
+  docDigitalRequestId?: string | null;
+  dispatchedAt?: string | null;
+  dispatchedByEmployeeId?: string | null;
+  dispatchedByFullName?: string | null;
+  returnedAt?: string | null;
+  returnedByEmployeeId?: string | null;
+  returnedByFullName?: string | null;
+  returnReason?: string | null;
+  document?: DocumentEntity;
+  documentId: string;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface DocDigitalInboundEntity {
+  id: string;
+  docDigitalDocumentId: string;
+  docDigitalRequestId?: string | null;
+  status: DocDigitalInboundStatus;
+  subject: string;
+  description?: string | null;
+  folio?: string | null;
+  folioDate?: string | null;
+  typeName?: string | null;
+  reserved: boolean;
+  senderEntityId?: number | null;
+  senderEntityName?: string | null;
+  senderName?: string | null;
+  senderPosition?: string | null;
+  fileId?: string | null;
+  fileName?: string | null;
+  attachments: JsonValue;
+  registeredAt?: string | null;
+  registeredByEmployeeId?: string | null;
+  registeredByFullName?: string | null;
+  acknowledgedAt?: string | null;
+  acknowledgeError?: string | null;
+  returnedAt?: string | null;
+  returnedByEmployeeId?: string | null;
+  returnedByFullName?: string | null;
+  returnReason?: string | null;
+  document?: DocumentEntity | null;
+  documentId?: string | null;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface IntakeSequenceEntity {
+  year: number;
+  next: number;
+}
+
+type JsonValue = string | number | boolean | { [key in string]?: JsonValue } | Array<JsonValue> | null;

package/src/contracts/caseFile.contract.ts

@@ -0,0 +1,134 @@
+import {
+  type CaseFileActorRelation,
+  type CaseFileActorType,
+  type CaseFileActuationType,
+  type CaseFileEntity,
+  type CaseFileStatus,
+  type DocumentAccessLevel,
+} from '../base/entities';
+import {
+  type CaseFileAddEntryResponseEntity,
+  type CaseFileCreateResponseEntity,
+  type CaseFileEntryFileResponseEntity,
+  type CaseFileExportResponseEntity,
+  type CaseFileGetAllResponseEntity,
+  type CaseFileGetByIdResponseEntity,
+  type CaseFileUpdateResponseEntity,
+} from '../entities';
+import { type RpcPage } from './contract';
+import { type DocumentActor } from './document.contract';
+
+/** Patrones NATS de `caseFile`: `<servicio>.<recurso>.<acción>`. */
+export const CaseFilePatterns = {
+  getAll: 'gestorDocumental.caseFile.getAll',
+  getById: 'gestorDocumental.caseFile.getById',
+  create: 'gestorDocumental.caseFile.create',
+  update: 'gestorDocumental.caseFile.update',
+  addEntry: 'gestorDocumental.caseFile.addEntry',
+  voidEntry: 'gestorDocumental.caseFile.voidEntry',
+  share: 'gestorDocumental.caseFile.share',
+  unshare: 'gestorDocumental.caseFile.unshare',
+  close: 'gestorDocumental.caseFile.close',
+  getEntryFile: 'gestorDocumental.caseFile.getEntryFile',
+  getExport: 'gestorDocumental.caseFile.getExport',
+} as const;
+
+/** Persona u organización relacionada con el expediente (MGDEE54). */
+export interface CaseFileActorInput {
+  relation: CaseFileActorRelation;
+  actorType: CaseFileActorType;
+  identifier?: string | null;
+  name: string;
+}
+
+/** Metadatos del expediente que se ingresan a mano. */
+export interface CaseFileWritePayload {
+  title: string;
+  subject: string;
+  summary?: string | null;
+  procedureId: string;
+  accessLevel: DocumentAccessLevel;
+  hasSensitiveData: boolean;
+  actors?: CaseFileActorInput[];
+}
+
+/** Actuación que se incorpora al índice: un documento del gestor, un archivo subido u otro expediente. */
+export type CaseFileEntryInput =
+  | { kind: 'Document'; actuationType: CaseFileActuationType; documentId: string }
+  | {
+      kind: 'File';
+      actuationType: CaseFileActuationType;
+      fileId: string;
+      fileName: string;
+      title: string;
+      documentTypeName?: string | null;
+      originDate?: string | null;
+      author?: string | null;
+      keywords: string[];
+      accessLevel: DocumentAccessLevel;
+      hasSensitiveData: boolean;
+    }
+  | { kind: 'CaseFile'; actuationType: CaseFileActuationType; linkedCaseFileId: string };
+
+/** Quién hace la operación (de la sesión) y si puede ver todos los expedientes. */
+interface CaseFileActorPayload {
+  actor: DocumentActor;
+  viewAll?: boolean;
+}
+
+/** Ámbito del listado: los expedientes del funcionario (responsable o compartidos con él) o todos. */
+export type CaseFileScope = 'mine' | 'all';
+
+export interface CaseFileContract {
+  [CaseFilePatterns.getAll]: {
+    payload: {
+      pagination?: { page?: number; limit?: number };
+      filters?: { search?: string; status?: CaseFileStatus; procedureId?: string; scope?: CaseFileScope };
+    } & CaseFileActorPayload;
+    response: RpcPage<CaseFileGetAllResponseEntity[]>;
+  };
+  /** Por id o por su identificador (`EXP-2026-00001`), que es el del enlace persistente. Queda en el registro de accesos. */
+  [CaseFilePatterns.getById]: {
+    payload: { id: string } & CaseFileActorPayload;
+    response: CaseFileGetByIdResponseEntity;
+  };
+  [CaseFilePatterns.create]: {
+    payload: CaseFileWritePayload & { actor: DocumentActor };
+    response: CaseFileCreateResponseEntity;
+  };
+  [CaseFilePatterns.update]: {
+    payload: CaseFileWritePayload & Pick<CaseFileEntity, 'id'> & { actor: DocumentActor };
+    response: CaseFileUpdateResponseEntity;
+  };
+  [CaseFilePatterns.addEntry]: {
+    payload: Pick<CaseFileEntity, 'id'> & { entry: CaseFileEntryInput } & CaseFileActorPayload;
+    response: CaseFileAddEntryResponseEntity;
+  };
+  /** Deja una actuación sin efecto, con su motivo. No se elimina del índice. */
+  [CaseFilePatterns.voidEntry]: {
+    payload: Pick<CaseFileEntity, 'id'> & { entryId: string; reason: string; actor: DocumentActor };
+    response: CaseFileUpdateResponseEntity;
+  };
+  [CaseFilePatterns.share]: {
+    payload: Pick<CaseFileEntity, 'id'> & { employeeIds: string[]; actor: DocumentActor };
+    response: CaseFileUpdateResponseEntity;
+  };
+  [CaseFilePatterns.unshare]: {
+    payload: Pick<CaseFileEntity, 'id'> & { participantId: string; actor: DocumentActor };
+    response: CaseFileUpdateResponseEntity;
+  };
+  [CaseFilePatterns.close]: {
+    payload: Pick<CaseFileEntity, 'id'> & { note?: string | null; actor: DocumentActor };
+    response: CaseFileUpdateResponseEntity;
+  };
+  /** Archivo de una actuación del índice. Queda en el registro de accesos. */
+  [CaseFilePatterns.getEntryFile]: {
+    payload: Pick<CaseFileEntity, 'id'> & { entryId: string } & CaseFileActorPayload;
+    response: CaseFileEntryFileResponseEntity;
+  };
+  /** Metadatos y archivos para exportar el expediente completo. Queda en la trazabilidad y en el registro de accesos. */
+  [CaseFilePatterns.getExport]: {
+    payload: Pick<CaseFileEntity, 'id'> & CaseFileActorPayload;
+    response: CaseFileExportResponseEntity;
+  };
+}

package/src/contracts/document.contract.ts

@@ -102,10 +102,18 @@ export interface DocumentWritePayload extends Pick<DocumentEntity, 'subject' | '
   responseDueAt?: string | null;
   // Documento al que este responde.
   replyToDocumentId?: string | null;
+  // Instituciones (y usuarios) de DocDigital a quienes va: al terminar la firma pasa a Oficina de Partes.
+  externalRecipients?: DocumentExternalRecipientInput[];
   action?: 'Submit';
   actor: DocumentActor;
 }
 
+/** Destinatario externo: una institución de DocDigital y, si se indica, uno de sus usuarios. */
+export interface DocumentExternalRecipientInput {
+  entityId: number;
+  userId?: number | null;
+}
+
 /**
  * Qué se envía y qué se responde en cada patrón. Generado desde los handlers y los DTO del microservicio.
  */

package/src/contracts/index.ts

@@ -1,15 +1,28 @@
+import { CaseFilePatterns, type CaseFileContract } from './caseFile.contract';
 import { DocumentPatterns, type DocumentContract } from './document.contract';
 import { DocumentTypePatterns, type DocumentTypeContract } from './documentType.contract';
+import { PartsOfficePatterns, type PartsOfficeContract } from './partsOffice.contract';
+import { ProcedurePatterns, type ProcedureContract } from './procedure.contract';
 
 export * from './contract';
 export * from './document.contract';
 export * from './documentType.contract';
+export * from './procedure.contract';
+export * from './caseFile.contract';
+export * from './partsOffice.contract';
 
 /** Patrones NATS de gestor-documental-ms, por recurso: `gestorDocumental.<recurso>.<acción>`. */
 export const GestorDocumentalPatterns = {
   documentType: DocumentTypePatterns,
   document: DocumentPatterns,
+  procedure: ProcedurePatterns,
+  caseFile: CaseFilePatterns,
+  partsOffice: PartsOfficePatterns,
 } 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 &
+  CaseFileContract &
+  PartsOfficeContract;