@muni-sanfer/types-pre-obligado 0.0.11 → 0.0.12

package/src/contracts/budgetAvailabilityPurchaseRequest.contract.ts

@@ -0,0 +1,154 @@
+import { type RpcListFilter, type RpcPage } from './contract';
+
+/** Patrones NATS de `budgetAvailabilityPurchaseRequest`: `<servicio>.<recurso>.<acción>`. */
+export const BudgetAvailabilityPurchaseRequestPatterns = {
+  getAll: 'preObligado.budgetAvailabilityPurchaseRequest.getAll',
+  getById: 'preObligado.budgetAvailabilityPurchaseRequest.getById',
+  generate: 'preObligado.budgetAvailabilityPurchaseRequest.generate',
+  discardByPurchaseRequest: 'preObligado.budgetAvailabilityPurchaseRequest.discardByPurchaseRequest',
+  reject: 'preObligado.budgetAvailabilityPurchaseRequest.reject',
+} as const;
+
+/**
+ * Qué se envía y qué se responde en cada patrón. Generado desde los handlers y los DTO del microservicio.
+ */
+export interface BudgetAvailabilityPurchaseRequestContract {
+  [BudgetAvailabilityPurchaseRequestPatterns.getAll]: {
+    payload: RpcListFilter;
+    response: RpcPage<
+      ({
+        id: string;
+        correlative: number;
+        date: string;
+        concept: string;
+        totalAmount: number;
+        priority?: { id: string; level: string; days?: number | null } | null;
+        directorate?: { Codigo_Direccion?: number | null; DESCRIPCION?: string | null } | null;
+        department?: { id?: string | null; name?: string | null } | null;
+        currentPurchaseRequestTracking?: {
+          id: string;
+          status: string;
+          observation?: string | null;
+          createdAt?: string | null;
+        } | null;
+        accountCodes: string[];
+      } & {
+        budgetAvailabilities: {
+          id: string;
+          correlative: number;
+          year: number;
+          date: string;
+          accountCodeReference: string | null;
+          signatureCompletedAt: string | null;
+        }[];
+        requiredBudgetAvailabilities: number;
+        issuedBudgetAvailabilities: number;
+      })[]
+    > & {
+      extraData: {
+        purchaseRequests: number;
+        pendingIssuance: number;
+        fullyIssued: number;
+        requiredBudgetAvailabilities: number;
+        issuedBudgetAvailabilities: number;
+        pendingBudgetAvailabilities: number;
+        budgetAvailabilitiesInSignature: number;
+        totalAmount: number;
+        pendingAmount: number;
+        returned: number;
+        averageWaitingDays: number;
+        maxWaitingDays: number;
+      };
+    };
+  };
+  [BudgetAvailabilityPurchaseRequestPatterns.getById]: {
+    payload: { id: string };
+    response: {
+      purchaseRequest: {
+        id: string;
+        correlative: number;
+        date: string;
+        concept: string;
+        justification?: string | null;
+        directorateCodeReference?: number | null;
+        departmentId?: string | null;
+        directorate?: { Codigo_Direccion?: number | null; DESCRIPCION?: string | null } | null;
+        department?: { id?: string | null; name?: string | null } | null;
+        purchaseRequestDetails: {
+          id: string;
+          quantity: number;
+          detail: string;
+          unitAmount: number;
+          totalAmount: number;
+          costCenter?: { Codigo_Centro_Costo: number; Descripcion?: string | null } | null;
+          account?: { CodigoCuenta: string; Descripcion?: string | null } | null;
+          measureUnit?: { id: string; name?: string | null } | null;
+        }[];
+        currentPurchaseRequestTracking?:
+          | ({ id: string; status: string; observation?: string | null; createdAt?: string | null } & {
+              step?: { id: string; order: number } | null;
+            })
+          | null;
+        signedPurchaseRequest?: { id: string; fileId?: string | null; fileUrl?: string | null } | null;
+      };
+      prefill: {
+        year: number;
+        concept: string;
+        originDocumentId: string;
+        originDocumentFolio: string;
+        originDocumentDate: string;
+        directorateCode: number | null;
+        departmentId: string | null;
+      };
+      accounts: {
+        accountCodeReference: string;
+        accountName: string | null;
+        totalAmount: number;
+        budgetAvailabilityDetail: {
+          costCenterCodeReference: number;
+          accountCodeReference: string;
+          requestedAmount: number;
+        }[];
+        budgetAvailability: {
+          id: string;
+          correlative: number;
+          year: number;
+          date: string;
+          accountCodeReference: string | null;
+          signatureCompletedAt: string | null;
+        } | null;
+      }[];
+      requiredBudgetAvailabilities: number;
+      issuedBudgetAvailabilities: number;
+    };
+  };
+  [BudgetAvailabilityPurchaseRequestPatterns.generate]: {
+    payload: {
+      purchaseRequestId: string;
+      date: string | Date;
+      year: number;
+      originDocumentFolio: string;
+      originDocumentDate?: string | Date | null;
+      concept: string;
+      observations?: string | null;
+      directorateCode?: number | null;
+      departmentId?: string | null;
+      employeeId?: string | null;
+    };
+    response: { ids: string[]; ok: boolean; generated: number };
+  };
+  [BudgetAvailabilityPurchaseRequestPatterns.discardByPurchaseRequest]: {
+    payload: { purchaseRequestId: string };
+    response: { discarded: number; ok: boolean };
+  };
+  [BudgetAvailabilityPurchaseRequestPatterns.reject]: {
+    payload: {
+      purchaseRequestId: string;
+      observation: string;
+      directorateCode?: number | null;
+      departmentId?: string | null;
+      employeeId?: string | null;
+    };
+    response: { id: string; ok: boolean };
+  };
+}

package/src/contracts/budgetAvailabilitySignature.contract.ts

@@ -0,0 +1,126 @@
+import {
+  type BudgetAvailabilitySignatureStatus,
+  type BudgetAvailabilitySignatureType,
+  type BudgetAvailabilityStatus,
+  type BudgetAvailabilityStepAccess,
+  type BudgetAvailabilityStepAction,
+} from '../base/entities';
+import { type RpcPage } from './contract';
+
+/** Patrones NATS de `budgetAvailabilitySignature`: `<servicio>.<recurso>.<acción>`. */
+export const BudgetAvailabilitySignaturePatterns = {
+  getAllPending: 'preObligado.budgetAvailabilitySignature.getAllPending',
+  getFlow: 'preObligado.budgetAvailabilitySignature.getFlow',
+  resolve: 'preObligado.budgetAvailabilitySignature.resolve',
+} as const;
+
+/**
+ * Qué se envía y qué se responde en cada patrón. Generado desde los handlers y los DTO del microservicio.
+ */
+export interface BudgetAvailabilitySignatureContract {
+  [BudgetAvailabilitySignaturePatterns.getAllPending]: {
+    payload: Partial<{
+      page: number;
+      limit: number;
+      search?: string;
+      year?: number | null;
+      directorateCodes: number[];
+      departmentIds: string[];
+      employeeId?: string | null;
+      bucket?: 'pending' | 'onHold' | 'rejected' | 'signed' | 'completed' | 'all';
+    }>;
+    response: RpcPage<
+      {
+        id: string;
+        correlative: number;
+        year: number;
+        date: string;
+        concept: string;
+        totalAmount: number;
+        signedFileUrl?: string | null;
+        currentStep: {
+          id: string;
+          order: number;
+          status: BudgetAvailabilitySignatureStatus;
+          type: BudgetAvailabilitySignatureType;
+          title: string;
+          actions: BudgetAvailabilityStepAction[];
+          areaName?: string | null;
+          assignedToMe: boolean;
+          resolvedByMe: boolean;
+        } | null;
+        totalSteps: number;
+        resolvedSteps: number;
+        signedFileId?: string | null;
+        status?: BudgetAvailabilityStatus;
+        signatureCompletedAt?: string | null;
+        resolvedStep?: {
+          id: string;
+          order: number;
+          status: BudgetAvailabilitySignatureStatus;
+          type: BudgetAvailabilitySignatureType;
+          title: string;
+          observation?: string | null;
+          resolvedAt?: string | null;
+        } | null;
+      }[]
+    > & {
+      extraData: {
+        budgetAvailabilities: number;
+        pending: number;
+        onHold: number;
+        rejected: number;
+        pendingSignatures: number;
+        pendingVisas: number;
+        pendingApprovals: number;
+        resolvedByEmployee: number;
+        completed: number;
+        averageWaitingDays: number;
+        maxWaitingDays: number;
+      };
+    };
+  };
+  [BudgetAvailabilitySignaturePatterns.getFlow]: {
+    payload: { id: string; directorateCodes?: number[]; departmentIds?: string[] };
+    response: {
+      budgetAvailabilityId: string;
+      signedFileId?: string | null;
+      signedFileUrl?: string | null;
+      signatureCompletedAt?: string | null;
+      steps: {
+        id: string;
+        order: number;
+        status: BudgetAvailabilitySignatureStatus;
+        observation?: string | null;
+        resolvedAt?: string | null;
+        employeeId?: string | null;
+        employeeFullName?: string | null;
+        type: BudgetAvailabilitySignatureType;
+        title: string;
+        subTitle?: string | null;
+        description?: string | null;
+        access: BudgetAvailabilityStepAccess;
+        actions: BudgetAvailabilityStepAction[];
+        directorateCode?: number | null;
+        departmentId?: string | null;
+        areaName?: string | null;
+        isCurrent: boolean;
+        assignedToMe: boolean;
+      }[];
+    };
+  };
+  [BudgetAvailabilitySignaturePatterns.resolve]: {
+    payload: {
+      id: string;
+      action: BudgetAvailabilityStepAction;
+      observation?: string | null;
+      employeeId?: string | null;
+      directorateCode?: number | null;
+      departmentId?: string | null;
+      directorateCodes?: number[];
+      departmentIds?: string[];
+      signer: { rut: string; fullName: string; role: string; areaName: string };
+    };
+    response: { id: string; ok: boolean; completed: boolean };
+  };
+}

package/src/contracts/budgetAvailabilityTemplate.contract.ts

@@ -0,0 +1,67 @@
+import {
+  type BudgetAvailabilityTemplateEntity,
+  type BudgetAvailabilityTemplateSignatureEntity,
+} from '../base/entities';
+import {
+  type BudgetAvailabilityTemplateCreateResponseEntity,
+  type BudgetAvailabilityTemplateDeleteResponseEntity,
+  type BudgetAvailabilityTemplateGetAllResponseEntity,
+  type BudgetAvailabilityTemplateGetByIdResponseEntity,
+  type BudgetAvailabilityTemplateGetByYearResponseEntity,
+  type BudgetAvailabilityTemplateUpdateResponseEntity,
+} from '../entities';
+import { type RpcListFilter, type RpcPage } from './contract';
+
+/** Patrones NATS de `budgetAvailabilityTemplate`: `<servicio>.<recurso>.<acción>`. */
+export const BudgetAvailabilityTemplatePatterns = {
+  getAll: 'preObligado.budgetAvailabilityTemplate.getAll',
+  getById: 'preObligado.budgetAvailabilityTemplate.getById',
+  getByYear: 'preObligado.budgetAvailabilityTemplate.getByYear',
+  getActive: 'preObligado.budgetAvailabilityTemplate.getActive',
+  create: 'preObligado.budgetAvailabilityTemplate.create',
+  update: 'preObligado.budgetAvailabilityTemplate.update',
+  delete: 'preObligado.budgetAvailabilityTemplate.delete',
+} as const;
+
+/**
+ * Qué se envía y qué se responde en cada patrón. Generado desde los handlers y los DTO del microservicio.
+ */
+export interface BudgetAvailabilityTemplateContract {
+  [BudgetAvailabilityTemplatePatterns.getAll]: {
+    payload: RpcListFilter;
+    response: RpcPage<BudgetAvailabilityTemplateGetAllResponseEntity[]>;
+  };
+  [BudgetAvailabilityTemplatePatterns.getById]: {
+    payload: Pick<BudgetAvailabilityTemplateEntity, 'id'>;
+    response: BudgetAvailabilityTemplateGetByIdResponseEntity;
+  };
+  [BudgetAvailabilityTemplatePatterns.getByYear]: {
+    payload: Pick<BudgetAvailabilityTemplateEntity, 'year'>;
+    response: BudgetAvailabilityTemplateGetByYearResponseEntity;
+  };
+  [BudgetAvailabilityTemplatePatterns.getActive]: {
+    // no recibe datos
+    payload: Record<string, never>;
+    response: BudgetAvailabilityTemplateGetByIdResponseEntity;
+  };
+  [BudgetAvailabilityTemplatePatterns.create]: {
+    payload: Omit<BudgetAvailabilityTemplateEntity, 'id'> & {
+      budgetAvailabilityTemplateSignature: Omit<
+        BudgetAvailabilityTemplateSignatureEntity,
+        'id' | 'deleted' | 'budgetAvailabilityTemplateId' | 'createdAt' | 'updatedAt'
+      >[];
+    };
+    response: BudgetAvailabilityTemplateCreateResponseEntity;
+  };
+  [BudgetAvailabilityTemplatePatterns.update]: {
+    payload: Omit<BudgetAvailabilityTemplateEntity, 'id'> & {
+      id: BudgetAvailabilityTemplateEntity['id'];
+      budgetAvailabilityTemplateSignature?: Array<BudgetAvailabilityTemplateSignatureEntity> | null;
+    };
+    response: BudgetAvailabilityTemplateUpdateResponseEntity;
+  };
+  [BudgetAvailabilityTemplatePatterns.delete]: {
+    payload: Pick<BudgetAvailabilityTemplateEntity, 'id'>;
+    response: BudgetAvailabilityTemplateDeleteResponseEntity;
+  };
+}

package/src/contracts/contract.ts

@@ -0,0 +1,35 @@
+/**
+ * Contrato de mensajes NATS de un servicio: por cada patrón, qué se envía (`payload`) y qué se responde (`response`).
+ * Lo comparten quien atiende el mensaje (el microservicio) y quien lo envía (el gateway u otro microservicio), para
+ * que el patrón y sus datos se verifiquen al compilar en vez de escribirse como texto en cada lado.
+ */
+export type RpcContract = Record<string, { payload: unknown; response: unknown }>;
+
+/** Datos que se envían con el patrón `K` del contrato `C`. */
+export type RpcPayload<C, K extends keyof C> = C[K] extends { payload: infer P } ? P : never;
+
+/** Respuesta del patrón `K` del contrato `C`. */
+export type RpcResponse<C, K extends keyof C> = C[K] extends { response: infer R } ? R : never;
+
+/** Página de resultados que entregan los listados paginados. */
+export interface RpcPage<T> {
+  total: number;
+  totalPages: number;
+  currentPage: number;
+  nextPage: number | null;
+  prevPage: number | null;
+  results: T;
+}
+
+/** Filtros comunes de los listados; llegan desde la URL, por eso admiten texto. */
+export interface RpcListFilter {
+  page?: number | string;
+  limit?: number | string;
+  search?: string;
+}
+
+/**
+ * Datos cuya forma aún no está descrita en el contrato (el tipo vive dentro del microservicio). El microservicio los
+ * valida igual con su esquema; aquí solo no se verifican al compilar.
+ */
+export type RpcData = Record<string, unknown>;

package/src/contracts/index.ts

@@ -0,0 +1,40 @@
+import { BudgetAvailabilityPatterns, type BudgetAvailabilityContract } from './budgetAvailability.contract';
+import {
+  BudgetAvailabilityGeneratorPatterns,
+  type BudgetAvailabilityGeneratorContract,
+} from './budgetAvailabilityGenerator.contract';
+import {
+  BudgetAvailabilityPurchaseRequestPatterns,
+  type BudgetAvailabilityPurchaseRequestContract,
+} from './budgetAvailabilityPurchaseRequest.contract';
+import {
+  BudgetAvailabilitySignaturePatterns,
+  type BudgetAvailabilitySignatureContract,
+} from './budgetAvailabilitySignature.contract';
+import {
+  BudgetAvailabilityTemplatePatterns,
+  type BudgetAvailabilityTemplateContract,
+} from './budgetAvailabilityTemplate.contract';
+
+export * from './contract';
+export * from './budgetAvailability.contract';
+export * from './budgetAvailabilityGenerator.contract';
+export * from './budgetAvailabilityPurchaseRequest.contract';
+export * from './budgetAvailabilitySignature.contract';
+export * from './budgetAvailabilityTemplate.contract';
+
+/** Patrones NATS de pre-obligado-ms, por recurso: `preObligado.<recurso>.<acción>`. */
+export const PreObligadoPatterns = {
+  budgetAvailability: BudgetAvailabilityPatterns,
+  budgetAvailabilityGenerator: BudgetAvailabilityGeneratorPatterns,
+  budgetAvailabilityPurchaseRequest: BudgetAvailabilityPurchaseRequestPatterns,
+  budgetAvailabilitySignature: BudgetAvailabilitySignaturePatterns,
+  budgetAvailabilityTemplate: BudgetAvailabilityTemplatePatterns,
+} as const;
+
+/** Contrato completo de pre-obligado-ms: la unión de los contratos de sus recursos. */
+export type PreObligadoContract = BudgetAvailabilityContract &
+  BudgetAvailabilityGeneratorContract &
+  BudgetAvailabilityPurchaseRequestContract &
+  BudgetAvailabilitySignatureContract &
+  BudgetAvailabilityTemplateContract;

package/src/entities/budgetAvailability/budgetAvailability.entity.ts

@@ -71,6 +71,10 @@ export class BudgetAvailabilityGetAllResponseEntity {
       id: DepartmentEntity['id'];
       name: DepartmentEntity['name'];
     } | null,
+    // Avance del procedimiento de firmas / visaciones del certificado.
+    public totalSignatureSteps?: number,
+    public resolvedSignatureSteps?: number,
+    public signatureCompletedAt?: string | null,
   ) {}
 }
 
@@ -250,3 +254,11 @@ export class BudgetAvailabilityComptrollerSignResponseEntity {
     public ok: boolean,
   ) {}
 }
+
+/** Resultado de generar en lote los CDP de un documento (uno por cuenta). */
+export class BudgetAvailabilitiesBatchCreateResponseEntity {
+  constructor(
+    public ids: string[],
+    public ok: boolean,
+  ) {}
+}

package/src/entities/budgetAvailabilityTemplate/budgetAvailabilityTemplate.entity.ts

@@ -24,6 +24,12 @@ export class BudgetAvailabilityTemplateGetByIdResponseEntity {
       type: BudgetAvailabilityTemplateSignatureEntity['type'];
       title: BudgetAvailabilityTemplateSignatureEntity['title'];
       subTitle: BudgetAvailabilityTemplateSignatureEntity['subTitle'];
+      access: BudgetAvailabilityTemplateSignatureEntity['access'];
+      actions: BudgetAvailabilityTemplateSignatureEntity['actions'];
+      description: BudgetAvailabilityTemplateSignatureEntity['description'];
+      // área que resuelve el paso (dirección o departamento); el nombre viene resuelto más abajo
+      directorateCode?: BudgetAvailabilityTemplateSignatureEntity['directorateCode'];
+      departmentId?: BudgetAvailabilityTemplateSignatureEntity['departmentId'];
       directorate?: {
         Codigo_Direccion: DirectorateEntity['Codigo_Direccion'];
         DESCRIPCION: DirectorateEntity['DESCRIPCION'];
@@ -49,6 +55,9 @@ export class BudgetAvailabilityTemplateGetByYearResponseEntity {
       type: BudgetAvailabilityTemplateSignatureEntity['type'];
       title: BudgetAvailabilityTemplateSignatureEntity['title'];
       subTitle: BudgetAvailabilityTemplateSignatureEntity['subTitle'];
+      access: BudgetAvailabilityTemplateSignatureEntity['access'];
+      actions: BudgetAvailabilityTemplateSignatureEntity['actions'];
+      description: BudgetAvailabilityTemplateSignatureEntity['description'];
       directorate?: {
         Codigo_Direccion: DirectorateEntity['Codigo_Direccion'];
         DESCRIPCION: DirectorateEntity['DESCRIPCION'];

package/src/index.ts

@@ -1,2 +1,3 @@
 export * from './entities';
 export * from './base/entities';
+export * from './contracts';

package/tsconfig.json

@@ -7,7 +7,7 @@
     "strict": true,
     "esModuleInterop": true,
     "skipLibCheck": true,
-    "baseUrl": "./"
+    "rootDir": "./src"
   },
   "include": [
     "src"