@fiado/type-kit 3.589.0 → 3.590.0

package/_test_/unit/retailWizard/backofficeSessionSummaries.test.ts

@@ -0,0 +1,67 @@
+import 'reflect-metadata';
+import { plainToInstance } from 'class-transformer';
+import { validateSync } from 'class-validator';
+import * as RetailWizard from '../../../src/retailWizard';
+import * as RetailCatalog from '../../../src/retailCatalog';
+
+const { BackofficeSessionSummariesRequest, BACKOFFICE_SESSION_SUMMARIES_MAX_IDS } = RetailWizard;
+
+function errorsOf(payload: Record<string, unknown>): string[] {
+  const dto = plainToInstance(BackofficeSessionSummariesRequest, payload, { excludeExtraneousValues: true });
+  return validateSync(dto).map((e) => e.property);
+}
+
+describe('BackofficeSessionSummariesRequest', () => {
+  it('acepta una lista de ids válidos', () => {
+    expect(errorsOf({ sessionIds: ['01HXYZ', 'abc_def-1'] })).toEqual([]);
+  });
+
+  it('rechaza lista vacía, ausente o no-lista', () => {
+    expect(errorsOf({ sessionIds: [] })).toEqual(['sessionIds']);
+    expect(errorsOf({})).toEqual(['sessionIds']);
+    expect(errorsOf({ sessionIds: 'abc' })).toEqual(['sessionIds']);
+  });
+
+  it('rechaza más ids que el techo', () => {
+    const ids = Array.from({ length: BACKOFFICE_SESSION_SUMMARIES_MAX_IDS + 1 }, (_, i) => `s${i}`);
+    expect(errorsOf({ sessionIds: ids })).toEqual(['sessionIds']);
+  });
+
+  it('rechaza ids con forma inválida o que no son texto', () => {
+    expect(errorsOf({ sessionIds: ['ok', 'con espacio'] })).toEqual(['sessionIds']);
+    expect(errorsOf({ sessionIds: [123] })).toEqual(['sessionIds']);
+  });
+
+  it('el response tipa el resumen de sesión', () => {
+    const result: RetailWizard.BackofficeSessionSummariesResult = {
+      sessions: [
+        {
+          sessionId: 's1',
+          state: RetailWizard.WizardStateEnum.ACTIVE,
+          sellerName: null,
+          sellerRetailUserId: null,
+          storeId: 'st1',
+          paid: false,
+          saleId: null,
+          currentStep: null,
+        },
+      ],
+    };
+    expect(result.sessions).toHaveLength(1);
+  });
+});
+
+describe('retailCatalog — saldo por tienda y reservas vivas', () => {
+  it('InventoryStorePieces acepta el saldo opcional y GetInventorySkuResponse las reservas vivas', () => {
+    const store: RetailCatalog.InventoryStorePieces = { storeId: 'st1', pieces: [], available: 3, reserved: 1, availableToSell: 2 };
+    const reservation: RetailCatalog.InventoryLiveReservation = {
+      storeId: 'st1', sessionId: 's1', lineId: 'l1', reservationId: 'r1', quantity: 1,
+      expiresAt: '2026-10-26T00:00:00.000Z', reservedAt: null,
+    };
+    const detail: Pick<RetailCatalog.GetInventorySkuResponse, 'piecesByStore' | 'liveReservations'> = {
+      piecesByStore: [store],
+      liveReservations: [reservation],
+    };
+    expect(detail.liveReservations?.[0].reservationId).toBe('r1');
+  });
+});

package/bin/retailCatalog/dtos/responses/GetInventorySkuResponse.d.ts

@@ -37,6 +37,24 @@ export interface InventoryPieceEntry {
 export interface InventoryStorePieces {
     storeId: string;
     pieces: InventoryPieceEntry[];
+    /** BALANCE#.available de la tienda; 0 sin BALANCE#. */
+    available?: number;
+    /** BALANCE#.reserved: apartadas por cantidad o con pieza HELD. */
+    reserved?: number;
+    /** Unidades que de verdad se pueden vender: min(available, piezas AVAILABLE). */
+    availableToSell?: number;
+}
+/** Reserva RES# viva de un SKU en una tienda, para la tarjeta "Apartados ahora" de la ficha. */
+export interface InventoryLiveReservation {
+    storeId: string;
+    sessionId: string;
+    lineId: string;
+    reservationId: string;
+    quantity: number;
+    /** ISO en que vence la reserva. */
+    expiresAt: string;
+    /** ISO en que se apartó; null si la fila no trae createdAt. */
+    reservedAt: string | null;
 }
 /** Response de backofficeGetInventorySku: solo lo que la fila de filter=list no trae. */
 export interface GetInventorySkuResponse {
@@ -51,6 +69,8 @@ export interface GetInventorySkuResponse {
     /** Promos de venta vigentes del SKU; `null` si retail-promotions no respondió. */
     promotions?: ActiveSalePromotionSummary[] | null;
     sources?: InventorySkuSources;
+    /** Reservas RES# vivas del SKU en todas las tiendas. */
+    liveReservations?: InventoryLiveReservation[];
 }
 /** Estado de las fuentes externas de la ficha. */
 export interface InventorySkuSources {

package/bin/retailWizard/catalog/backofficeSessionSummaries.d.ts

@@ -0,0 +1,4 @@
+/** Techo de ids por request de `POST /backoffice/wizard/sessions/summaries`. */
+export declare const BACKOFFICE_SESSION_SUMMARIES_MAX_IDS = 50;
+/** Forma aceptada de un `sessionId`; la misma que el lote privado de sesiones. */
+export declare const BACKOFFICE_SESSION_ID_PATTERN: RegExp;

package/bin/retailWizard/catalog/backofficeSessionSummaries.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BACKOFFICE_SESSION_ID_PATTERN = exports.BACKOFFICE_SESSION_SUMMARIES_MAX_IDS = void 0;
+/** Techo de ids por request de `POST /backoffice/wizard/sessions/summaries`. */
+exports.BACKOFFICE_SESSION_SUMMARIES_MAX_IDS = 50;
+/** Forma aceptada de un `sessionId`; la misma que el lote privado de sesiones. */
+exports.BACKOFFICE_SESSION_ID_PATTERN = /^[0-9A-Za-z_-]{1,64}$/;

package/bin/retailWizard/dtos/requests/BackofficeSessionSummariesRequest.d.ts

@@ -0,0 +1,4 @@
+/** Body de `POST /backoffice/wizard/sessions/summaries`. */
+export declare class BackofficeSessionSummariesRequest {
+    sessionIds: string[];
+}

package/bin/retailWizard/dtos/requests/BackofficeSessionSummariesRequest.js

@@ -0,0 +1,30 @@
+"use strict";
+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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BackofficeSessionSummariesRequest = void 0;
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+const backofficeSessionSummaries_1 = require("../../catalog/backofficeSessionSummaries");
+/** Body de `POST /backoffice/wizard/sessions/summaries`. */
+class BackofficeSessionSummariesRequest {
+}
+exports.BackofficeSessionSummariesRequest = BackofficeSessionSummariesRequest;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsArray)({ message: 'sessionIds debe ser una lista' }),
+    (0, class_validator_1.ArrayMinSize)(1, { message: 'sessionIds debe traer al menos un id' }),
+    (0, class_validator_1.ArrayMaxSize)(backofficeSessionSummaries_1.BACKOFFICE_SESSION_SUMMARIES_MAX_IDS, {
+        message: `sessionIds no puede pasar de ${backofficeSessionSummaries_1.BACKOFFICE_SESSION_SUMMARIES_MAX_IDS} ids`,
+    }),
+    (0, class_validator_1.IsString)({ each: true, message: 'cada sessionId debe ser texto' }),
+    (0, class_validator_1.Matches)(backofficeSessionSummaries_1.BACKOFFICE_SESSION_ID_PATTERN, { each: true, message: 'cada sessionId debe tener forma de id' }),
+    __metadata("design:type", Array)
+], BackofficeSessionSummariesRequest.prototype, "sessionIds", void 0);

package/bin/retailWizard/dtos/responses/BackofficeSessionSummariesResponse.d.ts

@@ -0,0 +1,18 @@
+import type { WizardStateEnum } from '../../enums/WizardStateEnum';
+import type { WizardStepEnum } from '../../enums/WizardStepEnum';
+/** Resumen de una sesión para el cajón de inventario del backoffice. */
+export interface BackofficeSessionSummary {
+    sessionId: string;
+    state: WizardStateEnum;
+    sellerName: string | null;
+    sellerRetailUserId: string | null;
+    storeId: string;
+    /** `true` si la sesión ya tiene cobro registrado. */
+    paid: boolean;
+    saleId: string | null;
+    currentStep: WizardStepEnum | null;
+}
+/** Respuesta de `POST /backoffice/wizard/sessions/summaries`; los ids desconocidos no aparecen. */
+export interface BackofficeSessionSummariesResult {
+    sessions: BackofficeSessionSummary[];
+}

package/bin/retailWizard/dtos/responses/BackofficeSessionSummariesResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/bin/retailWizard/index.d.ts

@@ -188,3 +188,6 @@ export * from './dtos/WizardSessionLookupEntry';
 export * from './dtos/responses/WizardSessionLookupResponse';
 export * from './dtos/responses/PrivateWizardSessionResponse';
 export * from './dtos/responses/SetAnchorGiftsResponse';
+export * from './catalog/backofficeSessionSummaries';
+export * from './dtos/requests/BackofficeSessionSummariesRequest';
+export * from './dtos/responses/BackofficeSessionSummariesResponse';

package/bin/retailWizard/index.js

@@ -224,3 +224,7 @@ __exportStar(require("./dtos/responses/WizardSessionLookupResponse"), exports);
 // M2M de Promociones (lectura privada de la sesión y regalo)
 __exportStar(require("./dtos/responses/PrivateWizardSessionResponse"), exports);
 __exportStar(require("./dtos/responses/SetAnchorGiftsResponse"), exports);
+// Resúmenes de sesión para el cajón de inventario (POST /backoffice/wizard/sessions/summaries)
+__exportStar(require("./catalog/backofficeSessionSummaries"), exports);
+__exportStar(require("./dtos/requests/BackofficeSessionSummariesRequest"), exports);
+__exportStar(require("./dtos/responses/BackofficeSessionSummariesResponse"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fiado/type-kit",
-  "version": "3.589.0",
+  "version": "3.590.0",
   "description": "",
   "main": "bin/index.js",
   "types": "bin/index.d.ts",

package/src/retailCatalog/dtos/responses/GetInventorySkuResponse.ts

@@ -41,6 +41,25 @@ export interface InventoryPieceEntry {
 export interface InventoryStorePieces {
     storeId: string;
     pieces: InventoryPieceEntry[];
+    /** BALANCE#.available de la tienda; 0 sin BALANCE#. */
+    available?: number;
+    /** BALANCE#.reserved: apartadas por cantidad o con pieza HELD. */
+    reserved?: number;
+    /** Unidades que de verdad se pueden vender: min(available, piezas AVAILABLE). */
+    availableToSell?: number;
+}
+
+/** Reserva RES# viva de un SKU en una tienda, para la tarjeta "Apartados ahora" de la ficha. */
+export interface InventoryLiveReservation {
+    storeId: string;
+    sessionId: string;
+    lineId: string;
+    reservationId: string;
+    quantity: number;
+    /** ISO en que vence la reserva. */
+    expiresAt: string;
+    /** ISO en que se apartó; null si la fila no trae createdAt. */
+    reservedAt: string | null;
 }
 
 /** Response de backofficeGetInventorySku: solo lo que la fila de filter=list no trae. */
@@ -56,6 +75,8 @@ export interface GetInventorySkuResponse {
     /** Promos de venta vigentes del SKU; `null` si retail-promotions no respondió. */
     promotions?: ActiveSalePromotionSummary[] | null;
     sources?: InventorySkuSources;
+    /** Reservas RES# vivas del SKU en todas las tiendas. */
+    liveReservations?: InventoryLiveReservation[];
 }
 
 /** Estado de las fuentes externas de la ficha. */

package/src/retailWizard/catalog/backofficeSessionSummaries.ts

@@ -0,0 +1,5 @@
+/** Techo de ids por request de `POST /backoffice/wizard/sessions/summaries`. */
+export const BACKOFFICE_SESSION_SUMMARIES_MAX_IDS = 50;
+
+/** Forma aceptada de un `sessionId`; la misma que el lote privado de sesiones. */
+export const BACKOFFICE_SESSION_ID_PATTERN = /^[0-9A-Za-z_-]{1,64}$/;

package/src/retailWizard/dtos/requests/BackofficeSessionSummariesRequest.ts

@@ -0,0 +1,19 @@
+import { Expose } from 'class-transformer';
+import { ArrayMaxSize, ArrayMinSize, IsArray, IsString, Matches } from 'class-validator';
+import {
+  BACKOFFICE_SESSION_ID_PATTERN,
+  BACKOFFICE_SESSION_SUMMARIES_MAX_IDS,
+} from '../../catalog/backofficeSessionSummaries';
+
+/** Body de `POST /backoffice/wizard/sessions/summaries`. */
+export class BackofficeSessionSummariesRequest {
+  @Expose()
+  @IsArray({ message: 'sessionIds debe ser una lista' })
+  @ArrayMinSize(1, { message: 'sessionIds debe traer al menos un id' })
+  @ArrayMaxSize(BACKOFFICE_SESSION_SUMMARIES_MAX_IDS, {
+    message: `sessionIds no puede pasar de ${BACKOFFICE_SESSION_SUMMARIES_MAX_IDS} ids`,
+  })
+  @IsString({ each: true, message: 'cada sessionId debe ser texto' })
+  @Matches(BACKOFFICE_SESSION_ID_PATTERN, { each: true, message: 'cada sessionId debe tener forma de id' })
+  sessionIds!: string[];
+}

package/src/retailWizard/dtos/responses/BackofficeSessionSummariesResponse.ts

@@ -0,0 +1,20 @@
+import type { WizardStateEnum } from '../../enums/WizardStateEnum';
+import type { WizardStepEnum } from '../../enums/WizardStepEnum';
+
+/** Resumen de una sesión para el cajón de inventario del backoffice. */
+export interface BackofficeSessionSummary {
+  sessionId: string;
+  state: WizardStateEnum;
+  sellerName: string | null;
+  sellerRetailUserId: string | null;
+  storeId: string;
+  /** `true` si la sesión ya tiene cobro registrado. */
+  paid: boolean;
+  saleId: string | null;
+  currentStep: WizardStepEnum | null;
+}
+
+/** Respuesta de `POST /backoffice/wizard/sessions/summaries`; los ids desconocidos no aparecen. */
+export interface BackofficeSessionSummariesResult {
+  sessions: BackofficeSessionSummary[];
+}

package/src/retailWizard/index.ts

@@ -219,3 +219,8 @@ export * from './dtos/responses/WizardSessionLookupResponse';
 // M2M de Promociones (lectura privada de la sesión y regalo)
 export * from './dtos/responses/PrivateWizardSessionResponse';
 export * from './dtos/responses/SetAnchorGiftsResponse';
+
+// Resúmenes de sesión para el cajón de inventario (POST /backoffice/wizard/sessions/summaries)
+export * from './catalog/backofficeSessionSummaries';
+export * from './dtos/requests/BackofficeSessionSummariesRequest';
+export * from './dtos/responses/BackofficeSessionSummariesResponse';