@commercetools/ts-client 0.0.0-beta.8 → 1.0.0

package/dist/declarations/src/client/builder.d.ts

@@ -1,4 +1,4 @@
-import { Client, AuthMiddlewareOptions, CorrelationIdMiddlewareOptions, Credentials, ExistingTokenMiddlewareOptions, HttpMiddlewareOptions, HttpUserAgentOptions, Middleware, PasswordAuthMiddlewareOptions, QueueMiddlewareOptions, RefreshAuthMiddlewareOptions, LoggerMiddlewareOptions, RetryMiddlewareOptions, ErrorMiddlewareOptions } from '../types/types';
+import { Client, AuthMiddlewareOptions, CorrelationIdMiddlewareOptions, Credentials, ExistingTokenMiddlewareOptions, HttpMiddlewareOptions, HttpUserAgentOptions, Middleware, PasswordAuthMiddlewareOptions, QueueMiddlewareOptions, RefreshAuthMiddlewareOptions, LoggerMiddlewareOptions, ErrorMiddlewareOptions } from '../types/types';
 export default class ClientBuilder {
     private projectKey;
     private authMiddleware;
@@ -7,7 +7,6 @@ export default class ClientBuilder {
     private correlationIdMiddleware;
     private loggerMiddleware;
     private queueMiddleware;
-    private retryMiddleware;
     private concurrentMiddleware;
     private errorMiddleware;
     private middlewares;
@@ -20,7 +19,6 @@ export default class ClientBuilder {
     withPasswordFlow(options: PasswordAuthMiddlewareOptions): ClientBuilder;
     withAnonymousSessionFlow(options: AuthMiddlewareOptions): ClientBuilder;
     withRefreshTokenFlow(options: RefreshAuthMiddlewareOptions): ClientBuilder;
-    withRetryMiddleware(options: RetryMiddlewareOptions): ClientBuilder;
     withExistingTokenFlow(authorization: string, options?: ExistingTokenMiddlewareOptions): ClientBuilder;
     withHttpMiddleware(options: HttpMiddlewareOptions): ClientBuilder;
     withUserAgentMiddleware(options?: HttpUserAgentOptions): ClientBuilder;

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

@@ -1,6 +1,3 @@
-import { ClientResult, ClientRequest, ClientOptions, ProcessFn, ProcessOptions } from '../types/types';
+import { Client, ClientRequest, ClientOptions, ProcessFn, ProcessOptions } from '../types/types';
 export declare function process(request: ClientRequest, fn: ProcessFn, processOpt?: ProcessOptions): Promise<Array<ClientRequest>>;
-export default function createClient(middlewares: ClientOptions): {
-    process: typeof process;
-    execute(request: ClientRequest): Promise<ClientResult>;
-};
+export default function createClient(middlewares: ClientOptions): Client;

package/dist/declarations/src/middleware/index.d.ts

@@ -1,7 +1,6 @@
 export { default as createCorrelationIdMiddleware } from './create-correlation-id-middleware';
 export { default as createHttpMiddleware } from './create-http-middleware';
 export { default as createQueueMiddleware } from './create-queue-middleware';
-export { default as createRetryMiddleware } from './create-retry-middleware';
 export { default as createLoggerMiddleware } from './create-logger-middleware';
 export { default as createUserAgentMiddleware } from './create-user-agent-middleware';
 export { default as createConcurrentModificationMiddleware } from './create-concurrent-modification-middleware';

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

@@ -1,4 +1,5 @@
 import { Buffer } from 'buffer/'
+import AbortController from 'abort-controller'
 
 export type Nullable<T> = T | null
 export type Keys = string | number | symbol
@@ -8,13 +9,12 @@ export type Optional = { [k in Keys]: any }
 
 export type Middleware = (next: Next) => (request: MiddlewareRequest) => Promise<MiddlewareResponse>
 
-export type MiddlewareResponse<T = Record<string, any>> = {
+export type MiddlewareResponse<T = unknown> = {
   resolve: Function;
   reject: Function;
   body: T;
   error?: HttpErrorType;
   statusCode: number;
-  // headers?: JsonObject<string>;
   headers?: Record<string, any>
   request?: MiddlewareRequest;
 }
@@ -27,9 +27,8 @@ export type HttpErrorType = {
   method: MethodType
   statusCode: number
   originalRequest?: ClientRequest
-  body?: JsonObject
+  body: JsonObject
   retryCount?: number
-  // headers?: JsonObject<QueryParam>
   headers?: Record<string, any>
   [key: string]: any
 }
@@ -37,7 +36,6 @@ export type HttpErrorType = {
 export interface ClientRequest {
   baseUri?: string
   uri?: string
-  // headers?: VariableMap
   headers?: Record<string, any>
   method: MethodType
   uriTemplate?: string
@@ -80,10 +78,9 @@ export type ClientResponse<T = any> = {
   body: T
   code?: number
   statusCode?: number
-  // headers?: JsonObject<string>
   headers?: Record<string, any>
   error?: HttpErrorType
-  // request?: Object
+  retryCount?: number
 }
 
 export type ClientResult = ClientResponse
@@ -216,28 +213,23 @@ export type CredentialsMode = 'omit' | 'same-origin' | 'include'
 export type HttpMiddlewareOptions = {
   host: string
   credentialsMode?: CredentialsMode
-  includeHeaders?: boolean
   includeResponseHeaders?: boolean
   includeOriginalRequest?: boolean
   includeRequestInErrorResponse?: boolean
-  // maskSensitiveHeaderData?: boolean
+  maskSensitiveHeaderData?: boolean
   timeout?: number
-  // enableRetry?: boolean
-  // retryConfig?: {
-  //   maxRetries?: number
-  //   retryDelay?: number
-  //   backoff?: boolean
-  //   maxDelay?: number
-  //   retryCodes?: Array<number | string>,
-  // }
+  enableRetry?: boolean
+  retryConfig?: RetryOptions
   httpClient: Function
   getAbortController?: () => AbortController
   httpClientOptions?: object
 }
 
+export type RetryOptions = RetryMiddlewareOptions
+
 export type HttpOptions = {
   url: string
-  clientOptions: IClientOptions
+  clientOptions: HttpClientOptions
   httpClient: Function
 }
 
@@ -285,12 +277,15 @@ export type ExistingTokenMiddlewareOptions = {
 
 export type IClientOptions = {
   method: MethodType;
-  // headers: JsonObject<QueryParam>;
   headers: Record<string, any>
   credentialsMode?: CredentialsMode;
   body?: string | Buffer
   timeout?: number
   abortController?: AbortController
+  includeOriginalRequest?: boolean
+  enableRetry?: boolean
+  retryConfig?: RetryOptions
+  maskSensitiveHeaderData?: boolean
 }
 
 export type HttpClientOptions = IClientOptions & Optional
@@ -304,6 +299,7 @@ type TResponse = {
   data: Record<string, any>
   message?: string
   statusCode: number
+  retryCount: number
   headers: Record<string, any>
 }
 
@@ -312,7 +308,7 @@ export type Client = {
   process: (
     request: ClientRequest,
     fn: ProcessFn,
-    processOpt: ProcessOptions
+    processOpt?: ProcessOptions
   ) => Promise<unknown>
 }
 
@@ -328,4 +324,6 @@ export type SuccessResult = {
   headers?: JsonObject<string>;
 }
 
+export type IResponse = Response & { statusCode?: number; data?: object } 
+
 export type executeRequest = (request: ClientRequest) => Promise<ClientResponse>

package/dist/declarations/src/utils/createError.d.ts

@@ -0,0 +1,8 @@
+import { HttpErrorType } from '../types/types';
+type ErrorType = ErrorArgs & Partial<HttpErrorType>;
+type ErrorArgs = {
+    statusCode: number;
+    message: string;
+};
+declare function createError({ statusCode, message, ...rest }: ErrorType): HttpErrorType;
+export default createError;

package/dist/declarations/src/utils/errors.d.ts

@@ -0,0 +1,10 @@
+export declare function NetworkError(...args: Array<unknown>): void;
+export declare function HttpError(...args: Array<unknown>): void;
+export declare function BadRequest(...args: Array<unknown>): void;
+export declare function Unauthorized(...args: Array<unknown>): void;
+export declare function Forbidden(...args: Array<unknown>): void;
+export declare function NotFound(...args: Array<unknown>): void;
+export declare function ConcurrentModification(...args: Array<unknown>): void;
+export declare function InternalServerError(...args: Array<unknown>): void;
+export declare function ServiceUnavailable(...args: Array<unknown>): void;
+export default function getErrorByCode(code: number): typeof NetworkError;

package/dist/declarations/src/utils/executor.d.ts

@@ -1,2 +1,2 @@
-import { HttpClientConfig, TResponse } from '../types/types';
+import { TResponse, HttpClientConfig } from '../types/types';
 export default function executor(request: HttpClientConfig): Promise<TResponse>;

package/dist/declarations/src/utils/index.d.ts

@@ -1,4 +1,3 @@
-export { default as logger } from './logger';
 export { default as getHeaders } from './headers';
 export { default as isBuffer } from './isBuffer';
 export { default as calculateRetryDelay } from './retryDelay';
@@ -13,4 +12,6 @@ export { default as executor } from './executor';
 export * as constants from './constants';
 export { default as sleep } from './sleep';
 export { default as METHODS } from './methods';
-export { validateRetryCodes, validateHttpOptions, validateUserAgentOptions, validateClient, validate } from './validate';
+export { default as createError } from './createError';
+export { NetworkError } from './errors';
+export { validateRetryCodes, validateHttpOptions, validateClient, validate } from './validate';

package/dist/declarations/src/utils/maskAuthData.d.ts

@@ -1,2 +1,2 @@
 import { MiddlewareRequest } from '../types/types';
-export default function maskAuthData(request: MiddlewareRequest): void;
+export default function maskAuthData(request: MiddlewareRequest): import("../types/types").ClientRequest;

package/dist/declarations/src/utils/retryDelay.d.ts

@@ -1,4 +1,4 @@
-export declare type TRetryPolicy = {
+export type TRetryPolicy = {
     retryCount: number;
     retryDelay: number;
     maxRetries: number;

package/dist/declarations/src/utils/validate.d.ts

@@ -1,4 +1,4 @@
-import { ClientRequest, HttpMiddlewareOptions, HttpUserAgentOptions, Middleware } from '../types/types';
+import { ClientRequest, HttpMiddlewareOptions, Middleware } from '../types/types';
 /**
  * validate some essential http options
  * @param options
@@ -11,11 +11,6 @@ export declare function validateHttpOptions(options: HttpMiddlewareOptions): voi
  * const retryCodes = [500, 504, "ETIMEDOUT"]
  */
 export declare function validateRetryCodes(retryCodes: Array<string | number>): void;
-/**
- *
- * @param options
- */
-export declare function validateUserAgentOptions(options: HttpUserAgentOptions): void;
 /**
  * @param options
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools/ts-client",
-  "version": "0.0.0-beta.8",
+  "version": "1.0.0",
   "engines": {
     "node": ">=14"
   },
@@ -33,14 +33,12 @@
     "url": "https://github.com/commercetools/commercetools-sdk-typescript/issues"
   },
   "dependencies": {
+    "abort-controller": "3.0.0",
     "buffer": "^6.0.3",
     "node-fetch": "^2.6.1",
     "querystring": "^0.2.1"
   },
-  "files": [
-    "dist",
-    "CHANGELOG.md"
-  ],
+  "files": ["dist", "CHANGELOG.md"],
   "author": "Chukwuemeka Ajima <meeky.ae@gmail.com>",
   "main": "dist/commercetools-ts-client.cjs.js",
   "module": "dist/commercetools-ts-client.esm.js",
@@ -49,10 +47,9 @@
     "./dist/commercetools-ts-client.esm.js": "./dist/commercetools-ts-client.browser.esm.js"
   },
   "devDependencies": {
-    "abort-controller": "3.0.0",
     "common-tags": "1.8.2",
-    "dotenv": "16.0.2",
-    "jest": "29.0.3",
+    "dotenv": "16.0.3",
+    "jest": "29.5.0",
     "nock": "12.0.3",
     "organize-imports-cli": "0.10.0"
   },

package/dist/declarations/src/middleware/create-retry-middleware.d.ts

@@ -1,2 +0,0 @@
-import { Middleware, RetryMiddlewareOptions } from '../types/types';
-export default function createRetryMiddleware(options: RetryMiddlewareOptions): Middleware;

package/dist/declarations/src/utils/logger.d.ts

@@ -1,2 +0,0 @@
-import { ClientResponse } from '../types/types';
-export default function logger(res: ClientResponse): void;