@gradientedge/commercetools-utils 4.32.0 → 5.0.1

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

@@ -1,8 +1,7 @@
-import { AxiosInstance } from 'axios';
 import { CommercetoolsApiConfig, CommercetoolsRetryConfig } from './types';
 import { CommercetoolsAuth, PaymentDraft, ProductTypePagedQueryResponse, TypePagedQueryResponse } from '../';
-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, StandalonePrice, StandalonePriceDraft, StandalonePricePagedQueryResponse, StandalonePriceUpdate, State, StatePagedQueryResponse, Store, StoreDraft, StorePagedQueryResponse, StoreUpdate, Type } from '../models';
+import { CommercetoolsRequest, 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, ProductSelection, ProductSelectionDraft, ProductSelectionPagedQueryResponse, ProductSelectionUpdateAction, ProductsInStorePagedQueryResponse, ProductType, ProductUpdate, ShippingMethod, ShippingMethodPagedQueryResponse, StandalonePrice, StandalonePriceDraft, StandalonePricePagedQueryResponse, StandalonePriceUpdate, State, StatePagedQueryResponse, Store, StoreDraft, StorePagedQueryResponse, StoreUpdate, Type } from '../models';
 export interface FetchOptions<T = any> {
     path: string;
     headers?: Record<string, string>;
@@ -25,13 +24,8 @@ export declare class CommercetoolsApi {
     readonly auth: CommercetoolsAuth;
     readonly config: CommercetoolsApiConfig;
     readonly endpoints: RegionEndpoints;
-    private readonly userAgent;
-    private readonly axios;
-    private readonly retry;
+    private readonly requestExecutor;
     constructor(config: CommercetoolsApiConfig);
-    createAxiosInstance(options?: {
-        logFn?: Logger | null | undefined;
-    }): AxiosInstance;
     getStoreById(options: CommonRequestOptions & {
         id: string;
     }): Promise<Store>;
@@ -473,11 +467,8 @@ export declare class CommercetoolsApi {
         data: GraphQLRequest;
     }): Promise<GraphQLResponse>;
     request<T = any, R = any>(options: FetchOptions<T>): Promise<R>;
-    getRetryConfig(methodRetryConfig?: CommercetoolsRetryConfig): CommercetoolsRetryConfig;
-    getRequestOptions(options: FetchOptions): Promise<any>;
-    isRetryableError(error: any): boolean;
+    getRequestOptions(options: FetchOptions): Promise<CommercetoolsRequest>;
     extractCommonRequestOptions(options?: CommonRequestOptions): CommonRequestOptions;
     applyStore(path: string, storeKey: string | undefined | null): string;
-    transformError(lastError: any): any;
     static validateConfig(config: any): void;
 }

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

@@ -2,8 +2,8 @@
 import * as https from 'https';
 import { CommercetoolsAuthConfig } from '../auth';
 export interface CommercetoolsApiConfig extends CommercetoolsAuthConfig {
-    retry?: CommercetoolsRetryConfig;
     httpsAgent?: https.Agent;
+    clientScopes: string[];
 }
 export interface CommercetoolsRetryConfig {
     delayMs: number;

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

@@ -1,15 +1,11 @@
 import { CommercetoolsAuthApiConfig, CommercetoolsGrantResponse, LoginOptions, LogoutOptions, RevokeTokenOptions } from './types';
-import { Logger, RegionEndpoints } from '../types';
-import { AxiosInstance } from 'axios';
+import { CommercetoolsRequest } from '../';
+import { RegionEndpoints } from '../types';
 export declare class CommercetoolsAuthApi {
     readonly config: CommercetoolsAuthApiConfig;
     readonly endpoints: RegionEndpoints;
-    private readonly userAgent;
-    private readonly axios;
+    private readonly requestExecutor;
     constructor(config: CommercetoolsAuthApiConfig);
-    createAxiosInstance(options?: {
-        logFn?: Logger | null | undefined;
-    }): AxiosInstance;
     getClientGrant(scopes: string[]): Promise<CommercetoolsGrantResponse>;
     refreshGrant(refreshToken: string): Promise<CommercetoolsGrantResponse>;
     login(options: LoginOptions & {
@@ -22,5 +18,10 @@ export declare class CommercetoolsAuthApi {
         scopes: string[];
     }): Promise<CommercetoolsGrantResponse>;
     post(path: string, body: Record<string, any>): Promise<CommercetoolsGrantResponse>;
+    getRequestOptions(options: {
+        path: string;
+        correlationId?: string | undefined;
+        body: Record<string, any>;
+    }): CommercetoolsRequest;
     applyStore(path: string, storeKey: string | undefined | null): string;
 }

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

@@ -1,20 +1,14 @@
 /// <reference types="node" />
-import { CommercetoolsBaseConfig, Logger, Region } from '../types';
+import { CommercetoolsBaseConfig } from '../types';
 import https from 'https';
 export interface CommercetoolsAuthConfig extends CommercetoolsBaseConfig {
     refreshIfWithinSecs?: number;
     customerScopes?: string[];
+    clientScopes: string[];
 }
-export interface CommercetoolsAuthApiConfig {
-    projectKey: string;
-    clientId: string;
-    clientSecret: string;
-    region: Region;
-    timeoutMs?: number;
-    systemIdentifier?: string;
-    storeKey?: string;
+export interface CommercetoolsAuthApiConfig extends CommercetoolsBaseConfig {
+    clientScopes?: string[] | undefined;
     httpsAgent?: https.Agent;
-    logFn?: Logger;
 }
 export interface CommercetoolsGrantResponse {
     access_token: string;

package/dist/typings/constants.d.ts

@@ -1,2 +1,12 @@
+import { CommercetoolsRetryConfig } from './api';
+export declare const USER_AGENT_PREFIX = "@gradientedge/commercetools-utils";
 export declare const DEFAULT_REQUEST_TIMEOUT_MS = 5000;
 export declare const MAX_ITEMS_PER_QUERY = 500;
+export declare const DEFAULT_RETRY_CONFIG: CommercetoolsRetryConfig;
+export declare const RETRYABLE_STATUS_CODES: number[];
+export declare const DEFAULT_HTTPS_AGENT_CONFIG: {
+    keepAlive: boolean;
+    maxSockets: number;
+    maxFreeSockets: number;
+    timeout: number;
+};

package/dist/typings/error/CommercetoolsError.d.ts

@@ -1,16 +1,11 @@
-import { AxiosError, AxiosRequestConfig } from 'axios';
+import { AxiosError, InternalAxiosRequestConfig } from 'axios';
 export declare class CommercetoolsError extends Error {
     readonly data?: any;
     readonly status: number | undefined;
     readonly isCommercetoolsError = true;
     constructor(message: string, data?: any, status?: number);
     static fromAxiosError(e: AxiosError): CommercetoolsError;
-    static parseRequestData(config: AxiosRequestConfig): any;
-    toJSON(): {
-        status: number | undefined;
-        message: string;
-        data: any;
-        isCommercetoolsError: boolean;
-    };
+    static parseRequestData(config: InternalAxiosRequestConfig | undefined): any;
+    toJSON(): Record<string, any>;
     toString(): string;
 }

package/dist/typings/index.d.ts

@@ -1,7 +1,7 @@
 export * from './error';
 export * from './auth';
 export * from './api';
-export { Region, RegionEndpoints, Logger, LoggerParams } from './types';
+export { Region, RegionEndpoints, CommercetoolsRequest, CommercetoolsRequestResponse } from './types';
 export * from './utils';
 export * from './models';
 export { MAX_ITEMS_PER_QUERY } from './constants';

package/dist/typings/request/index.d.ts

@@ -0,0 +1,2 @@
+export * from './request';
+export * from './is-retryable-error';

package/dist/typings/request/is-retryable-error.d.ts

@@ -0,0 +1 @@
+export declare function isRetryableError(error: any): boolean;

package/dist/typings/request/request-executor.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+import https from 'https';
+import { CommercetoolsRetryConfig } from '../api';
+import { CommercetoolsHooks, RequestExecutor } from '../types';
+export interface GetRequestExecutorProps extends CommercetoolsHooks {
+    httpsAgent?: https.Agent;
+    timeoutMs?: number;
+    retry?: Partial<CommercetoolsRetryConfig>;
+    systemIdentifier?: string;
+}
+export declare function getRequestExecutor(props: GetRequestExecutorProps): RequestExecutor;

package/dist/typings/request/request.d.ts

@@ -0,0 +1,10 @@
+import { AxiosInstance } from 'axios';
+import { CommercetoolsRetryConfig } from '../api';
+import { CommercetoolsHooks, CommercetoolsRequest } from '../types';
+export interface RequestOptions extends CommercetoolsHooks {
+    axiosInstance: AxiosInstance;
+    retry: CommercetoolsRetryConfig;
+    request: CommercetoolsRequest;
+    timeoutMs?: number;
+}
+export declare function request<T = any>(options: RequestOptions): Promise<T>;

package/dist/typings/request/transform-error.d.ts

@@ -0,0 +1,2 @@
+import { CommercetoolsError } from '../error';
+export declare function transformError(lastError: any): Error | CommercetoolsError;

package/dist/typings/types.d.ts

@@ -1,3 +1,4 @@
+import { CommercetoolsRetryConfig } from './api';
 export declare enum Region {
     NORTH_AMERICA_GCP = "north_america_gcp",
     NORTH_AMERICA_AWS = "north_america_aws",
@@ -9,33 +10,49 @@ export interface RegionEndpoints {
     auth: string;
     api: string;
 }
-export interface CommercetoolsBaseConfig {
+export interface CommercetoolsBaseConfig extends CommercetoolsHooks {
     projectKey: string;
     storeKey?: string;
     clientId: string;
     clientSecret: string;
     region: Region;
-    clientScopes: string[];
     timeoutMs?: number;
+    retry?: Partial<CommercetoolsRetryConfig>;
     systemIdentifier?: string;
-    logFn?: Logger;
 }
-export interface Logger {
-    (options: LoggerParams): any;
+export interface CommercetoolsHooks {
+    onBeforeRequest?: (requestConfig: CommercetoolsRequest) => Promise<CommercetoolsRequest> | CommercetoolsRequest;
+    onAfterResponse?: (response: CommercetoolsRequestResponse) => void;
 }
-export interface LoggerParams {
+export interface CommercetoolsRequest {
+    url: string;
+    method: string;
+    params?: Record<string, string | number | boolean>;
+    headers: Record<string, string>;
+    data?: any;
+}
+export interface CommercetoolsRequestResponse {
     request: {
         url: string;
         method: string;
-        params?: Record<string, string | number | boolean>;
-        headers?: Record<string, string | number | boolean>;
+        params?: Record<string, string | number | boolean> | undefined;
+        headers?: Record<string, string> | undefined;
         data?: any;
     };
     response: {
         code?: string | undefined;
         message?: string | undefined;
         status?: number;
-        headers?: Record<string, string | number | boolean>;
+        headers?: Record<string, string> | undefined;
         data?: any;
     };
+    stats: CommercetoolsRequestResponseStats;
+}
+export interface CommercetoolsRequestResponseStats {
+    accumulativeDurationMs: number;
+    durationMs: number;
+    retries: number;
+}
+export interface RequestExecutor<T = any> {
+    (options: CommercetoolsRequest): Promise<T>;
 }

package/dist/typings/utils/axios/convert-error.d.ts

@@ -0,0 +1,3 @@
+import { CommercetoolsRequestResponse, CommercetoolsRequestResponseStats } from '../../types';
+import { AxiosError } from 'axios';
+export declare function convertAxiosError(error: AxiosError | Error, stats: CommercetoolsRequestResponseStats): CommercetoolsRequestResponse | null;

package/dist/typings/utils/axios/convert-response.d.ts

@@ -0,0 +1,3 @@
+import { CommercetoolsRequestResponse, CommercetoolsRequestResponseStats } from '../../types';
+import { AxiosResponse } from 'axios';
+export declare function convertAxiosResponse(response: AxiosResponse, stats: CommercetoolsRequestResponseStats): CommercetoolsRequestResponse;

package/dist/typings/utils/axios/create-instance.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="node" />
+import { AxiosInstance } from 'axios';
+import https from 'https';
+export declare function createAxiosInstance(options: {
+    httpsAgent?: https.Agent;
+}): AxiosInstance;

package/dist/typings/utils/axios/extract-headers.d.ts

@@ -0,0 +1 @@
+export declare function extractAxiosHeaders(headers: unknown): Record<string, string> | undefined;

package/dist/typings/utils/axios/index.d.ts

@@ -0,0 +1,4 @@
+export * from './convert-error';
+export * from './convert-response';
+export * from './create-instance';
+export * from './extract-headers';

package/dist/typings/utils/index.d.ts

@@ -1,3 +1,4 @@
+export * from './axios';
 export * from './calculate-delay';
 export * from './format';
 export * from './get-attribute-value';

package/dist/typings/utils/mask.d.ts

@@ -1,6 +1,6 @@
 export declare const SENSITIVE_PROPERTY_NAMES: string[];
 export declare const SENSITIVE_HEADER_NAMES: string[];
 export declare const DEFAULT_MASKING_STRING = "********";
-export declare function maskSensitiveInput(data: unknown): unknown;
-export declare function maskSensitiveHeaders(data: unknown): unknown;
-export declare function maskSensitiveData(data: unknown, propertyNames: string[], mask?: string): unknown;
+export declare function maskSensitiveInput(data: unknown): any;
+export declare function maskSensitiveHeaders(data: unknown): any;
+export declare function maskSensitiveData(data: any, propertyNames: string[], mask?: string): any;

package/dist/typings/utils/plain-clone.d.ts

@@ -0,0 +1 @@
+export declare function plainClone(source: any): any;

package/dist/typings/utils/retry-on-conflict.d.ts

@@ -1,5 +1,5 @@
 export interface RetryOnConflictParams<T = any> {
-    executeFn: (...args: any) => Promise<T>;
+    executeFn: (attemptNo: number) => Promise<T>;
     delayMs?: number;
     maxRetries?: number;
     jitter?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/commercetools-utils",
-  "version": "4.32.0",
+  "version": "5.0.1",
   "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",
@@ -56,41 +56,40 @@
   "homepage": "https://github.com/gradientedge/commercetools-utils#readme",
   "devDependencies": {
     "@sinonjs/fake-timers": "10.0.2",
-    "@types/jest": "29.2.6",
+    "@types/jest": "29.4.0",
     "@types/json-stringify-safe": "5.0.0",
     "@types/lodash": "4.14.191",
     "@types/lodash.clonedeep": "4.5.7",
-    "@types/node": "18.11.18",
+    "@types/node": "18.14.2",
     "@types/qs": "6.9.7",
     "@types/sinonjs__fake-timers": "8.1.2",
     "@types/traverse": "0.6.32",
-    "@typescript-eslint/eslint-plugin": "5.48.2",
-    "@typescript-eslint/parser": "5.48.2",
+    "@typescript-eslint/eslint-plugin": "5.54.0",
+    "@typescript-eslint/parser": "5.54.0",
     "codecov": "3.8.3",
     "commitizen": "4.3.0",
     "cz-conventional-changelog": "3.3.0",
-    "eslint": "8.32.0",
+    "eslint": "8.35.0",
     "eslint-config-prettier": "8.6.0",
     "husky": "8.0.3",
-    "jest": "29.3.1",
+    "jest": "29.4.3",
     "jest-matcher-specific-error": "1.0.0",
-    "jest-mock": "29.3.1",
+    "jest-mock": "29.4.3",
     "nock": "13.3.0",
-    "prettier": "2.8.3",
-    "rimraf": "4.1.1",
+    "prettier": "2.8.4",
+    "rimraf": "4.1.2",
     "semantic-release": "19.0.5",
     "ts-jest": "29.0.5",
     "ts-node": "^10.9.1",
-    "typedoc": "0.23.24",
-    "typescript": "4.9.4",
+    "typedoc": "0.23.26",
+    "typescript": "4.9.5",
     "webpack": "5.75.0",
     "webpack-cli": "5.0.1"
   },
   "dependencies": {
     "@tshttp/status": "^2.0.0",
-    "axios": "0.27.2",
+    "axios": "1.3.4",
     "json-stringify-safe": "5.0.1",
-    "lodash.clonedeep": "4.5.0",
     "qs": "6.11.0",
     "traverse": "0.6.7"
   },

package/dist/typings/axios/interceptors/logger.d.ts

@@ -1,3 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { Logger } from '../../types';
-export declare function applyLoggerInterceptor(instance: AxiosInstance, logFn: Logger): void;