@coveo/push-api-client 2.8.13 → 3.0.0

package/dist/help/fileContainer.js

@@ -1,32 +1,49 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFileContainerAxiosConfig = exports.uploadContentToFileContainer = void 0;
-const axios_1 = require("axios");
-const url_1 = require("url");
+exports.uploadContentToFileContainer = void 0;
+const node_url_1 = require("node:url");
 const uploadContentToFileContainer = async (fileContainer, batch) => {
-    const uploadURL = new url_1.URL(fileContainer.uploadUri);
-    return axios_1.default
-        .put(uploadURL.toString(), {
-        addOrUpdate: batch.addOrUpdate.map((docBuilder) => docBuilder.marshal()),
-        delete: batch.delete,
-    }, (0, exports.getFileContainerAxiosConfig)(fileContainer))
-        .catch((err) => {
-        if (isMaxBodyLengthExceededError(err)) {
-            err.message +=
-                '\nFile container size limit exceeded.\nSee <https://docs.coveo.com/en/63/index-content/push-api-limits#request-size-limits>.';
+    const uploadURL = new node_url_1.URL(fileContainer.uploadUri);
+    let response;
+    const errors = [];
+    try {
+        response = await fetch(uploadURL.toString(), {
+            method: 'PUT',
+            body: JSON.stringify({
+                addOrUpdate: batch.addOrUpdate.map((docBuilder) => docBuilder.marshal()),
+                delete: batch.delete,
+            }),
+            headers: fileContainer.requiredHeaders,
+        });
+    }
+    catch (error) {
+        errors.push(error);
+    }
+    finally {
+        if ((response === null || response === void 0 ? void 0 : response.ok) === false) {
+            if (isMaxBodyLengthExceededError(response)) {
+                addMaxBodyLengthError(errors, response);
+            }
+            else {
+                addGenericFetchError(errors, response);
+            }
         }
-        throw err;
-    });
+    }
+    if (errors.length > 0) {
+        throw new AggregateError(errors);
+    }
+    else {
+        return response;
+    }
 };
 exports.uploadContentToFileContainer = uploadContentToFileContainer;
-const getFileContainerAxiosConfig = (fileContainer) => {
-    return {
-        headers: fileContainer.requiredHeaders,
-        maxBodyLength: 256e6,
-    };
-};
-exports.getFileContainerAxiosConfig = getFileContainerAxiosConfig;
-function isMaxBodyLengthExceededError(err) {
-    return (err === null || err === void 0 ? void 0 : err.code) === 'ERR_FR_MAX_BODY_LENGTH_EXCEEDED';
+function addGenericFetchError(errors, response) {
+    errors.push(new Error('Request failed', { cause: response }));
+}
+function addMaxBodyLengthError(errors, response) {
+    errors.push(new Error('File container size limit exceeded.\nSee <https://docs.coveo.com/en/63/index-content/push-api-limits#request-size-limits>.', { cause: response }));
+}
+function isMaxBodyLengthExceededError(response) {
+    return (response === null || response === void 0 ? void 0 : response.status) === 413;
 }
 //# sourceMappingURL=fileContainer.js.map

package/dist/help/fileContainer.js.map

@@ -1 +1 @@
-{"version":3,"file":"fileContainer.js","sourceRoot":"","sources":["../../src/help/fileContainer.ts"],"names":[],"mappings":";;;AAAA,iCAAgD;AAChD,6BAAwB;AASjB,MAAM,4BAA4B,GAAG,KAAK,EAC/C,aAAoC,EACpC,KAA2B,EAC3B,EAAE;IACF,MAAM,SAAS,GAAG,IAAI,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IACnD,OAAO,eAAK;SACT,GAAG,CACF,SAAS,CAAC,QAAQ,EAAE,EACpB;QACE,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAChD,UAAU,CAAC,OAAO,EAAE,CACrB;QACD,MAAM,EAAE,KAAK,CAAC,MAAM;KACrB,EACD,IAAA,mCAA2B,EAAC,aAAa,CAAC,CAC3C;SACA,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;QACb,IAAI,4BAA4B,CAAC,GAAG,CAAC,EAAE;YACrC,GAAG,CAAC,OAAO;gBACT,8HAA8H,CAAC;SAClI;QACD,MAAM,GAAG,CAAC;IACZ,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAvBW,QAAA,4BAA4B,gCAuBvC;AAEK,MAAM,2BAA2B,GAAG,CACzC,aAAoC,EAChB,EAAE;IACtB,OAAO;QACL,OAAO,EAAE,aAAa,CAAC,eAAe;QACtC,aAAa,EAAE,KAAK;KACrB,CAAC;AACJ,CAAC,CAAC;AAPW,QAAA,2BAA2B,+BAOtC;AAEF,SAAS,4BAA4B,CAAC,GAA4B;IAChE,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,MAAK,iCAAiC,CAAC;AACzD,CAAC"}
+{"version":3,"file":"fileContainer.js","sourceRoot":"","sources":["../../src/help/fileContainer.ts"],"names":[],"mappings":";;;AACA,uCAA6B;AAStB,MAAM,4BAA4B,GAAG,KAAK,EAC/C,aAAoC,EACpC,KAA2B,EAC3B,EAAE;IACF,MAAM,SAAS,GAAG,IAAI,cAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IACnD,IAAI,QAA8B,CAAC;IACnC,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,IAAI;QACF,QAAQ,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE;YAC3C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAChD,UAAU,CAAC,OAAO,EAAE,CACrB;gBACD,MAAM,EAAE,KAAK,CAAC,MAAM;aACrB,CAAC;YACF,OAAO,EAAE,aAAa,CAAC,eAAe;SACvC,CAAC,CAAC;KACJ;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KACpB;YAAS;QACR,IAAI,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,EAAE,MAAK,KAAK,EAAE;YAC1B,IAAI,4BAA4B,CAAC,QAAQ,CAAC,EAAE;gBAC1C,qBAAqB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;aACzC;iBAAM;gBACL,oBAAoB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;aACxC;SACF;KACF;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QACrB,MAAM,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC;KAClC;SAAM;QACL,OAAO,QAAS,CAAC;KAClB;AACH,CAAC,CAAC;AAnCW,QAAA,4BAA4B,gCAmCvC;AAEF,SAAS,oBAAoB,CAC3B,MAAiB,EACjB,QAA8B;IAE9B,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,gBAAgB,EAAE,EAAC,KAAK,EAAE,QAAQ,EAAC,CAAC,CAAC,CAAC;AAC9D,CAAC;AAED,SAAS,qBAAqB,CAC5B,MAAiB,EACjB,QAA8B;IAE9B,MAAM,CAAC,IAAI,CACT,IAAI,KAAK,CACP,4HAA4H,EAC5H,EAAC,KAAK,EAAE,QAAQ,EAAC,CAClB,CACF,CAAC;AACJ,CAAC;AAED,SAAS,4BAA4B,CAAC,QAA8B;IAClE,OAAO,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,MAAM,MAAK,GAAG,CAAC;AAClC,CAAC"}

package/dist/help/fileContainer.spec.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const mockedPut = jest.fn();
-jest.mock('axios', () => ({
-    default: { put: mockedPut },
-}));
+require("fetch-undici-polyfill");
+jest.mock('fetch-undici-polyfill', () => {
+    Object.assign(global, { fetch: jest.fn() });
+});
 const __1 = require("..");
 const fileContainer_1 = require("./fileContainer");
 describe('#uploadContentToFileContainer', () => {
+    const fetchMocked = fetch;
     const fileContainerResponse = {
         uploadUri: 'https://fake.upload.url',
         fileId: 'file_id',
@@ -16,51 +17,55 @@ describe('#uploadContentToFileContainer', () => {
         addOrUpdate: [new __1.DocumentBuilder('http://some.url', 'Some document')],
         delete: [],
     };
-    const doMockAxiosPut = () => {
-        mockedPut.mockImplementation(() => Promise.resolve());
+    const doMockFetch = () => {
+        fetchMocked.mockImplementation(() => Promise.resolve());
     };
     beforeEach(() => {
-        doMockAxiosPut();
+        doMockFetch();
     });
     it('should perform an PUT request with the right params', async () => {
         await (0, fileContainer_1.uploadContentToFileContainer)(fileContainerResponse, batch);
-        expect(mockedPut).toHaveBeenCalledWith('https://fake.upload.url/', expect.objectContaining({
-            addOrUpdate: expect.arrayContaining([
-                expect.objectContaining({
-                    documentId: 'http://some.url',
-                }),
-            ]),
-            delete: expect.arrayContaining([]),
-        }), {
-            headers: {
-                foo: 'bar',
-            },
-            maxBodyLength: 256e6,
-        });
+        expect(fetchMocked).toBeCalled();
+        expect(fetchMocked.mock.lastCall).toMatchSnapshot();
     });
-    describe('when an MaxBodyLengthExceededError is thrown', () => {
+    describe('when the server respond with 413', () => {
         beforeEach(() => {
-            mockedPut.mockImplementationOnce(() => Promise.reject(new FakeMaxBodyLengthExceededError()));
+            fetchMocked.mockImplementationOnce(() => Promise.resolve({
+                ok: false,
+                status: 413,
+            }));
         });
         it('should give some info on how to fix it', async () => {
-            await expect((0, fileContainer_1.uploadContentToFileContainer)(fileContainerResponse, batch)).rejects.toThrowErrorMatchingSnapshot();
+            try {
+                await (0, fileContainer_1.uploadContentToFileContainer)(fileContainerResponse, batch);
+            }
+            catch (error) {
+                expect(error).toBeInstanceOf(AggregateError);
+                expect(error.errors).toMatchSnapshot(`
+          [
+            [Error: File container size limit exceeded.
+          See <https://docs.coveo.com/en/63/index-content/push-api-limits#request-size-limits>.],
+          ]
+        `);
+            }
+            expect.assertions(2);
         });
     });
     describe('when anything else than MaxBodyLengthExceededError is thrown', () => {
         const thrownError = new Error();
         beforeEach(() => {
-            mockedPut.mockImplementationOnce(() => Promise.reject(thrownError));
+            fetchMocked.mockImplementationOnce(() => Promise.reject(thrownError));
         });
-        it('should just bubble up the error', async () => {
-            await expect((0, fileContainer_1.uploadContentToFileContainer)(fileContainerResponse, batch)).rejects.toBe(thrownError);
+        it('should bubble up the error', async () => {
+            try {
+                await (0, fileContainer_1.uploadContentToFileContainer)(fileContainerResponse, batch);
+            }
+            catch (error) {
+                expect(error).toBeInstanceOf(AggregateError);
+                expect(error.errors).toContain(thrownError);
+            }
+            expect.assertions(2);
         });
     });
 });
-class FakeMaxBodyLengthExceededError extends Error {
-    constructor() {
-        super(...arguments);
-        this.code = 'ERR_FR_MAX_BODY_LENGTH_EXCEEDED';
-        this.message = 'some initial message';
-    }
-}
 //# sourceMappingURL=fileContainer.spec.js.map

package/dist/help/fileContainer.spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"fileContainer.spec.js","sourceRoot":"","sources":["../../src/help/fileContainer.spec.ts"],"names":[],"mappings":";;AAAA,MAAM,SAAS,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;AAC5B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IACxB,OAAO,EAAE,EAAC,GAAG,EAAE,SAAS,EAAC;CAC1B,CAAC,CAAC,CAAC;AAEJ,0BAAyD;AACzD,mDAGyB;AAEzB,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC7C,MAAM,qBAAqB,GAA0B;QACnD,SAAS,EAAE,yBAAyB;QACpC,MAAM,EAAE,SAAS;QACjB,eAAe,EAAE,EAAC,GAAG,EAAE,KAAK,EAAC;KAC9B,CAAC;IAEF,MAAM,KAAK,GAAyB;QAClC,WAAW,EAAE,CAAC,IAAI,mBAAe,CAAC,iBAAiB,EAAE,eAAe,CAAC,CAAC;QACtE,MAAM,EAAE,EAAE;KACX,CAAC;IAEF,MAAM,cAAc,GAAG,GAAG,EAAE;QAC1B,SAAS,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACxD,CAAC,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACd,cAAc,EAAE,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACnE,MAAM,IAAA,4CAA4B,EAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;QAEjE,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CACpC,0BAA0B,EAC1B,MAAM,CAAC,gBAAgB,CAAC;YACtB,WAAW,EAAE,MAAM,CAAC,eAAe,CAAC;gBAClC,MAAM,CAAC,gBAAgB,CAAC;oBACtB,UAAU,EAAE,iBAAiB;iBAC9B,CAAC;aACH,CAAC;YACF,MAAM,EAAE,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;SACnC,CAAC,EACF;YACE,OAAO,EAAE;gBACP,GAAG,EAAE,KAAK;aACX;YACD,aAAa,EAAE,KAAK;SACrB,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,8CAA8C,EAAE,GAAG,EAAE;QAC5D,UAAU,CAAC,GAAG,EAAE;YACd,SAAS,CAAC,sBAAsB,CAAC,GAAG,EAAE,CACpC,OAAO,CAAC,MAAM,CAAC,IAAI,8BAA8B,EAAE,CAAC,CACrD,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACtD,MAAM,MAAM,CACV,IAAA,4CAA4B,EAAC,qBAAqB,EAAE,KAAK,CAAC,CAC3D,CAAC,OAAO,CAAC,4BAA4B,EAAE,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,8DAA8D,EAAE,GAAG,EAAE;QAC5E,MAAM,WAAW,GAAG,IAAI,KAAK,EAAE,CAAC;QAChC,UAAU,CAAC,GAAG,EAAE;YACd,SAAS,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;YAC/C,MAAM,MAAM,CACV,IAAA,4CAA4B,EAAC,qBAAqB,EAAE,KAAK,CAAC,CAC3D,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,8BAA+B,SAAQ,KAAK;IAAlD;;QACE,SAAI,GAAG,iCAAiC,CAAC;QACzC,YAAO,GAAG,sBAAsB,CAAC;IACnC,CAAC;CAAA"}
+{"version":3,"file":"fileContainer.spec.js","sourceRoot":"","sources":["../../src/help/fileContainer.spec.ts"],"names":[],"mappings":";;AAAA,iCAA+B;AAC/B,IAAI,CAAC,IAAI,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACtC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,EAAC,CAAC,CAAC;AAC5C,CAAC,CAAC,CAAC;AAEH,0BAAyD;AACzD,mDAGyB;AAEzB,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC7C,MAAM,WAAW,GAAc,KAAkB,CAAC;IAClD,MAAM,qBAAqB,GAA0B;QACnD,SAAS,EAAE,yBAAyB;QACpC,MAAM,EAAE,SAAS;QACjB,eAAe,EAAE,EAAC,GAAG,EAAE,KAAK,EAAC;KAC9B,CAAC;IAEF,MAAM,KAAK,GAAyB;QAClC,WAAW,EAAE,CAAC,IAAI,mBAAe,CAAC,iBAAiB,EAAE,eAAe,CAAC,CAAC;QACtE,MAAM,EAAE,EAAE;KACX,CAAC;IAEF,MAAM,WAAW,GAAG,GAAG,EAAE;QACvB,WAAW,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACd,WAAW,EAAE,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACnE,MAAM,IAAA,4CAA4B,EAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;QAEjE,MAAM,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;QACjC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,eAAe,EAAE,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAChD,UAAU,CAAC,GAAG,EAAE;YACd,WAAW,CAAC,sBAAsB,CAAC,GAAG,EAAE,CACtC,OAAO,CAAC,OAAO,CAAC;gBACd,EAAE,EAAE,KAAK;gBACT,MAAM,EAAE,GAAG;aACZ,CAAC,CACH,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACtD,IAAI;gBACF,MAAM,IAAA,4CAA4B,EAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;aAClE;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;gBAC7C,MAAM,CAAE,KAAwB,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC;;;;;SAKxD,CAAC,CAAC;aACJ;YACD,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,8DAA8D,EAAE,GAAG,EAAE;QAC5E,MAAM,WAAW,GAAG,IAAI,KAAK,EAAE,CAAC;QAChC,UAAU,CAAC,GAAG,EAAE;YACd,WAAW,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;QACxE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;YAC1C,IAAI;gBACF,MAAM,IAAA,4CAA4B,EAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;aAClE;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;gBAC7C,MAAM,CAAE,KAAwB,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;aACjE;YACD,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/index.js

@@ -14,12 +14,10 @@ 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 });
-exports.parseAndGetDocumentBuilderFromJSONDocument = exports.SourceVisibility = exports.Region = exports.PlatformEnvironment = exports.DocumentBuilder = exports.FieldAnalyser = exports.CatalogSource = exports.PushSource = exports.Source = exports.errors = void 0;
+exports.parseAndGetDocumentBuilderFromJSONDocument = exports.PermissionSetBuilder = exports.SourceVisibility = exports.Region = exports.PlatformEnvironment = exports.DocumentBuilder = exports.FieldAnalyser = exports.CatalogSource = exports.PushSource = exports.errors = void 0;
 __exportStar(require("./document"), exports);
 __exportStar(require("./validation/transformers/transformer"), exports);
 exports.errors = require("./errors");
-var source_1 = require("./source/source");
-Object.defineProperty(exports, "Source", { enumerable: true, get: function () { return source_1.Source; } });
 var push_1 = require("./source/push");
 Object.defineProperty(exports, "PushSource", { enumerable: true, get: function () { return push_1.PushSource; } });
 var catalog_1 = require("./source/catalog");
@@ -34,6 +32,8 @@ Object.defineProperty(exports, "PlatformEnvironment", { enumerable: true, get: f
 Object.defineProperty(exports, "Region", { enumerable: true, get: function () { return environment_1.Region; } });
 var platform_client_1 = require("@coveo/platform-client");
 Object.defineProperty(exports, "SourceVisibility", { enumerable: true, get: function () { return platform_client_1.SourceVisibility; } });
+var permissionSetBuilder_1 = require("./permissionSetBuilder");
+Object.defineProperty(exports, "PermissionSetBuilder", { enumerable: true, get: function () { return permissionSetBuilder_1.PermissionSetBuilder; } });
 var parseFile_1 = require("./validation/parseFile");
 Object.defineProperty(exports, "parseAndGetDocumentBuilderFromJSONDocument", { enumerable: true, get: function () { return parseFile_1.parseAndGetDocumentBuilderFromJSONDocument; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,wEAAsD;AACtD,qCAAmC;AACnC,0CAAuC;AAA/B,gGAAA,MAAM,OAAA;AACd,sCAAyC;AAAjC,kGAAA,UAAU,OAAA;AAClB,4CAA+C;AAAvC,wGAAA,aAAa,OAAA;AAUrB,+DAA4D;AAApD,8GAAA,aAAa,OAAA;AACrB,qDAAkD;AAA1C,kHAAA,eAAe,OAAA;AACvB,4DAA0C;AAC1C,6CAA8E;AAAtE,kHAAA,mBAAmB,OAAA;AAAE,qGAAA,MAAM,OAAA;AACnC,0DAAwD;AAAhD,mHAAA,gBAAgB,OAAA;AAExB,oDAAkF;AAA1E,uIAAA,0CAA0C,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,wEAAsD;AACtD,qCAAmC;AACnC,sCAAyC;AAAjC,kGAAA,UAAU,OAAA;AAClB,4CAA+C;AAAvC,wGAAA,aAAa,OAAA;AAUrB,+DAA4D;AAApD,8GAAA,aAAa,OAAA;AACrB,qDAAkD;AAA1C,kHAAA,eAAe,OAAA;AACvB,4DAA0C;AAC1C,6CAA8E;AAAtE,kHAAA,mBAAmB,OAAA;AAAE,qGAAA,MAAM,OAAA;AACnC,0DAAwD;AAAhD,mHAAA,gBAAgB,OAAA;AACxB,+DAA4D;AAApD,4HAAA,oBAAoB,OAAA;AAE5B,oDAAkF;AAA1E,uIAAA,0CAA0C,OAAA"}

package/dist/localtest.js

@@ -5,12 +5,19 @@ require("dotenv/config");
 const documentBuilder_1 = require("./documentBuilder");
 const securityIdentityBuilder_1 = require("./securityIdentityBuilder");
 const push_1 = require("./source/push");
+const permissionSetBuilder_1 = require("./permissionSetBuilder");
 const API_KEY = process.env.API_KEY;
 const ORG_ID = process.env.ORG_ID;
 const SOURCE_ID = process.env.SOURCE_ID;
 async function main() {
     const source = new push_1.PushSource(API_KEY, ORG_ID);
     await source.setSourceStatus(SOURCE_ID, 'REFRESH');
+    const allowedPermissionSet = new permissionSetBuilder_1.PermissionSetBuilder(false)
+        .withAllowedPermissions(new securityIdentityBuilder_1.UserSecurityIdentityBuilder('olamothe@coveo.com'))
+        .withDeniedPermissions(new securityIdentityBuilder_1.UserSecurityIdentityBuilder([
+        'ylakhdar@coveo.com',
+        'lbompart@coveo.com',
+    ]));
     const docBuilder = new documentBuilder_1.DocumentBuilder('https://perdu.com', 'hello world title')
         .withAuthor('anonymous@coveo.com')
         .withClickableUri('https://perdu.com/click')
@@ -18,11 +25,7 @@ async function main() {
         .withMetadataValue('foo', 'bar')
         .withDate('2000/01/01')
         .withFileExtension('.html')
-        .withAllowedPermissions(new securityIdentityBuilder_1.UserSecurityIdentityBuilder('olamothe@coveo.com'))
-        .withDeniedPermissions(new securityIdentityBuilder_1.UserSecurityIdentityBuilder([
-        'ylakhdar@coveo.com',
-        'lbompart@coveo.com',
-    ]));
+        .withPermissionSet(allowedPermissionSet);
     const result = await source.addOrUpdateDocument(SOURCE_ID, docBuilder);
     console.log('STATUS CREATE', result.status);
     const resultDelete = await source.deleteDocument(SOURCE_ID, 'https://does.not.exists.com');
@@ -35,12 +38,11 @@ async function main() {
         addOrUpdate: [],
         delete: [],
     };
+    const permissionSet = new permissionSetBuilder_1.PermissionSetBuilder(false).withAllowedPermissions(new securityIdentityBuilder_1.UserSecurityIdentityBuilder('olamothe@coveo.com'));
     for (let i = 0; i < 10; i++) {
         const docID = `https://perdu.com/${i}`;
         if (i < 8) {
-            batch.addOrUpdate.push(new documentBuilder_1.DocumentBuilder(docID, `Doc number ${i}`)
-                .withAllowAnonymousUsers(false)
-                .withAllowedPermissions(new securityIdentityBuilder_1.UserSecurityIdentityBuilder('olamothe@coveo.com')));
+            batch.addOrUpdate.push(new documentBuilder_1.DocumentBuilder(docID, `Doc number ${i}`).withPermissionSet(permissionSet));
         }
         else {
             batch.delete.push({ documentId: docID, deleteChildren: true });

package/dist/localtest.js.map

@@ -1 +1 @@
-{"version":3,"file":"localtest.js","sourceRoot":"","sources":["../src/localtest.ts"],"names":[],"mappings":";;AAAA,sDAAsD;AACtD,yBAAuB;AACvB,uDAAkD;AAClD,uEAAsE;AAEtE,wCAAyC;AACzC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,OAAiB,CAAC;AAC9C,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,MAAgB,CAAC;AAC5C,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,SAAmB,CAAC;AAElD,KAAK,UAAU,IAAI;IACjB,MAAM,MAAM,GAAG,IAAI,iBAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC/C,MAAM,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACnD,MAAM,UAAU,GAAG,IAAI,iCAAe,CACpC,mBAAmB,EACnB,mBAAmB,CACpB;SACE,UAAU,CAAC,qBAAqB,CAAC;SACjC,gBAAgB,CAAC,yBAAyB,CAAC;SAC3C,QAAQ,CAAC,6BAA6B,CAAC;SACvC,iBAAiB,CAAC,KAAK,EAAE,KAAK,CAAC;SAC/B,QAAQ,CAAC,YAAY,CAAC;SACtB,iBAAiB,CAAC,OAAO,CAAC;SAC1B,sBAAsB,CACrB,IAAI,qDAA2B,CAAC,oBAAoB,CAAC,CACtD;SACA,qBAAqB,CACpB,IAAI,qDAA2B,CAAC;QAC9B,oBAAoB;QACpB,oBAAoB;KACrB,CAAC,CACH,CAAC;IACJ,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IACvE,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAE5C,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,cAAc,CAC9C,SAAS,EACT,6BAA6B,CAC9B,CAAC;IACF,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IAElD,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IAC7B,SAAS,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;IAC5C,MAAM,qBAAqB,GAAG,MAAM,MAAM,CAAC,wBAAwB,CACjE,SAAS,EACT,SAAS,CACV,CAAC;IACF,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAEtE,MAAM,KAAK,GAAyB;QAClC,WAAW,EAAE,EAAE;QACf,MAAM,EAAE,EAAE;KACX,CAAC;IACF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;QAC3B,MAAM,KAAK,GAAG,qBAAqB,CAAC,EAAE,CAAC;QACvC,IAAI,CAAC,GAAG,CAAC,EAAE;YACT,KAAK,CAAC,WAAW,CAAC,IAAI,CACpB,IAAI,iCAAe,CAAC,KAAK,EAAE,cAAc,CAAC,EAAE,CAAC;iBAC1C,uBAAuB,CAAC,KAAK,CAAC;iBAC9B,sBAAsB,CACrB,IAAI,qDAA2B,CAAC,oBAAoB,CAAC,CACtD,CACJ,CAAC;SACH;aAAM;YACL,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAC,UAAU,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAC,CAAC,CAAC;SAC9D;KACF;IAED,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACxE,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;AAClD,CAAC;AAED,IAAI,EAAE,CAAC"}
+{"version":3,"file":"localtest.js","sourceRoot":"","sources":["../src/localtest.ts"],"names":[],"mappings":";;AAAA,sDAAsD;AACtD,yBAAuB;AACvB,uDAAkD;AAClD,uEAAsE;AAEtE,wCAAyC;AACzC,iEAA4D;AAC5D,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,OAAiB,CAAC;AAC9C,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,MAAgB,CAAC;AAC5C,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,SAAmB,CAAC;AAElD,KAAK,UAAU,IAAI;IACjB,MAAM,MAAM,GAAG,IAAI,iBAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC/C,MAAM,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACnD,MAAM,oBAAoB,GAAG,IAAI,2CAAoB,CAAC,KAAK,CAAC;SACzD,sBAAsB,CACrB,IAAI,qDAA2B,CAAC,oBAAoB,CAAC,CACtD;SACA,qBAAqB,CACpB,IAAI,qDAA2B,CAAC;QAC9B,oBAAoB;QACpB,oBAAoB;KACrB,CAAC,CACH,CAAC;IACJ,MAAM,UAAU,GAAG,IAAI,iCAAe,CACpC,mBAAmB,EACnB,mBAAmB,CACpB;SACE,UAAU,CAAC,qBAAqB,CAAC;SACjC,gBAAgB,CAAC,yBAAyB,CAAC;SAC3C,QAAQ,CAAC,6BAA6B,CAAC;SACvC,iBAAiB,CAAC,KAAK,EAAE,KAAK,CAAC;SAC/B,QAAQ,CAAC,YAAY,CAAC;SACtB,iBAAiB,CAAC,OAAO,CAAC;SAC1B,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;IAC3C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IACvE,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAE5C,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,cAAc,CAC9C,SAAS,EACT,6BAA6B,CAC9B,CAAC;IACF,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IAElD,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IAC7B,SAAS,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;IAC5C,MAAM,qBAAqB,GAAG,MAAM,MAAM,CAAC,wBAAwB,CACjE,SAAS,EACT,SAAS,CACV,CAAC;IACF,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAEtE,MAAM,KAAK,GAAyB;QAClC,WAAW,EAAE,EAAE;QACf,MAAM,EAAE,EAAE;KACX,CAAC;IAEF,MAAM,aAAa,GAAG,IAAI,2CAAoB,CAAC,KAAK,CAAC,CAAC,sBAAsB,CAC1E,IAAI,qDAA2B,CAAC,oBAAoB,CAAC,CACtD,CAAC;IAEF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;QAC3B,MAAM,KAAK,GAAG,qBAAqB,CAAC,EAAE,CAAC;QACvC,IAAI,CAAC,GAAG,CAAC,EAAE;YACT,KAAK,CAAC,WAAW,CAAC,IAAI,CACpB,IAAI,iCAAe,CAAC,KAAK,EAAE,cAAc,CAAC,EAAE,CAAC,CAAC,iBAAiB,CAC7D,aAAa,CACd,CACF,CAAC;SACH;aAAM;YACL,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAC,UAAU,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAC,CAAC,CAAC;SAC9D;KACF;IAED,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACxE,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;AAClD,CAAC;AAED,IAAI,EAAE,CAAC"}

package/dist/permissionSetBuilder.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PermissionSetBuilder = void 0;
+class PermissionSetBuilder {
+    /**
+     * Builds a Permission Set Model
+     *
+     * See[Simple Permission Model Definition](https://docs.coveo.com/en/107/index-content/simple-permission-model-definition-examples)
+     * @param {boolean} allowAnonymous Whether to allow anonymous users in this permission set
+     */
+    constructor(allowAnonymous) {
+        this.permissionSet = {
+            allowAnonymous,
+            allowedPermissions: [],
+            deniedPermissions: [],
+        };
+    }
+    /**
+     * Set allowed identities on the document. See {@link PermissionSet}
+     *
+     * When the {@link PermissionsSetBuilder} class is instanciated with `allowAnonymous` property set to `true`, calling this method is redundant, and can therefore be omitted.
+     * @param securityIdentityBuilder The allowed security identities to add to the permission set
+     * @returns
+     */
+    withAllowedPermissions(securityIdentityBuilder) {
+        this.setPermission(securityIdentityBuilder, 'allowedPermissions');
+        return this;
+    }
+    /**
+     * Set denied identities on the document. See {@link PermissionSet}
+     *
+     * @param securityIdentityBuilder The denied security identities to add to the permission set
+     * @returns
+     */
+    withDeniedPermissions(securityIdentityBuilder) {
+        this.setPermission(securityIdentityBuilder, 'deniedPermissions');
+        return this;
+    }
+    /**
+     * Build and return the security identity or identities.
+     * @returns
+     */
+    build() {
+        return this.permissionSet;
+    }
+    setPermission(securityIdentityBuilder, permissionSection) {
+        var _a, _b;
+        const identities = securityIdentityBuilder.build();
+        if (Array.isArray(identities)) {
+            this.permissionSet[permissionSection] =
+                (_a = this.permissionSet[permissionSection]) === null || _a === void 0 ? void 0 : _a.concat(identities);
+        }
+        else {
+            (_b = this.permissionSet[permissionSection]) === null || _b === void 0 ? void 0 : _b.push(identities);
+        }
+    }
+}
+exports.PermissionSetBuilder = PermissionSetBuilder;
+//# sourceMappingURL=permissionSetBuilder.js.map

package/dist/permissionSetBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissionSetBuilder.js","sourceRoot":"","sources":["../src/permissionSetBuilder.ts"],"names":[],"mappings":";;;AAQA,MAAa,oBAAoB;IAG/B;;;;;OAKG;IACH,YAAmB,cAAuB;QACxC,IAAI,CAAC,aAAa,GAAG;YACnB,cAAc;YACd,kBAAkB,EAAE,EAAE;YACtB,iBAAiB,EAAE,EAAE;SACtB,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,sBAAsB,CAC3B,uBAAgD;QAEhD,IAAI,CAAC,aAAa,CAAC,uBAAuB,EAAE,oBAAoB,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,qBAAqB,CAC1B,uBAAgD;QAEhD,IAAI,CAAC,aAAa,CAAC,uBAAuB,EAAE,mBAAmB,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,KAAK;QACV,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEO,aAAa,CACnB,uBAAgD,EAChD,iBAAoC;;QAEpC,MAAM,UAAU,GAAG,uBAAuB,CAAC,KAAK,EAAE,CAAC;QACnD,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC7B,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC;gBACnC,MAAA,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,0CAAE,MAAM,CAAC,UAAU,CAAC,CAAC;SAC7D;aAAM;YACL,MAAA,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,0CAAE,IAAI,CAAC,UAAU,CAAC,CAAC;SACzD;IACH,CAAC;CACF;AAhED,oDAgEC"}

package/dist/permissionSetBuilder.spec.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const permissionSetBuilder_1 = require("./permissionSetBuilder");
+const securityIdentityBuilder_1 = require("./securityIdentityBuilder");
+describe('PermissionSetBuilder', () => {
+    const bobUserIdentity = new securityIdentityBuilder_1.UserSecurityIdentityBuilder('bob@foo.com');
+    const multipleUsersIdentity = new securityIdentityBuilder_1.UserSecurityIdentityBuilder([
+        'max@foo.com',
+        'sue@foo.com',
+    ]);
+    const groupIdentity = new securityIdentityBuilder_1.GroupSecurityIdentityBuilder('my_group');
+    const virtualGroupsIdentity = new securityIdentityBuilder_1.VirtualGroupSecurityIdentityBuilder([
+        'SampleGroup',
+        'SpecialGroup',
+    ]);
+    let restrictedPermissionSet;
+    let openedPermissionSet;
+    beforeEach(() => {
+        restrictedPermissionSet = new permissionSetBuilder_1.PermissionSetBuilder(false);
+        openedPermissionSet = new permissionSetBuilder_1.PermissionSetBuilder(true);
+    });
+    it('should marshal allowAnonymous to false', () => {
+        expect(restrictedPermissionSet.build()).toEqual(expect.objectContaining({ allowAnonymous: false }));
+    });
+    it('should marshal allowAnonymous to true', () => {
+        expect(openedPermissionSet.build()).toEqual(expect.objectContaining({ allowAnonymous: true }));
+    });
+    it('should marshal allowedPermissions', () => {
+        restrictedPermissionSet.withAllowedPermissions(bobUserIdentity);
+        expect(restrictedPermissionSet.build()).toMatchObject({
+            allowedPermissions: expect.arrayContaining([
+                expect.objectContaining({ identity: 'bob@foo.com' }),
+            ]),
+        });
+    });
+    it('should marshal allowedPermissions in multiple #withAllowedPermissions', () => {
+        restrictedPermissionSet
+            .withAllowedPermissions(multipleUsersIdentity)
+            .withAllowedPermissions(bobUserIdentity)
+            .withAllowedPermissions(virtualGroupsIdentity)
+            .withAllowedPermissions(groupIdentity);
+        expect(restrictedPermissionSet.build()).toMatchSnapshot();
+    });
+    it('should marshal deniedPermissions', () => {
+        restrictedPermissionSet.withDeniedPermissions(new securityIdentityBuilder_1.UserSecurityIdentityBuilder('bob@foo.com'));
+        expect(restrictedPermissionSet.build()).toMatchObject({
+            deniedPermissions: expect.arrayContaining([
+                expect.objectContaining({ identity: 'bob@foo.com' }),
+            ]),
+        });
+    });
+    it('should marshal deniedPermissions in multiple #withDeniedPermissions', () => {
+        restrictedPermissionSet
+            .withDeniedPermissions(multipleUsersIdentity)
+            .withDeniedPermissions(bobUserIdentity)
+            .withDeniedPermissions(virtualGroupsIdentity)
+            .withDeniedPermissions(groupIdentity);
+        expect(restrictedPermissionSet.build()).toMatchSnapshot();
+    });
+    it('should marshal both allowed and denied permissions ', () => {
+        restrictedPermissionSet
+            .withDeniedPermissions(multipleUsersIdentity)
+            .withDeniedPermissions(bobUserIdentity)
+            .withAllowedPermissions(virtualGroupsIdentity)
+            .withAllowedPermissions(groupIdentity);
+        expect(restrictedPermissionSet.build()).toMatchSnapshot();
+    });
+});
+//# sourceMappingURL=permissionSetBuilder.spec.js.map

package/dist/permissionSetBuilder.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissionSetBuilder.spec.js","sourceRoot":"","sources":["../src/permissionSetBuilder.spec.ts"],"names":[],"mappings":";;AAAA,iEAA4D;AAC5D,uEAImC;AAEnC,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IACpC,MAAM,eAAe,GAAG,IAAI,qDAA2B,CAAC,aAAa,CAAC,CAAC;IACvE,MAAM,qBAAqB,GAAG,IAAI,qDAA2B,CAAC;QAC5D,aAAa;QACb,aAAa;KACd,CAAC,CAAC;IACH,MAAM,aAAa,GAAG,IAAI,sDAA4B,CAAC,UAAU,CAAC,CAAC;IACnE,MAAM,qBAAqB,GAAG,IAAI,6DAAmC,CAAC;QACpE,aAAa;QACb,cAAc;KACf,CAAC,CAAC;IACH,IAAI,uBAA6C,CAAC;IAClD,IAAI,mBAAyC,CAAC;IAE9C,UAAU,CAAC,GAAG,EAAE;QACd,uBAAuB,GAAG,IAAI,2CAAoB,CAAC,KAAK,CAAC,CAAC;QAC1D,mBAAmB,GAAG,IAAI,2CAAoB,CAAC,IAAI,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,CAAC,uBAAuB,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAC7C,MAAM,CAAC,gBAAgB,CAAC,EAAC,cAAc,EAAE,KAAK,EAAC,CAAC,CACjD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CACzC,MAAM,CAAC,gBAAgB,CAAC,EAAC,cAAc,EAAE,IAAI,EAAC,CAAC,CAChD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,uBAAuB,CAAC,sBAAsB,CAAC,eAAe,CAAC,CAAC;QAEhE,MAAM,CAAC,uBAAuB,CAAC,KAAK,EAAE,CAAC,CAAC,aAAa,CAAC;YACpD,kBAAkB,EAAE,MAAM,CAAC,eAAe,CAAC;gBACzC,MAAM,CAAC,gBAAgB,CAAC,EAAC,QAAQ,EAAE,aAAa,EAAC,CAAC;aACnD,CAAC;SACH,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;QAC/E,uBAAuB;aACpB,sBAAsB,CAAC,qBAAqB,CAAC;aAC7C,sBAAsB,CAAC,eAAe,CAAC;aACvC,sBAAsB,CAAC,qBAAqB,CAAC;aAC7C,sBAAsB,CAAC,aAAa,CAAC,CAAC;QAEzC,MAAM,CAAC,uBAAuB,CAAC,KAAK,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,uBAAuB,CAAC,qBAAqB,CAC3C,IAAI,qDAA2B,CAAC,aAAa,CAAC,CAC/C,CAAC;QAEF,MAAM,CAAC,uBAAuB,CAAC,KAAK,EAAE,CAAC,CAAC,aAAa,CAAC;YACpD,iBAAiB,EAAE,MAAM,CAAC,eAAe,CAAC;gBACxC,MAAM,CAAC,gBAAgB,CAAC,EAAC,QAAQ,EAAE,aAAa,EAAC,CAAC;aACnD,CAAC;SACH,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qEAAqE,EAAE,GAAG,EAAE;QAC7E,uBAAuB;aACpB,qBAAqB,CAAC,qBAAqB,CAAC;aAC5C,qBAAqB,CAAC,eAAe,CAAC;aACtC,qBAAqB,CAAC,qBAAqB,CAAC;aAC5C,qBAAqB,CAAC,aAAa,CAAC,CAAC;QAExC,MAAM,CAAC,uBAAuB,CAAC,KAAK,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC7D,uBAAuB;aACpB,qBAAqB,CAAC,qBAAqB,CAAC;aAC5C,qBAAqB,CAAC,eAAe,CAAC;aACtC,sBAAsB,CAAC,qBAAqB,CAAC;aAC7C,sBAAsB,CAAC,aAAa,CAAC,CAAC;QAEzC,MAAM,CAAC,uBAAuB,CAAC,KAAK,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC;IAC5D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/securityIdentityBuilder.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VirtualGroupSecurityIdentityBuilder = exports.GroupSecurityIdentityBuilder = exports.UserSecurityIdentityBuilder = exports.AnySecurityIdentityBuilder = void 0;
+const platform_client_1 = require("@coveo/platform-client");
 /**
- * Build any {@link SecurityIdentityType}.
+ * Build any {@link PermissionIdentityType}.
  *
  * Instead of using this class directly, use one of:
  * - {@link UserSecurityIdentityBuilder}
@@ -11,17 +12,23 @@ exports.VirtualGroupSecurityIdentityBuilder = exports.GroupSecurityIdentityBuild
  */
 class AnySecurityIdentityBuilder {
     /**
+     * @param identityType  The type of the identity.
+     * Valid values:
+     * - `UNKNOWN`
+     * - `USER` : Defines a single user.
+     * - `GROUP` : Defines an existing group of identities within the indexed system. Individual members of this group can be of any valid identity Type (USER, GROUP, or VIRTUAL_GROUP).
+     * - `VIRTUAL_GROUP` : Defines a group that doesn't exist within the indexed system. Mechanically, a `VIRTUAL_GROUP` is identical to a `GROUP`.
      *
-     * @param identityType
-     * @param identity
-     * @param securityProvider
+     * @param identity The name of the security identity.
+     * Examples:
+     * - `asmith@example.com`
+     * - `SampleTeam2`
+     *
+     * @param securityProvider The security identity provider through which the security identity is updated. Defaults to the first security identity provider associated with the target source.
      */
     constructor(identityType, identity, securityProvider) {
-        this.securityIdentity = {
-            identityType,
-            identity,
-            securityProvider,
-        };
+        this.securityIdentity = Object.assign({ identityType,
+            identity }, (securityProvider && { securityProvider }));
     }
     /**
      * Build and return the security identity.
@@ -35,15 +42,15 @@ exports.AnySecurityIdentityBuilder = AnySecurityIdentityBuilder;
 /**
  * Build a security identity of type `USER`.
  *
- * Typically used in conjunction with {@link DocumentBuilder.withAllowedPermissions} or {@link DocumentBuilder.withDeniedPermissions}.
+ * Typically used in conjunction with {@link PermissionSetBuilder.withAllowedPermissions} or {@link PermissionSetBuilder.withDeniedPermissions}.
  *
- * See {@link SecurityIdentity}.
+ * See {@link Permission}.
  */
 class UserSecurityIdentityBuilder {
     /**
      * Pass either a single user, or an array of user to create multiple identities.
-     * @param user
-     * @param securityProvider
+     * @param {(string | string[])} user  The user identity or identities
+     * @param {string} [securityProvider='Email Security Provider'] The security identity provider through which the security identity is updated. Defaults to the first security identity provider associated with the target source.
      */
     constructor(user, securityProvider = 'Email Security Provider') {
         this.user = user;
@@ -55,24 +62,24 @@ class UserSecurityIdentityBuilder {
      */
     build() {
         if (Array.isArray(this.user)) {
-            return this.user.map((u) => new AnySecurityIdentityBuilder('USER', u, this.securityProvider).build());
+            return this.user.map((u) => new AnySecurityIdentityBuilder(platform_client_1.PermissionIdentityType.User, u, this.securityProvider).build());
         }
-        return new AnySecurityIdentityBuilder('USER', this.user, this.securityProvider).build();
+        return new AnySecurityIdentityBuilder(platform_client_1.PermissionIdentityType.User, this.user, this.securityProvider).build();
     }
 }
 exports.UserSecurityIdentityBuilder = UserSecurityIdentityBuilder;
 /**
  * Build a security identity of type `GROUP`.
  *
- * Typically used in conjunction with {@link DocumentBuilder.withAllowedPermissions} or {@link DocumentBuilder.withDeniedPermissions}.
+ * Typically used in conjunction with {@link PermissionSetBuilder.withAllowedPermissions} or {@link PermissionSetBuilder.withDeniedPermissions}.
  *
- * See {@link SecurityIdentity}.
+ * See {@link Permission}.
  */
 class GroupSecurityIdentityBuilder {
     /**
      * Pass either a single `group`, or an array of `group` to create multiple identities.
-     * @param group
-     * @param securityProvider
+     * @param {(string | string[])} group
+     * @param {string} [securityProvider] The security identity provider through which the security identity is updated. Defaults to the first security identity provider associated with the target source.
      */
     constructor(group, securityProvider) {
         this.group = group;
@@ -84,24 +91,24 @@ class GroupSecurityIdentityBuilder {
      */
     build() {
         if (Array.isArray(this.group)) {
-            return this.group.map((g) => new AnySecurityIdentityBuilder('GROUP', g, this.securityProvider).build());
+            return this.group.map((g) => new AnySecurityIdentityBuilder(platform_client_1.PermissionIdentityType.Group, g, this.securityProvider).build());
         }
-        return new AnySecurityIdentityBuilder('GROUP', this.group, this.securityProvider).build();
+        return new AnySecurityIdentityBuilder(platform_client_1.PermissionIdentityType.Group, this.group, this.securityProvider).build();
     }
 }
 exports.GroupSecurityIdentityBuilder = GroupSecurityIdentityBuilder;
 /**
  * Build a security identity of type `VIRTUAL_GROUP`.
  *
- * Typically used in conjunction with {@link DocumentBuilder.withAllowedPermissions} or {@link DocumentBuilder.withDeniedPermissions}.
+ * Typically used in conjunction with {@link PermissionSetBuilder.withAllowedPermissions} or {@link PermissionSetBuilder.withDeniedPermissions}.
  *
- * See {@link SecurityIdentity}.
+ * See {@link Permission}.
  */
 class VirtualGroupSecurityIdentityBuilder {
     /**
      * Pass either a single `virtualGroup`, or an array of `virtualGroup` to create multiple identities.
-     * @param group
-     * @param securityProvider
+     * @param {(string | string[])} virtualGroup
+     * @param {string} [securityProvider] The security identity provider through which the security identity is updated. Defaults to the first security identity provider associated with the target source.
      */
     constructor(virtualGroup, securityProvider) {
         this.virtualGroup = virtualGroup;
@@ -113,9 +120,9 @@ class VirtualGroupSecurityIdentityBuilder {
      */
     build() {
         if (Array.isArray(this.virtualGroup)) {
-            return this.virtualGroup.map((vg) => new AnySecurityIdentityBuilder('VIRTUAL_GROUP', vg, this.securityProvider).build());
+            return this.virtualGroup.map((vg) => new AnySecurityIdentityBuilder(platform_client_1.PermissionIdentityType.VirtualGroup, vg, this.securityProvider).build());
         }
-        return new AnySecurityIdentityBuilder('VIRTUAL_GROUP', this.virtualGroup, this.securityProvider).build();
+        return new AnySecurityIdentityBuilder(platform_client_1.PermissionIdentityType.VirtualGroup, this.virtualGroup, this.securityProvider).build();
     }
 }
 exports.VirtualGroupSecurityIdentityBuilder = VirtualGroupSecurityIdentityBuilder;

package/dist/securityIdentityBuilder.js.map

@@ -1 +1 @@
-{"version":3,"file":"securityIdentityBuilder.js","sourceRoot":"","sources":["../src/securityIdentityBuilder.ts"],"names":[],"mappings":";;;AASA;;;;;;;GAOG;AACH,MAAa,0BAA0B;IAErC;;;;;OAKG;IACH,YACE,YAAkC,EAClC,QAAgB,EAChB,gBAAyB;QAEzB,IAAI,CAAC,gBAAgB,GAAG;YACtB,YAAY;YACZ,QAAQ;YACR,gBAAgB;SACjB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,KAAK;QACV,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;CACF;AA3BD,gEA2BC;AAED;;;;;;GAMG;AACH,MAAa,2BAA2B;IACtC;;;;OAIG;IACH,YACU,IAAuB,EACvB,mBAA2B,yBAAyB;QADpD,SAAI,GAAJ,IAAI,CAAmB;QACvB,qBAAgB,GAAhB,gBAAgB,CAAoC;IAC3D,CAAC;IAEJ;;;OAGG;IACI,KAAK;QACV,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACzB,IAAI,0BAA0B,CAAC,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC,KAAK,EAAE,CACzE,CAAC;SACH;QACD,OAAO,IAAI,0BAA0B,CACnC,MAAM,EACN,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,gBAAgB,CACtB,CAAC,KAAK,EAAE,CAAC;IACZ,CAAC;CACF;AA3BD,kEA2BC;AAED;;;;;;GAMG;AACH,MAAa,4BAA4B;IACvC;;;;OAIG;IACH,YACU,KAAwB,EACxB,gBAAyB;QADzB,UAAK,GAAL,KAAK,CAAmB;QACxB,qBAAgB,GAAhB,gBAAgB,CAAS;IAChC,CAAC;IAEJ;;;OAGG;IACI,KAAK;QACV,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAC1B,IAAI,0BAA0B,CAC5B,OAAO,EACP,CAAC,EACD,IAAI,CAAC,gBAAgB,CACtB,CAAC,KAAK,EAAE,CACV,CAAC;SACH;QACD,OAAO,IAAI,0BAA0B,CACnC,OAAO,EACP,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,gBAAgB,CACtB,CAAC,KAAK,EAAE,CAAC;IACZ,CAAC;CACF;AA/BD,oEA+BC;AACD;;;;;;GAMG;AACH,MAAa,mCAAmC;IAG9C;;;;OAIG;IACH,YACU,YAA+B,EAC/B,gBAAyB;QADzB,iBAAY,GAAZ,YAAY,CAAmB;QAC/B,qBAAgB,GAAhB,gBAAgB,CAAS;IAChC,CAAC;IAEJ;;;OAGG;IACI,KAAK;QACV,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;YACpC,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAClC,IAAI,0BAA0B,CAC5B,eAAe,EACf,EAAE,EACF,IAAI,CAAC,gBAAgB,CACtB,CAAC,KAAK,EAAE,CACV,CAAC;SACH;QACD,OAAO,IAAI,0BAA0B,CACnC,eAAe,EACf,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,gBAAgB,CACtB,CAAC,KAAK,EAAE,CAAC;IACZ,CAAC;CACF;AAjCD,kFAiCC"}
+{"version":3,"file":"securityIdentityBuilder.js","sourceRoot":"","sources":["../src/securityIdentityBuilder.ts"],"names":[],"mappings":";;;AAEA,4DAA0E;AAS1E;;;;;;;GAOG;AACH,MAAa,0BAA0B;IAErC;;;;;;;;;;;;;;OAcG;IACH,YACE,YAAoC,EACpC,QAAgB,EAChB,gBAAyB;QAEzB,IAAI,CAAC,gBAAgB,mBACnB,YAAY;YACZ,QAAQ,IACL,CAAC,gBAAgB,IAAI,EAAC,gBAAgB,EAAC,CAAC,CAC5C,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,KAAK;QACV,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;CACF;AApCD,gEAoCC;AAED;;;;;;GAMG;AACH,MAAa,2BAA2B;IACtC;;;;OAIG;IACH,YACU,IAAuB,EACvB,mBAA2B,yBAAyB;QADpD,SAAI,GAAJ,IAAI,CAAmB;QACvB,qBAAgB,GAAhB,gBAAgB,CAAoC;IAC3D,CAAC;IAEJ;;;OAGG;IACI,KAAK;QACV,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACzB,IAAI,0BAA0B,CAC5B,wCAAsB,CAAC,IAAI,EAC3B,CAAC,EACD,IAAI,CAAC,gBAAgB,CACtB,CAAC,KAAK,EAAE,CACV,CAAC;SACH;QACD,OAAO,IAAI,0BAA0B,CACnC,wCAAsB,CAAC,IAAI,EAC3B,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,gBAAgB,CACtB,CAAC,KAAK,EAAE,CAAC;IACZ,CAAC;CACF;AA/BD,kEA+BC;AAED;;;;;;GAMG;AACH,MAAa,4BAA4B;IACvC;;;;OAIG;IACH,YACU,KAAwB,EACxB,gBAAyB;QADzB,UAAK,GAAL,KAAK,CAAmB;QACxB,qBAAgB,GAAhB,gBAAgB,CAAS;IAChC,CAAC;IAEJ;;;OAGG;IACI,KAAK;QACV,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAC1B,IAAI,0BAA0B,CAC5B,wCAAsB,CAAC,KAAK,EAC5B,CAAC,EACD,IAAI,CAAC,gBAAgB,CACtB,CAAC,KAAK,EAAE,CACV,CAAC;SACH;QACD,OAAO,IAAI,0BAA0B,CACnC,wCAAsB,CAAC,KAAK,EAC5B,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,gBAAgB,CACtB,CAAC,KAAK,EAAE,CAAC;IACZ,CAAC;CACF;AA/BD,oEA+BC;AACD;;;;;;GAMG;AACH,MAAa,mCAAmC;IAG9C;;;;OAIG;IACH,YACU,YAA+B,EAC/B,gBAAyB;QADzB,iBAAY,GAAZ,YAAY,CAAmB;QAC/B,qBAAgB,GAAhB,gBAAgB,CAAS;IAChC,CAAC;IAEJ;;;OAGG;IACI,KAAK;QACV,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;YACpC,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAClC,IAAI,0BAA0B,CAC5B,wCAAsB,CAAC,YAAY,EACnC,EAAE,EACF,IAAI,CAAC,gBAAgB,CACtB,CAAC,KAAK,EAAE,CACV,CAAC;SACH;QACD,OAAO,IAAI,0BAA0B,CACnC,wCAAsB,CAAC,YAAY,EACnC,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,gBAAgB,CACtB,CAAC,KAAK,EAAE,CAAC;IACZ,CAAC;CACF;AAjCD,kFAiCC"}