@reactionary/magento 0.0.1 → 0.10.19

package/capabilities/order-search.capability.js

@@ -0,0 +1,150 @@
+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 {
+  OrderSearchCapability,
+  OrderSearchQueryByTermSchema,
+  OrderSearchResultSchema,
+  Reactionary,
+  success
+} from "@reactionary/core";
+import createDebug from "debug";
+const debug = createDebug("reactionary:magento:order-search");
+class MagentoOrderSearchCapability extends OrderSearchCapability {
+  constructor(config, cache, context, magentoApi, factory) {
+    super(cache, context);
+    this.magentoApi = magentoApi;
+    this.config = config;
+    this.factory = factory;
+  }
+  magentoApi;
+  config;
+  factory;
+  emptyResult(payload) {
+    return this.factory.parseOrderSearchResult(
+      this.context,
+      {
+        items: [],
+        total_count: 0,
+        search_criteria: {
+          page_size: payload.search.paginationOptions.pageSize,
+          current_page: payload.search.paginationOptions.pageNumber
+        }
+      },
+      payload
+    );
+  }
+  async resolveCustomerId() {
+    try {
+      const me = await this.magentoApi.getMe();
+      return me?.id !== void 0 ? String(me.id) : null;
+    } catch (err) {
+      debug("resolveCustomerId: not authenticated: %O", err);
+      return null;
+    }
+  }
+  buildSearchParams(payload, customerId) {
+    const params = new URLSearchParams();
+    let group = 0;
+    const addFilter = (field, value, condition = "eq") => {
+      params.set(
+        `searchCriteria[filterGroups][${group}][filters][0][field]`,
+        field
+      );
+      params.set(
+        `searchCriteria[filterGroups][${group}][filters][0][value]`,
+        value
+      );
+      params.set(
+        `searchCriteria[filterGroups][${group}][filters][0][condition_type]`,
+        condition
+      );
+      group += 1;
+    };
+    addFilter("customer_id", customerId);
+    if (payload.search.term) {
+      addFilter("increment_id", `%${payload.search.term}%`, "like");
+    }
+    if (payload.search.orderStatus && payload.search.orderStatus.length > 0) {
+      const magentoStatuses = Array.from(
+        new Set(
+          payload.search.orderStatus.flatMap((status) => {
+            switch (status) {
+              case "ReleasedToFulfillment":
+                return ["processing"];
+              case "Shipped":
+                return ["complete", "closed"];
+              case "Cancelled":
+                return ["canceled"];
+              default:
+                return ["pending"];
+            }
+          })
+        )
+      );
+      addFilter("status", magentoStatuses.join(","), "in");
+    }
+    if (payload.search.startDate) {
+      addFilter("created_at", payload.search.startDate, "gteq");
+    }
+    if (payload.search.endDate) {
+      addFilter("created_at", payload.search.endDate, "lteq");
+    }
+    params.set(
+      "searchCriteria[pageSize]",
+      String(payload.search.paginationOptions.pageSize)
+    );
+    params.set(
+      "searchCriteria[currentPage]",
+      String(payload.search.paginationOptions.pageNumber)
+    );
+    params.set("searchCriteria[sortOrders][0][field]", "created_at");
+    params.set("searchCriteria[sortOrders][0][direction]", "DESC");
+    return params;
+  }
+  async queryByTerm(payload) {
+    const customerId = await this.resolveCustomerId();
+    if (!customerId) {
+      return success(this.emptyResult(payload));
+    }
+    let response = await this.magentoApi.searchOrders(
+      this.buildSearchParams(payload, customerId)
+    );
+    if (payload.search.partNumber && payload.search.partNumber.length > 0) {
+      response = this.filterByPartNumber(response, payload.search.partNumber);
+    }
+    const result = this.factory.parseOrderSearchResult(
+      this.context,
+      response,
+      payload
+    );
+    return success(result);
+  }
+  filterByPartNumber(response, partNumbers) {
+    const items = (response.items ?? []).filter((order) => {
+      const skus = (order.items ?? []).map((i) => i.sku);
+      return partNumbers.every((pn) => skus.includes(pn));
+    });
+    return {
+      ...response,
+      items,
+      total_count: items.length
+    };
+  }
+}
+__decorateClass([
+  Reactionary({
+    inputSchema: OrderSearchQueryByTermSchema,
+    outputSchema: OrderSearchResultSchema
+  })
+], MagentoOrderSearchCapability.prototype, "queryByTerm", 1);
+export {
+  MagentoOrderSearchCapability
+};

package/capabilities/order.capability.js

@@ -0,0 +1,51 @@
+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 {
+  OrderCapability,
+  OrderQueryByIdSchema,
+  OrderSchema,
+  Reactionary,
+  error,
+  success
+} from "@reactionary/core";
+import createDebug from "debug";
+const debug = createDebug("reactionary:magento:order");
+class MagentoOrderCapability extends OrderCapability {
+  constructor(config, cache, context, magentoApi, factory) {
+    super(cache, context);
+    this.magentoApi = magentoApi;
+    this.config = config;
+    this.factory = factory;
+  }
+  magentoApi;
+  config;
+  factory;
+  async getById(payload) {
+    debug("getById %s", payload.order.key);
+    const data = await this.magentoApi.getOrderById(payload.order.key);
+    if (!data) {
+      return error({
+        type: "NotFound",
+        identifier: payload.order
+      });
+    }
+    return success(this.factory.parseOrder(this.context, data));
+  }
+}
+__decorateClass([
+  Reactionary({
+    inputSchema: OrderQueryByIdSchema,
+    outputSchema: OrderSchema
+  })
+], MagentoOrderCapability.prototype, "getById", 1);
+export {
+  MagentoOrderCapability
+};

package/capabilities/price.capability.js

@@ -5,8 +5,7 @@ var __decorateClass = (decorators, target, key, kind) => {
   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);
+  if (kind && result) __defProp(target, key, result);
   return result;
 };
 import {
@@ -26,6 +25,7 @@ class MagentoPriceCapability extends PriceCapability {
     this.config = config;
     this.factory = factory;
   }
+  magentoApi;
   config;
   factory;
   async getListPrice(payload) {

package/capabilities/product-associations.capability.js

@@ -0,0 +1,118 @@
+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,
+  Reactionary,
+  success
+} from "@reactionary/core";
+import createDebug from "debug";
+import {
+  fetchProductsBySkus,
+  resolveProductSku
+} from "../utils/magento-product-lookup.js";
+const debug = createDebug("reactionary:magento:product-associations");
+class MagentoProductAssociationsCapability extends ProductAssociationsCapability {
+  constructor(config, cache, context, magentoApi, factory) {
+    super(cache, context);
+    this.magentoApi = magentoApi;
+    this.config = config;
+    this.factory = factory;
+  }
+  magentoApi;
+  config;
+  factory;
+  getAccessoriesLinkType() {
+    return "related";
+  }
+  getSparepartsLinkType() {
+    return "crosssell";
+  }
+  getReplacementsLinkType() {
+    return "upsell";
+  }
+  async fetchAssociatedProductsFor(forProduct, linkType, maxNumberOfAssociations) {
+    const sku = await resolveProductSku(this.magentoApi, forProduct.key);
+    if (!sku) {
+      return [];
+    }
+    try {
+      const links = await this.magentoApi.getProductLinks(sku, linkType);
+      const linkedSkus = [...links].sort((a, b) => (a.position ?? 0) - (b.position ?? 0)).map((link) => link.linked_product_sku).slice(0, maxNumberOfAssociations);
+      return await fetchProductsBySkus(this.magentoApi, linkedSkus);
+    } catch (err) {
+      debug("Failed to load %s links for %s: %O", linkType, sku, err);
+      return [];
+    }
+  }
+  toAssociations(forProduct, associationType, products) {
+    return products.map(
+      (product) => this.factory.parseAssociation(this.context, {
+        product,
+        identifier: {
+          key: `${forProduct.key}-${associationType}-${product.sku}`
+        }
+      })
+    );
+  }
+  async getAccessories(query) {
+    const products = await this.fetchAssociatedProductsFor(
+      query.forProduct,
+      this.getAccessoriesLinkType(),
+      query.numberOfAccessories
+    );
+    return success(this.toAssociations(query.forProduct, "accessory", products));
+  }
+  async getSpareparts(query) {
+    const products = await this.fetchAssociatedProductsFor(
+      query.forProduct,
+      this.getSparepartsLinkType(),
+      query.numberOfSpareparts
+    );
+    return success(this.toAssociations(query.forProduct, "sparepart", products));
+  }
+  async getReplacements(query) {
+    const products = await this.fetchAssociatedProductsFor(
+      query.forProduct,
+      this.getReplacementsLinkType(),
+      query.numberOfReplacements
+    );
+    return success(
+      this.toAssociations(query.forProduct, "replacement", products)
+    );
+  }
+}
+__decorateClass([
+  Reactionary({
+    cache: true,
+    cacheTimeToLiveInSeconds: 300,
+    currencyDependentCaching: false,
+    localeDependentCaching: false
+  })
+], MagentoProductAssociationsCapability.prototype, "getAccessories", 1);
+__decorateClass([
+  Reactionary({
+    cache: true,
+    cacheTimeToLiveInSeconds: 300,
+    currencyDependentCaching: false,
+    localeDependentCaching: false
+  })
+], MagentoProductAssociationsCapability.prototype, "getSpareparts", 1);
+__decorateClass([
+  Reactionary({
+    cache: true,
+    cacheTimeToLiveInSeconds: 300,
+    currencyDependentCaching: false,
+    localeDependentCaching: false
+  })
+], MagentoProductAssociationsCapability.prototype, "getReplacements", 1);
+export {
+  MagentoProductAssociationsCapability
+};

package/capabilities/product-recommendations.capability.js

@@ -0,0 +1,148 @@
+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 {
+  ProductRecommendationsCapability,
+  Reactionary,
+  success
+} from "@reactionary/core";
+import createDebug from "debug";
+import {
+  fetchProductsBySkus,
+  fetchProductsInCategory,
+  findCategoryByName,
+  resolveProductSku
+} from "../utils/magento-product-lookup.js";
+import { buildProductSearchResultItem } from "../utils/magento-product.js";
+const debug = createDebug("reactionary:magento:product-recommendations");
+class MagentoProductRecommendationsCapability extends ProductRecommendationsCapability {
+  constructor(config, cache, context, magentoApi) {
+    super(cache, context);
+    this.magentoApi = magentoApi;
+    this.config = config;
+  }
+  magentoApi;
+  config;
+  getRelatedLinkType() {
+    return "related";
+  }
+  getSimilarLinkType() {
+    return "upsell";
+  }
+  getFrequentlyBoughtTogetherLinkType() {
+    return "crosssell";
+  }
+  toRecommendations(algorithm, keyPrefix, products) {
+    return products.map(
+      (product) => ({
+        recommendationIdentifier: {
+          key: `${keyPrefix}_${product.sku}`,
+          algorithm
+        },
+        recommendationReturnType: "productSearchResultItem",
+        product: buildProductSearchResultItem(this.config, product)
+      })
+    );
+  }
+  async fetchLinkedProducts(sourceProduct, linkType, numberOfRecommendations) {
+    const sku = await resolveProductSku(this.magentoApi, sourceProduct.key);
+    if (!sku) {
+      return [];
+    }
+    try {
+      const links = await this.magentoApi.getProductLinks(sku, linkType);
+      const linkedSkus = [...links].sort((a, b) => (a.position ?? 0) - (b.position ?? 0)).map((link) => link.linked_product_sku).slice(0, numberOfRecommendations);
+      return await fetchProductsBySkus(this.magentoApi, linkedSkus);
+    } catch (err) {
+      debug("Failed to load %s links for %s: %O", linkType, sku, err);
+      return [];
+    }
+  }
+  async getCollection(query) {
+    const category = await findCategoryByName(
+      this.magentoApi,
+      query.collectionName
+    );
+    if (!category) {
+      debug("Collection not found: %s", query.collectionName);
+      return success([]);
+    }
+    try {
+      const products = await fetchProductsInCategory(
+        this.magentoApi,
+        String(category.id),
+        query.numberOfRecommendations
+      );
+      return success(
+        this.toRecommendations("collection", String(category.id), products)
+      );
+    } catch (err) {
+      debug("Failed to load products for collection %s: %O", query.collectionName, err);
+      return success([]);
+    }
+  }
+  async getRelatedProductsRecommendations(query) {
+    const products = await this.fetchLinkedProducts(
+      query.sourceProduct,
+      this.getRelatedLinkType(),
+      query.numberOfRecommendations
+    );
+    return this.toRecommendations("related", query.sourceProduct.key, products);
+  }
+  async getSimilarProductsRecommendations(query) {
+    const products = await this.fetchLinkedProducts(
+      query.sourceProduct,
+      this.getSimilarLinkType(),
+      query.numberOfRecommendations
+    );
+    return this.toRecommendations("similar", query.sourceProduct.key, products);
+  }
+  async getFrequentlyBoughtTogetherRecommendations(query) {
+    const products = await this.fetchLinkedProducts(
+      query.sourceProduct,
+      this.getFrequentlyBoughtTogetherLinkType(),
+      query.numberOfRecommendations
+    );
+    return this.toRecommendations(
+      "frequentlyBoughtTogether",
+      query.sourceProduct.key,
+      products
+    );
+  }
+  async getTrendingInCategoryRecommendations(query) {
+    const category = await findCategoryByName(
+      this.magentoApi,
+      query.sourceCategory.key
+    );
+    const categoryId = category ? String(category.id) : query.sourceCategory.key;
+    try {
+      const products = await fetchProductsInCategory(
+        this.magentoApi,
+        categoryId,
+        query.numberOfRecommendations
+      );
+      return this.toRecommendations("trendingInCategory", categoryId, products);
+    } catch (err) {
+      debug("Failed to load trending products for category %s: %O", categoryId, err);
+      return [];
+    }
+  }
+}
+__decorateClass([
+  Reactionary({
+    cache: true,
+    cacheTimeToLiveInSeconds: 300,
+    currencyDependentCaching: false,
+    localeDependentCaching: false
+  })
+], MagentoProductRecommendationsCapability.prototype, "getCollection", 1);
+export {
+  MagentoProductRecommendationsCapability
+};

package/capabilities/product-reviews.capability.js

@@ -0,0 +1,182 @@
+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 {
+  ProductRatingSummarySchema,
+  ProductReviewMutationSubmitSchema,
+  ProductReviewPaginatedResultSchema,
+  ProductReviewSchema,
+  ProductReviewsCapability,
+  ProductReviewsGetRatingSummaryQuerySchema,
+  ProductReviewsListQuerySchema,
+  Reactionary,
+  error,
+  success
+} from "@reactionary/core";
+import createDebug from "debug";
+import { resolveProductSku } from "../utils/magento-product-lookup.js";
+const debug = createDebug("reactionary:magento:product-reviews");
+const DEFAULT_PAGE_SIZE = 20;
+const DEFAULT_REVIEW_RATING_CODE = "Rating";
+class MagentoProductReviewsCapability extends ProductReviewsCapability {
+  constructor(config, cache, context, magentoApi, factory) {
+    super(cache, context);
+    this.magentoApi = magentoApi;
+    this.config = config;
+    this.factory = factory;
+  }
+  magentoApi;
+  config;
+  factory;
+  /**
+   * The name of the Magento rating that carries the overall star score. Stores
+   * can define several named ratings; override to pick a different one.
+   */
+  getReviewRatingCode() {
+    return this.config.reviewRatingCode ?? DEFAULT_REVIEW_RATING_CODE;
+  }
+  async fetchRatingSummary(sku) {
+    try {
+      return await this.magentoApi.getProductReviewSummary(sku);
+    } catch (err) {
+      debug("Failed to load the rating summary for %s: %O", sku, err);
+      return null;
+    }
+  }
+  async fetchReviews(sku, pageSize, pageNumber) {
+    try {
+      return await this.magentoApi.getProductReviews(sku, pageSize, pageNumber);
+    } catch (err) {
+      debug("Failed to load reviews for %s: %O", sku, err);
+      return null;
+    }
+  }
+  /**
+   * Magento will not accept a star count directly — the rating has to be sent
+   * as an opaque `value_id` looked up through `productReviewRatingsMetadata`.
+   */
+  async resolveRatingInput(rating) {
+    const metadata = await this.magentoApi.getProductReviewRatingsMetadata();
+    const wantedCode = this.getReviewRatingCode().toLowerCase();
+    const entry = metadata.find((item) => item.name.toLowerCase() === wantedCode) ?? metadata[0];
+    if (!entry) {
+      return null;
+    }
+    const wantedValue = String(Math.round(rating));
+    const value = entry.values.find((item) => item.value === wantedValue);
+    if (!value) {
+      return null;
+    }
+    return [{ id: entry.id, value_id: value.value_id }];
+  }
+  async getRatingSummary(query) {
+    const sku = await resolveProductSku(this.magentoApi, query.product.key);
+    const product = sku ? await this.fetchRatingSummary(sku) : null;
+    return success(
+      this.factory.parseRatingSummary(this.context, {
+        product: query.product,
+        ratingSummary: product?.rating_summary,
+        reviewCount: product?.review_count
+      })
+    );
+  }
+  async findReviews(query) {
+    const pageSize = query.paginationOptions?.pageSize ?? DEFAULT_PAGE_SIZE;
+    const pageNumber = query.paginationOptions?.pageNumber ?? 1;
+    const sku = await resolveProductSku(this.magentoApi, query.product.key);
+    const product = sku ? await this.fetchReviews(sku, pageSize, pageNumber) : null;
+    const reviews = product?.reviews?.items ?? [];
+    return success(
+      this.factory.parseReviewPaginatedResult(this.context, {
+        product: query.product,
+        sku: sku ?? query.product.key,
+        reviews,
+        totalCount: product?.review_count ?? reviews.length,
+        pageSize,
+        pageNumber
+      })
+    );
+  }
+  async submitReview(mutation) {
+    if (this.context.session.identityContext.identity.type !== "Registered") {
+      return error({
+        type: "InvalidInput",
+        error: "Only registered users can submit reviews."
+      });
+    }
+    const sku = await resolveProductSku(this.magentoApi, mutation.product.key);
+    if (!sku) {
+      return error({
+        type: "NotFound",
+        identifier: mutation.product
+      });
+    }
+    const ratings = await this.resolveRatingInput(mutation.rating);
+    if (!ratings) {
+      return error({
+        type: "Generic",
+        message: `Magento has no review rating "${this.getReviewRatingCode()}" with a value of ${mutation.rating}. Check the store's review rating configuration.`
+      });
+    }
+    const review = await this.magentoApi.createProductReview({
+      sku,
+      nickname: mutation.authorName,
+      summary: mutation.title,
+      text: mutation.content,
+      ratings
+    });
+    if (!review) {
+      return error({
+        type: "Generic",
+        message: `Magento accepted the review for ${sku} but returned no review payload.`
+      });
+    }
+    return success(
+      this.factory.parseReview(this.context, {
+        product: mutation.product,
+        sku,
+        review
+      })
+    );
+  }
+}
+__decorateClass([
+  Reactionary({
+    inputSchema: ProductReviewsGetRatingSummaryQuerySchema,
+    outputSchema: ProductRatingSummarySchema,
+    cache: true,
+    cacheTimeToLiveInSeconds: 300,
+    currencyDependentCaching: false,
+    localeDependentCaching: false
+  })
+], MagentoProductReviewsCapability.prototype, "getRatingSummary", 1);
+__decorateClass([
+  Reactionary({
+    inputSchema: ProductReviewsListQuerySchema,
+    outputSchema: ProductReviewPaginatedResultSchema,
+    cache: true,
+    cacheTimeToLiveInSeconds: 60,
+    currencyDependentCaching: false,
+    localeDependentCaching: true
+  })
+], MagentoProductReviewsCapability.prototype, "findReviews", 1);
+__decorateClass([
+  Reactionary({
+    inputSchema: ProductReviewMutationSubmitSchema,
+    outputSchema: ProductReviewSchema,
+    cache: false,
+    cacheTimeToLiveInSeconds: 0,
+    currencyDependentCaching: false,
+    localeDependentCaching: false
+  })
+], MagentoProductReviewsCapability.prototype, "submitReview", 1);
+export {
+  MagentoProductReviewsCapability
+};

package/capabilities/product-search.capability.js

@@ -5,8 +5,7 @@ var __decorateClass = (decorators, target, key, kind) => {
   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);
+  if (kind && result) __defProp(target, key, result);
   return result;
 };
 import {
@@ -27,6 +26,7 @@ class MagentoProductSearchCapability extends ProductSearchCapability {
     this.config = config;
     this.factory = factory;
   }
+  magentoApi;
   config;
   factory;
   async queryByTerm(payload) {