bc-api-client 0.2.1 → 1.0.0-beta.0

package/dist/client.d.ts

@@ -1,160 +0,0 @@
-import { Logger } from './core';
-import { RateLimitOptions, RequestOptions, StoreOptions, KyOptions } from './net';
-/**
- * Options for GET requests to the BigCommerce API
- */
-export type GetOptions = {
-    /** Query parameters to include in the request */
-    query?: Record<string, string>;
-    /** API version to use (v2 or v3) */
-    version?: 'v2' | 'v3';
-    /** Options to pass directly to ky */
-    kyOptions?: KyOptions;
-};
-/**
- * Options for POST/PUT requests to the BigCommerce API
- */
-export type PostOptions<T> = GetOptions & {
-    /** Request body data */
-    body: T;
-};
-/**
- * Options for controlling concurrent request behavior
- */
-export type ConcurrencyOptions = {
-    /** Maximum number of concurrent requests (default: 10) */
-    concurrency?: number;
-    /** Whether to skip errors and continue processing (default: false) */
-    skipErrors?: boolean;
-};
-/**
- * Options for querying multiple values against a single filter field
- */
-export type QueryOptions = Omit<GetOptions, 'version'> & ConcurrencyOptions & {
-    /** The field name to query against */
-    key: string;
-    /** Array of values to query for */
-    values: (string | number)[];
-} & {
-    /** Options to pass directly to ky */
-    kyOptions?: KyOptions;
-};
-/**
- * Configuration options for the BigCommerce client
- */
-export type Config = StoreOptions & RateLimitOptions & ConcurrencyOptions & {
-    /** Logger instance */
-    logger?: Logger;
-};
-/**
- * Client for interacting with the BigCommerce API
- *
- * This client provides methods for making HTTP requests to the BigCommerce API,
- * with support for both v2 and v3 endpoints, pagination, and concurrent requests.
- */
-export declare class BigCommerceClient {
-    private readonly config;
-    /**
-     * Creates a new BigCommerce client instance
-     * @param config - Configuration options for the client
-     * @param config.baseUrl - The base URL to use for the client (default: https://api.bigcommerce.com)
-     * @param config.storeHash - The store hash to use for the client
-     * @param config.accessToken - The API access token to use for the client
-     * @param config.maxRetries - The maximum number of retries for rate limit errors (default: 5)
-     * @param config.maxDelay - Maximum time to wait to retry in case of rate limit errors in milliseconds (default: 60000 - 1 minute). If `X-Rate-Limit-Time-Reset-Ms` header is higher than `maxDelay`, the request will fail immediately.
-     * @param config.concurrency - The default concurrency for concurrent methods (default: 10)
-     * @param config.skipErrors - Whether to skip errors during concurrent requests (default: false)
-     * @param config.logger - Optional logger instance for debugging and error tracking
-     */
-    constructor(config: Config);
-    /**
-     * Makes a GET request to the BigCommerce API
-     * @param endpoint - The API endpoint to request
-     * @param options.query - Query parameters to include in the request
-     * @param options.version - API version to use (v2 or v3) (default: v3)
-     * @returns Promise resolving to the response data of type `R`
-     */
-    get<R>(endpoint: string, options?: GetOptions): Promise<R>;
-    /**
-     * Makes a POST request to the BigCommerce API
-     * @param endpoint - The API endpoint to request
-     * @param options.query - Query parameters to include in the request
-     * @param options.version - API version to use (v2 or v3) (default: v3)
-     * @param options.body - Request body data of type `T`
-     * @returns Promise resolving to the response data of type `R`
-     */
-    post<T, R>(endpoint: string, options?: PostOptions<T>): Promise<R>;
-    /**
-     * Makes a PUT request to the BigCommerce API
-     * @param endpoint - The API endpoint to request
-     * @param options.query - Query parameters to include in the request
-     * @param options.version - API version to use (v2 or v3) (default: v3)
-     * @param options.body - Request body data of type `T`
-     * @returns Promise resolving to the response data of type `R`
-     */
-    put<T, R>(endpoint: string, options?: PostOptions<T>): Promise<R>;
-    /**
-     * Makes a DELETE request to the BigCommerce API
-     * @param endpoint - The API endpoint to delete
-     * @param options.version - API version to use (v2 or v3) (default: v3)
-     * @returns Promise resolving to void
-     */
-    delete<R>(endpoint: string, options?: Pick<GetOptions, 'version' | 'query'> & {
-        kyOptions?: KyOptions;
-    }): Promise<void>;
-    /**
-     * Executes multiple requests concurrently with controlled concurrency
-     * @param requests - Array of request options to execute
-     * @param options.concurrency - Maximum number of concurrent requests, overrides the client's concurrency setting (default: 10)
-     * @param options.skipErrors - Whether to skip errors and continue processing (the errors will be logged if logger is provided), overrides the client's skipErrors setting (default: false)
-     * @returns Promise resolving to array of response data
-     */
-    concurrent<T, R>(requests: RequestOptions<T>[], options?: ConcurrencyOptions): Promise<R[]>;
-    /**
-     * Lowest level concurrent request method.
-     * This method executes requests in chunks and returns bare PromiseSettledResult objects.
-     * Use this method if you need to handle errors in a custom way.
-     * @param requests - Array of request options to execute
-     * @param options.concurrency - Maximum number of concurrent requests, overrides the client's concurrency setting (default: 10)
-     * @returns Promise resolving to array of PromiseSettledResult containing both successful and failed requests
-     */
-    concurrentSettled<T, R>(requests: RequestOptions<T>[], options?: Pick<ConcurrencyOptions, 'concurrency'>): Promise<PromiseSettledResult<R>[]>;
-    /**
-     * Collects all pages of data from a paginated v3 API endpoint.
-     * This method pulls the first page and uses pagination meta to collect the remaining pages concurrently.
-     * @param endpoint - The API endpoint to request
-     * @param options.query - Query parameters to include in the request
-     * @param options.concurrency - Maximum number of concurrent requests, overrides the client's concurrency setting (default: 10)
-     * @param options.skipErrors - Whether to skip errors and continue processing (the errors will be logged if logger is provided), overrides the client's skipErrors setting (default: false)
-     * @returns Promise resolving to array of all items across all pages
-     */
-    collect<T>(endpoint: string, options?: Omit<GetOptions, 'version'> & ConcurrencyOptions & {
-        kyOptions?: KyOptions;
-    }): Promise<T[]>;
-    /**
-     * Collects all pages of data from a paginated v2 API endpoint.
-     * This method simply pulls all pages concurrently until a 204 is returned in a batch.
-     * @param endpoint - The API endpoint to request
-     * @param options.query - Query parameters to include in the request
-     * @param options.concurrency - Maximum number of concurrent requests, overrides the client's concurrency setting (default: 10)
-     * @param options.skipErrors - Whether to skip errors and continue processing (the errors will be logged if logger is provided), overrides the client's skipErrors setting (default: false)
-     * @returns Promise resolving to array of all items across all pages
-     */
-    collectV2<T>(endpoint: string, options?: Omit<GetOptions, 'version'> & ConcurrencyOptions & {
-        kyOptions?: KyOptions;
-    }): Promise<T[]>;
-    /**
-     * Queries multiple values against a single field using the v3 API.
-     * If the url + query params are too long, the query will be chunked. Otherwise, this method acts like `collect`.
-     * This method does not check for uniqueness of the `values` array.
-     *
-     * @param endpoint - The API endpoint to request
-     * @param options.key - The field name to query against e.g. `sku:in`
-     * @param options.values - Array of values to query for e.g. `['123', '456', ...]`
-     * @param options.query - Additional query parameters
-     * @param options.concurrency - Maximum number of concurrent requests, overrides the client's concurrency setting (default: 10)
-     * @param options.skipErrors - Whether to skip errors and continue processing (the errors will be logged if logger is provided), overrides the client's skipErrors setting (default: false)
-     * @returns Promise resolving to array of matching items
-     */
-    query<T>(endpoint: string, options: QueryOptions): Promise<T[]>;
-}

package/dist/core.d.ts

@@ -1,27 +0,0 @@
-export type Pagination = {
-    total: number;
-    count: number;
-    per_page: number;
-    current_page: number;
-    total_pages: number;
-    links: {
-        previous: string | null;
-        current: string;
-        next: string | null;
-    };
-};
-export type V3Resource<T> = {
-    data: T;
-    meta: {
-        pagination: Pagination;
-    };
-};
-/**
- * Logger interface for logging messages and data, Pino compatible by default
- */
-export interface Logger {
-    debug: (data: unknown, message?: string) => void;
-    info: (data: unknown, message?: string) => void;
-    warn: (data: unknown, message?: string) => void;
-    error: (data: unknown, message?: string) => void;
-}

package/dist/endpoints.d.ts

@@ -1,471 +0,0 @@
-export declare const customerSegmentation: {
-    segments: string;
-    shopperProfileSegments: (profileId: string) => string;
-    shopperProfiles: string;
-    segmentShopperProfiles: (segmentId: string) => string;
-};
-export declare const geography: {
-    v2: {
-        countries: {
-            path: string;
-            byId: (id: string) => string;
-            count: string;
-            states: {
-                path: (id: string) => string;
-                byId: (countryId: string, id: string) => string;
-                count: (countryId: string) => string;
-            };
-        };
-        states: {
-            path: string;
-            count: string;
-        };
-    };
-};
-export declare const bc: {
-    catalogSummary: string;
-    products: {
-        path: string;
-        byId: (id: number) => string;
-        batchPrices: string;
-        metafields: {
-            batch: string;
-            product: {
-                path: (productId: number) => string;
-                byId: (productId: number, id: number) => string;
-            };
-        };
-        bulkPricingRules: {
-            path: (productId: number) => string;
-            byId: (productId: number, id: number) => string;
-        };
-        categoryAssignments: string;
-        channelAssignments: string;
-        complexRules: {
-            path: (productId: number) => string;
-            byId: (productId: number, id: number) => string;
-        };
-        customFields: {
-            path: (productId: number) => string;
-            byId: (productId: number, id: number) => string;
-        };
-        images: {
-            path: (productId: number) => string;
-            byId: (productId: number, id: number) => string;
-        };
-        reviews: {
-            path: (productId: number) => string;
-            byId: (productId: number, id: number) => string;
-        };
-        videos: {
-            path: (productId: number) => string;
-            byId: (productId: number, id: number) => string;
-        };
-    };
-    modifiers: {
-        path: (productId: number) => string;
-        byId: (productId: number, id: number) => string;
-        values: {
-            path: (productId: number, modifierId: number) => string;
-            byId: (productId: number, modifierId: number, id: number) => string;
-            createImage: (productId: number, modifierId: number, id: number) => string;
-        };
-    };
-    variantOptions: {
-        path: (productId: number) => string;
-        byId: (productId: number, id: number) => string;
-        values: {
-            path: (productId: number, optionId: number) => string;
-            byId: (productId: number, optionId: number, id: number) => string;
-        };
-    };
-    variants: {
-        batch: string;
-        path: (productId: number) => string;
-        byId: (productId: number, id: number) => string;
-        createImage: (productId: number, id: number) => string;
-        metafields: {
-            batch: string;
-            path: (productId: number, id: number) => string;
-            byId: (productId: number, variantId: number, id: number) => string;
-        };
-    };
-    brands: {
-        path: string;
-        byId: (id: number) => string;
-        image: (id: number) => string;
-        metafields: {
-            batch: string;
-            path: (id: number) => string;
-            byId: (brandId: number, id: number) => string;
-        };
-    };
-    categories: {
-        deprecated: {
-            path: string;
-            byId: (id: number) => string;
-        };
-        image: (id: number) => string;
-        metafields: {
-            batch: string;
-            path: (id: number) => string;
-            byId: (categoryId: number, id: number) => string;
-        };
-        sortOrder: (id: number) => string;
-    };
-    trees: {
-        path: string;
-        byId: (id: number) => string;
-        categories: (id: number) => string;
-        allCategories: string;
-    };
-    abandonedCarts: {
-        path: (token: string) => string;
-        settings: {
-            global: string;
-            channel: (channelId: number) => string;
-        };
-    };
-    carts: {
-        path: string;
-        byId: (uuid: string) => string;
-        createRedirectUrl: (uuid: string) => string;
-        items: {
-            path: (uuid: string) => string;
-            byId: (cartUuid: string, itemUuid: string) => string;
-        };
-        metafields: {
-            batch: string;
-            path: (uuid: string) => string;
-            byId: (cartUuid: string, metafieldUuid: string) => string;
-        };
-        settings: {
-            global: string;
-            channel: (channelId: number) => string;
-        };
-    };
-    channels: {
-        path: string;
-        byId: (id: number) => string;
-        activeTheme: (id: number) => string;
-        site: (id: number) => string;
-        menus: (id: number) => string;
-        checkoutUrl: (id: number) => string;
-        currencyAssignments: {
-            path: (id: number) => string;
-            byId: (channelId: number, id: number) => string;
-        };
-        listings: {
-            path: (id: number) => string;
-            byId: (channelId: number, id: number) => string;
-        };
-        metafields: {
-            batch: string;
-            path: (id: number) => string;
-            byId: (channelId: number, id: number) => string;
-        };
-    };
-    checkouts: {
-        path: (uuid: string) => string;
-        billingAddress: (uuid: string) => string;
-        consignments: {
-            path: (uuid: string) => string;
-            byId: (checkoutUuid: string, consignmentUuid: string) => string;
-        };
-        coupons: {
-            add: (uuid: string) => string;
-            delete: (uuid: string, code: string) => string;
-        };
-        discounts: (uuid: string) => string;
-        fees: (uuid: string) => string;
-        createOrder: (uuid: string) => string;
-        settings: string;
-        createToken: (uuid: string) => string;
-    };
-    currencies: {
-        v2: {
-            path: string;
-            byId: (id: string) => string;
-        };
-    };
-    customers: {
-        path: string;
-        addresses: string;
-        attributes: string;
-        attributesValues: string;
-        settings: {
-            channel: (channelId: number) => string;
-            global: string;
-        };
-        consent: (id: number) => string;
-        formFieldValues: string;
-        storedInstruments: (id: number) => string;
-        validateCredentials: string;
-        metafields: {
-            batch: string;
-            path: (id: number) => string;
-            byId: (customerId: number, id: number) => string;
-        };
-        v2: {
-            groups: {
-                path: string;
-                byId: (id: number) => string;
-                count: string;
-            };
-            deprecated: {
-                path: string;
-                byId: (id: number) => string;
-                addresses: {
-                    path: (id: number) => string;
-                    byId: (customerId: number, id: number) => string;
-                };
-                validatePassword: (id: number) => string;
-            };
-        };
-        subscribers: {
-            path: string;
-            byId: (id: number) => string;
-        };
-    };
-    customerSegmentation: {
-        segments: string;
-        shopperProfileSegments: (profileId: string) => string;
-        shopperProfiles: string;
-        segmentShopperProfiles: (segmentId: string) => string;
-    };
-    geography: {
-        v2: {
-            countries: {
-                path: string;
-                byId: (id: string) => string;
-                count: string;
-                states: {
-                    path: (id: string) => string;
-                    byId: (countryId: string, id: string) => string;
-                    count: (countryId: string) => string;
-                };
-            };
-            states: {
-                path: string;
-                count: string;
-            };
-        };
-    };
-    inventory: {
-        adjustments: {
-            absolute: string;
-            relative: string;
-        };
-        items: {
-            path: string;
-            atLocation: (locationId: string) => string;
-            updateLocationSettings: (locationId: string) => string;
-        };
-    };
-    locations: {
-        path: string;
-        metafields: {
-            batch: string;
-            path: (id: string) => string;
-            byId: (locationId: string, id: string) => string;
-        };
-    };
-    orders: {
-        v2: {
-            path: string;
-            byId: (id: number) => string;
-            count: string;
-            consignments: {
-                path: (id: number) => string;
-                shippingQuotes: (orderId: number, consignmentId: number) => string;
-            };
-            coupons: (id: number) => string;
-            fees: (id: number) => string;
-            messages: (id: number) => string;
-            products: {
-                path: (id: number) => string;
-                byId: (orderId: number, id: number) => string;
-            };
-            shipments: {
-                path: (id: number) => string;
-                count: (id: number) => string;
-                byId: (orderId: number, id: number) => string;
-            };
-            shippingAddresses: {
-                path: (id: number) => string;
-                byId: (orderId: number, id: number) => string;
-                quotes: (orderId: number, id: number) => string;
-            };
-            statuses: {
-                path: string;
-                byId: (id: number) => string;
-            };
-            taxes: (id: number) => string;
-        };
-        transactions: (id: number) => string;
-        metafields: {
-            batch: string;
-            path: (id: number) => string;
-            byId: (orderId: number, id: number) => string;
-        };
-        settings: {
-            global: string;
-            channel: (channelId: number) => string;
-        };
-        payments: {
-            capture: (id: number) => string;
-            void: (id: number) => string;
-        };
-        refunds: {
-            path: string;
-            byId: (refundId: number) => string;
-            quote: (id: number) => string;
-            forOrder: (id: number) => string;
-        };
-        pickups: {
-            path: string;
-            methods: string;
-            options: string;
-        };
-    };
-    priceLists: {
-        path: string;
-        byId: (id: number) => string;
-        assignments: {
-            path: string;
-            byId: (id: number) => string;
-        };
-        records: {
-            path: string;
-            forList: (id: number) => string;
-            byVariant: (listId: number, variantId: number) => string;
-            byCurrency: (listId: number, variantId: number, currencyCode: string) => string;
-        };
-    };
-    promotions: {
-        path: string;
-        byId: (id: number) => string;
-        coupons: {
-            path: (promotionId: number) => string;
-            byId: (promotionId: number, id: number) => string;
-        };
-        settings: string;
-    };
-    redirects: {
-        path: string;
-        imexJobs: string;
-        createExportJob: string;
-        createImportJob: string;
-        exportEventStream: (jobUuid: string) => string;
-        importEventStream: (jobUuid: string) => string;
-        downloadExport: (jobUuid: string) => string;
-    };
-    scripts: {
-        path: string;
-        byId: (uuid: string) => string;
-    };
-    settings: {
-        analytics: {
-            providers: string;
-            provider: (providerId: string) => string;
-        };
-        catalog: string;
-        emailStatuses: string;
-        createFavicon: string;
-        inventory: {
-            path: string;
-            notifications: string;
-        };
-        logo: {
-            path: string;
-            image: string;
-        };
-        filters: {
-            enabled: string;
-            available: string;
-            contextual: string;
-        };
-        locale: string;
-        profile: string;
-        storefront: {
-            category: string;
-            product: string;
-            robotstxt: string;
-            search: string;
-            security: string;
-            seo: string;
-            status: string;
-            uom: string;
-        };
-    };
-    shipping: {
-        v2: {
-            carrierConnections: string;
-            methods: {
-                path: (zoneId: number) => string;
-                byId: (zoneId: number, id: number) => string;
-            };
-            zones: {
-                path: string;
-                byId: (id: number) => string;
-            };
-        };
-        customsInformation: string;
-        settings: {
-            global: string;
-            channel: (channelId: number) => string;
-        };
-    };
-    sites: {
-        path: string;
-        byId: (id: number) => string;
-        certificates: {
-            all: string;
-            forSite: (id: number) => string;
-        };
-        routes: {
-            path: (siteId: number) => string;
-            byId: (siteId: number, id: number) => string;
-        };
-    };
-    store: {
-        v2: {
-            info: string;
-            time: string;
-        };
-        metafields: {
-            batch: string;
-            path: (id: number) => string;
-            byId: (storeId: number, id: number) => string;
-        };
-        logs: string;
-    };
-    tax: {
-        v2: {
-            classes: {
-                path: string;
-                byId: (id: number) => string;
-            };
-        };
-        customers: string;
-        rates: string;
-        zones: string;
-        properties: string;
-        productProperties: string;
-        settings: string;
-    };
-    wishlists: {
-        path: string;
-        byId: (id: number) => string;
-        items: {
-            delete: (id: number, itemId: number) => string;
-            add: (id: number) => string;
-        };
-    };
-    webhooks: {
-        path: string;
-        byId: (id: number) => string;
-        admin: string;
-        upsertEmailNotifications: string;
-    };
-};