@mframework/layer-commerce 0.0.3

package/app/types/Layout.type.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { CategoryPageLayout } from '../routes/CategoryPage/CategoryPage.config';
+
+// Support for comtabilitiy
+
+export const LayoutType = PropTypes.oneOf([CategoryPageLayout.GRID, CategoryPageLayout.LIST]);

package/app/types/Menu.type.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 PropTypes from 'prop-types';
+
+import { LocationType } from './Router.type';
+
+// Support for comtabilitiy
+
+export const MenuItemType = PropTypes.shape({
+    item_id: PropTypes.string,
+    is_active: PropTypes.bool,
+    parent_id: PropTypes.number,
+    position: PropTypes.number,
+    title: PropTypes.string,
+    item_class: PropTypes.string,
+    icon: PropTypes.string,
+    url: LocationType,
+    cms_page_identifier: PropTypes.string,
+    category_id: PropTypes.number,
+});
+
+// @ts-ignore
+MenuItemType.children = PropTypes.objectOf(MenuItemType);
+
+export const MenuType = PropTypes.shape({
+    menu_id: PropTypes.string,
+    is_active: PropTypes.bool,
+    css_class: PropTypes.string,
+    items: PropTypes.arrayOf(MenuItemType),
+});

package/app/types/MiniCart.type.ts

@@ -0,0 +1,61 @@
+/**
+ * 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';
+
+import { ProductType } from './ProductList.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 QuantitySelectorType = PropTypes.shape({
+    increase: PropTypes.func,
+    decrease: PropTypes.func,
+    quantity: PropTypes.number,
+});
+
+export const TotalsType = PropTypes.shape({
+    count: PropTypes.number,
+    subTotalPrice: PropTypes.string,
+    taxPrice: PropTypes.string,
+    grandTotalPrice: PropTypes.string,
+});
+
+export const CartItemType = PropTypes.shape({
+    discount_amount: PropTypes.number,
+    discount_percent: PropTypes.number,
+    item_id: PropTypes.number,
+    price: PropTypes.number,
+    product: ProductType,
+    qty: PropTypes.number,
+    row_total: PropTypes.number,
+    sku: PropTypes.string,
+    tax_amount: PropTypes.number,
+    tax_percent: PropTypes.number,
+});
+
+export const CartDisplayType = PropTypes.shape({
+    display_tax_in_price: PropTypes.string,
+    display_tax_in_subtotal: PropTypes.string,
+    display_tax_in_shipping_amount: PropTypes.string,
+    include_tax_in_order_total: PropTypes.bool,
+    display_full_tax_summary: PropTypes.bool,
+    display_zero_tax_subtotal: PropTypes.bool,
+});

package/app/types/NotificationList.type.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 NotificationType = PropTypes.shape({
+    msgText: PropTypes.string,
+    msgType: PropTypes.string,
+    msgDebug: PropTypes.arrayOf(
+        PropTypes.shape({
+            message: PropTypes.string,
+            extensions: PropTypes.shape({
+                category: PropTypes.string,
+            }),
+            locations: PropTypes.arrayOf(PropTypes.shape({
+                line: PropTypes.number,
+                column: PropTypes.number,
+            })),
+            path: PropTypes.arrayOf(PropTypes.string),
+        }),
+    ),
+});
+
+export const NotificationListType = PropTypes.objectOf(NotificationType);

package/app/types/Order.type.ts

@@ -0,0 +1,174 @@
+/**
+ * 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 OrderPrintMapType = PropTypes.shape({
+    activeTab: PropTypes.string,
+    request: PropTypes.func,
+});
+
+export const OrderComment = PropTypes.shape({
+    message: PropTypes.string,
+    timestamp: PropTypes.string,
+});
+
+export const OrderComments = PropTypes.arrayOf(OrderComment);
+
+export const OrderGrandTotalType = PropTypes.shape({
+    value: PropTypes.number,
+    currency: PropTypes.string,
+});
+
+export const OrderTotalType = PropTypes.shape({
+    grand_total: OrderGrandTotalType,
+});
+
+export const OrderInfoType = PropTypes.shape({
+    id: PropTypes.number,
+    increment_id: PropTypes.string,
+    created_at: PropTypes.string,
+    status_label: PropTypes.string,
+    grand_total: PropTypes.number,
+    subtotal: PropTypes.string,
+});
+
+export const OrderPaymentInfo = PropTypes.shape({
+    name: PropTypes.string,
+    type: PropTypes.string,
+    additional_data: PropTypes.shape({
+        name: PropTypes.string,
+        value: PropTypes.string,
+    }),
+});
+
+export const OrderPaymentsInfo = PropTypes.arrayOf(OrderPaymentInfo);
+
+export const OrderAddressType = PropTypes.shape({
+    city: PropTypes.string,
+    country_code: PropTypes.string,
+    firstname: PropTypes.string,
+    lastname: PropTypes.string,
+    postcode: PropTypes.string,
+    region: PropTypes.string,
+    region_id: PropTypes.string,
+    street: PropTypes.arrayOf(PropTypes.string),
+    telephone: PropTypes.string,
+});
+
+export const orderItemQtyType = PropTypes.shape({
+    quantity_ordered: PropTypes.number,
+    quantity_canceled: PropTypes.number,
+    quantity_invoiced: PropTypes.number,
+    quantity_refunded: PropTypes.number,
+    quantity_returned: PropTypes.number,
+    quantity_shipped: PropTypes.number,
+});
+
+export const MoneyType = PropTypes.shape({
+    currency: PropTypes.string,
+    value: PropTypes.number,
+});
+
+export const DiscountType = PropTypes.shape({
+    amount: MoneyType,
+    value: PropTypes.number,
+});
+
+export const OptionItemType = PropTypes.shape({
+    title: PropTypes.string,
+    qty: PropTypes.number,
+    price: PropTypes.number,
+});
+
+export const OptionItemsType = PropTypes.arrayOf(OptionItemType);
+
+export const OptionType = PropTypes.shape({
+    label: PropTypes.string,
+    value: PropTypes.string,
+    items: OptionItemsType,
+    linkItems: PropTypes.arrayOf(PropTypes.string),
+});
+
+export const OptionsType = PropTypes.arrayOf(OptionType);
+
+export const OrderProductType = PropTypes.shape({
+    orderItemQtyType,
+    discounts: PropTypes.arrayOf(DiscountType),
+    id: PropTypes.string,
+    selected_options: OptionsType,
+    entered_options: OptionsType,
+    product_name: PropTypes.string,
+    product_sale_price: MoneyType,
+    product_sku: PropTypes.string,
+    product_type: PropTypes.string,
+    product_url_key: PropTypes.string,
+});
+
+export const OrderProductsType = PropTypes.arrayOf(OrderProductType);
+
+export const OrderTabType = PropTypes.shape({
+    items: OrderProductsType,
+    id: PropTypes.oneOfType([
+        PropTypes.string,
+        PropTypes.number,
+    ]),
+    number: PropTypes.string,
+    total: OrderTotalType,
+    comments: OrderComments,
+});
+
+export const OrderTabsType = PropTypes.arrayOf(OrderTabType);
+
+export const OrderType = PropTypes.shape({
+    can_reorder: PropTypes.bool,
+    carrier: PropTypes.string,
+    id: PropTypes.string,
+    order_date: PropTypes.string,
+    credit_memos: OrderTabsType,
+    invoices: OrderTabsType,
+    items: OrderProductsType,
+    shipments: OrderTabsType,
+    payment_methods: OrderPaymentsInfo,
+    rss_link: PropTypes.string,
+    shipping_address: OrderAddressType,
+    billing_address: OrderAddressType,
+    shipping_method: PropTypes.string,
+    status: PropTypes.string,
+    total: OrderTotalType,
+    comments: OrderComments,
+});
+
+export const DownloadableType = PropTypes.shape({
+    id: PropTypes.number,
+    order_id: PropTypes.number,
+    order_increment_id: PropTypes.string,
+    status_label: PropTypes.string,
+    downloads: PropTypes.string,
+    download_url: PropTypes.string,
+    created_at: PropTypes.string,
+    title: PropTypes.string,
+});
+
+export const PageInfoType = PropTypes.shape({
+    current_page: PropTypes.number,
+    page_size: PropTypes.number,
+    total_pages: PropTypes.number,
+});
+
+export const OrdersType = PropTypes.arrayOf(OrderType);
+
+export const OrdersListType = PropTypes.shape({
+    items: OrdersType,
+    pageInfo: PageInfoType,
+});

package/app/types/Price.type.ts

@@ -0,0 +1,72 @@
+export type PriceType = number;
+// Preserve runtime PropTypes definitions below; remove top-level TS alias to avoid duplication
+/**
+ * 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 PriceItemType = PropTypes.shape({
+    currency: PropTypes.string,
+    value: PropTypes.number,
+    valueFormatted: PropTypes.string,
+});
+
+export const DiscountType = PropTypes.shape({
+    amount_off: PropTypes.number,
+    percent_off: PropTypes.number,
+});
+
+export const PriceVariantType = PropTypes.shape({
+    discount: DiscountType,
+    final_price: PriceItemType,
+    regular_price: PriceItemType,
+});
+
+export const PriceType = PropTypes.shape({
+    minimum_price: PriceVariantType,
+    maximal_price: PriceVariantType,
+});
+
+export const OriginalPriceType = PropTypes.shape({
+    minRegularPrice: PriceItemType,
+    minFinalPrice: PriceItemType,
+    minFinalPriceExclTax: PriceItemType,
+    maxRegularPrice: PriceItemType,
+    maxFinalPrice: PriceItemType,
+    maxFinalPriceExclTax: PriceItemType,
+});
+
+export const ProductPriceType = PropTypes.shape({
+    price: PropTypes.shape({
+        finalPrice: PriceItemType,
+        finalPriceExclTax: PriceItemType,
+        originalPrice: PriceItemType,
+        originalPriceExclTax: PriceItemType,
+        discount: DiscountType,
+    }),
+    originalPrice: OriginalPriceType,
+    configuration: PropTypes.shape({
+        containsOptions: PropTypes.bool,
+        containsOptionsWithPrice: PropTypes.bool,
+        containsRequiredOptions: PropTypes.bool,
+        containsRequiredOptionsWithPrice: PropTypes.bool,
+    }),
+});
+
+export const TierPricesType = PropTypes.arrayOf(PropTypes.shape({
+    discount: DiscountType,
+    final_price: PropTypes.shape({
+        currency: PropTypes.string,
+        value: PropTypes.number,
+    }),
+    quantity: PropTypes.number,
+}));

package/app/types/ProductCompare.type.ts

@@ -0,0 +1,24 @@
+export interface ComparableAttribute {
+  id?: string
+  name?: string
+  values?: string[]
+}
+
+export interface ComparableProduct {
+  id?: string
+  sku: string
+  name?: string
+}
+
+export interface ComparableItem {
+  product: ComparableProduct
+  attributes?: Record<string, any>
+}
+
+export interface CompareList {
+  attributes?: ComparableAttribute[]
+  products?: ComparableProduct[]
+  items?: ComparableItem[]
+}
+
+export {}