@fiado/api-invoker 5.112.0 → 5.113.0

package/bin/index.d.ts

@@ -90,6 +90,7 @@ export * from "./retailCards/index.js";
 export * from "./retailNotifications/index.js";
 export * from "./retailWizard/index.js";
 export * from "./retailPromotions/index.js";
+export * from "./retailCommission/index.js";
 export * from "./retailIntegration/index.js";
 export * from "./shortlink/index.js";
 export * from "./loanConfig/index.js";

package/bin/index.js

@@ -90,6 +90,7 @@ export * from "./retailCards/index.js";
 export * from "./retailNotifications/index.js";
 export * from "./retailWizard/index.js";
 export * from "./retailPromotions/index.js";
+export * from "./retailCommission/index.js";
 export * from "./retailIntegration/index.js";
 export * from "./shortlink/index.js";
 export * from "./loanConfig/index.js";

package/bin/retailCommission/RetailCommissionBusinessApi.d.ts

@@ -0,0 +1,12 @@
+import type { IHttpRequest } from "@fiado/http-client";
+import type { StandardResponse } from "@fiado/gateway-adapter";
+import type { PrivateLatestClosedPayoutResponse } from "@fiado/type-kit/bin/retailCommission/index.js";
+import type { IRetailCommissionBusinessApi } from "./interfaces/IRetailCommissionBusinessApi.js";
+/** Publisher HTTP de `retail-commission-business`. Contrato → `IRetailCommissionBusinessApi`. */
+export declare class RetailCommissionBusinessApi implements IRetailCommissionBusinessApi {
+    private readonly httpRequest;
+    constructor(httpRequest: IHttpRequest);
+    /** La URL del SSM termina en `/v1/`; se quita la barra final para no duplicarla. */
+    private get baseUrl();
+    getLatestClosedPayout(retailerId: string, tenantId: string): Promise<StandardResponse<PrivateLatestClosedPayoutResponse>>;
+}

package/bin/retailCommission/RetailCommissionBusinessApi.js

@@ -0,0 +1,35 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { inject, injectable } from "inversify";
+/** Publisher HTTP de `retail-commission-business`. Contrato → `IRetailCommissionBusinessApi`. */
+let RetailCommissionBusinessApi = class RetailCommissionBusinessApi {
+    httpRequest;
+    constructor(httpRequest) {
+        this.httpRequest = httpRequest;
+    }
+    /** La URL del SSM termina en `/v1/`; se quita la barra final para no duplicarla. */
+    get baseUrl() {
+        return (process.env.RETAIL_COMMISSION_BUSINESS_URL || "").replace(/\/+$/, "");
+    }
+    async getLatestClosedPayout(retailerId, tenantId) {
+        const path = `/private/retailers/${encodeURIComponent(retailerId)}/payouts/latest-closed`;
+        const query = new URLSearchParams({ tenantId });
+        return await this.httpRequest.get(`${this.baseUrl}${path}?${query.toString()}`);
+    }
+};
+RetailCommissionBusinessApi = __decorate([
+    injectable(),
+    __param(0, inject("IHttpRequest")),
+    __metadata("design:paramtypes", [Object])
+], RetailCommissionBusinessApi);
+export { RetailCommissionBusinessApi };

package/bin/retailCommission/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./interfaces/IRetailCommissionBusinessApi.js";
+export * from "./RetailCommissionBusinessApi.js";

package/bin/retailCommission/index.js

@@ -0,0 +1,2 @@
+export * from "./interfaces/IRetailCommissionBusinessApi.js";
+export * from "./RetailCommissionBusinessApi.js";

package/bin/retailCommission/interfaces/IRetailCommissionBusinessApi.d.ts

@@ -0,0 +1,16 @@
+import type { StandardResponse } from "@fiado/gateway-adapter";
+import type { PrivateLatestClosedPayoutResponse } from "@fiado/type-kit/bin/retailCommission/index.js";
+/**
+ * Publisher de los endpoints privados de `retail-commission-business` (motor de comisiones de
+ * VentasLuga). No confundir con `commission-business`, que es otro servicio.
+ *
+ * Env var requerida en el consumer: `RETAIL_COMMISSION_BUSINESS_URL: '{{resolve:ssm:retail-commission-business}}'`.
+ * `tenantId` es obligatorio: los privados no llevan token y el silo lo declara el caller.
+ */
+export interface IRetailCommissionBusinessApi {
+    /**
+     * `GET /private/retailers/{retailerId}/payouts/latest-closed` — el último corte semanal CERRADO
+     * de la cadena, con lo que le pagó a cada vendedor. Sin corte cerrado reciente: `period: null`.
+     */
+    getLatestClosedPayout(retailerId: string, tenantId: string): Promise<StandardResponse<PrivateLatestClosedPayoutResponse>>;
+}

package/bin/retailCommission/interfaces/IRetailCommissionBusinessApi.js

@@ -0,0 +1 @@
+export {};

package/bin/retailOrg/api/RetailOrgBusinessApi.d.ts

@@ -1,6 +1,6 @@
 import type { IHttpRequest } from "@fiado/http-client";
 import { StandardResponse } from "@fiado/gateway-adapter";
-import { RetailerValidationDto, StoreValidationDto, RetailUserValidationDto, CollectorValidationDto, PrivateSellerListResponse, RetailUserStatusEnum } from "@fiado/type-kit/bin/retailOrg/index.js";
+import { RetailerValidationDto, StoreValidationDto, RetailUserValidationDto, CollectorValidationDto, PrivateSellerListResponse, PrivateGoalListResponse, GoalTargetTypeEnum, RetailUserStatusEnum } from "@fiado/type-kit/bin/retailOrg/index.js";
 import type { ApplyRetailUserEventRequest, ApplyRetailUserEventResponse, ApplyStoreEventRequest, ApplyStoreEventResponse } from "@fiado/type-kit/bin/retailIntegration/index.js";
 import { IRetailOrgBusinessApi, RetailerRosterStatusFilter, StoreRosterStatusFilter } from "./interfaces/IRetailOrgBusinessApi.js";
 /**
@@ -49,7 +49,9 @@ export default class RetailOrgBusinessApi implements IRetailOrgBusinessApi {
      * ⚠️ Es el único método de este publisher con el `retailerId` en el QUERY y no anidado en el
      * path: el caller no está validando un recurso, está pidiendo una colección entera.
      */
-    listSellers(retailerId: string, tenantId: string, callerService: string, status?: RetailUserStatusEnum): Promise<StandardResponse<PrivateSellerListResponse>>;
+    listSellers(retailerId: string, tenantId: string, callerService: string, status?: RetailUserStatusEnum, includePhone?: boolean): Promise<StandardResponse<PrivateSellerListResponse>>;
+    /** Metas del periodo de una cadena. Contrato → `IRetailOrgBusinessApi.listGoals`. */
+    listGoals(retailerId: string, tenantId: string, periodId: string, targetType?: GoalTargetTypeEnum): Promise<StandardResponse<PrivateGoalListResponse>>;
     privateApplyStoreEvent(request: ApplyStoreEventRequest): Promise<StandardResponse<ApplyStoreEventResponse>>;
     privateApplyRetailUserEvent(request: ApplyRetailUserEventRequest): Promise<StandardResponse<ApplyRetailUserEventResponse>>;
     private applyRetailEvent;

package/bin/retailOrg/api/RetailOrgBusinessApi.js

@@ -92,14 +92,24 @@ let RetailOrgBusinessApi = class RetailOrgBusinessApi {
      * ⚠️ Es el único método de este publisher con el `retailerId` en el QUERY y no anidado en el
      * path: el caller no está validando un recurso, está pidiendo una colección entera.
      */
-    async listSellers(retailerId, tenantId, callerService, status) {
+    async listSellers(retailerId, tenantId, callerService, status, includePhone) {
         // `URLSearchParams` en vez de concatenar: `status` es opcional y armar el `&status=` a mano
         // deja un `&status=undefined` en cuanto alguien se distrae.
         const query = new URLSearchParams({ retailerId, tenantId, callerService });
         if (status)
             query.set("status", status);
+        if (includePhone)
+            query.set("includePhone", "true");
         return await this.httpRequest.get(`${this.baseUrl}/private/sellers?${query.toString()}`);
     }
+    /** Metas del periodo de una cadena. Contrato → `IRetailOrgBusinessApi.listGoals`. */
+    async listGoals(retailerId, tenantId, periodId, targetType) {
+        const query = new URLSearchParams({ tenantId, periodId });
+        if (targetType)
+            query.set("targetType", targetType);
+        const path = `/private/retailers/${encodeURIComponent(retailerId)}/goals`;
+        return await this.httpRequest.get(`${this.baseUrl}${path}?${query.toString()}`);
+    }
     async privateApplyStoreEvent(request) {
         return await this.applyRetailEvent("/private/integration/store-events", request);
     }

package/bin/retailOrg/api/interfaces/IRetailOrgBusinessApi.d.ts

@@ -1,5 +1,5 @@
 import { StandardResponse } from "@fiado/gateway-adapter";
-import { RetailerValidationDto, StoreValidationDto, RetailUserValidationDto, CollectorValidationDto, PrivateSellerListResponse, RetailUserStatusEnum, RetailerStatusEnum, StoreStatusEnum } from "@fiado/type-kit/bin/retailOrg/index.js";
+import { RetailerValidationDto, StoreValidationDto, RetailUserValidationDto, CollectorValidationDto, PrivateSellerListResponse, PrivateGoalListResponse, GoalTargetTypeEnum, RetailUserStatusEnum, RetailerStatusEnum, StoreStatusEnum } from "@fiado/type-kit/bin/retailOrg/index.js";
 import type { ApplyRetailUserEventRequest, ApplyRetailUserEventResponse, ApplyStoreEventRequest, ApplyStoreEventResponse } from "@fiado/type-kit/bin/retailIntegration/index.js";
 /**
  * Filtro de `listStoresByRetailer`. `"ALL"` no es un estado de tienda: es la ausencia de filtro, y
@@ -206,6 +206,8 @@ export interface IRetailOrgBusinessApi {
      * lo perdería en silencio sin dejar ninguna forma de pedir el padrón completo. Si el motor
      * quiere solo activos, que lo diga explícito.
      *
+     * `includePhone: true` agrega el teléfono de cada vendedor (PII, por eso es opt-in).
+     *
      * ── `callerService`: quién exportó la nómina ─────────────────────────────────────────────────
      * El endpoint es `Feature.ANONIMUS` (sin token de usuario), así que **no hay `actorId`** al que
      * atribuirle la lectura — y esto exporta la nómina completa de una cadena en una sola llamada.
@@ -218,7 +220,14 @@ export interface IRetailOrgBusinessApi {
      *   cerraría el corte sin devengos sin que nadie se entere hasta el día de pago.
      * @throws `400 VALIDATION_ERROR` si `retailerId` no es un ULID · `400 UNKNOWN_TENANT` sin `tenantId`.
      */
-    listSellers(retailerId: string, tenantId: string, callerService: string, status?: RetailUserStatusEnum): Promise<StandardResponse<PrivateSellerListResponse>>;
+    listSellers(retailerId: string, tenantId: string, callerService: string, status?: RetailUserStatusEnum, includePhone?: boolean): Promise<StandardResponse<PrivateSellerListResponse>>;
+    /**
+     * `GET /private/retailers/{retailerId}/goals` — las metas del periodo (`YYYY-MM`) de una cadena,
+     * con `monthCents`/`weekCents`/`dayCents` ya derivadas. Sin metas devuelve `goals: []`, no 404.
+     *
+     * @throws `400 VALIDATION_ERROR` con un periodo o tipo inválido · `400 UNKNOWN_TENANT` sin tenant.
+     */
+    listGoals(retailerId: string, tenantId: string, periodId: string, targetType?: GoalTargetTypeEnum): Promise<StandardResponse<PrivateGoalListResponse>>;
     /** `POST /private/integration/store-events?tenantId=` — aplica un evento de tienda del retailer. */
     privateApplyStoreEvent(request: ApplyStoreEventRequest): Promise<StandardResponse<ApplyStoreEventResponse>>;
     /** `POST /private/integration/retail-user-events?tenantId=` — aplica un evento de usuario del retailer. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fiado/api-invoker",
-  "version": "5.112.0",
+  "version": "5.113.0",
   "description": "Sirve como un puente entre diferentes funciones lambda, facilitando la comunicación entre ellas a través de invocaciones http",
   "type": "module",
   "main": "bin/index.js",
@@ -34,7 +34,7 @@
     "@fiado/gateway-adapter": "^3.14.0",
     "@fiado/http-client": "^2.0.1",
     "@fiado/logger": "^1.1.3",
-    "@fiado/type-kit": "^3.500.0",
+    "@fiado/type-kit": "^3.506.0",
     "dotenv": "^16.4.7"
   },
   "peerDependencies": {

package/src/index.ts

@@ -90,6 +90,7 @@ export * from "./retailCards/index.js";
 export * from "./retailNotifications/index.js";
 export * from "./retailWizard/index.js";
 export * from "./retailPromotions/index.js";
+export * from "./retailCommission/index.js";
 export * from "./retailIntegration/index.js";
 export * from "./shortlink/index.js";
 export * from "./loanConfig/index.js";

package/src/retailCommission/RetailCommissionBusinessApi.ts

@@ -0,0 +1,25 @@
+import { inject, injectable } from "inversify";
+import type { IHttpRequest } from "@fiado/http-client";
+import type { StandardResponse } from "@fiado/gateway-adapter";
+import type { PrivateLatestClosedPayoutResponse } from "@fiado/type-kit/bin/retailCommission/index.js";
+import type { IRetailCommissionBusinessApi } from "./interfaces/IRetailCommissionBusinessApi.js";
+
+/** Publisher HTTP de `retail-commission-business`. Contrato → `IRetailCommissionBusinessApi`. */
+@injectable()
+export class RetailCommissionBusinessApi implements IRetailCommissionBusinessApi {
+    constructor(@inject("IHttpRequest") private readonly httpRequest: IHttpRequest) {}
+
+    /** La URL del SSM termina en `/v1/`; se quita la barra final para no duplicarla. */
+    private get baseUrl(): string {
+        return (process.env.RETAIL_COMMISSION_BUSINESS_URL || "").replace(/\/+$/, "");
+    }
+
+    async getLatestClosedPayout(
+        retailerId: string,
+        tenantId: string,
+    ): Promise<StandardResponse<PrivateLatestClosedPayoutResponse>> {
+        const path = `/private/retailers/${encodeURIComponent(retailerId)}/payouts/latest-closed`;
+        const query = new URLSearchParams({ tenantId });
+        return await this.httpRequest.get(`${this.baseUrl}${path}?${query.toString()}`);
+    }
+}

package/src/retailCommission/index.ts

@@ -0,0 +1,2 @@
+export * from "./interfaces/IRetailCommissionBusinessApi.js";
+export * from "./RetailCommissionBusinessApi.js";

package/src/retailCommission/interfaces/IRetailCommissionBusinessApi.ts

@@ -0,0 +1,20 @@
+import type { StandardResponse } from "@fiado/gateway-adapter";
+import type { PrivateLatestClosedPayoutResponse } from "@fiado/type-kit/bin/retailCommission/index.js";
+
+/**
+ * Publisher de los endpoints privados de `retail-commission-business` (motor de comisiones de
+ * VentasLuga). No confundir con `commission-business`, que es otro servicio.
+ *
+ * Env var requerida en el consumer: `RETAIL_COMMISSION_BUSINESS_URL: '{{resolve:ssm:retail-commission-business}}'`.
+ * `tenantId` es obligatorio: los privados no llevan token y el silo lo declara el caller.
+ */
+export interface IRetailCommissionBusinessApi {
+    /**
+     * `GET /private/retailers/{retailerId}/payouts/latest-closed` — el último corte semanal CERRADO
+     * de la cadena, con lo que le pagó a cada vendedor. Sin corte cerrado reciente: `period: null`.
+     */
+    getLatestClosedPayout(
+        retailerId: string,
+        tenantId: string,
+    ): Promise<StandardResponse<PrivateLatestClosedPayoutResponse>>;
+}

package/src/retailOrg/api/RetailOrgBusinessApi.ts

@@ -7,6 +7,8 @@ import {
     RetailUserValidationDto,
     CollectorValidationDto,
     PrivateSellerListResponse,
+    PrivateGoalListResponse,
+    GoalTargetTypeEnum,
     RetailUserStatusEnum,
 } from "@fiado/type-kit/bin/retailOrg/index.js";
 import type {
@@ -142,14 +144,29 @@ export default class RetailOrgBusinessApi implements IRetailOrgBusinessApi {
         tenantId: string,
         callerService: string,
         status?: RetailUserStatusEnum,
+        includePhone?: boolean,
     ): Promise<StandardResponse<PrivateSellerListResponse>> {
         // `URLSearchParams` en vez de concatenar: `status` es opcional y armar el `&status=` a mano
         // deja un `&status=undefined` en cuanto alguien se distrae.
         const query = new URLSearchParams({ retailerId, tenantId, callerService });
         if (status) query.set("status", status);
+        if (includePhone) query.set("includePhone", "true");
         return await this.httpRequest.get(`${this.baseUrl}/private/sellers?${query.toString()}`);
     }
 
+    /** Metas del periodo de una cadena. Contrato → `IRetailOrgBusinessApi.listGoals`. */
+    async listGoals(
+        retailerId: string,
+        tenantId: string,
+        periodId: string,
+        targetType?: GoalTargetTypeEnum,
+    ): Promise<StandardResponse<PrivateGoalListResponse>> {
+        const query = new URLSearchParams({ tenantId, periodId });
+        if (targetType) query.set("targetType", targetType);
+        const path = `/private/retailers/${encodeURIComponent(retailerId)}/goals`;
+        return await this.httpRequest.get(`${this.baseUrl}${path}?${query.toString()}`);
+    }
+
     async privateApplyStoreEvent(request: ApplyStoreEventRequest): Promise<StandardResponse<ApplyStoreEventResponse>> {
         return await this.applyRetailEvent("/private/integration/store-events", request);
     }

package/src/retailOrg/api/interfaces/IRetailOrgBusinessApi.ts

@@ -5,6 +5,8 @@ import {
     RetailUserValidationDto,
     CollectorValidationDto,
     PrivateSellerListResponse,
+    PrivateGoalListResponse,
+    GoalTargetTypeEnum,
     RetailUserStatusEnum,
     RetailerStatusEnum,
     StoreStatusEnum,
@@ -258,6 +260,8 @@ export interface IRetailOrgBusinessApi {
      * lo perdería en silencio sin dejar ninguna forma de pedir el padrón completo. Si el motor
      * quiere solo activos, que lo diga explícito.
      *
+     * `includePhone: true` agrega el teléfono de cada vendedor (PII, por eso es opt-in).
+     *
      * ── `callerService`: quién exportó la nómina ─────────────────────────────────────────────────
      * El endpoint es `Feature.ANONIMUS` (sin token de usuario), así que **no hay `actorId`** al que
      * atribuirle la lectura — y esto exporta la nómina completa de una cadena en una sola llamada.
@@ -275,8 +279,22 @@ export interface IRetailOrgBusinessApi {
         tenantId: string,
         callerService: string,
         status?: RetailUserStatusEnum,
+        includePhone?: boolean,
     ): Promise<StandardResponse<PrivateSellerListResponse>>;
 
+    /**
+     * `GET /private/retailers/{retailerId}/goals` — las metas del periodo (`YYYY-MM`) de una cadena,
+     * con `monthCents`/`weekCents`/`dayCents` ya derivadas. Sin metas devuelve `goals: []`, no 404.
+     *
+     * @throws `400 VALIDATION_ERROR` con un periodo o tipo inválido · `400 UNKNOWN_TENANT` sin tenant.
+     */
+    listGoals(
+        retailerId: string,
+        tenantId: string,
+        periodId: string,
+        targetType?: GoalTargetTypeEnum,
+    ): Promise<StandardResponse<PrivateGoalListResponse>>;
+
     /** `POST /private/integration/store-events?tenantId=` — aplica un evento de tienda del retailer. */
     privateApplyStoreEvent(request: ApplyStoreEventRequest): Promise<StandardResponse<ApplyStoreEventResponse>>;