@mframework/layer-commerce 0.0.3

package/app/normalizers/Order.type.ts

@@ -0,0 +1,268 @@
+/**
+ * ScandiPWA - Progressive Web App for Magento
+ *
+ * Copyright © Scandiweb, Inc. All rights reserved.
+ * See LICENSE for license details.
+ *
+ * @license OSL-3.0 (Open Software License ("OSL") v. 3.0)
+ * @package scandipwa/scandipwa-theme
+ * @link https://github.com/scandipwa/scandipwa
+ */
+
+import { GQLCurrencyEnum } from '../types/Graphql.type';
+import { Order as DomainOrder, CartItem as DomainCartItem, Product as DomainProduct } from '../types/domain';
+
+export interface CustomerDownloadableProduct {
+    order_id: string;
+    order_increment_id: number;
+    date: string;
+    status: string;
+    download_url: string;
+    link_title: string;
+    remaining_downloads: number;
+    title: string;
+}
+
+export interface PaymentMethodAdditionalData {
+    name: string;
+    value: string;
+}
+
+export interface OrderPaymentMethod {
+    name: string;
+    type: string;
+    purchase_number: string;
+    additional_data: PaymentMethodAdditionalData;
+}
+
+export interface Money {
+    value?: string;
+    currency?: GQLCurrencyEnum;
+}
+
+export interface BundleOption {
+    title: string;
+    qty: number;
+    price: number;
+}
+
+export interface OrderProductSelectedOption {
+    label: string;
+    value: string;
+    items: BundleOption[];
+    linkItems: string[];
+}
+
+export interface BaseOrderItemProduct {
+    product_name: string;
+    product_sku: string;
+    product_sale_price: Money;
+}
+
+export interface CheckoutUserInputError {
+    code: string;
+    message: string;
+    path: string;
+}
+
+export interface SalesCommentItem {
+    timestamp: string;
+    message: string;
+}
+
+export interface Discount {
+    label: string;
+    amount: Money;
+}
+
+export interface TaxItem {
+    rate: number;
+    title: string;
+    amount: Money;
+}
+
+export interface ShippingHandling {
+    amount_excluding_tax: Money;
+    amount_including_tax: Money;
+    discounts: Discount[];
+    total_amount: Money;
+    taxes: TaxItem[];
+}
+
+export interface OrderTotal {
+    grand_total: Money;
+    discounts: Discount[];
+    base_grand_total: Money;
+    subtotal: Money;
+    total_shipping: Money;
+    total_tax: Money;
+    shipping_handling: ShippingHandling;
+    taxes: TaxItem[];
+}
+
+export interface ShipmentTracking {
+    carrier: string;
+    number: string;
+    title: string;
+}
+
+export interface ShipmentItemInterface {
+    quantity_shipped: number;
+    product_name: string;
+    product_sku: string;
+    product_sale_price: Money;
+    product_url_key: string;
+}
+
+export interface OrderShipment {
+    id: string;
+    number: string;
+    comments: SalesCommentItem[];
+    tracking: ShipmentTracking[];
+    items: ShipmentItemInterface[];
+}
+
+export interface OrderItemProduct {
+    product_url_key: string;
+    quantity_ordered: number;
+    quantity_shipped: number;
+    quantity_refunded: number;
+    quantity_canceled: number;
+    quantity_returned: number;
+    entered_options: OrderProductSelectedOption[];
+    selected_options: OrderProductSelectedOption[];
+    row_subtotal: Money;
+    product_name: string;
+    product_sku: string;
+    product_sale_price: Money;
+}
+
+export interface RefundItem {
+    quantity_refunded: number;
+    product_name: string;
+    product_sku: string;
+    product_sale_price: Money;
+    order_item: OrderItemProduct;
+    row_subtotal: Money;
+    discounts: Discount[];
+    product_url_key: string;
+}
+
+export interface CreditMemo {
+    id: string;
+    number: string;
+    comments: SalesCommentItem[];
+    items: RefundItem[];
+    total: OrderTotal;
+}
+
+export interface InvoiceItem {
+    quantity_invoiced: number;
+    row_subtotal: Money;
+    product_name: string;
+    product_sku: string;
+    product_sale_price: Money;
+    product_url_key: string;
+}
+
+export interface Invoice {
+    id: string;
+    number: string;
+    comments: SalesCommentItem[];
+    items: InvoiceItem[];
+    total: OrderTotal;
+}
+
+export interface OrderAddress {
+    city: string;
+    country_id: number;
+    firstname: string;
+    lastname: string;
+    postcode: string;
+    region: string;
+    region_id: number;
+    telephone: string;
+    vat_id: string;
+    street: string[];
+}
+
+export interface OrderItem {
+    id: string;
+    increment_id: string;
+    created_at: string;
+    order_date: string;
+    status: string;
+    can_reorder: boolean;
+    rss_link: string;
+    total: OrderTotal;
+    carrier: string;
+    shipments: OrderShipment[];
+    items: OrderItemProduct[];
+    invoices: Invoice[];
+    credit_memos: CreditMemo[];
+    shipping_address: OrderAddress;
+    billing_address: OrderAddress;
+    payment_methods: OrderPaymentMethod[];
+    shipping_method: string;
+    comments: SalesCommentItem[];
+}
+
+/**
+ * Minimal order normalizer: converts a raw order object into the canonical
+ * `DomainOrder` used by the commerce layer. This is intentionally permissive
+ * and maps only commonly-used fields (id/number/items/total/status/created_at).
+ */
+export function normalizeOrder(raw: any): DomainOrder {
+    if (!raw) return raw;
+    const id = raw?.id ?? raw?.order_id ?? raw?.increment_id ?? '';
+    const number = raw?.increment_id ?? raw?.order_number ?? raw?.number ?? '';
+    const items: DomainCartItem[] = Array.isArray(raw?.items)
+        ? raw.items.map((it: any) => ({
+            id: String(it?.id ?? it?.item_id ?? it?.uid ?? ''),
+            sku: it?.sku ?? it?.product_sku ?? it?.product?.sku,
+            quantity: it?.quantity ?? it?.qty ?? it?.quantity_ordered ?? 0,
+            product: it?.product ? {
+                id: String(it.product?.id ?? it.product?.sku ?? it.product?.uid ?? ''),
+                sku: it.product?.sku,
+                title: it.product?.name ?? it.product?.title ?? it.product?.product_name,
+                price: (it.product?.price && (it.product.price.final_price?.value ?? it.product.price)) ?? it.price ?? 0,
+                images: Array.isArray(it.product?.media_gallery_entries)
+                    ? it.product.media_gallery_entries.map((m: any) => ({ url: m.file ?? m.url }))
+                    : []
+            } as DomainProduct : undefined,
+            raw: it,
+        })) : [];
+
+    const total = raw?.total ?? raw?.grand_total ?? raw?.total_amount ?? (raw?.prices?.grand_total?.value ?? undefined);
+
+    return {
+        id: String(id),
+        number,
+        items,
+        total,
+        status: raw?.status ?? raw?.state,
+        created_at: raw?.created_at ?? raw?.order_date,
+        raw,
+    };
+}
+
+export interface SearchResultPageInfo {
+    current_page: number;
+    page_size: number;
+    total_pages: number;
+}
+
+export interface CustomerOrders {
+    total_count: number;
+    items: OrderItem[];
+    page_info: SearchResultPageInfo;
+}
+
+export interface OrdersOptions {
+    orderId: number;
+    page: number;
+}
+
+export interface ReorderOutput {
+    userInputErrors: CheckoutUserInputError[];
+}

package/app/normalizers/Payment.type.ts

@@ -0,0 +1,28 @@
+import { PaymentIntent as DomainPaymentIntent } from '../types/domain';
+
+export interface PaymentFragment {
+  id: string;
+  status?: string;
+  amount?: number;
+  currency?: string;
+  method?: string;
+}
+
+export function normalizePayment(raw: any): DomainPaymentIntent {
+  if (!raw) return raw;
+  return {
+    id: String(raw?.id ?? raw?.payment_id ?? raw?.uid ?? ''),
+    status: raw?.status ?? raw?.state,
+    amount: raw?.amount ?? raw?.value ?? raw?.total ?? raw?.amount_paid,
+    currency: raw?.currency ?? raw?.currency_code,
+    method: raw?.method ?? raw?.payment_method ?? raw?.method_type,
+    raw,
+  } as DomainPaymentIntent;
+}
+
+export function normalizePayments(raw: any): DomainPaymentIntent[] {
+  if (!raw) return [];
+  if (Array.isArray(raw)) return raw.map(normalizePayment);
+  if (Array.isArray(raw?.items)) return raw.items.map(normalizePayment);
+  return [];
+}

package/app/normalizers/ProductAlerts.query.ts

@@ -0,0 +1,23 @@
+/**
+ * ScandiPWA - Progressive Web App for Magento
+ *
+ * Copyright © Scandiweb, Inc. All rights reserved.
+ * See LICENSE for license details.
+ *
+ * @license OSL-3.0 (Open Software License ("OSL") v. 3.0)
+ * @package scandipwa/scandipwa
+ * @link https://github.com/scandipwa/scandipwa
+ */
+
+import { Mutation } from '@tilework/opus';
+
+/** @namespace ../../normalizers/ProductAlerts/Query */
+export class ProductAlertsQuery {
+    getProductAlertSubscribeMutation(productId: string, type: string): Mutation<'productAlertSubscribe', boolean> {
+        return new Mutation<'productAlertSubscribe', boolean>('productAlertSubscribe')
+            .addArgument('productId', 'ID!', productId)
+            .addArgument('type', 'String!', type);
+    }
+}
+
+export default new ProductAlertsQuery();

package/app/normalizers/ProductCompare.query.ts

@@ -0,0 +1,226 @@
+/**
+ * ScandiPWA - Progressive Web App for Magento
+ *
+ * Copyright © Scandiweb, Inc. All rights reserved.
+ * See LICENSE for license details.
+ *
+ * @license OSL-3.0 (Open Software License ("OSL") v. 3.0)
+ * @package scandipwa/scandipwa-theme
+ * @link https://github.com/scandipwa/scandipwa-theme
+ */
+
+import {
+    Field,
+    InlineFragment,
+    Mutation,
+    Query,
+} from '@tilework/opus';
+
+import { ProductListQuery } from './ProductList.query';
+
+import {
+    AssignCompareListToCustomerOutput,
+    ComparableAttribute,
+    ComparableItem,
+    ComparableItemAttribute,
+    ComparableProduct,
+    CompareList,
+    ProductId,
+    normalizeCompareList,
+} from './ProductCompare.type';
+import { CustomizableProductFragmentOptions } from './ProductList.type';
+import { Product as DomainProduct } from '../types/domain';
+
+/** @namespace ../../normalizers/ProductCompare/Query */
+export class ProductCompareQuery extends ProductListQuery {
+    getCreateEmptyCompareList(): Mutation<'createCompareList', CompareList> {
+        return new Mutation<'createCompareList', CompareList>('createCompareList')
+            .addArgument('input', 'CreateCompareListInput', {})
+            .addFieldList(this._getCompareListFields());
+    }
+
+    getCreateCompareList(products: string[]): Mutation<'createCompareList', CompareList> {
+        return new Mutation<'createCompareList', CompareList>('createCompareList')
+            .addArgument('input', 'CreateCompareListInput', { products })
+            .addFieldList(this._getCompareListFields());
+    }
+
+    getDeleteCompareList(uid: string): Mutation<'deleteCompareList', { result: boolean }> {
+        return new Mutation<'deleteCompareList', { result: boolean }>('deleteCompareList')
+            .addArgument('uid', 'ID!', uid)
+            .addField('result');
+    }
+
+    getAddProductsToCompareList(
+        uid: string,
+        products: string[],
+    ): Mutation<'addProductsToCompareList', CompareList> {
+        return new Mutation<'addProductsToCompareList', CompareList>('addProductsToCompareList')
+            .addArgument('input', 'AddProductsToCompareListInput', { uid, products })
+            .addFieldList(this._getCompareListFields());
+    }
+
+    getRemoveProductsFromCompareList(
+        uid: string,
+        products: string[],
+    ): Mutation<'removeProductsFromCompareList', CompareList> {
+        return new Mutation<'removeProductsFromCompareList', CompareList>('removeProductsFromCompareList')
+            .addArgument('input', 'RemoveProductsFromCompareListInput', { uid, products })
+            .addFieldList(this._getCompareListFields());
+    }
+
+    getAssignCompareList(uid: string): Mutation<'assignCompareListToCustomer', AssignCompareListToCustomerOutput> {
+        return new Mutation<'assignCompareListToCustomer', AssignCompareListToCustomerOutput>(
+            'assignCompareListToCustomer',
+        )
+            .addArgument('uid', 'ID!', uid)
+            .addFieldList(this._getAssignFields());
+    }
+
+    _getAssignFields(): Array<
+    Field<'result', boolean>
+    | Field<'compare_list', CompareList>
+    > {
+        return [
+            new Field<'result', boolean>('result'),
+            this._getAssignCompareListField(),
+        ];
+    }
+
+    _getAssignCompareListField(): Field<'compare_list', CompareList> {
+        return new Field<'compare_list', CompareList>('compare_list')
+            .addFieldList(this._getCompareListFields());
+    }
+
+    getCompareList(uid: string): Query<'compareList', CompareList> {
+        return new Query<'compareList', CompareList>('compareList')
+            .addArgument('uid', 'ID!', uid)
+            .addFieldList(this._getCompareListFields());
+    }
+
+    getCompareListIds(uid: string): Query<'compareList', { items: ProductId[] }> {
+        return new Query<'compareList', { items: ProductId[] }>('compareList')
+            .addArgument('uid', 'ID!', uid)
+            .addField(this._getComparableItemIdsField());
+    }
+
+    _getCompareListFields(): Array<
+    Field<'uid', string>
+    | Field<'item_count', number>
+    | Field<'attributes', ComparableAttribute, true>
+    | Field<'items', ComparableItem, true>
+    > {
+        return [
+            new Field<'uid', string>('uid'),
+            new Field<'item_count', number>('item_count'),
+            this._getCompareAttributeField(),
+            this._getComparableItemField(),
+        ];
+    }
+
+    _getCompareAttributeField(): Field<'attributes', ComparableAttribute, true> {
+        return new Field<'attributes', ComparableAttribute, true>('attributes', true)
+            .addFieldList(this._getCompareAttributeFields());
+    }
+
+    _getCompareAttributeFields(): Array<
+    Field<'label', string>
+    | Field<'code', string>
+    > {
+        return [
+            new Field<'label', string>('label'),
+            new Field<'code', string>('code'),
+        ];
+    }
+
+    _getComparableItemAttributeField(): Field<'attributes', ComparableItemAttribute, true> {
+        return new Field<'attributes', ComparableItemAttribute, true>('attributes', true)
+            .addFieldList(this._getComparableItemAttributeFields());
+    }
+
+    _getComparableItemAttributeFields(): Array<
+    Field<'value', string>
+    | Field<'code', string>
+    > {
+        return [
+            new Field<'value', string>('value'),
+            new Field<'code', string>('code'),
+        ];
+    }
+
+    _getComparableItemFields(): Array<
+    Field<'product', ComparableProduct | DomainProduct>
+    | Field<'attributes', ComparableItemAttribute, true>
+    > {
+        return [
+            this._getCompareProductField(),
+            this._getComparableItemAttributeField(),
+        ];
+    }
+
+    _getComparableItemIdsFields(): Field<'product', { id: number }>[] {
+        return [
+            this._getProductIdsField(),
+        ];
+    }
+
+    _getCompareProductField(): Field<'product', ComparableProduct> {
+        return new Field<'product', ComparableProduct>('product')
+            .addFieldList(this._getProductInterfaceFields(true, false))
+            .addFieldList([new Field<'url', string>('url')])
+            .addField(this._getReviewCountField())
+            .addField(this._getRatingSummaryField())
+            .addField(this._getDescriptionField())
+            .addField(this._getGroupedProductItems())
+            .addField(this._getDownloadableProductLinksRequired())
+            .addField(this._getCustomizableProductFragment());
+    }
+
+    _getCustomizableProductFragment(): InlineFragment<'CustomizableProductInterface', {
+        options: CustomizableProductFragmentOptions[];
+    }> {
+        return new InlineFragment<'CustomizableProductInterface', {
+            options: CustomizableProductFragmentOptions[];
+        }>(
+            'CustomizableProductInterface',
+        )
+            .addFieldList([this._getCustomizableProductRequiredOptionsField()]);
+    }
+
+    _getCustomizableProductRequiredOptionsField(): Field<'options', CustomizableProductFragmentOptions, true> {
+        return new Field<'options', CustomizableProductFragmentOptions, true>('options', true)
+            .addField(new Field<'required', boolean>('required'));
+    }
+
+    _getProductIdsField(): Field<'product', { id: number }> {
+        return new Field<'product', { id: number }>('product')
+            .addFieldList(this._getProductIdsFields());
+    }
+
+    _getComparableItemField(): Field<'items', ComparableItem, true> {
+        return new Field<'items', ComparableItem, true>('items', true)
+            .addFieldList(this._getComparableItemFields());
+    }
+
+    _getComparableItemIdsField(): Field<'items', ProductId, true> {
+        return new Field<'items', { product: { id: number } }, true>('items')
+            .addFieldList(this._getComparableItemIdsFields());
+    }
+
+    _getProductIdsFields(): Field<'id', number>[] {
+        return [
+            new Field<'id', number>('id'),
+        ];
+    }
+}
+
+export default new ProductCompareQuery();
+
+// Helper to normalize a compareList GraphQL response into the domain-friendly
+// `CompareList` shape via the normalizer. Accepts either the root response
+// ({ compareList }) or the compare list object itself.
+export function normalizeCompareResponse(raw: any): CompareList {
+    if (!raw) return raw;
+    if (raw.compareList) return normalizeCompareList(raw.compareList as any) as CompareList;
+    return normalizeCompareList(raw as any) as CompareList;
+}

package/app/normalizers/ProductCompare.type.ts

@@ -0,0 +1,90 @@
+/**
+ * ScandiPWA - Progressive Web App for Magento
+ *
+ * Copyright © Scandiweb, Inc. All rights reserved.
+ * See LICENSE for license details.
+ *
+ * @license OSL-3.0 (Open Software License ("OSL") v. 3.0)
+ * @package scandipwa/scandipwa-theme
+ * @link https://github.com/scandipwa/scandipwa
+ */
+
+import {
+    ComplexTextValue,
+    GroupedProductItem,
+} from './ProductList.type';
+import { Product as DomainProduct } from '../types/domain';
+
+// Normalize a comparable product into a domain-friendly product + compare metadata
+export function normalizeComparableProduct(raw: any): ComparableProduct {
+    if (!raw) return raw;
+
+    const base: DomainProduct = (raw?.product ? (raw.product as any) : raw) as any;
+
+    return {
+        ...base,
+        url: raw?.url ?? base?.raw?.url ?? '',
+        review_count: Number(raw?.review_count ?? base?.raw?.review_count ?? 0),
+        rating_summary: Number(raw?.rating_summary ?? base?.raw?.rating_summary ?? 0),
+        description: raw?.description ?? base?.raw?.description ?? { html: '' },
+        GroupedProduct: { items: (raw?.GroupedProduct?.items ?? base?.raw?.GroupedProduct?.items ?? []) as GroupedProductItem[] },
+    } as ComparableProduct;
+}
+
+export function normalizeCompareList(raw: any): CompareList {
+    if (!raw) return raw;
+    const items = Array.isArray(raw?.items) ? raw.items.map((it: any) => ({
+        product: normalizeComparableProduct(it.product ?? it),
+        attributes: Array.isArray(it?.attributes) ? it.attributes.map((a: any) => ({ value: a?.value ?? a?.attribute_value, code: a?.code ?? a?.attribute_code })) : [],
+    })) : [];
+
+    return {
+        uid: raw?.uid ?? raw?.id ?? '',
+        item_count: raw?.item_count ?? items.length,
+        attributes: Array.isArray(raw?.attributes) ? raw.attributes.map((a: any) => ({ label: a?.label ?? a?.attribute_label ?? '', code: a?.code ?? a?.attribute_code ?? '' })) : [],
+        items,
+    } as CompareList;
+}
+
+export interface ProductId {
+    product: {
+        id: number;
+    };
+}
+
+export interface ComparableAttribute {
+    label: string;
+    code: string;
+}
+
+export interface ComparableItemAttribute {
+    value: string;
+    code: string;
+}
+
+export type ComparableProduct = Omit<DomainProduct, 'description'> & {
+    url: string;
+    review_count: number;
+    rating_summary: number;
+    description: ComplexTextValue;
+    GroupedProduct: {
+        items: GroupedProductItem[];
+    };
+}
+
+export interface ComparableItem {
+    product: ComparableProduct;
+    attributes: ComparableItemAttribute[];
+}
+
+export interface CompareList {
+    uid: string;
+    item_count: number;
+    attributes: ComparableAttribute[];
+    items: ComparableItem[];
+}
+
+export interface AssignCompareListToCustomerOutput {
+    result: boolean;
+    compare_list: CompareList;
+}