@commercetools/ts-client 1.0.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +55 -0
  3. package/dist/commercetools-ts-client.browser.cjs.js +1155 -1141
  4. package/dist/commercetools-ts-client.browser.esm.js +1155 -1140
  5. package/dist/commercetools-ts-client.cjs.d.ts +1 -0
  6. package/dist/commercetools-ts-client.cjs.d.ts.map +1 -0
  7. package/dist/commercetools-ts-client.cjs.dev.js +1155 -1141
  8. package/dist/commercetools-ts-client.cjs.prod.js +1155 -1141
  9. package/dist/commercetools-ts-client.esm.js +1155 -1140
  10. package/dist/declarations/src/client/builder.d.ts +1 -1
  11. package/dist/declarations/src/client/client.d.ts +1 -1
  12. package/dist/declarations/src/client/index.d.ts +2 -3
  13. package/dist/declarations/src/index.d.ts +3 -12
  14. package/dist/declarations/src/middleware/auth-middleware/anonymous-session-flow.d.ts +1 -1
  15. package/dist/declarations/src/middleware/auth-middleware/client-credentials-flow.d.ts +1 -1
  16. package/dist/declarations/src/middleware/auth-middleware/existing-token-flow.d.ts +1 -1
  17. package/dist/declarations/src/middleware/auth-middleware/index.d.ts +5 -5
  18. package/dist/declarations/src/middleware/auth-middleware/password-flow.d.ts +1 -1
  19. package/dist/declarations/src/middleware/auth-middleware/refresh-token-flow.d.ts +1 -1
  20. package/dist/declarations/src/middleware/create-concurrent-modification-middleware.d.ts +1 -1
  21. package/dist/declarations/src/middleware/create-correlation-id-middleware.d.ts +1 -1
  22. package/dist/declarations/src/middleware/create-error-middleware.d.ts +1 -1
  23. package/dist/declarations/src/middleware/create-http-middleware.d.ts +1 -1
  24. package/dist/declarations/src/middleware/create-logger-middleware.d.ts +1 -1
  25. package/dist/declarations/src/middleware/create-queue-middleware.d.ts +1 -1
  26. package/dist/declarations/src/middleware/create-user-agent-middleware.d.ts +1 -1
  27. package/dist/declarations/src/middleware/index.d.ts +8 -8
  28. package/dist/declarations/src/types/types.d.ts +1 -1
  29. package/package.json +4 -4
  30. package/dist/declarations/src/middleware/auth-middleware/auth-request-builder.d.ts +0 -24
  31. package/dist/declarations/src/middleware/auth-middleware/auth-request-executor.d.ts +0 -2
  32. package/dist/declarations/src/utils/constants.d.ts +0 -5
  33. package/dist/declarations/src/utils/createError.d.ts +0 -8
  34. package/dist/declarations/src/utils/errors.d.ts +0 -10
  35. package/dist/declarations/src/utils/executor.d.ts +0 -2
  36. package/dist/declarations/src/utils/generateID.d.ts +0 -1
  37. package/dist/declarations/src/utils/headers.d.ts +0 -2
  38. package/dist/declarations/src/utils/index.d.ts +0 -17
  39. package/dist/declarations/src/utils/isBuffer.d.ts +0 -1
  40. package/dist/declarations/src/utils/maskAuthData.d.ts +0 -2
  41. package/dist/declarations/src/utils/mergeAuthHeader.d.ts +0 -2
  42. package/dist/declarations/src/utils/methods.d.ts +0 -2
  43. package/dist/declarations/src/utils/retryDelay.d.ts +0 -8
  44. package/dist/declarations/src/utils/sleep.d.ts +0 -1
  45. package/dist/declarations/src/utils/tokenCacheKey.d.ts +0 -2
  46. package/dist/declarations/src/utils/tokenExpirationTime.d.ts +0 -1
  47. package/dist/declarations/src/utils/tokenStore.d.ts +0 -2
  48. package/dist/declarations/src/utils/userAgent.d.ts +0 -2
  49. package/dist/declarations/src/utils/validate.d.ts +0 -25
@@ -1,4 +1,4 @@
1
- import { Client, AuthMiddlewareOptions, CorrelationIdMiddlewareOptions, Credentials, ExistingTokenMiddlewareOptions, HttpMiddlewareOptions, HttpUserAgentOptions, Middleware, PasswordAuthMiddlewareOptions, QueueMiddlewareOptions, RefreshAuthMiddlewareOptions, LoggerMiddlewareOptions, ErrorMiddlewareOptions } from '../types/types';
1
+ import { AuthMiddlewareOptions, Client, CorrelationIdMiddlewareOptions, Credentials, ErrorMiddlewareOptions, ExistingTokenMiddlewareOptions, HttpMiddlewareOptions, HttpUserAgentOptions, LoggerMiddlewareOptions, Middleware, PasswordAuthMiddlewareOptions, QueueMiddlewareOptions, RefreshAuthMiddlewareOptions } from "../types/types.js";
2
2
  export default class ClientBuilder {
3
3
  private projectKey;
4
4
  private authMiddleware;
@@ -1,3 +1,3 @@
1
- import { Client, ClientRequest, ClientOptions, ProcessFn, ProcessOptions } from '../types/types';
1
+ import { Client, ClientOptions, ClientRequest, ProcessFn, ProcessOptions } from "../types/types.js";
2
2
  export declare function process(request: ClientRequest, fn: ProcessFn, processOpt?: ProcessOptions): Promise<Array<ClientRequest>>;
3
3
  export default function createClient(middlewares: ClientOptions): Client;
@@ -1,3 +1,2 @@
1
- export { default as createClient } from './client';
2
- export { default as ClientBuilder } from './builder';
3
- export { process as Process } from './client';
1
+ export { default as ClientBuilder } from "./builder.js";
2
+ export { default as createClient, process as Process } from "./client.js";
@@ -1,12 +1,3 @@
1
- export { ClientBuilder, createClient, Process } from './client';
2
- export { createAuthMiddlewareForAnonymousSessionFlow } from './middleware';
3
- export { createAuthMiddlewareForClientCredentialsFlow } from './middleware';
4
- export { createAuthMiddlewareForExistingTokenFlow } from './middleware';
5
- export { createAuthMiddlewareForPasswordFlow } from './middleware';
6
- export { createAuthMiddlewareForRefreshTokenFlow } from './middleware';
7
- export { createCorrelationIdMiddleware } from './middleware';
8
- export { createHttpMiddleware } from './middleware';
9
- export { createLoggerMiddleware } from './middleware';
10
- export { createQueueMiddleware } from './middleware';
11
- export { createUserAgentMiddleware } from './middleware';
12
- export * from './types/types.d';
1
+ export { ClientBuilder, createClient, Process } from "./client/index.js";
2
+ export { createAuthMiddlewareForAnonymousSessionFlow, createAuthMiddlewareForClientCredentialsFlow, createAuthMiddlewareForExistingTokenFlow, createAuthMiddlewareForPasswordFlow, createAuthMiddlewareForRefreshTokenFlow, createConcurrentModificationMiddleware, createCorrelationIdMiddleware, createHttpMiddleware, createLoggerMiddleware, createQueueMiddleware, createUserAgentMiddleware } from "./middleware/index.js";
3
+ export * from "./types/types.js";
@@ -1,2 +1,2 @@
1
- import { Middleware, AuthMiddlewareOptions } from '../../types/types';
1
+ import { AuthMiddlewareOptions, Middleware } from "../../types/types.js";
2
2
  export default function createAuthMiddlewareForAnonymousSessionFlow(options: AuthMiddlewareOptions): Middleware;
@@ -1,2 +1,2 @@
1
- import { Middleware, AuthMiddlewareOptions } from '../../types/types';
1
+ import { AuthMiddlewareOptions, Middleware } from "../../types/types.js";
2
2
  export default function createAuthMiddlewareForClientCredentialsFlow(options: AuthMiddlewareOptions): Middleware;
@@ -1,2 +1,2 @@
1
- import { Middleware, ExistingTokenMiddlewareOptions } from '../../types/types';
1
+ import { ExistingTokenMiddlewareOptions, Middleware } from "../../types/types.js";
2
2
  export default function createAuthMiddlewareForExistingTokenFlow(authorization: string, options?: ExistingTokenMiddlewareOptions): Middleware;
@@ -1,6 +1,6 @@
1
- import createAuthMiddlewareForPasswordFlow from './password-flow';
2
- import createAuthMiddlewareForAnonymousSessionFlow from './anonymous-session-flow';
3
- import createAuthMiddlewareForClientCredentialsFlow from './client-credentials-flow';
4
- import createAuthMiddlewareForRefreshTokenFlow from './refresh-token-flow';
5
- import createAuthMiddlewareForExistingTokenFlow from './existing-token-flow';
1
+ import createAuthMiddlewareForAnonymousSessionFlow from "./anonymous-session-flow.js";
2
+ import createAuthMiddlewareForClientCredentialsFlow from "./client-credentials-flow.js";
3
+ import createAuthMiddlewareForExistingTokenFlow from "./existing-token-flow.js";
4
+ import createAuthMiddlewareForPasswordFlow from "./password-flow.js";
5
+ import createAuthMiddlewareForRefreshTokenFlow from "./refresh-token-flow.js";
6
6
  export { createAuthMiddlewareForPasswordFlow, createAuthMiddlewareForAnonymousSessionFlow, createAuthMiddlewareForClientCredentialsFlow, createAuthMiddlewareForRefreshTokenFlow, createAuthMiddlewareForExistingTokenFlow };
@@ -1,2 +1,2 @@
1
- import { Middleware, PasswordAuthMiddlewareOptions } from '../../types/types';
1
+ import { Middleware, PasswordAuthMiddlewareOptions } from "../../types/types.js";
2
2
  export default function createAuthMiddlewareForPasswordFlow(options: PasswordAuthMiddlewareOptions): Middleware;
@@ -1,2 +1,2 @@
1
- import { Middleware, RefreshAuthMiddlewareOptions } from '../../types/types';
1
+ import { Middleware, RefreshAuthMiddlewareOptions } from "../../types/types.js";
2
2
  export default function createAuthMiddlewareForRefreshTokenFlow(options: RefreshAuthMiddlewareOptions): Middleware;
@@ -1,2 +1,2 @@
1
- import { Middleware } from '../types/types';
1
+ import { Middleware } from "../types/types.js";
2
2
  export default function createConcurrentModificationMiddleware(): Middleware;
@@ -1,2 +1,2 @@
1
- import { Middleware, CorrelationIdMiddlewareOptions } from '../types/types';
1
+ import { CorrelationIdMiddlewareOptions, Middleware } from "../types/types.js";
2
2
  export default function createCorrelationIdMiddleware(options?: CorrelationIdMiddlewareOptions): Middleware;
@@ -1,2 +1,2 @@
1
- import { Middleware, ErrorMiddlewareOptions } from '../types/types';
1
+ import { ErrorMiddlewareOptions, Middleware } from "../types/types.js";
2
2
  export default function createErrorMiddleware(options?: ErrorMiddlewareOptions): Middleware;
@@ -1,2 +1,2 @@
1
- import { Middleware, HttpMiddlewareOptions } from '../types/types';
1
+ import { HttpMiddlewareOptions, Middleware } from "../types/types.js";
2
2
  export default function createHttpMiddleware(options: HttpMiddlewareOptions): Middleware;
@@ -1,2 +1,2 @@
1
- import { Middleware, LoggerMiddlewareOptions } from '../types/types';
1
+ import { LoggerMiddlewareOptions, Middleware } from "../types/types.js";
2
2
  export default function createLoggerMiddleware(options?: LoggerMiddlewareOptions): Middleware;
@@ -1,2 +1,2 @@
1
- import { Middleware, QueueMiddlewareOptions } from '../types/types';
1
+ import { Middleware, QueueMiddlewareOptions } from "../types/types.js";
2
2
  export default function createQueueMiddleware({ concurrency, }: QueueMiddlewareOptions): Middleware;
@@ -1,2 +1,2 @@
1
- import { HttpUserAgentOptions, Middleware } from '../types/types';
1
+ import { HttpUserAgentOptions, Middleware } from "../types/types.js";
2
2
  export default function createUserAgentMiddleware(options?: HttpUserAgentOptions): Middleware;
@@ -1,8 +1,8 @@
1
- export { default as createCorrelationIdMiddleware } from './create-correlation-id-middleware';
2
- export { default as createHttpMiddleware } from './create-http-middleware';
3
- export { default as createQueueMiddleware } from './create-queue-middleware';
4
- export { default as createLoggerMiddleware } from './create-logger-middleware';
5
- export { default as createUserAgentMiddleware } from './create-user-agent-middleware';
6
- export { default as createConcurrentModificationMiddleware } from './create-concurrent-modification-middleware';
7
- export { default as createErrorMiddleware } from './create-error-middleware';
8
- export { createAuthMiddlewareForPasswordFlow, createAuthMiddlewareForClientCredentialsFlow, createAuthMiddlewareForAnonymousSessionFlow, createAuthMiddlewareForExistingTokenFlow, createAuthMiddlewareForRefreshTokenFlow } from './auth-middleware';
1
+ export { createAuthMiddlewareForAnonymousSessionFlow, createAuthMiddlewareForClientCredentialsFlow, createAuthMiddlewareForExistingTokenFlow, createAuthMiddlewareForPasswordFlow, createAuthMiddlewareForRefreshTokenFlow } from "./auth-middleware/index.js";
2
+ export { default as createConcurrentModificationMiddleware } from "./create-concurrent-modification-middleware.js";
3
+ export { default as createCorrelationIdMiddleware } from "./create-correlation-id-middleware.js";
4
+ export { default as createErrorMiddleware } from "./create-error-middleware.js";
5
+ export { default as createHttpMiddleware } from "./create-http-middleware.js";
6
+ export { default as createLoggerMiddleware } from "./create-logger-middleware.js";
7
+ export { default as createQueueMiddleware } from "./create-queue-middleware.js";
8
+ export { default as createUserAgentMiddleware } from "./create-user-agent-middleware.js";
@@ -1,5 +1,5 @@
1
- import { Buffer } from 'buffer/'
2
1
  import AbortController from 'abort-controller'
2
+ import { Buffer } from 'buffer/'
3
3
 
4
4
  export type Nullable<T> = T | null
5
5
  export type Keys = string | number | symbol
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@commercetools/ts-client",
3
- "version": "1.0.0",
3
+ "version": "1.1.1",
4
4
  "engines": {
5
5
  "node": ">=14"
6
6
  },
@@ -36,7 +36,7 @@
36
36
  "abort-controller": "3.0.0",
37
37
  "buffer": "^6.0.3",
38
38
  "node-fetch": "^2.6.1",
39
- "querystring": "^0.2.1"
39
+ "uuid": "9.0.0"
40
40
  },
41
41
  "files": ["dist", "CHANGELOG.md"],
42
42
  "author": "Chukwuemeka Ajima <meeky.ae@gmail.com>",
@@ -48,8 +48,8 @@
48
48
  },
49
49
  "devDependencies": {
50
50
  "common-tags": "1.8.2",
51
- "dotenv": "16.0.3",
52
- "jest": "29.5.0",
51
+ "dotenv": "16.3.1",
52
+ "jest": "29.6.2",
53
53
  "nock": "12.0.3",
54
54
  "organize-imports-cli": "0.10.0"
55
55
  },
@@ -1,24 +0,0 @@
1
- import { IBuiltRequestParams, AuthMiddlewareOptions, RefreshAuthMiddlewareOptions, PasswordAuthMiddlewareOptions } from '../../types/types';
2
- /**
3
- *
4
- * @param {AuthMiddlewareOptions} options
5
- * @returns { IBuiltRequestParams } *
6
- */
7
- export declare function buildRequestForClientCredentialsFlow(options: AuthMiddlewareOptions): IBuiltRequestParams;
8
- /**
9
- *
10
- * @param {AuthMiddlewareOptions} options
11
- * @returns {IBuiltRequestParams} *
12
- */
13
- export declare function buildRequestForAnonymousSessionFlow(options: AuthMiddlewareOptions): IBuiltRequestParams;
14
- /**
15
- *
16
- * @param {RefreshAuthMiddlewareOptions} options
17
- * @returns {IBuiltRequestParams}
18
- */
19
- export declare function buildRequestForRefreshTokenFlow(options: RefreshAuthMiddlewareOptions): IBuiltRequestParams;
20
- /**
21
- * @param {PasswordAuthMiddlewareOptions} options
22
- * @returns {IBuiltRequestParams}
23
- */
24
- export declare function buildRequestForPasswordFlow(options: PasswordAuthMiddlewareOptions): IBuiltRequestParams;
@@ -1,2 +0,0 @@
1
- import { ClientRequest, executeRequestOptions } from '../../types/types';
2
- export declare function executeRequest(options: executeRequestOptions): Promise<ClientRequest>;
@@ -1,5 +0,0 @@
1
- export declare const HEADERS_CONTENT_TYPES: string[];
2
- export declare const CONCURRENCT_REQUEST = 20;
3
- export declare const CTP_API_URL = "https://api.europe-west1.gcp.commercetools.com";
4
- export declare const CTP_AUTH_URL = "https://auth.europe-west1.gcp.commercetools.com";
5
- export declare const DEFAULT_HEADERS: string[];
@@ -1,8 +0,0 @@
1
- import { HttpErrorType } from '../types/types';
2
- type ErrorType = ErrorArgs & Partial<HttpErrorType>;
3
- type ErrorArgs = {
4
- statusCode: number;
5
- message: string;
6
- };
7
- declare function createError({ statusCode, message, ...rest }: ErrorType): HttpErrorType;
8
- export default createError;
@@ -1,10 +0,0 @@
1
- export declare function NetworkError(...args: Array<unknown>): void;
2
- export declare function HttpError(...args: Array<unknown>): void;
3
- export declare function BadRequest(...args: Array<unknown>): void;
4
- export declare function Unauthorized(...args: Array<unknown>): void;
5
- export declare function Forbidden(...args: Array<unknown>): void;
6
- export declare function NotFound(...args: Array<unknown>): void;
7
- export declare function ConcurrentModification(...args: Array<unknown>): void;
8
- export declare function InternalServerError(...args: Array<unknown>): void;
9
- export declare function ServiceUnavailable(...args: Array<unknown>): void;
10
- export default function getErrorByCode(code: number): typeof NetworkError;
@@ -1,2 +0,0 @@
1
- import { TResponse, HttpClientConfig } from '../types/types';
2
- export default function executor(request: HttpClientConfig): Promise<TResponse>;
@@ -1 +0,0 @@
1
- export default function generateID(): string;
@@ -1,2 +0,0 @@
1
- import { JsonObject } from '../types/types';
2
- export default function getHeaders(headers: JsonObject<any>): JsonObject<string>;
@@ -1,17 +0,0 @@
1
- export { default as getHeaders } from './headers';
2
- export { default as isBuffer } from './isBuffer';
3
- export { default as calculateRetryDelay } from './retryDelay';
4
- export { default as generate } from './generateID';
5
- export { default as userAgent } from './userAgent';
6
- export { default as maskAuthData } from './maskAuthData';
7
- export { default as calculateExpirationTime } from './tokenExpirationTime';
8
- export { default as buildTokenCacheKey } from './tokenCacheKey';
9
- export { default as store } from './tokenStore';
10
- export { default as mergeAuthHeader } from './mergeAuthHeader';
11
- export { default as executor } from './executor';
12
- export * as constants from './constants';
13
- export { default as sleep } from './sleep';
14
- export { default as METHODS } from './methods';
15
- export { default as createError } from './createError';
16
- export { NetworkError } from './errors';
17
- export { validateRetryCodes, validateHttpOptions, validateClient, validate } from './validate';
@@ -1 +0,0 @@
1
- export default function isBuffer(obj: any): boolean;
@@ -1,2 +0,0 @@
1
- import { MiddlewareRequest } from '../types/types';
2
- export default function maskAuthData(request: MiddlewareRequest): import("../types/types").ClientRequest;
@@ -1,2 +0,0 @@
1
- import { MiddlewareRequest } from '../types/types';
2
- export default function mergeAuthHeader(token: string, req: MiddlewareRequest): MiddlewareRequest;
@@ -1,2 +0,0 @@
1
- declare const _default: string[];
2
- export default _default;
@@ -1,8 +0,0 @@
1
- export type TRetryPolicy = {
2
- retryCount: number;
3
- retryDelay: number;
4
- maxRetries: number;
5
- backoff: boolean;
6
- maxDelay: number;
7
- };
8
- export default function calculateRetryDelay({ retryCount, retryDelay, backoff, maxDelay, }: TRetryPolicy): number;
@@ -1 +0,0 @@
1
- export default function sleep(ms: number): Promise<void>;
@@ -1,2 +0,0 @@
1
- import { AuthMiddlewareOptions, TokenCacheOptions } from '../types/types';
2
- export default function buildTokenCacheKey(options: AuthMiddlewareOptions): TokenCacheOptions;
@@ -1 +0,0 @@
1
- export default function calculateExpirationTime(expiresIn: number): number;
@@ -1,2 +0,0 @@
1
- import { TokenCacheOptions } from '../types/types';
2
- export default function store<T, V, S = TokenCacheOptions>(initVal: T): V;
@@ -1,2 +0,0 @@
1
- import { HttpUserAgentOptions } from '../types/types';
2
- export default function createUserAgent(options: HttpUserAgentOptions): string;
@@ -1,25 +0,0 @@
1
- import { ClientRequest, HttpMiddlewareOptions, Middleware } from '../types/types';
2
- /**
3
- * validate some essential http options
4
- * @param options
5
- */
6
- export declare function validateHttpOptions(options: HttpMiddlewareOptions): void;
7
- /**
8
- *
9
- * @param retryCodes
10
- * @example
11
- * const retryCodes = [500, 504, "ETIMEDOUT"]
12
- */
13
- export declare function validateRetryCodes(retryCodes: Array<string | number>): void;
14
- /**
15
- * @param options
16
- */
17
- export declare function validateClient(options: {
18
- middlewares: Array<Middleware>;
19
- }): void;
20
- /**
21
- * @param options
22
- */
23
- export declare function validate(funcName: string, request: ClientRequest, options?: {
24
- allowedMethods: Array<string>;
25
- }): void;