@gradientedge/commercetools-utils 5.9.1 → 5.11.0

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

@@ -0,0 +1,83 @@
+import { CommercetoolsAuthApiConfig, CommercetoolsGrantResponse, LoginOptions, LogoutOptions, RevokeTokenOptions } from './types.js';
+import { CommercetoolsRequest } from '../index.js';
+import { RegionEndpoints } from '../types.js';
+/**
+ * Provides an easy to use set of methods for communicating with the commercetools
+ * HTTP Authorization API
+ */
+export declare class CommercetoolsAuthApi {
+    /**
+     * The internal configuration. This is a combination of the `CommercetoolsAuthConfig`
+     * type passed in to the constructor and the default values specified in the
+     * `configDefaults` object.
+     */
+    readonly config: CommercetoolsAuthApiConfig;
+    /**
+     * The Auth and API endpoints driven by the user's setting of {@link CommercetoolsAuthApiConfig.region}
+     * https://docs.commercetools.com/api/general-concepts#regions
+     */
+    readonly endpoints: RegionEndpoints;
+    /**
+     * The request executor that's responsible for making the request to commercetools
+     */
+    private readonly requestExecutor;
+    constructor(config: CommercetoolsAuthApiConfig);
+    /**
+     * Get a new client grant:
+     * https://docs.commercetools.com/api/authorization#client-credentials-flow
+     */
+    getClientGrant(scopes: string[]): Promise<CommercetoolsGrantResponse>;
+    /**
+     * Refresh a customer or client grant given a refresh token:
+     * https://docs.commercetools.com/api/authorization#refresh-token-flow
+     */
+    refreshGrant(refreshToken: string): Promise<CommercetoolsGrantResponse>;
+    /**
+     * Login the customer using the given options:
+     * https://docs.commercetools.com/api/authorization#password-flow
+     */
+    login(options: LoginOptions & {
+        scopes: string[];
+    }): Promise<CommercetoolsGrantResponse>;
+    /**
+     * Revoke a refresh or access token:
+     * https://docs.commercetools.com/api/authorization#revoking-tokens
+     *
+     * If you're logging out a customer, you will likely want to call this method twice;
+     * once with the access token and once with the refresh token (you can call these in parallel).
+     */
+    revokeToken(options: RevokeTokenOptions): Promise<void>;
+    /**
+     * Log the customer out
+     *
+     * This is a convenience mechanism which makes 2 calls to the `revokeToken` method under
+     * the hood (in parallel). One with the access token and one with the refresh token.
+     */
+    logout(options: LogoutOptions): Promise<void>;
+    /**
+     * Get a grant an anonymous customer:
+     * https://docs.commercetools.com/api/authorization#tokens-for-anonymous-sessions
+     */
+    getAnonymousGrant(options?: {
+        anonymousId?: string;
+        scopes: string[];
+    }): Promise<CommercetoolsGrantResponse>;
+    /**
+     * Construct and send a request to the commercetools auth endpoint.
+     */
+    post(path: string, body: Record<string, any>): Promise<CommercetoolsGrantResponse>;
+    /**
+     * Generate request options. These are then fed in to axios when
+     * making the request to commercetools.
+     */
+    getRequestOptions(options: {
+        path: string;
+        correlationId?: string | undefined;
+        body: Record<string, any>;
+    }): CommercetoolsRequest;
+    /**
+     * Applies the store key to a given path
+     */
+    applyStore(path: string, storeKey: string | undefined | null): string;
+}
+//# sourceMappingURL=CommercetoolsAuthApi.d.ts.map

package/dist/mjs/auth/CommercetoolsAuthApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommercetoolsAuthApi.d.ts","sourceRoot":"","sources":["../../../src/lib/auth/CommercetoolsAuthApi.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,0BAA0B,EAC1B,0BAA0B,EAE1B,YAAY,EACZ,aAAa,EACb,kBAAkB,EACnB,MAAM,YAAY,CAAA;AACnB,OAAO,EAAsB,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAItE,OAAO,EAAE,eAAe,EAAmB,MAAM,aAAa,CAAA;AAG9D;;;GAGG;AACH,qBAAa,oBAAoB;IAC/B;;;;OAIG;IACH,SAAgB,MAAM,EAAE,0BAA0B,CAAA;IAElD;;;OAGG;IACH,SAAgB,SAAS,EAAE,eAAe,CAAA;IAE1C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;gBAErC,MAAM,EAAE,0BAA0B;IAa9C;;;OAGG;IACU,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAOlF;;;OAGG;IACU,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAOpF;;;OAGG;IACU,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG;QAAE,MAAM,EAAE,MAAM,EAAE,CAAA;KAAE,GAAG,OAAO,CAAC,0BAA0B,CAAC;IASrG;;;;;;OAMG;IACU,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAOpE;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB1D;;;OAGG;IACU,iBAAiB,CAAC,OAAO,CAAC,EAAE;QACvC,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,MAAM,EAAE,MAAM,EAAE,CAAA;KACjB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAavC;;OAEG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAI/F;;;OAGG;IACH,iBAAiB,CAAC,OAAO,EAAE;QACzB,IAAI,EAAE,MAAM,CAAA;QACZ,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAClC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAC1B,GAAG,oBAAoB;IA0BxB;;OAEG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,MAAM;CAQtE"}

package/dist/mjs/auth/CommercetoolsAuthApi.js

@@ -0,0 +1,165 @@
+import { GrantType, } from './types.js';
+import { CommercetoolsError } from '../index.js';
+import { scopeArrayToRequestString } from './scopes.js';
+import { REGION_URLS } from './constants.js';
+import { base64EncodeForBasicAuth } from './utils.js';
+import { getRequestExecutor } from '../request/request-executor.js';
+/**
+ * Provides an easy to use set of methods for communicating with the commercetools
+ * HTTP Authorization API
+ */
+export class CommercetoolsAuthApi {
+    /**
+     * The internal configuration. This is a combination of the `CommercetoolsAuthConfig`
+     * type passed in to the constructor and the default values specified in the
+     * `configDefaults` object.
+     */
+    config;
+    /**
+     * The Auth and API endpoints driven by the user's setting of {@link CommercetoolsAuthApiConfig.region}
+     * https://docs.commercetools.com/api/general-concepts#regions
+     */
+    endpoints;
+    /**
+     * The request executor that's responsible for making the request to commercetools
+     */
+    requestExecutor;
+    constructor(config) {
+        this.config = config;
+        this.endpoints = REGION_URLS[this.config.region];
+        this.requestExecutor = getRequestExecutor({
+            timeoutMs: config.timeoutMs,
+            httpsAgent: config.httpsAgent,
+            systemIdentifier: config.systemIdentifier,
+            onBeforeRequest: config.onBeforeRequest,
+            onAfterResponse: config.onAfterResponse,
+            retry: config.retry,
+        });
+    }
+    /**
+     * Get a new client grant:
+     * https://docs.commercetools.com/api/authorization#client-credentials-flow
+     */
+    async getClientGrant(scopes) {
+        return this.post('/token', {
+            grant_type: GrantType.CLIENT_CREDENTIALS,
+            scope: scopeArrayToRequestString(scopes, this.config.projectKey),
+        });
+    }
+    /**
+     * Refresh a customer or client grant given a refresh token:
+     * https://docs.commercetools.com/api/authorization#refresh-token-flow
+     */
+    async refreshGrant(refreshToken) {
+        return await this.post('/token', {
+            grant_type: GrantType.REFRESH_TOKEN,
+            refresh_token: refreshToken,
+        });
+    }
+    /**
+     * Login the customer using the given options:
+     * https://docs.commercetools.com/api/authorization#password-flow
+     */
+    async login(options) {
+        return this.post(`/${this.config.projectKey}${this.applyStore('/customers/token', options.storeKey)}`, {
+            username: options.username,
+            password: options.password,
+            grant_type: GrantType.PASSWORD,
+            scope: scopeArrayToRequestString(options.scopes, this.config.projectKey),
+        });
+    }
+    /**
+     * Revoke a refresh or access token:
+     * https://docs.commercetools.com/api/authorization#revoking-tokens
+     *
+     * If you're logging out a customer, you will likely want to call this method twice;
+     * once with the access token and once with the refresh token (you can call these in parallel).
+     */
+    async revokeToken(options) {
+        await this.post('/token/revoke', {
+            token: options.tokenValue,
+            token_type_hint: options.tokenType,
+        });
+    }
+    /**
+     * Log the customer out
+     *
+     * This is a convenience mechanism which makes 2 calls to the `revokeToken` method under
+     * the hood (in parallel). One with the access token and one with the refresh token.
+     */
+    async logout(options) {
+        const settlements = await Promise.allSettled([
+            this.revokeToken({ tokenType: 'access_token', tokenValue: options.accessToken }),
+            this.revokeToken({ tokenType: 'refresh_token', tokenValue: options.refreshToken }),
+        ]);
+        const errors = settlements.reduce((errors, settlement) => {
+            if (settlement.status === 'rejected') {
+                errors.push(settlement.reason);
+            }
+            return errors;
+        }, []);
+        if (errors.length) {
+            throw new CommercetoolsError(`Logout failed in one or more calls to the token revocation endpoint`, errors);
+        }
+    }
+    /**
+     * Get a grant an anonymous customer:
+     * https://docs.commercetools.com/api/authorization#tokens-for-anonymous-sessions
+     */
+    async getAnonymousGrant(options) {
+        const postOptions = {
+            grant_type: GrantType.CLIENT_CREDENTIALS,
+        };
+        if (options?.scopes?.length) {
+            postOptions.scope = scopeArrayToRequestString(options.scopes, this.config.projectKey);
+        }
+        if (options?.anonymousId) {
+            postOptions.anonymous_id = options.anonymousId;
+        }
+        return this.post(`/${this.config.projectKey}/anonymous/token`, postOptions);
+    }
+    /**
+     * Construct and send a request to the commercetools auth endpoint.
+     */
+    async post(path, body) {
+        return await this.requestExecutor(this.getRequestOptions({ path, body }));
+    }
+    /**
+     * Generate request options. These are then fed in to axios when
+     * making the request to commercetools.
+     */
+    getRequestOptions(options) {
+        const url = `${this.endpoints.auth}/oauth${options.path}`;
+        let data;
+        const headers = {
+            Authorization: `Basic ${base64EncodeForBasicAuth(this.config.clientId, this.config.clientSecret)}`,
+            'Content-Type': 'application/x-www-form-urlencoded',
+        };
+        if (options.correlationId && options.correlationId !== '') {
+            headers['X-Correlation-ID'] = options.correlationId;
+            delete options.correlationId;
+        }
+        if (options.body) {
+            data = new URLSearchParams(options.body).toString();
+        }
+        return {
+            method: 'POST',
+            data,
+            url,
+            headers,
+        };
+    }
+    /**
+     * Applies the store key to a given path
+     */
+    applyStore(path, storeKey) {
+        if (typeof storeKey === 'string' && storeKey !== '') {
+            return `/in-store/key=${storeKey}${path}`;
+        }
+        else if (this.config.storeKey) {
+            return `/in-store/key=${this.config.storeKey}${path}`;
+        }
+        return path;
+    }
+}
+//# sourceMappingURL=CommercetoolsAuthApi.js.map

package/dist/mjs/auth/CommercetoolsAuthApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommercetoolsAuthApi.js","sourceRoot":"","sources":["../../../src/lib/auth/CommercetoolsAuthApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,SAAS,GAIV,MAAM,YAAY,CAAA;AACnB,OAAO,EAAE,kBAAkB,EAAwB,MAAM,aAAa,CAAA;AACtE,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAA;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAA;AAErD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AAEnE;;;GAGG;AACH,MAAM,OAAO,oBAAoB;IAC/B;;;;OAIG;IACa,MAAM,CAA4B;IAElD;;;OAGG;IACa,SAAS,CAAiB;IAE1C;;OAEG;IACc,eAAe,CAAiB;IAEjD,YAAY,MAAkC;QAC5C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAChD,IAAI,CAAC,eAAe,GAAG,kBAAkB,CAAC;YACxC,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;YACzC,eAAe,EAAE,MAAM,CAAC,eAAe;YACvC,eAAe,EAAE,MAAM,CAAC,eAAe;YACvC,KAAK,EAAE,MAAM,CAAC,KAAK;SACpB,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,cAAc,CAAC,MAAgB;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACzB,UAAU,EAAE,SAAS,CAAC,kBAAkB;YACxC,KAAK,EAAE,yBAAyB,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;SACjE,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,YAAoB;QAC5C,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAC/B,UAAU,EAAE,SAAS,CAAC,aAAa;YACnC,aAAa,EAAE,YAAY;SAC5B,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,KAAK,CAAC,OAA4C;QAC7D,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE;YACrG,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,UAAU,EAAE,SAAS,CAAC,QAAQ;YAC9B,KAAK,EAAE,yBAAyB,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;SACzE,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CAAC,OAA2B;QAClD,MAAM,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YAC/B,KAAK,EAAE,OAAO,CAAC,UAAU;YACzB,eAAe,EAAE,OAAO,CAAC,SAAS;SACnC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,OAAsB;QACxC,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC;YAC3C,IAAI,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,cAAc,EAAE,UAAU,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC;YAChF,IAAI,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,UAAU,EAAE,OAAO,CAAC,YAAY,EAAE,CAAC;SACnF,CAAC,CAAA;QACF,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,MAAa,EAAE,UAAU,EAAE,EAAE;YAC9D,IAAI,UAAU,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;gBACrC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;YAChC,CAAC;YACD,OAAO,MAAM,CAAA;QACf,CAAC,EAAE,EAAE,CAAC,CAAA;QACN,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAClB,MAAM,IAAI,kBAAkB,CAAC,qEAAqE,EAAE,MAAM,CAAC,CAAA;QAC7G,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,iBAAiB,CAAC,OAG9B;QACC,MAAM,WAAW,GAAwB;YACvC,UAAU,EAAE,SAAS,CAAC,kBAAkB;SACzC,CAAA;QACD,IAAI,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;YAC5B,WAAW,CAAC,KAAK,GAAG,yBAAyB,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;QACvF,CAAC;QACD,IAAI,OAAO,EAAE,WAAW,EAAE,CAAC;YACzB,WAAW,CAAC,YAAY,GAAG,OAAO,CAAC,WAAW,CAAA;QAChD,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,kBAAkB,EAAE,WAAW,CAAC,CAAA;IAC7E,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CAAC,IAAY,EAAE,IAAyB;QACvD,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;IAC3E,CAAC;IAED;;;OAGG;IACH,iBAAiB,CAAC,OAIjB;QACC,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,SAAS,OAAO,CAAC,IAAI,EAAE,CAAA;QACzD,IAAI,IAAqB,CAAA;QAEzB,MAAM,OAAO,GAA2B;YACtC,aAAa,EAAE,SAAS,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE;YAClG,cAAc,EAAE,mCAAmC;SACpD,CAAA;QAED,IAAI,OAAO,CAAC,aAAa,IAAI,OAAO,CAAC,aAAa,KAAK,EAAE,EAAE,CAAC;YAC1D,OAAO,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,aAAa,CAAA;YACnD,OAAO,OAAO,CAAC,aAAa,CAAA;QAC9B,CAAC;QAED,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,IAAI,GAAG,IAAI,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAA;QACrD,CAAC;QAED,OAAO;YACL,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,GAAG;YACH,OAAO;SACR,CAAA;IACH,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,IAAY,EAAE,QAAmC;QAC1D,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,EAAE,EAAE,CAAC;YACpD,OAAO,iBAAiB,QAAQ,GAAG,IAAI,EAAE,CAAA;QAC3C,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YAChC,OAAO,iBAAiB,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,IAAI,EAAE,CAAA;QACvD,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;CACF"}

package/dist/mjs/auth/CommercetoolsGrant.d.ts

@@ -0,0 +1,66 @@
+import { CommercetoolsGrantResponse } from './types.js';
+/**
+ * Holds the details of the grant returned from commercetools in response
+ * to an authorisation API related request:
+ * https://docs.commercetools.com/api/authorization
+ */
+export declare class CommercetoolsGrant {
+    /**
+     * The access token string needed when making requests to commercetools. If this
+     * was generated by a customer logging in, then this is used by commercetools
+     * to identify the customer.
+     */
+    accessToken: string;
+    /**
+     * The refresh token is required for refreshing an existing grant. A refresh token
+     * is only issued for customer grants (either logged in or anonymous), an not for
+     * client grants.
+     */
+    refreshToken?: string;
+    /**
+     * The duration of the access token in seconds (typically 48 hours)
+     */
+    expiresIn: number;
+    /**
+     * This is the expiry date/time of the access token. This is calculated based
+     * on the `expiredIn` property, and as such may be very slightly after the
+     * internal commercetools expiry date (due to the time involved to receive
+     * and process the response.
+     */
+    expiresAt: Date;
+    /**
+     * List of permission scopes. This will also include the `anonymous_id` when
+     * generating an anonymous customer token, or the `customer_id` when logging
+     * in as an existing customer.
+     */
+    scopes: string[];
+    /**
+     * When this grant came from a call to {@see CommercetoolsAuth.getAnonymousGrant}
+     * or {@see CommercetoolsApi.getAnonymousGrant} then the value will be populated
+     * with the id of the anonymous customer to which this grant relates.
+     */
+    anonymousId?: string;
+    /**
+     * When this grant is generated from a call to {@see CommercetoolsAuth.login}
+     * or {@see CommercetoolsApi.login} then this value will be populated with the
+     * id of the customer to which this grant relates.
+     */
+    customerId?: string;
+    /**
+     * Create a new grant from grant data received back from commercetools.
+     */
+    constructor(data: CommercetoolsGrantResponse);
+    /**
+     * Calculates whether the grant is due to expire within a given number of
+     * seconds. This is useful when deciding if the expiry date/time is close
+     * enough to warrant pro-active renewal, rather than waiting for expiry.
+     */
+    expiresWithin(refreshIfWithinSecs: number): boolean;
+    /**
+     * Given a scope string (as returned from commercetools), this method
+     * extracts the value of the associated with the given key. Used for
+     * retrieving the anonymous id and customer id from the scope string.
+     */
+    extractKeyFromScope(key: string, scope: string): string | undefined;
+}
+//# sourceMappingURL=CommercetoolsGrant.d.ts.map

package/dist/mjs/auth/CommercetoolsGrant.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommercetoolsGrant.d.ts","sourceRoot":"","sources":["../../../src/lib/auth/CommercetoolsGrant.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAA;AAGvD;;;;GAIG;AACH,qBAAa,kBAAkB;IAC7B;;;;OAIG;IACI,WAAW,SAAK;IAEvB;;;;OAIG;IACI,YAAY,CAAC,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACI,SAAS,SAAI;IAEpB;;;;;OAKG;IACI,SAAS,OAAa;IAE7B;;;;OAIG;IACI,MAAM,EAAE,MAAM,EAAE,CAAK;IAE5B;;;;OAIG;IACI,WAAW,CAAC,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACI,UAAU,CAAC,EAAE,MAAM,CAAA;IAE1B;;OAEG;gBACS,IAAI,EAAE,0BAA0B;IAiB5C;;;;OAIG;IACI,aAAa,CAAC,mBAAmB,EAAE,MAAM,GAAG,OAAO;IAK1D;;;;OAIG;IACI,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;CAc3E"}

package/dist/mjs/auth/CommercetoolsGrant.js

@@ -0,0 +1,95 @@
+import { scopeRequestStringToArray } from './scopes.js';
+/**
+ * Holds the details of the grant returned from commercetools in response
+ * to an authorisation API related request:
+ * https://docs.commercetools.com/api/authorization
+ */
+export class CommercetoolsGrant {
+    /**
+     * The access token string needed when making requests to commercetools. If this
+     * was generated by a customer logging in, then this is used by commercetools
+     * to identify the customer.
+     */
+    accessToken = '';
+    /**
+     * The refresh token is required for refreshing an existing grant. A refresh token
+     * is only issued for customer grants (either logged in or anonymous), an not for
+     * client grants.
+     */
+    refreshToken;
+    /**
+     * The duration of the access token in seconds (typically 48 hours)
+     */
+    expiresIn = 0;
+    /**
+     * This is the expiry date/time of the access token. This is calculated based
+     * on the `expiredIn` property, and as such may be very slightly after the
+     * internal commercetools expiry date (due to the time involved to receive
+     * and process the response.
+     */
+    expiresAt = new Date();
+    /**
+     * List of permission scopes. This will also include the `anonymous_id` when
+     * generating an anonymous customer token, or the `customer_id` when logging
+     * in as an existing customer.
+     */
+    scopes = [];
+    /**
+     * When this grant came from a call to {@see CommercetoolsAuth.getAnonymousGrant}
+     * or {@see CommercetoolsApi.getAnonymousGrant} then the value will be populated
+     * with the id of the anonymous customer to which this grant relates.
+     */
+    anonymousId;
+    /**
+     * When this grant is generated from a call to {@see CommercetoolsAuth.login}
+     * or {@see CommercetoolsApi.login} then this value will be populated with the
+     * id of the customer to which this grant relates.
+     */
+    customerId;
+    /**
+     * Create a new grant from grant data received back from commercetools.
+     */
+    constructor(data) {
+        this.accessToken = data.access_token;
+        this.expiresIn = data.expires_in;
+        this.scopes = scopeRequestStringToArray(data.scope);
+        this.anonymousId = this.extractKeyFromScope('anonymous_id', data.scope);
+        this.customerId = this.extractKeyFromScope('customer_id', data.scope);
+        // This sets the `expiresAt` property to the calculated Date when the grant is due to expire.
+        this.expiresAt = new Date(new Date().getTime() + 1000 * data.expires_in);
+        // When a grant is refreshed, we don't get back a new token,
+        // so we keep hold of the old one unless one is explicitly provided.
+        if ('refresh_token' in data && data.refresh_token) {
+            this.refreshToken = data.refresh_token;
+        }
+    }
+    /**
+     * Calculates whether the grant is due to expire within a given number of
+     * seconds. This is useful when deciding if the expiry date/time is close
+     * enough to warrant pro-active renewal, rather than waiting for expiry.
+     */
+    expiresWithin(refreshIfWithinSecs) {
+        const cutoff = new Date().getTime() + refreshIfWithinSecs * 1000;
+        return this.expiresAt.getTime() < cutoff;
+    }
+    /**
+     * Given a scope string (as returned from commercetools), this method
+     * extracts the value of the associated with the given key. Used for
+     * retrieving the anonymous id and customer id from the scope string.
+     */
+    extractKeyFromScope(key, scope) {
+        if (!scope || !key) {
+            return undefined;
+        }
+        const parts = scope?.split(' ');
+        if (!Array.isArray(parts) || parts.length === 0) {
+            return undefined;
+        }
+        const item = parts.find((part) => part.slice(0, key.length + 1) === `${key}:`);
+        if (item) {
+            return item.slice(key.length + 1);
+        }
+        return undefined;
+    }
+}
+//# sourceMappingURL=CommercetoolsGrant.js.map

package/dist/mjs/auth/CommercetoolsGrant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommercetoolsGrant.js","sourceRoot":"","sources":["../../../src/lib/auth/CommercetoolsGrant.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAA;AAEvD;;;;GAIG;AACH,MAAM,OAAO,kBAAkB;IAC7B;;;;OAIG;IACI,WAAW,GAAG,EAAE,CAAA;IAEvB;;;;OAIG;IACI,YAAY,CAAS;IAE5B;;OAEG;IACI,SAAS,GAAG,CAAC,CAAA;IAEpB;;;;;OAKG;IACI,SAAS,GAAG,IAAI,IAAI,EAAE,CAAA;IAE7B;;;;OAIG;IACI,MAAM,GAAa,EAAE,CAAA;IAE5B;;;;OAIG;IACI,WAAW,CAAS;IAE3B;;;;OAIG;IACI,UAAU,CAAS;IAE1B;;OAEG;IACH,YAAY,IAAgC;QAC1C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAA;QACpC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,UAAU,CAAA;QAChC,IAAI,CAAC,MAAM,GAAG,yBAAyB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACnD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;QACvE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,mBAAmB,CAAC,aAAa,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;QAErE,6FAA6F;QAC7F,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAA;QAExE,4DAA4D;QAC5D,oEAAoE;QACpE,IAAI,eAAe,IAAI,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAClD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,aAAa,CAAA;QACxC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,mBAA2B;QAC9C,MAAM,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,mBAAmB,GAAG,IAAI,CAAA;QAChE,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,MAAM,CAAA;IAC1C,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CAAC,GAAW,EAAE,KAAa;QACnD,IAAI,CAAC,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC;YACnB,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,MAAM,KAAK,GAAG,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;QAC/B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChD,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,GAAG,GAAG,CAAC,CAAA;QAC9E,IAAI,IAAI,EAAE,CAAC;YACT,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QACnC,CAAC;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;CACF"}

package/dist/mjs/auth/constants.d.ts

@@ -0,0 +1,7 @@
+import { Region, RegionEndpoints } from '../types.js';
+/**
+ * Commercetools regions and cloud providers - https://docs.commercetools.com/api/general-concepts#hosts
+ */
+export declare const REGION_URLS: Record<Region, RegionEndpoints>;
+export declare const INVALID_SCOPES: string[];
+//# sourceMappingURL=constants.d.ts.map

package/dist/mjs/auth/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/lib/auth/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAErD;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAqBvD,CAAA;AAED,eAAO,MAAM,cAAc,UAAkC,CAAA"}

package/dist/mjs/auth/constants.js

@@ -0,0 +1,28 @@
+import { Region } from '../types.js';
+/**
+ * Commercetools regions and cloud providers - https://docs.commercetools.com/api/general-concepts#hosts
+ */
+export const REGION_URLS = {
+    [Region.EUROPE_GCP]: {
+        auth: 'https://auth.europe-west1.gcp.commercetools.com',
+        api: 'https://api.europe-west1.gcp.commercetools.com',
+    },
+    [Region.EUROPE_AWS]: {
+        auth: 'https://auth.eu-central-1.aws.commercetools.com',
+        api: 'https://api.eu-central-1.aws.commercetools.com',
+    },
+    [Region.NORTH_AMERICA_GCP]: {
+        auth: 'https://auth.us-central1.gcp.commercetools.com',
+        api: 'https://api.us-central1.gcp.commercetools.com',
+    },
+    [Region.NORTH_AMERICA_AWS]: {
+        auth: 'https://auth.us-east-2.aws.commercetools.com',
+        api: 'https://api.us-east-2.aws.commercetools.com',
+    },
+    [Region.AUSTRALIA_GCP]: {
+        auth: 'https://auth.australia-southeast1.gcp.commercetools.com',
+        api: 'https://api.australia-southeast1.gcp.commercetools.com',
+    },
+};
+export const INVALID_SCOPES = ['anonymous_id', 'customer_id'];
+//# sourceMappingURL=constants.js.map

package/dist/mjs/auth/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/lib/auth/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAmB,MAAM,aAAa,CAAA;AAErD;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAoC;IAC1D,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE;QACnB,IAAI,EAAE,iDAAiD;QACvD,GAAG,EAAE,gDAAgD;KACtD;IACD,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE;QACnB,IAAI,EAAE,iDAAiD;QACvD,GAAG,EAAE,gDAAgD;KACtD;IACD,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE;QAC1B,IAAI,EAAE,gDAAgD;QACtD,GAAG,EAAE,+CAA+C;KACrD;IACD,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE;QAC1B,IAAI,EAAE,8CAA8C;QACpD,GAAG,EAAE,6CAA6C;KACnD;IACD,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE;QACtB,IAAI,EAAE,yDAAyD;QAC/D,GAAG,EAAE,wDAAwD;KAC9D;CACF,CAAA;AAED,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,cAAc,EAAE,aAAa,CAAC,CAAA"}

package/dist/mjs/auth/index.d.ts

@@ -0,0 +1,4 @@
+export * from './CommercetoolsAuth.js';
+export * from './CommercetoolsGrant.js';
+export type { CommercetoolsAuthConfig, AnonymousGrantOptions, GrantType, LoginOptions } from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/mjs/auth/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/auth/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,YAAY,EAAE,uBAAuB,EAAE,qBAAqB,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA"}

package/dist/mjs/auth/index.js

@@ -0,0 +1,3 @@
+export * from './CommercetoolsAuth.js';
+export * from './CommercetoolsGrant.js';
+//# sourceMappingURL=index.js.map

package/dist/mjs/auth/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/auth/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA"}

package/dist/mjs/auth/scopes.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Take an array of scope strings and form them in to a string
+ * that is appropriate for the `scope` parameter in requests to commercetools.
+ */
+export declare function scopeArrayToRequestString(scopes: string[], projectKey: string): string;
+/**
+ * Take the scopes string returned by commercetools and parse it in to an
+ * array of scope strings.
+ */
+export declare function scopeRequestStringToArray(scopes: string): string[];
+//# sourceMappingURL=scopes.d.ts.map

package/dist/mjs/auth/scopes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scopes.d.ts","sourceRoot":"","sources":["../../../src/lib/auth/scopes.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAKtF;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAQlE"}

package/dist/mjs/auth/scopes.js

@@ -0,0 +1,25 @@
+import { INVALID_SCOPES } from './constants.js';
+/**
+ * Take an array of scope strings and form them in to a string
+ * that is appropriate for the `scope` parameter in requests to commercetools.
+ */
+export function scopeArrayToRequestString(scopes, projectKey) {
+    if (!scopes.length) {
+        return '';
+    }
+    return scopes.map((scope) => `${scope}:${projectKey}`).join(' ');
+}
+/**
+ * Take the scopes string returned by commercetools and parse it in to an
+ * array of scope strings.
+ */
+export function scopeRequestStringToArray(scopes) {
+    if (!scopes) {
+        return [];
+    }
+    return scopes
+        .split(' ')
+        .map((scope) => scope.split(':')[0])
+        .filter((scope) => !INVALID_SCOPES.includes(scope));
+}
+//# sourceMappingURL=scopes.js.map

package/dist/mjs/auth/scopes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scopes.js","sourceRoot":"","sources":["../../../src/lib/auth/scopes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAE/C;;;GAGG;AACH,MAAM,UAAU,yBAAyB,CAAC,MAAgB,EAAE,UAAkB;IAC5E,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACnB,OAAO,EAAE,CAAA;IACX,CAAC;IACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,IAAI,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAClE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,yBAAyB,CAAC,MAAc;IACtD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,EAAE,CAAA;IACX,CAAC;IACD,OAAO,MAAM;SACV,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;SACnC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAA;AACvD,CAAC"}

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

@@ -0,0 +1,118 @@
+/// <reference types="node" resolution-mode="require"/>
+import { CommercetoolsBaseConfig } from '../types.js';
+import https from 'https';
+/**
+ * Configuration for {@see CommercetoolsAuth}
+ */
+export interface CommercetoolsAuthConfig extends CommercetoolsBaseConfig {
+    refreshIfWithinSecs?: number;
+    customerScopes?: string[];
+    clientScopes: string[];
+}
+/**
+ * Configuration for {@see CommercetoolsAuthApi}
+ */
+export interface CommercetoolsAuthApiConfig extends CommercetoolsBaseConfig {
+    clientScopes?: string[] | undefined;
+    httpsAgent?: https.Agent;
+}
+/**
+ * The object structure that we receive back from commercetools
+ * on a successful call to get a new grant, or refresh an existing one.
+ */
+export interface CommercetoolsGrantResponse {
+    access_token: string;
+    refresh_token?: string;
+    expires_in: number;
+    scope: string;
+}
+/**
+ * This is the LoginOptions description
+ */
+export interface LoginOptions {
+    /**
+     * The customer's username (email address)
+     */
+    username: string;
+    /**
+     * The customer's password
+     */
+    password: string;
+    /**
+     * The scopes to which you want to restrict the customer grant. Note that
+     * these must be a subset of the scopes associated with the client grant.
+     */
+    scopes?: string[];
+    /**
+     * The key of the store to login to
+     */
+    storeKey?: string;
+}
+/**
+ * RevokeTokenOptions
+ */
+export interface RevokeTokenOptions {
+    /**
+     * The type of token to be revoked
+     */
+    tokenType: 'access_token' | 'refresh_token';
+    /**
+     * The value of the token to be revoked
+     */
+    tokenValue: string;
+}
+/**
+ * LogoutOptions
+ */
+export interface LogoutOptions {
+    /**
+     * The customer's access token
+     */
+    accessToken: string;
+    /**
+     * The customer's refresh token
+     */
+    refreshToken: string;
+}
+export interface AnonymousGrantOptions {
+    /**
+     * The scopes of the anonymous customer must be less than or equal to
+     * the scopes of the client API key (ideally, less). If you don't specify
+     * the scopes using this property, then the code will check for the scopes
+     * defined on {@link CommercetoolsAuthConfig.customerScopes}. If scopes
+     * aren't defined there either, than an error will be thrown when a call
+     * is made to {@link CommercetoolsAuth.getAnonymousGrant}
+     */
+    scopes?: string[];
+    /**
+     * If you specify this, you need to be sure that the value does not
+     * already exist as an anonymous customer id in the commercetools system
+     * under your project key. If it does, an error will be thrown when
+     * trying to create the access token.
+     */
+    anonymousId?: string;
+}
+/**
+ * Authentication grant types.
+ * These are used when populating the 'grant_type' parameter.
+ */
+export declare enum GrantType {
+    /**
+     * Used when either requesting a client grant or an
+     * anonymous customer access token:
+     * https://docs.commercetools.com/api/authorization#client-credentials-flow
+     * https://docs.commercetools.com/api/authorization#tokens-for-anonymous-sessions
+     */
+    CLIENT_CREDENTIALS = "client_credentials",
+    /**
+     * Used when refreshing any existing access token (whether client or customer):
+     * https://docs.commercetools.com/api/authorization#refresh-token-flow
+     */
+    REFRESH_TOKEN = "refresh_token",
+    /**
+     * Used when attempting to login a customer:
+     * https://docs.commercetools.com/api/authorization#password-flow
+     */
+    PASSWORD = "password"
+}
+//# sourceMappingURL=types.d.ts.map