@fiado/type-kit 3.515.0 → 3.517.0

package/src/rewardsEligibility/dtos/backoffice/RunResponse.ts

@@ -0,0 +1,25 @@
+import { ApprovalModeEnum } from '../../enums/ApprovalModeEnum';
+import { RunModeEnum } from '../../enums/RunModeEnum';
+import { RunStatusEnum } from '../../enums/RunStatusEnum';
+import { TriggerTypeEnum } from '../../enums/TriggerTypeEnum';
+import { RunCounts } from '../RunCounts';
+import { QuotaImpactResponse } from './QuotaImpactResponse';
+
+/** Corrida para el backoffice (spec 10). */
+export class RunResponse {
+    id: string;
+    evaluationId: string;
+    /** `version` de la evaluación CONGELADA en la corrida. */
+    evaluationVersion: number;
+    campaignId: string;
+    trigger: TriggerTypeEnum;
+    approval: ApprovalModeEnum;
+    mode: RunModeEnum;
+    status: RunStatusEnum;
+    counts: RunCounts;
+    /** Solo con `status: AWAITING_APPROVAL`: cuánto consumiría la corrida de cada cupo y cuánto queda. */
+    quotaImpact?: QuotaImpactResponse[];
+    requestedBy: string;
+    createdAt: number;
+    updatedAt: number;
+}

package/src/rewardsEligibility/dtos/backoffice/RunResultListResponse.ts

@@ -0,0 +1,6 @@
+import { RunResultResponse } from './RunResultResponse';
+
+export class RunResultListResponse {
+    items: RunResultResponse[];
+    nextCursor?: string;
+}

package/src/rewardsEligibility/dtos/backoffice/RunResultResponse.ts

@@ -0,0 +1,23 @@
+import { DynamicFormValue } from '../../../dynamicForm/types/DynamicFormValue';
+import { EvaluationOutcomeEnum } from '../../enums/EvaluationOutcomeEnum';
+import { GrantRequestStatusEnum } from '../../enums/GrantRequestStatusEnum';
+import { ResultTraceResponse } from './ResultTraceResponse';
+
+/** Resultado por sujeto CON traza e inputs (spec 5.4). */
+export class RunResultResponse {
+    runId: string;
+    subjectKey: string;
+    inputs: Record<string, DynamicFormValue>;
+    beneficiaryDirectoryId: string;
+    campaignId: string;
+    evaluationId: string;
+    packageId: string;
+    outcome: EvaluationOutcomeEnum;
+    trace?: ResultTraceResponse;
+    grantKey?: string;
+    grantStatus: GrantRequestStatusEnum;
+    /** Cruza con `GET /grants/{id}` de rewards. */
+    grantId?: string;
+    errorMessage?: string;
+    evaluatedAt: number;
+}

package/src/rewardsEligibility/dtos/backoffice/SimulateRequest.ts

@@ -0,0 +1,25 @@
+import { Expose, Type } from 'class-transformer';
+import { IsOptional, IsString, Matches, Validate, ValidateNested } from 'class-validator';
+import { DynamicFormValue } from '../../../dynamicForm/types/DynamicFormValue';
+import { IsDynamicFormValues } from '../../../dynamicForm/validators/IsDynamicFormValues';
+import { ELIGIBILITY_ID_PATTERN } from '../../constants/BackofficeLimits';
+import { EvaluationRequest } from './EvaluationRequest';
+
+/** `POST /evaluations/simulate`: una evaluación GUARDADA (`evaluationId`) o un BORRADOR sin guardar (`evaluation`), más los inputs del sujeto. No persiste nada. Exactamente uno de los dos lo valida el lambda. */
+export class SimulateRequest {
+    @Expose()
+    @IsOptional()
+    @IsString()
+    @Matches(ELIGIBILITY_ID_PATTERN)
+    evaluationId?: string;
+
+    @Expose()
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => EvaluationRequest)
+    evaluation?: EvaluationRequest;
+
+    @Expose()
+    @Validate(IsDynamicFormValues)
+    inputs: Record<string, DynamicFormValue>;
+}

package/src/rewardsEligibility/dtos/backoffice/SimulateResponse.ts

@@ -0,0 +1,12 @@
+import { EvaluationOutcomeEnum } from '../../enums/EvaluationOutcomeEnum';
+import { ResultTraceResponse } from './ResultTraceResponse';
+
+export class SimulateResponse {
+    outcome: EvaluationOutcomeEnum;
+    /** Ausente si el sujeto ni siquiera pudo evaluarse (inputs inválidos). */
+    trace?: ResultTraceResponse;
+    beneficiaryDirectoryId?: string;
+    grantKey?: string;
+    /** Explicación corta: «Ya recibió el premio para la venta s-9». */
+    note?: string;
+}

package/src/rewardsEligibility/enums/MetricsDimensionEnum.ts

@@ -0,0 +1,8 @@
+/** Dimensión de las métricas preagregadas (spec 5.7). `ALL` suma todas las campañas al consultar (no se escribe). */
+export enum MetricsDimensionEnum {
+    CAMPAIGN = 'CAMPAIGN',
+    EVALUATION = 'EVALUATION',
+    PACKAGE = 'PACKAGE',
+    TRIGGER = 'TRIGGER',
+    ALL = 'ALL',
+}

package/src/rewardsEligibility/enums/RewardsEligibilityErrorCodeEnum.ts

@@ -5,4 +5,51 @@ export enum RewardsEligibilityErrorCodeEnum {
     EVENT_TYPE_NOT_FOUND = 'EVENT_TYPE_NOT_FOUND',
     /** 404: GET /runs/{id} sin corrida. */
     RUN_NOT_FOUND = 'RUN_NOT_FOUND',
+
+    // ── Backoffice (fase 3) ──
+    /** 400: el cuerpo no cumple el DTO (solo nombres de propiedad, nunca valores). */
+    VALIDATION_ERROR = 'VALIDATION_ERROR',
+    /** 400: `limit` fuera de rango o `cursor` que no devolvió esta API. */
+    INVALID_PAGE = 'INVALID_PAGE',
+    /** 400: un filtro de query (`outcome`, `status`, `dimension`, fechas…) no es válido. */
+    INVALID_FILTER = 'INVALID_FILTER',
+    /** 503: el índice de listado aún no existe en la tabla (pendiente de infraestructura). */
+    LIST_INDEX_NOT_AVAILABLE = 'LIST_INDEX_NOT_AVAILABLE',
+    /** 409: otra persona editó la misma fila. */
+    VERSION_CONFLICT = 'VERSION_CONFLICT',
+    /** 400: el id de la ruta no coincide con el del cuerpo. */
+    REQUEST_ID_MISMATCH = 'REQUEST_ID_MISMATCH',
+    /** 409: la transición de estado no está permitida. */
+    INVALID_STATUS_TRANSITION = 'INVALID_STATUS_TRANSITION',
+    CAMPAIGN_NOT_FOUND = 'CAMPAIGN_NOT_FOUND',
+    CAMPAIGN_ALREADY_EXISTS = 'CAMPAIGN_ALREADY_EXISTS',
+    CAMPAIGN_INVALID = 'CAMPAIGN_INVALID',
+    EVALUATION_NOT_FOUND = 'EVALUATION_NOT_FOUND',
+    EVALUATION_ALREADY_EXISTS = 'EVALUATION_ALREADY_EXISTS',
+    /** 400: la evaluación no pasa las validaciones del spec 5.1 (lista TODOS los problemas). */
+    EVALUATION_INVALID = 'EVALUATION_INVALID',
+    /** 409: la evaluación o su campaña no están en condiciones de correr (estado o vigencia). */
+    EVALUATION_NOT_RUNNABLE = 'EVALUATION_NOT_RUNNABLE',
+    EVENT_TYPE_ALREADY_EXISTS = 'EVENT_TYPE_ALREADY_EXISTS',
+    EVENT_TYPE_INVALID = 'EVENT_TYPE_INVALID',
+    /** 409: el tipo de evento lo escuchan evaluaciones ACTIVAS. */
+    EVENT_TYPE_IN_USE = 'EVENT_TYPE_IN_USE',
+    PACKAGE_NOT_FOUND = 'PACKAGE_NOT_FOUND',
+    /** 503: rewards-business no respondió al consultar un paquete. */
+    PACKAGE_LOOKUP_UNAVAILABLE = 'PACKAGE_LOOKUP_UNAVAILABLE',
+    /** 400: la evaluación no tiene disparador MANUAL. */
+    MANUAL_TRIGGER_MISSING = 'MANUAL_TRIGGER_MISSING',
+    /** 400: la corrida manual por población llega con la fase 4 (cron masivo). */
+    POPULATION_RUN_NOT_SUPPORTED = 'POPULATION_RUN_NOT_SUPPORTED',
+    /** 409: la corrida no está esperando aprobación. */
+    RUN_NOT_AWAITING_APPROVAL = 'RUN_NOT_AWAITING_APPROVAL',
+    /** 409: la corrida tiene más de un registro de reserva (aprobación masiva = fase 4). */
+    APPROVAL_RUN_TOO_LARGE = 'APPROVAL_RUN_TOO_LARGE',
+    RESULT_NOT_FOUND = 'RESULT_NOT_FOUND',
+    /** 409: solo se reintenta un sujeto en ERROR o REQUEST_FAILED de una corrida LIVE cerrada. */
+    RESULT_NOT_RETRYABLE = 'RESULT_NOT_RETRYABLE',
+    /** 400: el rango pedido excede el tope de filas de la exportación. */
+    EXPORT_TOO_LARGE = 'EXPORT_TOO_LARGE',
+    /** 503: la tabla de métricas no responde o no existe aún. */
+    METRICS_UNAVAILABLE = 'METRICS_UNAVAILABLE',
 }

package/src/rewardsEligibility/enums/RuleValueTypeEnum.ts

@@ -0,0 +1,9 @@
+/** Tipo de valor de un campo del catálogo de reglas (`GET /rule-catalog`). */
+export enum RuleValueTypeEnum {
+    NUMBER = 'NUMBER',
+    STRING = 'STRING',
+    BOOLEAN = 'BOOLEAN',
+    DATE = 'DATE',
+    /** Lista de textos (ej. `directory.scope`). */
+    STRING_LIST = 'STRING_LIST',
+}

package/src/rewardsEligibility/index.ts

@@ -38,3 +38,39 @@ export * from './dtos/CampaignAlerts';
 export * from './dtos/PopulationRef';
 export * from './dtos/EvaluationReward';
 export * from './dtos/EvaluationTrigger';
+
+//Backoffice (fase 3): enums, constantes y DTOs
+export * from './enums/MetricsDimensionEnum';
+export * from './enums/RuleValueTypeEnum';
+export * from './constants/BackofficeLimits';
+export * from './dtos/backoffice/CampaignRequest';
+export * from './dtos/backoffice/CampaignStatusRequest';
+export * from './dtos/backoffice/CampaignResponse';
+export * from './dtos/backoffice/CampaignListResponse';
+export * from './dtos/backoffice/QuotaUsageResponse';
+export * from './dtos/backoffice/CampaignSummaryResponse';
+export * from './dtos/backoffice/EventTypeRequest';
+export * from './dtos/backoffice/EventTypeResponse';
+export * from './dtos/backoffice/EventTypeListResponse';
+export * from './dtos/backoffice/EvaluationRequest';
+export * from './dtos/backoffice/EvaluationStatusRequest';
+export * from './dtos/backoffice/EvaluationResponse';
+export * from './dtos/backoffice/EvaluationListResponse';
+export * from './dtos/backoffice/ResultTraceResponse';
+export * from './dtos/backoffice/SimulateRequest';
+export * from './dtos/backoffice/SimulateResponse';
+export * from './dtos/backoffice/RuleCatalogResponse';
+export * from './dtos/backoffice/PopulationSourceResponse';
+export * from './dtos/backoffice/InputTypeResponse';
+export * from './dtos/backoffice/CreateRunRequest';
+export * from './dtos/backoffice/PopulationRunRequest';
+export * from './dtos/backoffice/ApproveRunRequest';
+export * from './dtos/backoffice/QuotaImpactResponse';
+export * from './dtos/backoffice/RunResponse';
+export * from './dtos/backoffice/RunListResponse';
+export * from './dtos/backoffice/RunResultResponse';
+export * from './dtos/backoffice/RunResultListResponse';
+export * from './dtos/backoffice/CreateRunResponse';
+export * from './dtos/backoffice/MetricsPointResponse';
+export * from './dtos/backoffice/FailedConditionStatResponse';
+export * from './dtos/backoffice/MetricsQuery';