@mframework/layer-commerce 0.0.3

package/app/types/Field.type.ts

@@ -0,0 +1,151 @@
+/**
+ * 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 PropTypes from 'prop-types';
+
+import { FieldType } from 'Component/Field/Field.config';
+import { ValidationInputType } from '../utils/Validator/Config';
+
+export type Label = string | React.ReactNode;
+
+export interface Option {
+    id?: string | number;
+    label?: Label;
+    value?: string | number;
+    name?: string;
+    isAvailable?: boolean;
+    target?: { value: string | number };
+    sort_order?: number;
+    isPlaceholder?: boolean;
+    subLabel?: string;
+    isHovered?: boolean;
+    disabled?: boolean;
+}
+
+export interface CustomErrorMessages {
+    onRequirementFail?: string;
+    onInputTypeFail?: string;
+    onMatchFail?: string;
+    onRangeFailMin?: string;
+    onRangeFailMax?: string;
+    onExtensionFail?: string;
+    onGroupFail?: string;
+}
+
+// TODO
+export type Events = Record<string, unknown>;
+
+// TODO
+export type FieldAttr = unknown;
+
+export interface FieldOptions {
+    id?: string | number;
+    label?: Label;
+    value?: string | number;
+    isHovered?: boolean;
+}
+
+export interface Values {
+    value?: string | boolean;
+    type?: string | boolean;
+    name?: string | boolean;
+}
+
+export interface ErrorMessage {
+    injectables?: string[];
+    value?: string;
+}
+
+export interface ErrorField {
+    errorMessages?: ErrorMessage[];
+    value?: string | boolean;
+    type?: string | boolean;
+    name?: string | boolean;
+}
+
+export type FieldGroupValidationResponse = {
+    errorFields: ErrorField;
+    errorMessages: ErrorMessage;
+    values: Values;
+} | boolean;
+
+export type Date = number | string;
+
+export interface ValidationOutput {
+    detail?: {
+        errors?: {
+            type: any;
+            name?: string;
+            value?: string | boolean;
+            errorMessages?: string[];
+        }[];
+    };
+}
+
+export const LabelType = PropTypes.oneOfType([PropTypes.string, PropTypes.node]);
+
+export const OptionType = PropTypes.shape({
+    id: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+    label: LabelType,
+    value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+});
+
+export const CustomErrorMessagesType = PropTypes.shape({
+    onRequirementFail: PropTypes.string,
+    onInputTypeFail: PropTypes.string,
+    onMatchFail: PropTypes.oneOfType([PropTypes.object, PropTypes.string]),
+    onRangeFailMin: PropTypes.string,
+    onRangeFailMax: PropTypes.string,
+    onExtensionFail: PropTypes.string,
+});
+
+export const ValidationRuleType = PropTypes.shape({
+    isRequired: PropTypes.bool,
+    inputType: PropTypes.oneOf(Object.values(ValidationInputType)),
+    match: PropTypes.func,
+    customErrorMessages: CustomErrorMessagesType,
+});
+
+export const EventsType = PropTypes.objectOf(PropTypes.func);
+
+export const FieldAttrType = PropTypes.object;
+
+export const FieldOptionsType = PropTypes.arrayOf(
+    PropTypes.shape({
+        id: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+        label: LabelType,
+        value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+    }),
+);
+
+export const ValuesShape = PropTypes.shape({
+    value: PropTypes.oneOfType([PropTypes.string, PropTypes.bool]),
+    type: PropTypes.oneOfType([PropTypes.string, PropTypes.bool]),
+    name: PropTypes.oneOfType([PropTypes.string, PropTypes.bool]),
+});
+
+export const ErrorMessageShape = PropTypes.shape({
+    injectables: PropTypes.arrayOf(PropTypes.string),
+    value: PropTypes.string,
+});
+
+export const errorFieldShape = PropTypes.arrayOf(PropTypes.shape({
+    errorMessages: PropTypes.arrayOf(ErrorMessageShape),
+    ...ValuesShape,
+}));
+
+export const FieldGroupValidationResponseType = PropTypes.oneOfType([PropTypes.shape({
+    errorFields: PropTypes.arrayOf(errorFieldShape),
+    errorMessages: PropTypes.arrayOf(ErrorMessageShape),
+    values: PropTypes.arrayOf(ValuesShape),
+}), PropTypes.bool]);
+
+export const DateType = PropTypes.oneOfType([PropTypes.number, PropTypes.string]);

package/app/types/Global.type.ts

@@ -0,0 +1,156 @@
+/**
+ * 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 { StoreEnhancer } from 'redux';
+
+import { CmsPageFields } from '../normalizers/CmsPage.type';
+import { Slider } from '../normalizers/Slider.type';
+import { CategoryDisplayMode } from '../routes/CategoryPage/CategoryPage.config';
+
+import { Mix } from './Common.type';
+
+declare global {
+    interface Window {
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        '__REACT_DEVTOOLS_GLOBAL_HOOK__'?: Record<string, unknown>;
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        '__REDUX_DEVTOOLS_EXTENSION__'?: (options: any) => StoreEnhancer<any, any>;
+        storeRegexText: string;
+        actionName: {
+            type?: string;
+            id?: number;
+            sku?: string;
+            name?: string;
+            cmsPage?: CmsPageData;
+            description?: string;
+            categoryDefaultSortBy?: string;
+            slider?: Slider;
+            display_mode?: CategoryDisplayMode;
+        };
+        storeConfig?: {
+            cms_home_page: string;
+            catalog_default_sort_by: string;
+            tax_display_type: string;
+            demo_notice: boolean;
+        };
+        secure_base_media_url?: string;
+        prefetchedImages: Record<string, HTMLImageElement>;
+        storeList: Array<string>;
+        dataCache?: Record<number, unknown>;
+        contentConfiguration?: ContentConfiguration;
+        prompt_event?: BeforeInstallPromptEvent;
+        website_code: string;
+        storeCurrency: string;
+        isPriorityLoaded: boolean;
+        isPrefetchValueUsed?: boolean;
+        metaHtml?: string;
+        isInstallPromptAvailable?: boolean;
+    }
+
+    interface BeforeInstallPromptEvent extends Event {
+
+        readonly platforms: Array<string>;
+
+        readonly userChoice: Promise<{
+            outcome: 'accepted' | 'dismissed';
+            platform: string;
+        }>;
+
+        prompt(): Promise<void>;
+
+    }
+
+    function __(message: string, ...args: unknown[]): string;
+
+    // eslint-disable-next-line @typescript-eslint/no-namespace
+    namespace React {
+        interface Component {
+            __construct?(props: unknown): void;
+        }
+
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        interface ClassAttributes<T> {
+            block?: string;
+            elem?: string;
+            mods?: Record<string, unknown>;
+            mix?: Mix;
+        }
+    }
+
+    interface Navigator {
+        userAgentData: NavigatorUAData;
+    }
+
+    interface NavigatorUABrandVersion {
+        brand: string;
+        version: string;
+    }
+
+    interface UADataValues {
+        brands?: NavigatorUABrandVersion[];
+        mobile?: boolean;
+        platform?: string;
+        architecture?: string;
+        bitness?: string;
+        model?: string;
+        platformVersion?: string;
+        uaFullVersion?: string;
+    }
+
+    interface UALowEntropyJSON {
+        brands: NavigatorUABrandVersion[];
+        mobile: boolean;
+        platform: string;
+    }
+
+    interface NavigatorUAData extends UALowEntropyJSON {
+        getHighEntropyValues(hints: string[]): Promise<UADataValues>;
+        toJSON(): UALowEntropyJSON;
+    }
+
+    interface HTMLInputElement {
+        fileData?: string;
+    }
+
+    interface ContentConfiguration {
+        header_content?: {
+            header_menu?: string;
+            contacts_cms?: string;
+        };
+        minicart_content?: {
+            minicart_cms?: string;
+        };
+        footer_content?: {
+            footer_cms?: string;
+        };
+        product_list_content?: {
+            attribute_to_display?: string;
+        };
+        cart_content?: {
+            cart_cms?: string;
+        };
+        checkout_content?: {
+            checkout_billing_cms?: string;
+            checkout_shipping_cms?: string;
+        };
+        contact_us_content?: {
+            contact_us_cms_block?: string;
+        };
+    }
+
+    interface CmsPageData extends CmsPageFields {
+        page_id?: String;
+        identifier?: String;
+        url_key?: String;
+    }
+
+    type EmptyObject = Record<string, never>;
+}