@mframework/layer-commerce 0.0.3

package/app/utils/Cache/Cache.ts

@@ -0,0 +1,99 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+/**
+ * M Framework - Flexible backend agnostic framework.
+ *
+ * Copyright © Meeovi, LTD. All rights reserved.
+ * See LICENSE for license details.
+ *
+ * @license OSL-3.0 (Open Software License ("OSL") v. 3.0)
+ * @package mframework/mframework
+ * @link https://github.com/meeovi/mframework
+ */
+
+export type CacheMap = {
+    cache: Record<string, any>;
+};
+
+/**
+ * Prefetches images
+ * @param urls
+ * @returns {Promise<void>}
+ * @namespace ../../utils/Cache/cacheImages
+ */
+export const cacheImages = (urls: string[]): void => {
+    if (!Array.isArray(urls) || urls.length === 0) {
+        return;
+    }
+
+    // Prefetched images require persistent variable
+    // to prevent browser from creating repeated requests
+    if (!window.prefetchedImages) {
+        window.prefetchedImages = {};
+    }
+
+    const filteredUrls = urls.filter((url) => !window.prefetchedImages[url]);
+
+    filteredUrls.forEach((url) => {
+        const img = new Image();
+
+        img.src = url;
+        window.prefetchedImages[url] = img;
+    });
+};
+
+/**
+ * Returns result from global cache for fn
+ * @param {function} fn
+ * @param {array} args
+ * @returns function response
+ * @namespace ../../utils/Cache/fromCache
+ */
+export const fromCache = (fn: any, args: any): any => {
+    // Checks if cache is defined
+    if ((fromCache as unknown as CacheMap).cache === undefined) {
+        (fromCache as unknown as CacheMap).cache = {};
+    }
+
+    // Checks if function is registered into cache
+    const { name } = fn;
+
+    if ((fromCache as unknown as CacheMap).cache[name] === undefined) {
+        (fromCache as unknown as CacheMap).cache[name] = {};
+    }
+
+    // Generates key from args
+    const key = JSON.stringify(args);
+
+    // Finds response
+    const { cache, cache: { [name]: { [key]: cachedResponse } = {} } = {} } = (fromCache as unknown as CacheMap);
+
+    // If already cached then returns cache value
+    if (cachedResponse) {
+        return cachedResponse;
+    }
+
+    // If not get response, caches it and return value
+    const response = fn(...args);
+
+    cache[name][key] = response;
+
+    return response;
+};
+
+/**
+ * Clears functions cache from global cache register
+ * @param {function} fn
+ * @namespace ../../utils/Cache/clearCacheFor
+ */
+export const clearCacheFor = (fn: any): void => {
+    if ((fromCache as unknown as CacheMap).cache === undefined) {
+        return;
+    }
+
+    const { name } = fn;
+
+    (fromCache as unknown as CacheMap).cache[name] = {};
+};
+
+export default fromCache;

package/app/utils/Cart/Cart.ts

@@ -0,0 +1,300 @@
+/**
+ * M Framework - Flexible backend agnostic framework.
+ *
+ * Copyright © Meeovi, LTD. All rights reserved.
+ * See LICENSE for license details.
+ *
+ * @license OSL-3.0 (Open Software License ("OSL") v. 3.0)
+ * @package mframework/mframework
+ * @link https://github.com/meeovi/mframework
+ */
+
+import { ShippingMethod } from '../../normalizers/Checkout.type';
+import { IndexedCartItem } from '../../stores/Cart/Cart.type';
+import { RootState } from '../../utils/Store/Store.type';
+
+import {
+    CartItemPriceProps,
+    DisplayCartTaxInPrice,
+    DisplayCartTaxInShipping,
+    DisplayCartTaxInSubTotal,
+    DisplayShippingPrices,
+} from './Cart.type';
+
+/** @namespace ../../utils/Cart/getCartSubtotal */
+export const getCartSubtotal = (state: RootState): number => {
+    const {
+        ConfigReducer: {
+            cartDisplayConfig: {
+                display_tax_in_subtotal = '',
+            } = {},
+        } = {},
+        CartReducer: {
+            cartTotals: {
+                prices: {
+                    subtotal_excluding_tax: {
+                        value: subtotal = 0,
+                    } = {},
+                    subtotal_including_tax: {
+                        value: subtotal_incl_tax = 0,
+                    } = {},
+                } = {},
+            } = {},
+        } = {},
+    } = state;
+
+    if (display_tax_in_subtotal === DisplayCartTaxInSubTotal.EXCL_TAX) {
+        return subtotal;
+    }
+
+    return subtotal_incl_tax;
+};
+
+/** @namespace ../../utils/Cart/getCartSubtotalSubPrice */
+export const getCartSubtotalSubPrice = (state: RootState): number | null => {
+    const {
+        ConfigReducer: {
+            cartDisplayConfig: {
+                display_tax_in_subtotal = '',
+            } = {},
+        } = {},
+        CartReducer: {
+            cartTotals: {
+                prices: {
+                    subtotal_excluding_tax: {
+                        value: subtotal = 0,
+                    } = {},
+                } = {},
+            } = {},
+        } = {},
+    } = state;
+
+    if (display_tax_in_subtotal === DisplayCartTaxInSubTotal.BOTH) {
+        return subtotal;
+    }
+
+    return null;
+};
+
+/** @namespace ../../utils/Cart/getCartItemPrice */
+export const getCartItemPrice = (state: RootState) => (props: CartItemPriceProps): number => {
+    const {
+        ConfigReducer: {
+            cartDisplayConfig: {
+                display_tax_in_price = '',
+            } = {},
+        } = {},
+    } = state;
+
+    const {
+        row_total = 0,
+        row_total_incl_tax = 0,
+    } = props;
+
+    if (display_tax_in_price === DisplayCartTaxInPrice.EXCL_TAX) {
+        return row_total;
+    }
+
+    return row_total_incl_tax;
+};
+
+/** @namespace ../../utils/Cart/getCartItemSubPrice */
+export const getCartItemSubPrice = (state: RootState) => (props: CartItemPriceProps): number | null => {
+    const {
+        ConfigReducer: {
+            cartDisplayConfig: {
+                display_tax_in_price = '',
+            } = {},
+        } = {},
+    } = state;
+
+    const {
+        row_total = 0,
+    } = props;
+
+    if (display_tax_in_price === DisplayCartTaxInPrice.BOTH) {
+        return row_total;
+    }
+
+    return null;
+};
+
+/** @namespace ../../utils/Cart/getCartShippingPrice */
+export const getCartShippingPrice = (state: RootState): number => {
+    const {
+        ConfigReducer: {
+            cartDisplayConfig: {
+                display_tax_in_shipping_amount = '',
+            } = {},
+        } = {},
+        CartReducer: {
+            cartTotals: {
+                shipping_addresses: {
+                    selected_shipping_method,
+                } = {},
+            } = {},
+        } = {},
+    } = state;
+
+    if (!selected_shipping_method) {
+        return 0;
+    }
+
+    const {
+        amount: {
+            value: shipping_amount = 0,
+        } = {},
+        amount_incl_tax: shipping_incl_tax = 0,
+    } = selected_shipping_method;
+
+    if (display_tax_in_shipping_amount === DisplayCartTaxInShipping.EXCL_TAX) {
+        return shipping_amount;
+    }
+
+    return shipping_incl_tax;
+};
+
+/** @namespace ../../utils/Cart/getCartShippingSubPrice */
+export const getCartShippingSubPrice = (state: RootState): number | null => {
+    const {
+        ConfigReducer: {
+            cartDisplayConfig: {
+                display_tax_in_shipping_amount = '',
+            } = {},
+        } = {},
+        CartReducer: {
+            cartTotals: {
+                shipping_addresses: {
+                    selected_shipping_method,
+                } = {},
+            } = {},
+        } = {},
+    } = state;
+
+    if (!selected_shipping_method) {
+        return null;
+    }
+
+    const {
+        amount: {
+            value: shipping_amount = 0,
+        } = {},
+    } = selected_shipping_method;
+
+    if (display_tax_in_shipping_amount === DisplayCartTaxInShipping.BOTH) {
+        return shipping_amount;
+    }
+
+    return null;
+};
+
+/** @namespace ../../utils/Cart/getCartShippingItemPrice */
+export const getCartShippingItemPrice = (state: RootState) => (props: ShippingMethod): number => {
+    const {
+        ConfigReducer: {
+            priceTaxDisplay: {
+                shipping_price_display_type = '',
+            } = {},
+        } = {},
+    } = state;
+
+    const {
+        price_incl_tax = 0,
+        price_excl_tax = 0,
+    } = props;
+
+    if (shipping_price_display_type === DisplayShippingPrices.EXCL_TAX) {
+        return price_excl_tax;
+    }
+
+    return price_incl_tax;
+};
+
+/** @namespace ../../utils/Cart/getCartShippingItemSubPrice */
+export const getCartShippingItemSubPrice = (state: RootState) => (props: ShippingMethod): number | null => {
+    const {
+        ConfigReducer: {
+            priceTaxDisplay: {
+                shipping_price_display_type = '',
+            } = {},
+        } = {},
+    } = state;
+
+    const {
+        price_excl_tax = 0,
+    } = props;
+
+    if (shipping_price_display_type === DisplayShippingPrices.BOTH) {
+        return price_excl_tax;
+    }
+
+    return null;
+};
+
+/** @namespace ../../utils/Cart/getCartTotalSubPrice */
+export const getCartTotalSubPrice = (state: RootState): number | null => {
+    const {
+        ConfigReducer: {
+            cartDisplayConfig: {
+                include_tax_in_order_total = '',
+            } = {},
+        } = {},
+        CartReducer: {
+            cartTotals: {
+                prices: {
+                    grand_total: {
+                        value: grand_total = 0,
+                    } = {},
+                    applied_taxes = [],
+                } = {},
+            } = {},
+        } = {},
+    } = state;
+
+    if (include_tax_in_order_total) {
+        return applied_taxes.reduce((acc: number, { amount: { value: tax_amount = 0 } = {} }) => acc - tax_amount, grand_total);
+    }
+
+    return null;
+};
+
+/** @namespace ../../utils/Cart/getItemsCountLabel */
+export const getItemsCountLabel = (items_qty: number): string => (
+    items_qty === 1
+        ? __('1 item')
+        : __('%s items', items_qty || 0)
+);
+
+/** @namespace ../../utils/Cart/getAllCartItemsSku */
+export const getAllCartItemsSku = (
+    cartItems: IndexedCartItem[],
+): Array<{ sku: string }> => (cartItems ? cartItems.reduce<Array<{ sku: string }>>((acc, item) => {
+    acc.push({ sku: item.sku || '' });
+
+    return acc;
+}, []) : []);
+
+/** @namespace ../../utils/Cart/trimCrossSellDuplicateItems */
+export const trimCrossSellDuplicateItems = (items: IndexedCartItem[]): IndexedCartItem[] => items.filter(
+    ({
+        sku: itemSku,
+        product: { variants: itemVariants, id: itemId },
+    }, index, array) => {
+        if (!index || !itemVariants?.length) {
+            return true;
+        }
+
+        const foundItem = array.find(({ product: { id: elementId } }) => elementId === itemId);
+
+        if (!foundItem) {
+            return false;
+        }
+
+        const {
+            sku: duplicateSku,
+            product: { id: duplicateId },
+        } = foundItem;
+
+        return (duplicateId === itemId && duplicateSku === itemSku);
+    },
+);

package/app/utils/Cart/Cart.type.ts

@@ -0,0 +1,76 @@
+/**
+ * M Framework - Flexible backend agnostic framework.
+ *
+ * Copyright © Meeovi, LTD. All rights reserved.
+ * See LICENSE for license details.
+ *
+ * @license OSL-3.0 (Open Software License ("OSL") v. 3.0)
+ * @package mframework/mframework
+ * @link https://github.com/meeovi/mframework
+ */
+
+import {
+    GQLCartDisplayConfig,
+    GQLConfigurableProduct,
+    GQLPriceTaxDisplay,
+    GQLQuoteData,
+} from '../../types/Graphql.type';
+
+// ! TODO move reducer types when we start work with redux!
+
+export interface ConfigReducerState {
+    cartDisplayConfig: GQLCartDisplayConfig;
+    priceTaxDisplay: GQLPriceTaxDisplay;
+}
+
+export interface CartReducerState {
+    cartTotals: GQLQuoteData;
+}
+
+export interface CartState {
+    ConfigReducer: ConfigReducerState;
+    CartReducer: CartReducerState;
+}
+
+export interface CartItem {
+    sku: string;
+    product: GQLConfigurableProduct;
+}
+
+export interface CartItemPriceProps {
+    row_total: number;
+    row_total_incl_tax: number;
+    price_incl_tax: number;
+    price_excl_tax: number;
+}
+
+export enum DisplayCartTaxInSubTotal {
+    INCL_TAX = 'DISPLAY_CART_TAX_IN_SUBTOTAL_INCL_TAX',
+    EXCL_TAX = 'DISPLAY_CART_TAX_IN_SUBTOTAL_EXL_TAX',
+    BOTH = 'DISPLAY_CART_TAX_IN_SUBTOTAL_BOTH',
+}
+
+export enum DisplayCartTaxInShipping {
+    INCL_TAX = 'DISPLAY_CART_TAX_IN_SHIPPING_INCL_TAX',
+    EXCL_TAX = 'DISPLAY_CART_TAX_IN_SHIPPING_EXL_TAX',
+    BOTH = 'DISPLAY_CART_TAX_IN_SHIPPING_BOTH',
+}
+
+export enum DisplayCartTaxInPrice {
+    INCL_TAX = 'DISPLAY_CART_TAX_IN_PRICE_INCL_TAX',
+    EXCL_TAX = 'DISPLAY_CART_TAX_IN_PRICE_EXL_TAX',
+    BOTH = 'DISPLAY_CART_TAX_IN_PRICE_BOTH',
+}
+
+export enum DisplayShippingPrices {
+    INCL_TAX = 'DISPLAY_SHIPPING_PRICES_INCL_TAX',
+    EXCL_TAX = 'DISPLAY_SHIPPING_PRICES_EXCL_TAX',
+    BOTH = 'DISPLAY_SHIPPING_PRICES_BOTH',
+}
+
+export interface CartToken {
+    token: string;
+    isCustomerToken: boolean;
+}
+
+export type CartTokensByWebsite = Record<string, CartToken | undefined>;

package/app/utils/Cart/Token.ts

@@ -0,0 +1,59 @@
+/**
+ * M Framework - Flexible backend agnostic framework.
+ *
+ * Copyright © Meeovi, LTD. All rights reserved.
+ * See LICENSE for license details.
+ *
+ * @license OSL-3.0 (Open Software License ("OSL") v. 3.0)
+ * @package mframework/mframework
+ * @link https://github.com/meeovi/mframework
+ */
+
+import { isSignedIn } from '../../utils/Auth/IsSignedIn';
+import BrowserDatabase from '../../utils/BrowserDatabase';
+
+import { CartTokensByWebsite } from './Cart.type';
+
+export const CART_ID = 'cart_id';
+
+/** @namespace ../../utils/Cart/Token/setCartId */
+export const setCartId = (token: string): void => {
+    const { website_code } = window;
+
+    const tokens: CartTokensByWebsite = BrowserDatabase.getItem(CART_ID) || {};
+
+    tokens[website_code] = {
+        token,
+        isCustomerToken: isSignedIn(),
+    };
+    BrowserDatabase.setItem(tokens, CART_ID);
+};
+
+/** @namespace ../../utils/Cart/Token/getCartId */
+export const getCartId = (): string | null => {
+    const { website_code } = window;
+
+    const tokens: CartTokensByWebsite = BrowserDatabase.getItem(CART_ID) || {};
+
+    const token = tokens[website_code];
+
+    if (token) {
+        if (token.isCustomerToken && !isSignedIn()) {
+            return null;
+        }
+
+        return token.token;
+    }
+
+    return null;
+};
+
+/** @namespace ../../utils/Cart/Token/deleteCartId */
+export const deleteCartId = (): void => {
+    const { website_code } = window;
+
+    const tokens: CartTokensByWebsite = BrowserDatabase.getItem(CART_ID) || {};
+
+    tokens[website_code] = undefined;
+    BrowserDatabase.setItem(tokens, CART_ID);
+};

package/app/utils/Cart/index.ts

@@ -0,0 +1,13 @@
+/**
+ * M Framework - Flexible backend agnostic framework.
+ *
+ * Copyright © Meeovi, LTD. All rights reserved.
+ * See LICENSE for license details.
+ *
+ * @license OSL-3.0 (Open Software License ("OSL") v. 3.0)
+ * @package mframework/mframework
+ * @link https://github.com/meeovi/mframework
+ */
+
+export * from './Cart';
+export * from './Token';

package/app/utils/Category/Filters.ts

@@ -0,0 +1,39 @@
+/**
+ * M Framework - Flexible backend agnostic framework.
+ *
+ * Copyright © Meeovi, LTD. All rights reserved.
+ * See LICENSE for license details.
+ *
+ * @license OSL-3.0 (Open Software License ("OSL") v. 3.0)
+ * @package mframework/mframework
+ * @link https://github.com/meeovi/mframework
+ */
+
+import { GQLCurrencyEnum } from '../../types/Graphql.type';
+import { formatPrice } from '../../utils/Price';
+
+/** @namespace ../../utils/Category/Filters/getPriceFilterLabel */
+export const getPriceFilterLabel = (
+    from: number | string,
+    to: number | string,
+    currencyCode: GQLCurrencyEnum,
+): string => {
+    const priceFrom = formatPrice(Number(from), currencyCode);
+    const priceTo = formatPrice(Number(to), currencyCode);
+
+    if (from === '*') {
+        return __('Up to %s', priceTo);
+    }
+
+    if (to === '*') {
+        return __('From %s', priceFrom);
+    }
+
+    return __('From %s to %s', priceFrom, priceTo);
+};
+
+/** @namespace ../../utils/Category/Filters/getFiltersCount */
+export const getFiltersCount = (
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    filters: Record<string, any[]>,
+): number => Object.values(filters).reduce((prev: number, next) => prev + next.length, 0);

package/app/utils/Category/index.ts

@@ -0,0 +1,12 @@
+/**
+ * M Framework - Flexible backend agnostic framework.
+ *
+ * Copyright © Meeovi, LTD. All rights reserved.
+ * See LICENSE for license details.
+ *
+ * @license OSL-3.0 (Open Software License ("OSL") v. 3.0)
+ * @package mframework/mframework
+ * @link https://github.com/meeovi/mframework
+ */
+
+export * from './Filters';

package/app/utils/Common/index.ts

@@ -0,0 +1,32 @@
+/* eslint-disable import/prefer-default-export */
+/**
+ * M Framework - Flexible backend agnostic framework.
+ *
+ * Copyright © Meeovi, LTD. All rights reserved.
+ * See LICENSE for license details.
+ *
+ * @license OSL-3.0 (Open Software License ("OSL") v. 3.0)
+ * @package mframework/mframework
+ * @link https://github.com/meeovi/mframework
+ */
+
+/**
+ * No-operate function.
+ * Can be used as a fallback if real function wasn't passed.
+ * In this case instead of creating empty function every time we can reuse existing.
+ * Examples: default props, argument default values.
+ * @namespace ../../utils/Common/Index/noopFn
+ */
+export const noopFn = (): void => {};
+
+/** @namespace ../../utils/Common/Index/noopFnAsync */
+export const noopFnAsync = async (): Promise<void> => {};
+
+/** @namespace ../../utils/Common/Index/decodeString */
+export const decodeString = (string: string): string => {
+    try {
+        return decodeURIComponent(string);
+    } catch (e) {
+        return string;
+    }
+};