@mframework/layer-commerce 0.0.3

package/app/normalizers/Checkout.query.ts

@@ -0,0 +1,253 @@
+/**
+ * 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 {
+       GQLEstimateShippingCostsAddress,
+       GQLSaveAddressInformation,
+       GQLSSetBillingAddressOnCartInput,
+       GQLSSetPaymentMethodOnCartInput,
+} from '../types/Graphql.type';
+        import { isSignedIn } from '../utils/Auth/IsSignedIn';
+
+import {
+    PaymentDetails,
+    PaymentMethod,
+    SetGuestEmailOnCartOutput,
+    ShippingMethod,
+    TotalsItem,
+    TotalsObject,
+} from './Checkout.type';
+
+/** @namespace ../../normalizers/Checkout/Query */
+export class CheckoutQuery {
+    getPaymentMethodsQuery(guestCartId: string): Query<'getPaymentMethods', PaymentMethod, true> {
+        const query = new Query<'getPaymentMethods', PaymentMethod, true>('getPaymentMethods', true)
+            .addFieldList(this._getPaymentMethodFields());
+
+        this._addGuestCartId(guestCartId, query as Query<'getPaymentMethods', PaymentMethod, true>);
+
+        return query as Query<'getPaymentMethods', PaymentMethod, true>;
+    }
+
+    getSaveGuestEmailMutation(
+        email: string,
+        cart_id: string,
+    ): Mutation<'setGuestEmailOnCart', SetGuestEmailOnCartOutput> {
+        const input = { email, cart_id };
+        const mutation = new Mutation<'setGuestEmailOnCart', SetGuestEmailOnCartOutput>('setGuestEmailOnCart')
+            .addArgument('input', 'SetGuestEmailOnCartInput', input)
+            .addField(((new Field('cart')).addField('email')));
+
+        return mutation;
+    }
+
+    getEstimateShippingCosts(
+        address: GQLEstimateShippingCostsAddress,
+        guestCartId: string,
+    ): Mutation<'estimateShippingCosts', ShippingMethod, true> {
+        const mutation = new Mutation<'estimateShippingCosts', ShippingMethod, true>('estimateShippingCosts')
+            .addArgument('address', 'EstimateShippingCostsAddress!', address)
+            .addFieldList(this._getEstimatedShippingFields());
+
+        this._addGuestCartId(guestCartId, mutation);
+
+        return mutation;
+    }
+
+    getSaveAddressInformation(
+        addressInformation: GQLSaveAddressInformation,
+        guestCartId: string,
+    ): Mutation<'saveAddressInformation', PaymentDetails> {
+        const mutation = new Mutation<'saveAddressInformation', PaymentDetails>('saveAddressInformation')
+            .addArgument('addressInformation', 'SaveAddressInformation!', addressInformation)
+            .addFieldList(this._getSaveAddressInformationFields());
+
+        this._addGuestCartId(guestCartId, mutation);
+
+        return mutation;
+    }
+
+    getSetBillingAddressOnCart(
+        input: GQLSSetBillingAddressOnCartInput,
+    ): Mutation<'billingAddress', { cart: { id: number } }> {
+        return new Mutation<'setBillingAddressOnCart', { cart: { id: number } }>('setBillingAddressOnCart')
+            .addArgument('input', 'SetBillingAddressOnCartInput', input)
+            .addField(this._getCartField())
+            .setAlias('billingAddress');
+    }
+
+    getSetPaymentMethodOnCartMutation(
+        input: GQLSSetPaymentMethodOnCartInput,
+    ): Mutation<'paymentMethod', { cart: { id: number } }> {
+        return new Mutation<'setPaymentMethodOnCart', { cart: { id: number } }>('setPaymentMethodOnCart')
+            .addArgument('input', 'SetPaymentMethodOnCartInput', input)
+            .addField(this._getCartField())
+            .setAlias('paymentMethod');
+    }
+
+    getPlaceOrderMutation(cartId: string): Mutation<'placeOrder', { order: { order_id: string } }> {
+        const mutation = new Mutation<'placeOrder', { order: { order_id: string } }>('placeOrder')
+            .addArgument('input', 'PlaceOrderInput', { cart_id: cartId })
+            .addField(this._getOrderField());
+
+        return mutation;
+    }
+
+    _addGuestCartId(
+        guestCartId: string,
+        mutation: Mutation<'saveAddressInformation', PaymentDetails>
+        | Mutation<'estimateShippingCosts', ShippingMethod, true>
+        | Query<'getPaymentMethods', PaymentMethod, true>,
+    ): void {
+        if (guestCartId && !isSignedIn()) {
+            mutation.addArgument('guestCartId', 'String!', guestCartId);
+        }
+    }
+
+    _getOrderField(): Field<'order', { order_id: string }> {
+        return new Field<'order', { order_id: string }>('order')
+            .addFieldList([new Field<'order_id', string>('order_id')]);
+    }
+
+    _getSaveAddressInformationFields(): Array<
+    Field<'payment_methods', PaymentMethod, true>
+    | Field<'totals', TotalsObject>
+    > {
+        return [
+            this._getPaymentMethodsField(),
+            this._getTotalsField(),
+        ];
+    }
+
+    _getEstimatedShippingFields(): Array<
+    Field<'amount', number>
+    | Field<'available', boolean>
+    | Field<'base_amount', number>
+    | Field<'method_code', string>
+    | Field<'carrier_code', string>
+    | Field<'method_title', string>
+    | Field<'carrier_title', string>
+    | Field<'error_message', string>
+    | Field<'price_excl_tax', number>
+    | Field<'price_incl_tax', number>
+    > {
+        return [
+            new Field<'amount', number>('amount'),
+            new Field<'available', boolean>('available'),
+            new Field<'base_amount', number>('base_amount'),
+            new Field<'method_code', string>('method_code'),
+            new Field<'carrier_code', string>('carrier_code'),
+            new Field<'method_title', string>('method_title'),
+            new Field<'carrier_title', string>('carrier_title'),
+            new Field<'error_message', string>('error_message'),
+            new Field<'price_excl_tax', number>('price_excl_tax'),
+            new Field<'price_incl_tax', number>('price_incl_tax'),
+        ];
+    }
+
+    _getPaymentMethodsField(): Field<'payment_methods', PaymentMethod, true> {
+        return new Field<'payment_methods', PaymentMethod, true>('payment_methods', true)
+            .addFieldList(this._getPaymentMethodFields()) as Field<'payment_methods', PaymentMethod, true>;
+    }
+
+    _getPaymentMethodFields(): Array<
+    Field<'code', string>
+    | Field<'title', string>
+    > {
+        return [
+            new Field<'code', string>('code'),
+            new Field<'title', string>('title'),
+        ];
+    }
+
+    _getTotalItemFields(): Array<
+    Field<'qty', number>
+    | Field<'name', string>
+    | Field<'price', number>
+    | Field<'item_id', number>
+    | Field<'options', string>
+    | Field<'tax_amount', number>
+    | Field<'tax_percent', number>
+    | Field<'price_incl_tax', number>
+    | Field<'discount_amount', number>
+    | Field<'discount_percent', number>
+    > {
+        return [
+            new Field<'qty', number>('qty'),
+            new Field<'name', string>('name'),
+            new Field<'price', number>('price'),
+            new Field<'item_id', number>('item_id'),
+            new Field<'options', string>('options'),
+            new Field<'tax_amount', number>('tax_amount'),
+            new Field<'tax_percent', number>('tax_percent'),
+            new Field<'price_incl_tax', number>('price_incl_tax'),
+            new Field<'discount_amount', number>('discount_amount'),
+            new Field<'discount_percent', number>('discount_percent'),
+        ];
+    }
+
+    _getTotalItemField(): Field<'items', TotalsItem, true> {
+        return new Field<'items', TotalsItem, true>('items')
+            .addFieldList(this._getTotalItemFields());
+    }
+
+    _getTotalsFields(): Array<
+    Field<'subtotal', number>
+    | Field<'tax_amount', number>
+    | Field<'base_grand_total', number>
+    | Field<'grand_total', number>
+    | Field<'discount_amount', number>
+    | Field<'shipping_amount', number>
+    | Field<'subtotal_incl_tax', number>
+    | Field<'shipping_incl_tax', number>
+    | Field<'quote_currency_code', string>
+    | Field<'shipping_tax_amount', number>
+    | Field<'subtotal_with_discount', number>
+    | Field<'shipping_discount_amount', number>
+    | Field<'items', TotalsItem, true>
+    > {
+        return [
+            new Field<'subtotal', number>('subtotal'),
+            new Field<'tax_amount', number>('tax_amount'),
+            new Field<'base_grand_total', number>('base_grand_total'),
+            new Field<'grand_total', number>('grand_total'),
+            new Field<'discount_amount', number>('discount_amount'),
+            new Field<'shipping_amount', number>('shipping_amount'),
+            new Field<'subtotal_incl_tax', number>('subtotal_incl_tax'),
+            new Field<'shipping_incl_tax', number>('shipping_incl_tax'),
+            new Field<'quote_currency_code', string>('quote_currency_code'),
+            new Field<'shipping_tax_amount', number>('shipping_tax_amount'),
+            new Field<'subtotal_with_discount', number>('subtotal_with_discount'),
+            new Field<'shipping_discount_amount', number>('shipping_discount_amount'),
+            this._getTotalItemField(),
+        ];
+    }
+
+    _getTotalsField(): Field<'totals', TotalsObject> {
+        return new Field<'totals', TotalsObject>('totals')
+            .addFieldList(this._getTotalsFields());
+    }
+
+    _getCartField(): Field<'cart', { id: number }> {
+        return new Field<'cart', { id: number }>('cart')
+            .addFieldList(this._getCartFieldList());
+    }
+
+    _getCartFieldList(): Field<'id', number>[] {
+        return [
+            new Field<'id', number>('id'),
+        ];
+    }
+}
+
+export default new CheckoutQuery();

package/app/normalizers/Checkout.type.ts

@@ -0,0 +1,77 @@
+/**
+ * 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 { AppliedTaxItem } from './Cart.type';
+import { PaymentMethodAdditionalData } from './Order.type';
+
+export interface TotalsItem {
+    qty: number;
+    name: string;
+    price: number;
+    item_id: number;
+    options: string;
+    tax_amount: number;
+    tax_percent: number;
+    price_incl_tax: number;
+    discount_amount: number;
+    discount_percent: number;
+}
+
+export interface TotalsObject {
+    applied_rule_ids: string;
+    applied_taxes: AppliedTaxItem[];
+    coupon_code: string;
+    subtotal: number;
+    tax_amount: number;
+    items_qty: number;
+    base_grand_total: number;
+    grand_total: number;
+    discount_amount: number;
+    shipping_amount: number;
+    subtotal_incl_tax: number;
+    shipping_incl_tax: number;
+    quote_currency_code: string;
+    shipping_tax_amount: number;
+    subtotal_with_discount: number;
+    shipping_discount_amount: number;
+    items: TotalsItem[];
+}
+
+export interface PaymentMethod {
+    code: string;
+    title?: string;
+    additional_data?: PaymentMethodAdditionalData;
+    purchase_order_number?: string;
+}
+
+export interface PaymentDetails {
+    payment_methods: PaymentMethod[];
+    totals: TotalsObject;
+}
+
+export interface ShippingMethod {
+    amount: number;
+    available: boolean;
+    base_amount: number;
+    method_code: string;
+    carrier_code: string;
+    method_title: string;
+    carrier_title: string;
+    error_message: string;
+    price_excl_tax: number;
+    price_incl_tax: number;
+}
+
+export interface SetGuestEmailOnCartOutput {
+    cart: {
+        email: string;
+    };
+}

package/app/normalizers/CmsBlock.query.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 { Field, Query } from '@tilework/opus';
+
+import { CmsBlock, CmsBlocks } from './CmsBlock.type';
+
+/**
+ * CMS Blocks Query
+ * @class CmsBlocksQuery
+ * @namespace ../../normalizers/CmsBlock/Query */
+export class CmsBlockQuery {
+    /**
+     * get CMS Block query
+     * @param  {{identifier: String, title: String, content: String}} options A object containing different aspects of query, each item can be omitted
+     * @return {Field} CMS Block query
+     * @memberof CmsBlocksQuery
+     */
+    getQuery({ identifiers }: { identifiers: string[] }): Query<'cmsBlocks', CmsBlocks> {
+        if (!identifiers) {
+            throw new Error('Missing argument `options`');
+        }
+
+        return new Query<'cmsBlocks', CmsBlocks>('cmsBlocks')
+            .addArgument('identifiers', '[String]', identifiers)
+            .addField(this._getItemsField());
+    }
+
+    _getItemFields(): Array<
+    Field<'title', string>
+    | Field<'content', string>
+    | Field<'identifier', string>
+    | Field<'disabled', boolean>
+    > {
+        return [
+            new Field<'title', string>('title'),
+            new Field<'content', string>('content'),
+            new Field<'identifier', string>('identifier'),
+            new Field<'disabled', boolean>('disabled'),
+        ];
+    }
+
+    _getItemsField(): Field<'items', CmsBlock, true> {
+        return new Field<'items', CmsBlock, true>('items', true)
+            .addFieldList(this._getItemFields());
+    }
+}
+
+export default new CmsBlockQuery();

package/app/normalizers/CmsBlock.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
+ */
+
+export interface CmsBlock {
+    title: string;
+    content: string;
+    identifier: string;
+    disabled: boolean;
+}
+
+export interface CmsBlocks {
+    items: CmsBlock[];
+}
+
+export interface CmsBlockQueryOutput {
+    cmsBlocks: CmsBlocks;
+}

package/app/normalizers/CmsPage.query.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-theme
+ */
+
+import { Field, Query } from '@tilework/opus';
+
+import { CmsPageFields, CmsPageQueryOptions } from './CmsPage.type';
+
+/**
+ * CMS Page Query
+ * @class CmsPageQuery
+ * @namespace ../../normalizers/CmsPage/Query */
+export class CmsPageQuery {
+    getQuery({ id, url_key, identifier }: Partial<CmsPageQueryOptions>): Query<'cmsPage', CmsPageFields> {
+        if (!id && !url_key && !identifier) {
+            throw new Error('Missing argument `id` or `url_key`!');
+        }
+
+        const cmsPage = new Query<'cmsPage', CmsPageFields>('cmsPage')
+            .addFieldList(this._getPageFields());
+
+        if (identifier) {
+            cmsPage.addArgument('identifier', 'String!', identifier);
+        } else if (id) {
+            cmsPage.addArgument('id', 'Int!', id);
+        }
+
+        return cmsPage;
+    }
+
+    _getPageFields(): Array<
+    Field<'title', string>
+    | Field<'content', string>
+    | Field<'page_width', string>
+    | Field<'content_heading', string>
+    | Field<'meta_title', string>
+    | Field<'meta_description', string>
+    | Field<'meta_keywords', string>
+    > {
+        return [
+            new Field<'title', string>('title'),
+            new Field<'content', string>('content'),
+            new Field<'page_width', string>('page_width'),
+            new Field<'content_heading', string>('content_heading'),
+            new Field<'meta_title', string>('meta_title'),
+            new Field<'meta_description', string>('meta_description'),
+            new Field<'meta_keywords', string>('meta_keywords'),
+        ];
+    }
+}
+
+export default new CmsPageQuery();

package/app/normalizers/CmsPage.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 CmsPageFields {
+    title: string;
+    content: string;
+    page_width: string;
+    content_heading: string;
+    meta_title: string;
+    meta_description: string;
+    meta_keywords: string;
+}
+
+export interface CmsPageQueryOptions {
+    id: number;
+    url_key: string;
+    identifier: string;
+}