@commercengine/storefront-sdk 0.3.12 → 0.4.0

package/dist/lib/cart.js

@@ -1,302 +0,0 @@
-import { StorefrontAPIClient } from "./client";
-/**
- * Client for interacting with cart endpoints
- */
-export class CartClient extends StorefrontAPIClient {
-    /**
-     * Create a new cart
-     *
-     * @param payload - Object containing the items to add to the cart
-     * @returns Promise with the created cart
-     */
-    async createCart(payload) {
-        return this.executeRequest(() => this.client.POST("/carts", {
-            body: payload,
-        }));
-    }
-    /**
-     * Get cart details - either by ID or using the stored cart ID
-     *
-     * @param cartId - The ID of the cart
-     * @returns Promise with cart details
-     */
-    async getCart(cartId) {
-        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 - The ID of the cart
-     * @returns Promise that resolves when the cart is deleted
-     */
-    async deleteCart(cartId) {
-        return this.executeRequest(() => this.client.DELETE("/carts/{id}", {
-            params: {
-                path: cartId,
-            },
-        }));
-    }
-    /**
-     * Update cart items (add, update quantity, remove)
-     *
-     * @param cartId - The cart id
-     * @param body - The body of the request
-     * @returns Promise with updated cart
-     */
-    async addDeleteCartItem(cartId, body) {
-        return this.executeRequest(() => this.client.POST("/carts/{id}/items", {
-            params: {
-                path: cartId,
-            },
-            body: body,
-        }));
-    }
-    /**
-     * Get cart details by user ID
-     *
-     * @param userId - The ID of the user
-     * @returns Promise with cart details
-     */
-    async getUserCart(userId) {
-        return this.executeRequest(() => this.client.GET("/carts/users/{user_id}", {
-            params: {
-                path: userId,
-            },
-        }));
-    }
-    /**
-     * Delete a cart by user ID
-     *
-     * @param userId - The ID of the user
-     * @returns Promise that resolves when the cart is deleted
-     */
-    async deleteUserCart(userId) {
-        return this.executeRequest(() => this.client.DELETE("/carts/users/{user_id}", {
-            params: {
-                path: userId,
-            },
-            body: undefined,
-        }));
-    }
-    /**
-     * Update cart addresses
-     *
-     * @param cartId - The ID of the cart
-     * @param addressData - The address data
-     * @returns Promise with updated cart
-     */
-    async updateCartAddress(cartId, addressData) {
-        return this.executeRequest(() => this.client.POST("/carts/{id}/address", {
-            params: {
-                path: cartId,
-            },
-            body: addressData,
-        }));
-    }
-    /**
-     * Apply a coupon to the cart
-     *
-     * @param cartId - The ID of the cart
-     * @param couponCode - The coupon code
-     * @returns Promise with updated cart
-     */
-    async applyCoupon(cartId, couponCode) {
-        return this.executeRequest(() => this.client.POST("/carts/{id}/coupon", {
-            params: {
-                path: cartId,
-            },
-            body: couponCode,
-        }));
-    }
-    /**
-     * Remove a coupon from the cart
-     *
-     * @param cartId - The ID of the cart
-     * @returns Promise with updated cart
-     */
-    async removeCoupon(cartId) {
-        return this.executeRequest(() => this.client.DELETE("/carts/{id}/coupon", {
-            params: {
-                path: cartId,
-            },
-            body: undefined,
-        }));
-    }
-    /**
-     * Redeem loyalty points
-     *
-     * @param cartId - The ID of the cart
-     * @param points - The number of points to redeem
-     * @returns Promise with updated cart
-     */
-    async redeemLoyaltyPoints(cartId, points) {
-        return this.executeRequest(() => this.client.POST("/carts/{id}/loyalty-points", {
-            params: {
-                path: cartId,
-            },
-            body: points,
-        }));
-    }
-    /**
-     * Remove loyalty points
-     *
-     * @param cartId - The ID of the cart
-     * @returns Promise with updated cart
-     */
-    async removeLoyaltyPoints(cartId) {
-        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,
-        }));
-    }
-    /**
-     * Get all available coupons
-     *
-     * @param headers - Optional header parameters (customer_group_id, etc.)
-     * @returns Promise with all available coupons
-     */
-    async getAvailableCoupons(headers) {
-        const mergedHeaders = this.mergeHeaders(headers);
-        return this.executeRequest(() => this.client.GET("/carts/available-coupons", {
-            params: {
-                header: mergedHeaders,
-            },
-        }));
-    }
-    /**
-     * Get all available promotions
-     *
-     * @param headers - Optional header parameters (customer_group_id, etc.)
-     * @returns Promise with all available promotions
-     */
-    async getAvailablePromotions(headers) {
-        const mergedHeaders = this.mergeHeaders(headers);
-        return this.executeRequest(() => this.client.GET("/carts/available-promotions", {
-            params: {
-                header: mergedHeaders,
-            },
-        }));
-    }
-}

package/dist/lib/catalog.d.ts

@@ -1,101 +0,0 @@
-import { StorefrontAPIClient } from "./client";
-import type { ApiResult, GetProductDetailContent, GetProductDetailPathParams, GetProductDetailHeaderParams, GetVariantDetailContent, GetVariantDetailPathParams, GetVariantDetailHeaderParams, ListProductsContent, ListProductsQuery, ListProductsHeaderParams, ListProductVariantsContent, ListProductVariantsPathParams, ListProductVariantsHeaderParams, ListCategoriesQuery, ListCategoriesContent, ListProductReviewsQuery, ListProductReviewsPathParams, ListProductReviewsContent, CreateProductReviewPathParams, CreateProductReviewFormData, CreateProductReviewResponse, SearchProductsBody, SearchProductsContent, ListSkusQuery, ListSkusContent, ListSkusHeaderParams, ListCrosssellProductsContent, ListCrosssellProductsQuery, ListCrosssellProductsHeaderParams, ListUpsellProductsQuery, ListUpsellProductsContent, ListUpsellProductsHeaderParams, ListSimilarProductsQuery, ListSimilarProductsContent, ListSimilarProductsHeaderParams, SearchProductsHeaderParams } from "../types/storefront-api-types";
-/**
- * Client for interacting with catalog endpoints
- */
-export declare class CatalogClient extends StorefrontAPIClient {
-    /**
-     * List all products
-     *
-     * @param options - Optional query parameters
-     * @param headers - Optional header parameters (customer_group_id, etc.)
-     * @returns Promise with products and pagination info
-     */
-    listProducts(options?: ListProductsQuery, headers?: ListProductsHeaderParams): Promise<ApiResult<ListProductsContent>>;
-    /**
-     * List all skus
-     *
-     * @param options - Optional query parameters
-     * @param headers - Optional header parameters (customer_group_id, etc.)
-     * @returns Promise with skus and pagination info
-     */
-    listSkus(options?: ListSkusQuery, headers?: ListSkusHeaderParams): Promise<ApiResult<ListSkusContent>>;
-    /**
-     * Get details for a specific product
-     *
-     * @param pathParams - The path parameters (product ID or slug)
-     * @param headers - Optional header parameters (customer_group_id, etc.)
-     * @returns Promise with product details
-     */
-    getProductDetail(pathParams: GetProductDetailPathParams, headers?: GetProductDetailHeaderParams): Promise<ApiResult<GetProductDetailContent>>;
-    /**
-     * List variants for a specific product
-     *
-     * @param pathParams - The path parameters (product ID)
-     * @param headers - Optional header parameters (customer_group_id, etc.)
-     * @returns Promise with variants
-     */
-    listProductVariants(pathParams: ListProductVariantsPathParams, headers?: ListProductVariantsHeaderParams): Promise<ApiResult<ListProductVariantsContent>>;
-    /**
-     * Get details for a specific variant
-     *
-     * @param pathParams - The path parameters (product ID and variant ID)
-     * @param headers - Optional header parameters (customer_group_id, etc.)
-     * @returns Promise with variant details
-     */
-    getVariantDetail(pathParams: GetVariantDetailPathParams, headers?: GetVariantDetailHeaderParams): Promise<ApiResult<GetVariantDetailContent>>;
-    /**
-     * List all categories
-     *
-     * @param options - Optional query parameters
-     * @returns Promise with categories and pagination info
-     */
-    listCategories(options?: ListCategoriesQuery): Promise<ApiResult<ListCategoriesContent>>;
-    /**
-     * List reviews for a specific product
-     *
-     * @param pathParams - The path parameters (product ID)
-     * @param queryParams - Optional query parameters
-     * @returns Promise with reviews and pagination info
-     */
-    listProductReviews(pathParams: ListProductReviewsPathParams, queryParams?: ListProductReviewsQuery): Promise<ApiResult<ListProductReviewsContent>>;
-    /**
-     * Create a review for a specific product
-     *
-     * @param pathParams - The path parameters (product ID)
-     * @param formData - The review data
-     * @returns Promise that resolves when the review is created
-     */
-    createProductReview(pathParams: CreateProductReviewPathParams, formData: CreateProductReviewFormData): Promise<ApiResult<CreateProductReviewResponse>>;
-    /**
-     * Search for products
-     *
-     * @param searchData - The search parameters
-     * @returns Promise with search results, facet distribution, facet stats, and pagination
-     */
-    searchProducts(searchData: SearchProductsBody, headers?: SearchProductsHeaderParams): Promise<ApiResult<SearchProductsContent>>;
-    /**
-     * List cross-sell products
-     *
-     * @param options - Optional query parameters
-     * @param headers - Optional header parameters (customer_group_id, etc.)
-     * @returns Promise with cross-sell products
-     */
-    listCrossSellProducts(options?: ListCrosssellProductsQuery, headers?: ListCrosssellProductsHeaderParams): Promise<ApiResult<ListCrosssellProductsContent>>;
-    /**
-     * List up-sell products
-     *
-     * @param options - Optional query parameters
-     * @param headers - Optional header parameters (customer_group_id, etc.)
-     * @returns Promise with up-sell products
-     */
-    listUpSellProducts(options?: ListUpsellProductsQuery, headers?: ListUpsellProductsHeaderParams): Promise<ApiResult<ListUpsellProductsContent>>;
-    /**
-     * List similar products
-     *
-     * @param options - Optional query parameters
-     * @param headers - Optional header parameters (customer_group_id, etc.)
-     * @returns Promise with similar products
-     */
-    listSimilarProducts(options?: ListSimilarProductsQuery, headers?: ListSimilarProductsHeaderParams): Promise<ApiResult<ListSimilarProductsContent>>;
-}

package/dist/lib/catalog.js

@@ -1,204 +0,0 @@
-import { StorefrontAPIClient } from "./client";
-/**
- * Client for interacting with catalog endpoints
- */
-export class CatalogClient extends StorefrontAPIClient {
-    /**
-     * List all products
-     *
-     * @param options - Optional query parameters
-     * @param headers - Optional header parameters (customer_group_id, etc.)
-     * @returns Promise with products and pagination info
-     */
-    async listProducts(options, headers) {
-        const mergedHeaders = this.mergeHeaders(headers);
-        return this.executeRequest(() => this.client.GET("/catalog/products", {
-            params: {
-                query: options,
-                header: mergedHeaders,
-            },
-        }));
-    }
-    /**
-     * List all skus
-     *
-     * @param options - Optional query parameters
-     * @param headers - Optional header parameters (customer_group_id, etc.)
-     * @returns Promise with skus and pagination info
-     */
-    async listSkus(options, headers) {
-        const mergedHeaders = this.mergeHeaders(headers);
-        return this.executeRequest(() => this.client.GET("/catalog/skus", {
-            params: {
-                query: options,
-                header: mergedHeaders,
-            },
-        }));
-    }
-    /**
-     * Get details for a specific product
-     *
-     * @param pathParams - The path parameters (product ID or slug)
-     * @param headers - Optional header parameters (customer_group_id, etc.)
-     * @returns Promise with product details
-     */
-    async getProductDetail(pathParams, headers) {
-        const mergedHeaders = this.mergeHeaders(headers);
-        return this.executeRequest(() => this.client.GET("/catalog/products/{product_id_or_slug}", {
-            params: {
-                path: pathParams,
-                header: mergedHeaders,
-            },
-        }));
-    }
-    /**
-     * List variants for a specific product
-     *
-     * @param pathParams - The path parameters (product ID)
-     * @param headers - Optional header parameters (customer_group_id, etc.)
-     * @returns Promise with variants
-     */
-    async listProductVariants(pathParams, headers) {
-        const mergedHeaders = this.mergeHeaders(headers);
-        return this.executeRequest(() => this.client.GET("/catalog/products/{product_id}/variants", {
-            params: {
-                path: pathParams,
-                header: mergedHeaders,
-            },
-        }));
-    }
-    /**
-     * Get details for a specific variant
-     *
-     * @param pathParams - The path parameters (product ID and variant ID)
-     * @param headers - Optional header parameters (customer_group_id, etc.)
-     * @returns Promise with variant details
-     */
-    async getVariantDetail(pathParams, headers) {
-        const mergedHeaders = this.mergeHeaders(headers);
-        return this.executeRequest(() => this.client.GET("/catalog/products/{product_id}/variants/{variant_id}", {
-            params: {
-                path: pathParams,
-                header: mergedHeaders,
-            },
-        }));
-    }
-    /**
-     * List all categories
-     *
-     * @param options - Optional query parameters
-     * @returns Promise with categories and pagination info
-     */
-    async listCategories(options) {
-        return this.executeRequest(() => this.client.GET("/catalog/categories", {
-            params: { query: options },
-        }));
-    }
-    /**
-     * List reviews for a specific product
-     *
-     * @param pathParams - The path parameters (product ID)
-     * @param queryParams - Optional query parameters
-     * @returns Promise with reviews and pagination info
-     */
-    async listProductReviews(pathParams, queryParams) {
-        return this.executeRequest(() => this.client.GET("/catalog/products/{product_id}/reviews", {
-            params: {
-                path: pathParams,
-                query: queryParams,
-            },
-        }));
-    }
-    /**
-     * Create a review for a specific product
-     *
-     * @param pathParams - The path parameters (product ID)
-     * @param formData - The review data
-     * @returns Promise that resolves when the review is created
-     */
-    async createProductReview(pathParams, formData) {
-        return this.executeRequest(() => this.client.POST("/catalog/products/{product_id}/reviews", {
-            params: {
-                path: pathParams,
-            },
-            body: formData,
-            bodySerializer: (body) => {
-                const fd = new FormData();
-                for (const [key, value] of Object.entries(body)) {
-                    if (value !== undefined && value !== null) {
-                        // Handle File objects directly
-                        if (value instanceof File || value instanceof Blob) {
-                            fd.append(key, value);
-                        }
-                        else {
-                            // Convert other values to string
-                            fd.append(key, String(value));
-                        }
-                    }
-                }
-                return fd;
-            },
-        }));
-    }
-    /**
-     * Search for products
-     *
-     * @param searchData - The search parameters
-     * @returns Promise with search results, facet distribution, facet stats, and pagination
-     */
-    async searchProducts(searchData, headers) {
-        const mergedHeaders = this.mergeHeaders(headers);
-        return this.executeRequest(() => this.client.POST("/catalog/products/search", {
-            body: searchData,
-            header: mergedHeaders,
-        }));
-    }
-    /**
-     * List cross-sell products
-     *
-     * @param options - Optional query parameters
-     * @param headers - Optional header parameters (customer_group_id, etc.)
-     * @returns Promise with cross-sell products
-     */
-    async listCrossSellProducts(options, headers) {
-        const mergedHeaders = this.mergeHeaders(headers);
-        return this.executeRequest(() => this.client.GET("/catalog/products/cross-sell", {
-            params: {
-                query: options,
-                header: mergedHeaders,
-            },
-        }));
-    }
-    /**
-     * List up-sell products
-     *
-     * @param options - Optional query parameters
-     * @param headers - Optional header parameters (customer_group_id, etc.)
-     * @returns Promise with up-sell products
-     */
-    async listUpSellProducts(options, headers) {
-        const mergedHeaders = this.mergeHeaders(headers);
-        return this.executeRequest(() => this.client.GET("/catalog/products/up-sell", {
-            params: {
-                query: options,
-                header: mergedHeaders,
-            },
-        }));
-    }
-    /**
-     * List similar products
-     *
-     * @param options - Optional query parameters
-     * @param headers - Optional header parameters (customer_group_id, etc.)
-     * @returns Promise with similar products
-     */
-    async listSimilarProducts(options, headers) {
-        const mergedHeaders = this.mergeHeaders(headers);
-        return this.executeRequest(() => this.client.GET("/catalog/products/similar", {
-            params: {
-                query: options,
-                header: mergedHeaders,
-            },
-        }));
-    }
-}