@fiado/type-kit 3.513.0 → 3.515.0

package/src/rewardsEligibility/dtos/EvaluationReward.ts

@@ -0,0 +1,7 @@
+import { RewardInputRef } from '../types/RewardInputRef';
+
+/** Que se pide a rewards-business al calificar: el paquete y sus inputs `itemKey -> inputKey -> valor`. */
+export class EvaluationReward {
+    packageId: string;
+    inputs: Record<string, Record<string, RewardInputRef>>;
+}

package/src/rewardsEligibility/dtos/EvaluationTrigger.ts

@@ -0,0 +1,15 @@
+import { ApprovalModeEnum } from '../enums/ApprovalModeEnum';
+import { TriggerTypeEnum } from '../enums/TriggerTypeEnum';
+import { PopulationRef } from './PopulationRef';
+
+/** Disparador de una evaluacion (spec B 5.1). Una evaluacion tiene a lo sumo UN disparador `EVENT`. */
+export class EvaluationTrigger {
+    type: TriggerTypeEnum;
+    approval: ApprovalModeEnum;
+    /** Solo `EVENT`. */
+    eventKey?: string;
+    /** Solo `CRON`: cron de 5 campos, granularidad de 15 minutos (fase 4). */
+    schedule?: string;
+    /** Solo `CRON` (fase 4). */
+    population?: PopulationRef;
+}

package/src/rewardsEligibility/dtos/GrantPolicy.ts

@@ -0,0 +1,13 @@
+import { GrantPeriodEnum } from '../enums/GrantPeriodEnum';
+import { GrantPolicyModeEnum } from '../enums/GrantPolicyModeEnum';
+
+/** Politica de frecuencia de una evaluacion (spec B 5.1). Cada modo exige su campo (lo valida el backoffice). */
+export class GrantPolicy {
+    mode: GrantPolicyModeEnum;
+    /** Solo `PER_PERIOD`. */
+    period?: GrantPeriodEnum;
+    /** Solo `PER_REFERENCE`: la `key` de un input del contrato (ej. `saleId`). */
+    referenceInput?: string;
+    /** Solo `MAX_N`: tope de premios en total (>= 1). */
+    max?: number;
+}

package/src/rewardsEligibility/dtos/PopulationRef.ts

@@ -0,0 +1,7 @@
+import { DynamicFormValue } from '../../dynamicForm/types/DynamicFormValue';
+
+/** Fuente de poblacion de un disparador `CRON` (fase 4) con sus params. */
+export class PopulationRef {
+    source: string;
+    params: Record<string, DynamicFormValue>;
+}

package/src/rewardsEligibility/enums/ApprovalModeEnum.ts

@@ -0,0 +1,4 @@
+export enum ApprovalModeEnum {
+    AUTO = 'AUTO',
+    REQUIRED = 'REQUIRED',
+}

package/src/rewardsEligibility/enums/BatchPublishStateEnum.ts

@@ -0,0 +1,7 @@
+/** Estado de publicacion del registro de reserva de un lote (spec B 5.8). */
+export enum BatchPublishStateEnum {
+    PENDING_APPROVAL = 'PENDING_APPROVAL',
+    PENDING = 'PENDING',
+    PUBLISHED = 'PUBLISHED',
+    CANCELLED = 'CANCELLED',
+}

package/src/rewardsEligibility/enums/CampaignPausedReasonEnum.ts

@@ -0,0 +1,7 @@
+/** Por que esta pausada una campania: decide si se siguen soltando sus lotes reservados (spec B 7.6). */
+export enum CampaignPausedReasonEnum {
+    /** Lo pauso un operador: no se sueltan lotes. */
+    MANUAL = 'MANUAL',
+    /** Se agoto un cupo con `PAUSE_CAMPAIGN`: lo reservado igual se suelta. */
+    QUOTA_EXHAUSTED = 'QUOTA_EXHAUSTED',
+}

package/src/rewardsEligibility/enums/CampaignStatusEnum.ts

@@ -0,0 +1,8 @@
+export enum CampaignStatusEnum {
+    DRAFT = 'DRAFT',
+    ACTIVE = 'ACTIVE',
+    PAUSED = 'PAUSED',
+    /** Llego a `endsAt` (lo marca el tick, spec B 5.6). */
+    ENDED = 'ENDED',
+    ARCHIVED = 'ARCHIVED',
+}

package/src/rewardsEligibility/enums/EvaluationStatusEnum.ts

@@ -0,0 +1,6 @@
+export enum EvaluationStatusEnum {
+    DRAFT = 'DRAFT',
+    ACTIVE = 'ACTIVE',
+    PAUSED = 'PAUSED',
+    ARCHIVED = 'ARCHIVED',
+}

package/src/rewardsEligibility/enums/GrantPeriodEnum.ts

@@ -0,0 +1,5 @@
+/** Periodos validos de `GrantPolicy.period` (modo `PER_PERIOD`). */
+export enum GrantPeriodEnum {
+    WEEK = 'WEEK',
+    MONTH = 'MONTH',
+}

package/src/rewardsEligibility/enums/GrantPolicyModeEnum.ts

@@ -0,0 +1,11 @@
+/** Politica de frecuencia de una evaluacion (spec B E5 y 5.5). */
+export enum GrantPolicyModeEnum {
+    /** Una vez en la vida por evaluacion. */
+    ONCE = 'ONCE',
+    /** Una por periodo (`GrantPeriodEnum`). */
+    PER_PERIOD = 'PER_PERIOD',
+    /** Una por valor del `referenceInput` (ej. `saleId`). */
+    PER_REFERENCE = 'PER_REFERENCE',
+    /** Hasta N en total (`max`), con un contador. */
+    MAX_N = 'MAX_N',
+}

package/src/rewardsEligibility/enums/LedgerStatusEnum.ts

@@ -0,0 +1,5 @@
+/** Estado de una reserva del ledger de frecuencia (spec B 5.5). */
+export enum LedgerStatusEnum {
+    RESERVED = 'RESERVED',
+    RELEASED = 'RELEASED',
+}

package/src/rewardsEligibility/enums/QuotaExhaustedActionEnum.ts

@@ -0,0 +1,7 @@
+/** Que pasa al agotarse un cupo (`onExhausted`, spec B 5.6). */
+export enum QuotaExhaustedActionEnum {
+    /** Pausa la campania; sus evaluaciones dejan de correr. */
+    PAUSE_CAMPAIGN = 'PAUSE_CAMPAIGN',
+    /** Siguen corriendo y registrando, sin entregar (`QUOTA_EXHAUSTED`). */
+    RECORD_ONLY = 'RECORD_ONLY',
+}

package/src/rewardsEligibility/enums/QuotaPeriodEnum.ts

@@ -0,0 +1,7 @@
+/** Periodo de un cupo de campania (spec B 5.6). `TOTAL` no se reinicia nunca. */
+export enum QuotaPeriodEnum {
+    TOTAL = 'TOTAL',
+    DAY = 'DAY',
+    WEEK = 'WEEK',
+    MONTH = 'MONTH',
+}

package/src/rewardsEligibility/enums/TraceOriginEnum.ts

@@ -0,0 +1,5 @@
+/** De donde salio el dato con el que se decidio una condicion (spec B 7.4.1). */
+export enum TraceOriginEnum {
+    PREFETCHED = 'PREFETCHED',
+    RESOLVED = 'RESOLVED',
+}

package/src/rewardsEligibility/index.ts

@@ -14,3 +14,27 @@ export * from './dtos/PostEventResponse';
 export * from './dtos/RunCounts';
 export * from './dtos/RunResultItem';
 export * from './dtos/GetRunResponse';
+
+//Enums del dominio (campanias, evaluaciones, ledger)
+export * from './enums/CampaignStatusEnum';
+export * from './enums/CampaignPausedReasonEnum';
+export * from './enums/EvaluationStatusEnum';
+export * from './enums/GrantPolicyModeEnum';
+export * from './enums/GrantPeriodEnum';
+export * from './enums/QuotaPeriodEnum';
+export * from './enums/QuotaExhaustedActionEnum';
+export * from './enums/ApprovalModeEnum';
+export * from './enums/LedgerStatusEnum';
+export * from './enums/BatchPublishStateEnum';
+export * from './enums/TraceOriginEnum';
+
+//Types
+export * from './types/RewardInputRef';
+
+//DTOs de configuracion (forma guardada de campanias y evaluaciones)
+export * from './dtos/GrantPolicy';
+export * from './dtos/CampaignQuota';
+export * from './dtos/CampaignAlerts';
+export * from './dtos/PopulationRef';
+export * from './dtos/EvaluationReward';
+export * from './dtos/EvaluationTrigger';

package/src/rewardsEligibility/types/RewardInputRef.ts

@@ -0,0 +1,4 @@
+import { DynamicFormValue } from '../../dynamicForm/types/DynamicFormValue';
+
+/** Valor de un input de `reward.inputs`: constante o tomado de un input de la evaluacion (spec B 5.1). */
+export type RewardInputRef = { const: DynamicFormValue } | { input: string };