@reactionary/source 0.6.1 → 0.6.3

package/packages/commercetools/src/factories/cart/cart.factory.ts

@@ -0,0 +1,142 @@
+import type { Cart as CTCart, LineItem } from '@commercetools/platform-sdk';
+import type {
+  CartIdentifierSchema,
+  CartSchema} from '@reactionary/core';
+import {
+  CartItemSchema,
+  type AnyCartIdentifierSchema,
+  type AnyCartSchema,
+  type Cart,
+  type CartFactory,
+  type CartIdentifier,
+  type CartItem,
+  type CostBreakDown,
+  type Currency,
+  type RequestContext,
+} from '@reactionary/core';
+import type * as z from 'zod';
+
+export class CommercetoolsCartFactory<
+  TCartSchema extends AnyCartSchema = typeof CartSchema,
+  TCartIdentifierSchema extends AnyCartIdentifierSchema = typeof CartIdentifierSchema,
+> implements CartFactory<TCartSchema, TCartIdentifierSchema>
+{
+  public readonly cartSchema: TCartSchema;
+  public readonly cartIdentifierSchema: TCartIdentifierSchema;
+
+  constructor(cartSchema: TCartSchema, cartIdentifierSchema: TCartIdentifierSchema) {
+    this.cartSchema = cartSchema;
+    this.cartIdentifierSchema = cartIdentifierSchema;
+  }
+
+  public parseCartIdentifier(
+    _context: RequestContext,
+    data: { key?: string },
+  ): z.output<TCartIdentifierSchema> {
+    return this.cartIdentifierSchema.parse({
+      key: data.key || '',
+    } satisfies Partial<CartIdentifier>);
+  }
+
+  public parseCart(
+    context: RequestContext,
+    data: CTCart,
+  ): z.output<TCartSchema> {
+    const identifier = this.parseCartIdentifier(context, {
+      key: data.id,
+    });
+
+    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 as Currency;
+
+    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,
+      },
+    } satisfies CostBreakDown;
+
+    const items: CartItem[] = [];
+    for (const lineItem of data.lineItems) {
+      items.push(this.parseCartItem(lineItem));
+    }
+
+    const result = {
+      identifier,
+      userId: {
+        userId: '???',
+      },
+      name: data.custom?.fields['name'] || '',
+      description: data.custom?.fields['description'] || '',
+      price,
+      items,
+      appliedPromotions: [],
+    } satisfies Cart;
+
+    return this.cartSchema.parse(result);
+  }
+
+  protected parseCartItem(lineItem: LineItem): CartItem {
+    const unitPrice = lineItem.price.value.centAmount;
+    const totalPrice = lineItem.totalPrice.centAmount || 0;
+    const totalDiscount = lineItem.price.discounted?.value.centAmount || 0;
+    const unitDiscount = totalDiscount / lineItem.quantity;
+    const currency = lineItem.price.value.currencyCode.toUpperCase() as Currency;
+
+    return CartItemSchema.parse({
+      identifier: {
+        key: lineItem.id,
+      },
+      product: {
+        key: lineItem.productId,
+      },
+      variant: {
+        sku: lineItem.variant.sku || '',
+      },
+      quantity: lineItem.quantity,
+      price: {
+        unitPrice: {
+          value: unitPrice / 100,
+          currency,
+        },
+        unitDiscount: {
+          value: unitDiscount / 100,
+          currency,
+        },
+        totalPrice: {
+          value: totalPrice / 100,
+          currency,
+        },
+        totalDiscount: {
+          value: totalDiscount / 100,
+          currency,
+        },
+      },
+    } satisfies Partial<CartItem>);
+  }
+}

package/packages/commercetools/src/factories/category/category.factory.ts

@@ -0,0 +1,77 @@
+import type { Category as CTCategory, CategoryPagedQueryResponse } from '@commercetools/platform-sdk';
+import type {
+  CategoryPaginatedResultSchema,
+  CategorySchema} from '@reactionary/core';
+import {
+  type AnyCategoryPaginatedResultSchema,
+  type AnyCategorySchema,
+  type Category,
+  type CategoryFactory,
+  type CategoryIdentifier,
+  type CategoryPaginatedResult,
+  type RequestContext,
+} from '@reactionary/core';
+import type * as z from 'zod';
+
+export class CommercetoolsCategoryFactory<
+  TCategorySchema extends AnyCategorySchema = typeof CategorySchema,
+  TCategoryPaginatedSchema extends AnyCategoryPaginatedResultSchema = typeof CategoryPaginatedResultSchema,
+> implements CategoryFactory<TCategorySchema, TCategoryPaginatedSchema>
+{
+  public readonly categorySchema: TCategorySchema;
+  public readonly categoryPaginatedResultSchema: TCategoryPaginatedSchema;
+
+  constructor(
+    categorySchema: TCategorySchema,
+    categoryPaginatedResultSchema: TCategoryPaginatedSchema,
+  ) {
+    this.categorySchema = categorySchema;
+    this.categoryPaginatedResultSchema = categoryPaginatedResultSchema;
+  }
+
+  public parseCategory(
+    context: RequestContext,
+    data: CTCategory,
+  ): z.output<TCategorySchema> {
+    const identifier = { key: data.key || '' } satisfies CategoryIdentifier;
+    const result = {
+      identifier,
+      name: data.name[context.languageContext.locale] || 'No Name',
+      slug: data.slug ? data.slug[context.languageContext.locale] || '' : '',
+      text: data.description ? data.description[context.languageContext.locale] || '' : '',
+      parentCategory:
+        data.parent && data.parent.obj && data.parent.obj?.key
+          ? { key: data.parent.obj.key }
+          : undefined,
+      images: (data.assets || [])
+        .filter((asset) => asset.sources.length > 0)
+        .filter((asset) => asset.sources[0].contentType?.startsWith('image/'))
+        .map((asset) => ({
+          sourceUrl: asset.sources[0].uri,
+          altText:
+            asset.description?.[context.languageContext.locale] ||
+            asset.name[context.languageContext.locale] ||
+            '',
+          height: asset.sources[0].dimensions?.h || 0,
+          width: asset.sources[0].dimensions?.w || 0,
+        })),
+    } satisfies Category;
+
+    return this.categorySchema.parse(result);
+  }
+
+  public parseCategoryPaginatedResult(
+    context: RequestContext,
+    data: CategoryPagedQueryResponse,
+  ): z.output<TCategoryPaginatedSchema> {
+    const result = {
+      pageNumber: Math.floor(data.offset / data.count) + 1,
+      pageSize: data.count,
+      totalCount: data.total || 0,
+      totalPages: Math.ceil((data.total ?? 0) / data.count),
+      items: data.results.map((category) => this.parseCategory(context, category)),
+    } satisfies CategoryPaginatedResult;
+
+    return this.categoryPaginatedResultSchema.parse(result);
+  }
+}

package/packages/commercetools/src/factories/checkout/checkout-initializer-overrides.example.ts

@@ -0,0 +1,94 @@
+import type { Cart as CTCart } from "@commercetools/platform-sdk";
+import {
+  CheckoutSchema,
+  PaymentMethodSchema,
+  ShippingMethodSchema,
+  type CheckoutQueryById,
+  type RequestContext,
+  unwrapValue,
+} from "@reactionary/core";
+import { withCommercetoolsCapabilities } from "../../core/initialize.js";
+import { CommercetoolsCheckoutCapability } from "../../capabilities/checkout.capability.js";
+import { assertNotAny, assertType } from "../product/utils.example.js";
+import { CommercetoolsCheckoutFactory } from "./checkout.factory.js";
+import * as z from "zod";
+
+const cache = {} as any;
+const context = {} as any;
+const config = {} as any;
+
+const ExtendedCheckoutSchema = CheckoutSchema.safeExtend({
+  extendedValue: z.string().default(""),
+});
+
+type ExtendedCheckout = z.output<typeof ExtendedCheckoutSchema>;
+
+class ExtendedCommercetoolsCheckoutFactory extends CommercetoolsCheckoutFactory<
+  typeof ExtendedCheckoutSchema,
+  typeof ShippingMethodSchema,
+  typeof PaymentMethodSchema
+> {
+  constructor() {
+    super(ExtendedCheckoutSchema, ShippingMethodSchema, PaymentMethodSchema);
+  }
+
+  public override parseCheckout(
+    context: RequestContext,
+    data: CTCart,
+  ): ExtendedCheckout {
+    const base = super.parseCheckout(context, data);
+    return {
+      ...base,
+      extendedValue: "from-factory",
+    };
+  }
+}
+
+class ExtendedCommercetoolsCheckoutCapability extends CommercetoolsCheckoutCapability<ExtendedCommercetoolsCheckoutFactory> {
+  public async getByIdOrThrow(payload: CheckoutQueryById): Promise<ExtendedCheckout> {
+    const result = await this.getById(payload);
+    return unwrapValue(result);
+  }
+}
+
+const extendedFactory = new ExtendedCommercetoolsCheckoutFactory();
+
+const capabilityFactory = withCommercetoolsCapabilities(config, {
+  checkout: {
+    enabled: true,
+    factory: extendedFactory,
+    capability: ({ cache, context, config, commercetoolsApi }) =>
+      new ExtendedCommercetoolsCheckoutCapability(
+        config,
+        cache,
+        context,
+        commercetoolsApi,
+        extendedFactory,
+      ),
+  },
+});
+
+const client = capabilityFactory(cache, context);
+
+client.checkout
+  .getById({
+    identifier: { key: "checkout-1" },
+  })
+  .then((result) => {
+    assertNotAny(result);
+    if (result.success) {
+      assertNotAny(result.value);
+      assertNotAny(result.value.extendedValue);
+      assertType<string>(result.value.extendedValue);
+    }
+  });
+
+client.checkout
+  .getByIdOrThrow({
+    identifier: { key: "checkout-2" },
+  })
+  .then((checkout) => {
+    assertNotAny(checkout);
+    assertNotAny(checkout.extendedValue);
+    assertType<string>(checkout.extendedValue);
+  });

package/packages/commercetools/src/factories/checkout/checkout.factory.ts

@@ -0,0 +1,338 @@
+import type {
+  Address as CTAddress,
+  Cart as CTCart,
+  LineItem,
+  Payment as CTPayment,
+  ShippingMethod as CTShippingMethod,
+} from '@commercetools/platform-sdk';
+import type {
+  CheckoutSchema,
+  PaymentMethodSchema,
+  ShippingMethodSchema} from '@reactionary/core';
+import {
+  CheckoutItemSchema,
+  type Address,
+  type AnyCheckoutSchema,
+  type AnyPaymentMethodSchema,
+  type AnyShippingMethodSchema,
+  type Checkout,
+  type CheckoutFactory,
+  type CheckoutIdentifier,
+  type CheckoutItem,
+  type CostBreakDown,
+  type Currency,
+  type MonetaryAmount,
+  type PaymentInstruction,
+  type PaymentInstructionIdentifier,
+  type PaymentMethod,
+  type PaymentMethodIdentifier,
+  type PaymentStatus,
+  type RequestContext,
+  type ShippingInstruction,
+  type ShippingMethod,
+  type ShippingMethodIdentifier,
+} from '@reactionary/core';
+import type * as z from 'zod';
+import type {
+  CommercetoolsCartIdentifier,
+  CommercetoolsCheckoutIdentifier,
+} from '../../schema/commercetools.schema.js';
+
+export class CommercetoolsCheckoutFactory<
+  TCheckoutSchema extends AnyCheckoutSchema = typeof CheckoutSchema,
+  TShippingMethodSchema extends AnyShippingMethodSchema = typeof ShippingMethodSchema,
+  TPaymentMethodSchema extends AnyPaymentMethodSchema = typeof PaymentMethodSchema,
+> implements
+    CheckoutFactory<TCheckoutSchema, TShippingMethodSchema, TPaymentMethodSchema>
+{
+  public readonly checkoutSchema: TCheckoutSchema;
+  public readonly shippingMethodSchema: TShippingMethodSchema;
+  public readonly paymentMethodSchema: TPaymentMethodSchema;
+
+  constructor(
+    checkoutSchema: TCheckoutSchema,
+    shippingMethodSchema: TShippingMethodSchema,
+    paymentMethodSchema: TPaymentMethodSchema,
+  ) {
+    this.checkoutSchema = checkoutSchema;
+    this.shippingMethodSchema = shippingMethodSchema;
+    this.paymentMethodSchema = paymentMethodSchema;
+  }
+
+  public parseCheckout(
+    context: RequestContext,
+    data: CTCart,
+  ): z.output<TCheckoutSchema> {
+    const identifier = {
+      key: data.id,
+      version: data.version || 0,
+    } satisfies CommercetoolsCheckoutIdentifier;
+
+    const originalCartReference = {
+      key: data.custom?.fields['commerceToolsCartId'] || '',
+      version: 0,
+    } satisfies CommercetoolsCartIdentifier;
+
+    let shippingAddress: Address | undefined;
+    if (data.shippingAddress) {
+      shippingAddress = this.parseAddress(data.shippingAddress);
+    }
+
+    let billingAddress: Address | undefined;
+    if (data.billingAddress) {
+      billingAddress = this.parseAddress(data.billingAddress);
+    }
+
+    const paymentInstructions: PaymentInstruction[] = [];
+    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 as Currency;
+
+    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,
+      },
+    } satisfies CostBreakDown;
+
+    const items: CheckoutItem[] = [];
+    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,
+    } satisfies Checkout;
+
+    return this.checkoutSchema.parse(result);
+  }
+
+  public parseShippingMethod(
+    context: RequestContext,
+    data: CTShippingMethod,
+  ): z.output<TShippingMethodSchema> {
+    const identifier = {
+      key: data.key || '',
+    } satisfies ShippingMethodIdentifier;
+
+    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 as Currency) ||
+              context.languageContext.currencyCode,
+          }
+        : { value: 0, currency: context.languageContext.currencyCode },
+    } satisfies ShippingMethod;
+
+    return this.shippingMethodSchema.parse(result);
+  }
+
+  public parsePaymentMethod(
+    _context: RequestContext,
+    data: PaymentMethod,
+  ): z.output<TPaymentMethodSchema> {
+    return this.paymentMethodSchema.parse(data);
+  }
+
+  protected parseCheckoutItem(remoteItem: LineItem): CheckoutItem {
+    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() as Currency;
+
+    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,
+        },
+      },
+    } satisfies CheckoutItem;
+
+    return CheckoutItemSchema.parse(item);
+  }
+
+  protected isReadyForFinalization(
+    price: CostBreakDown,
+    paymentInstructions: PaymentInstruction[],
+    billingAddress?: Address,
+    shippingAddress?: Address,
+    shippingInstruction?: ShippingInstruction,
+  ): boolean {
+    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;
+  }
+
+  protected parsePaymentInstruction(
+    context: RequestContext,
+    data: CTPayment,
+  ): PaymentInstruction {
+    const identifier = {
+      key: data.id,
+    } satisfies PaymentInstructionIdentifier;
+
+    const amount = {
+      value: data.amountPlanned.centAmount / 100,
+      currency: data.amountPlanned.currencyCode as Currency,
+    } satisfies MonetaryAmount;
+
+    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',
+    } satisfies PaymentMethodIdentifier;
+
+    const customData = data.custom?.fields || {};
+    const protocolData = Object.keys(customData).map((key) => ({
+      key,
+      value: customData[key],
+    }));
+
+    let status: PaymentStatus = '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,
+    } satisfies PaymentInstruction;
+
+    return result;
+  }
+
+  protected parseAddress(data: CTAddress): Address {
+    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: '',
+    } satisfies Address;
+  }
+
+  protected parseShippingInstruction(data: CTCart): ShippingInstruction | undefined {
+    if (!data.shippingInfo) return undefined;
+
+    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,
+    } satisfies ShippingInstruction;
+
+    return result;
+  }
+}

package/packages/commercetools/src/factories/identity/identity.factory.ts

@@ -0,0 +1,26 @@
+import type {
+  IdentitySchema} from '@reactionary/core';
+import {
+  type AnyIdentitySchema,
+  type IdentityFactory,
+  type RequestContext,
+} from '@reactionary/core';
+import type * as z from 'zod';
+
+export class CommercetoolsIdentityFactory<
+  TIdentitySchema extends AnyIdentitySchema = typeof IdentitySchema,
+> implements IdentityFactory<TIdentitySchema>
+{
+  public readonly identitySchema: TIdentitySchema;
+
+  constructor(identitySchema: TIdentitySchema) {
+    this.identitySchema = identitySchema;
+  }
+
+  public parseIdentity(
+    _context: RequestContext,
+    data: unknown,
+  ): z.output<TIdentitySchema> {
+    return this.identitySchema.parse(data);
+  }
+}