@mframework/layer-commerce 0.0.3

package/README.md

@@ -0,0 +1,101 @@
+# @mframework/commerce
+
+A backend‑agnostic commerce domain module for the Meeovi ecosystem.  
+This package provides a unified interface for products, categories, carts, and other commerce operations — regardless of the underlying backend (Directus, Medusa, Shopify, custom APIs, etc.).
+
+## ✨ Features
+
+- Pluggable provider architecture  
+- Unified composables (`useProducts`, `useCart`, `useCategories`)  
+- Backend‑agnostic types  
+- Runtime configuration  
+- Zero Nuxt dependency  
+- Works in any JS/TS environment  
+
+## 📦 Installation
+
+```sh
+npm install @mframework/commerce
+
+⚙️ Configuration
+Configure the active providers at runtime:
+
+
+import { setCommerceConfig } from '@mframework/commerce'
+
+setCommerceConfig({
+  productProvider: 'directus',
+  cartProvider: 'directus',
+  categoryProvider: 'directus'
+})
+
+🧩 Usage
+
+import { useProducts } from '@mframework/commerce'
+
+const { listProducts, getProduct } = useProducts()
+
+const products = await listProducts()
+const product = await getProduct('123')
+🔌 Providers
+A provider implements one or more domain interfaces:
+
+
+export interface ProductProvider {
+  getProduct(id: string): Promise<Product>
+  listProducts(params?: any): Promise<Product[]>
+}
+Register a provider:
+
+
+import { registerProductProvider } from '@mframework/commerce'
+
+registerProductProvider('directus', {
+  getProduct: async (id) => { ... },
+  listProducts: async () => { ... }
+})
+
+### Registering domain providers from an adapter
+
+Adapter packages can register domain-specific implementations at runtime. Import the runtime helpers from the layer package and call them from your adapter plugin entry:
+
+```ts
+import {
+  registerProductProvider,
+  registerEventProviderRuntime,
+  registerGiftCardProviderRuntime,
+  registerSubscriptionProviderRuntime
+} from '@mframework/commerce'
+
+registerProductProvider('my-adapter', {
+  getProduct: async (id) => { /* ... */ },
+  listProducts: async (params) => { /* ... */ }
+})
+
+registerEventProviderRuntime('my-adapter', {
+  getEvent: async (id) => { /* ... */ },
+  listEvents: async () => { /* ... */ }
+})
+
+registerGiftCardProviderRuntime('my-adapter', {
+  getGiftCard: async (id) => { /* ... */ },
+  listGiftCards: async () => { /* ... */ },
+  redeemGiftCard: async (code) => ({ success: true })
+})
+
+registerSubscriptionProviderRuntime('my-adapter', {
+  getSubscription: async (id) => { /* ... */ },
+  listSubscriptions: async () => { /* ... */ },
+  subscribe: async (payload) => ({ success: true })
+})
+```
+
+🧱 Folder Structure
+Code
+src/
+  products/
+  cart/
+  categories/
+  config.
+  registry.
+  useCommerce.

package/app/cart/useCart.ts

@@ -0,0 +1 @@
+export * from '../composables/cart/useCart'

package/app/components/ChevronIcon/ChevronIcon.config.ts

@@ -0,0 +1,17 @@
+export const Directions = {
+  UP: 'up',
+  DOWN: 'down',
+  LEFT: 'left',
+  RIGHT: 'right',
+  TOP: 'top',
+  BOTTOM: 'bottom',
+} as const
+
+export type ChevronDirection = typeof Directions[keyof typeof Directions]
+
+export const ChevronDefaults = {
+  size: 16,
+  direction: Directions.LEFT as ChevronDirection,
+}
+
+export default ChevronDefaults

package/app/components/DateSelect/DateSelect.config.ts

@@ -0,0 +1,15 @@
+export const DateFieldAttr = {
+  TYPE: 'data-type',
+  NAME: 'data-name',
+} as const
+
+export type DateFieldAttrType = typeof DateFieldAttr
+
+export enum HourFormat {
+  H12 = 12,
+  H24 = 24,
+}
+
+export const DEFAULT_DATE_ATTRS = { format: 'YYYY-MM-DD' }
+
+export default DEFAULT_DATE_ATTRS

package/app/components/Field/Field.config.ts

@@ -0,0 +1,14 @@
+export enum FieldType {
+  TEXT = 'text',
+  TEXTAREA = 'textarea',
+  SELECT = 'select',
+  RADIO = 'radio',
+  CHECKBOX = 'checkbox',
+  DATE = 'date',
+  FILE = 'file',
+  BUTTON = 'button',
+}
+
+export const DEFAULT_FIELD = FieldType.TEXT
+
+export default DEFAULT_FIELD

package/app/components/FieldDate/FieldDate.config.ts

@@ -0,0 +1,16 @@
+export enum FieldDateType {
+	DATE = 'date',
+	DATETIME = 'datetime',
+	TIME = 'time',
+}
+
+export const DATE_FIELDS_COUNT = 3
+
+export enum TimeFormat {
+	H12 = '12',
+	H24 = '24',
+}
+
+export const FIELD_DATE_DEFAULT = FieldDateType.DATE
+
+export default FIELD_DATE_DEFAULT

package/app/components/Form/Form.type.ts

@@ -0,0 +1,8 @@
+export type FormFields = Record<string, any>
+
+export interface FormValidationResult {
+  valid: boolean
+  errors?: Record<string, string[]>
+}
+
+export default FormFields

package/app/components/Product/Product.config.ts

@@ -0,0 +1,19 @@
+export enum ProductType {
+  SIMPLE = 'simple',
+  CONFIGURABLE = 'configurable',
+  VIRTUAL = 'virtual',
+  BUNDLE = 'bundle',
+  GROUPED = 'grouped',
+  DOWNLOADABLE = 'downloadable',
+}
+
+export const ProductTypes = [
+  ProductType.SIMPLE,
+  ProductType.CONFIGURABLE,
+  ProductType.VIRTUAL,
+  ProductType.BUNDLE,
+  ProductType.GROUPED,
+  ProductType.DOWNLOADABLE,
+]
+
+export default ProductTypes

package/app/components/Product/Stock.config.ts

@@ -0,0 +1,15 @@
+export enum StockStatus {
+  IN_STOCK = 'in_stock',
+  OUT_OF_STOCK = 'out_of_stock',
+  BACKORDER = 'backorder',
+}
+
+export type StockStatusType = StockStatus
+
+export const StockStatusDefaults = {
+  [StockStatus.IN_STOCK]: 'In stock',
+  [StockStatus.OUT_OF_STOCK]: 'Out of stock',
+  [StockStatus.BACKORDER]: 'Backorder',
+}
+
+export default StockStatus

package/app/components/ProductCustomizableOption/ProductCustomizableOption.config.ts

@@ -0,0 +1,5 @@
+export const NONE_RADIO_OPTION = 'none'
+
+export default {
+  NONE_RADIO_OPTION,
+}

package/app/components/ProductGallery/ProductGallery.config.ts

@@ -0,0 +1,15 @@
+export enum ImageType {
+  THUMBNAIL = 'thumbnail',
+  SMALL = 'small',
+  IMAGE = 'image',
+}
+
+export interface ImageDescriptor {
+  src: string
+  alt?: string
+  label?: string
+}
+
+export const ImageDefaults: Partial<ImageDescriptor> = {}
+
+export default ImageDefaults

package/app/components/ProductReviews/ProductReviews.config.ts

@@ -0,0 +1,8 @@
+export const REVIEW_POPUP_ID = 'review_popup'
+
+export const DEFAULT_REVIEW_LIMIT = 10
+
+export default {
+  REVIEW_POPUP_ID,
+  DEFAULT_REVIEW_LIMIT,
+}

package/app/composables/_types.ts

@@ -0,0 +1,18 @@
+export type Maybe<T> = T | null | undefined;
+
+// Re-export or alias common legacy names expected by the composables
+// Fallback permissive types for isolated builds
+export type SfProduct = any;
+export type Product = any;
+export type SfCart = any;
+export type Cart = any;
+
+// No direct equivalents in @mframework/commerce yet — use permissive any types
+export type SfCustomer = any;
+export type SfAddress = any;
+export type SfProductReview = any;
+export type SfShippingMethods = any;
+export type SfAttribute = any;
+
+// Export additional useful types from the commerce package if needed
+export type Category = any;

package/app/composables/adapters/abstract/productAdapter.ts

@@ -0,0 +1,7 @@
+import { Product } from "../../domain/product"
+
+export interface ProductAdapter {
+  list(): Promise<Product[]>
+  get(id: string): Promise<Product | null>
+  search(query: string): Promise<Product[]>
+}

package/app/composables/cart/registry.ts

@@ -0,0 +1,20 @@
+import { CartProvider } from "./types"
+
+const providers: Record<string, CartProvider> = {}
+
+export function registerCartProvider(name: string, provider: CartProvider) {
+  providers[name] = provider
+}
+
+export function getCartProvider(name: string) {
+  const provider = providers[name]
+  if (!provider) throw new Error(`Cart provider "${name}" not found`)
+  return provider
+}
+
+// Runtime helper for adapter packages to register themselves when the
+// app boots. Adapter packages can import this and call it from their
+// plugin entry to wire into the commerce cart provider registry.
+export function registerCartProviderRuntime(name: string, provider: CartProvider) {
+  registerCartProvider(name, provider)
+}

package/app/composables/cart/types.ts

@@ -0,0 +1,18 @@
+export interface CartItem {
+  id: string
+  quantity: number
+  product: any
+}
+
+export interface Cart {
+  id: string
+  items: CartItem[]
+  total: number
+}
+
+export interface CartProvider {
+  getCart(): Promise<Cart>
+  addItem(productId: string, quantity?: number): Promise<Cart>
+  removeItem(productId: string): Promise<Cart>
+  clearCart(): Promise<Cart>
+}

package/app/composables/cart/useCart.ts

@@ -0,0 +1,15 @@
+import { getCartProvider } from './registry'
+import useRuntimeConfig from '~/types'
+
+export function useCart() {
+  const _cfg: any = (typeof (useRuntimeConfig as any) === 'function') ? (useRuntimeConfig as any)() : (useRuntimeConfig || { public: {} })
+  const providerName = (_cfg && _cfg.public && _cfg.public.cartProvider) ? _cfg.public.cartProvider : 'directus'
+  const provider = getCartProvider(providerName)
+
+  return {
+    getCart: provider.getCart,
+    addItem: provider.addItem,
+    removeItem: provider.removeItem,
+    clearCart: provider.clearCart
+  }
+}

package/app/composables/config.ts

@@ -0,0 +1,19 @@
+export interface CommerceConfig {
+  productProvider: string
+  cartProvider: string
+  categoryProvider: string
+}
+
+let config: CommerceConfig = {
+  productProvider: 'directus',
+  cartProvider: 'directus',
+  categoryProvider: 'directus'
+}
+
+export function setCommerceConfig(newConfig: Partial<CommerceConfig>) {
+  config = { ...config, ...newConfig }
+}
+
+export function getCommerceConfig() {
+  return config
+}

package/app/composables/defs/apiDefinitions.ts

@@ -0,0 +1,55 @@
+import type { DefineAddCustomFields, NormalizersConstraint } from "./types";
+import type { UnifiedMethods } from "../methods";
+
+export type DefineApi<TContext = Record<string, unknown>> = {
+  [TKey in keyof UnifiedMethods]: (
+    fn: (
+      context: TContext,
+      ...args: Parameters<UnifiedMethods[TKey]>
+    ) => ReturnType<UnifiedMethods[TKey]>,
+  ) => (
+    context: TContext,
+    ...args: Parameters<UnifiedMethods[TKey]>
+  ) => ReturnType<UnifiedMethods[TKey]>;
+};
+
+export function getApiDefinitions<TContext = Record<string, unknown>>(): DefineApi<TContext> {
+  return {
+    getCategories: (fn) => fn,
+    getCategory: (fn) => fn,
+    getCart: (fn) => fn,
+    addCartLineItem: (fn) => fn,
+    updateCartLineItem: (fn) => fn,
+    removeCartLineItem: (fn) => fn,
+    applyCouponToCart: (fn) => fn,
+    removeCouponFromCart: (fn) => fn,
+    setCustomerEmail: (fn) => fn,
+    setCartAddress: (fn) => fn,
+    getAvailableShippingMethods: (fn) => fn,
+    setShippingMethod: (fn) => fn,
+    registerCustomer: (fn) => fn,
+    loginCustomer: (fn) => fn,
+    getCustomer: (fn) => fn,
+    logoutCustomer: (fn) => fn,
+    updateCustomer: (fn) => fn,
+    changeCustomerPassword: (fn) => fn,
+    searchProducts: (fn) => fn,
+    getProducts: (fn) => fn,
+    getProductDetails: (fn) => fn,
+    getProductReviews: (fn) => fn,
+    createCustomerAddress: (fn) => fn,
+    getCustomerAddresses: (fn) => fn,
+    updateCustomerAddress: (fn) => fn,
+    deleteCustomerAddress: (fn) => fn,
+    getCurrencies: (fn) => fn,
+    getOrders: (fn) => fn,
+    getOrderDetails: (fn) => fn,
+    placeOrder: (fn) => fn,
+  };
+}
+
+export function defineAddCustomFieldsFactory<TNormalizers extends NormalizersConstraint>() {
+  return <TInput extends DefineAddCustomFields<TNormalizers>>(input: TInput) => {
+    return input;
+  };
+}

package/app/composables/defs/extension.feature

@@ -0,0 +1,40 @@
+Feature: Unified Extension
+
+  Scenario: Overriding normalizer
+    Given one of the normalizers is overridden
+    When extension is created
+    And the normalizer is called
+    Then the overridden normalizer should be called
+    And remaining normalizers should be unchanged
+
+  Scenario: Add custom fields array with a single element
+    Given a custom field is added to one of the normalizers
+    When extension is created
+    And the normalizer is called
+    Then the custom field should be present in the $custom object
+    And remaining normalizers should be unchanged
+
+  Scenario: Add custom fields array with multiple elements
+    Given multiple elements of the addCustomFields array override the same normalizer
+    When extension is created
+    And the normalizer is called
+    Then all custom fields should be present in the $custom object
+
+  Scenario: Nested custom fields
+    Given multiple elements of the addCustomFields array override the same normalizer
+    And custom fields are objects
+    When extension is created
+    And the normalizer is called
+    Then objects should be merged into the $custom object
+
+  Scenario: Adding the same custom fields more than once
+    Given multiple elements of the addCustomFields array add the same custom field
+    When extension is created
+    And the normalizer is called
+    Then the custom field should have value based on the last element of the addCustomFields array
+
+  Scenario: Overriding api method
+    Given one of the api methods is overridden
+    When extension is created
+    And the api method is called
+    Then the overridden api method should be called

package/app/composables/defs/extension.mocks.ts

@@ -0,0 +1,39 @@
+interface RawMoney {
+  amount: number;
+  formattedAmount: string;
+  decimalPlaces: number;
+}
+
+interface RawProduct {
+  id: string;
+  name: string;
+}
+
+type NormalizerContext = any;
+
+export const normalizers = {
+  normalizeMoney: (rawMoney: RawMoney, ctx: NormalizerContext) => ({
+    amount: rawMoney.amount,
+    currency: ctx.currency,
+  }),
+  normalizeProductCatalogItem: (rawProduct: RawProduct) => ({
+    id: rawProduct.id,
+    name: rawProduct.name,
+  }),
+};
+
+export const rawMoneyMock: RawMoney = {
+  amount: 10,
+  formattedAmount: "10.00",
+  decimalPlaces: 2,
+};
+
+export const methods = {
+  getSuccess() {
+    return Promise.resolve({ ok: true });
+  },
+};
+
+export const getAdditionalNormalizerContext = () => ({
+  sku: "123",
+});