@atomic-solutions/woocommerce-react 0.1.0

package/dist/types-wgwJGLQ-.d.cts

@@ -0,0 +1,187 @@
+import { Cart, WooCommerceApiError, CartItem, Checkout, StoreApiOrder, ProductParams } from '@atomic-solutions/woocommerce-utils';
+
+type WooCommerceEventType = 'cart:item_added' | 'cart:item_removed' | 'cart:item_updated' | 'cart:coupon_applied' | 'cart:coupon_removed' | 'cart:customer_updated' | 'cart:shipping_selected' | 'checkout:processed' | 'order:fetched';
+interface BaseSuccessEvent<T extends WooCommerceEventType, D> {
+    type: T;
+    status: 'success';
+    data: D;
+}
+interface BaseErrorEvent<T extends WooCommerceEventType> {
+    type: T;
+    status: 'error';
+    error: WooCommerceApiError;
+}
+type CartItemAddedEvent = BaseSuccessEvent<'cart:item_added', {
+    item: CartItem;
+    cart: Cart;
+}> | BaseErrorEvent<'cart:item_added'>;
+type CartItemRemovedEvent = BaseSuccessEvent<'cart:item_removed', {
+    itemKey: string;
+    cart: Cart;
+}> | BaseErrorEvent<'cart:item_removed'>;
+type CartItemUpdatedEvent = BaseSuccessEvent<'cart:item_updated', {
+    item: CartItem;
+    cart: Cart;
+}> | BaseErrorEvent<'cart:item_updated'>;
+type CartCouponAppliedEvent = BaseSuccessEvent<'cart:coupon_applied', {
+    code: string;
+    cart: Cart;
+}> | BaseErrorEvent<'cart:coupon_applied'>;
+type CartCouponRemovedEvent = BaseSuccessEvent<'cart:coupon_removed', {
+    code: string;
+    cart: Cart;
+}> | BaseErrorEvent<'cart:coupon_removed'>;
+type CartCustomerUpdatedEvent = BaseSuccessEvent<'cart:customer_updated', {
+    cart: Cart;
+}> | BaseErrorEvent<'cart:customer_updated'>;
+type CartShippingSelectedEvent = BaseSuccessEvent<'cart:shipping_selected', {
+    cart: Cart;
+}> | BaseErrorEvent<'cart:shipping_selected'>;
+type CheckoutProcessedEvent = BaseSuccessEvent<'checkout:processed', {
+    checkout: Checkout;
+}> | BaseErrorEvent<'checkout:processed'>;
+type OrderFetchedEvent = BaseSuccessEvent<'order:fetched', {
+    order: StoreApiOrder;
+}> | BaseErrorEvent<'order:fetched'>;
+type WooCommerceEvent = CartItemAddedEvent | CartItemRemovedEvent | CartItemUpdatedEvent | CartCouponAppliedEvent | CartCouponRemovedEvent | CartCustomerUpdatedEvent | CartShippingSelectedEvent | CheckoutProcessedEvent | OrderFetchedEvent;
+type WooCommerceEventHandler = (event: WooCommerceEvent) => void;
+
+declare const createQueryKeys: (prefix?: string[]) => {
+    all: readonly string[];
+    products: {
+        all: readonly [...string[], "products"];
+        lists: () => readonly [...string[], "products", "list"];
+        list: (params?: ProductParams) => readonly [...string[], "products", "list", {
+            page: number;
+            per_page: number;
+            type?: "simple" | "grouped" | "external" | "variable" | "variation" | undefined;
+            status?: "pending" | "any" | "draft" | "private" | "publish" | undefined;
+            search?: string | undefined;
+            exclude?: number[] | undefined;
+            include?: number[] | undefined;
+            slug?: string | undefined;
+            rating?: number[] | undefined;
+            order?: "asc" | "desc" | undefined;
+            orderby?: "include" | "date" | "id" | "title" | "slug" | "popularity" | "rating" | "menu_order" | "price" | "date_modified" | undefined;
+            featured?: boolean | undefined;
+            category?: string | undefined;
+            tag?: string | undefined;
+            stock_status?: ("instock" | "outofstock" | "onbackorder")[] | undefined;
+            on_sale?: boolean | undefined;
+            min_price?: string | undefined;
+            max_price?: string | undefined;
+            after?: string | undefined;
+            before?: string | undefined;
+            modified_after?: string | undefined;
+            modified_before?: string | undefined;
+            catalog_visibility?: "search" | "any" | "visible" | "catalog" | "hidden" | undefined;
+            attributes?: {
+                attribute: string;
+                slug?: string[] | undefined;
+                term_id?: number[] | undefined;
+                operator?: "in" | "not_in" | "and" | undefined;
+            }[] | undefined;
+            parent?: number[] | undefined;
+            parent_exclude?: number[] | undefined;
+            category_operator?: "in" | "not_in" | "and" | undefined;
+            tag_operator?: "in" | "not_in" | "and" | undefined;
+            attribute_relation?: "in" | "and" | undefined;
+        } | undefined];
+        details: () => readonly [...string[], "products", "detail"];
+        detail: (id: number) => readonly [...string[], "products", "detail", number];
+        categories: () => readonly [...string[], "products", "categories"];
+    };
+    cart: {
+        all: readonly [...string[], "cart"];
+        details: () => readonly [...string[], "cart", "details"];
+        mutations: {
+            addItem: () => readonly [...string[], "cart", "mutation", "addItem"];
+            updateItem: () => readonly [...string[], "cart", "mutation", "updateItem"];
+            removeItem: () => readonly [...string[], "cart", "mutation", "removeItem"];
+            applyCoupon: () => readonly [...string[], "cart", "mutation", "applyCoupon"];
+            removeCoupon: () => readonly [...string[], "cart", "mutation", "removeCoupon"];
+            updateCustomer: () => readonly [...string[], "cart", "mutation", "updateCustomer"];
+            selectShippingRate: () => readonly [...string[], "cart", "mutation", "selectShippingRate"];
+        };
+    };
+    checkout: {
+        all: readonly [...string[], "checkout"];
+        details: () => readonly [...string[], "checkout", "details"];
+        mutations: {
+            process: () => readonly [...string[], "checkout", "mutation", "process"];
+        };
+    };
+    orders: {
+        all: readonly [...string[], "orders"];
+        lists: () => readonly [...string[], "orders", "list"];
+        list: (params?: Record<string, unknown>) => readonly [...string[], "orders", "list", Record<string, unknown> | undefined];
+        details: () => readonly [...string[], "orders", "detail"];
+        detail: (id: number, billing_email?: string, key?: string) => readonly (string | number)[];
+    };
+};
+type QueryKeys = ReturnType<typeof createQueryKeys>;
+
+interface StoreFeatures {
+    auth?: boolean;
+    wishlist?: boolean;
+    reviews?: boolean;
+    search?: boolean;
+    categories?: boolean;
+}
+interface StoreTheme {
+    primary?: string;
+    secondary?: string;
+    mode?: 'light' | 'dark' | 'auto';
+    fonts?: {
+        heading?: string;
+        body?: string;
+    };
+}
+interface StoreLocale {
+    localeTag?: string;
+    currency?: string;
+    currencyPosition?: 'before' | 'after';
+    thousandsSeparator?: string;
+    decimalSeparator?: string;
+    decimals?: number;
+}
+type ImageUrlTransformer = (url: string, size: 'thumbnail' | 'medium' | 'large' | 'full') => string;
+interface RateLimitConfig {
+    requestsPerMinute?: number;
+    requestsPerSecond?: number;
+    burstLimit?: number;
+}
+interface StoreGuardrails {
+    validateStore?: boolean;
+    rateLimit?: RateLimitConfig;
+    licenseKey?: string;
+}
+interface StoreValidationResult {
+    valid: boolean;
+    storeName?: string;
+    storeUrl?: string;
+    wcVersion?: string;
+    error?: string;
+}
+interface StoreConfig {
+    storeUrl: string;
+    features?: StoreFeatures;
+    theme?: StoreTheme;
+    locale?: StoreLocale;
+    guardrails?: StoreGuardrails;
+    onEvent?: WooCommerceEventHandler;
+    debug?: boolean;
+    imageUrlTransformer?: ImageUrlTransformer;
+    fallbackImageUrl?: string;
+}
+interface StoreContextValue {
+    config: StoreConfig;
+    isValidated: boolean;
+    isValidating: boolean;
+    validationError?: string;
+    validationResult?: StoreValidationResult;
+    revalidate: () => Promise<void>;
+}
+declare const DEFAULT_STORE_CONFIG: Required<Pick<StoreConfig, 'features' | 'locale' | 'guardrails' | 'debug'>>;
+
+export { type CartCouponAppliedEvent as C, DEFAULT_STORE_CONFIG as D, type ImageUrlTransformer as I, type OrderFetchedEvent as O, type QueryKeys as Q, type RateLimitConfig as R, type StoreLocale as S, type WooCommerceEventHandler as W, type StoreValidationResult as a, type CartCouponRemovedEvent as b, type CartCustomerUpdatedEvent as c, type CartItemAddedEvent as d, type CartItemRemovedEvent as e, type CartItemUpdatedEvent as f, type CartShippingSelectedEvent as g, type CheckoutProcessedEvent as h, type StoreConfig as i, type StoreContextValue as j, type StoreFeatures as k, type StoreGuardrails as l, type StoreTheme as m, type WooCommerceEvent as n, type WooCommerceEventType as o, createQueryKeys as p };

package/dist/types-wgwJGLQ-.d.ts

@@ -0,0 +1,187 @@
+import { Cart, WooCommerceApiError, CartItem, Checkout, StoreApiOrder, ProductParams } from '@atomic-solutions/woocommerce-utils';
+
+type WooCommerceEventType = 'cart:item_added' | 'cart:item_removed' | 'cart:item_updated' | 'cart:coupon_applied' | 'cart:coupon_removed' | 'cart:customer_updated' | 'cart:shipping_selected' | 'checkout:processed' | 'order:fetched';
+interface BaseSuccessEvent<T extends WooCommerceEventType, D> {
+    type: T;
+    status: 'success';
+    data: D;
+}
+interface BaseErrorEvent<T extends WooCommerceEventType> {
+    type: T;
+    status: 'error';
+    error: WooCommerceApiError;
+}
+type CartItemAddedEvent = BaseSuccessEvent<'cart:item_added', {
+    item: CartItem;
+    cart: Cart;
+}> | BaseErrorEvent<'cart:item_added'>;
+type CartItemRemovedEvent = BaseSuccessEvent<'cart:item_removed', {
+    itemKey: string;
+    cart: Cart;
+}> | BaseErrorEvent<'cart:item_removed'>;
+type CartItemUpdatedEvent = BaseSuccessEvent<'cart:item_updated', {
+    item: CartItem;
+    cart: Cart;
+}> | BaseErrorEvent<'cart:item_updated'>;
+type CartCouponAppliedEvent = BaseSuccessEvent<'cart:coupon_applied', {
+    code: string;
+    cart: Cart;
+}> | BaseErrorEvent<'cart:coupon_applied'>;
+type CartCouponRemovedEvent = BaseSuccessEvent<'cart:coupon_removed', {
+    code: string;
+    cart: Cart;
+}> | BaseErrorEvent<'cart:coupon_removed'>;
+type CartCustomerUpdatedEvent = BaseSuccessEvent<'cart:customer_updated', {
+    cart: Cart;
+}> | BaseErrorEvent<'cart:customer_updated'>;
+type CartShippingSelectedEvent = BaseSuccessEvent<'cart:shipping_selected', {
+    cart: Cart;
+}> | BaseErrorEvent<'cart:shipping_selected'>;
+type CheckoutProcessedEvent = BaseSuccessEvent<'checkout:processed', {
+    checkout: Checkout;
+}> | BaseErrorEvent<'checkout:processed'>;
+type OrderFetchedEvent = BaseSuccessEvent<'order:fetched', {
+    order: StoreApiOrder;
+}> | BaseErrorEvent<'order:fetched'>;
+type WooCommerceEvent = CartItemAddedEvent | CartItemRemovedEvent | CartItemUpdatedEvent | CartCouponAppliedEvent | CartCouponRemovedEvent | CartCustomerUpdatedEvent | CartShippingSelectedEvent | CheckoutProcessedEvent | OrderFetchedEvent;
+type WooCommerceEventHandler = (event: WooCommerceEvent) => void;
+
+declare const createQueryKeys: (prefix?: string[]) => {
+    all: readonly string[];
+    products: {
+        all: readonly [...string[], "products"];
+        lists: () => readonly [...string[], "products", "list"];
+        list: (params?: ProductParams) => readonly [...string[], "products", "list", {
+            page: number;
+            per_page: number;
+            type?: "simple" | "grouped" | "external" | "variable" | "variation" | undefined;
+            status?: "pending" | "any" | "draft" | "private" | "publish" | undefined;
+            search?: string | undefined;
+            exclude?: number[] | undefined;
+            include?: number[] | undefined;
+            slug?: string | undefined;
+            rating?: number[] | undefined;
+            order?: "asc" | "desc" | undefined;
+            orderby?: "include" | "date" | "id" | "title" | "slug" | "popularity" | "rating" | "menu_order" | "price" | "date_modified" | undefined;
+            featured?: boolean | undefined;
+            category?: string | undefined;
+            tag?: string | undefined;
+            stock_status?: ("instock" | "outofstock" | "onbackorder")[] | undefined;
+            on_sale?: boolean | undefined;
+            min_price?: string | undefined;
+            max_price?: string | undefined;
+            after?: string | undefined;
+            before?: string | undefined;
+            modified_after?: string | undefined;
+            modified_before?: string | undefined;
+            catalog_visibility?: "search" | "any" | "visible" | "catalog" | "hidden" | undefined;
+            attributes?: {
+                attribute: string;
+                slug?: string[] | undefined;
+                term_id?: number[] | undefined;
+                operator?: "in" | "not_in" | "and" | undefined;
+            }[] | undefined;
+            parent?: number[] | undefined;
+            parent_exclude?: number[] | undefined;
+            category_operator?: "in" | "not_in" | "and" | undefined;
+            tag_operator?: "in" | "not_in" | "and" | undefined;
+            attribute_relation?: "in" | "and" | undefined;
+        } | undefined];
+        details: () => readonly [...string[], "products", "detail"];
+        detail: (id: number) => readonly [...string[], "products", "detail", number];
+        categories: () => readonly [...string[], "products", "categories"];
+    };
+    cart: {
+        all: readonly [...string[], "cart"];
+        details: () => readonly [...string[], "cart", "details"];
+        mutations: {
+            addItem: () => readonly [...string[], "cart", "mutation", "addItem"];
+            updateItem: () => readonly [...string[], "cart", "mutation", "updateItem"];
+            removeItem: () => readonly [...string[], "cart", "mutation", "removeItem"];
+            applyCoupon: () => readonly [...string[], "cart", "mutation", "applyCoupon"];
+            removeCoupon: () => readonly [...string[], "cart", "mutation", "removeCoupon"];
+            updateCustomer: () => readonly [...string[], "cart", "mutation", "updateCustomer"];
+            selectShippingRate: () => readonly [...string[], "cart", "mutation", "selectShippingRate"];
+        };
+    };
+    checkout: {
+        all: readonly [...string[], "checkout"];
+        details: () => readonly [...string[], "checkout", "details"];
+        mutations: {
+            process: () => readonly [...string[], "checkout", "mutation", "process"];
+        };
+    };
+    orders: {
+        all: readonly [...string[], "orders"];
+        lists: () => readonly [...string[], "orders", "list"];
+        list: (params?: Record<string, unknown>) => readonly [...string[], "orders", "list", Record<string, unknown> | undefined];
+        details: () => readonly [...string[], "orders", "detail"];
+        detail: (id: number, billing_email?: string, key?: string) => readonly (string | number)[];
+    };
+};
+type QueryKeys = ReturnType<typeof createQueryKeys>;
+
+interface StoreFeatures {
+    auth?: boolean;
+    wishlist?: boolean;
+    reviews?: boolean;
+    search?: boolean;
+    categories?: boolean;
+}
+interface StoreTheme {
+    primary?: string;
+    secondary?: string;
+    mode?: 'light' | 'dark' | 'auto';
+    fonts?: {
+        heading?: string;
+        body?: string;
+    };
+}
+interface StoreLocale {
+    localeTag?: string;
+    currency?: string;
+    currencyPosition?: 'before' | 'after';
+    thousandsSeparator?: string;
+    decimalSeparator?: string;
+    decimals?: number;
+}
+type ImageUrlTransformer = (url: string, size: 'thumbnail' | 'medium' | 'large' | 'full') => string;
+interface RateLimitConfig {
+    requestsPerMinute?: number;
+    requestsPerSecond?: number;
+    burstLimit?: number;
+}
+interface StoreGuardrails {
+    validateStore?: boolean;
+    rateLimit?: RateLimitConfig;
+    licenseKey?: string;
+}
+interface StoreValidationResult {
+    valid: boolean;
+    storeName?: string;
+    storeUrl?: string;
+    wcVersion?: string;
+    error?: string;
+}
+interface StoreConfig {
+    storeUrl: string;
+    features?: StoreFeatures;
+    theme?: StoreTheme;
+    locale?: StoreLocale;
+    guardrails?: StoreGuardrails;
+    onEvent?: WooCommerceEventHandler;
+    debug?: boolean;
+    imageUrlTransformer?: ImageUrlTransformer;
+    fallbackImageUrl?: string;
+}
+interface StoreContextValue {
+    config: StoreConfig;
+    isValidated: boolean;
+    isValidating: boolean;
+    validationError?: string;
+    validationResult?: StoreValidationResult;
+    revalidate: () => Promise<void>;
+}
+declare const DEFAULT_STORE_CONFIG: Required<Pick<StoreConfig, 'features' | 'locale' | 'guardrails' | 'debug'>>;
+
+export { type CartCouponAppliedEvent as C, DEFAULT_STORE_CONFIG as D, type ImageUrlTransformer as I, type OrderFetchedEvent as O, type QueryKeys as Q, type RateLimitConfig as R, type StoreLocale as S, type WooCommerceEventHandler as W, type StoreValidationResult as a, type CartCouponRemovedEvent as b, type CartCustomerUpdatedEvent as c, type CartItemAddedEvent as d, type CartItemRemovedEvent as e, type CartItemUpdatedEvent as f, type CartShippingSelectedEvent as g, type CheckoutProcessedEvent as h, type StoreConfig as i, type StoreContextValue as j, type StoreFeatures as k, type StoreGuardrails as l, type StoreTheme as m, type WooCommerceEvent as n, type WooCommerceEventType as o, createQueryKeys as p };

package/package.json

@@ -0,0 +1,93 @@
+{
+  "name": "@atomic-solutions/woocommerce-react",
+  "version": "0.1.0",
+  "description": "React Query hooks and provider for WooCommerce Store API",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./hooks": {
+      "types": "./dist/hooks/index.d.ts",
+      "import": "./dist/hooks/index.js",
+      "require": "./dist/hooks/index.cjs"
+    },
+    "./provider": {
+      "types": "./dist/provider/index.d.ts",
+      "import": "./dist/provider/index.js",
+      "require": "./dist/provider/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "woocommerce",
+    "react",
+    "react-query",
+    "hooks",
+    "typescript"
+  ],
+  "author": "Atomic Solutions",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/atomic-solutions/wordpress-woocommerce-monorepo",
+    "directory": "packages/react-woocommerce"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@atomic-solutions/woocommerce-api-client": "0.1.0"
+  },
+  "peerDependencies": {
+    "@tanstack/react-query": ">=5.0.0",
+    "react": ">=18.0.0"
+  },
+  "devDependencies": {
+    "@ianvs/prettier-plugin-sort-imports": "^4.7.0",
+    "@tanstack/react-query": "^5.59.19",
+    "@testing-library/react": "^14.0.0",
+    "@types/node": "^24.10.1",
+    "@types/react": "^18.0.0",
+    "@types/react-dom": "^18.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.56.1",
+    "@typescript-eslint/parser": "^8.56.1",
+    "@vitest/coverage-v8": "^2.0.0",
+    "eslint": "^9.35.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "happy-dom": "^20.0.10",
+    "jsdom": "^27.2.0",
+    "prettier": "^3.0.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "release-it": "^19.0.6",
+    "tsup": "^8.0.0",
+    "typescript": "^5.9.0",
+    "vitest": "^2.0.0"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --ext .ts,.tsx",
+    "lint:fix": "eslint src --ext .ts,.tsx --fix",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "clean": "rm -rf dist"
+  }
+}