@reactionary/provider-commercetools 0.3.18 → 0.6.2

package/factories/checkout/checkout.factory.js

@@ -0,0 +1,232 @@
+import {
+  CheckoutItemSchema
+} from "@reactionary/core";
+class CommercetoolsCheckoutFactory {
+  constructor(checkoutSchema, shippingMethodSchema, paymentMethodSchema) {
+    this.checkoutSchema = checkoutSchema;
+    this.shippingMethodSchema = shippingMethodSchema;
+    this.paymentMethodSchema = paymentMethodSchema;
+  }
+  parseCheckout(context, data) {
+    const identifier = {
+      key: data.id,
+      version: data.version || 0
+    };
+    const originalCartReference = {
+      key: data.custom?.fields["commerceToolsCartId"] || "",
+      version: 0
+    };
+    let shippingAddress;
+    if (data.shippingAddress) {
+      shippingAddress = this.parseAddress(data.shippingAddress);
+    }
+    let billingAddress;
+    if (data.billingAddress) {
+      billingAddress = this.parseAddress(data.billingAddress);
+    }
+    const paymentInstructions = [];
+    for (const payment of data.paymentInfo?.payments || []) {
+      if (payment.obj) {
+        paymentInstructions.push(this.parsePaymentInstruction(context, payment.obj));
+      }
+    }
+    const grandTotal = data.totalPrice.centAmount || 0;
+    const shippingTotal = data.shippingInfo?.price.centAmount || 0;
+    const productTotal = grandTotal - shippingTotal;
+    const taxTotal = data.taxedPrice?.totalTax?.centAmount || 0;
+    const discountTotal = data.discountOnTotalPrice?.discountedAmount.centAmount || 0;
+    const surchargeTotal = 0;
+    const currency = data.totalPrice.currencyCode;
+    const price = {
+      totalTax: {
+        value: taxTotal / 100,
+        currency
+      },
+      totalDiscount: {
+        value: discountTotal / 100,
+        currency
+      },
+      totalSurcharge: {
+        value: surchargeTotal / 100,
+        currency
+      },
+      totalShipping: {
+        value: shippingTotal / 100,
+        currency
+      },
+      totalProductPrice: {
+        value: productTotal / 100,
+        currency
+      },
+      grandTotal: {
+        value: grandTotal / 100,
+        currency
+      }
+    };
+    const items = [];
+    for (const lineItem of data.lineItems) {
+      items.push(this.parseCheckoutItem(lineItem));
+    }
+    const shippingInstruction = this.parseShippingInstruction(data);
+    const readyForFinalization = this.isReadyForFinalization(
+      price,
+      paymentInstructions,
+      billingAddress,
+      shippingAddress,
+      shippingInstruction
+    );
+    const result = {
+      identifier,
+      originalCartReference,
+      name: data.custom?.fields["name"] || "",
+      description: data.custom?.fields["description"] || "",
+      readyForFinalization,
+      billingAddress,
+      shippingAddress,
+      shippingInstruction,
+      paymentInstructions,
+      items,
+      price
+    };
+    return this.checkoutSchema.parse(result);
+  }
+  parseShippingMethod(context, data) {
+    const identifier = {
+      key: data.key || ""
+    };
+    const result = {
+      deliveryTime: "",
+      description: data.localizedDescription?.[context.languageContext.locale] || "",
+      identifier,
+      name: data.name,
+      price: data.zoneRates[0].shippingRates[0].price ? {
+        value: (data.zoneRates[0].shippingRates[0].price.centAmount || 0) / 100,
+        currency: data.zoneRates[0].shippingRates[0].price.currencyCode || context.languageContext.currencyCode
+      } : { value: 0, currency: context.languageContext.currencyCode }
+    };
+    return this.shippingMethodSchema.parse(result);
+  }
+  parsePaymentMethod(_context, data) {
+    return this.paymentMethodSchema.parse(data);
+  }
+  parseCheckoutItem(remoteItem) {
+    const unitPrice = remoteItem.price.value.centAmount;
+    const totalPrice = remoteItem.totalPrice.centAmount || 0;
+    const totalDiscount = remoteItem.price.discounted?.value.centAmount || 0;
+    const unitDiscount = totalDiscount / remoteItem.quantity;
+    const currency = remoteItem.price.value.currencyCode.toUpperCase();
+    const item = {
+      identifier: {
+        key: remoteItem.id
+      },
+      variant: {
+        sku: remoteItem.variant.sku || ""
+      },
+      quantity: remoteItem.quantity,
+      price: {
+        unitPrice: {
+          value: unitPrice / 100,
+          currency
+        },
+        unitDiscount: {
+          value: unitDiscount / 100,
+          currency
+        },
+        totalPrice: {
+          value: totalPrice / 100,
+          currency
+        },
+        totalDiscount: {
+          value: totalDiscount / 100,
+          currency
+        }
+      }
+    };
+    return CheckoutItemSchema.parse(item);
+  }
+  isReadyForFinalization(price, paymentInstructions, billingAddress, shippingAddress, shippingInstruction) {
+    if (!billingAddress)
+      return false;
+    if (!shippingInstruction)
+      return false;
+    if (!shippingAddress && !shippingInstruction.pickupPoint)
+      return false;
+    if (paymentInstructions.length === 0)
+      return false;
+    const authorizedPayments = paymentInstructions.filter((paymentInstruction) => paymentInstruction.status === "authorized").map((paymentInstruction) => paymentInstruction.amount.value).reduce((sum, value) => sum + value, 0);
+    if (price.grandTotal.value !== authorizedPayments)
+      return false;
+    return true;
+  }
+  parsePaymentInstruction(context, data) {
+    const identifier = {
+      key: data.id
+    };
+    const amount = {
+      value: data.amountPlanned.centAmount / 100,
+      currency: data.amountPlanned.currencyCode
+    };
+    const method = data.paymentMethodInfo?.method || "unknown";
+    const paymentProcessor = data.paymentMethodInfo?.paymentInterface || method;
+    const paymentName = data.paymentMethodInfo.name?.[context.languageContext.locale];
+    const paymentMethod = {
+      method,
+      paymentProcessor,
+      name: paymentName || method || "Unknown"
+    };
+    const customData = data.custom?.fields || {};
+    const protocolData = Object.keys(customData).map((key) => ({
+      key,
+      value: customData[key]
+    }));
+    let status = "pending";
+    if (data.transactions && data.transactions.length > 0) {
+      const lastTransaction = data.transactions[data.transactions.length - 1];
+      if (lastTransaction.type === "Authorization" && lastTransaction.state === "Success") {
+        status = "authorized";
+      }
+    }
+    const result = {
+      amount,
+      identifier,
+      paymentMethod,
+      protocolData,
+      status
+    };
+    return result;
+  }
+  parseAddress(data) {
+    return {
+      countryCode: data.country || "",
+      firstName: data.firstName || "",
+      lastName: data.lastName || "",
+      streetAddress: data.streetName || "",
+      streetNumber: data.streetNumber || "",
+      postalCode: data.postalCode || "",
+      city: data.city || "",
+      identifier: {
+        nickName: ""
+      },
+      region: ""
+    };
+  }
+  parseShippingInstruction(data) {
+    if (!data.shippingInfo)
+      return void 0;
+    const instructions = data.custom?.fields["shippingInstruction"] || "";
+    const consentForUnattendedDelivery = data.custom?.fields["consentForUnattendedDelivery"] === "true";
+    const pickupPoint = data.custom?.fields["pickupPointId"] || "";
+    const result = {
+      shippingMethod: {
+        key: data.shippingInfo.shippingMethod?.obj?.key || ""
+      },
+      pickupPoint,
+      instructions,
+      consentForUnattendedDelivery
+    };
+    return result;
+  }
+}
+export {
+  CommercetoolsCheckoutFactory
+};

package/factories/identity/identity.factory.js

@@ -0,0 +1,13 @@
+import {
+} from "@reactionary/core";
+class CommercetoolsIdentityFactory {
+  constructor(identitySchema) {
+    this.identitySchema = identitySchema;
+  }
+  parseIdentity(_context, data) {
+    return this.identitySchema.parse(data);
+  }
+}
+export {
+  CommercetoolsIdentityFactory
+};

package/factories/inventory/inventory.factory.js

@@ -0,0 +1,29 @@
+import {
+} from "@reactionary/core";
+class CommercetoolsInventoryFactory {
+  constructor(inventorySchema) {
+    this.inventorySchema = inventorySchema;
+  }
+  parseInventory(_context, data) {
+    const identifier = {
+      variant: { sku: data.sku || "" },
+      fulfillmentCenter: {
+        key: data.supplyChannel?.obj?.key || ""
+      }
+    };
+    const quantity = data.availableQuantity || 0;
+    let status = "outOfStock";
+    if (quantity > 0) {
+      status = "inStock";
+    }
+    const result = {
+      identifier,
+      quantity,
+      status
+    };
+    return this.inventorySchema.parse(result);
+  }
+}
+export {
+  CommercetoolsInventoryFactory
+};

package/factories/order/order.factory.js

@@ -0,0 +1,113 @@
+import {
+} from "@reactionary/core";
+class CommercetoolsOrderFactory {
+  constructor(orderSchema) {
+    this.orderSchema = orderSchema;
+  }
+  parseOrder(_context, data) {
+    const identifier = {
+      key: data.id,
+      version: data.version || 0
+    };
+    const name = data.custom?.fields["name"] || "";
+    const description = data.custom?.fields["description"] || "";
+    const grandTotal = data.totalPrice.centAmount || 0;
+    const shippingTotal = data.shippingInfo?.price.centAmount || 0;
+    const productTotal = grandTotal - shippingTotal;
+    const taxTotal = data.taxedPrice?.totalTax?.centAmount || 0;
+    const discountTotal = data.discountOnTotalPrice?.discountedAmount.centAmount || 0;
+    const surchargeTotal = 0;
+    const currency = data.totalPrice.currencyCode;
+    const price = {
+      totalTax: {
+        value: taxTotal / 100,
+        currency
+      },
+      totalDiscount: {
+        value: discountTotal / 100,
+        currency
+      },
+      totalSurcharge: {
+        value: surchargeTotal / 100,
+        currency
+      },
+      totalShipping: {
+        value: shippingTotal / 100,
+        currency: data.shippingInfo?.price.currencyCode
+      },
+      totalProductPrice: {
+        value: productTotal / 100,
+        currency
+      },
+      grandTotal: {
+        value: grandTotal / 100,
+        currency
+      }
+    };
+    let orderStatus = "AwaitingPayment";
+    if (data.paymentState === "Paid" && data.orderState === "Confirmed") {
+      orderStatus = "ReleasedToFulfillment";
+    }
+    if (data.shipmentState === "Ready" && data.orderState === "Confirmed") {
+      orderStatus = "ReleasedToFulfillment";
+    }
+    if ((data.shipmentState === "Shipped" || data.shipmentState === "Delivered") && data.orderState === "Completed") {
+      orderStatus = "Shipped";
+    }
+    const items = [];
+    for (const remoteItem of data.lineItems) {
+      const lineIdentifier = {
+        key: remoteItem.id
+      };
+      const variant = {
+        sku: remoteItem.variant.sku || ""
+      };
+      const unitPrice = remoteItem.price.value.centAmount;
+      const totalPrice = remoteItem.totalPrice.centAmount || 0;
+      const totalDiscount = remoteItem.price.discounted?.value.centAmount || 0;
+      const unitDiscount = totalDiscount / remoteItem.quantity;
+      const linePrice = {
+        unitPrice: {
+          value: unitPrice / 100,
+          currency
+        },
+        unitDiscount: {
+          value: unitDiscount / 100,
+          currency
+        },
+        totalPrice: {
+          value: totalPrice / 100,
+          currency
+        },
+        totalDiscount: {
+          value: totalDiscount / 100,
+          currency
+        }
+      };
+      items.push({
+        identifier: lineIdentifier,
+        inventoryStatus: "NotAllocated",
+        price: linePrice,
+        quantity: remoteItem.quantity,
+        variant
+      });
+    }
+    const result = {
+      identifier,
+      name,
+      description,
+      price,
+      items,
+      inventoryStatus: "NotAllocated",
+      paymentInstructions: [],
+      userId: {
+        userId: ""
+      },
+      orderStatus
+    };
+    return this.orderSchema.parse(result);
+  }
+}
+export {
+  CommercetoolsOrderFactory
+};

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

@@ -0,0 +1,67 @@
+import {
+} from "@reactionary/core";
+class CommercetoolsOrderSearchFactory {
+  constructor(orderSearchResultSchema) {
+    this.orderSearchResultSchema = orderSearchResultSchema;
+  }
+  parseOrderSearchResult(context, data, query) {
+    const result = {
+      identifier: {
+        ...query.search
+      },
+      pageNumber: (Math.ceil(data.offset / data.limit) || 0) + 1,
+      pageSize: data.limit,
+      totalCount: data.total || 0,
+      totalPages: Math.ceil((data.total || 0) / data.limit || 0) + 1,
+      items: data.results.map((order) => this.parseOrderSearchItem(context, order))
+    };
+    return this.orderSearchResultSchema.parse(result);
+  }
+  parseAddress(data) {
+    return {
+      countryCode: data.country || "",
+      firstName: data.firstName || "",
+      lastName: data.lastName || "",
+      streetAddress: data.streetName || "",
+      streetNumber: data.streetNumber || "",
+      postalCode: data.postalCode || "",
+      city: data.city || "",
+      identifier: {
+        nickName: ""
+      },
+      region: ""
+    };
+  }
+  parseOrderSearchItem(context, data) {
+    const userId = {
+      userId: data.customerId || data.anonymousId || ""
+    };
+    let orderStatus = "AwaitingPayment";
+    if (data.paymentState === "Paid" && data.orderState === "Confirmed") {
+      orderStatus = "ReleasedToFulfillment";
+    }
+    if (data.shipmentState === "Ready" && data.orderState === "Confirmed") {
+      orderStatus = "ReleasedToFulfillment";
+    }
+    if ((data.shipmentState === "Shipped" || data.shipmentState === "Delivered") && data.orderState === "Completed") {
+      orderStatus = "Shipped";
+    }
+    const totalAmount = {
+      currency: data.totalPrice ? data.totalPrice.currencyCode : context.languageContext.currencyCode,
+      value: data.totalPrice ? data.totalPrice.centAmount / 100 : 0
+    };
+    return {
+      identifier: { key: data.id },
+      userId,
+      customerName: `${data.billingAddress?.firstName} ${data.billingAddress?.lastName}`,
+      shippingAddress: this.parseAddress(data.shippingAddress),
+      orderDate: data.createdAt,
+      orderStatus,
+      inventoryStatus: orderStatus === "Shipped" ? "Allocated" : "NotAllocated",
+      totalAmount
+    };
+  }
+}
+export {
+  CommercetoolsOrderSearchFactory
+};

package/factories/price/price.factory.js

@@ -0,0 +1,51 @@
+import {
+} from "@reactionary/core";
+class CommercetoolsPriceFactory {
+  constructor(priceSchema) {
+    this.priceSchema = priceSchema;
+  }
+  parsePrice(context, data, options = { includeDiscounts: false }) {
+    const price = data.price;
+    if (!price) {
+      return this.priceSchema.parse({
+        identifier: {
+          variant: {
+            sku: data.sku || ""
+          }
+        },
+        onSale: false,
+        tieredPrices: [],
+        unitPrice: {
+          value: -1,
+          currency: context.languageContext.currencyCode
+        }
+      });
+    }
+    let unitPrice = {
+      value: price.value.centAmount / 100,
+      currency: price.value.currencyCode
+    };
+    if (options.includeDiscounts) {
+      const discountedPrice = price.discounted?.value || price.value;
+      unitPrice = {
+        value: discountedPrice.centAmount / 100,
+        currency: price.value.currencyCode
+      };
+    }
+    const identifier = {
+      variant: {
+        sku: data.sku || ""
+      }
+    };
+    const result = {
+      identifier,
+      onSale: options.includeDiscounts && !!price.discounted,
+      tieredPrices: [],
+      unitPrice
+    };
+    return this.priceSchema.parse(result);
+  }
+}
+export {
+  CommercetoolsPriceFactory
+};

package/factories/product/product-factory-baseline.example.js

@@ -0,0 +1,10 @@
+import { ProductSchema } from "@reactionary/core";
+import { CommercetoolsProductFactory } from "./product.factory.js";
+import { assertNotAny, assertType } from "./utils.example.js";
+const context = {};
+const baseFactory = new CommercetoolsProductFactory(ProductSchema);
+const baseProduct = baseFactory.parseProduct(context, {});
+assertNotAny(baseProduct);
+assertNotAny(baseProduct.name);
+assertType(baseProduct.name);
+assertType(baseProduct.extendedValue);

package/factories/product/product-factory-schema-and-parse-extension.example.js

@@ -0,0 +1,25 @@
+import { ProductSchema } from "@reactionary/core";
+import { CommercetoolsProductFactory } from "./product.factory.js";
+import * as z from "zod";
+import { assertNotAny, assertType } from "./utils.example.js";
+const context = {};
+const ExtendedProductSchema = ProductSchema.safeExtend({
+  extendedValue: z.string()
+});
+class ExtendedCommercetoolsProductFactory extends CommercetoolsProductFactory {
+  constructor() {
+    super(ExtendedProductSchema);
+  }
+  parseProduct(context2, data) {
+    const base = super.parseProduct(context2, data);
+    return {
+      ...base,
+      extendedValue: "from-parse"
+    };
+  }
+}
+const extendedFactory = new ExtendedCommercetoolsProductFactory();
+const extendedProduct = extendedFactory.parseProduct(context, {});
+assertNotAny(extendedProduct);
+assertNotAny(extendedProduct.extendedValue);
+assertType(extendedProduct.extendedValue);

package/factories/product/product-factory-schema-extension.example.js

@@ -0,0 +1,18 @@
+import { ProductSchema } from "@reactionary/core";
+import { CommercetoolsProductFactory } from "./product.factory.js";
+import * as z from "zod";
+import { assertNotAny, assertType } from "./utils.example.js";
+const context = {};
+const ExtendedProductSchema = ProductSchema.safeExtend({
+  extendedValue: z.string()
+});
+class ExtendedCommercetoolsProductFactory extends CommercetoolsProductFactory {
+  constructor() {
+    super(ExtendedProductSchema);
+  }
+}
+const extendedFactory = new ExtendedCommercetoolsProductFactory();
+const extendedProduct = extendedFactory.parseProduct(context, {});
+assertNotAny(extendedProduct);
+assertNotAny(extendedProduct.extendedValue);
+assertType(extendedProduct.extendedValue);

package/factories/product/product-initializer-factory-extension.example.js

@@ -0,0 +1,33 @@
+import { ProductSchema } from "@reactionary/core";
+import { CommercetoolsProductFactory } from "./product.factory.js";
+import { withCommercetoolsCapabilities } from "../../core/initialize.js";
+import * as z from "zod";
+import { assertNotAny, assertType } from "./utils.example.js";
+const cache = {};
+const context = {};
+const config = {};
+const ExtendedProductSchema = ProductSchema.safeExtend({
+  extendedValue: z.string()
+});
+class ExtendedCommercetoolsProductFactory extends CommercetoolsProductFactory {
+  constructor() {
+    super(ExtendedProductSchema);
+  }
+}
+const capabilityFactory = withCommercetoolsCapabilities(config, {
+  product: {
+    enabled: true,
+    factory: new ExtendedCommercetoolsProductFactory()
+  }
+});
+const client = capabilityFactory(cache, context);
+client.product.getById({
+  identifier: { key: "p-1" }
+}).then((x) => {
+  assertNotAny(x);
+  if (x.success) {
+    assertNotAny(x.value);
+    assertNotAny(x.value.extendedValue);
+    assertType(x.value.extendedValue);
+  }
+});

package/factories/product/product-provider-custom-method-only.example.js

@@ -0,0 +1,38 @@
+import { ProductSchema } from "@reactionary/core";
+import { CommercetoolsProductFactory } from "./product.factory.js";
+import { CommercetoolsProductProvider } from "../../providers/product.provider.js";
+import { withCommercetoolsCapabilities } from "../../core/initialize.js";
+import { assertNotAny, assertType } from "./utils.example.js";
+const cache = {};
+const context = {};
+const config = {};
+const api = {};
+class ExtendedCommercetoolsProductProvider extends CommercetoolsProductProvider {
+  async getByCustomIdentifier(identifier) {
+    return this.getById({
+      identifier: { key: identifier }
+    });
+  }
+}
+const withExtendedProviderFactory = withCommercetoolsCapabilities(config, {
+  product: {
+    enabled: true,
+    factory: new CommercetoolsProductFactory(ProductSchema),
+    provider: ({ cache: cache2, context: context2, config: config2, commercetoolsApi }) => new ExtendedCommercetoolsProductProvider(
+      cache2,
+      context2,
+      config2,
+      commercetoolsApi,
+      new CommercetoolsProductFactory(ProductSchema)
+    )
+  }
+});
+const client = withExtendedProviderFactory(cache, context);
+client.product.getByCustomIdentifier("p-2").then((x) => {
+  assertNotAny(x);
+  if (x.success) {
+    assertNotAny(x.value);
+    assertNotAny(x.value.name);
+    assertType(x.value.name);
+  }
+});

package/factories/product/product-provider-schema-signature-extension.example.js

@@ -0,0 +1,46 @@
+import { ProductQueryByIdSchema, ProductSchema } from "@reactionary/core";
+import { CommercetoolsProductFactory } from "./product.factory.js";
+import { CommercetoolsProductProvider } from "../../providers/product.provider.js";
+import * as z from "zod";
+import { assertNotAny, assertType } from "./utils.example.js";
+const cache = {};
+const context = {};
+const config = {};
+const api = {};
+const ExtendedProductSchema = ProductSchema.safeExtend({
+  extendedValue: z.string()
+});
+class ExtendedCommercetoolsProductFactory extends CommercetoolsProductFactory {
+  constructor() {
+    super(ExtendedProductSchema);
+  }
+}
+const ExtendedProductQueryByIdSchema = ProductQueryByIdSchema.extend({
+  auditTrail: z.boolean()
+});
+class ExtendedCommercetoolsProductProvider extends CommercetoolsProductProvider {
+  async getById(payload) {
+    const basePayload = {
+      identifier: payload.identifier
+    };
+    return super.getById(basePayload);
+  }
+}
+const extendedProvider = new ExtendedCommercetoolsProductProvider(
+  cache,
+  context,
+  config,
+  api,
+  new ExtendedCommercetoolsProductFactory()
+);
+extendedProvider.getById({
+  identifier: { key: "p-1" },
+  auditTrail: true
+}).then((x) => {
+  assertNotAny(x);
+  if (x.success) {
+    assertNotAny(x.value);
+    assertNotAny(x.value.extendedValue);
+    assertType(x.value.extendedValue);
+  }
+});