@mframework/layer-commerce 0.0.3

package/app/types/ProductList.type.ts

@@ -0,0 +1,351 @@
+/**
+ * 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 { PriceType } from './Price.type';
+import { UrlRewriteType } from './Router.type';
+import { StockStatusType } from './StockStatus.type';
+
+// Support for comtabilitiy
+
+export const AttributeType = PropTypes.shape({
+    attribute_code: PropTypes.string,
+    attribute_type: PropTypes.string,
+    attribute_value: PropTypes.string,
+    attribute_label: PropTypes.string,
+    attribute_options: PropTypes.objectOf(PropTypes.shape({
+        label: PropTypes.string,
+        value: PropTypes.string,
+    })),
+    has_swatch: PropTypes.bool,
+    is_boolean: PropTypes.bool,
+});
+
+export const AttributesType = PropTypes.oneOfType([
+    PropTypes.objectOf(AttributeType),
+    PropTypes.arrayOf(PropTypes.objectOf(AttributeType)),
+]);
+
+export const FilterAttributeType = PropTypes.shape({
+    attribute_code: PropTypes.string,
+    attribute_label: PropTypes.string,
+    attribute_position: PropTypes.number,
+    attribute_values: PropTypes.arrayOf(PropTypes.string),
+    attribute_type: PropTypes.string,
+    attribute_options: PropTypes.objectOf(PropTypes.shape({
+        label: PropTypes.string,
+        count: PropTypes.number,
+        value_string: PropTypes.string,
+        swatch_data: PropTypes.shape({ type: PropTypes.string, value: PropTypes.string }),
+    })),
+    is_boolean: PropTypes.bool,
+    has_swatch: PropTypes.bool,
+});
+
+export const BreadcrumbsType = PropTypes.arrayOf(
+    PropTypes.shape({
+        name: PropTypes.string,
+        url_path: PropTypes.string,
+    }),
+);
+
+export const ImageType = PropTypes.shape({
+    path: PropTypes.string,
+    url: PropTypes.string,
+});
+
+export const CategoryType = PropTypes.shape({
+    name: PropTypes.string,
+    url_path: PropTypes.string,
+    breadcrumbs: BreadcrumbsType,
+});
+
+export const CategoriesType = PropTypes.arrayOf(CategoryType);
+
+export const ThumbnailType = PropTypes.shape({
+    height: PropTypes.string,
+    type: PropTypes.string,
+    url: PropTypes.string,
+    width: PropTypes.string,
+});
+
+export const MediaItemType = PropTypes.shape({
+    thumbnail: ThumbnailType,
+    file: PropTypes.string,
+    video_content: PropTypes.shape({
+        media_type: PropTypes.string,
+        video_description: PropTypes.string,
+        video_metadata: PropTypes.string,
+        video_provider: PropTypes.string,
+        video_title: PropTypes.string,
+        video_url: PropTypes.string,
+    }),
+    id: PropTypes.number,
+    media_type: PropTypes.string,
+    label: PropTypes.string,
+});
+
+export const MediaType = PropTypes.arrayOf(MediaItemType);
+
+export const ProductLinksType = PropTypes.arrayOf(
+    PropTypes.shape({
+        link_type: PropTypes.string,
+        linked_product_sku: PropTypes.string,
+        position: PropTypes.number,
+    }),
+);
+
+export const ReviewSummaryShape = {
+    rating_summary: PropTypes.number,
+    review_count: PropTypes.number,
+};
+
+export const RatingVoteType = PropTypes.shape({
+    vote_id: PropTypes.number,
+    rating_code: PropTypes.string,
+    percent: PropTypes.number,
+});
+
+export const ReviewsType = PropTypes.arrayOf(
+    PropTypes.shape({
+        review_id: PropTypes.number,
+        nickname: PropTypes.string,
+        title: PropTypes.string,
+        detail: PropTypes.string,
+        created_at: PropTypes.string,
+        rating_votes: PropTypes.arrayOf(RatingVoteType),
+    }),
+);
+
+export const DescriptionType = PropTypes.shape({ html: PropTypes.string });
+
+export const StockItemType = PropTypes.shape({
+    in_stock: PropTypes.bool,
+    min_sale_qty: PropTypes.number,
+    max_sale_qty: PropTypes.number,
+    qty_increments: PropTypes.number,
+});
+
+export const OptionValueType = PropTypes.shape({
+    option_type_id: PropTypes.number,
+    price: PropTypes.number,
+    price_type: PropTypes.string,
+    sku: PropTypes.string,
+    sort_order: PropTypes.number,
+    title: PropTypes.string,
+});
+
+export const OptionsType = PropTypes.arrayOf(
+    PropTypes.shape({
+        option_id: PropTypes.number,
+        required: PropTypes.bool,
+        sort_order: PropTypes.number,
+        title: PropTypes.string,
+        values: PropTypes.arrayOf(OptionValueType),
+    }),
+);
+
+export const ValueType = PropTypes.shape({
+    uid: PropTypes.string,
+    option_type_id: PropTypes.number,
+    price: PropTypes.number,
+    priceInclTax: PropTypes.number,
+    priceExclTax: PropTypes.number,
+    price_type: PropTypes.string,
+    currency: PropTypes.string,
+    sku: PropTypes.string,
+    title: PropTypes.string,
+    sort_order: PropTypes.number,
+});
+
+export const PriceTierType = PropTypes.shape({
+    discount: PropTypes.shape({ amount_off: PropTypes.number, percent_off: PropTypes.number }),
+    final_price: PropTypes.shape({ currency: PropTypes.string, value: PropTypes.number }),
+    quantity: PropTypes.number,
+});
+
+export const CustomizableOptionShape = {
+    price: PropTypes.number,
+    priceInclTax: PropTypes.number,
+    priceExclTax: PropTypes.number,
+    price_type: PropTypes.string,
+    currency: PropTypes.string,
+    sku: PropTypes.string,
+};
+
+export const CustomizableOptionType = PropTypes.shape({
+    ...CustomizableOptionShape,
+    uid: PropTypes.string,
+    option_type_id: PropTypes.number,
+    title: PropTypes.string,
+    sort_order: PropTypes.number,
+});
+
+export const InputOptionType = PropTypes.shape({
+    ...CustomizableOptionShape,
+    max_characters: PropTypes.number,
+});
+
+export const FileOptionType = PropTypes.shape({
+    ...CustomizableOptionShape,
+    file_extension: PropTypes.string,
+});
+
+export const CustomizableOptionsType = PropTypes.oneOfType([
+    FileOptionType,
+    InputOptionType,
+    PropTypes.arrayOf(CustomizableOptionType),
+]);
+
+export const ItemShape = {
+    attributes: AttributesType,
+    configurable_options: AttributesType,
+    id: PropTypes.number,
+    image: ImageType,
+    name: PropTypes.string,
+    options: CustomizableOptionsType,
+    price_range: PriceType,
+    price_tiers: PropTypes.arrayOf(PriceTierType),
+    ...ReviewSummaryShape,
+    review_summary: PropTypes.shape(ReviewSummaryShape),
+    short_description: DescriptionType,
+    sku: PropTypes.string,
+    small_image: ImageType,
+    special_from_date: PropTypes.string,
+    special_to_date: PropTypes.string,
+    stock_item: StockItemType,
+    stock_status: StockStatusType,
+    thumbnail: ImageType,
+    type_id: PropTypes.string,
+    uid: PropTypes.string,
+    url: PropTypes.string,
+    url_rewrites: PropTypes.arrayOf(UrlRewriteType),
+};
+export const ItemType = PropTypes.shape(ItemShape);
+
+export const ItemsType = PropTypes.arrayOf(ItemType);
+
+// @ts-ignore
+ItemType.variants = ItemsType;
+
+export const PagesType = PropTypes.objectOf(ItemsType);
+
+export const QuantityType = PropTypes.oneOfType([
+    PropTypes.number,
+    PropTypes.shape({
+        // @ts-ignore
+        [PropTypes.string]: PropTypes.number,
+    }),
+]);
+
+export const ItemOptionsType = PropTypes.arrayOf(
+    PropTypes.shape({
+        can_change_quantity: PropTypes.bool,
+        id: PropTypes.number,
+        is_default: PropTypes.bool,
+        label: PropTypes.string,
+        position: PropTypes.number,
+        price: PropTypes.number,
+        price_type: PropTypes.string,
+        quantity: QuantityType,
+        uid: PropTypes.string,
+        product: PropTypes.shape({
+            name: PropTypes.string,
+            stock_status: PropTypes.string,
+            price_range: PriceType,
+        }),
+        regularOptionPrice: PropTypes.number,
+        regularOptionPriceExclTax: PropTypes.number,
+        finalOptionPrice: PropTypes.number,
+        finalOptionPriceExclTax: PropTypes.number,
+    }),
+);
+
+export const ProductItemsType = PropTypes.arrayOf(
+    PropTypes.shape({
+        option_id: PropTypes.number,
+        options: ItemOptionsType,
+        position: PropTypes.number,
+        required: PropTypes.bool,
+        sku: PropTypes.string,
+        title: PropTypes.string,
+        type: PropTypes.string,
+    }),
+);
+
+export const ProductType = PropTypes.shape({
+    canonical_url: PropTypes.string,
+    categories: CategoriesType,
+    description: DescriptionType,
+    media_gallery_entries: MediaType,
+    meta_description: PropTypes.string,
+    meta_keyword: PropTypes.string,
+    meta_title: MetaTitleType,
+    product_links: ProductLinksType,
+    special_price: PropTypes.number,
+    url_key: PropTypes.string,
+    quantity: PropTypes.number,
+    items: ProductItemsType,
+    reviews: ReviewsType,
+    ...ItemShape,
+});
+
+export const DownloadableSamplesType = PropTypes.arrayOf(
+    PropTypes.shape({
+        sample_url: PropTypes.oneOfType([ProductType, PropTypes.string]),
+        sort_order: PropTypes.number,
+        title: PropTypes.string,
+    }),
+);
+
+export const PriceConfiguration = PropTypes.shape({
+    containsOptions: PropTypes.bool,
+    containsOptionsWithPrice: PropTypes.bool,
+    containsRequiredOptions: PropTypes.bool,
+    containsRequiredOptionsWithPrice: PropTypes.bool,
+});
+
+export const MagentoProductType = PropTypes.shape({
+    entered_options: PropTypes.arrayOf(PropTypes.shape({
+        uid: PropTypes.string,
+        value: PropTypes.string,
+    })),
+    quantity: QuantityType,
+    selected_options: PropTypes.arrayOf(PropTypes.string),
+    sku: PropTypes.string,
+});
+
+export const ProductCardPropsType = PropTypes.shape({
+    siblingsHaveBrands: PropTypes.bool,
+    siblingsHavePriceBadge: PropTypes.bool,
+    siblingsHaveTierPrice: PropTypes.bool,
+    siblingsHaveConfigurableOptions: PropTypes.bool,
+});
+
+export const OptionsListType = PropTypes.arrayOf(
+    PropTypes.shape({
+        value: CustomizableOptionsType,
+        title: PropTypes.string,
+        required: PropTypes.bool,
+        sort_order: PropTypes.number,
+        type: PropTypes.string,
+        uid: PropTypes.string,
+    }),
+);
+
+export const LinkedProductsType = PropTypes.objectOf(
+    PropTypes.shape({
+        items: PropTypes.arrayOf(ProductType),
+        total_count: PropTypes.number,
+    }),
+);

package/app/types/Rating.type.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 RatingOptionItemType = PropTypes.shape({
+    option_id: PropTypes.string,
+    value: PropTypes.string,
+});
+
+export const RatingItemsType = PropTypes.arrayOf(
+    PropTypes.shape({
+        rating_id: PropTypes.string,
+        rating_code: PropTypes.string,
+        rating_options: PropTypes.arrayOf(RatingOptionItemType),
+    }),
+);
+
+export const VoteType = PropTypes.shape({
+    rating_code: PropTypes.string,
+    value: PropTypes.string,
+    percent: PropTypes.number,
+});
+
+export const ReviewItemType = PropTypes.shape({
+    average_rating: PropTypes.number,
+    nickname: PropTypes.string,
+    title: PropTypes.string,
+    detail: PropTypes.string,
+    created_at: PropTypes.string,
+    rating_votes: PropTypes.arrayOf(VoteType),
+});

package/app/types/Router.type.ts

@@ -0,0 +1,67 @@
+export type LinkType = string;
+export type LocationType = string;
+export type UrlRewriteType = string;
+// Runtime PropTypes are defined below; keep file as a module for 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';
+
+// Support for comtabilitiy
+
+export const LocationType = PropTypes.shape({
+    pathname: PropTypes.string,
+    search: PropTypes.string,
+    // eslint-disable-next-line react/forbid-prop-types
+    state: PropTypes.object,
+    hash: PropTypes.string,
+    key: PropTypes.string,
+});
+
+export const HistoryType = PropTypes.shape({
+    length: PropTypes.number,
+    action: PropTypes.string,
+    location: LocationType,
+});
+
+export const MatchType = PropTypes.shape({
+    path: PropTypes.string,
+    url: PropTypes.string,
+    // eslint-disable-next-line react/forbid-prop-types
+    params: PropTypes.object,
+    isExact: PropTypes.bool,
+});
+
+export const UrlRewriteType = PropTypes.shape({
+    id: PropTypes.number,
+    type: PropTypes.string,
+    sku: PropTypes.string,
+    notFound: PropTypes.bool,
+});
+
+export const LinkType = PropTypes.oneOfType([
+    PropTypes.string,
+    PropTypes.shape({
+        pathname: PropTypes.string,
+    }),
+]);
+
+export const NavigationStateType = PropTypes.shape(
+    {
+        name: PropTypes.string.isRequired,
+        title: PropTypes.string,
+    },
+);
+
+export const NavigationStateHistoryType = PropTypes.shape({
+    navigationStateHistory: PropTypes.arrayOf(NavigationStateType),
+    navigationState: NavigationStateType,
+});

package/app/types/Slider.type.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 SlideType = PropTypes.shape({
+    slide_id: PropTypes.string,
+    image: PropTypes.string,
+    slide_text: PropTypes.string,
+});
+
+export const SliderType = PropTypes.shape({
+    slider_id: PropTypes.string,
+    slides: PropTypes.arrayOf(SlideType),
+});

package/app/types/StockStatus.type.ts

@@ -0,0 +1,21 @@
+export type StockStatusType = string;
+// Keep runtime PropTypes implementation below; avoid duplicate TS declarations
+/**
+ * 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 { StockStatus } from 'Component/Product/Stock.config';
+
+// Support for comtabilitiy
+
+// eslint-disable-next-line import/prefer-default-export
+export const StockStatusType = PropTypes.oneOf(Object.values(StockStatus));

package/app/types/domain/index.ts

@@ -0,0 +1,94 @@
+export type Price = {
+  value: number
+  currency?: string
+}
+
+export type Image = {
+  url: string
+  alt?: string
+  width?: number
+  height?: number
+}
+
+export interface Product {
+  id: string
+  sku?: string
+  title: string
+  description?: string
+  price: number | Price
+  images?: Image[]
+  variants?: any[]
+  attributes?: Record<string, any>
+  [key: string]: any
+}
+
+export interface CartItem {
+  id: string
+  sku?: string
+  quantity: number
+  product?: Product
+  [key: string]: any
+}
+
+export interface Cart {
+  id: string
+  email?: string
+  items: CartItem[]
+  total_quantity?: number
+  prices?: Record<string, any>
+  raw?: any
+}
+
+export interface Order {
+  id: string
+  number?: string
+  items?: CartItem[]
+  total?: Price | number
+  status?: string
+  created_at?: string
+  raw?: any
+}
+
+export interface Customer {
+  id: string
+  email?: string
+  firstName?: string
+  lastName?: string
+  [key: string]: any
+}
+
+export interface GiftCard {
+  code: string
+  balance?: Price | number
+  currency?: string
+  raw?: any
+}
+
+export interface Subscription {
+  id: string
+  productId?: string
+  status?: string
+  schedule?: any
+  raw?: any
+}
+
+export interface PaymentIntent {
+  id: string
+  status?: string
+  amount?: Price | number
+  currency?: string
+  method?: string
+  raw?: any
+}
+
+export interface Review {
+  id: string
+  title?: string
+  detail?: string
+  rating?: number
+  created_at?: string
+  author?: string
+  raw?: any
+}
+
+ 

package/app/types/index.ts

@@ -0,0 +1,33 @@
+// Minimal JSX namespace for legacy React/JSX type references used in the
+// commerce layer's migrated code. Kept permissive to avoid introducing
+// runtime changes; this only provides compile-time types.
+declare global {
+  namespace JSX {
+    interface Element {}
+    interface IntrinsicElements { [elemName: string]: any }
+  }
+}
+
+import { sdk } from '@mframework/sdk'
+
+export function createClient(provider?: string, config?: any) {
+  // Prefer provider-specific client creation if available on the SDK.
+  // Fall back to the SDK's commerce client.
+  try {
+    // some adapters expose a createClient/init API — delegate when present
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const anySdk: any = sdk
+    if (typeof anySdk.createClient === 'function') return anySdk.createClient(provider, config)
+    if (typeof anySdk.init === 'function') return anySdk.init(config)
+  } catch (e) {
+    // swallow and fallback
+  }
+
+  return sdk.commerce
+}
+
+export function init(config?: any) {
+  return createClient(undefined, config)
+}
+
+export default { createClient, init }

package/app/types/shims.d.ts

@@ -0,0 +1,52 @@
+declare module 'prop-types' {
+  const PropTypes: any;
+  export default PropTypes;
+}
+
+declare module 'Component/*' {
+  export type ProductType = any;
+  export const ProductType: any;
+  export type FieldType = any;
+  export const FieldType: any;
+  export type StockStatus = any;
+  export const StockStatus: any;
+  export type ImageType = any;
+  export const ImageType: any;
+  export const REVIEW_POPUP_ID: any;
+  export const NONE_RADIO_OPTION: any;
+  export const DATE_FIELDS_COUNT: any;
+  export type FieldDateType = any;
+  export const FieldDateType: any;
+  export const TimeFormat: any;
+  export type FormFields = any;
+  export const FormFields: any;
+  export type DateFieldAttr = any;
+  export const DateFieldAttr: any;
+  export const HourFormat: any;
+  export type Directions = any;
+  export const Directions: any;
+  const whatever: any;
+  export default whatever;
+}
+
+declare module 'Component/*/*' {
+  const whatever: any;
+  export = whatever;
+}
+
+declare module 'Component/*/*/*' {
+  const whatever: any;
+  export = whatever;
+}
+
+declare module 'Component/Product/Product.config' {
+  export const ProductType: any;
+  const cfg: any;
+  export default cfg;
+}
+
+declare module 'Component/Field/Field.config' {
+  export const FieldType: any;
+  const cfg: any;
+  export default cfg;
+}