@commercengine/storefront-sdk 0.3.0 → 0.3.2

package/dist/lib/cart.js

@@ -1,45 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CartClient = void 0;
-const client_1 = require("./client");
+import { StorefrontAPIClient } from "./client";
 /**
  * Client for interacting with cart endpoints
  */
-class CartClient extends client_1.StorefrontAPIClient {
-    constructor() {
-        super(...arguments);
-        this.clientStorage = null;
-    }
-    /**
-     * Set the client storage implementation to use for cart ID management
-     *
-     * @param storage - The client storage instance
-     */
-    setClientStorage(storage) {
-        this.clientStorage = storage;
-    }
-    /**
-     * Get the stored cart ID
-     *
-     * @returns Promise that resolves to the cart ID or null if not found
-     */
-    async getCartId() {
-        return this.clientStorage?.getCartId() ?? null;
-    }
-    /**
-     * Set the cart ID in storage
-     *
-     * @param cartId - The cart ID to store
-     */
-    async setCartId(cartId) {
-        await this.clientStorage?.setCartId(cartId);
-    }
-    /**
-     * Clear the stored cart ID
-     */
-    async clearCartId() {
-        await this.clientStorage?.clearCartId();
-    }
+export class CartClient extends StorefrontAPIClient {
     /**
      * Create a new cart
      *
@@ -47,119 +10,50 @@ class CartClient extends client_1.StorefrontAPIClient {
      * @returns Promise with the created cart
      */
     async createCart(payload) {
-        return this.executeRequest(async () => {
-            const { data, error } = await this.client.POST("/carts", {
-                body: payload,
-            });
-            if (error) {
-                this.handleError(error);
-            }
-            // Store the cart ID
-            if (data?.content?.cart?.id) {
-                await this.setCartId(data.content.cart.id);
-            }
-            return data?.content;
-        });
+        return this.executeRequest(() => this.client.POST("/carts", {
+            body: payload,
+        }));
     }
     /**
      * Get cart details - either by ID or using the stored cart ID
      *
-     * @param cartId - Optional cart ID (if not provided, uses stored cart ID)
+     * @param cartId - The ID of the cart
      * @returns Promise with cart details
-     * @throws Error if no cartId is provided and none is stored
      */
     async getCart(cartId) {
-        // Use provided cartId or stored cartId
-        const id = cartId || (await this.getCartId());
-        if (!id) {
-            throw new Error("Cart ID is required but not provided");
-        }
-        return this.executeRequest(async () => {
-            const { data, error } = await this.client.GET("/carts/{id}", {
-                params: {
-                    path: { id },
-                },
-            });
-            if (error) {
-                this.handleError(error);
-            }
-            return data?.content;
-        });
+        return this.executeRequest(() => this.client.GET("/carts/{id}", {
+            params: {
+                path: cartId,
+            },
+        }));
     }
     /**
      * Delete a cart - either by ID or using the stored cart ID
      *
-     * @param cartId - Optional cart ID (if not provided, uses stored cart ID)
+     * @param cartId - The ID of the cart
      * @returns Promise that resolves when the cart is deleted
-     * @throws Error if no cartId is provided and none is stored
      */
     async deleteCart(cartId) {
-        // Use provided cartId or stored cartId
-        const id = cartId || (await this.getCartId());
-        if (!id) {
-            throw new Error("Cart ID is required but not provided");
-        }
-        return this.executeRequest(async () => {
-            const { error } = await this.client.DELETE("/carts/{id}", {
-                params: {
-                    path: { id },
-                },
-                body: undefined,
-            });
-            if (error) {
-                this.handleError(error);
-            }
-            // Clear the stored cart ID if we deleted the current cart
-            const storedCartId = await this.getCartId();
-            if (cartId === undefined || cartId === storedCartId) {
-                await this.clearCartId();
-            }
-        });
-    }
-    /**
-     * Add item to cart - either by specified ID or stored cart ID
-     * Will create a new cart if no cart ID is available
-     *
-     * @param item - The item to add to the cart
-     * @param cartId - Optional cart ID (if not provided, uses stored cart ID or creates a new cart)
-     * @returns Promise with updated or created cart
-     */
-    async addItem(item, cartId) {
-        // Check if we have a cart ID (either provided or stored)
-        const id = cartId || (await this.getCartId());
-        // If we don't have a cart ID, create a new cart
-        if (!id) {
-            return this.createCart({ items: [item] });
-        }
-        // Otherwise update existing cart
-        return this.updateCartItem(id, item);
+        return this.executeRequest(() => this.client.DELETE("/carts/{id}", {
+            params: {
+                path: cartId,
+            },
+        }));
     }
     /**
      * Update cart items (add, update quantity, remove)
      *
-     * @param cartId - The ID of the cart or undefined to use stored cart ID
-     * @param item - The item data
+     * @param cartId - The cart id
+     * @param body - The body of the request
      * @returns Promise with updated cart
-     * @throws Error if no cartId is provided and none is stored
      */
-    async updateCartItem(cartId, item) {
-        // Use provided cartId or stored cartId
-        const id = cartId || (await this.getCartId());
-        if (!id) {
-            throw new Error("Cart ID is required but not provided");
-        }
-        return this.executeRequest(async () => {
-            const { data, error } = await this.client.POST("/carts/{id}/items", {
-                params: {
-                    path: { id },
-                },
-                body: item,
-            });
-            if (error) {
-                this.handleError(error);
-            }
-            return data?.content;
-        });
+    async addDeleteCartItem(cartId, body) {
+        return this.executeRequest(() => this.client.POST("/carts/{id}/items", {
+            params: {
+                path: cartId,
+            },
+            body: body,
+        }));
     }
     /**
      * Get cart details by user ID
@@ -168,21 +62,11 @@ class CartClient extends client_1.StorefrontAPIClient {
      * @returns Promise with cart details
      */
     async getUserCart(userId) {
-        return this.executeRequest(async () => {
-            const { data, error } = await this.client.GET("/carts/users/{user_id}", {
-                params: {
-                    path: { user_id: userId },
-                },
-            });
-            if (error) {
-                this.handleError(error);
-            }
-            // Store the cart ID if present
-            if (data?.content?.cart?.id) {
-                await this.setCartId(data.content.cart.id);
-            }
-            return data?.content;
-        });
+        return this.executeRequest(() => this.client.GET("/carts/users/{user_id}", {
+            params: {
+                path: userId,
+            },
+        }));
     }
     /**
      * Delete a cart by user ID
@@ -191,19 +75,12 @@ class CartClient extends client_1.StorefrontAPIClient {
      * @returns Promise that resolves when the cart is deleted
      */
     async deleteUserCart(userId) {
-        return this.executeRequest(async () => {
-            const { error } = await this.client.DELETE("/carts/users/{user_id}", {
-                params: {
-                    path: { user_id: userId },
-                },
-                body: undefined,
-            });
-            if (error) {
-                this.handleError(error);
-            }
-            // Clear the stored cart ID since we deleted the user's cart
-            await this.clearCartId();
-        });
+        return this.executeRequest(() => this.client.DELETE("/carts/users/{user_id}", {
+            params: {
+                path: userId,
+            },
+            body: undefined,
+        }));
     }
     /**
      * Update cart addresses
@@ -213,18 +90,12 @@ class CartClient extends client_1.StorefrontAPIClient {
      * @returns Promise with updated cart
      */
     async updateCartAddress(cartId, addressData) {
-        return this.executeRequest(async () => {
-            const { data, error } = await this.client.POST("/carts/{id}/address", {
-                params: {
-                    path: { id: cartId },
-                },
-                body: addressData,
-            });
-            if (error) {
-                this.handleError(error);
-            }
-            return data?.content;
-        });
+        return this.executeRequest(() => this.client.POST("/carts/{id}/address", {
+            params: {
+                path: cartId,
+            },
+            body: addressData,
+        }));
     }
     /**
      * Apply a coupon to the cart
@@ -234,18 +105,12 @@ class CartClient extends client_1.StorefrontAPIClient {
      * @returns Promise with updated cart
      */
     async applyCoupon(cartId, couponCode) {
-        return this.executeRequest(async () => {
-            const { data, error } = await this.client.POST("/carts/{id}/coupon", {
-                params: {
-                    path: { id: cartId },
-                },
-                body: { coupon_code: couponCode },
-            });
-            if (error) {
-                this.handleError(error);
-            }
-            return data?.content;
-        });
+        return this.executeRequest(() => this.client.POST("/carts/{id}/coupon", {
+            params: {
+                path: cartId,
+            },
+            body: couponCode,
+        }));
     }
     /**
      * Remove a coupon from the cart
@@ -254,18 +119,12 @@ class CartClient extends client_1.StorefrontAPIClient {
      * @returns Promise with updated cart
      */
     async removeCoupon(cartId) {
-        return this.executeRequest(async () => {
-            const { data, error } = await this.client.DELETE("/carts/{id}/coupon", {
-                params: {
-                    path: { id: cartId },
-                },
-                body: undefined,
-            });
-            if (error) {
-                this.handleError(error);
-            }
-            return data?.content;
-        });
+        return this.executeRequest(() => this.client.DELETE("/carts/{id}/coupon", {
+            params: {
+                path: cartId,
+            },
+            body: undefined,
+        }));
     }
     /**
      * Redeem loyalty points
@@ -275,18 +134,12 @@ class CartClient extends client_1.StorefrontAPIClient {
      * @returns Promise with updated cart
      */
     async redeemLoyaltyPoints(cartId, points) {
-        return this.executeRequest(async () => {
-            const { data, error } = await this.client.POST("/carts/{id}/loyalty-points", {
-                params: {
-                    path: { id: cartId },
-                },
-                body: { loyalty_point_redeemed: points },
-            });
-            if (error) {
-                this.handleError(error);
-            }
-            return data?.content;
-        });
+        return this.executeRequest(() => this.client.POST("/carts/{id}/loyalty-points", {
+            params: {
+                path: cartId,
+            },
+            body: points,
+        }));
     }
     /**
      * Remove loyalty points
@@ -295,18 +148,127 @@ class CartClient extends client_1.StorefrontAPIClient {
      * @returns Promise with updated cart
      */
     async removeLoyaltyPoints(cartId) {
-        return this.executeRequest(async () => {
-            const { data, error } = await this.client.DELETE("/carts/{id}/loyalty-points", {
-                params: {
-                    path: { id: cartId },
-                },
-                body: undefined,
-            });
-            if (error) {
-                this.handleError(error);
-            }
-            return data?.content;
-        });
+        return this.executeRequest(() => this.client.DELETE("/carts/{id}/loyalty-points", {
+            params: {
+                path: cartId,
+            },
+            body: undefined,
+        }));
+    }
+    /**
+     * Update shipping method
+     *
+     * @param cartId - The ID of the cart
+     * @param body - The body of the request
+     * @returns Promise with updated cart
+     */
+    async updateShippingMethod(cartId, body) {
+        return this.executeRequest(() => this.client.POST("/carts/{id}/shipping-method", {
+            params: {
+                path: cartId,
+            },
+            body: body,
+        }));
+    }
+    /**
+     * Use credit balance
+     *
+     * @param cartId - The ID of the cart
+     * @param body - The body of the request
+     * @returns Promise with updated cart
+     */
+    async redeemCreditBalance(cartId, body) {
+        return this.executeRequest(() => this.client.POST("/carts/{id}/credit-balance", {
+            params: {
+                path: cartId,
+            },
+            body: body,
+        }));
+    }
+    /**
+     * Remove credit balance
+     *
+     * @param cartId - The ID of the cart
+     * @returns Promise with updated cart
+     */
+    async removeCreditBalance(cartId) {
+        return this.executeRequest(() => this.client.DELETE("/carts/{id}/credit-balance", {
+            params: {
+                path: cartId,
+            },
+            body: undefined,
+        }));
+    }
+    /**
+     * Redeem gift card
+     *
+     * @param cartId - The ID of the cart
+     * @param body - The body of the request
+     * @returns Promise with updated cart
+     */
+    async redeemGiftCard(cartId, body) {
+        return this.executeRequest(() => this.client.POST("/carts/{id}/gift-card", {
+            params: {
+                path: cartId,
+            },
+            body: body,
+        }));
+    }
+    /**
+     * Remove gift card
+     *
+     * @param cartId - The ID of the cart
+     * @returns Promise with updated cart
+     */
+    async removeGiftCard(cartId) {
+        return this.executeRequest(() => this.client.DELETE("/carts/{id}/gift-card", {
+            params: {
+                path: cartId,
+            },
+            body: undefined,
+        }));
+    }
+    /**
+     * Get wishlist items
+     *
+     * @param userId - The ID of the user
+     * @returns Promise with wishlist items
+     */
+    async getWishlist(userId) {
+        return this.executeRequest(() => this.client.GET("/wishlist/{user_id}", {
+            params: {
+                path: userId,
+            },
+        }));
+    }
+    /**
+     * Add item to wishlist
+     *
+     * @param userId - The ID of the user
+     * @param itemId - The ID of the item
+     * @returns Promise with updated wishlist
+     */
+    async addToWishlist(userId, itemId) {
+        return this.executeRequest(() => this.client.POST("/wishlist/{user_id}", {
+            params: {
+                path: userId,
+            },
+            body: itemId,
+        }));
+    }
+    /**
+     * Remove item from wishlist
+     *
+     * @param userId - The ID of the user
+     * @param itemId - The ID of the item
+     * @returns Promise with updated wishlist
+     */
+    async removeFromWishlist(userId, body) {
+        return this.executeRequest(() => this.client.DELETE("/wishlist/{user_id}", {
+            params: {
+                path: userId,
+            },
+            body: body,
+        }));
     }
 }
-exports.CartClient = CartClient;

package/dist/lib/catalog.d.ts

@@ -1,5 +1,5 @@
 import { StorefrontAPIClient } from "./client";
-import type { components } from "../types/storefront";
+import type { ApiResult, GetProductDetailContent, GetProductDetailPathParams, GetProductDetailQuery, GetVariantDetailContent, GetVariantDetailQuery, GetVariantDetailPathParams, ListProductsContent, ListProductsQuery, ListProductVariantsContent, ListProductVariantsPathParams, ListProductVariantsQuery, ListCategoriesQuery, ListCategoriesContent, ListProductReviewsQuery, ListProductReviewsPathParams, ListProductReviewsContent, CreateProductReviewPathParams, CreateProductReviewFormData, CreateProductReviewResponse, SearchProductsBody, SearchProductsContent, ListSkusQuery, ListSkusContent, ListCrosssellProductsContent, ListCrosssellProductsQuery, ListUpsellProductsQuery, ListUpsellProductsContent, ListSimilarProductsQuery, ListSimilarProductsContent } from "../types/storefront-api-types";
 /**
  * Client for interacting with catalog endpoints
  */
@@ -10,16 +10,14 @@ export declare class CatalogClient extends StorefrontAPIClient {
      * @param options - Optional query parameters
      * @returns Promise with products and pagination info
      */
-    listProducts(options?: {
-        page?: number;
-        limit?: number;
-        sort_by?: string;
-        category_id?: string[];
-        customer_group_id?: string;
-    }): Promise<{
-        products: components["schemas"]["Product"][];
-        pagination: components["schemas"]["Pagination"];
-    }>;
+    listProducts(options?: ListProductsQuery): Promise<ApiResult<ListProductsContent>>;
+    /**
+     * List all skus
+     *
+     * @param options - Optional query parameters
+     * @returns Promise with skus and pagination info
+     */
+    listSkus(options?: ListSkusQuery): Promise<ApiResult<ListSkusContent>>;
     /**
      * Get details for a specific product
      *
@@ -27,11 +25,7 @@ export declare class CatalogClient extends StorefrontAPIClient {
      * @param options - Optional query parameters
      * @returns Promise with product details
      */
-    getProductDetail(productId: string, options?: {
-        customer_group_id?: string;
-    }): Promise<{
-        product: components["schemas"]["ProductDetail"];
-    }>;
+    getProductDetail(pathParams: GetProductDetailPathParams, queryParams?: GetProductDetailQuery): Promise<ApiResult<GetProductDetailContent>>;
     /**
      * List variants for a specific product
      *
@@ -39,11 +33,7 @@ export declare class CatalogClient extends StorefrontAPIClient {
      * @param options - Optional query parameters
      * @returns Promise with variants
      */
-    listProductVariants(productId: string, options?: {
-        customer_group_id?: string;
-    }): Promise<{
-        variants: components["schemas"]["Variant"][];
-    }>;
+    listProductVariants(pathParams: ListProductVariantsPathParams, queryParams?: ListProductVariantsQuery): Promise<ApiResult<ListProductVariantsContent>>;
     /**
      * Get details for a specific variant
      *
@@ -52,26 +42,14 @@ export declare class CatalogClient extends StorefrontAPIClient {
      * @param options - Optional query parameters
      * @returns Promise with variant details
      */
-    getVariantDetail(productId: string, variantId: string, options?: {
-        customer_group_id?: string;
-    }): Promise<{
-        variant: components["schemas"]["VariantDetail"];
-    }>;
+    getVariantDetail(pathParams: GetVariantDetailPathParams, queryParams?: GetVariantDetailQuery): Promise<ApiResult<GetVariantDetailContent>>;
     /**
      * List all categories
      *
      * @param options - Optional query parameters
      * @returns Promise with categories and pagination info
      */
-    listCategories(options?: {
-        parent_category_id?: string;
-        nested_level?: number;
-        search?: string;
-        sort_by?: string;
-    }): Promise<{
-        categories: components["schemas"]["ProductCategory"][];
-        pagination: components["schemas"]["Pagination"];
-    }>;
+    listCategories(options?: ListCategoriesQuery): Promise<ApiResult<ListCategoriesContent>>;
     /**
      * List reviews for a specific product
      *
@@ -79,17 +57,7 @@ export declare class CatalogClient extends StorefrontAPIClient {
      * @param options - Optional query parameters
      * @returns Promise with reviews and pagination info
      */
-    listProductReviews(productId: string, options?: {
-        page?: number;
-        limit?: number;
-        sort_by?: string;
-        search?: string;
-        review_tag?: string;
-    }): Promise<{
-        reviews: components["schemas"]["ProductReview"][];
-        review_tags?: string[] | null;
-        pagination?: components["schemas"]["Pagination"];
-    }>;
+    listProductReviews(pathParams: ListProductReviewsPathParams, queryParams?: ListProductReviewsQuery): Promise<ApiResult<ListProductReviewsContent>>;
     /**
      * Create a review for a specific product
      *
@@ -97,34 +65,33 @@ export declare class CatalogClient extends StorefrontAPIClient {
      * @param reviewData - The review data
      * @returns Promise that resolves when the review is created
      */
-    createProductReview(productId: string, reviewData: components["schemas"]["CreateReview"]): Promise<void>;
+    createProductReview(pathParams: CreateProductReviewPathParams, formData: CreateProductReviewFormData): Promise<ApiResult<CreateProductReviewResponse>>;
     /**
      * Search for products
      *
      * @param searchData - The search parameters
-     * @returns Promise with search results
+     * @returns Promise with search results, facet distribution, facet stats, and pagination
+     */
+    searchProducts(searchData: SearchProductsBody): Promise<ApiResult<SearchProductsContent>>;
+    /**
+     * Retrieve cross-sell recommendations for a specific product
+     *
+     * @param options - Optional query parameters
+     * @returns Promise with cross-sell recommendations with pagination
      */
-    searchProducts(searchData: components["schemas"]["SearchProduct"]): Promise<{
-        skus: components["schemas"]["SKU"][];
-        facet_distribution: {
-            [key: string]: {
-                [key: string]: number;
-            };
-        };
-        facet_stats: {
-            [key: string]: {
-                min: number;
-                max: number;
-            };
-        };
-        pagination: components["schemas"]["Pagination"];
-    }>;
+    listCrossSellProducts(options?: ListCrosssellProductsQuery): Promise<ApiResult<ListCrosssellProductsContent>>;
     /**
-     * Get product details by ID (alternative implementation)
-     * @param productId - The product ID to retrieve
-     * @returns Promise with the product details
+     * Retrieve up-sell recommendations for a specific product
+     *
+     * @param options - Optional query parameters
+     * @returns Promise with up-sell recommendations with pagination
+     */
+    listUpSellProducts(options?: ListUpsellProductsQuery): Promise<ApiResult<ListUpsellProductsContent>>;
+    /**
+     * Retrieve related products for a specific product
+     *
+     * @param options - Optional query parameters
+     * @returns Promise with related products with pagination
      */
-    getProduct(productId: string): Promise<{
-        product: components["schemas"]["ProductDetail"];
-    }>;
+    listSimilarProducts(options?: ListSimilarProductsQuery): Promise<ApiResult<ListSimilarProductsContent>>;
 }