@reactionary/hcl 0.9.13 → 0.9.15

package/src/factories/index.d.ts

@@ -1,5 +1,6 @@
 export * from './cart/cart.factory.js';
 export * from './checkout/checkout.factory.js';
+export * from './company/company.factory.js';
 export * from './product/product.factory.js';
 export * from './category/category.factory.js';
 export * from './product-search/product-search.factory.js';
@@ -10,5 +11,7 @@ export * from './profile/profile.factory.js';
 export * from './order/order.factory.js';
 export * from './order-search/order-search.factory.js';
 export * from './product-associations/product-associations.factory.js';
+export * from './product-list/product-list.factory.js';
 export * from './product-recommendations/product-recommendations.factory.js';
 export * from './personalization-profile/personalization-profile.factory.js';
+export * from './store/store.factory.js';

package/src/factories/product-list/product-list.factory.d.ts

@@ -0,0 +1,40 @@
+import type * as z from 'zod';
+import type { AnyProductListItemPaginatedSchema, AnyProductListItemSchema, AnyProductListPaginatedSchema, AnyProductListSchema, ProductListFactory, ProductListIdentifier, ProductListItemPaginatedResultsSchema, ProductListItemSchema, ProductListItemsQuery, ProductListPaginatedResultsSchema, ProductListQuery, ProductListSchema, RequestContext } from '@reactionary/core';
+import type { HclRequisitionList, HclRequisitionListDetailResponse, HclRequisitionListItem, HclRequisitionListResponse, HclWishlist, HclWishlistItem, HclWishlistItemResponse, HclWishlistListResponse } from '../../schema/hcl.schema.js';
+/** Passed to parseProductListItem so it can include the parent list reference. */
+export interface HclProductListItemInput {
+    item: HclWishlistItem;
+    list: ProductListIdentifier;
+}
+/** Passed to parseRequisitionListItem so it can include the parent list reference. */
+export interface HclRequisitionListItemInput {
+    item: HclRequisitionListItem;
+    list: ProductListIdentifier;
+}
+/** Extension interface implemented by HclProductListFactory for requisition list parsing. */
+export interface HclRequisitionListFactoryExtension {
+    parseRequisitionList(context: RequestContext, data: HclRequisitionList): unknown;
+    parseRequisitionListItem(context: RequestContext, data: HclRequisitionListItemInput): unknown;
+    parseRequisitionListPaginatedResult(context: RequestContext, data: HclRequisitionListResponse, query: ProductListQuery): unknown;
+    parseRequisitionListItemPaginatedResult(context: RequestContext, data: HclRequisitionListDetailResponse, query: ProductListItemsQuery): unknown;
+}
+/**
+ * Encode a listType and user description into HCL's description field.
+ * Format: `{type}:{description}` — e.g. `favorite:My list` or `wish:`
+ */
+export declare function encodeWishlistType(type: string, description: string | undefined): string;
+export declare class HclProductListFactory<TProductListSchema extends AnyProductListSchema = typeof ProductListSchema, TProductListItemSchema extends AnyProductListItemSchema = typeof ProductListItemSchema, TProductListPaginatedSchema extends AnyProductListPaginatedSchema = typeof ProductListPaginatedResultsSchema, TProductListItemPaginatedSchema extends AnyProductListItemPaginatedSchema = typeof ProductListItemPaginatedResultsSchema> implements ProductListFactory<TProductListSchema, TProductListItemSchema, TProductListPaginatedSchema, TProductListItemPaginatedSchema> {
+    readonly productListSchema: TProductListSchema;
+    readonly productListItemSchema: TProductListItemSchema;
+    readonly productListPaginatedSchema: TProductListPaginatedSchema;
+    readonly productListItemPaginatedSchema: TProductListItemPaginatedSchema;
+    constructor(productListSchema: TProductListSchema, productListItemSchema: TProductListItemSchema, productListPaginatedSchema: TProductListPaginatedSchema, productListItemPaginatedSchema: TProductListItemPaginatedSchema);
+    parseProductList(_context: RequestContext, data: HclWishlist): z.output<TProductListSchema>;
+    parseProductListItem(_context: RequestContext, data: HclProductListItemInput): z.output<TProductListItemSchema>;
+    parseProductListPaginatedResult(context: RequestContext, data: HclWishlistListResponse, query: ProductListQuery): z.output<TProductListPaginatedSchema>;
+    parseProductListItemPaginatedResult(context: RequestContext, data: HclWishlistItemResponse, query: ProductListItemsQuery): z.output<TProductListItemPaginatedSchema>;
+    parseRequisitionList(_context: RequestContext, data: HclRequisitionList): z.output<TProductListSchema>;
+    parseRequisitionListItem(_context: RequestContext, data: HclRequisitionListItemInput): z.output<TProductListItemSchema>;
+    parseRequisitionListPaginatedResult(context: RequestContext, data: HclRequisitionListResponse, query: ProductListQuery): z.output<TProductListPaginatedSchema>;
+    parseRequisitionListItemPaginatedResult(context: RequestContext, data: HclRequisitionListDetailResponse, query: ProductListItemsQuery): z.output<TProductListItemPaginatedSchema>;
+}

package/src/factories/store/store.factory.d.ts

@@ -0,0 +1,8 @@
+import type * as z from 'zod';
+import type { AnyStoreSchema, RequestContext, StoreFactory, StoreSchema } from '@reactionary/core';
+import type { HclPhysicalStore } from '../../schema/hcl.schema.js';
+export declare class HclStoreFactory<TStoreSchema extends AnyStoreSchema = typeof StoreSchema> implements StoreFactory<TStoreSchema> {
+    readonly storeSchema: TStoreSchema;
+    constructor(storeSchema: TStoreSchema);
+    parseStore(_context: RequestContext, data: HclPhysicalStore): z.output<TStoreSchema>;
+}

package/src/index.d.ts

@@ -21,3 +21,6 @@ export * from './capabilities/analytics.capability.js';
 export * from './capabilities/product-associations.capability.js';
 export * from './capabilities/product-recommendations.capability.js';
 export * from './capabilities/personalization-profile.capability.js';
+export * from './capabilities/company.capability.js';
+export * from './capabilities/store.capability.js';
+export * from './capabilities/product-list.capability.js';

package/src/schema/capabilities.schema.d.ts

@@ -1,4 +1,4 @@
-import type { Cache, RequestContext, AnalyticsCapability, CartFactory, CartFactoryWithOutput, CartCapability, CategoryFactory, CategoryFactoryWithOutput, CategoryCapability, CheckoutFactory, CheckoutFactoryWithOutput, CheckoutCapability, IdentityFactory, IdentityFactoryWithOutput, IdentityCapability, InventoryFactory, InventoryFactoryWithOutput, InventoryCapability, OrderFactory, OrderFactoryWithOutput, OrderCapability, OrderSearchFactory, OrderSearchFactoryWithOutput, OrderSearchCapability, PersonalizationProfileCapability, PersonalizationProfileFactory, PersonalizationProfileFactoryWithOutput, PriceFactory, PriceFactoryWithOutput, PriceCapability, ProductAssociationsCapability, ProductAssociationsFactory, ProductAssociationsFactoryWithOutput, ProductFactory, ProductFactoryWithOutput, ProductCapability, ProductRecommendationsCapability, ProductRecommendationsFactory, ProductRecommendationsFactoryWithOutput, ProductSearchFactory, ProductSearchFactoryWithOutput, ProductSearchCapability, ProfileFactory, ProfileFactoryWithOutput, ProfileCapability } from '@reactionary/core';
+import type { Cache, RequestContext, AnalyticsCapability, CartFactory, CartFactoryWithOutput, CartCapability, CategoryFactory, CategoryFactoryWithOutput, CategoryCapability, CheckoutFactory, CheckoutFactoryWithOutput, CheckoutCapability, CompanyCapability, CompanyFactory, CompanyFactoryWithOutput, IdentityFactory, IdentityFactoryWithOutput, IdentityCapability, InventoryFactory, InventoryFactoryWithOutput, InventoryCapability, OrderFactory, OrderFactoryWithOutput, OrderCapability, OrderSearchFactory, OrderSearchFactoryWithOutput, OrderSearchCapability, PersonalizationProfileCapability, PersonalizationProfileFactory, PersonalizationProfileFactoryWithOutput, PriceFactory, PriceFactoryWithOutput, PriceCapability, ProductAssociationsCapability, ProductAssociationsFactory, ProductAssociationsFactoryWithOutput, ProductFactory, ProductFactoryWithOutput, ProductCapability, ProductListCapability, ProductListFactory, ProductListFactoryWithOutput, ProductRecommendationsCapability, ProductRecommendationsFactory, ProductRecommendationsFactoryWithOutput, ProductSearchFactory, ProductSearchFactoryWithOutput, ProductSearchCapability, ProfileFactory, ProfileFactoryWithOutput, ProfileCapability, StoreCapability, StoreFactory, StoreFactoryWithOutput } from '@reactionary/core';
 import type { HclConfiguration } from './configuration.schema.js';
 import type { HclClient } from '../core/client.js';
 import * as z from 'zod';
@@ -18,6 +18,11 @@ export declare const HclCapabilitiesSchema: z.ZodObject<{
         factory: z.ZodOptional<z.ZodUnknown>;
         capability: z.ZodOptional<z.ZodUnknown>;
     }, z.core.$loose>>>;
+    company: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodBoolean;
+        factory: z.ZodOptional<z.ZodUnknown>;
+        capability: z.ZodOptional<z.ZodUnknown>;
+    }, z.core.$loose>>>;
     product: z.ZodOptional<z.ZodOptional<z.ZodObject<{
         enabled: z.ZodBoolean;
         factory: z.ZodOptional<z.ZodUnknown>;
@@ -43,6 +48,11 @@ export declare const HclCapabilitiesSchema: z.ZodObject<{
         factory: z.ZodOptional<z.ZodUnknown>;
         capability: z.ZodOptional<z.ZodUnknown>;
     }, z.core.$loose>>>;
+    productList: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodBoolean;
+        factory: z.ZodOptional<z.ZodUnknown>;
+        capability: z.ZodOptional<z.ZodUnknown>;
+    }, z.core.$loose>>>;
     profile: z.ZodOptional<z.ZodOptional<z.ZodObject<{
         enabled: z.ZodBoolean;
         factory: z.ZodOptional<z.ZodUnknown>;
@@ -78,6 +88,11 @@ export declare const HclCapabilitiesSchema: z.ZodObject<{
         factory: z.ZodOptional<z.ZodUnknown>;
         capability: z.ZodOptional<z.ZodUnknown>;
     }, z.core.$loose>>>;
+    store: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodBoolean;
+        factory: z.ZodOptional<z.ZodUnknown>;
+        capability: z.ZodOptional<z.ZodUnknown>;
+    }, z.core.$loose>>>;
 }, z.core.$loose>;
 export type HclCapabilities = z.infer<typeof HclCapabilitiesSchema>;
 export interface HclCapabilityFactoryArgs {
@@ -111,3 +126,6 @@ export type HclProductAssociationsCapabilityConfig = HclCapabilityConfig<Product
 /** Product recommendations uses a factory to parse espot activity data into recommendations. */
 export type HclProductRecommendationsCapabilityConfig = HclCapabilityConfig<ProductRecommendationsFactoryWithOutput<ProductRecommendationsFactory>, ProductRecommendationsCapability>;
 export type HclPersonalizationProfileCapabilityConfig = HclCapabilityConfig<PersonalizationProfileFactoryWithOutput<PersonalizationProfileFactory>, PersonalizationProfileCapability>;
+export type HclCompanyCapabilityConfig = HclCapabilityConfig<CompanyFactoryWithOutput<CompanyFactory>, CompanyCapability>;
+export type HclStoreCapabilityConfig = HclCapabilityConfig<StoreFactoryWithOutput<StoreFactory>, StoreCapability>;
+export type HclProductListCapabilityConfig = HclCapabilityConfig<ProductListFactoryWithOutput<ProductListFactory>, ProductListCapability>;

package/src/schema/hcl.schema.d.ts

@@ -752,3 +752,221 @@ export interface HclSegmentResponse {
     recordSetStartNumber?: number;
     recordSetComplete?: boolean;
 }
+/**
+ * A WCS person contact embedded within an organization's contactInfo or addressBook.
+ * Shares the same shape as HclWcsPersonContact but is returned under different keys
+ * in the organization API response.
+ */
+export interface HclWcsOrgContact {
+    nickName?: string;
+    firstName?: string;
+    lastName?: string;
+    /** Street address lines. Index 0 = street, index 1 = second line. */
+    addressLine?: string[];
+    city?: string;
+    stateOrProvinceName?: string;
+    zipCode?: string;
+    country?: string;
+    phone1?: string;
+    email1?: string;
+    /** '1' marks this as the default / primary shipping address. */
+    primary?: string;
+    addressType?: string;
+    addressId?: string;
+}
+/**
+ * An organization entry as returned by GET /wcs/resources/store/{storeId}/organization/{id}.
+ * Fields present depend on the profileName used (IBM_Org_Entity_Details vs IBM_Organization_Details).
+ */
+export interface HclOrganizationItem {
+    /** Internal WCS organization/member ID (numeric string). */
+    organizationId?: string;
+    orgEntityId?: string;
+    organizationName?: string;
+    displayName?: string;
+    /** Approval status code: '0' = pending, '1' = approved, '2' = rejected. */
+    status?: string;
+    /** '0' = locked/blocked, '1' = active. */
+    state?: string;
+    /** Tax payer ID (maps to taxIdentifier on the domain model). */
+    taxPayerId?: string;
+    /** Legal entity identifier. */
+    legalId?: string;
+    /** Business category. */
+    businessCategory?: string;
+    description?: string;
+    /** Primary billing / contact address. */
+    contactInfo?: HclWcsOrgContact;
+    /** Additional shipping addresses. */
+    addressBook?: HclWcsOrgContact[];
+    /** Context attributes set by IBM_Org_Entity_Details profile (key-value map). */
+    contextAttribute?: Record<string, unknown>;
+    /** Parent organization member ID. */
+    parentMemberId?: string;
+}
+/**
+ * Top-level response from GET /wcs/resources/store/{storeId}/organization
+ * with profileName=IBM_Organization_List_Summary.
+ */
+export interface HclOrganizationListResponse {
+    organizationDataBeans?: HclOrganizationItem[];
+    recordSetTotal?: string;
+    recordSetCount?: string;
+    recordSetStartNumber?: string;
+    recordSetComplete?: string;
+}
+/**
+ * Response from POST /wcs/resources/store/{storeId}/organization/buyer.
+ * Returns the newly created org entity ID and the buyer admin user ID.
+ */
+export interface HclBuyerRegistrationResponse {
+    orgEntityId: string;
+    userId: string;
+    resourceName?: string;
+}
+/** A single store attribute as returned in the storelocator response. */
+export interface HclStoreAttribute {
+    name: string;
+    value: string;
+    displayName?: string;
+    displayValue?: string;
+}
+/** A description block for a physical store. */
+export interface HclStoreDescription {
+    displayStoreName?: string;
+}
+/**
+ * A single physical store entry as returned by the WCS storelocator endpoints.
+ * Reference: location_based_services.yaml — storelocator-storelocator_item
+ */
+export interface HclPhysicalStore {
+    uniqueID: string;
+    /** Store name as configured in WCS (fallback when Description[].displayStoreName is absent). */
+    storeName?: string;
+    /** Array of description blocks; index 0 typically contains displayStoreName. */
+    Description?: HclStoreDescription[];
+    /** Street address lines. Index 0 = primary line, index 1 = second line. */
+    addressLine?: string[];
+    city?: string;
+    stateOrProvinceName?: string;
+    postalCode?: string;
+    country?: string;
+    telephone1?: string;
+    email?: string;
+    /** Geographic latitude (as a string — coerce with Number()). */
+    latitude?: string;
+    /** Geographic longitude (as a string — coerce with Number()). */
+    longitude?: string;
+    /** Distance from the query point (as a string — coerce with Number()). */
+    distance?: string;
+    Attribute?: HclStoreAttribute[];
+    userDataField?: {
+        value?: string;
+        key: string;
+    }[];
+}
+/**
+ * Top-level response from GET /wcs/resources/store/{storeId}/storelocator/latitude/{lat}/longitude/{lon}.
+ */
+export interface HclStoreLocatorResponse {
+    PhysicalStore?: HclPhysicalStore[];
+    recordSetTotal?: string;
+    recordSetCount?: string;
+    recordSetStartNumber?: string;
+    recordSetComplete?: string;
+}
+/**
+ * A single item entry within a wishlist — from GET /wishlist/{id}/item.
+ */
+export interface HclWishlistItem {
+    /** Unique identifier for the wishlist item entry. */
+    giftListItemID?: string;
+    /** Internal WCS catalog entry ID (numeric string). Corresponds to a SKU. */
+    productId?: string;
+    /** SKU part number — use this as the variant identifier when present. */
+    partNumber?: string;
+    /** Requested quantity as a string — coerce with Number(). */
+    quantityRequested?: string;
+    /** Purchased quantity as a string. */
+    quantityBought?: string;
+    location?: string;
+}
+/**
+ * A single wishlist (GiftList) entry as returned by GET /wishlist/@self.
+ */
+export interface HclWishlist {
+    /** Internal WCS list ID. */
+    uniqueID?: string;
+    /** Customer-assigned external identifier. Alias for uniqueID on some responses. */
+    externalIdentifier?: string;
+    /** The list's display name. */
+    descriptionName?: string;
+    /** The list's optional description text. */
+    description?: string;
+    lastUpdate?: string;
+    guestAccessKey?: string;
+    /** Items embedded in the list (present when fetching a specific list with items). */
+    item?: HclWishlistItem[];
+}
+/** Top-level response from GET /wcs/resources/store/{storeId}/wishlist/@self. */
+export interface HclWishlistListResponse {
+    GiftList?: HclWishlist[];
+    recordSetTotal?: string;
+    recordSetCount?: string;
+    recordSetStartNumber?: string;
+    recordSetComplete?: string;
+}
+/** Top-level response from GET /wcs/resources/store/{storeId}/wishlist/{id}/item. */
+export interface HclWishlistItemResponse {
+    GiftList?: HclWishlist[];
+    recordSetTotal?: string;
+    recordSetCount?: string;
+    recordSetStartNumber?: string;
+}
+/** Response from POST /wishlist (create) and PUT /wishlist/{id} (update). */
+export interface HclWishlistMutationResponse {
+    uniqueID?: string;
+    externalIdentifier?: string;
+    resourceName?: string;
+}
+/** A single item in a WCS requisition list. */
+export interface HclRequisitionListItem {
+    /** Unique identifier of the item within the list. */
+    requisitionListItemId?: string;
+    /** Numeric product identifier (same semantics as GiftList item.productId). */
+    productId?: string;
+    /** Partner number / SKU. */
+    partNumber?: string;
+    /** Requested quantity as a string. */
+    quantity?: string;
+    /** Location (e.g. "online"). */
+    location?: string;
+}
+/** A single WCS requisition list (from GET /requisitionList/@self or by ID). */
+export interface HclRequisitionList {
+    /** Unique identifier of the list. */
+    requisitionListId?: string;
+    /** Display name of the list. */
+    name?: string;
+    /** Description of the list. */
+    description?: string;
+    /** Items in the list (only present on detail endpoints). */
+    item?: HclRequisitionListItem[];
+}
+/** Response from GET /requisitionList/@self — array of lists. */
+export interface HclRequisitionListResponse {
+    resultList?: HclRequisitionList[];
+    recordSetTotal?: string;
+    recordSetCount?: string;
+    recordSetStartNumber?: string;
+}
+/** Response from GET /requisitionList/{id}/item. */
+export interface HclRequisitionListDetailResponse {
+    resultList?: HclRequisitionList[];
+    recordSetTotal?: string;
+}
+/** Response from POST /requisitionList (create) and PUT /requisitionList/{id}. */
+export interface HclRequisitionListMutationResponse {
+    requisitionListId?: string;
+    resourceName?: string;
+}

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

@@ -4,6 +4,7 @@ export declare function getHclTestConfiguration(): HclConfiguration;
 export declare function createHclClient(contextOverrides?: Partial<RequestContext>): Omit<import("@reactionary/core").Client, "product" | "productSearch" | "category"> & Omit<import("@reactionary/core").ClientFromCapabilities<{
     product?: true | undefined;
     productSearch?: true | undefined;
+    company?: false | undefined;
     price?: false | undefined;
     order?: false | undefined;
     cart?: false | undefined;
@@ -12,8 +13,10 @@ 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" | "price" | "order" | "cart" | "checkout" | "identity" | "profile" | "inventory" | "category" | "orderSearch"> & {
+}>, "product" | "productSearch" | "company" | "price" | "order" | "cart" | "checkout" | "identity" | "profile" | "inventory" | "category" | "store" | "productList" | "orderSearch"> & {
     product: import("../index.js").HclProductCapability<import("../index.js").HclProductFactory<import("zod").ZodObject<{
         identifier: import("zod").ZodObject<{
             key: import("zod").ZodString;