@spree/sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,389 @@
+import { LoginCredentials, AuthTokens, RegisterParams, StoreStore, ProductListParams, PaginatedResponse, StoreProduct, ProductFiltersParams, ProductFiltersResponse, ListParams, StoreTaxonomy, TaxonListParams, StoreTaxon, StoreCountry, StoreOrder, OrderListParams, UpdateOrderParams, AddLineItemParams, StoreLineItem, UpdateLineItemParams, StorePayment, StorePaymentMethod, StoreShipment, StoreUser, StoreAddress, AddressParams, StoreCreditCard, StoreGiftCard, StoreWishlist, StoreWishedItem, ErrorResponse } from './types/index.js';
+export { AdminMetafield, AdminOrder, AdminPrice, AdminProduct, AdminTaxon, AdminTaxonomy, AdminUser, AdminVariant, AvailabilityFilter, FilterOption, OptionFilter, OptionFilterOption, PaginationMeta, PriceRangeFilter, ProductFilter, SortOption, StoreBase, StoreDigitalLink, StoreImage, StoreMetafield, StoreOptionType, StoreOptionValue, StoreOrderPromotion, StorePrice, StoreShippingMethod, StoreShippingRate, StoreState, StoreStockLocation, StoreVariant, TaxonFilter, TaxonFilterOption } from './types/index.js';
+
+interface SpreeClientConfig {
+    /** Base URL of the Spree API (e.g., 'https://api.mystore.com') */
+    baseUrl: string;
+    /** Publishable API key for store access */
+    apiKey: string;
+    /** Custom fetch implementation (optional, defaults to global fetch) */
+    fetch?: typeof fetch;
+}
+interface RequestOptions {
+    /** Bearer token for authenticated requests */
+    token?: string;
+    /** Order token for guest checkout */
+    orderToken?: string;
+    /** Locale for translated content (e.g., 'en', 'fr') */
+    locale?: string;
+    /** Currency for prices (e.g., 'USD', 'EUR') */
+    currency?: string;
+    /** Custom headers */
+    headers?: Record<string, string>;
+}
+declare class SpreeError extends Error {
+    readonly code: string;
+    readonly status: number;
+    readonly details?: Record<string, string[]>;
+    constructor(response: ErrorResponse, status: number);
+}
+declare class SpreeClient {
+    private readonly baseUrl;
+    private readonly apiKey;
+    private readonly fetchFn;
+    constructor(config: SpreeClientConfig);
+    private request;
+    readonly auth: {
+        /**
+         * Login with email and password
+         */
+        login: (credentials: LoginCredentials) => Promise<AuthTokens>;
+        /**
+         * Register a new customer account
+         */
+        register: (params: RegisterParams) => Promise<AuthTokens>;
+        /**
+         * Refresh access token (requires valid Bearer token)
+         */
+        refresh: (options: RequestOptions) => Promise<AuthTokens>;
+    };
+    readonly store: {
+        /**
+         * Get current store information
+         */
+        get: (options?: RequestOptions) => Promise<StoreStore>;
+    };
+    readonly products: {
+        /**
+         * List products
+         */
+        list: (params?: ProductListParams, options?: RequestOptions) => Promise<PaginatedResponse<StoreProduct>>;
+        /**
+         * Get a product by ID or slug
+         */
+        get: (idOrSlug: string, params?: {
+            includes?: string;
+        }, options?: RequestOptions) => Promise<StoreProduct>;
+        /**
+         * Get available filters for products
+         * Returns filter options (price range, availability, option types, taxons) with counts
+         */
+        filters: (params?: ProductFiltersParams, options?: RequestOptions) => Promise<ProductFiltersResponse>;
+    };
+    readonly taxonomies: {
+        /**
+         * List taxonomies
+         */
+        list: (params?: ListParams, options?: RequestOptions) => Promise<PaginatedResponse<StoreTaxonomy>>;
+        /**
+         * Get a taxonomy by ID
+         */
+        get: (id: string, params?: {
+            includes?: string;
+        }, options?: RequestOptions) => Promise<StoreTaxonomy>;
+    };
+    readonly taxons: {
+        /**
+         * List taxons
+         */
+        list: (params?: TaxonListParams, options?: RequestOptions) => Promise<PaginatedResponse<StoreTaxon>>;
+        /**
+         * Get a taxon by ID or permalink
+         */
+        get: (idOrPermalink: string, params?: {
+            includes?: string;
+        }, options?: RequestOptions) => Promise<StoreTaxon>;
+        /**
+         * Nested resource: Products in a taxon
+         */
+        products: {
+            /**
+             * List products in a taxon
+             * @param taxonId - Taxon ID (prefix_id) or permalink
+             */
+            list: (taxonId: string, params?: ProductListParams, options?: RequestOptions) => Promise<PaginatedResponse<StoreProduct>>;
+        };
+    };
+    readonly countries: {
+        /**
+         * List countries available for checkout
+         * Returns countries from the store's checkout zone without states
+         */
+        list: (options?: RequestOptions) => Promise<{
+            data: StoreCountry[];
+        }>;
+        /**
+         * Get a country by ISO code with states
+         * @param iso - ISO 3166-1 alpha-2 code (e.g., "US", "DE")
+         */
+        get: (iso: string, options?: RequestOptions) => Promise<StoreCountry>;
+    };
+    readonly cart: {
+        /**
+         * Get current cart (returns null if none exists)
+         * Pass orderToken for guest checkout, or use JWT for authenticated users
+         */
+        get: (options?: RequestOptions) => Promise<StoreOrder & {
+            token: string;
+        }>;
+        /**
+         * Create a new cart (alias for orders.create)
+         */
+        create: (options?: RequestOptions) => Promise<StoreOrder & {
+            token: string;
+        }>;
+        /**
+         * Associate a guest cart with the currently authenticated user
+         * Requires both JWT token (for authentication) and orderToken (to identify the cart)
+         * @param options - Must include both `token` (JWT) and `orderToken` (guest cart token)
+         */
+        associate: (options: RequestOptions) => Promise<StoreOrder & {
+            token: string;
+        }>;
+    };
+    readonly orders: {
+        /**
+         * List orders for the authenticated customer
+         */
+        list: (params?: OrderListParams, options?: RequestOptions) => Promise<PaginatedResponse<StoreOrder>>;
+        /**
+         * Create a new order (cart)
+         */
+        create: (options?: RequestOptions) => Promise<StoreOrder & {
+            order_token: string;
+        }>;
+        /**
+         * Get an order by ID or number
+         */
+        get: (idOrNumber: string, params?: {
+            includes?: string;
+        }, options?: RequestOptions) => Promise<StoreOrder>;
+        /**
+         * Update an order
+         */
+        update: (idOrNumber: string, params: UpdateOrderParams, options?: RequestOptions) => Promise<StoreOrder>;
+        /**
+         * Advance order to next checkout step
+         */
+        next: (idOrNumber: string, options?: RequestOptions) => Promise<StoreOrder>;
+        /**
+         * Advance through all checkout steps
+         */
+        advance: (idOrNumber: string, options?: RequestOptions) => Promise<StoreOrder>;
+        /**
+         * Complete the order
+         */
+        complete: (idOrNumber: string, options?: RequestOptions) => Promise<StoreOrder>;
+        /**
+         * Add store credit to order
+         */
+        addStoreCredit: (idOrNumber: string, amount?: number, options?: RequestOptions) => Promise<StoreOrder>;
+        /**
+         * Remove store credit from order
+         */
+        removeStoreCredit: (idOrNumber: string, options?: RequestOptions) => Promise<StoreOrder>;
+        /**
+         * Nested resource: Line items
+         */
+        lineItems: {
+            /**
+             * Add a line item to an order
+             */
+            create: (orderId: string, params: AddLineItemParams, options?: RequestOptions) => Promise<StoreLineItem>;
+            /**
+             * Update a line item
+             */
+            update: (orderId: string, lineItemId: string, params: UpdateLineItemParams, options?: RequestOptions) => Promise<StoreLineItem>;
+            /**
+             * Remove a line item from an order
+             */
+            delete: (orderId: string, lineItemId: string, options?: RequestOptions) => Promise<void>;
+        };
+        /**
+         * Nested resource: Payments
+         */
+        payments: {
+            /**
+             * List payments for an order
+             */
+            list: (orderId: string, options?: RequestOptions) => Promise<{
+                data: StorePayment[];
+                meta: object;
+            }>;
+            /**
+             * Get a payment by ID
+             */
+            get: (orderId: string, paymentId: string, options?: RequestOptions) => Promise<StorePayment>;
+        };
+        /**
+         * Nested resource: Payment methods
+         */
+        paymentMethods: {
+            /**
+             * List available payment methods for an order
+             */
+            list: (orderId: string, options?: RequestOptions) => Promise<PaginatedResponse<StorePaymentMethod>>;
+        };
+        /**
+         * Nested resource: Coupon codes
+         */
+        couponCodes: {
+            /**
+             * Apply a coupon code to an order
+             */
+            apply: (orderId: string, code: string, options?: RequestOptions) => Promise<StoreOrder>;
+            /**
+             * Remove a coupon code from an order
+             * @param promotionId - The promotion prefix_id (e.g., 'promo_xxx')
+             */
+            remove: (orderId: string, promotionId: string, options?: RequestOptions) => Promise<StoreOrder>;
+        };
+        /**
+         * Nested resource: Shipments
+         */
+        shipments: {
+            /**
+             * List shipments for an order
+             */
+            list: (orderId: string, options?: RequestOptions) => Promise<{
+                data: StoreShipment[];
+            }>;
+            /**
+             * Update a shipment (e.g., select shipping rate)
+             */
+            update: (orderId: string, shipmentId: string, params: {
+                selected_shipping_rate_id: string;
+            }, options?: RequestOptions) => Promise<StoreShipment>;
+        };
+    };
+    readonly customer: {
+        /**
+         * Get current customer profile
+         */
+        get: (options?: RequestOptions) => Promise<StoreUser>;
+        /**
+         * Update current customer profile
+         */
+        update: (params: {
+            first_name?: string;
+            last_name?: string;
+            email?: string;
+        }, options?: RequestOptions) => Promise<StoreUser>;
+        /**
+         * Nested resource: Addresses
+         */
+        addresses: {
+            /**
+             * List customer addresses
+             */
+            list: (params?: ListParams, options?: RequestOptions) => Promise<PaginatedResponse<StoreAddress>>;
+            /**
+             * Get an address by ID
+             */
+            get: (id: string, options?: RequestOptions) => Promise<StoreAddress>;
+            /**
+             * Create an address
+             */
+            create: (params: AddressParams, options?: RequestOptions) => Promise<StoreAddress>;
+            /**
+             * Update an address
+             */
+            update: (id: string, params: Partial<AddressParams>, options?: RequestOptions) => Promise<StoreAddress>;
+            /**
+             * Delete an address
+             */
+            delete: (id: string, options?: RequestOptions) => Promise<void>;
+        };
+        /**
+         * Nested resource: Credit Cards
+         */
+        creditCards: {
+            /**
+             * List customer credit cards
+             */
+            list: (params?: ListParams, options?: RequestOptions) => Promise<PaginatedResponse<StoreCreditCard>>;
+            /**
+             * Get a credit card by ID
+             */
+            get: (id: string, options?: RequestOptions) => Promise<StoreCreditCard>;
+            /**
+             * Delete a credit card
+             */
+            delete: (id: string, options?: RequestOptions) => Promise<void>;
+        };
+        /**
+         * Nested resource: Gift Cards
+         */
+        giftCards: {
+            /**
+             * List customer gift cards
+             * Returns gift cards associated with the current user, ordered by newest first
+             */
+            list: (params?: ListParams, options?: RequestOptions) => Promise<PaginatedResponse<StoreGiftCard>>;
+            /**
+             * Get a gift card by ID
+             */
+            get: (id: string, options?: RequestOptions) => Promise<StoreGiftCard>;
+        };
+    };
+    readonly wishlists: {
+        /**
+         * List wishlists
+         */
+        list: (params?: ListParams, options?: RequestOptions) => Promise<PaginatedResponse<StoreWishlist>>;
+        /**
+         * Get a wishlist by ID
+         */
+        get: (id: string, params?: {
+            includes?: string;
+        }, options?: RequestOptions) => Promise<StoreWishlist>;
+        /**
+         * Create a wishlist
+         */
+        create: (params: {
+            name: string;
+            is_private?: boolean;
+            is_default?: boolean;
+        }, options?: RequestOptions) => Promise<StoreWishlist>;
+        /**
+         * Update a wishlist
+         */
+        update: (id: string, params: {
+            name?: string;
+            is_private?: boolean;
+            is_default?: boolean;
+        }, options?: RequestOptions) => Promise<StoreWishlist>;
+        /**
+         * Delete a wishlist
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<void>;
+        /**
+         * Nested resource: Wishlist items
+         */
+        items: {
+            /**
+             * Add an item to a wishlist
+             */
+            create: (wishlistId: string, params: {
+                variant_id: string;
+                quantity?: number;
+            }, options?: RequestOptions) => Promise<StoreWishedItem>;
+            /**
+             * Update a wishlist item
+             */
+            update: (wishlistId: string, itemId: string, params: {
+                quantity: number;
+            }, options?: RequestOptions) => Promise<StoreWishedItem>;
+            /**
+             * Remove an item from a wishlist
+             */
+            delete: (wishlistId: string, itemId: string, options?: RequestOptions) => Promise<void>;
+        };
+    };
+}
+/**
+ * Create a new Spree SDK client
+ */
+declare function createSpreeClient(config: SpreeClientConfig): SpreeClient;
+
+export { AddLineItemParams, AddressParams, AuthTokens, ErrorResponse, ListParams, LoginCredentials, OrderListParams, PaginatedResponse, ProductFiltersParams, ProductFiltersResponse, ProductListParams, RegisterParams, type RequestOptions, SpreeClient, type SpreeClientConfig, SpreeError, StoreAddress, StoreCountry, StoreCreditCard, StoreGiftCard, StoreLineItem, StoreOrder, StorePayment, StorePaymentMethod, StoreProduct, StoreShipment, StoreStore, StoreTaxon, StoreTaxonomy, StoreUser, StoreWishedItem, StoreWishlist, TaxonListParams, UpdateLineItemParams, UpdateOrderParams, createSpreeClient };