@commercetools/ts-client 1.2.1 → 2.0.1

package/dist/declarations/src/types/types.d.ts

@@ -16,7 +16,7 @@ export type MiddlewareResponse<T = unknown> = {
   error?: HttpErrorType;
   statusCode: number;
   headers?: Record<string, any>
-  request?: MiddlewareRequest;
+  originalRequest?: MiddlewareRequest;
 }
 
 export type HttpErrorType = {
@@ -41,7 +41,7 @@ export interface ClientRequest {
   uriTemplate?: string
   pathVariables?: VariableMap
   queryParams?: VariableMap
-  body?: string | Buffer
+  body?: Record<string, any> | string | Buffer
   response?: ClientResponse
   resolve?: Function;
   reject?: Function;
@@ -111,7 +111,7 @@ export type TokenCacheOptions = {
 
 export type TokenStore = {
   token: string
-  expirationTime?: number
+  expirationTime: number
   refreshToken?: string
   tokenCacheKey?: TokenCacheOptions
 }
@@ -222,7 +222,7 @@ export type HttpMiddlewareOptions = {
   retryConfig?: RetryOptions
   httpClient: Function
   getAbortController?: () => AbortController
-  httpClientOptions?: object
+  httpClientOptions?: object // will be passed as a second argument to your httpClient function for configuration
 }
 
 export type RetryOptions = RetryMiddlewareOptions
@@ -233,14 +233,7 @@ export type HttpOptions = {
   httpClient: Function
 }
 
-export type LogLevel = 'INFO' | 'ERROR'
-
 export type LoggerMiddlewareOptions = {
-  logLevel?: LogLevel
-  maskSensitiveHeaderData?: boolean
-  includeOriginalRequest?: boolean
-  includeResponseHeaders?: boolean
-  includeRequestInErrorResponse?: boolean
   loggerFn?: (options: MiddlewareResponse) => void
 }
 
@@ -249,6 +242,7 @@ export type RetryMiddlewareOptions = {
   maxRetries?: number
   retryDelay?: number
   maxDelay?: typeof Infinity
+  retryOnAbort?: boolean
   retryCodes?: Array<number | string>
 }
 
@@ -275,11 +269,35 @@ export type ExistingTokenMiddlewareOptions = {
   force: boolean
 }
 
+export type ConcurrentModificationMiddlewareOptions = {
+  concurrentModificationHandlerFn?: (
+      version: number,
+      request: MiddlewareRequest,
+      response: MiddlewareResponse
+  ) => Promise<Record<string, any> | string | Buffer>
+}
+
+export type BeforeExecutionMiddlewareOptions = {
+  [key: string]: any;
+  middleware: (options?: Omit<BeforeExecutionMiddlewareOptions, 'middleware'>) => Middleware
+}
+
+export type AfterExecutionMiddlewareOptions = {
+  [key: string]: any;
+  middleware: (options?: Omit<AfterExecutionMiddlewareOptions, 'middleware'>) => Middleware
+}
+export type TelemetryOptions = {
+  apm?: Function;
+  tracer?: Function;
+  userAgent?: string;
+  createTelemetryMiddleware: (options?: Omit<TelemetryOptions, 'createTelemetryMiddleware'>) => Middleware
+}
+
 export type IClientOptions = {
   method: MethodType;
   headers: Record<string, any>
   credentialsMode?: CredentialsMode;
-  body?: string | Buffer
+  body?: Record<string, any> | string | Buffer
   timeout?: number
   abortController?: AbortController
   includeOriginalRequest?: boolean
@@ -324,6 +342,6 @@ export type SuccessResult = {
   headers?: JsonObject<string>;
 }
 
-export type IResponse = Response & { statusCode?: number; data?: object } 
+export type IResponse = Response & { statusCode?: number; data?: object }
 
 export type executeRequest = (request: ClientRequest) => Promise<ClientResponse>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools/ts-client",
-  "version": "1.2.1",
+  "version": "2.0.1",
   "engines": {
     "node": ">=14"
   },
@@ -36,7 +36,7 @@
     "abort-controller": "3.0.0",
     "buffer": "^6.0.3",
     "node-fetch": "^2.6.1",
-    "uuid": "9.0.1"
+    "uuid": "10.0.0"
   },
   "files": ["dist", "CHANGELOG.md"],
   "author": "Chukwuemeka Ajima <meeky.ae@gmail.com>",
@@ -56,6 +56,7 @@
   "scripts": {
     "organize_imports": "find src -type f -name '*.ts' | xargs organize-imports-cli",
     "postbuild": "yarn organize_imports",
-    "post_process_generate": "yarn organize_imports"
+    "post_process_generate": "yarn organize_imports",
+    "docs": "typedoc --out docs"
   }
 }