@muni-sanfer/types-gestor-documental 0.0.1-beta.44 → 0.0.1-beta.45

package/dist/base/entities.d.ts

@@ -205,6 +205,11 @@ export declare const TextSnippetSection: {
     Body: "Body";
     Closing: "Closing";
 };
+export type HolidaySource = 'Manual' | 'Api';
+export declare const HolidaySource: {
+    Manual: "Manual";
+    Api: "Api";
+};
 export type WorkFolderItemKind = 'Document' | 'File';
 export declare const WorkFolderItemKind: {
     Document: "Document";
@@ -915,7 +920,16 @@ export interface HolidayEntity {
     id: string;
     date: string;
     name: string;
+    source: HolidaySource;
+    kind?: string | null;
+    excluded: boolean;
     createdAt: string;
+    updatedAt: string;
+}
+export interface HolidaySyncEntity {
+    year: number;
+    syncedAt: string;
+    total: number;
 }
 export interface TextSnippetEntity {
     id: string;

package/dist/base/entities.js

@@ -1,8 +1,8 @@
 "use strict";
 // This file was auto-generated by prisma-generator-typescript-interfaces
 Object.defineProperty(exports, "__esModule", { value: true });
-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.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 = void 0;
+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.DocumentCategory = {
     Decree: 'Decree',
     Communication: 'Communication',
@@ -184,6 +184,10 @@ exports.TextSnippetSection = {
     Body: 'Body',
     Closing: 'Closing',
 };
+exports.HolidaySource = {
+    Manual: 'Manual',
+    Api: 'Api',
+};
 exports.WorkFolderItemKind = {
     Document: 'Document',
     File: 'File',

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

@@ -1,19 +1,20 @@
-import { type HolidayRemoveResponseEntity, type HolidayResponseEntity } from '../entities';
+import { type HolidayListResponseEntity, type HolidayRemoveResponseEntity, type HolidayResponseEntity, type HolidaySyncResponseEntity } from '../entities';
 /** Patrones NATS de `holiday`: feriados para contar días hábiles. */
 export declare const HolidayPatterns: {
     readonly getAll: "gestorDocumental.holiday.getAll";
     readonly create: "gestorDocumental.holiday.create";
     readonly remove: "gestorDocumental.holiday.remove";
+    readonly sync: "gestorDocumental.holiday.sync";
 };
 export interface HolidayContract {
-    /** Feriados de un año, en orden. */
+    /** Feriados de un año, en orden (también los de la API que se quitaron a mano). */
     [HolidayPatterns.getAll]: {
         payload: {
             year: number;
         };
-        response: HolidayResponseEntity[];
+        response: HolidayListResponseEntity;
     };
-    /** `date` como «AAAA-MM-DD». */
+    /** `date` como «AAAA-MM-DD». Si es uno de la API que se había quitado, vuelve a contar. */
     [HolidayPatterns.create]: {
         payload: {
             date: string;
@@ -21,10 +22,18 @@ export interface HolidayContract {
         };
         response: HolidayResponseEntity;
     };
+    /** Uno cargado a mano se borra; uno de la API se marca como quitado. */
     [HolidayPatterns.remove]: {
         payload: {
             id: string;
         };
         response: HolidayRemoveResponseEntity;
     };
+    /** Trae de la API pública los feriados de un año. Lo cargado o quitado a mano se respeta. */
+    [HolidayPatterns.sync]: {
+        payload: {
+            year: number;
+        };
+        response: HolidaySyncResponseEntity;
+    };
 }

package/dist/contracts/holiday.contract.js

@@ -6,4 +6,5 @@ exports.HolidayPatterns = {
     getAll: 'gestorDocumental.holiday.getAll',
     create: 'gestorDocumental.holiday.create',
     remove: 'gestorDocumental.holiday.remove',
+    sync: 'gestorDocumental.holiday.sync',
 };

package/dist/contracts/index.d.ts

@@ -214,6 +214,7 @@ export declare const GestorDocumentalPatterns: {
         readonly getAll: "gestorDocumental.holiday.getAll";
         readonly create: "gestorDocumental.holiday.create";
         readonly remove: "gestorDocumental.holiday.remove";
+        readonly sync: "gestorDocumental.holiday.sync";
     };
     readonly indicators: {
         readonly getManagement: "gestorDocumental.indicators.getManagement";

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

@@ -1,10 +1,32 @@
+import { type HolidaySource } from '../../base/entities';
 /** Feriado: el día («AAAA-MM-DD») no cuenta como hábil en los plazos. */
 export interface HolidayResponseEntity {
     id: string;
     date: string;
     name: string;
+    /** Cargado a mano o traído de la API pública de feriados. */
+    source: HolidaySource;
+    /** Como lo informa la API. Ej: «Civil e Irrenunciable». */
+    kind: string | null;
+    /** Uno de la API que se quitó a mano: no cuenta, y la próxima actualización no lo vuelve a agregar. */
+    excluded: boolean;
+}
+/** Feriados de un año y cuándo se trajeron de la API por última vez (`null` si nunca). */
+export interface HolidayListResponseEntity {
+    holidays: HolidayResponseEntity[];
+    syncedAt: string | null;
 }
 export interface HolidayRemoveResponseEntity {
     id: string;
     ok: boolean;
 }
+/** Resultado de traer de la API los feriados de un año: los agregados, actualizados y quitados por la API. */
+export interface HolidaySyncResponseEntity {
+    year: number;
+    added: number;
+    updated: number;
+    removed: number;
+    /** Cuántos informó la API para ese año. */
+    total: number;
+    syncedAt: string;
+}

package/package.json

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

package/src/base/entities.ts

@@ -310,6 +310,13 @@ export const TextSnippetSection = {
   Closing: 'Closing',
 } satisfies Record<string, TextSnippetSection>;
 
+export type HolidaySource = 'Manual' | 'Api';
+
+export const HolidaySource = {
+  Manual: 'Manual',
+  Api: 'Api',
+} satisfies Record<string, HolidaySource>;
+
 export type WorkFolderItemKind = 'Document' | 'File';
 
 export const WorkFolderItemKind = {
@@ -1144,7 +1151,17 @@ export interface HolidayEntity {
   id: string;
   date: string;
   name: string;
+  source: HolidaySource;
+  kind?: string | null;
+  excluded: boolean;
   createdAt: string;
+  updatedAt: string;
+}
+
+export interface HolidaySyncEntity {
+  year: number;
+  syncedAt: string;
+  total: number;
 }
 
 export interface TextSnippetEntity {

package/src/contracts/holiday.contract.ts

@@ -1,16 +1,25 @@
-import { type HolidayRemoveResponseEntity, type HolidayResponseEntity } from '../entities';
+import {
+  type HolidayListResponseEntity,
+  type HolidayRemoveResponseEntity,
+  type HolidayResponseEntity,
+  type HolidaySyncResponseEntity,
+} from '../entities';
 
 /** Patrones NATS de `holiday`: feriados para contar días hábiles. */
 export const HolidayPatterns = {
   getAll: 'gestorDocumental.holiday.getAll',
   create: 'gestorDocumental.holiday.create',
   remove: 'gestorDocumental.holiday.remove',
+  sync: 'gestorDocumental.holiday.sync',
 } as const;
 
 export interface HolidayContract {
-  /** Feriados de un año, en orden. */
-  [HolidayPatterns.getAll]: { payload: { year: number }; response: HolidayResponseEntity[] };
-  /** `date` como «AAAA-MM-DD». */
+  /** Feriados de un año, en orden (también los de la API que se quitaron a mano). */
+  [HolidayPatterns.getAll]: { payload: { year: number }; response: HolidayListResponseEntity };
+  /** `date` como «AAAA-MM-DD». Si es uno de la API que se había quitado, vuelve a contar. */
   [HolidayPatterns.create]: { payload: { date: string; name: string }; response: HolidayResponseEntity };
+  /** Uno cargado a mano se borra; uno de la API se marca como quitado. */
   [HolidayPatterns.remove]: { payload: { id: string }; response: HolidayRemoveResponseEntity };
+  /** Trae de la API pública los feriados de un año. Lo cargado o quitado a mano se respeta. */
+  [HolidayPatterns.sync]: { payload: { year: number }; response: HolidaySyncResponseEntity };
 }

package/src/entities/holiday/holiday.entity.ts

@@ -1,11 +1,36 @@
+import { type HolidaySource } from '../../base/entities';
+
 /** Feriado: el día («AAAA-MM-DD») no cuenta como hábil en los plazos. */
 export interface HolidayResponseEntity {
   id: string;
   date: string;
   name: string;
+  /** Cargado a mano o traído de la API pública de feriados. */
+  source: HolidaySource;
+  /** Como lo informa la API. Ej: «Civil e Irrenunciable». */
+  kind: string | null;
+  /** Uno de la API que se quitó a mano: no cuenta, y la próxima actualización no lo vuelve a agregar. */
+  excluded: boolean;
+}
+
+/** Feriados de un año y cuándo se trajeron de la API por última vez (`null` si nunca). */
+export interface HolidayListResponseEntity {
+  holidays: HolidayResponseEntity[];
+  syncedAt: string | null;
 }
 
 export interface HolidayRemoveResponseEntity {
   id: string;
   ok: boolean;
 }
+
+/** Resultado de traer de la API los feriados de un año: los agregados, actualizados y quitados por la API. */
+export interface HolidaySyncResponseEntity {
+  year: number;
+  added: number;
+  updated: number;
+  removed: number;
+  /** Cuántos informó la API para ese año. */
+  total: number;
+  syncedAt: string;
+}