@muni-sanfer/types-gestor-documental 0.0.1-beta.50 → 0.0.1-beta.51

package/dist/base/entities.d.ts

@@ -4,6 +4,11 @@ export declare const DocumentCategory: {
     Communication: "Communication";
     Other: "Other";
 };
+export type DocumentNumberingScope = 'Type' | 'Category';
+export declare const DocumentNumberingScope: {
+    Type: "Type";
+    Category: "Category";
+};
 export type DocumentStatus = 'Drafted' | 'PendingVisa' | 'PendingSignature' | 'Finished' | 'Rejected' | 'Discarded' | 'Annulled';
 export declare const DocumentStatus: {
     Drafted: "Drafted";
@@ -236,7 +241,7 @@ export declare const DocumentAccessAction: {
     FileDownloaded: "FileDownloaded";
     TrailExported: "TrailExported";
 };
-export type AuditEntity = 'DocumentType' | 'IssuingEntity' | 'ArchivalSeries' | 'TextSnippet' | 'Holiday' | 'Procedure' | 'QualityMetric' | 'ServiceOutage' | 'Repository' | 'DataTreatment' | 'DocumentTemplate' | 'DirectorateReviewer';
+export type AuditEntity = 'DocumentType' | 'IssuingEntity' | 'ArchivalSeries' | 'TextSnippet' | 'Holiday' | 'Procedure' | 'QualityMetric' | 'ServiceOutage' | 'Repository' | 'DataTreatment' | 'DocumentTemplate' | 'DirectorateReviewer' | 'CategoryNumbering';
 export declare const AuditEntity: {
     DocumentType: "DocumentType";
     IssuingEntity: "IssuingEntity";
@@ -250,6 +255,7 @@ export declare const AuditEntity: {
     DataTreatment: "DataTreatment";
     DocumentTemplate: "DocumentTemplate";
     DirectorateReviewer: "DirectorateReviewer";
+    CategoryNumbering: "CategoryNumbering";
 };
 export type AuditAction = 'Created' | 'Updated' | 'Enabled' | 'Disabled' | 'Removed' | 'Exported';
 export declare const AuditAction: {
@@ -437,6 +443,8 @@ export interface DocumentTypeEntity {
     correlativeYear?: number | null;
     resetsYearly: boolean;
     numbered: boolean;
+    numberingScope: DocumentNumberingScope;
+    allowsExternalNumber: boolean;
     activeTransparency: boolean;
     transparencySection?: string | null;
     directorateCodeReference?: number | null;
@@ -474,6 +482,8 @@ export interface DocumentEntity {
     correlative?: number | null;
     correlativeYear?: number | null;
     numberedAt?: string | null;
+    externalCorrelative?: number | null;
+    externalCorrelativeYear?: number | null;
     verificationCode?: string | null;
     signatureSheet: boolean;
     annulledAt?: string | null;
@@ -644,6 +654,13 @@ export interface DocumentDeliveryEntity {
     documentId: string;
     createdAt: string;
 }
+export interface CategoryNumberingEntity {
+    category: DocumentCategory;
+    nextCorrelative: number;
+    correlativeYear?: number | null;
+    resetsYearly: boolean;
+    updatedAt: string;
+}
 export interface DocumentTypeVersionEntity {
     id: string;
     version: number;
@@ -652,6 +669,8 @@ export interface DocumentTypeVersionEntity {
     category: DocumentCategory;
     description?: string | null;
     numbered: boolean;
+    numberingScope: DocumentNumberingScope;
+    allowsExternalNumber: boolean;
     activeTransparency: boolean;
     transparencySection?: string | null;
     directorateCodeReference?: number | null;

package/dist/base/entities.js

@@ -1,13 +1,17 @@
 "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.HolidaySource = 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.DraftReviewStatus = exports.DocumentTrackingAction = exports.DocumentParticipantStatus = exports.DocumentParticipantRole = exports.DocumentAccessLevel = exports.DocumentStatus = exports.DocumentCategory = void 0;
-exports.DraftingRequestEventAction = exports.DraftingRequestStatus = exports.MailAuthentication = exports.MailIntakeStatus = exports.DeskFileTarget = exports.DeskFileSource = void 0;
+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.HolidaySource = 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.DraftReviewStatus = exports.DocumentTrackingAction = exports.DocumentParticipantStatus = exports.DocumentParticipantRole = exports.DocumentAccessLevel = exports.DocumentStatus = exports.DocumentNumberingScope = exports.DocumentCategory = void 0;
+exports.DraftingRequestEventAction = exports.DraftingRequestStatus = exports.MailAuthentication = exports.MailIntakeStatus = exports.DeskFileTarget = exports.DeskFileSource = exports.DataBreachNoticeMeans = void 0;
 exports.DocumentCategory = {
     Decree: 'Decree',
     Communication: 'Communication',
     Other: 'Other',
 };
+exports.DocumentNumberingScope = {
+    Type: 'Type',
+    Category: 'Category',
+};
 exports.DocumentStatus = {
     Drafted: 'Drafted',
     PendingVisa: 'PendingVisa',
@@ -223,6 +227,7 @@ exports.AuditEntity = {
     DataTreatment: 'DataTreatment',
     DocumentTemplate: 'DocumentTemplate',
     DirectorateReviewer: 'DirectorateReviewer',
+    CategoryNumbering: 'CategoryNumbering',
 };
 exports.AuditAction = {
     Created: 'Created',

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

@@ -1,5 +1,5 @@
-import { type DocumentCategory, type DocumentParticipantRole, type DocumentTypeEntity } from '../base/entities';
-import { type DocumentTemplateContent, type DocumentTypeCreateResponseEntity, type DocumentTypeGetAllResponseEntity, type DocumentTypeGetByIdResponseEntity, type DocumentTypeUpdateResponseEntity } from '../entities';
+import { type DocumentCategory, type DocumentNumberingScope, type DocumentParticipantRole, type DocumentTypeEntity } from '../base/entities';
+import { type CategoryNumberingResponseEntity, type CategoryNumberingUpdateResponseEntity, type DocumentTemplateContent, type DocumentTypeCreateResponseEntity, type DocumentTypeGetAllResponseEntity, type DocumentTypeGetByIdResponseEntity, type DocumentTypeUpdateResponseEntity } from '../entities';
 import { type RpcPage } from './contract';
 /** Patrones NATS de `documentType`: `<servicio>.<recurso>.<acción>`. */
 export declare const DocumentTypePatterns: {
@@ -8,6 +8,8 @@ export declare const DocumentTypePatterns: {
     readonly create: "gestorDocumental.documentType.create";
     readonly update: "gestorDocumental.documentType.update";
     readonly setEnabled: "gestorDocumental.documentType.setEnabled";
+    readonly getCategoryNumbering: "gestorDocumental.documentType.getCategoryNumbering";
+    readonly updateCategoryNumbering: "gestorDocumental.documentType.updateCategoryNumbering";
 };
 /**
  * Paso del flujo sugerido de un tipo documental: un funcionario en particular, o quien dirija una dirección al
@@ -35,6 +37,8 @@ export interface DocumentTypeWritePayload {
     nextCorrelative?: number;
     resetsYearly?: boolean;
     numbered?: boolean;
+    numberingScope?: DocumentNumberingScope;
+    allowsExternalNumber?: boolean;
     /** Transparencia Activa: sus documentos se publican cada mes, en esta sección del Portal. */
     activeTransparency?: boolean;
     transparencySection?: string | null;
@@ -83,4 +87,16 @@ export interface DocumentTypeContract {
         payload: Pick<DocumentTypeEntity, 'id' | 'enabled'>;
         response: DocumentTypeUpdateResponseEntity;
     };
+    [DocumentTypePatterns.getCategoryNumbering]: {
+        payload: Record<string, never>;
+        response: CategoryNumberingResponseEntity[];
+    };
+    [DocumentTypePatterns.updateCategoryNumbering]: {
+        payload: {
+            category: DocumentCategory;
+            nextCorrelative?: number;
+            resetsYearly?: boolean;
+        };
+        response: CategoryNumberingUpdateResponseEntity;
+    };
 }

package/dist/contracts/documentType.contract.js

@@ -8,4 +8,6 @@ exports.DocumentTypePatterns = {
     create: 'gestorDocumental.documentType.create',
     update: 'gestorDocumental.documentType.update',
     setEnabled: 'gestorDocumental.documentType.setEnabled',
+    getCategoryNumbering: 'gestorDocumental.documentType.getCategoryNumbering',
+    updateCategoryNumbering: 'gestorDocumental.documentType.updateCategoryNumbering',
 };

package/dist/contracts/index.d.ts

@@ -63,6 +63,8 @@ export declare const GestorDocumentalPatterns: {
         readonly create: "gestorDocumental.documentType.create";
         readonly update: "gestorDocumental.documentType.update";
         readonly setEnabled: "gestorDocumental.documentType.setEnabled";
+        readonly getCategoryNumbering: "gestorDocumental.documentType.getCategoryNumbering";
+        readonly updateCategoryNumbering: "gestorDocumental.documentType.updateCategoryNumbering";
     };
     readonly document: {
         readonly getAll: "gestorDocumental.document.getAll";

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

@@ -158,6 +158,8 @@ export interface DocumentGetByIdResponseEntity {
     correlative: DocumentEntity['correlative'];
     correlativeYear: DocumentEntity['correlativeYear'];
     numberedAt: DocumentEntity['numberedAt'];
+    externalCorrelative: DocumentEntity['externalCorrelative'];
+    externalCorrelativeYear: DocumentEntity['externalCorrelativeYear'];
     directorateCodeReference: DocumentEntity['directorateCodeReference'];
     departmentId: DocumentEntity['departmentId'];
     createdByEmployeeId: DocumentEntity['createdByEmployeeId'];

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

@@ -1,4 +1,4 @@
-import { DocumentTypeEntity, DocumentTypeFlowStepEntity } from '../../base/entities';
+import { type DocumentCategory, DocumentTypeEntity, DocumentTypeFlowStepEntity } from '../../base/entities';
 import { type DocumentTemplateContent } from '../documentTemplate/documentTemplate.entity';
 /** Paso del flujo sugerido de un tipo documental: quién visa o firma, en su orden. */
 export interface DocumentTypeFlowStepResponseEntity {
@@ -22,6 +22,8 @@ export interface DocumentTypeGetAllResponseEntity {
     correlativeYear: DocumentTypeEntity['correlativeYear'];
     resetsYearly: DocumentTypeEntity['resetsYearly'];
     numbered: DocumentTypeEntity['numbered'];
+    numberingScope: DocumentTypeEntity['numberingScope'];
+    allowsExternalNumber: DocumentTypeEntity['allowsExternalNumber'];
     /** Transparencia Activa: sus documentos se publican cada mes, en esta sección del Portal. */
     activeTransparency: DocumentTypeEntity['activeTransparency'];
     transparencySection: DocumentTypeEntity['transparencySection'];
@@ -73,6 +75,22 @@ export interface DocumentTypeGetByIdResponseEntity extends DocumentTypeGetAllRes
     template: DocumentTypeTemplateResponseEntity | null;
     versions: DocumentTypeVersionResponseEntity[];
 }
+/** Correlativo de una categoría: una sola serie para los tipos que lo heredan. */
+export interface CategoryNumberingResponseEntity {
+    category: DocumentCategory;
+    nextCorrelative: number;
+    correlativeYear: number | null;
+    resetsYearly: boolean;
+    lastCorrelative: number | null;
+    documentTypes: {
+        id: string;
+        name: string;
+    }[];
+}
+export interface CategoryNumberingUpdateResponseEntity {
+    id: DocumentCategory;
+    ok: boolean;
+}
 export interface DocumentTypeCreateResponseEntity {
     id: DocumentTypeEntity['id'];
     ok: boolean;

package/package.json

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

package/src/base/entities.ts

@@ -8,6 +8,13 @@ export const DocumentCategory = {
   Other: 'Other',
 } satisfies Record<string, DocumentCategory>;
 
+export type DocumentNumberingScope = 'Type' | 'Category';
+
+export const DocumentNumberingScope = {
+  Type: 'Type',
+  Category: 'Category',
+} satisfies Record<string, DocumentNumberingScope>;
+
 export type DocumentStatus =
   'Drafted' | 'PendingVisa' | 'PendingSignature' | 'Finished' | 'Rejected' | 'Discarded' | 'Annulled';
 
@@ -370,7 +377,8 @@ export type AuditEntity =
   | 'Repository'
   | 'DataTreatment'
   | 'DocumentTemplate'
-  | 'DirectorateReviewer';
+  | 'DirectorateReviewer'
+  | 'CategoryNumbering';
 
 export const AuditEntity = {
   DocumentType: 'DocumentType',
@@ -385,6 +393,7 @@ export const AuditEntity = {
   DataTreatment: 'DataTreatment',
   DocumentTemplate: 'DocumentTemplate',
   DirectorateReviewer: 'DirectorateReviewer',
+  CategoryNumbering: 'CategoryNumbering',
 } satisfies Record<string, AuditEntity>;
 
 export type AuditAction = 'Created' | 'Updated' | 'Enabled' | 'Disabled' | 'Removed' | 'Exported';
@@ -643,6 +652,8 @@ export interface DocumentTypeEntity {
   correlativeYear?: number | null;
   resetsYearly: boolean;
   numbered: boolean;
+  numberingScope: DocumentNumberingScope;
+  allowsExternalNumber: boolean;
   activeTransparency: boolean;
   transparencySection?: string | null;
   directorateCodeReference?: number | null;
@@ -681,6 +692,8 @@ export interface DocumentEntity {
   correlative?: number | null;
   correlativeYear?: number | null;
   numberedAt?: string | null;
+  externalCorrelative?: number | null;
+  externalCorrelativeYear?: number | null;
   verificationCode?: string | null;
   signatureSheet: boolean;
   annulledAt?: string | null;
@@ -859,6 +872,14 @@ export interface DocumentDeliveryEntity {
   createdAt: string;
 }
 
+export interface CategoryNumberingEntity {
+  category: DocumentCategory;
+  nextCorrelative: number;
+  correlativeYear?: number | null;
+  resetsYearly: boolean;
+  updatedAt: string;
+}
+
 export interface DocumentTypeVersionEntity {
   id: string;
   version: number;
@@ -867,6 +888,8 @@ export interface DocumentTypeVersionEntity {
   category: DocumentCategory;
   description?: string | null;
   numbered: boolean;
+  numberingScope: DocumentNumberingScope;
+  allowsExternalNumber: boolean;
   activeTransparency: boolean;
   transparencySection?: string | null;
   directorateCodeReference?: number | null;

package/src/contracts/documentType.contract.ts

@@ -1,5 +1,12 @@
-import { type DocumentCategory, type DocumentParticipantRole, type DocumentTypeEntity } from '../base/entities';
 import {
+  type DocumentCategory,
+  type DocumentNumberingScope,
+  type DocumentParticipantRole,
+  type DocumentTypeEntity,
+} from '../base/entities';
+import {
+  type CategoryNumberingResponseEntity,
+  type CategoryNumberingUpdateResponseEntity,
   type DocumentTemplateContent,
   type DocumentTypeCreateResponseEntity,
   type DocumentTypeGetAllResponseEntity,
@@ -15,6 +22,8 @@ export const DocumentTypePatterns = {
   create: 'gestorDocumental.documentType.create',
   update: 'gestorDocumental.documentType.update',
   setEnabled: 'gestorDocumental.documentType.setEnabled',
+  getCategoryNumbering: 'gestorDocumental.documentType.getCategoryNumbering',
+  updateCategoryNumbering: 'gestorDocumental.documentType.updateCategoryNumbering',
 } as const;
 
 /**
@@ -41,6 +50,10 @@ export interface DocumentTypeWritePayload {
   resetsYearly?: boolean;
   // Sus documentos llevan número (por omisión, sí).
   numbered?: boolean;
+  // Serie de sus números: la propia (por omisión) o la de su categoría. No con numeración compartida.
+  numberingScope?: DocumentNumberingScope;
+  // Sus documentos pueden llegar ya numerados (por omisión, no).
+  allowsExternalNumber?: boolean;
   /** Transparencia Activa: sus documentos se publican cada mes, en esta sección del Portal. */
   activeTransparency?: boolean;
   transparencySection?: string | null;
@@ -97,4 +110,13 @@ export interface DocumentTypeContract {
     payload: Pick<DocumentTypeEntity, 'id' | 'enabled'>;
     response: DocumentTypeUpdateResponseEntity;
   };
+  // El correlativo de cada categoría (Decreto, Comunicación, Otro)
+  [DocumentTypePatterns.getCategoryNumbering]: {
+    payload: Record<string, never>;
+    response: CategoryNumberingResponseEntity[];
+  };
+  [DocumentTypePatterns.updateCategoryNumbering]: {
+    payload: { category: DocumentCategory; nextCorrelative?: number; resetsYearly?: boolean };
+    response: CategoryNumberingUpdateResponseEntity;
+  };
 }

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

@@ -178,6 +178,10 @@ export interface DocumentGetByIdResponseEntity {
   correlative: DocumentEntity['correlative'];
   correlativeYear: DocumentEntity['correlativeYear'];
   numberedAt: DocumentEntity['numberedAt'];
+  // Número con que llegó el documento, si ya venía numerado: lo toma con la primera firma (y no se pierde si lo
+  // rechazan).
+  externalCorrelative: DocumentEntity['externalCorrelative'];
+  externalCorrelativeYear: DocumentEntity['externalCorrelativeYear'];
   directorateCodeReference: DocumentEntity['directorateCodeReference'];
   departmentId: DocumentEntity['departmentId'];
   createdByEmployeeId: DocumentEntity['createdByEmployeeId'];

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

@@ -1,4 +1,4 @@
-import { DocumentTypeEntity, DocumentTypeFlowStepEntity } from '../../base/entities';
+import { type DocumentCategory, DocumentTypeEntity, DocumentTypeFlowStepEntity } from '../../base/entities';
 import { type DocumentTemplateContent } from '../documentTemplate/documentTemplate.entity';
 
 /** Paso del flujo sugerido de un tipo documental: quién visa o firma, en su orden. */
@@ -27,6 +27,11 @@ export interface DocumentTypeGetAllResponseEntity {
   resetsYearly: DocumentTypeEntity['resetsYearly'];
   // Sin numeración, sus documentos solo llevan fecha, código de verificación y QR.
   numbered: DocumentTypeEntity['numbered'];
+  // Serie de sus números: la propia (`Type`) o la de su categoría (`Category`). Con `Category`, `nextCorrelative`,
+  // `correlativeYear` y `resetsYearly` son los de la categoría.
+  numberingScope: DocumentTypeEntity['numberingScope'];
+  // Sus documentos pueden llegar ya numerados: quien sube el PDF indica su número.
+  allowsExternalNumber: DocumentTypeEntity['allowsExternalNumber'];
   /** Transparencia Activa: sus documentos se publican cada mes, en esta sección del Portal. */
   activeTransparency: DocumentTypeEntity['activeTransparency'];
   transparencySection: DocumentTypeEntity['transparencySection'];
@@ -81,6 +86,26 @@ export interface DocumentTypeGetByIdResponseEntity extends DocumentTypeGetAllRes
   versions: DocumentTypeVersionResponseEntity[];
 }
 
+/** Correlativo de una categoría: una sola serie para los tipos que lo heredan. */
+export interface CategoryNumberingResponseEntity {
+  category: DocumentCategory;
+  nextCorrelative: number;
+  // Año al que pertenece `nextCorrelative` (sin valor hasta numerar el primer documento).
+  correlativeYear: number | null;
+  resetsYearly: boolean;
+  // Último número usado en la serie en el año vigente (o en toda su historia, si no se reinicia): el próximo no puede
+  // quedar en él ni por debajo.
+  lastCorrelative: number | null;
+  // Tipos que lo heredan.
+  documentTypes: { id: string; name: string }[];
+}
+
+export interface CategoryNumberingUpdateResponseEntity {
+  // La categoría (como id, para la bitácora de configuración).
+  id: DocumentCategory;
+  ok: boolean;
+}
+
 export interface DocumentTypeCreateResponseEntity {
   id: DocumentTypeEntity['id'];
   ok: boolean;