@mframework/layer-commerce 0.0.3

package/app/normalizers/Region.query.ts

@@ -0,0 +1,58 @@
+/**
+ * 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, Query } from '@tilework/opus';
+
+import { Country, Region } from './Region.type';
+
+/**
+ * RegionQuery Mutations
+ * @class RegionQuery
+ * @namespace ../../normalizers/Region/Query */
+export class RegionQuery {
+    getCountriesQuery(): Query<'countries', Country, true> {
+        return new Query<'countries', Country, true>('countries', true)
+            .addFieldList(this._getCountryFields());
+    }
+
+    _getCountryFields(): Array<
+    Field<'id', number>
+    | Field<'is_state_required', boolean>
+    | Field<'available_regions', Region, true>
+    | Field<'label', string>
+    > {
+        return [
+            new Field<'id', number>('id'),
+            new Field<'is_state_required', boolean>('is_state_required'),
+            this._getAvailableRegionsField(),
+            new Field<'full_name_locale', string>('full_name_locale').setAlias('label'),
+        ];
+    }
+
+    _getAvailableRegionFields(): Array<
+    Field<'code', string>
+    | Field<'name', string>
+    | Field<'id', number>
+    > {
+        return [
+            new Field<'code', string>('code'),
+            new Field<'name', string>('name'),
+            new Field<'id', number>('id'),
+        ];
+    }
+
+    _getAvailableRegionsField(): Field<'available_regions', Region, true> {
+        return new Field<'available_regions', Region, true>('available_regions', true)
+            .addFieldList(this._getAvailableRegionFields());
+    }
+}
+
+export default new RegionQuery();

package/app/normalizers/Region.type.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-theme
+ * @link https://github.com/scandipwa/scandipwa
+ */
+
+export interface Region {
+    code: string;
+    name: string;
+    id: number;
+}
+
+export interface Country {
+    id: string;
+    is_state_required: boolean;
+    available_regions: Region[];
+    label: string;
+}

package/app/normalizers/Return.type.ts

@@ -0,0 +1,50 @@
+import { normalizeOrder } from './Order.type';
+import type { Order as DomainOrder } from '../types/domain';
+
+// Normalize return objects (customer returns / RMA) into a stable shape.
+// Returns frequently contain returned items and refund-related totals.
+export function normalizeReturn(raw: any): DomainOrder {
+  if (!raw) return raw;
+
+  const id = raw?.id ?? raw?.return_id ?? raw?.increment_id ?? '';
+  const number = raw?.increment_id ?? raw?.number ?? raw?.return_number ?? '';
+  const created_at = raw?.created_at ?? raw?.requested_at ?? raw?.date;
+  const status = raw?.status ?? raw?.state ?? raw?.return_status;
+
+  const items = Array.isArray(raw?.items)
+    ? raw.items.map((it: any) => ({
+        id: String(it?.id ?? it?.item_id ?? ''),
+        sku: it?.sku ?? it?.product_sku ?? it?.product?.sku,
+        quantity: it?.quantity_returned ?? it?.qty ?? it?.qty_returned ?? 0,
+        price: it?.price ?? it?.row_subtotal ?? undefined,
+        product: it?.product ? {
+          id: String(it.product?.id ?? it.product?.sku ?? ''),
+          sku: it.product?.sku,
+          title: it.product?.name ?? it.product?.title,
+        } : undefined,
+        reason: it?.reason ?? it?.return_reason,
+        raw: it,
+      }))
+    : [];
+
+  const total = raw?.total ?? raw?.refund_amount ?? raw?.grand_total ?? raw?.amount;
+
+  if (!id && !number && !Array.isArray(raw?.items)) return normalizeOrder(raw);
+
+  return {
+    id: String(id),
+    number,
+    created_at,
+    status,
+    items,
+    total,
+    raw,
+  };
+}
+
+export const normalizeReturns = (raw: any): DomainOrder[] => {
+  if (!raw) return [];
+  if (Array.isArray(raw)) return raw.map(normalizeReturn);
+  if (Array.isArray(raw.items)) return raw.items.map(normalizeReturn);
+  return [];
+};

package/app/normalizers/Review.query.ts

@@ -0,0 +1,81 @@
+/**
+ * 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, Mutation, Query } from '@tilework/opus';
+
+import { GQLCreateProductReviewInput } from '../types/Graphql.type';
+
+import {
+    CreateProductReviewOutput,
+    ReviewRatingItem,
+    ReviewRatingValue,
+} from './Review.type';
+
+/** @namespace ../../normalizers/Review/Query */
+export class ReviewQuery {
+    getAddProductReviewMutation(
+        reviewItem: GQLCreateProductReviewInput,
+    ): Mutation<'addProductReview', CreateProductReviewOutput> {
+        return new Mutation<'createProductReview', CreateProductReviewOutput>('createProductReview')
+            .setAlias('addProductReview')
+            .addArgument('input', 'CreateProductReviewInput!', reviewItem)
+            .addField(new Field('review').addField('nickname'));
+    }
+
+    getRatingQuery(): Query<'reviewRatings', { items: ReviewRatingItem[] }> {
+        return new Query<'productReviewRatingsMetadata', { items: ReviewRatingItem[] }>(
+            'productReviewRatingsMetadata',
+        )
+            .setAlias('reviewRatings')
+            .addFieldList(this._getRatingFields());
+    }
+
+    _getRatingFields(): Field<'items', ReviewRatingItem, true>[] {
+        return [
+            this._getRatingItemsField(),
+        ];
+    }
+
+    _getRatingItemsField(): Field<'items', ReviewRatingItem, true> {
+        return new Field<'items', ReviewRatingItem, true>('items', true)
+            .addFieldList(this._getRatingItemsFields());
+    }
+
+    _getRatingItemsFields(): Array<
+    Field<'rating_id', number>
+    | Field<'rating_code', string>
+    | Field<'rating_options', ReviewRatingValue, true>
+    > {
+        return [
+            new Field<'id', number>('id').setAlias('rating_id'),
+            new Field<'name', string>('name').setAlias('rating_code'),
+            this._getRatingOptionsField(),
+        ];
+    }
+
+    _getRatingOptionFields(): Array<
+    Field<'option_id', string>
+    | Field<'value', string>
+    > {
+        return [
+            new Field<'value_id', string>('value_id').setAlias('option_id'),
+            new Field<'value', string>('value'),
+        ];
+    }
+
+    _getRatingOptionsField(): Field<'rating_options', ReviewRatingValue, true> {
+        return new Field<'values', ReviewRatingValue, true>('values', true)
+            .setAlias('rating_options')
+            .addFieldList(this._getRatingOptionFields());
+    }
+}
+
+export default new ReviewQuery();

package/app/normalizers/Review.type.ts

@@ -0,0 +1,42 @@
+/**
+ * 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
+ */
+
+export interface ReviewRatingValue {
+    option_id: string;
+    value: string;
+}
+
+export interface ReviewRatingItem {
+    rating_id: number;
+    rating_code: string;
+    rating_options: ReviewRatingValue[];
+}
+
+export interface CreateProductReviewOutput {
+    review: {
+        nickname: string;
+    };
+}
+
+import type { Review as DomainReview } from '../types/domain';
+
+export function normalizeReview(raw: any): DomainReview {
+    if (!raw) return raw;
+    return {
+        id: String(raw?.id ?? raw?.review_id ?? raw?.uid ?? ''),
+        title: raw?.title ?? raw?.nickname ?? '',
+        detail: raw?.detail ?? raw?.text ?? raw?.comment ?? '',
+        rating: (raw?.rating ?? raw?.rating_summary ?? raw?.average_rating) as number | undefined,
+        created_at: raw?.created_at ?? raw?.createdAt ?? raw?.date,
+        author: raw?.author ?? raw?.nickname ?? undefined,
+        raw,
+    } as DomainReview;
+}

package/app/normalizers/Slider.query.ts

@@ -0,0 +1,72 @@
+/**
+ * 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, Query } from '@tilework/opus';
+
+import { Slide, Slider } from './Slider.type';
+
+/**
+ * Slider Query
+ * @class Slider
+ * @namespace ../../normalizers/Slider/Query */
+export class SliderQuery {
+    getQuery(options: { sliderId: string }): Query<'slider', Slider> {
+        const { sliderId } = options;
+
+        return new Query<'scandiwebSlider', Slider>('scandiwebSlider')
+            .addArgument('id', 'ID!', sliderId)
+            .addFieldList(this._getSliderFields())
+            .setAlias('slider');
+    }
+
+    _getSliderFields(): Array<
+    Field<'slides', Slide, true>
+    | Field<'slide_speed', number>
+    | Field<'slider_id', number>
+    | Field<'title', string>
+    > {
+        return [
+            this._getSlidesField(),
+            this._getSlideSpeedField(),
+            new Field<'slider_id', number>('slider_id'),
+            new Field<'title', string>('title'),
+        ];
+    }
+
+    _getSlideFields(): Array<
+    Field<'slide_text', string>
+    | Field<'slide_id', number>
+    | Field<'mobile_image', string>
+    | Field<'desktop_image', string>
+    | Field<'title', string>
+    | Field<'is_active', boolean>
+    > {
+        return [
+            new Field<'slide_text', string>('slide_text'),
+            new Field<'slide_id', number>('slide_id'),
+            new Field<'mobile_image', string>('mobile_image'),
+            new Field<'desktop_image', string>('desktop_image'),
+            new Field<'title', string>('title'),
+            new Field<'is_active', boolean>('is_active'),
+        ];
+    }
+
+    _getSlidesField(): Field<'slides', Slide, true> {
+        return new Field<'slides', Slide, true>('slides', true)
+            .addFieldList(this._getSlideFields());
+    }
+
+    _getSlideSpeedField(): Field<'slide_speed', number> {
+        return new Field<'slide_speed', number>('slide_speed');
+    }
+}
+
+export default new SliderQuery();

package/app/normalizers/Slider.type.ts

@@ -0,0 +1,26 @@
+/**
+ * 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
+ */
+
+export interface Slide {
+    slide_text: string;
+    slide_id: number;
+    mobile_image: string;
+    desktop_image: string;
+    title: string;
+    is_active: boolean;
+}
+
+export interface Slider {
+    slides: Slide[];
+    slide_speed: number;
+    slider_id: number;
+    title: string;
+}

package/app/normalizers/StoreInPickUp.query.ts

@@ -0,0 +1,54 @@
+/**
+ * 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, Query } from '@tilework/opus';
+
+import { GQLProductInfoInput } from '../types/Graphql.type';
+
+import { Store, normalizeStore } from './StoreInPickUp.type';
+
+/** @namespace ../../normalizers/StoreInPickUp/Query */
+export class StoreInPickUpQuery {
+    getStores(
+        country: string,
+        search = '',
+        productsInfo?: GQLProductInfoInput[],
+    ): Query<'getStores', { stores: Store[] }> {
+        return new Query<'getStores', { stores: Store[] }>('getStores')
+            .addFieldList([this.getStoreFields()])
+            .addArgument('search', 'String', search)
+            .addArgument('country', 'String', country)
+            .addArgument('productsInfo', '[ProductInfoInput]', productsInfo);
+    }
+
+    getStoreFields(): Field<'stores', Store, true> {
+        return new Field<'stores', Store, true>('stores', true)
+            .addFieldList([
+                new Field<'city', string>('city'),
+                new Field<'country', string>('country'),
+                new Field<'description', string>('description'),
+                new Field<'name', string>('name'),
+                new Field<'phone', string>('phone'),
+                new Field<'pickup_location_code', string>('pickup_location_code'),
+                new Field<'postcode', string>('postcode'),
+                new Field<'region', string>('region'),
+                new Field<'street', string>('street'),
+            ]);
+    }
+}
+
+export default new StoreInPickUpQuery();
+
+export function normalizeStoresResponse(raw: any) {
+    if (!raw) return [];
+    const list = Array.isArray(raw?.stores) ? raw.stores : (Array.isArray(raw) ? raw : raw?.items ?? []);
+    return Array.isArray(list) ? list.map((s: any) => normalizeStore(s)) : [];
+}

package/app/normalizers/StoreInPickUp.type.ts

@@ -0,0 +1,59 @@
+/**
+ * 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
+ */
+
+export interface Store {
+    city: string;
+    country: string;
+    description: string;
+    name: string;
+    phone: string;
+    pickup_location_code: string;
+    postcode: string;
+    region: string;
+    street: string[];
+    extension_attributes?: {
+        attribute_code: string;
+        value: string;
+    }[];
+}
+
+export interface DomainStore {
+    id?: string;
+    name: string;
+    address: {
+        street: string[];
+        city?: string;
+        region?: string;
+        postcode?: string;
+        country?: string;
+    };
+    phone?: string;
+    code?: string;
+    raw?: any;
+}
+
+export function normalizeStore(raw: any): DomainStore {
+    if (!raw) return raw;
+    return {
+        id: raw?.id ?? raw?.pickup_location_code ?? raw?.code ?? undefined,
+        name: raw?.name ?? raw?.store_name ?? '',
+        address: {
+            street: Array.isArray(raw?.street) ? raw.street : (raw?.address?.street ? (Array.isArray(raw.address.street) ? raw.address.street : [raw.address.street]) : []),
+            city: raw?.city ?? raw?.address?.city,
+            region: raw?.region ?? raw?.address?.region,
+            postcode: raw?.postcode ?? raw?.address?.postcode,
+            country: raw?.country ?? raw?.address?.country,
+        },
+        phone: raw?.phone ?? raw?.telephone,
+        code: raw?.pickup_location_code ?? raw?.code,
+        raw,
+    } as DomainStore;
+}

package/app/normalizers/Subscription.type.ts

@@ -0,0 +1,25 @@
+import { Subscription as DomainSubscription } from '../types/domain';
+
+export interface SubscriptionFragment {
+  id: string;
+  product_id?: string;
+  status?: string;
+}
+
+export function normalizeSubscription(raw: any): DomainSubscription {
+  if (!raw) return raw;
+  return {
+    id: String(raw?.id ?? raw?.subscription_id ?? raw?.uid ?? ''),
+    productId: raw?.product_id ?? raw?.product?.id ?? raw?.product_sku,
+    status: raw?.status ?? raw?.state,
+    schedule: raw?.schedule ?? raw?.delivery_schedule,
+    raw,
+  } as DomainSubscription;
+}
+
+export function normalizeSubscriptions(raw: any): DomainSubscription[] {
+  if (!raw) return [];
+  if (Array.isArray(raw)) return raw.map(normalizeSubscription);
+  if (Array.isArray(raw?.items)) return raw.items.map(normalizeSubscription);
+  return [];
+}

package/app/normalizers/Transaction.type.ts

@@ -0,0 +1,20 @@
+import { PaymentIntent as DomainPaymentIntent } from '../types/domain';
+
+export function normalizeTransaction(raw: any): DomainPaymentIntent {
+  if (!raw) return raw;
+  return {
+    id: String(raw?.id ?? raw?.transaction_id ?? raw?.uid ?? ''),
+    status: raw?.status ?? raw?.state,
+    amount: raw?.amount ?? raw?.total ?? raw?.value,
+    currency: raw?.currency ?? raw?.currency_code ?? raw?.currencyCode,
+    method: raw?.method ?? raw?.payment_method ?? raw?.method_type,
+    raw,
+  } as DomainPaymentIntent;
+}
+
+export function normalizeTransactions(raw: any): DomainPaymentIntent[] {
+  if (!raw) return [];
+  if (Array.isArray(raw)) return raw.map(normalizeTransaction);
+  if (Array.isArray(raw.items)) return raw.items.map(normalizeTransaction);
+  return [];
+}

package/app/normalizers/UrlRewrites.query.ts

@@ -0,0 +1,55 @@
+/**
+ * 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, Query } from '@tilework/opus';
+
+import { CategoryDisplayMode } from '../routes/CategoryPage/CategoryPage.config';
+import { GQLUrlRewriteEntityTypeEnum } from '../types/Graphql.type';
+
+import {
+    UrlRewritesOutput,
+    UrlRewritesQueryOptions,
+} from './UrlRewrites.type';
+
+/**
+ * UrlRewrites Query
+ * @class UrlRewritesQuery
+ * @namespace ../../normalizers/UrlRewrites/Query */
+export class UrlRewritesQuery {
+    getQuery({ urlParam }: UrlRewritesQueryOptions): Query<'urlResolver', {
+        sku: string;
+        type: GQLUrlRewriteEntityTypeEnum;
+        id: number;
+        display_mode: CategoryDisplayMode;
+        sort_by: string;
+    }> {
+        return new Query<'urlResolver', UrlRewritesOutput>('urlResolver')
+            .addArgument('url', 'String!', urlParam)
+            .addFieldList(this._getUrlResolverFields());
+    }
+
+    _getUrlResolverFields(): Array<
+    Field<'sku', string>
+    | Field<'type', GQLUrlRewriteEntityTypeEnum>
+    | Field<'id', number>
+    | Field<'display_mode', CategoryDisplayMode>
+    | Field<'sort_by', string>
+    > {
+        return [
+            new Field<'sku', string>('sku'),
+            new Field<'type', GQLUrlRewriteEntityTypeEnum>('type'),
+            new Field<'id', number>('id'),
+            new Field<'display_mode', CategoryDisplayMode>('display_mode'),
+            new Field<'sort_by', string>('sort_by'),
+        ];
+    }
+}
+
+export default new UrlRewritesQuery();

package/app/normalizers/UrlRewrites.type.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { CategoryDisplayMode } from '../routes/CategoryPage/CategoryPage.config';
+import { GQLUrlRewriteEntityTypeEnum } from '../types/Graphql.type';
+
+export interface UrlRewritesOutput {
+    sku: string;
+    type: GQLUrlRewriteEntityTypeEnum;
+    id: number;
+    display_mode: CategoryDisplayMode;
+    sort_by: string;
+}
+
+export interface UrlRewritesQueryOptions {
+    urlParam: string;
+}