@mframework/layer-commerce 0.0.3

package/app/types/Account.type.ts

@@ -0,0 +1,141 @@
+/* eslint-disable no-unused-vars */
+/**
+ * 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 { GQLCountryCodeEnum } from './Graphql.type';
+
+export enum MyAccountTabs {
+    MY_ACCOUNT = 'my-account',
+    MY_ORDERS = 'my-orders',
+    MY_ORDER = 'my-order',
+    MY_DOWNLOADABLE = 'my-downloadable',
+    MY_WISHLIST = 'my-wishlist',
+    ADDRESS_BOOK = 'address',
+    NEWSLETTER_SUBSCRIPTION = 'newsletter-subscription',
+    ACCOUNT_INFORMATION = 'edit',
+}
+
+export enum MyAccountTabsSection {
+    FIRST_SECTION = 1,
+    SECOND_SECTION,
+    THIRD_SECTION,
+}
+
+export interface Region {
+    region_code: string | null;
+    region: string | null;
+    region_id: number;
+}
+
+export interface Address {
+    city: string;
+    company: string | null;
+    country_id: string;
+    customer_id?: number;
+    default_billing: boolean;
+    default_shipping: boolean;
+    firstname: string;
+    id?: number;
+    lastname: string;
+    middlename: string;
+    postcode: string;
+    prefix: string;
+    region?: Region;
+    street: string | string[];
+    suffix: string;
+    telephone: string;
+    vat_id: number | null;
+}
+
+export interface TrimmedCheckoutAddress {
+    city: string;
+    company?: string;
+    country_id: GQLCountryCodeEnum;
+    firstname: string;
+    lastname: string;
+    postcode: string;
+    region?: string;
+    region_string?: string;
+    region_id: number;
+    region_code?: string;
+    street: Array<string | null>;
+    telephone: string;
+    vat_id?: string;
+}
+
+export interface Tab {
+    url: string;
+    name: string;
+}
+
+// Support for comtabilitiy
+
+export const RegionType = PropTypes.oneOfType([
+    PropTypes.shape({
+        region_code: PropTypes.string,
+        region: PropTypes.string,
+        region_id: PropTypes.number,
+    }),
+]);
+
+export const Addresstype = PropTypes.shape({
+    city: PropTypes.string,
+    country_id: PropTypes.string,
+    customer_id: PropTypes.number,
+    default_billing: PropTypes.bool,
+    default_shipping: PropTypes.bool,
+    firstname: PropTypes.string,
+    id: PropTypes.number,
+    lastname: PropTypes.string,
+    middlename: PropTypes.string,
+    postcode: PropTypes.string,
+    prefix: PropTypes.string,
+    RegionType,
+    street: PropTypes.oneOfType([
+        PropTypes.string,
+        PropTypes.arrayOf(PropTypes.string),
+    ]),
+    suffix: PropTypes.string,
+    telephone: PropTypes.string,
+});
+
+export const AddressesType = PropTypes.arrayOf(Addresstype);
+
+export const CustomerType = PropTypes.shape({
+    AddressesType,
+    created_at: PropTypes.string,
+    default_billing: PropTypes.string,
+    default_shipping: PropTypes.string,
+    dob: PropTypes.instanceOf(Date),
+    email: PropTypes.string,
+    firstname: PropTypes.string,
+    group_id: PropTypes.number,
+    id: PropTypes.number,
+    is_subscribed: PropTypes.bool,
+    lastname: PropTypes.string,
+    middlename: PropTypes.string,
+    prefix: PropTypes.string,
+    suffix: PropTypes.string,
+    taxvat: PropTypes.string,
+});
+
+export const ActiveTabType = PropTypes.string;
+
+export const TabType = PropTypes.shape({
+    url: PropTypes.string,
+    name: PropTypes.string,
+});
+
+export const TabMapType = PropTypes.objectOf(TabType);
+
+export const SignInStateType = PropTypes.string;

package/app/types/Breadcrumbs.type.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 { LinkType } from './Router.type';
+
+// Support for comtabilitiy
+
+export const BreadcrumbType = PropTypes.shape({
+    url: LinkType,
+    name: PropTypes.string,
+});
+
+export const BreadcrumbsType = PropTypes.arrayOf(BreadcrumbType);

package/app/types/CMS.type.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 { MetaTitleType } from './Common.type';
+
+// Support for comtabilitiy
+
+export const PageType = PropTypes.shape({
+    title: PropTypes.string,
+    content: PropTypes.string,
+    meta_title: MetaTitleType,
+    meta_description: PropTypes.string,
+    meta_keywords: PropTypes.string,
+});
+
+export const BlockType = PropTypes.shape({
+    title: PropTypes.string,
+    content: PropTypes.string,
+});
+
+export const BlockListType = PropTypes.shape({
+    items: PropTypes.objectOf(BlockType),
+});

package/app/types/Category.type.ts

@@ -0,0 +1,67 @@
+/**
+ * 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 { MetaTitleType } from './Common.type';
+
+// Support for comtabilitiy
+
+export const BreadcrumbsType = PropTypes.arrayOf(
+    PropTypes.shape({
+        category_name: PropTypes.string,
+        category_url: PropTypes.string,
+        category_level: PropTypes.number,
+    }),
+);
+
+export const CategoryFragment = {
+    id: PropTypes.number,
+    breadcrumbs: BreadcrumbsType,
+    description: PropTypes.string,
+    image: PropTypes.string,
+    meta_description: PropTypes.string,
+    meta_title: MetaTitleType,
+    name: PropTypes.string,
+    product_count: PropTypes.number,
+    url_key: PropTypes.string,
+    url_path: PropTypes.string,
+    display_mode: PropTypes.string,
+};
+
+export const CategoryTreeType = PropTypes.shape({
+    ...CategoryFragment,
+    children: PropTypes.arrayOf(PropTypes.shape(CategoryFragment)),
+});
+
+export const SelectedFiltersType = PropTypes.objectOf(PropTypes.arrayOf(PropTypes.string));
+
+export const FilterType = PropTypes.objectOf(
+    PropTypes.arrayOf(PropTypes.string),
+);
+
+export const FilterInputType = PropTypes.shape({
+    categoryIds: PropTypes.number,
+    categoryUrlPath: PropTypes.string,
+    customFilters: SelectedFiltersType,
+    priceRange: PropTypes.shape({
+        min: PropTypes.number,
+        max: PropTypes.number,
+    }),
+    conditions: PropTypes.string,
+});
+
+export const SortFieldsType = PropTypes.shape({
+    options: PropTypes.arrayOf(PropTypes.shape({
+        label: PropTypes.string,
+        value: PropTypes.string,
+    })),
+});

package/app/types/Checkout.type.ts

@@ -0,0 +1,58 @@
+/**
+ * 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';
+
+// Support for comtabilitiy
+
+export const PaymentMethodType = PropTypes.shape({
+    code: PropTypes.string,
+    title: PropTypes.string,
+});
+
+export const PaymentMethodsType = PropTypes.arrayOf(
+    PaymentMethodType,
+);
+
+export const ShippingMethodType = PropTypes.shape({
+    amount: PropTypes.number,
+    available: PropTypes.bool,
+    base_amount: PropTypes.number,
+    carrier_code: PropTypes.string,
+    carrier_title: PropTypes.string,
+    error_message: PropTypes.string,
+    method_code: PropTypes.string,
+    method_title: PropTypes.string,
+    price_excl_tax: PropTypes.number,
+    price_incl_tax: PropTypes.number,
+});
+
+export const ShippingMethodsType = PropTypes.arrayOf(
+    ShippingMethodType,
+);
+
+export const StoreType = PropTypes.shape({
+    city: PropTypes.string,
+    country: PropTypes.string,
+    description: PropTypes.string,
+    name: PropTypes.string,
+    phone: PropTypes.string,
+    pickup_location_code: PropTypes.string,
+    postcode: PropTypes.string,
+    region: PropTypes.string,
+    street: PropTypes.string,
+});
+
+export const CheckoutStepType = PropTypes.oneOf([
+    'billing',
+    'shipping',
+    'details',
+]);

package/app/types/Common.type.ts

@@ -0,0 +1,77 @@
+export type MetaTitleType = string;
+
+export interface CmsPageData {
+  content?: string;
+}
+// Type exports intentionally provided by PropTypes below for runtime compatibility
+/**
+ * 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 { ReactNode } from 'react';
+
+export type Merge<A, B> = Omit<A, keyof B> & B;
+
+export type Mods = Record<string, string | boolean>;
+
+export interface Mix {
+    block?: string;
+    elem?: string;
+    mods?: Mods;
+    mix?: Mix;
+}
+
+export type ReactElement = ReactNode | ReactNode[];
+
+export type Children = ReactElement;
+
+// TODO unknown
+export type MetaTitle = string | unknown;
+
+export type Url<T = unknown> = {
+    search?: string;
+    pathname: string;
+    state?: T;
+};
+
+export interface NetworkError { message: string }
+
+export type ObjectEntries<T> = {
+    [K in keyof T]: [K, T[K]];
+}[keyof T];
+
+// Support for comtabilitiy
+
+export const ModsType = PropTypes.objectOf(PropTypes.oneOfType([
+    PropTypes.string,
+    PropTypes.bool,
+]));
+
+export const MixType = PropTypes.shape({
+    block: PropTypes.string,
+    elem: PropTypes.string,
+    mods: ModsType,
+});
+
+// @ts-ignore
+MixType.mix = MixType;
+
+export const ChildrenType = PropTypes.oneOfType([
+    PropTypes.arrayOf(PropTypes.node),
+    PropTypes.node,
+]);
+
+export const RefType = PropTypes.oneOfType([
+    PropTypes.func,
+    PropTypes.shape({ current: PropTypes.instanceOf(Element) }),
+]);
+
+export const MetaTitleType = PropTypes.oneOfType([PropTypes.string, PropTypes.object]);

package/app/types/Config.type.ts

@@ -0,0 +1,47 @@
+/**
+ * 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 { DisplayCartTaxInPrice, DisplayCartTaxInShipping, DisplayCartTaxInSubTotal } from '../utils/Cart/Cart.type';
+
+// Support for comtabilitiy
+
+export const RegionType = PropTypes.shape({
+    code: PropTypes.string,
+    name: PropTypes.string,
+    id: PropTypes.number,
+});
+
+export const CountriesType = PropTypes.arrayOf(
+    PropTypes.shape({
+        label: PropTypes.string,
+        id: PropTypes.string,
+        available_regions: PropTypes.arrayOf(RegionType),
+    }),
+);
+
+export const CartConfigType = PropTypes.shape({
+    display_tax_in_price: PropTypes.oneOf(Object.values(DisplayCartTaxInPrice)),
+    display_tax_in_subtotal: PropTypes.oneOf(Object.values(DisplayCartTaxInSubTotal)),
+    display_tax_in_shipping_amount: PropTypes.oneOf(Object.values(DisplayCartTaxInShipping)),
+    include_tax_in_order_total: PropTypes.bool.isRequired,
+    display_full_tax_summary: PropTypes.bool.isRequired,
+    display_zero_tax_subtotal: PropTypes.bool.isRequired,
+});
+
+export const StoreItemType = PropTypes.shape({
+    id: PropTypes.string,
+    value: PropTypes.string,
+    storeUrl: PropTypes.string,
+    storeLinkUrl: PropTypes.string,
+    label: PropTypes.string,
+});

package/app/types/Device.type.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 we should move this to common types?
+import PropTypes from 'prop-types';
+
+export interface Device {
+    isMobile: boolean;
+    android: boolean;
+    ios: boolean;
+    blackberry: boolean;
+    opera: boolean;
+    safari: boolean;
+    windows: boolean;
+    standaloneMode?: boolean;
+}
+
+// Support for comtabilitiy
+
+export const DeviceType = PropTypes.shape({
+    isMobile: PropTypes.bool,
+    android: PropTypes.bool,
+    ios: PropTypes.bool,
+    blackberry: PropTypes.bool,
+    opera: PropTypes.bool,
+    safari: PropTypes.bool,
+    windows: PropTypes.bool,
+    standaloneMode: PropTypes.bool,
+});

package/app/types/Direction.type.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 {
+    Directions,
+} from 'Component/ChevronIcon/ChevronIcon.config';
+import { SortDirections } from '../routes/CategoryPage/CategoryPage.config';
+
+// Support for comtabilitiy
+
+export const DirectionType = PropTypes.oneOf([Directions.RIGHT, Directions.LEFT, Directions.TOP, Directions.BOTTOM]);
+
+export const SortDirectionType = PropTypes.oneOf(Object.values(SortDirections));

package/app/types/Downloadable.type.ts

@@ -0,0 +1,24 @@
+/**
+ * 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';
+
+// Support for comtabilitiy
+
+export const DownloadableLinkType = PropTypes.shape({
+    sample_url: PropTypes.string,
+    sort_order: PropTypes.number,
+    title: PropTypes.string,
+    id: PropTypes.number,
+    uid: PropTypes.string,
+    price: PropTypes.number,
+});
+
+export const DownloadableLinksType = PropTypes.oneOfType([PropTypes.arrayOf(DownloadableLinkType), PropTypes.string]);

package/app/types/Error.type.ts

@@ -0,0 +1,22 @@
+/**
+ * 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';
+
+// Support for comtabilitiy
+
+export const ErrorDetailsType = PropTypes.shape({
+    // eslint-disable-next-line react/forbid-prop-types
+    err: PropTypes.object,
+    info: PropTypes.shape({
+        componentStack: PropTypes.string,
+    }),
+});