@mframework/layer-commerce 0.0.3

package/app/types/tilework-opus.d.ts

@@ -0,0 +1,48 @@
+declare module '@tilework/opus' {
+  // Keep generics for compatibility in annotations, but use non-generic member types
+  // so different generic instantiations remain structurally compatible.
+  export class AbstractField<Name extends string = string, T = any, Required extends boolean = boolean> {
+    name: string
+    alias?: string
+    args?: Record<string, any>
+    children?: Array<AbstractField | string>
+    required: boolean
+    constructor(name: string, required?: boolean)
+    setAlias(alias: string): this
+    addArgument(name: string, type: string, value?: any): this
+    addField(field: AbstractField | string): this
+    addFieldList(fields: Array<AbstractField | string>): this
+  }
+
+  export class Field<Name extends string = string, T = any, Required extends boolean = boolean> extends AbstractField<Name, T, Required> {
+    constructor(name: string, required?: boolean)
+  }
+
+  export class InlineFragment<Name extends string = string, T = any, Required extends boolean = boolean> extends AbstractField<Name, T, Required> {
+    constructor(typeName: string, fields?: Array<AbstractField | string>)
+    addFieldList(fields: Array<AbstractField | string>): this
+    addField(field: AbstractField | string): this
+  }
+
+  export class Query<Name extends string = string, T = any, Required extends boolean = boolean> extends AbstractField<Name, T, Required> {
+    constructor(name?: string, required?: boolean)
+    addFragment(fragment: InlineFragment | string): this
+    build(): string
+  }
+
+  export class Mutation<Name extends string = string, T = any, Required extends boolean = boolean> extends AbstractField<Name, T, Required> {
+    constructor(name?: string)
+    build(): string
+  }
+
+  export class Argument {
+    name: string
+    type: string
+    value?: any
+    constructor(name: string, type: string, value?: any)
+  }
+
+  export type GraphQlResponse<T = any> = T
+
+  export default Query
+}

package/app/utils/Address/Address.type.ts

@@ -0,0 +1,28 @@
+/**
+ * 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-theme
+ * @link https://github.com/meeovi/mframework
+ */
+
+import { Country } from '../../normalizers/Region.type';
+
+export interface ZippopotamResponseResult {
+    city: string;
+    region: string;
+    regionAbbr: string;
+}
+
+export interface FormattedRegion {
+    country?: string;
+    region?: string | null;
+}
+
+export interface CountryOption extends Country {
+    name: string;
+    value: string;
+}

package/app/utils/Address/index.ts

@@ -0,0 +1,325 @@
+/**
+ * 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 { CustomerAddress } from '../../normalizers/MyAccount.type';
+import { OrderAddress } from '../../normalizers/Order.type';
+import { Country, Region } from '../../normalizers/Region.type';
+import { Store } from '../../normalizers/StoreInPickUp.type';
+import { CheckoutAddress } from '../../routes/Checkout/Checkout.type';
+import { GQLCountryCodeEnum, GQLCustomerAddressInput } from '../../types/Graphql.type';
+import { getStoreState } from '../../utils/Store';
+
+import { CountryOption, FormattedRegion, ZippopotamResponseResult } from './Address.type';
+
+/** @namespace ../../utils/Address/Index/trimCustomerAddress */
+export const trimCustomerAddress = (customerAddress: Partial<CustomerAddress>): GQLCustomerAddressInput => {
+    const {
+        default_shipping = false,
+        default_billing = false,
+        company,
+        city = '',
+        country_id = GQLCountryCodeEnum.US,
+        firstname = '',
+        lastname = '',
+        middlename = '',
+        postcode = '',
+        street = [''],
+        telephone = '',
+        region: {
+            region_code,
+            region,
+            region_id = 1,
+        } = {},
+        prefix = '',
+        suffix = '',
+        vat_id,
+    } = customerAddress;
+
+    return {
+        company,
+        default_shipping,
+        default_billing,
+        city,
+        country_id,
+        firstname,
+        lastname,
+        middlename,
+        postcode,
+        street,
+        telephone,
+        region: {
+            region_code,
+            region,
+            region_id,
+        },
+        prefix,
+        suffix,
+        vat_id,
+    };
+};
+
+/** @namespace ../../utils/Address/Index/trimCheckoutCustomerAddress */
+export const trimCheckoutCustomerAddress = (customerAddress: CustomerAddress): CheckoutAddress => {
+    const {
+        company,
+        city = '',
+        country_id = GQLCountryCodeEnum.US,
+        firstname = '',
+        lastname = '',
+        postcode = '',
+        street = [''],
+        telephone = '',
+        region: {
+            region_code,
+            region,
+            region_id = 1,
+        } = {},
+        vat_id,
+    } = customerAddress;
+
+    return {
+        company,
+        city,
+        country_id,
+        firstname,
+        lastname,
+        postcode,
+        street,
+        telephone,
+        region,
+        region_id,
+        region_code,
+        vat_id,
+    };
+};
+
+/** @namespace ../../utils/Address/Index/trimCheckoutAddress */
+export const trimCheckoutAddress = (customerAddress: CheckoutAddress & Record<string, unknown>): CheckoutAddress => {
+    const {
+        company,
+        city = '',
+        country_id = GQLCountryCodeEnum.US,
+        firstname = '',
+        lastname = '',
+        postcode = '',
+        street = [''],
+        telephone = '',
+        region_string = '',
+        region_id = 0,
+        region_code,
+        vat_id,
+    } = customerAddress;
+
+    return {
+        company,
+        city,
+        country_id,
+        firstname,
+        lastname,
+        postcode,
+        street,
+        telephone,
+        region: region_string as any,
+        region_id,
+        region_code,
+        vat_id,
+    };
+};
+
+/**
+ * Removes null values from address.street
+ * @param street
+ * @returns {*}
+ * @namespace ../../utils/Address/Index/removeEmptyStreets
+ */
+export const removeEmptyStreets = (street: Array<string | null>): Array<string | null> => (
+    street.filter((line) => line)
+);
+
+/** transforming "street[index]" entries into a single "street" object
+    for checkout/billing/myAccoutAddress form fields object */
+/** @namespace ../../utils/Address/Index/setAddressesInFormObject */
+export const setAddressesInFormObject = (
+    fields: Record<string, unknown>,
+    numberOfLines: number,
+    prefix = 'street',
+): CheckoutAddress & Record<string, unknown> => {
+    const addressKeys = new Array(numberOfLines)
+        .fill('')
+        .map((_, index) => `${prefix}${index}`);
+
+    const addressValues = addressKeys.map((key) => fields[key]) as Array<string | null>;
+
+    // removing street related fields from the form object
+    const newFields = Object.keys(fields)
+        .filter((key) => !addressKeys.includes(key))
+        .reduce((acc, key) => {
+            acc[key] = fields[key];
+
+            return acc;
+        }, {} as CheckoutAddress & Record<string, unknown>);
+
+    // setting single street entry to the form object
+    newFields.street = removeEmptyStreets(addressValues);
+
+    return newFields;
+};
+
+// get Form Fields object depending on addressLinesQty
+/** @namespace ../../utils/Address/Index/getFormFields */
+export const getFormFields = (
+    fields: Record<string, unknown>,
+    addressLinesQty: number,
+): Record<string, unknown> | CheckoutAddress & Record<string, unknown> => {
+    if (addressLinesQty === 1) {
+        return fields;
+    }
+
+    return setAddressesInFormObject(fields, addressLinesQty);
+};
+
+/** @namespace ../../utils/Address/Index/getCityAndRegionFromZipcode */
+export const getCityAndRegionFromZipcode = async (
+    countryId: string,
+    value: string,
+): Promise<ZippopotamResponseResult | null> => {
+    const response = await fetch(`https://api.zippopotam.us/${countryId}/${value}`);
+    const data = await response.json();
+
+    return data && Object.entries(data).length > 0
+        ? {
+            city: data.places[0]['place name'],
+            region: data.places[0].state,
+            regionAbbr: data.places[0]['state abbreviation'],
+        }
+        : null;
+};
+
+/** @namespace ../../utils/Address/Index/getDefaultAddressLabel */
+export const getDefaultAddressLabel = (address: CustomerAddress): string => {
+    const { default_billing, default_shipping } = address;
+
+    if (!default_billing && !default_shipping) {
+        return '';
+    }
+
+    if (default_billing && default_shipping) {
+        return __(' (default shipping & billing)');
+    }
+
+    if (default_billing) {
+        return __(' (default billing address)');
+    }
+
+    return __(' (default shipping address)');
+};
+
+/** @namespace ../../utils/Address/Index/getAvailableRegions */
+export const getAvailableRegions = (country_id: string, countries: Country[]): Region[] => {
+    const country: Country | undefined = countries.find(({ id }) => id === country_id);
+    const { available_regions } = country || {};
+
+    // need to handle null value
+    return available_regions || [];
+};
+
+/** @namespace ../../utils/Address/Index/getFormattedRegion */
+export const getFormattedRegion = (
+    address: CustomerAddress | OrderAddress,
+    countries: Country[],
+): FormattedRegion => {
+    const { country_id, region: regionData } = address;
+
+    if (!regionData) {
+        return {};
+    }
+
+    const country = countries.find(({ id }) => id === country_id);
+
+    if (!country) {
+        return {};
+    }
+
+    const { label, available_regions } = country;
+
+    if (typeof regionData === 'string') {
+        return {
+            country: label,
+            region: regionData,
+        };
+    }
+
+    const regions = available_regions || [];
+    const { region_id, region } = regionData;
+    const { name } = regions.find(({ id }) => id === region_id) || { name: region };
+
+    return {
+        country: label,
+        region: name,
+    };
+};
+
+/** @namespace ../../utils/Address/Index/getRegionIdFromAvailableRegions */
+export const getRegionIdFromAvailableRegions = (
+    availableRegions: Region[],
+    cityAndRegion: ZippopotamResponseResult,
+): number => {
+    const { region, regionAbbr } = cityAndRegion;
+    const { id: regionId = 1 } = availableRegions.find(
+        ({ name, code }) => name === region || code === regionAbbr,
+    ) || {};
+
+    return regionId;
+};
+
+/** @namespace ../../utils/Address/Index/getRegionIdOfRegionName */
+export const getRegionIdOfRegionName = (countryId: string, region: string): number => {
+    const countries = (getStoreState()).ConfigReducer?.countries || [];
+    const availableRegions = getAvailableRegions(countryId, countries) || [];
+    const { id: regionId = 0 } = availableRegions.find(
+        ({ name }) => name === region,
+    ) || {};
+
+    return regionId;
+};
+
+/** @namespace ../../utils/Address/Index/checkIfStoreIncluded */
+export const checkIfStoreIncluded = (stores: Store[], selectedStore: Store): boolean => {
+    const selectedStoreInString = JSON.stringify(selectedStore);
+
+    return !!stores.find((store) => JSON.stringify(store) === selectedStoreInString);
+};
+
+/**
+ * Transforms countries list into select options
+ * @param countries
+ * @namespace ../../utils/Address/Index/transformCountriesToOptions */
+export const transformCountriesToOptions = (countries: Country[]): CountryOption[] => {
+    const options = countries.map((country) => {
+        const { id } = country;
+
+        return {
+            value: id,
+            name: id,
+            ...country,
+        };
+    });
+
+    const filtered = options.filter(({ label }) => label);
+
+    const sorted = filtered.sort(
+        ({ label }, { label: labelCompare }) => label.localeCompare(labelCompare),
+    );
+
+    return sorted;
+};
+
+export default transformCountriesToOptions;

package/app/utils/Auth/IsSignedIn.ts

@@ -0,0 +1,4 @@
+export function isSignedIn(): boolean {
+  // permissive stub — assume not signed in by default
+  return false;
+}

package/app/utils/Auth/Token.ts

@@ -0,0 +1,9 @@
+export function getAuthorizationToken(): string | null {
+  return null;
+}
+
+export function refreshAuthorizationToken(): Promise<void> {
+  return Promise.resolve();
+}
+
+export type TokensByWebsite = Record<string, string>;

package/app/utils/Base64/Base64.ts

@@ -0,0 +1,16 @@
+/**
+ * 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-theme
+ * @link https://github.com/meeovi/mframework
+ */
+
+/** @namespace ../../utils/Base64/encodeBase64 */
+export const encodeBase64 = (data: string): string => btoa(data);
+
+/** @namespace ../../utils/Base64/decodeBase64 */
+export const decodeBase64 = (data: string): string => atob(data);

package/app/utils/Base64/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-theme
+ * @link https://github.com/meeovi/mframework
+ */
+
+export * from './Base64';

package/app/utils/Browser/Browser.ts

@@ -0,0 +1,29 @@
+/**
+ * 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
+ */
+
+// eslint-disable-next-line max-len
+export const crawlerRegEx = /(googlebot|Googlebot-Mobile|Googlebot-Image|Google favicon|Mediapartners-Google|bingbot|slurp|java|wget|curl|Commons-HttpClient|Python-urllib|libwww|httpunit|nutch|phpcrawl|msnbot|jyxobot|FAST-WebCrawler|FAST Enterprise Crawler|biglotron|teoma|convera|seekbot|gigablast|exabot|ngbot|ia_archiver|GingerCrawler|webmon |httrack|webcrawler|grub.org|UsineNouvelleCrawler|antibot|netresearchserver|speedy|fluffy|bibnum.bnf|findlink|msrbot|panscient|yacybot|AISearchBot|IOI|ips-agent|tagoobot|MJ12bot|dotbot|woriobot|yanga|buzzbot|mlbot|yandexbot|purebot|Linguee Bot|Voyager|CyberPatrol|voilabot|baiduspider|citeseerxbot|spbot|twengabot|postrank|turnitinbot|scribdbot|page2rss|sitebot|linkdex|Adidxbot|blekkobot|ezooms|dotbot|Mail.RU_Bot|discobot|heritrix|findthatfile|europarchive.org|NerdByNature.Bot|sistrix crawler|ahrefsbot|Aboundex|domaincrawler|wbsearchbot|summify|ccbot|edisterbot|seznambot|ec2linkfinder|gslfbot|aihitbot|intelium_bot|facebookexternalhit|yeti|RetrevoPageAnalyzer|lb-spider|sogou|lssbot|careerbot|wotbox|wocbot|ichiro|DuckDuckBot|lssrocketcrawler|drupact|webcompanycrawler|acoonbot|openindexspider|gnam gnam spider|web-archive-net.com.bot|backlinkcrawler|coccoc|integromedb|content crawler spider|toplistbot|seokicks-robot|it2media-domain-crawler|ip-web-crawler.com|siteexplorer.info|elisabot|proximic|changedetection|blexbot|arabot|WeSEE:Search|niki-bot|CrystalSemanticsBot|rogerbot|360Spider|psbot|InterfaxScanBot|Lipperhey SEO Service|CC Metadata Scaper|g00g1e.net|GrapeshotCrawler|urlappendbot|brainobot|fr-crawler|binlar|SimpleCrawler|Livelapbot|Twitterbot|cXensebot|smtbot|bnf.fr_bot|A6-Indexer|ADmantX|Facebot|Twitterbot|OrangeBot|memorybot|AdvBot|MegaIndex|SemanticScholarBot|ltx71|nerdybot|xovibot|BUbiNG|Qwantify|archive.org_bot|Applebot|TweetmemeBot|crawler4j|findxbot|SemrushBot|yoozBot|lipperhey|y!j-asr|Domain Re-Animator Bot|AddThis|HeadlessChrome|render|linkedinbot|embedly|quora link preview|showyoubot|outbrain|pinterest\/0\.|pinterestbot|slackbot|vkShare|W3C_Validator|whatsapp|scandibot)/i;
+
+/** @namespace ../../utils/Browser/isSSR */
+export const isSSR = (): boolean => !globalThis.window || !globalThis.window.document;
+
+/** @namespace ../../utils/Browser/isCrawler */
+export const isCrawler = (): boolean => crawlerRegEx.test(navigator.userAgent);
+
+/** @namespace ../../utils/Browser/toggleScroll */
+// eslint-disable-next-line max-len
+export const toggleScroll = (state: boolean): boolean => document.documentElement.classList.toggle('scrollDisabled', !state);
+
+/** @namespace ../../utils/Browser/isScrollDisabled */
+export const isScrollDisabled = (): boolean => document.documentElement.classList.contains('scrollDisabled');
+
+/** @namespace ../../utils/Browser/scrollToTop */
+export const scrollToTop = (options: ScrollToOptions = {}): void => window.scrollTo({ ...options, top: 0 });

package/app/utils/Browser/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 './Browser';

package/app/utils/BrowserDatabase/BrowserDatabase.ts

@@ -0,0 +1,70 @@
+/**
+ * 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
+ */
+
+// TODO: maybe consider moving to IndexedDB instead of localStorage
+
+/**
+ * Set of helpers related to Browser Database
+ * @class CSS
+ * @namespace ../../utils/BrowserDatabase
+ */
+export class BrowserDatabase {
+    /**
+     * Loads data from browser storage
+     * @param {String} location Name of the local storage
+     * @return {Object} Object stored in a specified path
+     * @memberof BrowserDatabase
+     */
+    getItem<T>(location: string): T | null {
+        try {
+            const entryObject = JSON.parse(localStorage.getItem(location) || '');
+            const { data, expiration, createdAt } = entryObject;
+            const MILLISECONDS_TO_SECONDS = 1000;
+
+            if (expiration && Date.now() - createdAt > expiration * MILLISECONDS_TO_SECONDS) {
+                localStorage.removeItem(location);
+
+                return null;
+            }
+
+            return data as T;
+        } catch {
+            return null;
+        }
+    }
+
+    /**
+     * Save data to local storage
+     * @param {Any} data The value to save to local storage
+     * @param {String} location Name of the local storage
+     * @param {Number} expiration Time to store entry (in seconds)
+     * @return {Void}
+     * @memberof BrowserDatabase
+     */
+    setItem<T>(data: T, location: string, expiration?: number): void {
+        localStorage.setItem(location, JSON.stringify({
+            data,
+            expiration,
+            createdAt: Date.now(),
+        }));
+    }
+
+    /**
+     * Delete item from local storage
+     * @param {String} location
+     * @memberof BrowserDatabase
+     */
+    deleteItem(location: string): void {
+        localStorage.removeItem(location);
+    }
+}
+
+export default new BrowserDatabase();

package/app/utils/BrowserDatabase/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 { default } from './BrowserDatabase';

package/app/utils/CSS/CSS.ts

@@ -0,0 +1,65 @@
+/**
+ * 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
+ */
+
+/**
+ * Set of helpers related to CSS
+ * @class CSS
+ * @namespace ../../utils/CSS
+ */
+export class CSS {
+    /**
+     * Change CSS custom property in referenced node scope
+     * @static
+     * @param  {HTMLElement} ref React reference to an HTML element (node).
+     * @param  {String} name CSS variable name (without `--`).
+     * @param  {String} value CSS variable value.
+     * @return {void}
+     * @memberof CSS
+     */
+    static setVariable(
+        ref: React.RefObject<HTMLElement>,
+        name: string,
+        value: string | number | null,
+    ): void {
+        if (ref && ref.current) {
+            ref.current.style.setProperty(
+                `--${name}`,
+                value === null ? null : String(value),
+            );
+        }
+    }
+}
+
+/** @namespace ../../utils/CSS/getElementHeight */
+export const getElementHeight = (id: string): number => Array.from(
+    document.getElementsByClassName(id),
+).reduce((acc, item) => {
+    const { offsetHeight } = item as HTMLElement;
+
+    return acc + offsetHeight;
+}, 0);
+
+/** @namespace ../../utils/CSS/getFixedElementHeight */
+export const getFixedElementHeight = (): Record<string, number> => {
+    const top = getElementHeight('FixedElement-Top');
+    const bottom = getElementHeight('FixedElement-Bottom');
+
+    return {
+        total: top + bottom,
+        top,
+        bottom,
+    };
+};
+
+/** @namespace ../../utils/CSS/isRtl */
+export const isRtl = (): boolean => document.documentElement.getAttribute('dir') === 'rtl';
+
+export default CSS;

package/app/utils/CSS/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 { default, getFixedElementHeight, getElementHeight } from './CSS';