@coveo/push-api-client 3.0.117 → 3.0.122

package/dist/securityIdentityBuilder.js

@@ -1,129 +1,129 @@
-"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 PermissionIdentityType}.
- *
- * Instead of using this class directly, use one of:
- * - {@link UserSecurityIdentityBuilder}
- * - {@link GroupSecurityIdentityBuilder}
- * - {@link VirtualGroupSecurityIdentityBuilder}
- */
-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 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 = Object.assign({ identityType,
-            identity }, (securityProvider && { securityProvider }));
-    }
-    /**
-     * Build and return the security identity.
-     * @returns
-     */
-    build() {
-        return this.securityIdentity;
-    }
-}
-exports.AnySecurityIdentityBuilder = AnySecurityIdentityBuilder;
-/**
- * Build a security identity of type `USER`.
- *
- * Typically used in conjunction with {@link PermissionSetBuilder.withAllowedPermissions} or {@link PermissionSetBuilder.withDeniedPermissions}.
- *
- * See {@link Permission}.
- */
-class UserSecurityIdentityBuilder {
-    /**
-     * Pass either a single user, or an array of user to create multiple identities.
-     * @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;
-        this.securityProvider = securityProvider;
-    }
-    /**
-     * Build and return the security identity or identities.
-     * @returns
-     */
-    build() {
-        if (Array.isArray(this.user)) {
-            return this.user.map((u) => new AnySecurityIdentityBuilder(platform_client_1.PermissionIdentityType.User, u, 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 PermissionSetBuilder.withAllowedPermissions} or {@link PermissionSetBuilder.withDeniedPermissions}.
- *
- * See {@link Permission}.
- */
-class GroupSecurityIdentityBuilder {
-    /**
-     * Pass either a single `group`, or an array of `group` to create multiple identities.
-     * @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;
-        this.securityProvider = securityProvider;
-    }
-    /**
-     * Build and return the security identity or identities.
-     * @returns
-     */
-    build() {
-        if (Array.isArray(this.group)) {
-            return this.group.map((g) => new AnySecurityIdentityBuilder(platform_client_1.PermissionIdentityType.Group, g, 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 PermissionSetBuilder.withAllowedPermissions} or {@link PermissionSetBuilder.withDeniedPermissions}.
- *
- * See {@link Permission}.
- */
-class VirtualGroupSecurityIdentityBuilder {
-    /**
-     * Pass either a single `virtualGroup`, or an array of `virtualGroup` to create multiple identities.
-     * @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;
-        this.securityProvider = securityProvider;
-    }
-    /**
-     * Build and return the security identity or identities.
-     * @returns
-     */
-    build() {
-        if (Array.isArray(this.virtualGroup)) {
-            return this.virtualGroup.map((vg) => new AnySecurityIdentityBuilder(platform_client_1.PermissionIdentityType.VirtualGroup, vg, this.securityProvider).build());
-        }
-        return new AnySecurityIdentityBuilder(platform_client_1.PermissionIdentityType.VirtualGroup, this.virtualGroup, this.securityProvider).build();
-    }
-}
-exports.VirtualGroupSecurityIdentityBuilder = VirtualGroupSecurityIdentityBuilder;
+"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 PermissionIdentityType}.
+ *
+ * Instead of using this class directly, use one of:
+ * - {@link UserSecurityIdentityBuilder}
+ * - {@link GroupSecurityIdentityBuilder}
+ * - {@link VirtualGroupSecurityIdentityBuilder}
+ */
+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 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 = Object.assign({ identityType,
+            identity }, (securityProvider && { securityProvider }));
+    }
+    /**
+     * Build and return the security identity.
+     * @returns
+     */
+    build() {
+        return this.securityIdentity;
+    }
+}
+exports.AnySecurityIdentityBuilder = AnySecurityIdentityBuilder;
+/**
+ * Build a security identity of type `USER`.
+ *
+ * Typically used in conjunction with {@link PermissionSetBuilder.withAllowedPermissions} or {@link PermissionSetBuilder.withDeniedPermissions}.
+ *
+ * See {@link Permission}.
+ */
+class UserSecurityIdentityBuilder {
+    /**
+     * Pass either a single user, or an array of user to create multiple identities.
+     * @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;
+        this.securityProvider = securityProvider;
+    }
+    /**
+     * Build and return the security identity or identities.
+     * @returns
+     */
+    build() {
+        if (Array.isArray(this.user)) {
+            return this.user.map((u) => new AnySecurityIdentityBuilder(platform_client_1.PermissionIdentityType.User, u, 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 PermissionSetBuilder.withAllowedPermissions} or {@link PermissionSetBuilder.withDeniedPermissions}.
+ *
+ * See {@link Permission}.
+ */
+class GroupSecurityIdentityBuilder {
+    /**
+     * Pass either a single `group`, or an array of `group` to create multiple identities.
+     * @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;
+        this.securityProvider = securityProvider;
+    }
+    /**
+     * Build and return the security identity or identities.
+     * @returns
+     */
+    build() {
+        if (Array.isArray(this.group)) {
+            return this.group.map((g) => new AnySecurityIdentityBuilder(platform_client_1.PermissionIdentityType.Group, g, 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 PermissionSetBuilder.withAllowedPermissions} or {@link PermissionSetBuilder.withDeniedPermissions}.
+ *
+ * See {@link Permission}.
+ */
+class VirtualGroupSecurityIdentityBuilder {
+    /**
+     * Pass either a single `virtualGroup`, or an array of `virtualGroup` to create multiple identities.
+     * @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;
+        this.securityProvider = securityProvider;
+    }
+    /**
+     * Build and return the security identity or identities.
+     * @returns
+     */
+    build() {
+        if (Array.isArray(this.virtualGroup)) {
+            return this.virtualGroup.map((vg) => new AnySecurityIdentityBuilder(platform_client_1.PermissionIdentityType.VirtualGroup, vg, this.securityProvider).build());
+        }
+        return new AnySecurityIdentityBuilder(platform_client_1.PermissionIdentityType.VirtualGroup, this.virtualGroup, this.securityProvider).build();
+    }
+}
+exports.VirtualGroupSecurityIdentityBuilder = VirtualGroupSecurityIdentityBuilder;
 //# sourceMappingURL=securityIdentityBuilder.js.map

package/dist/securityIdentityBuilder.spec.js

@@ -1,51 +1,51 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const platform_client_1 = require("@coveo/platform-client");
-const securityIdentityBuilder_1 = require("./securityIdentityBuilder");
-describe('SecurityIdentityBuilder', () => {
-    describe('when instanciating a UserSecurityIdentityBuilder', () => {
-        it('should not include undefined securityProvider', () => {
-            const identity = new securityIdentityBuilder_1.UserSecurityIdentityBuilder('foo@example.com');
-            expect(identity.build()).toEqual({
-                identity: 'foo@example.com',
-                identityType: platform_client_1.PermissionIdentityType.User,
-                securityProvider: 'Email Security Provider',
-            });
-        });
-        it('should not use provided securityProvider', () => {
-            const identity = new securityIdentityBuilder_1.UserSecurityIdentityBuilder('foo@example.com', 'provider12345');
-            expect(identity.build()).toEqual({
-                identity: 'foo@example.com',
-                identityType: platform_client_1.PermissionIdentityType.User,
-                securityProvider: 'provider12345',
-            });
-        });
-    });
-    describe.each([
-        {
-            identityBuilderClass: securityIdentityBuilder_1.GroupSecurityIdentityBuilder,
-            identityType: platform_client_1.PermissionIdentityType.Group,
-        },
-        {
-            identityBuilderClass: securityIdentityBuilder_1.VirtualGroupSecurityIdentityBuilder,
-            identityType: platform_client_1.PermissionIdentityType.VirtualGroup,
-        },
-    ])('when instanciating a $identityBuilderClass.name', ({ identityBuilderClass, identityType }) => {
-        it('should not include undefined securityProvider', () => {
-            const identity = new identityBuilderClass('SampleTeam');
-            expect(identity.build()).toEqual({
-                identity: 'SampleTeam',
-                identityType,
-            });
-        });
-        it('should include securityProvider in the identity', () => {
-            const identity = new identityBuilderClass('SampleTeam', 'provider123456');
-            expect(identity.build()).toEqual({
-                identity: 'SampleTeam',
-                identityType,
-                securityProvider: 'provider123456',
-            });
-        });
-    });
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const platform_client_1 = require("@coveo/platform-client");
+const securityIdentityBuilder_1 = require("./securityIdentityBuilder");
+describe('SecurityIdentityBuilder', () => {
+    describe('when instanciating a UserSecurityIdentityBuilder', () => {
+        it('should not include undefined securityProvider', () => {
+            const identity = new securityIdentityBuilder_1.UserSecurityIdentityBuilder('foo@example.com');
+            expect(identity.build()).toEqual({
+                identity: 'foo@example.com',
+                identityType: platform_client_1.PermissionIdentityType.User,
+                securityProvider: 'Email Security Provider',
+            });
+        });
+        it('should not use provided securityProvider', () => {
+            const identity = new securityIdentityBuilder_1.UserSecurityIdentityBuilder('foo@example.com', 'provider12345');
+            expect(identity.build()).toEqual({
+                identity: 'foo@example.com',
+                identityType: platform_client_1.PermissionIdentityType.User,
+                securityProvider: 'provider12345',
+            });
+        });
+    });
+    describe.each([
+        {
+            identityBuilderClass: securityIdentityBuilder_1.GroupSecurityIdentityBuilder,
+            identityType: platform_client_1.PermissionIdentityType.Group,
+        },
+        {
+            identityBuilderClass: securityIdentityBuilder_1.VirtualGroupSecurityIdentityBuilder,
+            identityType: platform_client_1.PermissionIdentityType.VirtualGroup,
+        },
+    ])('when instanciating a $identityBuilderClass.name', ({ identityBuilderClass, identityType }) => {
+        it('should not include undefined securityProvider', () => {
+            const identity = new identityBuilderClass('SampleTeam');
+            expect(identity.build()).toEqual({
+                identity: 'SampleTeam',
+                identityType,
+            });
+        });
+        it('should include securityProvider in the identity', () => {
+            const identity = new identityBuilderClass('SampleTeam', 'provider123456');
+            expect(identity.build()).toEqual({
+                identity: 'SampleTeam',
+                identityType,
+                securityProvider: 'provider123456',
+            });
+        });
+    });
+});
 //# sourceMappingURL=securityIdentityBuilder.spec.js.map

package/dist/source/batchUploadDocumentsFromFile.js

@@ -1,47 +1,47 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BatchUploadDocumentsFromFilesReturn = void 0;
-const fieldUtils_1 = require("../fieldAnalyser/fieldUtils");
-const file_1 = require("../help/file");
-const fileConsumer_1 = require("../help/fileConsumer");
-const index_1 = require("../index");
-const parseFile_1 = require("../validation/parseFile");
-class BatchUploadDocumentsFromFilesReturn {
-    constructor(platformClient, strategy, filesOrDirectories, options) {
-        this.consumer = new fileConsumer_1.FileConsumer((batch) => strategy.upload(batch), options);
-        this.internalPromise = (async () => {
-            var _a, _b;
-            let expectedDocumentCount = 0;
-            const files = (0, file_1.getAllJsonFilesFromEntries)(filesOrDirectories);
-            await ((_a = strategy.preUpload) === null || _a === void 0 ? void 0 : _a.call(strategy));
-            const analyser = new index_1.FieldAnalyser(platformClient);
-            for (const filePath of files.values()) {
-                const docBuilders = await (0, parseFile_1.parseAndGetDocumentBuilderFromJSONDocument)(filePath, options);
-                expectedDocumentCount += docBuilders.length;
-                if (options.createFields) {
-                    await analyser.add(docBuilders);
-                }
-            }
-            if (options.createFields) {
-                const report = analyser.report();
-                await (0, fieldUtils_1.createFieldsFromReport)(platformClient, report);
-            }
-            this.consumer.expectedDocumentCount = expectedDocumentCount;
-            await this.consumer.consume(files, options);
-            await ((_b = strategy.postUpload) === null || _b === void 0 ? void 0 : _b.call(strategy));
-        }).bind(this);
-    }
-    onBatchUpload(cb) {
-        this.consumer.onSuccess(cb);
-        return this;
-    }
-    onBatchError(cb) {
-        this.consumer.onError(cb);
-        return this;
-    }
-    batch() {
-        return this.internalPromise();
-    }
-}
-exports.BatchUploadDocumentsFromFilesReturn = BatchUploadDocumentsFromFilesReturn;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BatchUploadDocumentsFromFilesReturn = void 0;
+const fieldUtils_1 = require("../fieldAnalyser/fieldUtils");
+const file_1 = require("../help/file");
+const fileConsumer_1 = require("../help/fileConsumer");
+const index_1 = require("../index");
+const parseFile_1 = require("../validation/parseFile");
+class BatchUploadDocumentsFromFilesReturn {
+    constructor(platformClient, strategy, filesOrDirectories, options) {
+        this.consumer = new fileConsumer_1.FileConsumer((batch) => strategy.upload(batch), options);
+        this.internalPromise = (async () => {
+            var _a, _b;
+            let expectedDocumentCount = 0;
+            const files = (0, file_1.getAllJsonFilesFromEntries)(filesOrDirectories);
+            await ((_a = strategy.preUpload) === null || _a === void 0 ? void 0 : _a.call(strategy));
+            const analyser = new index_1.FieldAnalyser(platformClient);
+            for (const filePath of files.values()) {
+                const docBuilders = await (0, parseFile_1.parseAndGetDocumentBuilderFromJSONDocument)(filePath, options);
+                expectedDocumentCount += docBuilders.length;
+                if (options.createFields) {
+                    await analyser.add(docBuilders);
+                }
+            }
+            if (options.createFields) {
+                const report = analyser.report();
+                await (0, fieldUtils_1.createFieldsFromReport)(platformClient, report);
+            }
+            this.consumer.expectedDocumentCount = expectedDocumentCount;
+            await this.consumer.consume(files, options);
+            await ((_b = strategy.postUpload) === null || _b === void 0 ? void 0 : _b.call(strategy));
+        }).bind(this);
+    }
+    onBatchUpload(cb) {
+        this.consumer.onSuccess(cb);
+        return this;
+    }
+    onBatchError(cb) {
+        this.consumer.onError(cb);
+        return this;
+    }
+    batch() {
+        return this.internalPromise();
+    }
+}
+exports.BatchUploadDocumentsFromFilesReturn = BatchUploadDocumentsFromFilesReturn;
 //# sourceMappingURL=batchUploadDocumentsFromFile.js.map