@coveo/push-api-client 3.0.117 → 3.0.122

package/dist/index.js

@@ -1,39 +1,39 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-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.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 push_1 = require("./source/push");
-Object.defineProperty(exports, "PushSource", { enumerable: true, get: function () { return push_1.PushSource; } });
-var catalog_1 = require("./source/catalog");
-Object.defineProperty(exports, "CatalogSource", { enumerable: true, get: function () { return catalog_1.CatalogSource; } });
-var fieldAnalyser_1 = require("./fieldAnalyser/fieldAnalyser");
-Object.defineProperty(exports, "FieldAnalyser", { enumerable: true, get: function () { return fieldAnalyser_1.FieldAnalyser; } });
-var documentBuilder_1 = require("./documentBuilder");
-Object.defineProperty(exports, "DocumentBuilder", { enumerable: true, get: function () { return documentBuilder_1.DocumentBuilder; } });
-__exportStar(require("./securityIdentityBuilder"), exports);
-var environment_1 = require("./environment");
-Object.defineProperty(exports, "PlatformEnvironment", { enumerable: true, get: function () { return environment_1.PlatformEnvironment; } });
-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; } });
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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.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 push_1 = require("./source/push");
+Object.defineProperty(exports, "PushSource", { enumerable: true, get: function () { return push_1.PushSource; } });
+var catalog_1 = require("./source/catalog");
+Object.defineProperty(exports, "CatalogSource", { enumerable: true, get: function () { return catalog_1.CatalogSource; } });
+var fieldAnalyser_1 = require("./fieldAnalyser/fieldAnalyser");
+Object.defineProperty(exports, "FieldAnalyser", { enumerable: true, get: function () { return fieldAnalyser_1.FieldAnalyser; } });
+var documentBuilder_1 = require("./documentBuilder");
+Object.defineProperty(exports, "DocumentBuilder", { enumerable: true, get: function () { return documentBuilder_1.DocumentBuilder; } });
+__exportStar(require("./securityIdentityBuilder"), exports);
+var environment_1 = require("./environment");
+Object.defineProperty(exports, "PlatformEnvironment", { enumerable: true, get: function () { return environment_1.PlatformEnvironment; } });
+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/interfaces.js

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

package/dist/localtest.js

@@ -1,56 +1,56 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-// eslint-disable-next-line node/no-unpublished-import
-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')
-        .withData('the content of the document')
-        .withMetadataValue('foo', 'bar')
-        .withDate('2000/01/01')
-        .withFileExtension('.html')
-        .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');
-    console.log('STATUS DELETE', resultDelete.status);
-    const yesterday = new Date();
-    yesterday.setDate(new Date().getDate() - 1);
-    const resultDeleteOlderThan = await source.deleteDocumentsOlderThan(SOURCE_ID, yesterday);
-    console.log('STATUS DELETE OLDER THAN', resultDeleteOlderThan.status);
-    const batch = {
-        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}`).withPermissionSet(permissionSet));
-        }
-        else {
-            batch.delete.push({ documentId: docID, deleteChildren: true });
-        }
-    }
-    const batchResult = await source.batchUpdateDocuments(SOURCE_ID, batch);
-    console.log('STATUS BATCH', batchResult.status);
-    await source.setSourceStatus(SOURCE_ID, 'IDLE');
-}
-main();
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// eslint-disable-next-line node/no-unpublished-import
+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')
+        .withData('the content of the document')
+        .withMetadataValue('foo', 'bar')
+        .withDate('2000/01/01')
+        .withFileExtension('.html')
+        .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');
+    console.log('STATUS DELETE', resultDelete.status);
+    const yesterday = new Date();
+    yesterday.setDate(new Date().getDate() - 1);
+    const resultDeleteOlderThan = await source.deleteDocumentsOlderThan(SOURCE_ID, yesterday);
+    console.log('STATUS DELETE OLDER THAN', resultDeleteOlderThan.status);
+    const batch = {
+        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}`).withPermissionSet(permissionSet));
+        }
+        else {
+            batch.delete.push({ documentId: docID, deleteChildren: true });
+        }
+    }
+    const batchResult = await source.batchUpdateDocuments(SOURCE_ID, batch);
+    console.log('STATUS BATCH', batchResult.status);
+    await source.setSourceStatus(SOURCE_ID, 'IDLE');
+}
+main();
 //# sourceMappingURL=localtest.js.map

package/dist/permissionSetBuilder.js

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

@@ -1,69 +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();
-    });
-});
+"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