@reactionary/hcl 0.10.53 → 0.10.55

package/capabilities/store.capability.js

@@ -11,8 +11,12 @@ var __decorateClass = (decorators, target, key, kind) => {
 import {
   Reactionary,
   StoreCapability,
+  StoreQueryByIdSchema,
   StoreQueryByProximitySchema,
+  StoreQueryForListSchema,
+  StorePaginatedResultSchema,
   StoreSchema,
+  error,
   success
 } from "@reactionary/core";
 import * as z from "zod";
@@ -45,9 +49,63 @@ class HclStoreCapability extends StoreCapability {
     );
     return success(stores);
   }
+  async getById(payload) {
+    const response = await this.client.callGet(
+      this.getStoreByIdUrl(payload),
+      new URLSearchParams(),
+      { allowUndefined: true }
+    );
+    const store = response?.PhysicalStore?.[0];
+    if (!store) {
+      return error({ type: "NotFound", identifier: payload.identifier });
+    }
+    return success(this.factory.parseStore(this.context, store));
+  }
+  /**
+   * A radius in kilometers that covers the entire globe from any origin: the
+   * maximum great-circle distance between two points on Earth is ~20,015 km.
+   */
+  getGlobalRadiusKm() {
+    return 25e3;
+  }
+  async list(payload) {
+    const response = await this.client.callGet(
+      this.getStoreListUrl(payload),
+      this.getStoreListParams(payload),
+      { allowUndefined: true }
+    );
+    const { pageNumber, pageSize } = payload.paginationOptions;
+    const physicalStores = response?.PhysicalStore ?? [];
+    const requestedPageStart = (pageNumber - 1) * pageSize;
+    const pageStores = physicalStores.length > pageSize ? physicalStores.slice(requestedPageStart, requestedPageStart + pageSize) : physicalStores;
+    const reportedTotal = Number(response?.recordSetTotal);
+    const totalCount = Number.isFinite(reportedTotal) ? reportedTotal : physicalStores.length;
+    return success({
+      pageNumber,
+      pageSize,
+      totalCount,
+      totalPages: Math.ceil(totalCount / pageSize),
+      items: pageStores.map((store) => this.factory.parseStore(this.context, store))
+    });
+  }
   // ---------------------------------------------------------------------------
   // Extension points
   // ---------------------------------------------------------------------------
+  getStoreByIdUrl(payload) {
+    return `${this.client.transactionBaseUrl}/storelocator/byStoreId/${encodeURIComponent(payload.identifier.key)}`;
+  }
+  getStoreListUrl(_payload) {
+    return `${this.client.transactionBaseUrl}/storelocator/latitude/0/longitude/0`;
+  }
+  getStoreListParams(payload) {
+    const params = new URLSearchParams();
+    params.set("radius", String(this.getGlobalRadiusKm()));
+    params.set("radiusUOM", "km");
+    params.set("siteLevelStoreSearch", "false");
+    params.set("pageNumber", String(payload.paginationOptions.pageNumber));
+    params.set("pageSize", String(payload.paginationOptions.pageSize));
+    return params;
+  }
   getStoreLocatorUrl(payload) {
     return `${this.client.transactionBaseUrl}/storelocator/latitude/${payload.latitude}/longitude/${payload.longitude}`;
   }
@@ -66,6 +124,18 @@ __decorateClass([
     outputSchema: z.array(StoreSchema)
   })
 ], HclStoreCapability.prototype, "queryByProximity", 1);
+__decorateClass([
+  Reactionary({
+    inputSchema: StoreQueryByIdSchema,
+    outputSchema: StoreSchema
+  })
+], HclStoreCapability.prototype, "getById", 1);
+__decorateClass([
+  Reactionary({
+    inputSchema: StoreQueryForListSchema,
+    outputSchema: StorePaginatedResultSchema
+  })
+], HclStoreCapability.prototype, "list", 1);
 export {
   HclStoreCapability
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reactionary/hcl",
-  "version": "0.10.53",
+  "version": "0.10.55",
   "type": "module",
   "main": "./index.js",
   "types": "./src/index.d.ts",
@@ -9,7 +9,7 @@
     "url": "git+https://github.com/Solteq/reactionary.git"
   },
   "dependencies": {
-    "@reactionary/core": "0.10.53",
+    "@reactionary/core": "0.10.55",
     "debug": "^4.4.3",
     "zod": "4.1.9"
   },

package/src/capabilities/store.capability.d.ts

@@ -1,4 +1,4 @@
-import { type Cache, type RequestContext, type Result, StoreCapability, type StoreFactory, type StoreFactoryOutput, type StoreFactoryWithOutput, type StoreQueryByProximity } from '@reactionary/core';
+import { type Cache, type NotFoundError, type RequestContext, type Result, StoreCapability, type StoreFactory, type StoreFactoryOutput, type StoreFactoryWithOutput, type StorePaginatedResult, type StoreQueryById, type StoreQueryByProximity, type StoreQueryForList } from '@reactionary/core';
 import type { HclConfiguration } from '../schema/configuration.schema.js';
 import type { HclClient } from '../core/client.js';
 import type { HclStoreFactory } from '../factories/store/store.factory.js';
@@ -8,6 +8,16 @@ export declare class HclStoreCapability<TFactory extends StoreFactory = HclStore
     protected readonly factory: StoreFactoryWithOutput<TFactory>;
     constructor(cache: Cache, context: RequestContext, config: HclConfiguration, client: HclClient, factory: StoreFactoryWithOutput<TFactory>);
     queryByProximity(payload: StoreQueryByProximity): Promise<Result<StoreFactoryOutput<TFactory>[]>>;
+    getById(payload: StoreQueryById): Promise<Result<StoreFactoryOutput<TFactory>, NotFoundError>>;
+    /**
+     * A radius in kilometers that covers the entire globe from any origin: the
+     * maximum great-circle distance between two points on Earth is ~20,015 km.
+     */
+    protected getGlobalRadiusKm(): number;
+    list(payload: StoreQueryForList): Promise<Result<StorePaginatedResult>>;
+    protected getStoreByIdUrl(payload: StoreQueryById): string;
+    protected getStoreListUrl(_payload: StoreQueryForList): string;
+    protected getStoreListParams(payload: StoreQueryForList): URLSearchParams;
     protected getStoreLocatorUrl(payload: StoreQueryByProximity): string;
     protected getStoreLocatorParams(payload: StoreQueryByProximity): URLSearchParams;
 }

package/src/test/test-utils.d.ts

@@ -6,6 +6,7 @@ export declare function createHclClient(contextOverrides?: Partial<RequestContex
     productSearch?: true | undefined;
     company?: false | undefined;
     price?: false | undefined;
+    store?: false | undefined;
     order?: false | undefined;
     cart?: false | undefined;
     checkout?: false | undefined;
@@ -13,10 +14,9 @@ export declare function createHclClient(contextOverrides?: Partial<RequestContex
     profile?: false | undefined;
     inventory?: false | undefined;
     category?: true | undefined;
-    store?: false | undefined;
     productList?: false | undefined;
     orderSearch?: false | undefined;
-}>, "product" | "productSearch" | "company" | "price" | "order" | "cart" | "checkout" | "identity" | "profile" | "inventory" | "category" | "store" | "productList" | "orderSearch"> & {
+}>, "product" | "productSearch" | "company" | "price" | "store" | "order" | "cart" | "checkout" | "identity" | "profile" | "inventory" | "category" | "productList" | "orderSearch"> & {
     product: import("../index.js").HclProductCapability<import("../index.js").HclProductFactory<import("zod").ZodObject<{
         identifier: import("zod").ZodObject<{
             key: import("zod").ZodString;