@reactionary/hcl 0.9.12 → 0.9.14

package/capabilities/analytics.capability.js

@@ -0,0 +1,98 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result)
+    __defProp(target, key, result);
+  return result;
+};
+import {
+  AnalyticsCapability,
+  AnalyticsMutationSchema,
+  AnalyticsResultSchema,
+  Reactionary
+} from "@reactionary/core";
+import { SESSION_KEY_PERSONALIZATION_ID } from "../core/session-keys.js";
+class HclAnalyticsCapability extends AnalyticsCapability {
+  constructor(cache, context, config, client) {
+    super(cache, context);
+    this.config = config;
+    this.client = client;
+  }
+  async track(event) {
+    return super.track(event);
+  }
+  async processProductSummaryView(event) {
+    try {
+      for (const product of event.products) {
+        await this.fireEvent({ productId: product.key });
+      }
+      return this.accepted();
+    } catch {
+      return this.rejected();
+    }
+  }
+  async processProductSummaryClick(event) {
+    try {
+      await this.fireEvent({ productId: event.product.key });
+      return this.accepted();
+    } catch {
+      return this.rejected();
+    }
+  }
+  async processProductDetailsView(event) {
+    try {
+      await this.fireEvent({ productId: event.product.key });
+      return this.accepted();
+    } catch {
+      return this.rejected();
+    }
+  }
+  async processProductAddToCart(event) {
+    try {
+      await this.fireEvent({ productId: event.product.key });
+      return this.accepted();
+    } catch {
+      return this.rejected();
+    }
+  }
+  async processPurchase(event) {
+    try {
+      for (const item of event.order.items) {
+        await this.fireEvent({ productId: item.variant.sku });
+      }
+      return this.accepted();
+    } catch {
+      return this.rejected();
+    }
+  }
+  async fireEvent(extra) {
+    await this.client.callPost(
+      this.getEventUrl(),
+      this.getEventBody(extra)
+    );
+  }
+  getEventUrl() {
+    return `${this.client.transactionBaseUrl}/event`;
+  }
+  getEventBody(extra) {
+    const personalizationID = this.context.session[SESSION_KEY_PERSONALIZATION_ID];
+    const body = { ...extra };
+    if (personalizationID) {
+      body["personalizationID"] = personalizationID;
+    }
+    return body;
+  }
+}
+__decorateClass([
+  Reactionary({
+    inputSchema: AnalyticsMutationSchema,
+    outputSchema: AnalyticsResultSchema
+  })
+], HclAnalyticsCapability.prototype, "track", 1);
+export {
+  HclAnalyticsCapability
+};

package/capabilities/company.capability.js

@@ -0,0 +1,307 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result)
+    __defProp(target, key, result);
+  return result;
+};
+import {
+  CompanyCapability,
+  CompanyMutationAddShippingAddressSchema,
+  CompanyMutationMakeShippingAddressDefaultSchema,
+  CompanyMutationRemoveShippingAddressSchema,
+  CompanyMutationUpdateShippingAddressSchema,
+  CompanyPaginatedListSchema,
+  CompanyQueryByIdSchema,
+  CompanyQueryListSchema,
+  Reactionary,
+  error,
+  success
+} from "@reactionary/core";
+import createDebug from "debug";
+const debug = createDebug("reactionary:hcl:company");
+class HclCompanyCapability extends CompanyCapability {
+  config;
+  client;
+  factory;
+  constructor(cache, context, config, client, factory) {
+    super(cache, context);
+    this.config = config;
+    this.client = client;
+    this.factory = factory;
+  }
+  async getById(payload) {
+    debug("getById %s", payload.identifier.taxIdentifier);
+    const raw = await this.client.callGet(
+      this.getOrganizationUrl(payload.identifier.taxIdentifier),
+      this.getOrganizationDetailsParams(),
+      { allowUndefined: true }
+    );
+    if (!raw) {
+      return error({
+        type: "NotFound",
+        identifier: payload.identifier
+      });
+    }
+    return success(
+      this.factory.parseCompany(
+        this.context,
+        raw
+      )
+    );
+  }
+  async listCompanies(payload) {
+    debug(
+      "listCompanies page=%d size=%d",
+      payload.search.paginationOptions.pageNumber,
+      payload.search.paginationOptions.pageSize
+    );
+    const response = await this.client.callGet(
+      this.getOrganizationListUrl(),
+      this.getOrganizationListParams(payload)
+    );
+    return success(
+      this.factory.parseCompanyPaginatedList(this.context, response, payload)
+    );
+  }
+  async addShippingAddress(payload) {
+    debug(
+      "addShippingAddress %s \u2192 %s",
+      payload.company.taxIdentifier,
+      payload.address.identifier.nickName
+    );
+    const org = await this.fetchOrganization(payload.company.taxIdentifier);
+    if (!org) {
+      return error({
+        type: "NotFound",
+        identifier: payload.company
+      });
+    }
+    const addressBook = [
+      ...org.addressBook ?? [],
+      this.toOrgContact(payload.address)
+    ];
+    await this.client.callPut(
+      this.getUpdateOrganizationUrl(payload.company.taxIdentifier),
+      this.getUpdateOrganizationBody(org, addressBook)
+    );
+    return success(
+      this.factory.parseCompany(
+        this.context,
+        await this.fetchOrganizationOrThrow(payload.company.taxIdentifier)
+      )
+    );
+  }
+  async updateShippingAddress(payload) {
+    debug(
+      "updateShippingAddress %s \u2192 %s",
+      payload.company.taxIdentifier,
+      payload.address.identifier.nickName
+    );
+    const org = await this.fetchOrganization(payload.company.taxIdentifier);
+    if (!org) {
+      return error({
+        type: "NotFound",
+        identifier: payload.company
+      });
+    }
+    const existing = (org.addressBook ?? []).find(
+      (a) => a.nickName === payload.address.identifier.nickName
+    );
+    if (!existing) {
+      return error({
+        type: "NotFound",
+        identifier: payload.address.identifier
+      });
+    }
+    const addressBook = (org.addressBook ?? []).map(
+      (a) => a.nickName === payload.address.identifier.nickName ? { ...this.toOrgContact(payload.address), primary: existing.primary } : a
+    );
+    await this.client.callPut(
+      this.getUpdateOrganizationUrl(payload.company.taxIdentifier),
+      this.getUpdateOrganizationBody(org, addressBook)
+    );
+    return success(
+      this.factory.parseCompany(
+        this.context,
+        await this.fetchOrganizationOrThrow(payload.company.taxIdentifier)
+      )
+    );
+  }
+  async removeShippingAddress(payload) {
+    debug(
+      "removeShippingAddress %s \u2192 %s",
+      payload.company.taxIdentifier,
+      payload.addressIdentifier.nickName
+    );
+    const org = await this.fetchOrganization(payload.company.taxIdentifier);
+    if (!org) {
+      return error({
+        type: "NotFound",
+        identifier: payload.company
+      });
+    }
+    const existing = (org.addressBook ?? []).find(
+      (a) => a.nickName === payload.addressIdentifier.nickName
+    );
+    if (!existing) {
+      return error({
+        type: "NotFound",
+        identifier: payload.addressIdentifier
+      });
+    }
+    const addressBook = (org.addressBook ?? []).filter(
+      (a) => a.nickName !== payload.addressIdentifier.nickName
+    );
+    await this.client.callPut(
+      this.getUpdateOrganizationUrl(payload.company.taxIdentifier),
+      this.getUpdateOrganizationBody(org, addressBook)
+    );
+    return success(
+      this.factory.parseCompany(
+        this.context,
+        await this.fetchOrganizationOrThrow(payload.company.taxIdentifier)
+      )
+    );
+  }
+  async makeShippingAddressDefault(payload) {
+    debug(
+      "makeShippingAddressDefault %s \u2192 %s",
+      payload.company.taxIdentifier,
+      payload.addressIdentifier.nickName
+    );
+    const org = await this.fetchOrganization(payload.company.taxIdentifier);
+    if (!org) {
+      return error({
+        type: "NotFound",
+        identifier: payload.company
+      });
+    }
+    const existing = (org.addressBook ?? []).find(
+      (a) => a.nickName === payload.addressIdentifier.nickName
+    );
+    if (!existing) {
+      return error({
+        type: "NotFound",
+        identifier: payload.addressIdentifier
+      });
+    }
+    const addressBook = (org.addressBook ?? []).map((a) => ({
+      ...a,
+      primary: a.nickName === payload.addressIdentifier.nickName ? "1" : void 0
+    }));
+    await this.client.callPut(
+      this.getUpdateOrganizationUrl(payload.company.taxIdentifier),
+      this.getUpdateOrganizationBody(org, addressBook)
+    );
+    return success(
+      this.factory.parseCompany(
+        this.context,
+        await this.fetchOrganizationOrThrow(payload.company.taxIdentifier)
+      )
+    );
+  }
+  // ---------------------------------------------------------------------------
+  // Extension points
+  // ---------------------------------------------------------------------------
+  getOrganizationUrl(orgId) {
+    return `${this.client.transactionBaseUrl}/organization/${encodeURIComponent(orgId)}`;
+  }
+  getOrganizationDetailsParams() {
+    const params = new URLSearchParams();
+    params.set("profileName", "IBM_Organization_Details");
+    return params;
+  }
+  getOrganizationListUrl() {
+    return `${this.client.transactionBaseUrl}/organization`;
+  }
+  getOrganizationListParams(query) {
+    const { pageSize, pageNumber } = query.search.paginationOptions;
+    const params = new URLSearchParams();
+    params.set("q", "organizationsICanAdmin");
+    params.set("profileName", "IBM_Organization_List_Summary");
+    params.set("maxResults", String(pageSize));
+    params.set("startIndex", String((pageNumber - 1) * pageSize));
+    return params;
+  }
+  getUpdateOrganizationUrl(orgId) {
+    return `${this.client.transactionBaseUrl}/organization/${encodeURIComponent(orgId)}`;
+  }
+  getUpdateOrganizationBody(org, addressBook) {
+    return { addressBook };
+  }
+  // ---------------------------------------------------------------------------
+  // Internal helpers
+  // ---------------------------------------------------------------------------
+  async fetchOrganization(orgId) {
+    return this.client.callGet(
+      this.getOrganizationUrl(orgId),
+      this.getOrganizationDetailsParams(),
+      { allowUndefined: true }
+    );
+  }
+  async fetchOrganizationOrThrow(orgId) {
+    const org = await this.fetchOrganization(orgId);
+    if (!org)
+      throw new Error(`Organization not found: ${orgId}`);
+    return org;
+  }
+  toOrgContact(address) {
+    const lines = [address.streetAddress, address.streetNumber].filter(
+      Boolean
+    );
+    return {
+      nickName: address.identifier.nickName,
+      firstName: address.firstName,
+      lastName: address.lastName,
+      addressLine: lines.length ? lines : void 0,
+      city: address.city,
+      stateOrProvinceName: address.region,
+      zipCode: address.postalCode,
+      country: address.countryCode
+    };
+  }
+}
+__decorateClass([
+  Reactionary({
+    inputSchema: CompanyQueryByIdSchema,
+    outputSchema: CompanyPaginatedListSchema
+  })
+], HclCompanyCapability.prototype, "getById", 1);
+__decorateClass([
+  Reactionary({
+    inputSchema: CompanyQueryListSchema,
+    outputSchema: CompanyPaginatedListSchema
+  })
+], HclCompanyCapability.prototype, "listCompanies", 1);
+__decorateClass([
+  Reactionary({
+    inputSchema: CompanyMutationAddShippingAddressSchema,
+    outputSchema: CompanyPaginatedListSchema
+  })
+], HclCompanyCapability.prototype, "addShippingAddress", 1);
+__decorateClass([
+  Reactionary({
+    inputSchema: CompanyMutationUpdateShippingAddressSchema,
+    outputSchema: CompanyPaginatedListSchema
+  })
+], HclCompanyCapability.prototype, "updateShippingAddress", 1);
+__decorateClass([
+  Reactionary({
+    inputSchema: CompanyMutationRemoveShippingAddressSchema,
+    outputSchema: CompanyPaginatedListSchema
+  })
+], HclCompanyCapability.prototype, "removeShippingAddress", 1);
+__decorateClass([
+  Reactionary({
+    inputSchema: CompanyMutationMakeShippingAddressDefaultSchema,
+    outputSchema: CompanyPaginatedListSchema
+  })
+], HclCompanyCapability.prototype, "makeShippingAddressDefault", 1);
+export {
+  HclCompanyCapability
+};

package/capabilities/personalization-profile.capability.js

@@ -0,0 +1,85 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result)
+    __defProp(target, key, result);
+  return result;
+};
+import {
+  PersonalizationProfileCapability,
+  PersonalizationProfileQueryGetProfileSchema,
+  PersonalizationProfileSchema,
+  Reactionary,
+  success
+} from "@reactionary/core";
+import { SESSION_KEY_PERSONALIZATION_ID } from "../core/session-keys.js";
+class HclPersonalizationProfileCapability extends PersonalizationProfileCapability {
+  constructor(cache, context, config, client, factory) {
+    super(cache, context);
+    this.config = config;
+    this.client = client;
+    this.factory = factory;
+  }
+  async getPersonalizationProfile(_payload) {
+    const personalizationId = this.context.session[SESSION_KEY_PERSONALIZATION_ID];
+    if (!personalizationId) {
+      return success(
+        this.factory.parsePersonalizationProfile(this.context, {
+          personalizationId: "anonymous",
+          segments: []
+        })
+      );
+    }
+    const segments = await this.fetchSegments(personalizationId);
+    return success(
+      this.factory.parsePersonalizationProfile(this.context, {
+        personalizationId,
+        segments
+      })
+    );
+  }
+  /**
+   * Calls the WCS segment API to retrieve the customer segments for the given
+   * personalization ID. Returns an empty array when the API call fails or
+   * returns no segment data.
+   */
+  async fetchSegments(personalizationId) {
+    try {
+      const response = await this.client.callGet(
+        this.getSegmentsUrl(),
+        this.getSegmentsParams(personalizationId),
+        { allowUndefined: true }
+      );
+      if (!response?.MemberGroup) {
+        return [];
+      }
+      return response.MemberGroup.map((g) => g.displayName?.value).filter(
+        (name) => name !== void 0 && name.length > 0
+      );
+    } catch {
+      return [];
+    }
+  }
+  getSegmentsUrl() {
+    return `${this.client.transactionBaseUrl}/segment`;
+  }
+  getSegmentsParams(personalizationId) {
+    const params = new URLSearchParams();
+    params.set("q", "byPersonalizationId");
+    params.set("qPersonalizationId", personalizationId);
+    return params;
+  }
+}
+__decorateClass([
+  Reactionary({
+    inputSchema: PersonalizationProfileQueryGetProfileSchema,
+    outputSchema: PersonalizationProfileSchema
+  })
+], HclPersonalizationProfileCapability.prototype, "getPersonalizationProfile", 1);
+export {
+  HclPersonalizationProfileCapability
+};

package/capabilities/product-associations.capability.js

@@ -0,0 +1,117 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result)
+    __defProp(target, key, result);
+  return result;
+};
+import {
+  ProductAssociationsCapability,
+  ProductAssociationSchema,
+  ProductAssociationsGetAccessoriesQuerySchema,
+  ProductAssociationsGetSparepartsQuerySchema,
+  ProductAssociationsGetReplacementsQuerySchema,
+  Reactionary,
+  success
+} from "@reactionary/core";
+import * as z from "zod";
+class HclProductAssociationsCapability extends ProductAssociationsCapability {
+  constructor(cache, context, config, client, factory) {
+    super(cache, context);
+    this.config = config;
+    this.client = client;
+    this.factory = factory;
+  }
+  async getAccessories(query) {
+    const associations = await this.fetchAssociations(
+      query.forProduct.key,
+      this.config.associationTypes.accessories,
+      query.numberOfAccessories
+    );
+    return success(
+      associations.map((a) => this.factory.parseAssociation(this.context, a))
+    );
+  }
+  async getSpareparts(query) {
+    const associations = await this.fetchAssociations(
+      query.forProduct.key,
+      this.config.associationTypes.spareparts,
+      query.numberOfSpareparts
+    );
+    return success(
+      associations.map((a) => this.factory.parseAssociation(this.context, a))
+    );
+  }
+  async getReplacements(query) {
+    const associations = await this.fetchAssociations(
+      query.forProduct.key,
+      this.config.associationTypes.replacements,
+      query.numberOfReplacements
+    );
+    return success(
+      associations.map((a) => this.factory.parseAssociation(this.context, a))
+    );
+  }
+  /**
+   * Fetches the product detail for the given part number and returns the
+   * `merchandisingAssociations` filtered to the requested association types,
+   * capped at `maxCount`.
+   */
+  async fetchAssociations(partNumber, types, maxCount) {
+    const response = await this.client.callGet(
+      this.getProductsUrl(),
+      this.getProductsParams(partNumber)
+    );
+    const product = (response.contents ?? response.catalogEntryView ?? [])[0];
+    if (!product?.merchandisingAssociations) {
+      return [];
+    }
+    return product.merchandisingAssociations.filter(
+      (a) => a.associationCodeType && types.includes(a.associationCodeType)
+    ).slice(0, maxCount);
+  }
+  getProductsUrl() {
+    return `${this.client.catalogBaseUrl}/api/v2/products`;
+  }
+  getProductsParams(partNumber) {
+    const params = new URLSearchParams();
+    params.set("storeId", this.config.storeId);
+    params.append("partNumber", partNumber);
+    params.set("profileName", this.config.profiles.product);
+    return params;
+  }
+}
+__decorateClass([
+  Reactionary({
+    inputSchema: ProductAssociationsGetAccessoriesQuerySchema,
+    outputSchema: z.array(ProductAssociationSchema),
+    cache: true,
+    cacheTimeToLiveInSeconds: 300,
+    currencyDependentCaching: false
+  })
+], HclProductAssociationsCapability.prototype, "getAccessories", 1);
+__decorateClass([
+  Reactionary({
+    inputSchema: ProductAssociationsGetSparepartsQuerySchema,
+    outputSchema: z.array(ProductAssociationSchema),
+    cache: true,
+    cacheTimeToLiveInSeconds: 300,
+    currencyDependentCaching: false
+  })
+], HclProductAssociationsCapability.prototype, "getSpareparts", 1);
+__decorateClass([
+  Reactionary({
+    inputSchema: ProductAssociationsGetReplacementsQuerySchema,
+    outputSchema: z.array(ProductAssociationSchema),
+    cache: true,
+    cacheTimeToLiveInSeconds: 300,
+    currencyDependentCaching: false
+  })
+], HclProductAssociationsCapability.prototype, "getReplacements", 1);
+export {
+  HclProductAssociationsCapability
+};