@coveo/push-api-client 3.0.122 → 3.0.124

package/dist/source/push.spec.js

@@ -1,153 +1,153 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable node/no-unpublished-import */
-jest.mock('@coveo/platform-client');
-jest.mock('./documentUploader');
-jest.mock('../uploadStrategy');
-jest.mock('../APICore');
-const platform_client_1 = require("@coveo/platform-client");
-const push_1 = require("./push");
-const documentBuilder_1 = require("../documentBuilder");
-const path_1 = require("path");
-const process_1 = require("process");
-const __1 = require("..");
-const APICore_1 = require("../APICore");
-const documentUploader_1 = require("./documentUploader");
-const uploadStrategy_1 = require("../uploadStrategy");
-const urlUtils_1 = require("../help/urlUtils");
-const mockedAPICore = jest.mocked(APICore_1.APICore);
-const mockedDelete = jest.fn();
-const mockedPost = jest.fn();
-const mockedPlatformClient = jest.mocked(platform_client_1.default);
-const mockCreateSource = jest.fn();
-const mockedUploadDocument = jest.mocked(documentUploader_1.uploadDocument);
-const mockedUploadBatch = jest.mocked(documentUploader_1.uploadBatch);
-const mockedUploadBatchFromFile = jest.mocked(documentUploader_1.uploadBatchFromFile);
-const pathToStub = (0, path_1.join)((0, process_1.cwd)(), 'src', '__stub__');
-const dummyClient = {
-    source: {
-        create: mockCreateSource,
-    },
-};
-const dummyAPICore = {
-    delete: mockedDelete,
-    post: mockedPost,
-};
-const doMockPlatformClient = () => {
-    mockedPlatformClient.mockImplementation(() => dummyClient);
-};
-const doMockAPICore = () => {
-    mockedAPICore.mockImplementation(() => dummyAPICore);
-};
-describe('PushSource', () => {
-    let defaultSource;
-    beforeAll(() => {
-        doMockAPICore();
-        doMockPlatformClient();
-    });
-    beforeEach(() => {
-        defaultSource = new push_1.PushSource('the_key', 'the_org');
-    });
-    it('should call platform client on creation', () => {
-        defaultSource.create('the_name', platform_client_1.SourceVisibility.SHARED);
-        expect(mockCreateSource).toHaveBeenCalledWith({
-            name: 'the_name',
-            pushEnabled: true,
-            sourceType: 'PUSH',
-            sourceVisibility: 'SHARED',
-        });
-    });
-    it.each([
-        {
-            title: 'default region/environment',
-            expectedUrl: 'https://api.cloud.coveo.com/push/v1/organizations/the_org/sources/the_id/documents',
-        },
-        {
-            title: 'non default region',
-            options: {
-                region: __1.Region.AU,
-            },
-            expectedUrl: 'https://api-au.cloud.coveo.com/push/v1/organizations/the_org/sources/the_id/documents',
-        },
-        {
-            title: 'non default environment',
-            options: {
-                environment: __1.PlatformEnvironment.Dev,
-            },
-            expectedUrl: 'https://apidev.cloud.coveo.com/push/v1/organizations/the_org/sources/the_id/documents',
-        },
-        {
-            title: 'non default region/environment',
-            options: {
-                environment: __1.PlatformEnvironment.Stg,
-                region: __1.Region.EU,
-            },
-            expectedUrl: 'https://apistg-eu.cloud.coveo.com/push/v1/organizations/the_org/sources/the_id/documents',
-        },
-    ])('should call #uploadDocument with $title', async ({ options, expectedUrl }) => {
-        await new push_1.PushSource('the_key', 'the_org', options).addOrUpdateDocument('the_id', new documentBuilder_1.DocumentBuilder('the_uri', 'the_title'));
-        expect(mockedUploadDocument).toHaveBeenCalledWith(dummyClient, new documentBuilder_1.DocumentBuilder('the_uri', 'the_title'), new URL(expectedUrl), dummyAPICore, undefined);
-    });
-    it('should call #uploadDocument with right BatchUpdateDocumentsOptions', async () => {
-        await defaultSource.addOrUpdateDocument('the_id', new documentBuilder_1.DocumentBuilder('the_uri', 'the_title'), { createFields: true });
-        expect(mockedUploadDocument).toHaveBeenCalledWith(dummyClient, new documentBuilder_1.DocumentBuilder('the_uri', 'the_title'), new URL('https://api.cloud.coveo.com/push/v1/organizations/the_org/sources/the_id/documents'), dummyAPICore, { createFields: true });
-    });
-    it('should call #APICore on delete', () => {
-        defaultSource.deleteDocument('the_id', 'the_uri', true);
-        expect(mockedDelete).toHaveBeenCalledWith('https://api.cloud.coveo.com/push/v1/organizations/the_org/sources/the_id/documents?documentId=the_uri&deleteChildren=true', false);
-    });
-    it('should call #APICore on status update', () => {
-        defaultSource.setSourceStatus('the_id', 'INCREMENTAL');
-        expect(mockedPost).toHaveBeenCalledWith('https://api.cloud.coveo.com/push/v1/organizations/the_org/sources/the_id/status?statusType=INCREMENTAL');
-    });
-    describe('calls #APICore when doing delete olderthan', () => {
-        const expectCorrectOrderingId = (id) => {
-            expect(mockedDelete).toHaveBeenCalledWith(`https://api.cloud.coveo.com/push/v1/organizations/the_org/sources/the_id/documents/olderthan?orderingId=${id}`, false);
-        };
-        it('with a date', () => {
-            const now = new Date();
-            defaultSource.deleteDocumentsOlderThan('the_id', now);
-            expectCorrectOrderingId(now.valueOf());
-        });
-        it('with a date string', () => {
-            defaultSource.deleteDocumentsOlderThan('the_id', '2001/01/01');
-            expectCorrectOrderingId(new Date('2001/01/01').valueOf());
-        });
-        it('with a timestamp', () => {
-            const nowInTimestamp = new Date().valueOf();
-            defaultSource.deleteDocumentsOlderThan('the_id', nowInTimestamp);
-            expectCorrectOrderingId(nowInTimestamp);
-        });
-    });
-    it('should call #APICore on delete', () => {
-        defaultSource.deleteDocument('the_id', 'the_uri', true);
-        expect(mockedDelete).toHaveBeenCalledWith('https://api.cloud.coveo.com/push/v1/organizations/the_org/sources/the_id/documents?documentId=the_uri&deleteChildren=true', false);
-    });
-    describe('when doing batch update', () => {
-        const batch = {
-            addOrUpdate: [
-                new documentBuilder_1.DocumentBuilder('the_uri_1', 'the_title_1'),
-                new documentBuilder_1.DocumentBuilder('the_uri_2', 'the_title_2'),
-            ],
-            delete: [{ documentId: 'the_uri_3', deleteChildren: true }],
-        };
-        it('should call #uploadBatch', async () => {
-            await defaultSource.batchUpdateDocuments('the_id', batch, {
-                createFields: false,
-            });
-            expect(mockedUploadBatch).toHaveBeenCalledWith(dummyClient, expect.any(uploadStrategy_1.FileContainerStrategy), batch, { createFields: false });
-        });
-        it('should call #uploadBatch with the right strategy', async () => {
-            await defaultSource.batchUpdateDocuments('the_id', batch);
-            expect(uploadStrategy_1.FileContainerStrategy).toHaveBeenCalledWith(expect.any(urlUtils_1.PushUrlBuilder), dummyAPICore);
-        });
-    });
-    describe('when doing batch update from local files', () => {
-        it('should call #uploadBatchFromFile', async () => {
-            await defaultSource.batchUpdateDocumentsFromFiles('the_id', [(0, path_1.join)(pathToStub, 'mixdocuments')], { createFields: false });
-            expect(uploadStrategy_1.FileContainerStrategy).toHaveBeenCalledWith(expect.any(urlUtils_1.PushUrlBuilder), dummyAPICore);
-            expect(mockedUploadBatchFromFile).toHaveBeenCalledWith(dummyClient, expect.any(uploadStrategy_1.FileContainerStrategy), [(0, path_1.join)(pathToStub, 'mixdocuments')], { createFields: false });
-        });
-    });
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable node/no-unpublished-import */
+jest.mock('@coveo/platform-client');
+jest.mock('./documentUploader');
+jest.mock('../uploadStrategy');
+jest.mock('../APICore');
+const platform_client_1 = require("@coveo/platform-client");
+const push_1 = require("./push");
+const documentBuilder_1 = require("../documentBuilder");
+const path_1 = require("path");
+const process_1 = require("process");
+const __1 = require("..");
+const APICore_1 = require("../APICore");
+const documentUploader_1 = require("./documentUploader");
+const uploadStrategy_1 = require("../uploadStrategy");
+const urlUtils_1 = require("../help/urlUtils");
+const mockedAPICore = jest.mocked(APICore_1.APICore);
+const mockedDelete = jest.fn();
+const mockedPost = jest.fn();
+const mockedPlatformClient = jest.mocked(platform_client_1.default);
+const mockCreateSource = jest.fn();
+const mockedUploadDocument = jest.mocked(documentUploader_1.uploadDocument);
+const mockedUploadBatch = jest.mocked(documentUploader_1.uploadBatch);
+const mockedUploadBatchFromFile = jest.mocked(documentUploader_1.uploadBatchFromFile);
+const pathToStub = (0, path_1.join)((0, process_1.cwd)(), 'src', '__stub__');
+const dummyClient = {
+    source: {
+        create: mockCreateSource,
+    },
+};
+const dummyAPICore = {
+    delete: mockedDelete,
+    post: mockedPost,
+};
+const doMockPlatformClient = () => {
+    mockedPlatformClient.mockImplementation(() => dummyClient);
+};
+const doMockAPICore = () => {
+    mockedAPICore.mockImplementation(() => dummyAPICore);
+};
+describe('PushSource', () => {
+    let defaultSource;
+    beforeAll(() => {
+        doMockAPICore();
+        doMockPlatformClient();
+    });
+    beforeEach(() => {
+        defaultSource = new push_1.PushSource('the_key', 'the_org');
+    });
+    it('should call platform client on creation', () => {
+        defaultSource.create('the_name', platform_client_1.SourceVisibility.SHARED);
+        expect(mockCreateSource).toHaveBeenCalledWith({
+            name: 'the_name',
+            pushEnabled: true,
+            sourceType: 'PUSH',
+            sourceVisibility: 'SHARED',
+        });
+    });
+    it.each([
+        {
+            title: 'default region/environment',
+            expectedUrl: 'https://api.cloud.coveo.com/push/v1/organizations/the_org/sources/the_id/documents',
+        },
+        {
+            title: 'non default region',
+            options: {
+                region: __1.Region.AU,
+            },
+            expectedUrl: 'https://api-au.cloud.coveo.com/push/v1/organizations/the_org/sources/the_id/documents',
+        },
+        {
+            title: 'non default environment',
+            options: {
+                environment: __1.PlatformEnvironment.Dev,
+            },
+            expectedUrl: 'https://apidev.cloud.coveo.com/push/v1/organizations/the_org/sources/the_id/documents',
+        },
+        {
+            title: 'non default region/environment',
+            options: {
+                environment: __1.PlatformEnvironment.Stg,
+                region: __1.Region.EU,
+            },
+            expectedUrl: 'https://apistg-eu.cloud.coveo.com/push/v1/organizations/the_org/sources/the_id/documents',
+        },
+    ])('should call #uploadDocument with $title', async ({ options, expectedUrl }) => {
+        await new push_1.PushSource('the_key', 'the_org', options).addOrUpdateDocument('the_id', new documentBuilder_1.DocumentBuilder('the_uri', 'the_title'));
+        expect(mockedUploadDocument).toHaveBeenCalledWith(dummyClient, new documentBuilder_1.DocumentBuilder('the_uri', 'the_title'), new URL(expectedUrl), dummyAPICore, undefined);
+    });
+    it('should call #uploadDocument with right BatchUpdateDocumentsOptions', async () => {
+        await defaultSource.addOrUpdateDocument('the_id', new documentBuilder_1.DocumentBuilder('the_uri', 'the_title'), { createFields: true });
+        expect(mockedUploadDocument).toHaveBeenCalledWith(dummyClient, new documentBuilder_1.DocumentBuilder('the_uri', 'the_title'), new URL('https://api.cloud.coveo.com/push/v1/organizations/the_org/sources/the_id/documents'), dummyAPICore, { createFields: true });
+    });
+    it('should call #APICore on delete', () => {
+        defaultSource.deleteDocument('the_id', 'the_uri', true);
+        expect(mockedDelete).toHaveBeenCalledWith('https://api.cloud.coveo.com/push/v1/organizations/the_org/sources/the_id/documents?documentId=the_uri&deleteChildren=true', false);
+    });
+    it('should call #APICore on status update', () => {
+        defaultSource.setSourceStatus('the_id', 'INCREMENTAL');
+        expect(mockedPost).toHaveBeenCalledWith('https://api.cloud.coveo.com/push/v1/organizations/the_org/sources/the_id/status?statusType=INCREMENTAL');
+    });
+    describe('calls #APICore when doing delete olderthan', () => {
+        const expectCorrectOrderingId = (id) => {
+            expect(mockedDelete).toHaveBeenCalledWith(`https://api.cloud.coveo.com/push/v1/organizations/the_org/sources/the_id/documents/olderthan?orderingId=${id}`, false);
+        };
+        it('with a date', () => {
+            const now = new Date();
+            defaultSource.deleteDocumentsOlderThan('the_id', now);
+            expectCorrectOrderingId(now.valueOf());
+        });
+        it('with a date string', () => {
+            defaultSource.deleteDocumentsOlderThan('the_id', '2001/01/01');
+            expectCorrectOrderingId(new Date('2001/01/01').valueOf());
+        });
+        it('with a timestamp', () => {
+            const nowInTimestamp = new Date().valueOf();
+            defaultSource.deleteDocumentsOlderThan('the_id', nowInTimestamp);
+            expectCorrectOrderingId(nowInTimestamp);
+        });
+    });
+    it('should call #APICore on delete', () => {
+        defaultSource.deleteDocument('the_id', 'the_uri', true);
+        expect(mockedDelete).toHaveBeenCalledWith('https://api.cloud.coveo.com/push/v1/organizations/the_org/sources/the_id/documents?documentId=the_uri&deleteChildren=true', false);
+    });
+    describe('when doing batch update', () => {
+        const batch = {
+            addOrUpdate: [
+                new documentBuilder_1.DocumentBuilder('the_uri_1', 'the_title_1'),
+                new documentBuilder_1.DocumentBuilder('the_uri_2', 'the_title_2'),
+            ],
+            delete: [{ documentId: 'the_uri_3', deleteChildren: true }],
+        };
+        it('should call #uploadBatch', async () => {
+            await defaultSource.batchUpdateDocuments('the_id', batch, {
+                createFields: false,
+            });
+            expect(mockedUploadBatch).toHaveBeenCalledWith(dummyClient, expect.any(uploadStrategy_1.FileContainerStrategy), batch, { createFields: false });
+        });
+        it('should call #uploadBatch with the right strategy', async () => {
+            await defaultSource.batchUpdateDocuments('the_id', batch);
+            expect(uploadStrategy_1.FileContainerStrategy).toHaveBeenCalledWith(expect.any(urlUtils_1.PushUrlBuilder), dummyAPICore);
+        });
+    });
+    describe('when doing batch update from local files', () => {
+        it('should call #uploadBatchFromFile', async () => {
+            await defaultSource.batchUpdateDocumentsFromFiles('the_id', [(0, path_1.join)(pathToStub, 'mixdocuments')], { createFields: false });
+            expect(uploadStrategy_1.FileContainerStrategy).toHaveBeenCalledWith(expect.any(urlUtils_1.PushUrlBuilder), dummyAPICore);
+            expect(mockedUploadBatchFromFile).toHaveBeenCalledWith(dummyClient, expect.any(uploadStrategy_1.FileContainerStrategy), [(0, path_1.join)(pathToStub, 'mixdocuments')], { createFields: false });
+        });
+    });
+});
 //# sourceMappingURL=push.spec.js.map

package/dist/source/securityIdenty.js

@@ -1,58 +1,58 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SecurityIdentity = void 0;
-require("fetch-undici-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;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SecurityIdentity = void 0;
+require("fetch-undici-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/uploadStrategy/fileContainerStrategy.js

@@ -1,33 +1,33 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileContainerStrategy = void 0;
-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, api) {
-        this.urlBuilder = urlBuilder;
-        this.api = api;
-    }
-    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 this.api.post(fileContainerURL);
-        return res;
-    }
-    pushFileContainerContent(fileContainer) {
-        const pushURL = this.urlBuilder.baseAPIURLForUpdate;
-        pushURL.searchParams.append('fileId', fileContainer.fileId);
-        return this.api.put(pushURL.toString(), undefined, false);
-    }
-}
-exports.FileContainerStrategy = FileContainerStrategy;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileContainerStrategy = void 0;
+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, api) {
+        this.urlBuilder = urlBuilder;
+        this.api = api;
+    }
+    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 this.api.post(fileContainerURL);
+        return res;
+    }
+    pushFileContainerContent(fileContainer) {
+        const pushURL = this.urlBuilder.baseAPIURLForUpdate;
+        pushURL.searchParams.append('fileId', fileContainer.fileId);
+        return this.api.put(pushURL.toString(), undefined, false);
+    }
+}
+exports.FileContainerStrategy = FileContainerStrategy;
 //# sourceMappingURL=fileContainerStrategy.js.map