@commercelayer/sdk 6.0.0-alfa.4 → 6.0.0-alfa.6

package/lib/esm/client.js

@@ -1,9 +1,6 @@
-import axios from 'axios';
 import { SdkError, handleError } from './error';
 import config from './config';
-// import type { Agent as HttpAgent } from 'http'
-// import type { Agent as HttpsAgent } from 'https'
-// import { packageInfo } from './util'
+import { fetchURL } from './fetch';
 import Debug from './debug';
 const debug = Debug('client');
 const baseURL = (organization, domain) => {
@@ -16,114 +13,81 @@ class ApiClient {
                 throw new SdkError({ message: `Undefined '${attr}' parameter` });
         return new ApiClient(options);
     }
-    baseUrl;
+    #baseUrl;
     #accessToken;
-    #client;
-    interceptors;
+    #clientConfig;
+    #interceptors;
     constructor(options) {
         debug('new client instance %O', options);
-        this.baseUrl = baseURL(options.organization, options.domain);
+        this.#baseUrl = baseURL(options.organization, options.domain);
         this.#accessToken = options.accessToken;
-        const axiosConfig = {
+        const fetchConfig = {
             timeout: options.timeout || config.client.timeout,
-            proxy: options.proxy,
-            httpAgent: options.httpAgent,
-            httpsAgent: options.httpsAgent
         };
-        // Set custom headers
         const customHeaders = this.customHeaders(options.headers);
-        // Set headers
         const headers = {
             ...customHeaders,
             'Accept': 'application/vnd.api+json',
             'Content-Type': 'application/vnd.api+json',
             'Authorization': 'Bearer ' + this.#accessToken
         };
-        // Set User-Agent
-        let userAgent = options.userAgent; // || `SDK-core axios/${axios.VERSION}`
-        if (userAgent) {
-            if (!userAgent.includes('axios/'))
-                userAgent += ` axios/${axios.VERSION}`;
+        const userAgent = options.userAgent;
+        if (userAgent)
             headers['User-Agent'] = userAgent;
-        }
-        const axiosOptions = {
-            baseURL: this.baseUrl,
-            timeout: config.client.timeout,
-            headers,
-            ...axiosConfig
-        };
-        if (options.adapter)
-            axiosOptions.adapter = options.adapter;
-        debug('axios options: %O', axiosOptions);
-        this.#client = axios.create(axiosOptions);
-        this.interceptors = this.#client.interceptors;
+        fetchConfig.headers = headers;
+        this.#clientConfig = fetchConfig;
+        debug('fetch config: %O', fetchConfig);
+        this.#interceptors = {};
+    }
+    get interceptors() { return this.#interceptors; }
+    get requestHeaders() {
+        if (!this.#clientConfig.headers)
+            this.#clientConfig.headers = {};
+        return this.#clientConfig.headers;
     }
     config(config) {
         debug('config %o', config);
-        const def = this.#client.defaults;
-        // Axios config
+        const def = this.#clientConfig;
+        if (!def.headers)
+            def.headers = {};
         if (config.timeout)
             def.timeout = config.timeout;
-        if (config.proxy)
-            def.proxy = config.proxy;
-        if (config.httpAgent)
-            def.httpAgent = config.httpAgent;
-        if (config.httpsAgent)
-            def.httpsAgent = config.httpsAgent;
-        if (config.adapter)
-            this.adapter(config.adapter);
         if (config.userAgent)
             this.userAgent(config.userAgent);
-        // API Client config
         if (config.organization)
-            this.baseUrl = baseURL(config.organization, config.domain);
+            this.#baseUrl = baseURL(config.organization, config.domain);
         if (config.accessToken) {
             this.#accessToken = config.accessToken;
-            def.headers.common.Authorization = 'Bearer ' + this.#accessToken;
+            def.headers.Authorization = 'Bearer ' + this.#accessToken;
         }
         if (config.headers)
-            def.headers.common = this.customHeaders(config.headers);
+            def.headers = { ...def.headers, ...this.customHeaders(config.headers) };
         return this;
     }
     userAgent(userAgent) {
-        if (userAgent) {
-            let ua = userAgent;
-            if (!ua.includes('axios/')) {
-                // const axiosVer = packageInfo(['dependencies.axios'], { nestedName: true })
-                if (axios.VERSION)
-                    ua += ` axios/${axios.VERSION}`;
-            }
-            this.#client.defaults.headers['User-Agent'] = ua;
-        }
-        return this;
-    }
-    adapter(adapter) {
-        if (adapter)
-            this.#client.defaults.adapter = adapter;
+        if (userAgent)
+            this.requestHeaders['User-Agent'] = userAgent;
         return this;
     }
     async request(method, path, body, options) {
         debug('request %s %s, %O, %O', method, path, body || {}, options || {});
-        // Ignored params alerts (in debug mode)
-        if (options?.adapter)
-            debug('Adapter ignored in request config');
         if (options?.userAgent)
             debug('User-Agent header ignored in request config');
-        const data = body ? { data: body } : undefined;
-        const url = path;
-        // Runtime request parameters
-        const baseUrl = options?.organization ? baseURL(options.organization, options.domain) : undefined;
+        const baseUrl = options?.organization ? baseURL(options.organization, options.domain) : this.#baseUrl;
+        const url = new URL(`${baseUrl}/${path}`);
+        const bodyData = body ? JSON.stringify({ data: body }) : undefined;
+        const headers = { ...this.requestHeaders, ...this.customHeaders(options?.headers) };
         const accessToken = options?.accessToken || this.#accessToken;
-        const headers = this.customHeaders(options?.headers);
         if (accessToken)
             headers.Authorization = 'Bearer ' + accessToken;
-        const requestParams = { method, baseURL: baseUrl, url, data, ...options, headers };
-        debug('request params: %O', requestParams);
-        // const start = Date.now()
-        return this.#client.request(requestParams)
-            .then(response => response.data)
+        const fetchOptions = { method, body: bodyData, headers };
+        const timeout = options?.timeout || this.#clientConfig.timeout;
+        if (timeout)
+            fetchOptions.signal = AbortSignal.timeout(timeout);
+        if (options?.params)
+            Object.entries(options?.params).forEach(([name, value]) => { url.searchParams.append(name, String(value)); });
+        return await fetchURL(url, fetchOptions, this.interceptors)
             .catch((error) => handleError(error));
-        // .finally(() => console.log(`<<-- ${method} ${path} ${Date.now() - start}`))
     }
     customHeaders(headers) {
         const customHeaders = {};

package/lib/esm/commercelayer.d.ts

@@ -10,142 +10,143 @@ type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
 declare class CommerceLayerClient {
     #private;
     readonly openApiSchemaVersion = "5.1.0";
-    addresses: api.Addresses;
-    adjustments: api.Adjustments;
-    adyen_gateways: api.AdyenGateways;
-    adyen_payments: api.AdyenPayments;
-    application: api.Applications;
-    attachments: api.Attachments;
-    authorizations: api.Authorizations;
-    avalara_accounts: api.AvalaraAccounts;
-    axerve_gateways: api.AxerveGateways;
-    axerve_payments: api.AxervePayments;
-    billing_info_validation_rules: api.BillingInfoValidationRules;
-    bing_geocoders: api.BingGeocoders;
-    braintree_gateways: api.BraintreeGateways;
-    braintree_payments: api.BraintreePayments;
-    bundles: api.Bundles;
-    buy_x_pay_y_promotions: api.BuyXPayYPromotions;
-    captures: api.Captures;
-    carrier_accounts: api.CarrierAccounts;
-    checkout_com_gateways: api.CheckoutComGateways;
-    checkout_com_payments: api.CheckoutComPayments;
-    cleanups: api.Cleanups;
-    coupon_codes_promotion_rules: api.CouponCodesPromotionRules;
-    coupon_recipients: api.CouponRecipients;
-    coupons: api.Coupons;
-    custom_promotion_rules: api.CustomPromotionRules;
-    customer_addresses: api.CustomerAddresses;
-    customer_groups: api.CustomerGroups;
-    customer_password_resets: api.CustomerPasswordResets;
-    customer_payment_sources: api.CustomerPaymentSources;
-    customer_subscriptions: api.CustomerSubscriptions;
-    customers: api.Customers;
-    delivery_lead_times: api.DeliveryLeadTimes;
-    event_callbacks: api.EventCallbacks;
-    events: api.Events;
-    exports: api.Exports;
-    external_gateways: api.ExternalGateways;
-    external_payments: api.ExternalPayments;
-    external_promotions: api.ExternalPromotions;
-    external_tax_calculators: api.ExternalTaxCalculators;
-    fixed_amount_promotions: api.FixedAmountPromotions;
-    fixed_price_promotions: api.FixedPricePromotions;
-    free_gift_promotions: api.FreeGiftPromotions;
-    free_shipping_promotions: api.FreeShippingPromotions;
-    geocoders: api.Geocoders;
-    gift_card_recipients: api.GiftCardRecipients;
-    gift_cards: api.GiftCards;
-    google_geocoders: api.GoogleGeocoders;
-    imports: api.Imports;
-    in_stock_subscriptions: api.InStockSubscriptions;
-    inventory_models: api.InventoryModels;
-    inventory_return_locations: api.InventoryReturnLocations;
-    inventory_stock_locations: api.InventoryStockLocations;
-    klarna_gateways: api.KlarnaGateways;
-    klarna_payments: api.KlarnaPayments;
-    line_item_options: api.LineItemOptions;
-    line_items: api.LineItems;
-    manual_gateways: api.ManualGateways;
-    manual_tax_calculators: api.ManualTaxCalculators;
-    markets: api.Markets;
-    merchants: api.Merchants;
-    order_amount_promotion_rules: api.OrderAmountPromotionRules;
-    order_copies: api.OrderCopies;
-    order_factories: api.OrderFactories;
-    order_subscription_items: api.OrderSubscriptionItems;
-    order_subscriptions: api.OrderSubscriptions;
-    order_validation_rules: api.OrderValidationRules;
-    orders: api.Orders;
-    organization: api.Organizations;
-    packages: api.Packages;
-    parcel_line_items: api.ParcelLineItems;
-    parcels: api.Parcels;
-    payment_gateways: api.PaymentGateways;
-    payment_methods: api.PaymentMethods;
-    payment_options: api.PaymentOptions;
-    paypal_gateways: api.PaypalGateways;
-    paypal_payments: api.PaypalPayments;
-    percentage_discount_promotions: api.PercentageDiscountPromotions;
-    price_frequency_tiers: api.PriceFrequencyTiers;
-    price_lists: api.PriceLists;
-    price_tiers: api.PriceTiers;
-    price_volume_tiers: api.PriceVolumeTiers;
-    prices: api.Prices;
-    promotion_rules: api.PromotionRules;
-    promotions: api.Promotions;
-    recurring_order_copies: api.RecurringOrderCopies;
-    refunds: api.Refunds;
-    reserved_stocks: api.ReservedStocks;
-    resource_errors: api.ResourceErrors;
-    return_line_items: api.ReturnLineItems;
-    returns: api.Returns;
-    satispay_gateways: api.SatispayGateways;
-    satispay_payments: api.SatispayPayments;
-    shipments: api.Shipments;
-    shipping_categories: api.ShippingCategories;
-    shipping_method_tiers: api.ShippingMethodTiers;
-    shipping_methods: api.ShippingMethods;
-    shipping_weight_tiers: api.ShippingWeightTiers;
-    shipping_zones: api.ShippingZones;
-    sku_list_items: api.SkuListItems;
-    sku_list_promotion_rules: api.SkuListPromotionRules;
-    sku_lists: api.SkuLists;
-    sku_options: api.SkuOptions;
-    skus: api.Skus;
-    stock_items: api.StockItems;
-    stock_line_items: api.StockLineItems;
-    stock_locations: api.StockLocations;
-    stock_reservations: api.StockReservations;
-    stock_transfers: api.StockTransfers;
-    stripe_gateways: api.StripeGateways;
-    stripe_payments: api.StripePayments;
-    subscription_models: api.SubscriptionModels;
-    tags: api.Tags;
-    tax_calculators: api.TaxCalculators;
-    tax_categories: api.TaxCategories;
-    tax_rules: api.TaxRules;
-    taxjar_accounts: api.TaxjarAccounts;
-    transactions: api.Transactions;
-    versions: api.Versions;
-    voids: api.Voids;
-    webhooks: api.Webhooks;
-    wire_transfers: api.WireTransfers;
     constructor(config: CommerceLayerInitConfig);
+    get addresses(): api.Addresses;
+    get adjustments(): api.Adjustments;
+    get adyen_gateways(): api.AdyenGateways;
+    get adyen_payments(): api.AdyenPayments;
+    get application(): api.Applications;
+    get attachments(): api.Attachments;
+    get authorizations(): api.Authorizations;
+    get avalara_accounts(): api.AvalaraAccounts;
+    get axerve_gateways(): api.AxerveGateways;
+    get axerve_payments(): api.AxervePayments;
+    get billing_info_validation_rules(): api.BillingInfoValidationRules;
+    get bing_geocoders(): api.BingGeocoders;
+    get braintree_gateways(): api.BraintreeGateways;
+    get braintree_payments(): api.BraintreePayments;
+    get bundles(): api.Bundles;
+    get buy_x_pay_y_promotions(): api.BuyXPayYPromotions;
+    get captures(): api.Captures;
+    get carrier_accounts(): api.CarrierAccounts;
+    get checkout_com_gateways(): api.CheckoutComGateways;
+    get checkout_com_payments(): api.CheckoutComPayments;
+    get cleanups(): api.Cleanups;
+    get coupon_codes_promotion_rules(): api.CouponCodesPromotionRules;
+    get coupon_recipients(): api.CouponRecipients;
+    get coupons(): api.Coupons;
+    get custom_promotion_rules(): api.CustomPromotionRules;
+    get customer_addresses(): api.CustomerAddresses;
+    get customer_groups(): api.CustomerGroups;
+    get customer_password_resets(): api.CustomerPasswordResets;
+    get customer_payment_sources(): api.CustomerPaymentSources;
+    get customer_subscriptions(): api.CustomerSubscriptions;
+    get customers(): api.Customers;
+    get delivery_lead_times(): api.DeliveryLeadTimes;
+    get event_callbacks(): api.EventCallbacks;
+    get events(): api.Events;
+    get exports(): api.Exports;
+    get external_gateways(): api.ExternalGateways;
+    get external_payments(): api.ExternalPayments;
+    get external_promotions(): api.ExternalPromotions;
+    get external_tax_calculators(): api.ExternalTaxCalculators;
+    get fixed_amount_promotions(): api.FixedAmountPromotions;
+    get fixed_price_promotions(): api.FixedPricePromotions;
+    get free_gift_promotions(): api.FreeGiftPromotions;
+    get free_shipping_promotions(): api.FreeShippingPromotions;
+    get geocoders(): api.Geocoders;
+    get gift_card_recipients(): api.GiftCardRecipients;
+    get gift_cards(): api.GiftCards;
+    get google_geocoders(): api.GoogleGeocoders;
+    get imports(): api.Imports;
+    get in_stock_subscriptions(): api.InStockSubscriptions;
+    get inventory_models(): api.InventoryModels;
+    get inventory_return_locations(): api.InventoryReturnLocations;
+    get inventory_stock_locations(): api.InventoryStockLocations;
+    get klarna_gateways(): api.KlarnaGateways;
+    get klarna_payments(): api.KlarnaPayments;
+    get line_item_options(): api.LineItemOptions;
+    get line_items(): api.LineItems;
+    get manual_gateways(): api.ManualGateways;
+    get manual_tax_calculators(): api.ManualTaxCalculators;
+    get markets(): api.Markets;
+    get merchants(): api.Merchants;
+    get order_amount_promotion_rules(): api.OrderAmountPromotionRules;
+    get order_copies(): api.OrderCopies;
+    get order_factories(): api.OrderFactories;
+    get order_subscription_items(): api.OrderSubscriptionItems;
+    get order_subscriptions(): api.OrderSubscriptions;
+    get order_validation_rules(): api.OrderValidationRules;
+    get orders(): api.Orders;
+    get organization(): api.Organizations;
+    get packages(): api.Packages;
+    get parcel_line_items(): api.ParcelLineItems;
+    get parcels(): api.Parcels;
+    get payment_gateways(): api.PaymentGateways;
+    get payment_methods(): api.PaymentMethods;
+    get payment_options(): api.PaymentOptions;
+    get paypal_gateways(): api.PaypalGateways;
+    get paypal_payments(): api.PaypalPayments;
+    get percentage_discount_promotions(): api.PercentageDiscountPromotions;
+    get price_frequency_tiers(): api.PriceFrequencyTiers;
+    get price_lists(): api.PriceLists;
+    get price_tiers(): api.PriceTiers;
+    get price_volume_tiers(): api.PriceVolumeTiers;
+    get prices(): api.Prices;
+    get promotion_rules(): api.PromotionRules;
+    get promotions(): api.Promotions;
+    get recurring_order_copies(): api.RecurringOrderCopies;
+    get refunds(): api.Refunds;
+    get reserved_stocks(): api.ReservedStocks;
+    get resource_errors(): api.ResourceErrors;
+    get return_line_items(): api.ReturnLineItems;
+    get returns(): api.Returns;
+    get satispay_gateways(): api.SatispayGateways;
+    get satispay_payments(): api.SatispayPayments;
+    get shipments(): api.Shipments;
+    get shipping_categories(): api.ShippingCategories;
+    get shipping_method_tiers(): api.ShippingMethodTiers;
+    get shipping_methods(): api.ShippingMethods;
+    get shipping_weight_tiers(): api.ShippingWeightTiers;
+    get shipping_zones(): api.ShippingZones;
+    get sku_list_items(): api.SkuListItems;
+    get sku_list_promotion_rules(): api.SkuListPromotionRules;
+    get sku_lists(): api.SkuLists;
+    get sku_options(): api.SkuOptions;
+    get skus(): api.Skus;
+    get stock_items(): api.StockItems;
+    get stock_line_items(): api.StockLineItems;
+    get stock_locations(): api.StockLocations;
+    get stock_reservations(): api.StockReservations;
+    get stock_transfers(): api.StockTransfers;
+    get stripe_gateways(): api.StripeGateways;
+    get stripe_payments(): api.StripePayments;
+    get subscription_models(): api.SubscriptionModels;
+    get tags(): api.Tags;
+    get tax_calculators(): api.TaxCalculators;
+    get tax_categories(): api.TaxCategories;
+    get tax_rules(): api.TaxRules;
+    get taxjar_accounts(): api.TaxjarAccounts;
+    get transactions(): api.Transactions;
+    get versions(): api.Versions;
+    get voids(): api.Voids;
+    get webhooks(): api.Webhooks;
+    get wire_transfers(): api.WireTransfers;
     get currentOrganization(): string;
+    private get interceptors();
     private localConfig;
     config(config: CommerceLayerConfig): CommerceLayerClient;
     resources(): readonly string[];
     singletons(): readonly string[];
     isSingleton(resource: api.ResourceTypeLock): boolean;
     isApiError(error: any): error is ApiError;
-    addRequestInterceptor(onFulfilled?: RequestInterceptor, onRejected?: ErrorInterceptor): number;
-    addResponseInterceptor(onFulfilled?: ResponseInterceptor, onRejected?: ErrorInterceptor): number;
-    removeInterceptor(type: InterceptorType, id: number): void;
+    addRequestInterceptor(onSuccess?: RequestInterceptor, onFailure?: ErrorInterceptor): void;
+    addResponseInterceptor(onSuccess?: ResponseInterceptor, onFailure?: ErrorInterceptor): void;
+    removeInterceptor(type: InterceptorType, id?: number): void;
     addRawResponseReader(options?: {
         headers: boolean;
     }): RawResponseReader;
-    removeRawResponseReader(reader: number | RawResponseReader): void;
+    removeRawResponseReader(): void;
 }
 declare const CommerceLayer: (config: CommerceLayerInitConfig) => CommerceLayerClient;
 export default CommerceLayer;