@coveo/push-api-client 1.7.0 → 2.1.1

package/dist/source/securityIdenty.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SecurityIdentity = void 0;
+require('isomorphic-fetch');
+require('abortcontroller-polyfill');
+class SecurityIdentity {
+    /**
+     *
+     * @param apikey An apiKey capable of pushing documents and managing sources in a Coveo organization. See [Manage API Keys](https://docs.coveo.com/en/1718).
+     * @param organizationid The Coveo Organization identifier.
+     */
+    constructor(platformClient) {
+        this.platformClient = platformClient;
+    }
+    /**
+     * Create or update a security identity. See [Adding a Single Security Identity](https://docs.coveo.com/en/167) and [Security Identity Models](https://docs.coveo.com/en/139).
+     * @param securityProviderId
+     * @param securityIdentity
+     * @returns
+     */
+    createSecurityIdentity(securityProviderId, securityIdentity) {
+        return this.platformClient.pushApi.createOrUpdateSecurityIdentity(securityProviderId, securityIdentity);
+    }
+    /**
+     * Create or update a security identity alias. See [Adding a Single Alias](https://docs.coveo.com/en/142) and [User Alias Definition Examples](https://docs.coveo.com/en/46).
+     * @param securityProviderId
+     * @param securityIdentityAlias
+     * @returns
+     */
+    createOrUpdateSecurityIdentityAlias(securityProviderId, securityIdentityAlias) {
+        return this.platformClient.pushApi.createOrUpdateSecurityIdentityAlias(securityProviderId, securityIdentityAlias);
+    }
+    /**
+     * Delete a security identity. See [Disabling a Single Security Identity](https://docs.coveo.com/en/84).
+     * @param securityProviderId
+     * @param securityIdentityToDelete
+     * @returns
+     */
+    deleteSecurityIdentity(securityProviderId, securityIdentityToDelete) {
+        return this.platformClient.pushApi.deleteSecurityIdentity(securityProviderId, securityIdentityToDelete);
+    }
+    /**
+     * Delete old security identities. See [Disabling Old Security Identities](https://docs.coveo.com/en/33).
+     * @param securityProviderId
+     * @param batchDelete
+     * @returns
+     */
+    deleteOldSecurityIdentities(securityProviderId, batchDelete) {
+        return this.platformClient.pushApi.deleteOldSecurityIdentities(securityProviderId, batchDelete);
+    }
+    /**
+     * Manage batches of security identities. See [Manage Batches of Security Identities](https://docs.coveo.com/en/55).
+     */
+    manageSecurityIdentities(securityProviderId, batchConfig) {
+        return this.platformClient.pushApi.manageSecurityIdentities(securityProviderId, batchConfig);
+    }
+}
+exports.SecurityIdentity = SecurityIdentity;
+//# sourceMappingURL=securityIdenty.js.map

package/dist/source/securityIdenty.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"securityIdenty.js","sourceRoot":"","sources":["../../src/source/securityIdenty.ts"],"names":[],"mappings":";;;AAAA,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAC5B,OAAO,CAAC,0BAA0B,CAAC,CAAC;AAWpC,MAAa,gBAAgB;IAC3B;;;;OAIG;IACH,YAAoB,cAA8B;QAA9B,mBAAc,GAAd,cAAc,CAAgB;IAAG,CAAC;IAEtD;;;;;OAKG;IACI,sBAAsB,CAC3B,kBAA0B,EAC1B,gBAAuC;QAEvC,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,8BAA8B,CAC/D,kBAAkB,EAClB,gBAAgB,CACjB,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,mCAAmC,CACxC,kBAA0B,EAC1B,qBAAiD;QAEjD,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,mCAAmC,CACpE,kBAAkB,EAClB,qBAAqB,CACtB,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,sBAAsB,CAC3B,kBAA0B,EAC1B,wBAAgD;QAEhD,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,sBAAsB,CACvD,kBAAkB,EAClB,wBAAwB,CACzB,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,2BAA2B,CAChC,kBAA0B,EAC1B,WAA0C;QAE1C,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,2BAA2B,CAC5D,kBAAkB,EAClB,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,wBAAwB,CAC7B,kBAA0B,EAC1B,WAAwC;QAExC,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,wBAAwB,CACzD,kBAAkB,EAClB,WAAW,CACZ,CAAC;IACJ,CAAC;CACF;AApFD,4CAoFC"}

package/dist/source/source.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Source = void 0;
+const push_1 = require("./push");
+/**
+ * @deprecated This class has been replaced by {@link PushSource}
+ */
+exports.Source = push_1.PushSource;
+//# sourceMappingURL=source.js.map

package/dist/source/source.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"source.js","sourceRoot":"","sources":["../../src/source/source.ts"],"names":[],"mappings":";;;AAAA,iCAAkC;AAElC;;GAEG;AACU,QAAA,MAAM,GAAG,iBAAU,CAAC"}

package/dist/uploadStrategy/fileContainerStrategy.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileContainerStrategy = void 0;
+const axios_1 = require("axios");
+const fileContainer_1 = require("../help/fileContainer");
+/**
+ * Upload documents using the [File container](https://docs.coveo.com/en/43/index-content/creating-a-file-container)
+ *
+ * @class FileContainerStrategy
+ * @implements {UploadStrategy}
+ */
+class FileContainerStrategy {
+    constructor(urlBuilder, documentsAxiosConfig) {
+        this.urlBuilder = urlBuilder;
+        this.documentsAxiosConfig = documentsAxiosConfig;
+    }
+    async upload(batch) {
+        const fileContainer = await this.createFileContainer();
+        await (0, fileContainer_1.uploadContentToFileContainer)(fileContainer, batch);
+        return this.pushFileContainerContent(fileContainer);
+    }
+    async createFileContainer() {
+        const fileContainerURL = this.urlBuilder.fileContainerUrl.toString();
+        const res = await axios_1.default.post(fileContainerURL, {}, this.documentsAxiosConfig);
+        return res.data;
+    }
+    pushFileContainerContent(fileContainer) {
+        const pushURL = this.urlBuilder.baseAPIURLForUpdate;
+        pushURL.searchParams.append('fileId', fileContainer.fileId);
+        return axios_1.default.put(pushURL.toString(), {}, this.documentsAxiosConfig);
+    }
+}
+exports.FileContainerStrategy = FileContainerStrategy;
+//# sourceMappingURL=fileContainerStrategy.js.map

package/dist/uploadStrategy/fileContainerStrategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileContainerStrategy.js","sourceRoot":"","sources":["../../src/uploadStrategy/fileContainerStrategy.ts"],"names":[],"mappings":";;;AAAA,iCAAgD;AAGhD,yDAAmE;AAQnE;;;;;GAKG;AACH,MAAa,qBAAqB;IAChC,YACU,UAAsB,EACtB,oBAAwC;QADxC,eAAU,GAAV,UAAU,CAAY;QACtB,yBAAoB,GAApB,oBAAoB,CAAoB;IAC/C,CAAC;IAEG,KAAK,CAAC,MAAM,CAAC,KAA2B;QAC7C,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACvD,MAAM,IAAA,4CAA4B,EAAC,aAAa,EAAE,KAAK,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC,wBAAwB,CAAC,aAAa,CAAC,CAAC;IACtD,CAAC;IAEO,KAAK,CAAC,mBAAmB;QAC/B,MAAM,gBAAgB,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC;QACrE,MAAM,GAAG,GAAG,MAAM,eAAK,CAAC,IAAI,CAC1B,gBAAgB,EAChB,EAAE,EACF,IAAI,CAAC,oBAAoB,CAC1B,CAAC;QACF,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;IAEO,wBAAwB,CAAC,aAAoC;QACnE,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;QACpD,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;QAC5D,OAAO,eAAK,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACtE,CAAC;CACF;AA3BD,sDA2BC"}

package/dist/uploadStrategy/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./fileContainerStrategy"), exports);
+tslib_1.__exportStar(require("./strategy"), exports);
+tslib_1.__exportStar(require("./streamChunkStrategy"), exports);
+//# sourceMappingURL=index.js.map

package/dist/uploadStrategy/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/uploadStrategy/index.ts"],"names":[],"mappings":";;;AAAA,kEAAwC;AACxC,qDAA2B;AAC3B,gEAAsC"}

package/dist/uploadStrategy/strategy.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=strategy.js.map

package/dist/uploadStrategy/strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"strategy.js","sourceRoot":"","sources":["../../src/uploadStrategy/strategy.ts"],"names":[],"mappings":""}

package/dist/uploadStrategy/streamChunkStrategy.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamChunkStrategy = void 0;
+const axios_1 = require("axios");
+const url_1 = require("url");
+const fileContainer_1 = require("../help/fileContainer");
+/**
+ * Upload documents using the [Stream API](https://docs.coveo.com/en/lb4a0344/coveo-for-commerce/how-to-stream-your-catalog-data-to-your-source)
+ *
+ * @class StreamChunkStrategy
+ * @implements {UploadStrategy}
+ */
+class StreamChunkStrategy {
+    constructor(urlBuilder, documentsAxiosConfig) {
+        this.urlBuilder = urlBuilder;
+        this.documentsAxiosConfig = documentsAxiosConfig;
+        this._openedStream = null;
+    }
+    async upload(batch) {
+        const chunk = await this.requestStreamChunk();
+        return (0, fileContainer_1.uploadContentToFileContainer)(chunk, batch);
+    }
+    postUpload() {
+        return this.closeOpenedStream();
+    }
+    async openStreamIfNotAlreadyOpen() {
+        if (this._openedStream === null) {
+            const openStreamUrl = new url_1.URL(`${this.urlBuilder.baseStreamURL}/open`);
+            const res = await axios_1.default.post(openStreamUrl.toString(), {}, this.documentsAxiosConfig);
+            this._openedStream = res.data;
+        }
+        return this._openedStream;
+    }
+    async closeOpenedStream() {
+        if (this._openedStream === null) {
+            return;
+        }
+        const openStreamUrl = new url_1.URL(`${this.urlBuilder.baseStreamURL}/${this._openedStream.streamId}/close`);
+        const res = await axios_1.default.post(openStreamUrl.toString(), {}, this.documentsAxiosConfig);
+        this._openedStream = null;
+        return res.data;
+    }
+    async requestStreamChunk() {
+        const { streamId } = await this.openStreamIfNotAlreadyOpen();
+        const openStreamUrl = new url_1.URL(`${this.urlBuilder.baseStreamURL}/${streamId}/chunk`);
+        const res = await axios_1.default.post(openStreamUrl.toString(), {}, this.documentsAxiosConfig);
+        return res.data;
+    }
+}
+exports.StreamChunkStrategy = StreamChunkStrategy;
+//# sourceMappingURL=streamChunkStrategy.js.map

package/dist/uploadStrategy/streamChunkStrategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streamChunkStrategy.js","sourceRoot":"","sources":["../../src/uploadStrategy/streamChunkStrategy.ts"],"names":[],"mappings":";;;AAAA,iCAAgD;AAChD,6BAAwB;AAGxB,yDAAmE;AAUnE;;;;;GAKG;AACH,MAAa,mBAAmB;IAE9B,YACU,UAA4B,EAC5B,oBAAwC;QADxC,eAAU,GAAV,UAAU,CAAkB;QAC5B,yBAAoB,GAApB,oBAAoB,CAAoB;QAH1C,kBAAa,GAA0B,IAAI,CAAC;IAIjD,CAAC;IAEG,KAAK,CAAC,MAAM,CAAC,KAA2B;QAC7C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC9C,OAAO,IAAA,4CAA4B,EAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAClC,CAAC;IAEM,KAAK,CAAC,0BAA0B;QACrC,IAAI,IAAI,CAAC,aAAa,KAAK,IAAI,EAAE;YAC/B,MAAM,aAAa,GAAG,IAAI,SAAG,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,aAAa,OAAO,CAAC,CAAC;YACvE,MAAM,GAAG,GAAG,MAAM,eAAK,CAAC,IAAI,CAC1B,aAAa,CAAC,QAAQ,EAAE,EACxB,EAAE,EACF,IAAI,CAAC,oBAAoB,CAC1B,CAAC;YAEF,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,IAAI,CAAC;SAC/B;QACD,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAC5B,IAAI,IAAI,CAAC,aAAa,KAAK,IAAI,EAAE;YAC/B,OAAO;SACR;QACD,MAAM,aAAa,GAAG,IAAI,SAAG,CAC3B,GAAG,IAAI,CAAC,UAAU,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,QAAQ,CACxE,CAAC;QAEF,MAAM,GAAG,GAAG,MAAM,eAAK,CAAC,IAAI,CAC1B,aAAa,CAAC,QAAQ,EAAE,EACxB,EAAE,EACF,IAAI,CAAC,oBAAoB,CAC1B,CAAC;QACF,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;IAEO,KAAK,CAAC,kBAAkB;QAC9B,MAAM,EAAC,QAAQ,EAAC,GAAG,MAAM,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAC3D,MAAM,aAAa,GAAG,IAAI,SAAG,CAC3B,GAAG,IAAI,CAAC,UAAU,CAAC,aAAa,IAAI,QAAQ,QAAQ,CACrD,CAAC;QAEF,MAAM,GAAG,GAAG,MAAM,eAAK,CAAC,IAAI,CAC1B,aAAa,CAAC,QAAQ,EAAE,EACxB,EAAE,EACF,IAAI,CAAC,oBAAoB,CAC1B,CAAC;QACF,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;CACF;AA5DD,kDA4DC"}

package/dist/validation/preconditions/apiKeyPrivilege.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureNecessaryCoveoPrivileges = void 0;
+const privilegeError_1 = require("../../errors/privilegeError");
+// Code copy pasted from https://github.com/coveo/cli/blob/master/packages/cli/src/lib/decorators/preconditions/apiKeyPrivilege.ts#L15
+async function ensureNecessaryCoveoPrivileges(client, ...privileges) {
+    const promises = privileges.flatMap((privilege) => privilege.models.map(async (model) => {
+        if (!(await hasPrivilege(client, model))) {
+            const message = privilege.unsatisfiedConditionMessage;
+            throw new privilegeError_1.PrivilegeError(message);
+        }
+    }));
+    await Promise.all(promises);
+}
+exports.ensureNecessaryCoveoPrivileges = ensureNecessaryCoveoPrivileges;
+async function hasPrivilege(client, privilege) {
+    const model = Object.assign({ requestedPrivilege: privilege });
+    const validation = await client.privilegeEvaluator.evaluate(model);
+    return Boolean(validation.approved);
+}
+//# sourceMappingURL=apiKeyPrivilege.js.map

package/dist/validation/preconditions/apiKeyPrivilege.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiKeyPrivilege.js","sourceRoot":"","sources":["../../../src/validation/preconditions/apiKeyPrivilege.ts"],"names":[],"mappings":";;;AAMA,gEAA2D;AAE3D,sIAAsI;AAC/H,KAAK,UAAU,8BAA8B,CAClD,MAAsB,EACtB,GAAG,UAA+B;IAElC,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAChD,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACnC,IAAI,CAAC,CAAC,MAAM,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,EAAE;YACxC,MAAM,OAAO,GAAG,SAAS,CAAC,2BAA2B,CAAC;YACtD,MAAM,IAAI,+BAAc,CAAC,OAAO,CAAC,CAAC;SACnC;IACH,CAAC,CAAC,CACH,CAAC;IAEF,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC9B,CAAC;AAdD,wEAcC;AAED,KAAK,UAAU,YAAY,CAAC,MAAsB,EAAE,SAAyB;IAC3E,MAAM,KAAK,iBACN,EAAC,kBAAkB,EAAE,SAAS,EAAC,CACnC,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACnE,OAAO,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;AACtC,CAAC"}

package/dist/validation/preconditions/apiKeyPrivilege.spec.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+jest.mock('@coveord/platform-client');
+const platform_client_1 = require("@coveord/platform-client");
+const platformPrivilege_1 = require("./platformPrivilege");
+const apiKeyPrivilege_1 = require("./apiKeyPrivilege");
+const mockedPlatformClient = jest.mocked(platform_client_1.default);
+const mockEvaluate = jest.fn();
+const doMockPlatformClient = () => {
+    mockedPlatformClient.mockImplementation(() => ({
+        privilegeEvaluator: { evaluate: mockEvaluate },
+    }));
+};
+const dummyPlatformClient = () => {
+    return new platform_client_1.default({ accessToken: 'xxx' });
+};
+describe('ApiKeyPrivileges', () => {
+    let client;
+    beforeAll(() => {
+        doMockPlatformClient();
+    });
+    beforeEach(async () => {
+        client = dummyPlatformClient();
+    });
+    describe('when not missing privileges', () => {
+        beforeEach(async () => {
+            mockEvaluate.mockResolvedValue({ approved: true });
+        });
+        it('should call the privilege evaluator for each privilege to evaluate', async () => {
+            await (0, apiKeyPrivilege_1.ensureNecessaryCoveoPrivileges)(client, platformPrivilege_1.writeFieldsPrivilege);
+            expect(mockEvaluate).toHaveBeenCalledTimes(3);
+        });
+        it.each([
+            {
+                type: 'VIEW',
+            },
+            {
+                type: 'CREATE',
+            },
+            {
+                type: 'EDIT',
+            },
+        ])('should evaluate the "$type FIELD" privilege', async ({ type }) => {
+            process.stdout.write('*********************\n');
+            process.stdout.write(`${type}\n`);
+            process.stdout.write('*********************\n');
+            await (0, apiKeyPrivilege_1.ensureNecessaryCoveoPrivileges)(client, platformPrivilege_1.writeFieldsPrivilege);
+            expect(mockEvaluate).toHaveBeenCalledWith({
+                requestedPrivilege: {
+                    type,
+                    targetDomain: 'FIELD',
+                    targetId: '*',
+                    owner: 'PLATFORM',
+                },
+            });
+        });
+        it('should not throw a Privilege Error', async () => {
+            await expect((0, apiKeyPrivilege_1.ensureNecessaryCoveoPrivileges)(client, platformPrivilege_1.writeFieldsPrivilege)).resolves.not.toThrow();
+        });
+    });
+    describe('when missing privileges', () => {
+        beforeEach(async () => {
+            mockEvaluate.mockResolvedValue({ approved: false });
+        });
+        it('should throw a Privilege Error', async () => {
+            await expect((0, apiKeyPrivilege_1.ensureNecessaryCoveoPrivileges)(client, platformPrivilege_1.writeFieldsPrivilege)).rejects.toThrow(/Your API key doesn't have the privilege to create or update fields/);
+        });
+    });
+});
+//# sourceMappingURL=apiKeyPrivilege.spec.js.map

package/dist/validation/preconditions/apiKeyPrivilege.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiKeyPrivilege.spec.js","sourceRoot":"","sources":["../../../src/validation/preconditions/apiKeyPrivilege.spec.ts"],"names":[],"mappings":";;AAAA,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;AAEtC,8DAAsD;AACtD,2DAAyD;AACzD,uDAAiE;AAEjE,MAAM,oBAAoB,GAAG,IAAI,CAAC,MAAM,CAAC,yBAAc,CAAC,CAAC;AACzD,MAAM,YAAY,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;AAE/B,MAAM,oBAAoB,GAAG,GAAG,EAAE;IAChC,oBAAoB,CAAC,kBAAkB,CACrC,GAAG,EAAE,CACH,CAAC;QACC,kBAAkB,EAAE,EAAC,QAAQ,EAAE,YAAY,EAAC;KACf,CAAA,CAClC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,GAAmB,EAAE;IAC/C,OAAO,IAAI,yBAAc,CAAC,EAAC,WAAW,EAAE,KAAK,EAAC,CAAC,CAAC;AAClD,CAAC,CAAC;AAEF,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,IAAI,MAAsB,CAAC;IAC3B,SAAS,CAAC,GAAG,EAAE;QACb,oBAAoB,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,MAAM,GAAG,mBAAmB,EAAE,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;QAC3C,UAAU,CAAC,KAAK,IAAI,EAAE;YACpB,YAAY,CAAC,iBAAiB,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;YAClF,MAAM,IAAA,gDAA8B,EAAC,MAAM,EAAE,wCAAoB,CAAC,CAAC;YACnE,MAAM,CAAC,YAAY,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,IAAI,CAAC;YACN;gBACE,IAAI,EAAE,MAAM;aACb;YACD;gBACE,IAAI,EAAE,QAAQ;aACf;YACD;gBACE,IAAI,EAAE,MAAM;aACb;SACF,CAAC,CAAC,6CAA6C,EAAE,KAAK,EAAE,EAAC,IAAI,EAAC,EAAE,EAAE;YACjE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;YAChD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC;YAClC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;YAEhD,MAAM,IAAA,gDAA8B,EAAC,MAAM,EAAE,wCAAoB,CAAC,CAAC;YACnE,MAAM,CAAC,YAAY,CAAC,CAAC,oBAAoB,CAAC;gBACxC,kBAAkB,EAAE;oBAClB,IAAI;oBACJ,YAAY,EAAE,OAAO;oBACrB,QAAQ,EAAE,GAAG;oBACb,KAAK,EAAE,UAAU;iBAClB;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;YAClD,MAAM,MAAM,CACV,IAAA,gDAA8B,EAAC,MAAM,EAAE,wCAAoB,CAAC,CAC7D,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACvC,UAAU,CAAC,KAAK,IAAI,EAAE;YACpB,YAAY,CAAC,iBAAiB,CAAC,EAAC,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;YAC9C,MAAM,MAAM,CACV,IAAA,gDAA8B,EAAC,MAAM,EAAE,wCAAoB,CAAC,CAC7D,CAAC,OAAO,CAAC,OAAO,CACf,oEAAoE,CACrE,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/validation/preconditions/platformPrivilege.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeFieldsPrivilege = exports.readFieldsPrivilege = void 0;
+exports.readFieldsPrivilege = {
+    models: [
+        {
+            type: 'VIEW',
+            targetDomain: 'FIELD',
+            targetId: '*',
+            owner: 'PLATFORM',
+        },
+    ],
+    unsatisfiedConditionMessage: `Your API key doesn't have the privilege to view fields and their configuration. Make sure to grant this privilege to your API key before running the command again.
+  See https://docs.coveo.com/en/1707#fields-domain`,
+};
+exports.writeFieldsPrivilege = {
+    models: [
+        ...exports.readFieldsPrivilege.models,
+        {
+            type: 'CREATE',
+            targetDomain: 'FIELD',
+            targetId: '*',
+            owner: 'PLATFORM',
+        },
+        {
+            type: 'EDIT',
+            targetDomain: 'FIELD',
+            targetId: '*',
+            owner: 'PLATFORM',
+        },
+    ],
+    unsatisfiedConditionMessage: `Your API key doesn't have the privilege to create or update fields. Make sure to grant this privilege to your API key before running the command again.
+  See https://docs.coveo.com/en/1707#fields-domain`,
+};
+//# sourceMappingURL=platformPrivilege.js.map

package/dist/validation/preconditions/platformPrivilege.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"platformPrivilege.js","sourceRoot":"","sources":["../../../src/validation/preconditions/platformPrivilege.ts"],"names":[],"mappings":";;;AAOa,QAAA,mBAAmB,GAAsB;IACpD,MAAM,EAAE;QACN;YACE,IAAI,EAAE,MAAM;YACZ,YAAY,EAAE,OAAO;YACrB,QAAQ,EAAE,GAAG;YACb,KAAK,EAAE,UAAU;SAClB;KACF;IACD,2BAA2B,EAAE;mDACoB;CAClD,CAAC;AAEW,QAAA,oBAAoB,GAAsB;IACrD,MAAM,EAAE;QACN,GAAG,2BAAmB,CAAC,MAAM;QAC7B;YACE,IAAI,EAAE,QAAQ;YACd,YAAY,EAAE,OAAO;YACrB,QAAQ,EAAE,GAAG;YACb,KAAK,EAAE,UAAU;SAClB;QACD;YACE,IAAI,EAAE,MAAM;YACZ,YAAY,EAAE,OAAO;YACrB,QAAQ,EAAE,GAAG;YACb,KAAK,EAAE,UAAU;SAClB;KACF;IACD,2BAA2B,EAAE;mDACoB;CAClD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/push-api-client",
-  "version": "1.7.0",
+  "version": "2.1.1",
   "description": "Push API client",
   "main": "./dist/index.js",
   "files": [