@coveo/push-api-client 3.0.116 → 3.0.122

package/dist/validation/parsePermissions.js

@@ -1,119 +1,119 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.processPermissionList = void 0;
-const bueno_1 = require("@coveo/bueno");
-const securityIdentityBuilder_1 = require("../securityIdentityBuilder");
-const caseInsensitiveDocument_1 = require("./caseInsensitiveDocument");
-const errors_1 = require("../errors");
-const knownKey_1 = require("./knownKey");
-const permissionSetBuilder_1 = require("../permissionSetBuilder");
-const requiredKeyValidator_1 = require("./requiredKeyValidator");
-const platform_client_1 = require("@coveo/platform-client");
-class PermissionParser {
-    constructor(caseInsensitiveDoc, documentBuilder, documentPath) {
-        this.caseInsensitiveDoc = caseInsensitiveDoc;
-        this.documentBuilder = documentBuilder;
-        this.documentPath = documentPath;
-        this.processPermissionSet = (permissionSet) => {
-            const permissionSetBuilder = this.validateRequiredPermissionSetKeysAndGetPermissionSetBuilder(permissionSet);
-            this.documentBuilder.withPermissionSet(permissionSetBuilder);
-        };
-    }
-    processPermissionList() {
-        this.ensurePermissionArray();
-        new knownKey_1.KnownKeys('permissions', this.caseInsensitiveDoc).whenExists((permissions) => {
-            permissions.forEach((permission) => {
-                const caseInsensitivePermission = new caseInsensitiveDocument_1.CaseInsensitiveDocument(permission);
-                new knownKey_1.KnownKeys('permissionsets', caseInsensitivePermission)
-                    .whenExists((permissionLevel) => this.processPermissionLevel(permissionLevel))
-                    .whenDoesNotExist((permissionSet) => this.processPermissionSet(permissionSet));
-            });
-            this.caseInsensitiveDoc.remove('permissions');
-        });
-    }
-    processPermissionLevel(permission) {
-        // TODO: require at least some permissions
-        const permissionSetBuilders = permission.permissionSets.map((permissionSet) => {
-            const caseInsensitivePermissions = new caseInsensitiveDocument_1.CaseInsensitiveDocument(permission);
-            const { isValid, explanation } = new requiredKeyValidator_1.RequiredKeyValidator('name', caseInsensitivePermissions, new bueno_1.StringValue({ required: true, emptyAllowed: false }));
-            if (!isValid) {
-                this.throwInvalidDocumentError(explanation);
-            }
-            return this.validateRequiredPermissionSetKeysAndGetPermissionSetBuilder(permissionSet);
-        });
-        // TODO: prevent empty permission set
-        this.documentBuilder.withPermissionLevel(permission.name, permissionSetBuilders);
-    }
-    validateAllowAnonymous(caseInsensitivePermissions) {
-        const { isValid, explanation, value } = new requiredKeyValidator_1.RequiredKeyValidator('allowanonymous', caseInsensitivePermissions, new bueno_1.BooleanValue({ required: true }));
-        if (!isValid) {
-            this.throwInvalidDocumentError(explanation);
-        }
-        return value;
-    }
-    validatePermission(permissionLogic, caseInsensitivePermissions) {
-        const { isValid, explanation, value } = new requiredKeyValidator_1.RequiredKeyValidator(permissionLogic, caseInsensitivePermissions, this.getSecurityIdentitySchemaValidation());
-        if (!isValid) {
-            this.throwInvalidDocumentError(explanation);
-        }
-        return value;
-    }
-    validateRequiredPermissionSetKeysAndGetPermissionSetBuilder(permission) {
-        const caseInsensitivePermissions = new caseInsensitiveDocument_1.CaseInsensitiveDocument(permission);
-        const allowAnonymous = this.validateAllowAnonymous(caseInsensitivePermissions);
-        const allowedPermissions = this.validatePermission('allowedpermissions', caseInsensitivePermissions);
-        const deniedPermissions = this.validatePermission('deniedpermissions', caseInsensitivePermissions);
-        const permissionSetBuilder = new permissionSetBuilder_1.PermissionSetBuilder(allowAnonymous);
-        allowedPermissions === null || allowedPermissions === void 0 ? void 0 : allowedPermissions.forEach(({ identity, identityType, securityProvider }) => {
-            permissionSetBuilder.withAllowedPermissions(new securityIdentityBuilder_1.AnySecurityIdentityBuilder(identityType, identity, securityProvider));
-        });
-        deniedPermissions === null || deniedPermissions === void 0 ? void 0 : deniedPermissions.forEach(({ identity, identityType, securityProvider }) => {
-            permissionSetBuilder.withDeniedPermissions(new securityIdentityBuilder_1.AnySecurityIdentityBuilder(identityType, identity, securityProvider));
-        });
-        return permissionSetBuilder;
-    }
-    get identityTypeRegex() {
-        const identityTypesValues = Object.values(platform_client_1.PermissionIdentityType);
-        return new RegExp(identityTypesValues.join('|'), 'i');
-    }
-    getSecurityIdentitySchemaValidation() {
-        return new bueno_1.ArrayValue({
-            required: false,
-            each: new bueno_1.RecordValue({
-                values: {
-                    identity: new bueno_1.StringValue({ required: true, emptyAllowed: false }),
-                    identityType: new bueno_1.StringValue({
-                        regex: this.identityTypeRegex,
-                        required: true,
-                        emptyAllowed: false,
-                    }),
-                    securityProvider: new bueno_1.StringValue({
-                        emptyAllowed: true,
-                        required: false,
-                    }),
-                },
-            }),
-        });
-    }
-    ensurePermissionArray() {
-        const validator = (schema) => new requiredKeyValidator_1.RequiredKeyValidator('permissions', this.caseInsensitiveDoc, schema);
-        const { isValid, explanation } = validator(new bueno_1.ArrayValue({ required: false }));
-        const requiredAtLeastOnePermission = validator(new bueno_1.ArrayValue({ min: 1 }));
-        if (!isValid) {
-            this.throwInvalidDocumentError(explanation);
-        }
-        if (!requiredAtLeastOnePermission.isValid) {
-            // simply discard empty array permission instead of throwing
-            this.caseInsensitiveDoc.remove('permissions');
-        }
-    }
-    throwInvalidDocumentError(explanation) {
-        throw new errors_1.InvalidDocument(this.documentPath, this.caseInsensitiveDoc.originalDocument, explanation);
-    }
-}
-const processPermissionList = (caseInsensitiveDoc, documentBuilder, documentPath) => {
-    const parser = new PermissionParser(caseInsensitiveDoc, documentBuilder, documentPath);
-    return parser.processPermissionList();
-};
-exports.processPermissionList = processPermissionList;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processPermissionList = void 0;
+const bueno_1 = require("@coveo/bueno");
+const securityIdentityBuilder_1 = require("../securityIdentityBuilder");
+const caseInsensitiveDocument_1 = require("./caseInsensitiveDocument");
+const errors_1 = require("../errors");
+const knownKey_1 = require("./knownKey");
+const permissionSetBuilder_1 = require("../permissionSetBuilder");
+const requiredKeyValidator_1 = require("./requiredKeyValidator");
+const platform_client_1 = require("@coveo/platform-client");
+class PermissionParser {
+    constructor(caseInsensitiveDoc, documentBuilder, documentPath) {
+        this.caseInsensitiveDoc = caseInsensitiveDoc;
+        this.documentBuilder = documentBuilder;
+        this.documentPath = documentPath;
+        this.processPermissionSet = (permissionSet) => {
+            const permissionSetBuilder = this.validateRequiredPermissionSetKeysAndGetPermissionSetBuilder(permissionSet);
+            this.documentBuilder.withPermissionSet(permissionSetBuilder);
+        };
+    }
+    processPermissionList() {
+        this.ensurePermissionArray();
+        new knownKey_1.KnownKeys('permissions', this.caseInsensitiveDoc).whenExists((permissions) => {
+            permissions.forEach((permission) => {
+                const caseInsensitivePermission = new caseInsensitiveDocument_1.CaseInsensitiveDocument(permission);
+                new knownKey_1.KnownKeys('permissionsets', caseInsensitivePermission)
+                    .whenExists((permissionLevel) => this.processPermissionLevel(permissionLevel))
+                    .whenDoesNotExist((permissionSet) => this.processPermissionSet(permissionSet));
+            });
+            this.caseInsensitiveDoc.remove('permissions');
+        });
+    }
+    processPermissionLevel(permission) {
+        // TODO: require at least some permissions
+        const permissionSetBuilders = permission.permissionSets.map((permissionSet) => {
+            const caseInsensitivePermissions = new caseInsensitiveDocument_1.CaseInsensitiveDocument(permission);
+            const { isValid, explanation } = new requiredKeyValidator_1.RequiredKeyValidator('name', caseInsensitivePermissions, new bueno_1.StringValue({ required: true, emptyAllowed: false }));
+            if (!isValid) {
+                this.throwInvalidDocumentError(explanation);
+            }
+            return this.validateRequiredPermissionSetKeysAndGetPermissionSetBuilder(permissionSet);
+        });
+        // TODO: prevent empty permission set
+        this.documentBuilder.withPermissionLevel(permission.name, permissionSetBuilders);
+    }
+    validateAllowAnonymous(caseInsensitivePermissions) {
+        const { isValid, explanation, value } = new requiredKeyValidator_1.RequiredKeyValidator('allowanonymous', caseInsensitivePermissions, new bueno_1.BooleanValue({ required: true }));
+        if (!isValid) {
+            this.throwInvalidDocumentError(explanation);
+        }
+        return value;
+    }
+    validatePermission(permissionLogic, caseInsensitivePermissions) {
+        const { isValid, explanation, value } = new requiredKeyValidator_1.RequiredKeyValidator(permissionLogic, caseInsensitivePermissions, this.getSecurityIdentitySchemaValidation());
+        if (!isValid) {
+            this.throwInvalidDocumentError(explanation);
+        }
+        return value;
+    }
+    validateRequiredPermissionSetKeysAndGetPermissionSetBuilder(permission) {
+        const caseInsensitivePermissions = new caseInsensitiveDocument_1.CaseInsensitiveDocument(permission);
+        const allowAnonymous = this.validateAllowAnonymous(caseInsensitivePermissions);
+        const allowedPermissions = this.validatePermission('allowedpermissions', caseInsensitivePermissions);
+        const deniedPermissions = this.validatePermission('deniedpermissions', caseInsensitivePermissions);
+        const permissionSetBuilder = new permissionSetBuilder_1.PermissionSetBuilder(allowAnonymous);
+        allowedPermissions === null || allowedPermissions === void 0 ? void 0 : allowedPermissions.forEach(({ identity, identityType, securityProvider }) => {
+            permissionSetBuilder.withAllowedPermissions(new securityIdentityBuilder_1.AnySecurityIdentityBuilder(identityType, identity, securityProvider));
+        });
+        deniedPermissions === null || deniedPermissions === void 0 ? void 0 : deniedPermissions.forEach(({ identity, identityType, securityProvider }) => {
+            permissionSetBuilder.withDeniedPermissions(new securityIdentityBuilder_1.AnySecurityIdentityBuilder(identityType, identity, securityProvider));
+        });
+        return permissionSetBuilder;
+    }
+    get identityTypeRegex() {
+        const identityTypesValues = Object.values(platform_client_1.PermissionIdentityType);
+        return new RegExp(identityTypesValues.join('|'), 'i');
+    }
+    getSecurityIdentitySchemaValidation() {
+        return new bueno_1.ArrayValue({
+            required: false,
+            each: new bueno_1.RecordValue({
+                values: {
+                    identity: new bueno_1.StringValue({ required: true, emptyAllowed: false }),
+                    identityType: new bueno_1.StringValue({
+                        regex: this.identityTypeRegex,
+                        required: true,
+                        emptyAllowed: false,
+                    }),
+                    securityProvider: new bueno_1.StringValue({
+                        emptyAllowed: true,
+                        required: false,
+                    }),
+                },
+            }),
+        });
+    }
+    ensurePermissionArray() {
+        const validator = (schema) => new requiredKeyValidator_1.RequiredKeyValidator('permissions', this.caseInsensitiveDoc, schema);
+        const { isValid, explanation } = validator(new bueno_1.ArrayValue({ required: false }));
+        const requiredAtLeastOnePermission = validator(new bueno_1.ArrayValue({ min: 1 }));
+        if (!isValid) {
+            this.throwInvalidDocumentError(explanation);
+        }
+        if (!requiredAtLeastOnePermission.isValid) {
+            // simply discard empty array permission instead of throwing
+            this.caseInsensitiveDoc.remove('permissions');
+        }
+    }
+    throwInvalidDocumentError(explanation) {
+        throw new errors_1.InvalidDocument(this.documentPath, this.caseInsensitiveDoc.originalDocument, explanation);
+    }
+}
+const processPermissionList = (caseInsensitiveDoc, documentBuilder, documentPath) => {
+    const parser = new PermissionParser(caseInsensitiveDoc, documentBuilder, documentPath);
+    return parser.processPermissionList();
+};
+exports.processPermissionList = processPermissionList;
 //# sourceMappingURL=parsePermissions.js.map

package/dist/validation/parsePermissions.spec.js

@@ -1,87 +1,87 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = require("path");
-const __1 = require("..");
-const caseInsensitiveDocument_1 = require("./caseInsensitiveDocument");
-const parsePermissions_1 = require("./parsePermissions");
-describe('parsePermissions', () => {
-    let documentBuilder;
-    const dummyPath = (0, path_1.join)('dummy', 'path');
-    const publicPermissionsSet = {
-        allowAnonymous: true,
-        deniedpermissions: [
-            {
-                identity: 'foo@example.com',
-                identityType: 'USER',
-            },
-        ],
-    };
-    const restrictedPermissionSet = {
-        allowAnonymous: false,
-        ALLOWEDPERMISSIONS: [
-            {
-                identity: 'asmith@example.com',
-                identityType: 'User',
-            },
-            {
-                identity: 'bjones@example.com',
-                identityType: 'USER',
-            },
-        ],
-    };
-    const complexPermissionSet = {
-        aLLowAnonyMOUS: false,
-        deniedpermissions: [
-            {
-                identity: 'foo',
-                identityType: 'VirtualGroup',
-            },
-        ],
-        allowedPERMISSIONS: [
-            {
-                identity: 'Sample_group',
-                identityType: 'Group',
-            },
-            {
-                identity: 'bjones@example.com',
-                identityType: 'user',
-            },
-        ],
-    };
-    beforeEach(() => {
-        documentBuilder = new __1.DocumentBuilder('https://foo.com', 'Some Document');
-    });
-    it('should not marhsal empty permssion when is empty array', () => {
-        const caseInsensitiveDoc = new caseInsensitiveDocument_1.CaseInsensitiveDocument({
-            permissions: [],
-        });
-        (0, parsePermissions_1.processPermissionList)(caseInsensitiveDoc, documentBuilder, dummyPath);
-        expect(documentBuilder.marshal()).not.toHaveProperty('permissions');
-    });
-    it('should marhsal denied permssion set', () => {
-        const caseInsensitiveDoc = new caseInsensitiveDocument_1.CaseInsensitiveDocument({
-            permissions: [publicPermissionsSet],
-        });
-        (0, parsePermissions_1.processPermissionList)(caseInsensitiveDoc, documentBuilder, dummyPath);
-        expect(documentBuilder.marshal().permissions).toMatchSnapshot();
-    });
-    it('should marhsal allowed permssion set', () => {
-        const caseInsensitiveDoc = new caseInsensitiveDocument_1.CaseInsensitiveDocument({
-            permissions: [restrictedPermissionSet],
-        });
-        (0, parsePermissions_1.processPermissionList)(caseInsensitiveDoc, documentBuilder, dummyPath);
-        expect(documentBuilder.marshal().permissions).toMatchSnapshot();
-    });
-    it('should marhsal combined permssion sets', () => {
-        const caseInsensitiveDoc = new caseInsensitiveDocument_1.CaseInsensitiveDocument({
-            permissions: [
-                publicPermissionsSet,
-                restrictedPermissionSet,
-                complexPermissionSet,
-            ],
-        });
-        (0, parsePermissions_1.processPermissionList)(caseInsensitiveDoc, documentBuilder, dummyPath);
-        expect(documentBuilder.marshal().permissions).toMatchSnapshot();
-    });
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+const __1 = require("..");
+const caseInsensitiveDocument_1 = require("./caseInsensitiveDocument");
+const parsePermissions_1 = require("./parsePermissions");
+describe('parsePermissions', () => {
+    let documentBuilder;
+    const dummyPath = (0, path_1.join)('dummy', 'path');
+    const publicPermissionsSet = {
+        allowAnonymous: true,
+        deniedpermissions: [
+            {
+                identity: 'foo@example.com',
+                identityType: 'USER',
+            },
+        ],
+    };
+    const restrictedPermissionSet = {
+        allowAnonymous: false,
+        ALLOWEDPERMISSIONS: [
+            {
+                identity: 'asmith@example.com',
+                identityType: 'User',
+            },
+            {
+                identity: 'bjones@example.com',
+                identityType: 'USER',
+            },
+        ],
+    };
+    const complexPermissionSet = {
+        aLLowAnonyMOUS: false,
+        deniedpermissions: [
+            {
+                identity: 'foo',
+                identityType: 'VirtualGroup',
+            },
+        ],
+        allowedPERMISSIONS: [
+            {
+                identity: 'Sample_group',
+                identityType: 'Group',
+            },
+            {
+                identity: 'bjones@example.com',
+                identityType: 'user',
+            },
+        ],
+    };
+    beforeEach(() => {
+        documentBuilder = new __1.DocumentBuilder('https://foo.com', 'Some Document');
+    });
+    it('should not marhsal empty permssion when is empty array', () => {
+        const caseInsensitiveDoc = new caseInsensitiveDocument_1.CaseInsensitiveDocument({
+            permissions: [],
+        });
+        (0, parsePermissions_1.processPermissionList)(caseInsensitiveDoc, documentBuilder, dummyPath);
+        expect(documentBuilder.marshal()).not.toHaveProperty('permissions');
+    });
+    it('should marhsal denied permssion set', () => {
+        const caseInsensitiveDoc = new caseInsensitiveDocument_1.CaseInsensitiveDocument({
+            permissions: [publicPermissionsSet],
+        });
+        (0, parsePermissions_1.processPermissionList)(caseInsensitiveDoc, documentBuilder, dummyPath);
+        expect(documentBuilder.marshal().permissions).toMatchSnapshot();
+    });
+    it('should marhsal allowed permssion set', () => {
+        const caseInsensitiveDoc = new caseInsensitiveDocument_1.CaseInsensitiveDocument({
+            permissions: [restrictedPermissionSet],
+        });
+        (0, parsePermissions_1.processPermissionList)(caseInsensitiveDoc, documentBuilder, dummyPath);
+        expect(documentBuilder.marshal().permissions).toMatchSnapshot();
+    });
+    it('should marhsal combined permssion sets', () => {
+        const caseInsensitiveDoc = new caseInsensitiveDocument_1.CaseInsensitiveDocument({
+            permissions: [
+                publicPermissionsSet,
+                restrictedPermissionSet,
+                complexPermissionSet,
+            ],
+        });
+        (0, parsePermissions_1.processPermissionList)(caseInsensitiveDoc, documentBuilder, dummyPath);
+        expect(documentBuilder.marshal().permissions).toMatchSnapshot();
+    });
+});
 //# sourceMappingURL=parsePermissions.spec.js.map

package/dist/validation/preconditions/apiKeyPrivilege.js

@@ -1,21 +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);
-}
+"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.spec.js

@@ -1,67 +1,67 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-jest.mock('@coveo/platform-client');
-const platform_client_1 = require("@coveo/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 }) => {
-            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/);
-        });
-    });
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+jest.mock('@coveo/platform-client');
+const platform_client_1 = require("@coveo/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 }) => {
+            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