@coveo/push-api-client 3.1.5 → 3.1.6

package/dist/APICore.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.APICore = void 0;
 const exponential_backoff_1 = require("exponential-backoff");
+const fetchError_1 = require("./errors/fetchError");
+const throttleError_1 = require("./errors/throttleError");
 class APICore {
     constructor(accessToken) {
         this.accessToken = accessToken;
@@ -9,12 +11,22 @@ class APICore {
     async request(url, config) {
         const req = async () => {
             const response = await fetch(url, Object.assign(Object.assign({}, config), { headers: Object.assign(Object.assign({}, this.requestHeaders), config.headers) }));
+            await this.handleResponse(response);
             return response;
         };
         return (0, exponential_backoff_1.backOff)(req, {
-            retry: (res) => this.isThrottled(res.status),
+            retry: (err) => err instanceof throttleError_1.ThrottleError,
         });
     }
+    async handleResponse(response) {
+        if (response.ok) {
+            return;
+        }
+        if (this.isThrottled(response)) {
+            throw new throttleError_1.ThrottleError();
+        }
+        throw await fetchError_1.FetchError.build(response);
+    }
     async requestJson(url, config) {
         return (await this.request(url, config)).json();
     }
@@ -40,8 +52,8 @@ class APICore {
         const documentsRequestHeaders = Object.assign(Object.assign({}, authorizationHeader), { 'Content-Type': 'application/json', Accept: 'application/json' });
         return documentsRequestHeaders;
     }
-    isThrottled(status) {
-        return status === 429;
+    isThrottled(res) {
+        return res.status === 429;
     }
 }
 exports.APICore = APICore;

package/dist/APICore.js.map

@@ -1 +1 @@
-{"version":3,"file":"APICore.js","sourceRoot":"","sources":["../src/APICore.ts"],"names":[],"mappings":";;;AAAA,6DAA4C;AAE5C,MAAa,OAAO;IAClB,YAA2B,WAAmB;QAAnB,gBAAW,GAAX,WAAW,CAAQ;IAAG,CAAC;IAE1C,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,MAAmB;QACpD,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;YACrB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,kCAC3B,MAAM,KACT,OAAO,kCAAM,IAAI,CAAC,cAAc,GAAK,MAAM,CAAC,OAAO,KACnD,CAAC;YACH,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC;QAEF,OAAO,IAAA,6BAAO,EAAC,GAAG,EAAE;YAClB,KAAK,EAAE,CAAC,GAAa,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC;SACvD,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,WAAW,CAAI,GAAW,EAAE,MAAmB;QAC3D,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,EAAgB,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,IAAI,CAAI,GAAW,EAAE,OAAgB,EAAE;QAClD,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,EAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC;IAC7E,CAAC;IAMM,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,OAAgB,EAAE,EAAE,KAAK,GAAG,IAAI;QAC/D,OAAO,IAAI,CAAC,eAAe,CAAI,KAAK,CAAC,CAAC,GAAG,EAAE;YACzC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAC1B,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;IACL,CAAC;IAEO,eAAe,CAAI,KAAc;QACvC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,WAAc,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjE,CAAC;IAKM,KAAK,CAAC,MAAM,CAAI,GAAW,EAAE,KAAK,GAAG,IAAI;QAC9C,OAAO,IAAI,CAAC,eAAe,CAAI,KAAK,CAAC,CAAC,GAAG,EAAE,EAAC,MAAM,EAAE,QAAQ,EAAC,CAAC,CAAC;IACjE,CAAC;IAED,IAAY,cAAc;QACxB,MAAM,mBAAmB,GAAG;YAC1B,aAAa,EAAE,UAAU,IAAI,CAAC,WAAW,EAAE;SAC5C,CAAC;QAEF,MAAM,uBAAuB,mCACxB,mBAAmB,KACtB,cAAc,EAAE,kBAAkB,EAClC,MAAM,EAAE,kBAAkB,GAC3B,CAAC;QAEF,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAEO,WAAW,CAAC,MAAc;QAChC,OAAO,MAAM,KAAK,GAAG,CAAC;IACxB,CAAC;CACF;AAhED,0BAgEC"}
+{"version":3,"file":"APICore.js","sourceRoot":"","sources":["../src/APICore.ts"],"names":[],"mappings":";;;AAAA,6DAA4C;AAE5C,oDAA+C;AAC/C,0DAAqD;AACrD,MAAa,OAAO;IAClB,YAA2B,WAAmB;QAAnB,gBAAW,GAAX,WAAW,CAAQ;IAAG,CAAC;IAE1C,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,MAAmB;QACpD,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;YACrB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,kCAC3B,MAAM,KACT,OAAO,kCAAM,IAAI,CAAC,cAAc,GAAK,MAAM,CAAC,OAAO,KACnD,CAAC;YACH,MAAM,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;YACpC,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC;QAEF,OAAO,IAAA,6BAAO,EAAC,GAAG,EAAE;YAClB,KAAK,EAAE,CAAC,GAAY,EAAE,EAAE,CAAC,GAAG,YAAY,6BAAa;SACtD,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,QAAkB;QAC7C,IAAI,QAAQ,CAAC,EAAE,EAAE;YACf,OAAO;SACR;QACD,IAAI,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE;YAC9B,MAAM,IAAI,6BAAa,EAAE,CAAC;SAC3B;QACD,MAAM,MAAM,uBAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAEO,KAAK,CAAC,WAAW,CAAI,GAAW,EAAE,MAAmB;QAC3D,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,EAAgB,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,IAAI,CAAI,GAAW,EAAE,OAAgB,EAAE;QAClD,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,EAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC;IAC7E,CAAC;IAMM,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,OAAgB,EAAE,EAAE,KAAK,GAAG,IAAI;QAC/D,OAAO,IAAI,CAAC,eAAe,CAAI,KAAK,CAAC,CAAC,GAAG,EAAE;YACzC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAC1B,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;IACL,CAAC;IAEO,eAAe,CAAI,KAAc;QACvC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,WAAc,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjE,CAAC;IAKM,KAAK,CAAC,MAAM,CAAI,GAAW,EAAE,KAAK,GAAG,IAAI;QAC9C,OAAO,IAAI,CAAC,eAAe,CAAI,KAAK,CAAC,CAAC,GAAG,EAAE,EAAC,MAAM,EAAE,QAAQ,EAAC,CAAC,CAAC;IACjE,CAAC;IAED,IAAY,cAAc;QACxB,MAAM,mBAAmB,GAAG;YAC1B,aAAa,EAAE,UAAU,IAAI,CAAC,WAAW,EAAE;SAC5C,CAAC;QAEF,MAAM,uBAAuB,mCACxB,mBAAmB,KACtB,cAAc,EAAE,kBAAkB,EAClC,MAAM,EAAE,kBAAkB,GAC3B,CAAC;QAEF,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAEO,WAAW,CAAC,GAAa;QAC/B,OAAO,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC;IAC5B,CAAC;CACF;AA3ED,0BA2EC"}

package/dist/APICore.spec.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+jest.mock('./errors/fetchError');
+const fetchError_1 = require("./errors/fetchError");
+const APICore_1 = require("./APICore");
+describe('APICore', () => {
+    const mockedFetchJson = jest.fn();
+    let fetchMock;
+    beforeEach(() => {
+        jest.resetAllMocks();
+        fetchMock = jest.spyOn(global, 'fetch');
+        fetchMock.mockResolvedValue({
+            ok: true,
+            json: () => Promise.resolve(mockedFetchJson),
+        });
+    });
+    describe('when request is OK', () => {
+        it('resolve with json', async () => {
+            const apiCore = new APICore_1.APICore('suchsecret');
+            await expect(apiCore.post('whatever')).resolves.toBe(mockedFetchJson);
+        });
+    });
+    describe('when request is throttled', () => {
+        beforeEach(() => {
+            fetchMock.mockResolvedValueOnce({
+                ok: false,
+                status: 429,
+                json: () => Promise.resolve(mockedFetchJson),
+            });
+        });
+        it('try again and then resolve with json', async () => {
+            const apiCore = new APICore_1.APICore('suchsecret');
+            await expect(apiCore.post('whatever')).resolves.toBe(mockedFetchJson);
+            expect(fetchMock).toBeCalledTimes(2);
+        });
+    });
+    describe('when request is NOK and not throttled', () => {
+        let mockedFetchErrorBuild;
+        const fakeFetchError = jest.fn();
+        beforeEach(() => {
+            fetchMock.mockResolvedValueOnce({
+                ok: false,
+                status: 500,
+                json: () => Promise.resolve(mockedFetchJson),
+            });
+            mockedFetchErrorBuild = jest
+                .spyOn(fetchError_1.FetchError, 'build')
+                .mockImplementationOnce(() => Promise.resolve(fakeFetchError));
+        });
+        it('rejects a FetchError', async () => {
+            const apiCore = new APICore_1.APICore('suchsecret');
+            await expect(apiCore.post('whatever')).rejects.toBe(fakeFetchError);
+            expect(fetchMock).toBeCalledTimes(1);
+            expect(mockedFetchErrorBuild).toBeCalledTimes(1);
+            expect(mockedFetchErrorBuild).toBeCalledWith(await fetchMock.mock.results[0].value);
+        });
+    });
+});
+//# sourceMappingURL=APICore.spec.js.map

package/dist/APICore.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"APICore.spec.js","sourceRoot":"","sources":["../src/APICore.spec.ts"],"names":[],"mappings":";;AAEA,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;AACjC,oDAA+C;AAE/C,uCAAkC;AAElC,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,MAAM,eAAe,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAClC,IAAI,SAA2B,CAAC;IAEhC,UAAU,CAAC,GAAG,EAAE;QACd,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACxC,SAAS,CAAC,iBAAiB,CAAC;YAC1B,EAAE,EAAE,IAAI;YACR,IAAI,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC;SACjC,CAAC,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;YACjC,MAAM,OAAO,GAAG,IAAI,iBAAO,CAAC,YAAY,CAAC,CAAC;YAC1C,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACxE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACzC,UAAU,CAAC,GAAG,EAAE;YACd,SAAS,CAAC,qBAAqB,CAAC;gBAC9B,EAAE,EAAE,KAAK;gBACT,MAAM,EAAE,GAAG;gBACX,IAAI,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC;aAC7C,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;YACpD,MAAM,OAAO,GAAG,IAAI,iBAAO,CAAC,YAAY,CAAC,CAAC;YAC1C,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YACtE,MAAM,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,uCAAuC,EAAE,GAAG,EAAE;QACrD,IAAI,qBAAuC,CAAC;QAC5C,MAAM,cAAc,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAEjC,UAAU,CAAC,GAAG,EAAE;YACd,SAAS,CAAC,qBAAqB,CAAC;gBAC9B,EAAE,EAAE,KAAK;gBACT,MAAM,EAAE,GAAG;gBACX,IAAI,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC;aAC7C,CAAC,CAAC;YACH,qBAAqB,GAAG,IAAI;iBACzB,KAAK,CAAC,uBAAU,EAAE,OAAO,CAAC;iBAC1B,sBAAsB,CAAC,GAAG,EAAE,CAC3B,OAAO,CAAC,OAAO,CAAC,cAAuC,CAAC,CACzD,CAAC;QACN,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;YACpC,MAAM,OAAO,GAAG,IAAI,iBAAO,CAAC,YAAY,CAAC,CAAC;YAC1C,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACpE,MAAM,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;YACrC,MAAM,CAAC,qBAAqB,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;YACjD,MAAM,CAAC,qBAAqB,CAAC,CAAC,cAAc,CAC1C,MAAM,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CACtC,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/definitions/APICore.d.ts

@@ -3,6 +3,7 @@ export declare class APICore {
     private accessToken;
     constructor(accessToken: string);
     private request;
+    private handleResponse;
     private requestJson;
     post<T>(url: string, data?: unknown): Promise<T>;
     put<T>(url: string): Promise<T>;

package/dist/definitions/APICore.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/definitions/errors/fetchError.d.ts

@@ -0,0 +1,8 @@
+import type { Response } from 'undici';
+import { PushApiClientBaseError } from './baseError';
+export declare class FetchError extends PushApiClientBaseError {
+    body: string;
+    name: string;
+    static build(response: Response): Promise<FetchError>;
+    private constructor();
+}

package/dist/definitions/errors/fetchError.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/definitions/errors/index.d.ts

@@ -1,3 +1,5 @@
+export * from './fetchError';
 export * from './fieldErrors';
 export * from './privilegeError';
+export * from './throttleError';
 export * from './validatorErrors';

package/dist/definitions/errors/throttleError.d.ts

@@ -0,0 +1,4 @@
+import { PushApiClientBaseError } from './baseError';
+export declare class ThrottleError extends PushApiClientBaseError {
+    name: string;
+}

package/dist/definitions/errors/throttleError.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/errors/fetchError.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FetchError = void 0;
+const baseError_1 = require("./baseError");
+const ts_dedent_1 = require("ts-dedent");
+class FetchError extends baseError_1.PushApiClientBaseError {
+    static async build(response) {
+        let body;
+        try {
+            body = JSON.stringify(await response.json());
+        }
+        catch (error) {
+            body = await response.text();
+        }
+        return new FetchError(body);
+    }
+    constructor(body) {
+        super();
+        this.body = body;
+        this.name = 'Fetch Error';
+        this.message = (0, ts_dedent_1.default) `
+      Response body:
+      ${body}
+    `;
+    }
+}
+exports.FetchError = FetchError;
+//# sourceMappingURL=fetchError.js.map

package/dist/errors/fetchError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchError.js","sourceRoot":"","sources":["../../src/errors/fetchError.ts"],"names":[],"mappings":";;;AACA,2CAAmD;AACnD,yCAA+B;AAE/B,MAAa,UAAW,SAAQ,kCAAsB;IAE7C,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,QAAkB;QAC1C,IAAI,IAAY,CAAC;QACjB,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;SAC9C;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;SAC9B;QACD,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IACD,YAA2B,IAAY;QACrC,KAAK,EAAE,CAAC;QADiB,SAAI,GAAJ,IAAI,CAAQ;QAVhC,SAAI,GAAG,aAAa,CAAC;QAY1B,IAAI,CAAC,OAAO,GAAG,IAAA,mBAAM,EAAA;;QAEjB,IAAI;KACP,CAAC;IACJ,CAAC;CACF;AAlBD,gCAkBC"}

package/dist/errors/fetchError.spec.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const baseError_1 = require("./baseError");
+const fetchError_1 = require("./fetchError");
+describe('FetchError', () => {
+    const fakeResponseJson = jest.fn();
+    const fakeResponseText = jest.fn();
+    const fakeResponse = {
+        json: fakeResponseJson,
+        text: fakeResponseText,
+    };
+    beforeEach(() => {
+        jest.resetAllMocks();
+        fakeResponseJson.mockResolvedValue(null);
+        fakeResponseText.mockResolvedValue('hello there');
+    });
+    it('has a proper name', async () => {
+        expect((await fetchError_1.FetchError.build(fakeResponse)).name).toBe('Fetch Error');
+    });
+    it('inherit the PushApiClientBaseError', async () => {
+        expect(await fetchError_1.FetchError.build(fakeResponse)).toBeInstanceOf(baseError_1.PushApiClientBaseError);
+    });
+    describe('when json returns a stringifiable object', () => {
+        beforeEach(() => {
+            fakeResponseJson.mockResolvedValueOnce({ hello: 'world' });
+        });
+        it('uses its stringify value in the message', async () => {
+            expect((await fetchError_1.FetchError.build(fakeResponse)).message).toMatchSnapshot();
+        });
+    });
+    describe('when json returns a unstringifiable object', () => {
+        beforeEach(() => {
+            const cyclicObject = {};
+            cyclicObject.self = cyclicObject;
+            fakeResponseJson.mockResolvedValueOnce(cyclicObject);
+        });
+        it('uses the text value in the message', async () => {
+            expect((await fetchError_1.FetchError.build(fakeResponse)).message).toMatchSnapshot();
+        });
+    });
+    describe('when json and text fails', () => {
+        beforeEach(() => {
+            fakeResponseJson.mockRejectedValueOnce('nope');
+            fakeResponseText.mockRejectedValueOnce('nope');
+        });
+        it('does not returns a FetchError', async () => {
+            await expect(fetchError_1.FetchError.build(fakeResponse)).rejects.not.toBeInstanceOf(fetchError_1.FetchError);
+        });
+    });
+});
+//# sourceMappingURL=fetchError.spec.js.map

package/dist/errors/fetchError.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchError.spec.js","sourceRoot":"","sources":["../../src/errors/fetchError.spec.ts"],"names":[],"mappings":";;AACA,2CAAmD;AACnD,6CAAwC;AAExC,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,MAAM,gBAAgB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IACnC,MAAM,gBAAgB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IACnC,MAAM,YAAY,GAAa;QAC7B,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,gBAAgB;KACA,CAAC;IAEzB,UAAU,CAAC,GAAG,EAAE;QACd,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,gBAAgB,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACzC,gBAAgB,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;QACjC,MAAM,CAAC,CAAC,MAAM,uBAAU,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,CAAC,MAAM,uBAAU,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,cAAc,CACzD,kCAAsB,CACvB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,0CAA0C,EAAE,GAAG,EAAE;QACxD,UAAU,CAAC,GAAG,EAAE;YACd,gBAAgB,CAAC,qBAAqB,CAAC,EAAC,KAAK,EAAE,OAAO,EAAC,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;YACvD,MAAM,CAAC,CAAC,MAAM,uBAAU,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,CAAC;QAC3E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,4CAA4C,EAAE,GAAG,EAAE;QAC1D,UAAU,CAAC,GAAG,EAAE;YACd,MAAM,YAAY,GAAoB,EAAE,CAAC;YACzC,YAAY,CAAC,IAAI,GAAG,YAAY,CAAC;YACjC,gBAAgB,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;YAClD,MAAM,CAAC,CAAC,MAAM,uBAAU,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,CAAC;QAC3E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;QACxC,UAAU,CAAC,GAAG,EAAE;YACd,gBAAgB,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;YAC/C,gBAAgB,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;YAC7C,MAAM,MAAM,CAAC,uBAAU,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CACrE,uBAAU,CACX,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/errors/index.js

@@ -14,7 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./fetchError"), exports);
 __exportStar(require("./fieldErrors"), exports);
 __exportStar(require("./privilegeError"), exports);
+__exportStar(require("./throttleError"), exports);
 __exportStar(require("./validatorErrors"), exports);
 //# sourceMappingURL=index.js.map

package/dist/errors/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/errors/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,mDAAiC;AACjC,oDAAkC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/errors/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,gDAA8B;AAC9B,mDAAiC;AACjC,kDAAgC;AAChC,oDAAkC"}

package/dist/errors/throttleError.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ThrottleError = void 0;
+const baseError_1 = require("./baseError");
+class ThrottleError extends baseError_1.PushApiClientBaseError {
+    constructor() {
+        super(...arguments);
+        this.name = 'Throttle Error';
+    }
+}
+exports.ThrottleError = ThrottleError;
+//# sourceMappingURL=throttleError.js.map

package/dist/errors/throttleError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"throttleError.js","sourceRoot":"","sources":["../../src/errors/throttleError.ts"],"names":[],"mappings":";;;AAAA,2CAAmD;AAEnD,MAAa,aAAc,SAAQ,kCAAsB;IAAzD;;QACS,SAAI,GAAG,gBAAgB,CAAC;IACjC,CAAC;CAAA;AAFD,sCAEC"}

package/dist/errors/throttleError.spec.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const baseError_1 = require("./baseError");
+const throttleError_1 = require("./throttleError");
+describe('ThrottleError', () => {
+    it('has a proper name', () => {
+        expect(new throttleError_1.ThrottleError().name).toBe('Throttle Error');
+    });
+    it('inherit the PushApiClientBaseError', () => {
+        expect(new throttleError_1.ThrottleError()).toBeInstanceOf(baseError_1.PushApiClientBaseError);
+    });
+});
+//# sourceMappingURL=throttleError.spec.js.map

package/dist/errors/throttleError.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"throttleError.spec.js","sourceRoot":"","sources":["../../src/errors/throttleError.spec.ts"],"names":[],"mappings":";;AAAA,2CAAmD;AACnD,mDAA8C;AAE9C,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;QAC3B,MAAM,CAAC,IAAI,6BAAa,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,CAAC,IAAI,6BAAa,EAAE,CAAC,CAAC,cAAc,CAAC,kCAAsB,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/push-api-client",
-  "version": "3.1.5",
+  "version": "3.1.6",
   "description": "Push API client",
   "main": "./dist/index.js",
   "files": [
@@ -20,6 +20,7 @@
     "dayjs": "^1.10.4",
     "exponential-backoff": "^3.1.0",
     "fetch-undici-polyfill": "1.2.1",
+    "ts-dedent": "2.2.0",
     "zod": "^3.20.2"
   },
   "devDependencies": {