@gradientedge/commercetools-utils 4.15.0 → 4.17.1

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

@@ -2,7 +2,7 @@ import { AxiosInstance } from 'axios';
 import { CommercetoolsApiConfig, CommercetoolsRetryConfig } from './types';
 import { CommercetoolsAuth } from '../';
 import { 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, Store, StoreDraft, StorePagedQueryResponse, StoreUpdate, Type } from '../models';
+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';
 export interface FetchOptions<T = Record<string, any>> {
     path: string;
     headers?: Record<string, string>;
@@ -15,7 +15,7 @@ export interface FetchOptions<T = Record<string, any>> {
 }
 export interface CommonRequestOptions {
     correlationId?: string;
-    params?: Record<string, any>;
+    params?: Record<string, undefined | string | boolean | number | (string | boolean | number)[]>;
     retry?: CommercetoolsRetryConfig;
 }
 export interface CommonStoreEnabledRequestOptions extends CommonRequestOptions {
@@ -425,6 +425,13 @@ export declare class CommercetoolsApi {
         key: string;
         version: number;
     }): Promise<CustomerGroup>;
+    getStateById(options: CommonRequestOptions & {
+        id: string;
+    }): Promise<State>;
+    getStateByKey(options: CommonRequestOptions & {
+        key: string;
+    }): Promise<State>;
+    queryStates(options?: CommonRequestOptions): Promise<StatePagedQueryResponse>;
     graphql(options: CommonRequestOptions & {
         accessToken?: string;
         data: GraphQLRequest;
@@ -432,7 +439,6 @@ export declare class CommercetoolsApi {
     request<T = any, R = any>(options: FetchOptions<T>): Promise<R>;
     getRetryConfig(methodRetryConfig?: CommercetoolsRetryConfig): CommercetoolsRetryConfig;
     getRequestOptions(options: FetchOptions): Promise<any>;
-    calculateDelay(retryCount: number, retryConfig?: CommercetoolsRetryConfig): number;
     isRetryableError(error: any): boolean;
     extractCommonRequestOptions(options?: CommonRequestOptions): CommonRequestOptions;
     applyStore(path: string, storeKey: string | undefined | null): string;

package/dist/typings/utils/calculate-delay.d.ts

@@ -0,0 +1,2 @@
+import { CommercetoolsRetryConfig } from '../api';
+export declare function calculateDelay(retryCount: number, retryConfig?: CommercetoolsRetryConfig): number;

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

@@ -1,3 +1,5 @@
+export * from './calculate-delay';
 export * from './format';
-export * from './useragent';
 export * from './mask';
+export * from './retry-on-conflict';
+export * from './useragent';

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

@@ -0,0 +1,7 @@
+export interface RetryOnConflictParams<T = any> {
+    executeFn: (...args: any) => Promise<T>;
+    delayMs?: number;
+    maxRetries?: number;
+    jitter?: boolean;
+}
+export declare function retryOnConflict<T = any>(options: RetryOnConflictParams): Promise<T>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/commercetools-utils",
-  "version": "4.15.0",
+  "version": "4.17.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",
@@ -87,6 +87,7 @@
     "webpack-cli": "4.9.2"
   },
   "dependencies": {
+    "@tshttp/status": "^2.0.0",
     "axios": "0.26.1",
     "json-stringify-safe": "5.0.1",
     "lodash.clonedeep": "4.5.0",