@reactionary/magento 0.0.1 → 0.10.19

package/core/product-reviews.graphql.js

@@ -0,0 +1,72 @@
+const REVIEW_FIELDS = `
+  average_rating
+  created_at
+  nickname
+  summary
+  text
+  ratings_breakdown {
+    name
+    value
+  }
+`;
+const PRODUCT_RATING_SUMMARY_QUERY = `
+  query ReactionaryProductRatingSummary($sku: String!) {
+    products(filter: { sku: { eq: $sku } }, pageSize: 1, currentPage: 1) {
+      items {
+        sku
+        rating_summary
+        review_count
+      }
+    }
+  }
+`;
+const PRODUCT_REVIEWS_QUERY = `
+  query ReactionaryProductReviews($sku: String!, $pageSize: Int!, $currentPage: Int!) {
+    products(filter: { sku: { eq: $sku } }, pageSize: 1, currentPage: 1) {
+      items {
+        sku
+        rating_summary
+        review_count
+        reviews(pageSize: $pageSize, currentPage: $currentPage) {
+          items {
+${REVIEW_FIELDS}
+          }
+          page_info {
+            page_size
+            current_page
+            total_pages
+          }
+        }
+      }
+    }
+  }
+`;
+const PRODUCT_REVIEW_RATINGS_METADATA_QUERY = `
+  query ReactionaryProductReviewRatingsMetadata {
+    productReviewRatingsMetadata {
+      items {
+        id
+        name
+        values {
+          value_id
+          value
+        }
+      }
+    }
+  }
+`;
+const CREATE_PRODUCT_REVIEW_MUTATION = `
+  mutation ReactionaryCreateProductReview($input: CreateProductReviewInput!) {
+    createProductReview(input: $input) {
+      review {
+${REVIEW_FIELDS}
+      }
+    }
+  }
+`;
+export {
+  CREATE_PRODUCT_REVIEW_MUTATION,
+  PRODUCT_RATING_SUMMARY_QUERY,
+  PRODUCT_REVIEWS_QUERY,
+  PRODUCT_REVIEW_RATINGS_METADATA_QUERY
+};

package/factories/category/category.factory.js

@@ -29,7 +29,7 @@ class MagentoCategoryFactory {
     };
     return this.categorySchema.parse(result);
   }
-  parseCategoryPaginatedResult(context, data) {
+  parseCategoryPaginatedResult(context, data, _query) {
     const items = (data.items || []).map((c) => this.parseCategory(context, c));
     const totalCount = data.total_count ?? 0;
     const totalPages = Math.max(1, Math.ceil(totalCount / data.pageSize));

package/factories/checkout/checkout.factory.js

@@ -0,0 +1,203 @@
+import {
+  AddressIdentifierSchema,
+  MonetaryAmountSchema,
+  ShippingMethodIdentifierSchema
+} from "@reactionary/core";
+function encodeShippingMethodKey(carrierCode, methodCode) {
+  return `${carrierCode}_${methodCode}`;
+}
+class MagentoCheckoutFactory {
+  checkoutSchema;
+  shippingMethodSchema;
+  paymentMethodSchema;
+  config;
+  constructor(checkoutSchema, shippingMethodSchema, paymentMethodSchema, config) {
+    this.checkoutSchema = checkoutSchema;
+    this.shippingMethodSchema = shippingMethodSchema;
+    this.paymentMethodSchema = paymentMethodSchema;
+    this.config = config;
+  }
+  resolveCurrency(data) {
+    const code = data.totals?.quote_currency_code || data.cart.quote_currency_code || this.config.defaultCurrency || "USD";
+    return code;
+  }
+  parseAddress(address) {
+    const street = address.street ?? [];
+    return {
+      identifier: AddressIdentifierSchema.parse({
+        nickName: address.company || ""
+      }),
+      firstName: address.firstname || "",
+      lastName: address.lastname || "",
+      streetAddress: street[0] || "",
+      streetNumber: street[1] || "",
+      city: address.city || "",
+      region: address.region || "",
+      postalCode: address.postcode || "",
+      countryCode: address.country_id || ""
+    };
+  }
+  parseCostBreakdown(data, currency) {
+    const source = data.totals ?? data.cart;
+    return {
+      totalProductPrice: {
+        value: source.subtotal ?? source.base_subtotal ?? 0,
+        currency
+      },
+      grandTotal: {
+        value: source.grand_total ?? source.base_grand_total ?? 0,
+        currency
+      },
+      totalTax: {
+        value: source.tax_amount ?? source.base_tax_amount ?? 0,
+        currency
+      },
+      totalShipping: {
+        value: source.shipping_amount ?? source.base_shipping_amount ?? 0,
+        currency
+      },
+      totalDiscount: {
+        value: Math.abs(source.discount_amount ?? source.base_discount_amount ?? 0),
+        currency
+      },
+      totalSurcharge: {
+        value: 0,
+        currency
+      }
+    };
+  }
+  parseItemPrice(item, currency) {
+    const qty = item.qty ?? 0;
+    return {
+      unitPrice: {
+        value: item.price ?? 0,
+        currency
+      },
+      unitDiscount: {
+        value: item.discount_amount ? Math.abs(item.discount_amount / (qty || 1)) : 0,
+        currency
+      },
+      totalPrice: {
+        value: item.row_total !== void 0 ? item.row_total : (item.price || 0) * (qty || 0),
+        currency
+      },
+      totalDiscount: {
+        value: Math.abs(item.discount_amount || 0),
+        currency
+      }
+    };
+  }
+  parseCheckoutItem(item, currency) {
+    return {
+      identifier: {
+        key: String(item.item_id)
+      },
+      variant: {
+        sku: item.sku
+      },
+      quantity: item.qty ?? 0,
+      price: this.parseItemPrice(item, currency)
+    };
+  }
+  parsePaymentInstruction(stored) {
+    return {
+      identifier: { key: stored.key },
+      amount: {
+        value: stored.amountValue,
+        currency: stored.amountCurrency
+      },
+      paymentMethod: {
+        method: stored.method,
+        name: stored.name,
+        paymentProcessor: stored.paymentProcessor
+      },
+      protocolData: stored.protocolData,
+      status: "pending"
+    };
+  }
+  parseShippingInstruction(state) {
+    if (!state.shippingInstruction) {
+      return void 0;
+    }
+    return {
+      shippingMethod: { key: state.shippingInstruction.shippingMethodKey },
+      pickupPoint: state.shippingInstruction.pickupPoint,
+      instructions: state.shippingInstruction.instructions,
+      consentForUnattendedDelivery: state.shippingInstruction.consentForUnattendedDelivery
+    };
+  }
+  parseCheckout(_context, data) {
+    const checkoutData = data;
+    const cart = checkoutData.cart;
+    const state = checkoutData.state ?? {};
+    const currency = this.resolveCurrency(checkoutData);
+    const key = checkoutData.requestedKey || cart.masked_id || String(cart.id || "");
+    const items = (cart.items || []).map(
+      (item) => this.parseCheckoutItem(item, currency)
+    );
+    const billingAddress = state.billingAddress ? this.parseAddress(state.billingAddress) : void 0;
+    const shippingAddress = state.shippingAddress ? this.parseAddress(state.shippingAddress) : void 0;
+    const paymentInstructions = (state.paymentInstructions ?? []).map(
+      (pi) => this.parsePaymentInstruction(pi)
+    );
+    const readyForFinalization = Boolean(
+      state.shippingInstruction && paymentInstructions.length > 0 && (billingAddress || shippingAddress)
+    );
+    const pointOfContact = {
+      email: state.email || cart.customer?.email || "",
+      phone: state.phone
+    };
+    const result = {
+      identifier: { key },
+      originalCartReference: { key },
+      resultingOrder: state.orderId ? { key: state.orderId } : void 0,
+      items,
+      price: this.parseCostBreakdown(checkoutData, currency),
+      name: cart.name || "",
+      description: cart.description || "",
+      pointOfContact,
+      billingAddress,
+      shippingAddress,
+      shippingInstruction: this.parseShippingInstruction(state),
+      paymentInstructions,
+      readyForFinalization
+    };
+    return this.checkoutSchema.parse(result);
+  }
+  parseShippingMethod(_context, data) {
+    const method = data;
+    const currency = this.config.defaultCurrency || "USD";
+    const sm = {
+      identifier: ShippingMethodIdentifierSchema.parse({
+        key: encodeShippingMethodKey(method.carrier_code, method.method_code)
+      }),
+      name: method.method_title || method.method_code,
+      description: method.carrier_title || "",
+      price: MonetaryAmountSchema.parse({
+        value: method.amount ?? 0,
+        currency
+      }),
+      deliveryTime: "",
+      carrier: method.carrier_code
+    };
+    return this.shippingMethodSchema.parse(sm);
+  }
+  parsePaymentMethod(_context, data) {
+    const method = data;
+    const pm = {
+      identifier: {
+        method: method.code,
+        name: method.title,
+        paymentProcessor: method.code
+      },
+      logo: void 0,
+      description: method.title,
+      isPunchOut: false
+    };
+    return this.paymentMethodSchema.parse(pm);
+  }
+}
+export {
+  MagentoCheckoutFactory,
+  encodeShippingMethodKey
+};

package/factories/index.js

@@ -5,3 +5,9 @@ export * from "./inventory/inventory.factory.js";
 export * from "./price/price.factory.js";
 export * from "./product/product.factory.js";
 export * from "./product-search/product-search.factory.js";
+export * from "./profile/profile.factory.js";
+export * from "./order-search/order-search.factory.js";
+export * from "./order/order.factory.js";
+export * from "./checkout/checkout.factory.js";
+export * from "./product-associations/product-associations.factory.js";
+export * from "./product-reviews/product-reviews.factory.js";

package/factories/order/order.factory.js

@@ -0,0 +1,115 @@
+import {
+  AddressIdentifierSchema
+} from "@reactionary/core";
+import { mapMagentoOrderStatus } from "../order-search/order-search.factory.js";
+function mapMagentoPaymentStatus(state) {
+  switch (state) {
+    case "complete":
+    case "closed":
+      return "captured";
+    case "processing":
+      return "authorized";
+    case "canceled":
+      return "canceled";
+    default:
+      return "pending";
+  }
+}
+class MagentoOrderFactory {
+  orderSchema;
+  constructor(orderSchema) {
+    this.orderSchema = orderSchema;
+  }
+  parseAddress(address) {
+    if (!address) return void 0;
+    const street = address.street ?? [];
+    return {
+      identifier: AddressIdentifierSchema.parse({
+        nickName: address.entity_id ? String(address.entity_id) : "address"
+      }),
+      firstName: address.firstname || "",
+      lastName: address.lastname || "",
+      streetAddress: street[0] || "",
+      streetNumber: street[1] || "",
+      city: address.city || "",
+      region: address.region || "",
+      postalCode: address.postcode || "",
+      countryCode: address.country_id || ""
+    };
+  }
+  parseOrderItem(order, item, currency) {
+    const unitPrice = item.price ?? 0;
+    const totalPrice = item.row_total ?? unitPrice * (item.qty_ordered ?? 1);
+    const price = {
+      unitPrice: { value: unitPrice, currency },
+      totalPrice: { value: totalPrice, currency },
+      unitDiscount: { value: 0, currency },
+      totalDiscount: { value: 0, currency }
+    };
+    return {
+      identifier: { key: String(item.item_id) },
+      variant: { sku: item.sku },
+      quantity: item.qty_ordered ?? 0,
+      price,
+      inventoryStatus: order.state === "complete" ? "Allocated" : "NotAllocated"
+    };
+  }
+  parseCostBreakdown(order, currency) {
+    return {
+      grandTotal: { value: order.grand_total ?? 0, currency },
+      totalProductPrice: { value: order.subtotal ?? 0, currency },
+      totalShipping: { value: order.shipping_amount ?? 0, currency },
+      totalTax: { value: order.tax_amount ?? 0, currency },
+      totalDiscount: { value: Math.abs(order.discount_amount ?? 0), currency },
+      totalSurcharge: { value: 0, currency }
+    };
+  }
+  parsePaymentInstruction(order, currency) {
+    const method = order.payment?.method ?? "unknown";
+    return {
+      identifier: { key: String(order.entity_id) },
+      amount: { value: order.payment?.amount_ordered ?? order.grand_total ?? 0, currency },
+      paymentMethod: { method, name: method, paymentProcessor: method },
+      protocolData: [],
+      status: mapMagentoPaymentStatus(order.state)
+    };
+  }
+  parseShippingMethod(order, method, currency) {
+    if (!method && !order.shipping_description) return void 0;
+    return {
+      identifier: { key: method ?? "default" },
+      name: order.shipping_description ?? method ?? "",
+      description: order.shipping_description ?? "",
+      price: { value: order.shipping_amount ?? 0, currency },
+      deliveryTime: ""
+    };
+  }
+  parseOrder(_context, data) {
+    const order = data;
+    const currency = (order.order_currency_code || "USD").toUpperCase();
+    const orderStatus = mapMagentoOrderStatus(order.status);
+    const inventoryStatus = order.state === "complete" ? "Allocated" : "NotAllocated";
+    const userId = { userId: order.customer_id ? String(order.customer_id) : "" };
+    const shippingAssignment = order.extension_attributes?.shipping_assignments?.[0]?.shipping;
+    const result = {
+      identifier: { key: String(order.entity_id) },
+      userId,
+      items: (order.items ?? []).map((item) => this.parseOrderItem(order, item, currency)),
+      price: this.parseCostBreakdown(order, currency),
+      orderStatus,
+      inventoryStatus,
+      paymentInstructions: order.payment ? [this.parsePaymentInstruction(order, currency)] : [],
+      shippingAddress: this.parseAddress(shippingAssignment?.address ?? order.billing_address),
+      billingAddress: this.parseAddress(order.billing_address),
+      shippingMethod: this.parseShippingMethod(order, shippingAssignment?.method, currency),
+      orderDate: new Date(order.created_at || Date.now()).toISOString(),
+      incrementId: order.increment_id,
+      customerEmail: order.customer_email || order.billing_address?.email,
+      customerPhone: order.billing_address?.telephone
+    };
+    return this.orderSchema.parse(result);
+  }
+}
+export {
+  MagentoOrderFactory
+};

package/factories/order-search/order-search.factory.js

@@ -0,0 +1,79 @@
+import {
+  AddressIdentifierSchema
+} from "@reactionary/core";
+function mapMagentoOrderStatus(status) {
+  switch (status) {
+    case "processing":
+      return "ReleasedToFulfillment";
+    case "complete":
+    case "closed":
+      return "Shipped";
+    case "canceled":
+      return "Cancelled";
+    default:
+      return "AwaitingPayment";
+  }
+}
+class MagentoOrderSearchFactory {
+  orderSearchResultSchema;
+  constructor(orderSearchResultSchema) {
+    this.orderSearchResultSchema = orderSearchResultSchema;
+  }
+  parseAddress(address) {
+    const street = address.street ?? [];
+    return {
+      identifier: AddressIdentifierSchema.parse({
+        nickName: address.entity_id ? String(address.entity_id) : "billing"
+      }),
+      firstName: address.firstname || "",
+      lastName: address.lastname || "",
+      streetAddress: street[0] || "",
+      streetNumber: street[1] || "",
+      city: address.city || "",
+      region: address.region || "",
+      postalCode: address.postcode || "",
+      countryCode: address.country_id || ""
+    };
+  }
+  parseOrderSearchResultItem(_context, order) {
+    const totalAmount = {
+      currency: (order.order_currency_code || "USD").toUpperCase(),
+      value: order.grand_total ?? 0
+    };
+    const inventoryStatus = order.state === "complete" ? "Allocated" : "NotAllocated";
+    const userId = {
+      userId: order.customer_id ? String(order.customer_id) : ""
+    };
+    return {
+      identifier: { key: String(order.entity_id) },
+      userId,
+      customerName: `${order.customer_firstname ?? ""} ${order.customer_lastname ?? ""}`.trim(),
+      shippingAddress: order.billing_address ? this.parseAddress(order.billing_address) : void 0,
+      orderDate: new Date(order.created_at || Date.now()).toISOString(),
+      orderStatus: mapMagentoOrderStatus(order.status),
+      inventoryStatus,
+      totalAmount
+    };
+  }
+  parseOrderSearchResult(context, data, query) {
+    const response = data;
+    const items = response.items ?? [];
+    const pageSize = response.search_criteria?.page_size || query.search.paginationOptions.pageSize;
+    const pageNumber = response.search_criteria?.current_page || query.search.paginationOptions.pageNumber;
+    const totalCount = response.total_count ?? items.length;
+    const identifier = { ...query.search };
+    const result = {
+      identifier,
+      pageNumber,
+      pageSize,
+      totalCount,
+      totalPages: pageSize > 0 ? Math.ceil(totalCount / pageSize) : 0,
+      items: items.map((o) => this.parseOrderSearchResultItem(context, o))
+    };
+    return this.orderSearchResultSchema.parse(result);
+  }
+}
+export {
+  MagentoOrderSearchFactory,
+  mapMagentoOrderStatus
+};

package/factories/product/product.factory.js

@@ -2,12 +2,11 @@ import {
   CategoryIdentifierSchema,
   ProductIdentifierSchema
 } from "@reactionary/core";
+import { getProductKey, parseDamImages } from "../../utils/magento-product.js";
 function getCustomAttribute(product, code) {
-  if (!product.custom_attributes)
-    return void 0;
+  if (!product.custom_attributes) return void 0;
   const found = product.custom_attributes.find((a) => a.attribute_code === code);
-  if (found?.value === null || found?.value === void 0)
-    return void 0;
+  if (found?.value === null || found?.value === void 0) return void 0;
   return String(found.value);
 }
 function normalizeBaseUrl(baseUrl) {
@@ -26,11 +25,11 @@ class MagentoProductFactory {
     this.config = config;
     this.productSchema = productSchema;
   }
+  config;
   productSchema;
   parseProduct(_context, data) {
     const sku = data.sku;
-    const idKey = data.id !== void 0 ? String(data.id) : sku;
-    const identifier = ProductIdentifierSchema.parse({ key: idKey });
+    const identifier = ProductIdentifierSchema.parse({ key: getProductKey(data) });
     const name = data.name || sku;
     const slug = getCustomAttribute(data, "url_key") ?? getCustomAttribute(data, "url_path") ?? "";
     const description = getCustomAttribute(data, "description") ?? getCustomAttribute(data, "short_description") ?? "";
@@ -59,10 +58,7 @@ class MagentoProductFactory {
     const sku = product.sku;
     const ean = getCustomAttribute(product, "ean") ?? getCustomAttribute(product, "gtin") ?? getCustomAttribute(product, "barcode") ?? "";
     const upc = getCustomAttribute(product, "upc") ?? "";
-    const images = (product.media_gallery_entries ?? []).filter((m) => m.file.length > 0).map((m) => ({
-      sourceUrl: buildMagentoImageUrl(this.config, m.file),
-      altText: product.name || sku
-    }));
+    const images = this.parseImages(product);
     const options = [];
     return {
       identifier: { sku },
@@ -75,6 +71,19 @@ class MagentoProductFactory {
       barcode: ean
     };
   }
+  parseImages(product) {
+    const altText = product.name || product.sku;
+    if (this.config.mediaSource === "EXTERNAL") {
+      return parseDamImages(
+        getCustomAttribute(product, "original_dam_reference"),
+        altText
+      );
+    }
+    return (product.media_gallery_entries ?? []).filter((m) => m.file.length > 0).map((m) => ({
+      sourceUrl: buildMagentoImageUrl(this.config, m.file),
+      altText
+    }));
+  }
   createSynthAttribute(key, name, value) {
     const attributeIdentifier = { key };
     const valueIdentifier = { key: `${key}-${value}` };
@@ -93,17 +102,13 @@ class MagentoProductFactory {
   }
   parseAttributes(product) {
     const sharedAttributes = [];
-    if (!product.custom_attributes)
-      return sharedAttributes;
+    if (!product.custom_attributes) return sharedAttributes;
     for (const entry of product.custom_attributes) {
       const key = entry.attribute_code;
       const value = entry.value;
-      if (!key)
-        continue;
-      if (key === "description" || key === "short_description")
-        continue;
-      if (value === null || value === void 0)
-        continue;
+      if (!key) continue;
+      if (key === "description" || key === "short_description") continue;
+      if (value === null || value === void 0) continue;
       const stringValue = typeof value === "string" || typeof value === "number" || typeof value === "boolean" ? String(value) : JSON.stringify(value);
       sharedAttributes.push(this.createSynthAttribute(key, key, stringValue));
     }

package/factories/product-associations/product-associations.factory.js

@@ -0,0 +1,25 @@
+import {
+} from "@reactionary/core";
+import { buildProductSearchResultItem } from "../../utils/magento-product.js";
+class MagentoProductAssociationsFactory {
+  productAssociationSchema;
+  config;
+  constructor(productAssociationSchema, config) {
+    this.productAssociationSchema = productAssociationSchema;
+    this.config = config;
+  }
+  parseProduct(_context, product) {
+    return buildProductSearchResultItem(this.config, product);
+  }
+  parseAssociation(context, data) {
+    const result = {
+      associationIdentifier: data.identifier,
+      associationReturnType: "productSearchResultItem",
+      product: this.parseProduct(context, data.product)
+    };
+    return this.productAssociationSchema.parse(result);
+  }
+}
+export {
+  MagentoProductAssociationsFactory
+};

package/factories/product-reviews/product-reviews.factory.js

@@ -0,0 +1,65 @@
+import {
+  buildProductReviewKey,
+  ratingPercentToStars,
+  toIsoTimestamp
+} from "../../utils/magento-review.js";
+class MagentoProductReviewsFactory {
+  ratingSummarySchema;
+  reviewSchema;
+  reviewPaginatedSchema;
+  constructor(ratingSummarySchema, reviewSchema, reviewPaginatedSchema) {
+    this.ratingSummarySchema = ratingSummarySchema;
+    this.reviewSchema = reviewSchema;
+    this.reviewPaginatedSchema = reviewPaginatedSchema;
+  }
+  /**
+   * Magento's GraphQL schema offers no per-star breakdown, so the distribution
+   * is left undefined rather than reconstructed from the current page.
+   */
+  parseRatingSummary(_context, data) {
+    return this.ratingSummarySchema.parse({
+      identifier: {
+        product: data.product
+      },
+      averageRating: ratingPercentToStars(data.ratingSummary),
+      totalRatings: data.reviewCount ?? void 0,
+      ratingDistribution: void 0
+    });
+  }
+  /**
+   * Magento does not expose whether a review came from a confirmed purchase, so
+   * `verified` is always false.
+   */
+  parseReview(_context, data) {
+    return this.reviewSchema.parse({
+      identifier: {
+        key: buildProductReviewKey(data.sku, data.review)
+      },
+      product: data.product,
+      authorName: data.review.nickname || "Anonymous",
+      rating: ratingPercentToStars(data.review.average_rating),
+      title: data.review.summary ?? "",
+      content: data.review.text ?? "",
+      createdAt: toIsoTimestamp(data.review.created_at),
+      verified: false
+    });
+  }
+  parseReviewPaginatedResult(context, data) {
+    return this.reviewPaginatedSchema.parse({
+      items: data.reviews.map(
+        (review) => this.parseReview(context, {
+          product: data.product,
+          sku: data.sku,
+          review
+        })
+      ),
+      totalCount: data.totalCount,
+      pageSize: data.pageSize,
+      pageNumber: data.pageNumber,
+      totalPages: Math.ceil(data.totalCount / Math.max(data.pageSize, 1))
+    });
+  }
+}
+export {
+  MagentoProductReviewsFactory
+};

package/factories/product-search/product-search.factory.js

@@ -4,11 +4,9 @@ import {
   ProductVariantIdentifierSchema
 } from "@reactionary/core";
 function getCustomAttribute(product, code) {
-  if (!product.custom_attributes)
-    return void 0;
+  if (!product.custom_attributes) return void 0;
   const found = product.custom_attributes.find((a) => a.attribute_code === code);
-  if (found?.value === null || found?.value === void 0)
-    return void 0;
+  if (found?.value === null || found?.value === void 0) return void 0;
   return String(found.value);
 }
 function normalizeBaseUrl(baseUrl) {
@@ -27,6 +25,7 @@ class MagentoProductSearchFactory {
     this.config = config;
     this.productSearchResultSchema = productSearchResultSchema;
   }
+  config;
   productSearchResultSchema;
   parseSearchResult(context, data, query) {
     const pageSize = query.search.paginationOptions.pageSize;