@gradientedge/commercetools-utils 4.23.3 → 4.25.0

package/dist/typings/api/CommercetoolsApi.d.ts

@@ -1,7 +1,7 @@
 import { AxiosInstance } from 'axios';
 import { CommercetoolsApiConfig, CommercetoolsRetryConfig } from './types';
 import { CommercetoolsAuth, PaymentDraft } from '../';
-import { RegionEndpoints } from '../types';
+import { Logger, RegionEndpoints } from '../types';
 import type { Cart, CartDiscount, CartDiscountPagedQueryResponse, CartDraft, CartPagedQueryResponse, CartUpdateAction, Category, CategoryDraft, CategoryPagedQueryResponse, CategoryUpdate, Channel, ChannelPagedQueryResponse, Customer, CustomerCreatePasswordResetToken, CustomerDraft, CustomerGroup, CustomerGroupDraft, CustomerGroupPagedQueryResponse, CustomerGroupUpdate, CustomerPagedQueryResponse, CustomerResetPassword, CustomerSignin, CustomerSignInResult, CustomerToken, CustomerUpdate, CustomObject, CustomObjectDraft, DiscountCode, GraphQLRequest, GraphQLResponse, MyCartDraft, MyCartUpdateAction, MyCustomerDraft, MyPayment, MyPaymentDraft, MyPaymentPagedQueryResponse, MyPaymentUpdate, Order, OrderImportDraft, OrderPagedQueryResponse, OrderUpdate, Payment, PaymentPagedQueryResponse, PaymentUpdate, Product, ProductDraft, ProductProjection, ProductProjectionPagedQueryResponse, ProductsInStorePagedQueryResponse, ProductSelection, ProductSelectionDraft, ProductSelectionPagedQueryResponse, ProductSelectionUpdateAction, ProductType, ProductUpdate, ShippingMethod, ShippingMethodPagedQueryResponse, State, StatePagedQueryResponse, Store, StoreDraft, StorePagedQueryResponse, StoreUpdate, Type } from '../models';
 import { StandalonePrice, StandalonePriceDraft, StandalonePricePagedQueryResponse, StandalonePriceUpdate } from '../models/standalone-price';
 export interface FetchOptions<T = any> {
@@ -30,7 +30,9 @@ export declare class CommercetoolsApi {
     private readonly axios;
     private readonly retry;
     constructor(config: CommercetoolsApiConfig);
-    createAxiosInstance(): AxiosInstance;
+    createAxiosInstance(options?: {
+        logFn?: Logger | null | undefined;
+    }): AxiosInstance;
     getStoreById(options: CommonRequestOptions & {
         id: string;
     }): Promise<Store>;
@@ -70,6 +72,9 @@ export declare class CommercetoolsApi {
     getChannelById(options: CommonRequestOptions & {
         id: string;
     }): Promise<Channel>;
+    getChannelByKey(options: CommonRequestOptions & {
+        key: string;
+    }): Promise<Channel>;
     getCategory(options: CommonRequestOptions & {
         id?: string;
         key?: string;

package/dist/typings/auth/CommercetoolsAuthApi.d.ts

@@ -1,10 +1,15 @@
 import { CommercetoolsAuthApiConfig, CommercetoolsGrantResponse, LoginOptions, LogoutOptions, RevokeTokenOptions } from './types';
-import { RegionEndpoints } from '../types';
+import { Logger, RegionEndpoints } from '../types';
+import { AxiosInstance } from 'axios';
 export declare class CommercetoolsAuthApi {
     readonly config: CommercetoolsAuthApiConfig;
     readonly endpoints: RegionEndpoints;
     private readonly userAgent;
+    private readonly axios;
     constructor(config: CommercetoolsAuthApiConfig);
+    createAxiosInstance(options?: {
+        logFn?: Logger | null | undefined;
+    }): AxiosInstance;
     getClientGrant(scopes: string[]): Promise<CommercetoolsGrantResponse>;
     refreshGrant(refreshToken: string): Promise<CommercetoolsGrantResponse>;
     login(options: LoginOptions & {

package/dist/typings/auth/types.d.ts

@@ -1,4 +1,6 @@
-import { CommercetoolsBaseConfig, Region } from '../types';
+/// <reference types="node" />
+import { CommercetoolsBaseConfig, Logger, Region } from '../types';
+import https from 'https';
 export interface CommercetoolsAuthConfig extends CommercetoolsBaseConfig {
     refreshIfWithinSecs?: number;
     customerScopes?: string[];
@@ -11,6 +13,8 @@ export interface CommercetoolsAuthApiConfig {
     timeoutMs?: number;
     systemIdentifier?: string;
     storeKey?: string;
+    httpsAgent?: https.Agent;
+    logFn?: Logger;
 }
 export interface CommercetoolsGrantResponse {
     access_token: string;

package/dist/typings/types.d.ts

@@ -18,4 +18,14 @@ export interface CommercetoolsBaseConfig {
     clientScopes: string[];
     timeoutMs?: number;
     systemIdentifier?: string;
+    logFn?: Logger;
+}
+export interface Logger {
+    (options: LoggerParams): any;
+}
+export interface LoggerParams {
+    url: string;
+    params: any;
+    method: string;
+    headers?: Record<string, string | number | boolean>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/commercetools-utils",
-  "version": "4.23.3",
+  "version": "4.25.0",
   "description": "Provide utility classes and functions for interacting with the commercetools API",
   "main": "./dist/ge-commercetools-utils-node.cjs.js",
   "module": "./dist/ge-commercetools-utils-node.esm.js",