@muni-sanfer/types-gestor-documental 0.0.1-beta.29 → 0.0.1-beta.30

package/dist/base/entities.d.ts

@@ -369,6 +369,16 @@ export declare const DataBreachNoticeMeans: {
     Individual: "Individual";
     PublicNotice: "PublicNotice";
 };
+export type DeskFileSource = 'Upload' | 'Scan';
+export declare const DeskFileSource: {
+    Upload: "Upload";
+    Scan: "Scan";
+};
+export type DeskFileTarget = 'Document' | 'CaseFile';
+export declare const DeskFileTarget: {
+    Document: "Document";
+    CaseFile: "CaseFile";
+};
 export interface DocumentTypeEntity {
     id: string;
     name: string;
@@ -1177,6 +1187,23 @@ export interface DataBreachEventEntity {
     breachId: string;
     createdAt: string;
 }
+export interface DeskFileEntity {
+    id: string;
+    ownerEmployeeId: string;
+    fileId: string;
+    fileName: string;
+    size: number;
+    sha256: string;
+    source: DeskFileSource;
+    description?: string | null;
+    classifiedAt?: string | null;
+    target?: DeskFileTarget | null;
+    targetId?: string | null;
+    targetLabel?: string | null;
+    removedAt?: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
 type JsonValue = string | number | boolean | {
     [key in string]?: JsonValue;
 } | Array<JsonValue> | null;

package/dist/base/entities.js

@@ -1,7 +1,7 @@
 "use strict";
 // This file was auto-generated by prisma-generator-typescript-interfaces
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataBreachNoticeMeans = exports.DataBreachEventAction = exports.DataBreachStatus = exports.DataBreachKind = exports.DataRightsEventAction = exports.DataRightsResolution = exports.DataRightsRequestStatus = exports.DataRightsChannel = exports.DataRight = exports.DataLegalBasis = exports.TransparencyStatus = exports.AccessRequestEventAction = exports.AccessRequestResolution = exports.AccessRequestStatus = exports.AccessRequestChannel = exports.DispositionKind = exports.FinalDisposition = exports.AuditAction = exports.AuditEntity = exports.DocumentAccessAction = exports.QualityMetricKey = exports.ServiceOutageKind = exports.WorkFolderItemKind = exports.TextSnippetSection = exports.ScanSessionStatus = exports.CaseFileAccessAction = exports.CaseFileTrackingAction = exports.CaseFileActorType = exports.CaseFileActorRelation = exports.CaseFileEntryKind = exports.CaseFileActuationType = exports.CaseFileIncorporationMechanism = exports.CaseFileStatus = exports.DocumentInstruction = exports.DocumentDeliveryOrigin = exports.DocumentRecipientType = exports.DocumentAttachmentType = exports.DocumentFlowStepType = exports.DocDigitalInboundStatus = exports.DocumentDispatchStatus = exports.CommunicationMeans = exports.DocumentOrigin = exports.DocumentTrackingAction = exports.DocumentParticipantStatus = exports.DocumentParticipantRole = exports.DocumentAccessLevel = exports.DocumentStatus = exports.DocumentCategory = void 0;
+exports.DeskFileTarget = exports.DeskFileSource = exports.DataBreachNoticeMeans = exports.DataBreachEventAction = exports.DataBreachStatus = exports.DataBreachKind = exports.DataRightsEventAction = exports.DataRightsResolution = exports.DataRightsRequestStatus = exports.DataRightsChannel = exports.DataRight = exports.DataLegalBasis = exports.TransparencyStatus = exports.AccessRequestEventAction = exports.AccessRequestResolution = exports.AccessRequestStatus = exports.AccessRequestChannel = exports.DispositionKind = exports.FinalDisposition = exports.AuditAction = exports.AuditEntity = exports.DocumentAccessAction = exports.QualityMetricKey = exports.ServiceOutageKind = exports.WorkFolderItemKind = exports.TextSnippetSection = exports.ScanSessionStatus = exports.CaseFileAccessAction = exports.CaseFileTrackingAction = exports.CaseFileActorType = exports.CaseFileActorRelation = exports.CaseFileEntryKind = exports.CaseFileActuationType = exports.CaseFileIncorporationMechanism = exports.CaseFileStatus = exports.DocumentInstruction = exports.DocumentDeliveryOrigin = exports.DocumentRecipientType = exports.DocumentAttachmentType = exports.DocumentFlowStepType = exports.DocDigitalInboundStatus = exports.DocumentDispatchStatus = exports.CommunicationMeans = exports.DocumentOrigin = exports.DocumentTrackingAction = exports.DocumentParticipantStatus = exports.DocumentParticipantRole = exports.DocumentAccessLevel = exports.DocumentStatus = exports.DocumentCategory = void 0;
 exports.DocumentCategory = {
     Decree: 'Decree',
     Communication: 'Communication',
@@ -325,3 +325,11 @@ exports.DataBreachNoticeMeans = {
     Individual: 'Individual',
     PublicNotice: 'PublicNotice',
 };
+exports.DeskFileSource = {
+    Upload: 'Upload',
+    Scan: 'Scan',
+};
+exports.DeskFileTarget = {
+    Document: 'Document',
+    CaseFile: 'CaseFile',
+};

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

@@ -0,0 +1,86 @@
+import { type CaseFileActuationType, type DeskFileSource, type DocumentAccessLevel } from '../base/entities';
+import { type CaseFileAddEntryResponseEntity, type DeskFileResponseEntity, type DeskOkResponseEntity, type DeskSummaryEntity, type DocumentPublicFileResponseEntity } from '../entities';
+import { type DocumentActor } from './document.contract';
+/** Patrones NATS de `desk`: el escritorio de documentos de cada funcionario («Sin clasificar»). */
+export declare const DeskPatterns: {
+    readonly getFiles: "gestorDocumental.desk.getFiles";
+    readonly getSummary: "gestorDocumental.desk.getSummary";
+    readonly addFiles: "gestorDocumental.desk.addFiles";
+    readonly getFile: "gestorDocumental.desk.getFile";
+    readonly remove: "gestorDocumental.desk.remove";
+    readonly classify: "gestorDocumental.desk.classify";
+    readonly moveToCaseFile: "gestorDocumental.desk.moveToCaseFile";
+};
+export interface DeskContract {
+    /** Los archivos sin clasificar de quien tiene la sesión, del más reciente al más antiguo. */
+    [DeskPatterns.getFiles]: {
+        payload: {
+            actor: DocumentActor;
+        };
+        response: DeskFileResponseEntity[];
+    };
+    [DeskPatterns.getSummary]: {
+        payload: {
+            actor: DocumentActor;
+        };
+        response: DeskSummaryEntity;
+    };
+    /** Archivos ya subidos a la carpeta del gestor (por el gateway), que quedan en el escritorio. */
+    [DeskPatterns.addFiles]: {
+        payload: {
+            files: {
+                fileId: string;
+                fileName: string;
+            }[];
+            source?: DeskFileSource;
+            description?: string | null;
+            actor: DocumentActor;
+        };
+        response: DeskFileResponseEntity[];
+    };
+    /** El archivo, solo para su dueño. */
+    [DeskPatterns.getFile]: {
+        payload: {
+            id: string;
+            actor: DocumentActor;
+        };
+        response: DocumentPublicFileResponseEntity;
+    };
+    /** Lo quita del escritorio. El archivo no se borra. */
+    [DeskPatterns.remove]: {
+        payload: {
+            id: string;
+            actor: DocumentActor;
+        };
+        response: DeskOkResponseEntity;
+    };
+    /** Se redactó o firmó un documento con este archivo: deja el escritorio. El documento tiene que ser de su dueño. */
+    [DeskPatterns.classify]: {
+        payload: {
+            id: string;
+            documentId: string;
+            actor: DocumentActor;
+        };
+        response: DeskOkResponseEntity;
+    };
+    /** Lo incorpora como actuación a un expediente abierto en que puede incorporar, con sus metadatos. */
+    [DeskPatterns.moveToCaseFile]: {
+        payload: {
+            id: string;
+            caseFileId: string;
+            entry: {
+                actuationType: CaseFileActuationType;
+                title: string;
+                documentTypeName?: string | null;
+                originDate?: string | null;
+                author?: string | null;
+                keywords: string[];
+                accessLevel: DocumentAccessLevel;
+                hasSensitiveData: boolean;
+            };
+            folder?: string | null;
+            actor: DocumentActor;
+        };
+        response: CaseFileAddEntryResponseEntity;
+    };
+}

package/dist/contracts/desk.contract.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeskPatterns = void 0;
+/** Patrones NATS de `desk`: el escritorio de documentos de cada funcionario («Sin clasificar»). */
+exports.DeskPatterns = {
+    getFiles: 'gestorDocumental.desk.getFiles',
+    getSummary: 'gestorDocumental.desk.getSummary',
+    addFiles: 'gestorDocumental.desk.addFiles',
+    getFile: 'gestorDocumental.desk.getFile',
+    remove: 'gestorDocumental.desk.remove',
+    classify: 'gestorDocumental.desk.classify',
+    moveToCaseFile: 'gestorDocumental.desk.moveToCaseFile',
+};

package/dist/contracts/index.d.ts

@@ -13,6 +13,7 @@ import { type RetentionContract } from './retention.contract';
 import { type AccessRequestContract } from './accessRequest.contract';
 import { type TransparencyContract } from './transparency.contract';
 import { type DataProtectionContract } from './dataProtection.contract';
+import { type DeskContract } from './desk.contract';
 import { type ScanContract } from './scan.contract';
 import { type PartsOfficeContract } from './partsOffice.contract';
 import { type ProcedureContract } from './procedure.contract';
@@ -41,6 +42,7 @@ export * from './retention.contract';
 export * from './accessRequest.contract';
 export * from './transparency.contract';
 export * from './dataProtection.contract';
+export * from './desk.contract';
 /** Patrones NATS de gestor-documental-ms, por recurso: `gestorDocumental.<recurso>.<acción>`. */
 export declare const GestorDocumentalPatterns: {
     readonly documentType: {
@@ -251,6 +253,15 @@ export declare const GestorDocumentalPatterns: {
         readonly actOnBreach: "gestorDocumental.dataProtection.actOnBreach";
         readonly getBreachPdf: "gestorDocumental.dataProtection.getBreachPdf";
     };
+    readonly desk: {
+        readonly getFiles: "gestorDocumental.desk.getFiles";
+        readonly getSummary: "gestorDocumental.desk.getSummary";
+        readonly addFiles: "gestorDocumental.desk.addFiles";
+        readonly getFile: "gestorDocumental.desk.getFile";
+        readonly remove: "gestorDocumental.desk.remove";
+        readonly classify: "gestorDocumental.desk.classify";
+        readonly moveToCaseFile: "gestorDocumental.desk.moveToCaseFile";
+    };
 };
 /** Contrato completo de gestor-documental-ms: la unión de los contratos de sus recursos. */
-export type GestorDocumentalContract = DocumentTypeContract & DocumentContract & ProcedureContract & IssuingEntityContract & CaseFileContract & PartsOfficeContract & RegisterBookContract & SignatureBatchContract & WorkFolderContract & ScanContract & ArchivalSeriesContract & TextSnippetContract & HolidayContract & IndicatorsContract & AuditContract & SignatureCheckContract & RepositoryExportContract & RetentionContract & AccessRequestContract & TransparencyContract & DataProtectionContract;
+export type GestorDocumentalContract = DocumentTypeContract & DocumentContract & ProcedureContract & IssuingEntityContract & CaseFileContract & PartsOfficeContract & RegisterBookContract & SignatureBatchContract & WorkFolderContract & ScanContract & ArchivalSeriesContract & TextSnippetContract & HolidayContract & IndicatorsContract & AuditContract & SignatureCheckContract & RepositoryExportContract & RetentionContract & AccessRequestContract & TransparencyContract & DataProtectionContract & DeskContract;

package/dist/contracts/index.js

@@ -30,6 +30,7 @@ const retention_contract_1 = require("./retention.contract");
 const accessRequest_contract_1 = require("./accessRequest.contract");
 const transparency_contract_1 = require("./transparency.contract");
 const dataProtection_contract_1 = require("./dataProtection.contract");
+const desk_contract_1 = require("./desk.contract");
 const scan_contract_1 = require("./scan.contract");
 const partsOffice_contract_1 = require("./partsOffice.contract");
 const procedure_contract_1 = require("./procedure.contract");
@@ -58,6 +59,7 @@ __exportStar(require("./retention.contract"), exports);
 __exportStar(require("./accessRequest.contract"), exports);
 __exportStar(require("./transparency.contract"), exports);
 __exportStar(require("./dataProtection.contract"), exports);
+__exportStar(require("./desk.contract"), exports);
 /** Patrones NATS de gestor-documental-ms, por recurso: `gestorDocumental.<recurso>.<acción>`. */
 exports.GestorDocumentalPatterns = {
     documentType: documentType_contract_1.DocumentTypePatterns,
@@ -81,4 +83,5 @@ exports.GestorDocumentalPatterns = {
     accessRequest: accessRequest_contract_1.AccessRequestPatterns,
     transparency: transparency_contract_1.TransparencyPatterns,
     dataProtection: dataProtection_contract_1.DataProtectionPatterns,
+    desk: desk_contract_1.DeskPatterns,
 };

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

@@ -0,0 +1,21 @@
+import { type DeskFileSource } from '../../base/entities';
+/** Archivo suelto del escritorio de un funcionario («Sin clasificar»). */
+export interface DeskFileResponseEntity {
+    id: string;
+    fileName: string;
+    size: number;
+    sha256: string;
+    source: DeskFileSource;
+    description: string | null;
+    /** Es un PDF: se puede redactar una comunicación con él o firmarlo como documento suelto. */
+    isPdf: boolean;
+    createdAt: string;
+}
+export interface DeskSummaryEntity {
+    /** Archivos del escritorio aún sin clasificar. */
+    unclassified: number;
+}
+export interface DeskOkResponseEntity {
+    id: string;
+    ok: boolean;
+}

package/dist/entities/desk/desk.entity.js

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

package/dist/entities/desk/index.d.ts

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

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

package/dist/entities/index.d.ts

@@ -19,3 +19,4 @@ export * from './retention';
 export * from './accessRequest';
 export * from './transparency';
 export * from './dataProtection';
+export * from './desk';

package/dist/entities/index.js

@@ -35,3 +35,4 @@ __exportStar(require("./retention"), exports);
 __exportStar(require("./accessRequest"), exports);
 __exportStar(require("./transparency"), exports);
 __exportStar(require("./dataProtection"), exports);
+__exportStar(require("./desk"), exports);

package/package.json

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

package/src/base/entities.ts

@@ -552,6 +552,20 @@ export const DataBreachNoticeMeans = {
   PublicNotice: 'PublicNotice',
 } satisfies Record<string, DataBreachNoticeMeans>;
 
+export type DeskFileSource = 'Upload' | 'Scan';
+
+export const DeskFileSource = {
+  Upload: 'Upload',
+  Scan: 'Scan',
+} satisfies Record<string, DeskFileSource>;
+
+export type DeskFileTarget = 'Document' | 'CaseFile';
+
+export const DeskFileTarget = {
+  Document: 'Document',
+  CaseFile: 'CaseFile',
+} satisfies Record<string, DeskFileTarget>;
+
 export interface DocumentTypeEntity {
   id: string;
   name: string;
@@ -1407,4 +1421,22 @@ export interface DataBreachEventEntity {
   createdAt: string;
 }
 
+export interface DeskFileEntity {
+  id: string;
+  ownerEmployeeId: string;
+  fileId: string;
+  fileName: string;
+  size: number;
+  sha256: string;
+  source: DeskFileSource;
+  description?: string | null;
+  classifiedAt?: string | null;
+  target?: DeskFileTarget | null;
+  targetId?: string | null;
+  targetLabel?: string | null;
+  removedAt?: string | null;
+  createdAt: string;
+  updatedAt: string;
+}
+
 type JsonValue = string | number | boolean | { [key in string]?: JsonValue } | Array<JsonValue> | null;

package/src/contracts/desk.contract.ts

@@ -0,0 +1,68 @@
+import { type CaseFileActuationType, type DeskFileSource, type DocumentAccessLevel } from '../base/entities';
+import {
+  type CaseFileAddEntryResponseEntity,
+  type DeskFileResponseEntity,
+  type DeskOkResponseEntity,
+  type DeskSummaryEntity,
+  type DocumentPublicFileResponseEntity,
+} from '../entities';
+import { type DocumentActor } from './document.contract';
+
+/** Patrones NATS de `desk`: el escritorio de documentos de cada funcionario («Sin clasificar»). */
+export const DeskPatterns = {
+  getFiles: 'gestorDocumental.desk.getFiles',
+  getSummary: 'gestorDocumental.desk.getSummary',
+  addFiles: 'gestorDocumental.desk.addFiles',
+  getFile: 'gestorDocumental.desk.getFile',
+  remove: 'gestorDocumental.desk.remove',
+  classify: 'gestorDocumental.desk.classify',
+  moveToCaseFile: 'gestorDocumental.desk.moveToCaseFile',
+} as const;
+
+export interface DeskContract {
+  /** Los archivos sin clasificar de quien tiene la sesión, del más reciente al más antiguo. */
+  [DeskPatterns.getFiles]: { payload: { actor: DocumentActor }; response: DeskFileResponseEntity[] };
+  [DeskPatterns.getSummary]: { payload: { actor: DocumentActor }; response: DeskSummaryEntity };
+  /** Archivos ya subidos a la carpeta del gestor (por el gateway), que quedan en el escritorio. */
+  [DeskPatterns.addFiles]: {
+    payload: {
+      files: { fileId: string; fileName: string }[];
+      source?: DeskFileSource;
+      description?: string | null;
+      actor: DocumentActor;
+    };
+    response: DeskFileResponseEntity[];
+  };
+  /** El archivo, solo para su dueño. */
+  [DeskPatterns.getFile]: {
+    payload: { id: string; actor: DocumentActor };
+    response: DocumentPublicFileResponseEntity;
+  };
+  /** Lo quita del escritorio. El archivo no se borra. */
+  [DeskPatterns.remove]: { payload: { id: string; actor: DocumentActor }; response: DeskOkResponseEntity };
+  /** Se redactó o firmó un documento con este archivo: deja el escritorio. El documento tiene que ser de su dueño. */
+  [DeskPatterns.classify]: {
+    payload: { id: string; documentId: string; actor: DocumentActor };
+    response: DeskOkResponseEntity;
+  };
+  /** Lo incorpora como actuación a un expediente abierto en que puede incorporar, con sus metadatos. */
+  [DeskPatterns.moveToCaseFile]: {
+    payload: {
+      id: string;
+      caseFileId: string;
+      entry: {
+        actuationType: CaseFileActuationType;
+        title: string;
+        documentTypeName?: string | null;
+        originDate?: string | null;
+        author?: string | null;
+        keywords: string[];
+        accessLevel: DocumentAccessLevel;
+        hasSensitiveData: boolean;
+      };
+      folder?: string | null;
+      actor: DocumentActor;
+    };
+    response: CaseFileAddEntryResponseEntity;
+  };
+}

package/src/contracts/index.ts

@@ -13,6 +13,7 @@ import { RetentionPatterns, type RetentionContract } from './retention.contract'
 import { AccessRequestPatterns, type AccessRequestContract } from './accessRequest.contract';
 import { TransparencyPatterns, type TransparencyContract } from './transparency.contract';
 import { DataProtectionPatterns, type DataProtectionContract } from './dataProtection.contract';
+import { DeskPatterns, type DeskContract } from './desk.contract';
 import { ScanPatterns, type ScanContract } from './scan.contract';
 import { PartsOfficePatterns, type PartsOfficeContract } from './partsOffice.contract';
 import { ProcedurePatterns, type ProcedureContract } from './procedure.contract';
@@ -42,6 +43,7 @@ export * from './retention.contract';
 export * from './accessRequest.contract';
 export * from './transparency.contract';
 export * from './dataProtection.contract';
+export * from './desk.contract';
 
 /** Patrones NATS de gestor-documental-ms, por recurso: `gestorDocumental.<recurso>.<acción>`. */
 export const GestorDocumentalPatterns = {
@@ -66,6 +68,7 @@ export const GestorDocumentalPatterns = {
   accessRequest: AccessRequestPatterns,
   transparency: TransparencyPatterns,
   dataProtection: DataProtectionPatterns,
+  desk: DeskPatterns,
 } as const;
 
 /** Contrato completo de gestor-documental-ms: la unión de los contratos de sus recursos. */
@@ -89,4 +92,5 @@ export type GestorDocumentalContract = DocumentTypeContract &
   RetentionContract &
   AccessRequestContract &
   TransparencyContract &
-  DataProtectionContract;
+  DataProtectionContract &
+  DeskContract;

package/src/entities/desk/desk.entity.ts

@@ -0,0 +1,24 @@
+import { type DeskFileSource } from '../../base/entities';
+
+/** Archivo suelto del escritorio de un funcionario («Sin clasificar»). */
+export interface DeskFileResponseEntity {
+  id: string;
+  fileName: string;
+  size: number;
+  sha256: string;
+  source: DeskFileSource;
+  description: string | null;
+  /** Es un PDF: se puede redactar una comunicación con él o firmarlo como documento suelto. */
+  isPdf: boolean;
+  createdAt: string;
+}
+
+export interface DeskSummaryEntity {
+  /** Archivos del escritorio aún sin clasificar. */
+  unclassified: number;
+}
+
+export interface DeskOkResponseEntity {
+  id: string;
+  ok: boolean;
+}

package/src/entities/desk/index.ts

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

package/src/entities/index.ts

@@ -19,3 +19,4 @@ export * from './retention';
 export * from './accessRequest';
 export * from './transparency';
 export * from './dataProtection';
+export * from './desk';