@spree/sdk 0.8.0 → 0.8.1

package/README.md

@@ -150,7 +150,7 @@ const products = await client.products.list({
   limit: 25,
   name_cont: 'shirt',
   sort: 'price asc',
-  expand: ['variants', 'images', 'taxons'],
+  expand: ['variants', 'images', 'categories'],
 });
 
 // Get single product by ID or slug
@@ -158,38 +158,27 @@ const product = await client.products.get('spree-tote', {
   expand: ['variants', 'images'],
 });
 
-// Get available filters (price range, availability, options, taxons)
+// Get available filters (price range, availability, options, categories)
 const filters = await client.products.filters({
-  taxon_id: 'txn_abc123', // Optional: scope filters to a taxon
+  category_id: 'ctg_abc123', // Optional: scope filters to a category
 });
 ```
 
-### Categories (Taxonomies & Taxons)
+### Categories
 
 ```typescript
-// List taxonomies
-const taxonomies = await client.taxonomies.list({
-  expand: ['taxons'],
-});
-
-// Get taxonomy with taxons
-const categories = await client.taxonomies.get('tax_123', {
-  expand: ['root', 'taxons'],
-});
-
-// List taxons with filtering
-const taxons = await client.taxons.list({
+// List categories with filtering
+const categories = await client.categories.list({
   depth_eq: 1,              // Top-level categories only
-  taxonomy_id_eq: '123',    // Filter by taxonomy
 });
 
-// Get single taxon by ID or permalink
-const taxon = await client.taxons.get('categories/clothing', {
+// Get single category by ID or permalink
+const category = await client.categories.get('clothing/shirts', {
   expand: ['ancestors', 'children'], // For breadcrumbs and subcategories
 });
 
 // List products in a category
-const categoryProducts = await client.taxons.products.list('categories/clothing', {
+const categoryProducts = await client.categories.products.list('clothing/shirts', {
   page: 1,
   limit: 12,
   expand: ['images', 'default_variant'],
@@ -525,7 +514,7 @@ The SDK uses a resource builder pattern for nested resources:
 | `customer` | `creditCards` | `list`, `get`, `delete` |
 | `customer` | `giftCards` | `list`, `get` |
 | `markets` | `countries` | `list`, `get` |
-| `taxons` | `products` | `list` |
+| `categories` | `products` | `list` |
 | `wishlists` | `items` | `create`, `update`, `delete` |
 
 Example:
@@ -536,7 +525,7 @@ await client.orders.payments.list(orderId, options);
 await client.orders.shipments.update(orderId, shipmentId, params, options);
 await client.customer.addresses.list({}, options);
 await client.markets.countries.list(marketId);
-await client.taxons.products.list(taxonId, params, options);
+await client.categories.products.list(categoryId, params, options);
 await client.wishlists.items.create(wishlistId, params, options);
 ```
 
@@ -605,8 +594,7 @@ import type {
   StoreProduct,
   StoreOrder,
   StoreVariant,
-  StoreTaxon,
-  StoreTaxonomy,
+  StoreCategory,
   StoreLineItem,
   StoreAddress,
   StoreCustomer,
@@ -615,7 +603,7 @@ import type {
 
 // All responses are fully typed
 const products: PaginatedResponse<StoreProduct> = await client.products.list();
-const taxon: StoreTaxon = await client.taxons.get('clothing');
+const category: StoreCategory = await client.categories.get('clothing');
 ```
 
 ## Available Types
@@ -627,8 +615,7 @@ The SDK exports all Store API types:
 - `StoreVariant` - Variant data
 - `StoreOrder` - Order/cart data
 - `StoreLineItem` - Line item in cart
-- `StoreTaxonomy` - Category group
-- `StoreTaxon` - Individual category
+- `StoreCategory` - Category
 - `StoreCountry` - Country with states
 - `StoreState` - State/province
 - `StoreAddress` - Customer address

package/dist/{index-CM4b4ZtS.d.cts → index-7DYT6LIh.d.cts}

@@ -130,6 +130,32 @@ type Base = {
     id: string;
 };
 
+type Category = {
+    id: string;
+    name: string;
+    permalink: string;
+    position: number;
+    depth: number;
+    meta_title: string | null;
+    meta_description: string | null;
+    meta_keywords: string | null;
+    children_count: number;
+    created_at: string;
+    updated_at: string;
+    parent_id: string | null;
+    description: string;
+    description_html: string;
+    image_url: string | null;
+    square_image_url: string | null;
+    is_root: boolean;
+    is_child: boolean;
+    is_leaf: boolean;
+    parent?: Category;
+    children?: Array<Category>;
+    ancestors?: Array<Category>;
+    metafields?: Array<Metafield>;
+};
+
 type Country = {
     iso: string;
     iso3: string;
@@ -535,7 +561,7 @@ type Product = {
     default_variant?: Variant;
     master_variant?: Variant;
     option_types?: Array<OptionType>;
-    taxons?: Array<Taxon>;
+    categories?: Array<Category>;
     metafields?: Array<Metafield>;
 };
 
@@ -722,45 +748,6 @@ type TaxCategory = {
     name: string;
 };
 
-type Taxon = {
-    id: string;
-    name: string;
-    permalink: string;
-    position: number;
-    depth: number;
-    meta_title: string | null;
-    meta_description: string | null;
-    meta_keywords: string | null;
-    children_count: number;
-    created_at: string;
-    updated_at: string;
-    parent_id: string | null;
-    taxonomy_id: string;
-    description: string;
-    description_html: string;
-    image_url: string | null;
-    square_image_url: string | null;
-    is_root: boolean;
-    is_child: boolean;
-    is_leaf: boolean;
-    parent?: Taxon;
-    children?: Array<Taxon>;
-    ancestors?: Array<Taxon>;
-    metafields?: Array<Metafield>;
-};
-
-type Taxonomy = {
-    id: string;
-    name: string;
-    position: number;
-    created_at: string;
-    updated_at: string;
-    root_id: string | null;
-    root?: Taxon;
-    taxons?: Array<Taxon>;
-    metafields?: Array<Metafield>;
-};
-
 type Variant = {
     id: string;
     product_id: string;
@@ -848,17 +835,16 @@ interface ProductListParams extends ListParams {
     in_stock?: boolean;
     /** Filter: only out-of-stock products */
     out_of_stock?: boolean;
-    /** Filter: products in taxon */
-    taxons_id_eq?: string;
+    /** Filter: products in category */
+    categories_id_eq?: string;
     /** Any additional Ransack predicate */
     [key: string]: string | number | boolean | (string | number)[] | undefined;
 }
-interface TaxonListParams extends ListParams {
+interface CategoryListParams extends ListParams {
     /** Sort order, e.g. 'name', '-created_at' */
     sort?: string;
     /** Filter: name contains */
     name_cont?: string;
-    taxonomy_id_eq?: string | number;
     parent_id_eq?: string | number;
     depth_eq?: number;
     /** Any additional Ransack predicate */
@@ -947,7 +933,7 @@ interface OptionFilterOption extends FilterOption {
     presentation: string;
     position: number;
 }
-interface TaxonFilterOption {
+interface CategoryFilterOption {
     id: string;
     name: string;
     permalink: string;
@@ -972,12 +958,12 @@ interface OptionFilter {
     presentation: string;
     options: OptionFilterOption[];
 }
-interface TaxonFilter {
-    id: 'taxons';
-    type: 'taxon';
-    options: TaxonFilterOption[];
+interface CategoryFilter {
+    id: 'categories';
+    type: 'category';
+    options: CategoryFilterOption[];
 }
-type ProductFilter = PriceRangeFilter | AvailabilityFilter | OptionFilter | TaxonFilter;
+type ProductFilter = PriceRangeFilter | AvailabilityFilter | OptionFilter | CategoryFilter;
 interface SortOption {
     id: string;
 }
@@ -988,8 +974,8 @@ interface ProductFiltersResponse {
     total_count: number;
 }
 interface ProductFiltersParams {
-    taxon_id?: string;
+    category_id?: string;
     q?: Record<string, unknown>;
 }
 
-export { type Image as $, type AuthTokens as A, type CreatePaymentSetupSessionParams as B, type Country as C, type PaymentSetupSession as D, type CompletePaymentSetupSessionParams as E, type WishedItem as F, type GiftCard as G, type RetryConfig as H, type Asset as I, type AvailabilityFilter as J, type Base as K, type LoginCredentials as L, type Market as M, type CustomerReturn as N, type Order as O, type ProductListParams as P, type Digital as Q, type RequestFn as R, type Shipment as S, type Taxonomy as T, type UpdateOrderParams as U, type DigitalLink as V, type Wishlist as W, type ErrorResponse as X, type Export as Y, type FilterOption as Z, type GiftCardBatch as _, type RequestOptions as a, type Import as a0, type ImportRow as a1, type Invitation as a2, type LineItem as a3, type LineItemInput as a4, type LocaleDefaults as a5, type Metafield as a6, type NewsletterSubscriber as a7, type OptionFilter as a8, type OptionFilterOption as a9, type Variant as aA, type TaxonFilter as aB, type TaxonFilterOption as aC, type OptionType as aa, type OptionValue as ab, type OrderPromotion as ac, type PaginationMeta as ad, type PaymentSource as ae, type Price as af, type PriceRangeFilter as ag, type ProductFilter as ah, type Promotion as ai, type Refund as aj, type Reimbursement as ak, type Report as al, type ReturnAuthorization as am, type ReturnItem as an, type ShippingCategory as ao, type ShippingMethod as ap, type ShippingRate as aq, type SortOption as ar, SpreeError as as, type State as at, type StockItem as au, type StockLocation as av, type StockMovement as aw, type StockTransfer as ax, type StoreCredit as ay, type TaxCategory as az, type PaginatedResponse as b, type Product as c, type ProductFiltersParams as d, type ProductFiltersResponse as e, type ListParams as f, type TaxonListParams as g, type Taxon as h, type ListResponse as i, type Currency as j, type Locale as k, type CreateCartParams as l, type AddLineItemParams as m, type UpdateLineItemParams as n, type Payment as o, type PaymentMethod as p, type CreatePaymentSessionParams as q, type PaymentSession as r, type UpdatePaymentSessionParams as s, type CompletePaymentSessionParams as t, type RegisterParams as u, type Customer as v, type Address as w, type AddressParams as x, type CreditCard as y, type OrderListParams as z };
+export { type GiftCardBatch as $, type AuthTokens as A, type CreatePaymentSetupSessionParams as B, type CategoryListParams as C, type PaymentSetupSession as D, type CompletePaymentSetupSessionParams as E, type WishedItem as F, type GiftCard as G, type RetryConfig as H, type Asset as I, type AvailabilityFilter as J, type Base as K, type LoginCredentials as L, type Market as M, type CategoryFilter as N, type Order as O, type ProductListParams as P, type CategoryFilterOption as Q, type RequestFn as R, type Shipment as S, type CustomerReturn as T, type UpdateOrderParams as U, type Digital as V, type Wishlist as W, type DigitalLink as X, type ErrorResponse as Y, type Export as Z, type FilterOption as _, type RequestOptions as a, type Image as a0, type Import as a1, type ImportRow as a2, type Invitation as a3, type LineItem as a4, type LineItemInput as a5, type LocaleDefaults as a6, type Metafield as a7, type NewsletterSubscriber as a8, type OptionFilter as a9, type TaxCategory as aA, type Variant as aB, type OptionFilterOption as aa, type OptionType as ab, type OptionValue as ac, type OrderPromotion as ad, type PaginationMeta as ae, type PaymentSource as af, type Price as ag, type PriceRangeFilter as ah, type ProductFilter as ai, type Promotion as aj, type Refund as ak, type Reimbursement as al, type Report as am, type ReturnAuthorization as an, type ReturnItem as ao, type ShippingCategory as ap, type ShippingMethod as aq, type ShippingRate as ar, type SortOption as as, SpreeError as at, type State as au, type StockItem as av, type StockLocation as aw, type StockMovement as ax, type StockTransfer as ay, type StoreCredit as az, type PaginatedResponse as b, type Product as c, type ProductFiltersParams as d, type ProductFiltersResponse as e, type Category as f, type ListResponse as g, type Country as h, type Currency as i, type Locale as j, type CreateCartParams as k, type AddLineItemParams as l, type UpdateLineItemParams as m, type Payment as n, type PaymentMethod as o, type CreatePaymentSessionParams as p, type PaymentSession as q, type UpdatePaymentSessionParams as r, type CompletePaymentSessionParams as s, type RegisterParams as t, type Customer as u, type ListParams as v, type Address as w, type AddressParams as x, type CreditCard as y, type OrderListParams as z };

package/dist/{index-CM4b4ZtS.d.ts → index-7DYT6LIh.d.ts}

@@ -130,6 +130,32 @@ type Base = {
     id: string;
 };
 
+type Category = {
+    id: string;
+    name: string;
+    permalink: string;
+    position: number;
+    depth: number;
+    meta_title: string | null;
+    meta_description: string | null;
+    meta_keywords: string | null;
+    children_count: number;
+    created_at: string;
+    updated_at: string;
+    parent_id: string | null;
+    description: string;
+    description_html: string;
+    image_url: string | null;
+    square_image_url: string | null;
+    is_root: boolean;
+    is_child: boolean;
+    is_leaf: boolean;
+    parent?: Category;
+    children?: Array<Category>;
+    ancestors?: Array<Category>;
+    metafields?: Array<Metafield>;
+};
+
 type Country = {
     iso: string;
     iso3: string;
@@ -535,7 +561,7 @@ type Product = {
     default_variant?: Variant;
     master_variant?: Variant;
     option_types?: Array<OptionType>;
-    taxons?: Array<Taxon>;
+    categories?: Array<Category>;
     metafields?: Array<Metafield>;
 };
 
@@ -722,45 +748,6 @@ type TaxCategory = {
     name: string;
 };
 
-type Taxon = {
-    id: string;
-    name: string;
-    permalink: string;
-    position: number;
-    depth: number;
-    meta_title: string | null;
-    meta_description: string | null;
-    meta_keywords: string | null;
-    children_count: number;
-    created_at: string;
-    updated_at: string;
-    parent_id: string | null;
-    taxonomy_id: string;
-    description: string;
-    description_html: string;
-    image_url: string | null;
-    square_image_url: string | null;
-    is_root: boolean;
-    is_child: boolean;
-    is_leaf: boolean;
-    parent?: Taxon;
-    children?: Array<Taxon>;
-    ancestors?: Array<Taxon>;
-    metafields?: Array<Metafield>;
-};
-
-type Taxonomy = {
-    id: string;
-    name: string;
-    position: number;
-    created_at: string;
-    updated_at: string;
-    root_id: string | null;
-    root?: Taxon;
-    taxons?: Array<Taxon>;
-    metafields?: Array<Metafield>;
-};
-
 type Variant = {
     id: string;
     product_id: string;
@@ -848,17 +835,16 @@ interface ProductListParams extends ListParams {
     in_stock?: boolean;
     /** Filter: only out-of-stock products */
     out_of_stock?: boolean;
-    /** Filter: products in taxon */
-    taxons_id_eq?: string;
+    /** Filter: products in category */
+    categories_id_eq?: string;
     /** Any additional Ransack predicate */
     [key: string]: string | number | boolean | (string | number)[] | undefined;
 }
-interface TaxonListParams extends ListParams {
+interface CategoryListParams extends ListParams {
     /** Sort order, e.g. 'name', '-created_at' */
     sort?: string;
     /** Filter: name contains */
     name_cont?: string;
-    taxonomy_id_eq?: string | number;
     parent_id_eq?: string | number;
     depth_eq?: number;
     /** Any additional Ransack predicate */
@@ -947,7 +933,7 @@ interface OptionFilterOption extends FilterOption {
     presentation: string;
     position: number;
 }
-interface TaxonFilterOption {
+interface CategoryFilterOption {
     id: string;
     name: string;
     permalink: string;
@@ -972,12 +958,12 @@ interface OptionFilter {
     presentation: string;
     options: OptionFilterOption[];
 }
-interface TaxonFilter {
-    id: 'taxons';
-    type: 'taxon';
-    options: TaxonFilterOption[];
+interface CategoryFilter {
+    id: 'categories';
+    type: 'category';
+    options: CategoryFilterOption[];
 }
-type ProductFilter = PriceRangeFilter | AvailabilityFilter | OptionFilter | TaxonFilter;
+type ProductFilter = PriceRangeFilter | AvailabilityFilter | OptionFilter | CategoryFilter;
 interface SortOption {
     id: string;
 }
@@ -988,8 +974,8 @@ interface ProductFiltersResponse {
     total_count: number;
 }
 interface ProductFiltersParams {
-    taxon_id?: string;
+    category_id?: string;
     q?: Record<string, unknown>;
 }
 
-export { type Image as $, type AuthTokens as A, type CreatePaymentSetupSessionParams as B, type Country as C, type PaymentSetupSession as D, type CompletePaymentSetupSessionParams as E, type WishedItem as F, type GiftCard as G, type RetryConfig as H, type Asset as I, type AvailabilityFilter as J, type Base as K, type LoginCredentials as L, type Market as M, type CustomerReturn as N, type Order as O, type ProductListParams as P, type Digital as Q, type RequestFn as R, type Shipment as S, type Taxonomy as T, type UpdateOrderParams as U, type DigitalLink as V, type Wishlist as W, type ErrorResponse as X, type Export as Y, type FilterOption as Z, type GiftCardBatch as _, type RequestOptions as a, type Import as a0, type ImportRow as a1, type Invitation as a2, type LineItem as a3, type LineItemInput as a4, type LocaleDefaults as a5, type Metafield as a6, type NewsletterSubscriber as a7, type OptionFilter as a8, type OptionFilterOption as a9, type Variant as aA, type TaxonFilter as aB, type TaxonFilterOption as aC, type OptionType as aa, type OptionValue as ab, type OrderPromotion as ac, type PaginationMeta as ad, type PaymentSource as ae, type Price as af, type PriceRangeFilter as ag, type ProductFilter as ah, type Promotion as ai, type Refund as aj, type Reimbursement as ak, type Report as al, type ReturnAuthorization as am, type ReturnItem as an, type ShippingCategory as ao, type ShippingMethod as ap, type ShippingRate as aq, type SortOption as ar, SpreeError as as, type State as at, type StockItem as au, type StockLocation as av, type StockMovement as aw, type StockTransfer as ax, type StoreCredit as ay, type TaxCategory as az, type PaginatedResponse as b, type Product as c, type ProductFiltersParams as d, type ProductFiltersResponse as e, type ListParams as f, type TaxonListParams as g, type Taxon as h, type ListResponse as i, type Currency as j, type Locale as k, type CreateCartParams as l, type AddLineItemParams as m, type UpdateLineItemParams as n, type Payment as o, type PaymentMethod as p, type CreatePaymentSessionParams as q, type PaymentSession as r, type UpdatePaymentSessionParams as s, type CompletePaymentSessionParams as t, type RegisterParams as u, type Customer as v, type Address as w, type AddressParams as x, type CreditCard as y, type OrderListParams as z };
+export { type GiftCardBatch as $, type AuthTokens as A, type CreatePaymentSetupSessionParams as B, type CategoryListParams as C, type PaymentSetupSession as D, type CompletePaymentSetupSessionParams as E, type WishedItem as F, type GiftCard as G, type RetryConfig as H, type Asset as I, type AvailabilityFilter as J, type Base as K, type LoginCredentials as L, type Market as M, type CategoryFilter as N, type Order as O, type ProductListParams as P, type CategoryFilterOption as Q, type RequestFn as R, type Shipment as S, type CustomerReturn as T, type UpdateOrderParams as U, type Digital as V, type Wishlist as W, type DigitalLink as X, type ErrorResponse as Y, type Export as Z, type FilterOption as _, type RequestOptions as a, type Image as a0, type Import as a1, type ImportRow as a2, type Invitation as a3, type LineItem as a4, type LineItemInput as a5, type LocaleDefaults as a6, type Metafield as a7, type NewsletterSubscriber as a8, type OptionFilter as a9, type TaxCategory as aA, type Variant as aB, type OptionFilterOption as aa, type OptionType as ab, type OptionValue as ac, type OrderPromotion as ad, type PaginationMeta as ae, type PaymentSource as af, type Price as ag, type PriceRangeFilter as ah, type ProductFilter as ai, type Promotion as aj, type Refund as ak, type Reimbursement as al, type Report as am, type ReturnAuthorization as an, type ReturnItem as ao, type ShippingCategory as ap, type ShippingMethod as aq, type ShippingRate as ar, type SortOption as as, SpreeError as at, type State as au, type StockItem as av, type StockLocation as aw, type StockMovement as ax, type StockTransfer as ay, type StoreCredit as az, type PaginatedResponse as b, type Product as c, type ProductFiltersParams as d, type ProductFiltersResponse as e, type Category as f, type ListResponse as g, type Country as h, type Currency as i, type Locale as j, type CreateCartParams as k, type AddLineItemParams as l, type UpdateLineItemParams as m, type Payment as n, type PaymentMethod as o, type CreatePaymentSessionParams as p, type PaymentSession as q, type UpdatePaymentSessionParams as r, type CompletePaymentSessionParams as s, type RegisterParams as t, type Customer as u, type ListParams as v, type Address as w, type AddressParams as x, type CreditCard as y, type OrderListParams as z };

package/dist/index.cjs

@@ -199,7 +199,7 @@ var StoreClient = class {
     }),
     /**
      * Get available filters for products
-     * Returns filter options (price range, availability, option types, taxons) with counts
+     * Returns filter options (price range, availability, option types, categories) with counts
      */
     filters: (params, options) => this.request("GET", "/products/filters", {
       ...options,
@@ -207,50 +207,34 @@ var StoreClient = class {
     })
   };
   // ============================================
-  // Taxonomies & Taxons
+  // Categories
   // ============================================
-  taxonomies = {
+  categories = {
     /**
-     * List taxonomies
+     * List categories
      */
-    list: (params, options) => this.request("GET", "/taxonomies", {
+    list: (params, options) => this.request("GET", "/categories", {
       ...options,
       params: transformListParams({ ...params })
     }),
     /**
-     * Get a taxonomy by ID
+     * Get a category by ID or permalink
      */
-    get: (id, params, options) => this.request("GET", `/taxonomies/${id}`, {
-      ...options,
-      params: getParams(params)
-    })
-  };
-  taxons = {
-    /**
-     * List taxons
-     */
-    list: (params, options) => this.request("GET", "/taxons", {
-      ...options,
-      params: transformListParams({ ...params })
-    }),
-    /**
-     * Get a taxon by ID or permalink
-     */
-    get: (idOrPermalink, params, options) => this.request("GET", `/taxons/${idOrPermalink}`, {
+    get: (idOrPermalink, params, options) => this.request("GET", `/categories/${idOrPermalink}`, {
       ...options,
       params: getParams(params)
     }),
     /**
-     * Nested resource: Products in a taxon
+     * Nested resource: Products in a category
      */
     products: {
       /**
-       * List products in a taxon
-       * @param taxonId - Taxon ID (prefix_id) or permalink
+       * List products in a category
+       * @param categoryId - Category ID (prefix_id) or permalink
        */
-      list: (taxonId, params, options) => this.request(
+      list: (categoryId, params, options) => this.request(
         "GET",
-        `/taxons/${taxonId}/products`,
+        `/categories/${categoryId}/products`,
         {
           ...options,
           params: transformListParams({ ...params })