@coveo/push-api-client 3.0.122 → 3.0.124

package/dist/source/documentUploader.js

@@ -1,46 +1,46 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.uploadBatchFromFile = exports.uploadBatch = exports.uploadDocument = void 0;
-const __1 = require("..");
-const fieldUtils_1 = require("../fieldAnalyser/fieldUtils");
-const function_1 = require("../help/function");
-const transformer_1 = require("../validation/transformers/transformer");
-const batchUploadDocumentsFromFile_1 = require("./batchUploadDocumentsFromFile");
-const defaultBatchOptions = {
-    createFields: true,
-};
-const defaultBatchFromFileOptions = Object.assign(Object.assign({}, defaultBatchOptions), { fieldNameTransformer: transformer_1.BuiltInTransformers.identity, maxConcurrent: 10, callback: function_1.noop });
-async function uploadDocument(platformClient, docBuilder, addURL, api, options) {
-    const { createFields } = Object.assign(Object.assign({}, defaultBatchFromFileOptions), options);
-    if (createFields) {
-        const analyser = new __1.FieldAnalyser(platformClient);
-        await analyser.add([docBuilder]);
-        const report = analyser.report();
-        await (0, fieldUtils_1.createFieldsFromReport)(platformClient, report);
-    }
-    const doc = docBuilder.build();
-    addURL.searchParams.append('documentId', doc.uri);
-    return api.put(addURL.toString(), docBuilder.marshal(), false);
-}
-exports.uploadDocument = uploadDocument;
-async function uploadBatch(platformClient, strategy, batch, options) {
-    var _a, _b;
-    const { createFields } = Object.assign(Object.assign({}, defaultBatchOptions), options);
-    if (createFields) {
-        const analyser = new __1.FieldAnalyser(platformClient);
-        await analyser.add(batch.addOrUpdate);
-        const report = analyser.report();
-        await (0, fieldUtils_1.createFieldsFromReport)(platformClient, report);
-    }
-    await ((_a = strategy.preUpload) === null || _a === void 0 ? void 0 : _a.call(strategy));
-    const res = await strategy.upload(batch);
-    await ((_b = strategy.postUpload) === null || _b === void 0 ? void 0 : _b.call(strategy));
-    return res;
-}
-exports.uploadBatch = uploadBatch;
-function uploadBatchFromFile(platformClient, strategy, filesOrDirectories, options) {
-    const opts = Object.assign(Object.assign({}, defaultBatchFromFileOptions), options);
-    return new batchUploadDocumentsFromFile_1.BatchUploadDocumentsFromFilesReturn(platformClient, strategy, filesOrDirectories, opts);
-}
-exports.uploadBatchFromFile = uploadBatchFromFile;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uploadBatchFromFile = exports.uploadBatch = exports.uploadDocument = void 0;
+const __1 = require("..");
+const fieldUtils_1 = require("../fieldAnalyser/fieldUtils");
+const function_1 = require("../help/function");
+const transformer_1 = require("../validation/transformers/transformer");
+const batchUploadDocumentsFromFile_1 = require("./batchUploadDocumentsFromFile");
+const defaultBatchOptions = {
+    createFields: true,
+};
+const defaultBatchFromFileOptions = Object.assign(Object.assign({}, defaultBatchOptions), { fieldNameTransformer: transformer_1.BuiltInTransformers.identity, maxConcurrent: 10, callback: function_1.noop });
+async function uploadDocument(platformClient, docBuilder, addURL, api, options) {
+    const { createFields } = Object.assign(Object.assign({}, defaultBatchFromFileOptions), options);
+    if (createFields) {
+        const analyser = new __1.FieldAnalyser(platformClient);
+        await analyser.add([docBuilder]);
+        const report = analyser.report();
+        await (0, fieldUtils_1.createFieldsFromReport)(platformClient, report);
+    }
+    const doc = docBuilder.build();
+    addURL.searchParams.append('documentId', doc.uri);
+    return api.put(addURL.toString(), docBuilder.marshal(), false);
+}
+exports.uploadDocument = uploadDocument;
+async function uploadBatch(platformClient, strategy, batch, options) {
+    var _a, _b;
+    const { createFields } = Object.assign(Object.assign({}, defaultBatchOptions), options);
+    if (createFields) {
+        const analyser = new __1.FieldAnalyser(platformClient);
+        await analyser.add(batch.addOrUpdate);
+        const report = analyser.report();
+        await (0, fieldUtils_1.createFieldsFromReport)(platformClient, report);
+    }
+    await ((_a = strategy.preUpload) === null || _a === void 0 ? void 0 : _a.call(strategy));
+    const res = await strategy.upload(batch);
+    await ((_b = strategy.postUpload) === null || _b === void 0 ? void 0 : _b.call(strategy));
+    return res;
+}
+exports.uploadBatch = uploadBatch;
+function uploadBatchFromFile(platformClient, strategy, filesOrDirectories, options) {
+    const opts = Object.assign(Object.assign({}, defaultBatchFromFileOptions), options);
+    return new batchUploadDocumentsFromFile_1.BatchUploadDocumentsFromFilesReturn(platformClient, strategy, filesOrDirectories, opts);
+}
+exports.uploadBatchFromFile = uploadBatchFromFile;
 //# sourceMappingURL=documentUploader.js.map

package/dist/source/documentUploader.spec.js

@@ -1,119 +1,119 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-jest.mock('../fieldAnalyser/fieldAnalyser');
-jest.mock('../fieldAnalyser/fieldUtils');
-jest.mock('../APICore');
-jest.mock('./batchUploadDocumentsFromFile');
-const platform_client_1 = require("@coveo/platform-client");
-const __1 = require("..");
-const APICore_1 = require("../APICore");
-const fieldAnalyser_1 = require("../fieldAnalyser/fieldAnalyser");
-const fieldUtils_1 = require("../fieldAnalyser/fieldUtils");
-const function_1 = require("../help/function");
-const batchUploadDocumentsFromFile_1 = require("./batchUploadDocumentsFromFile");
-const transformer_1 = require("../validation/transformers/transformer");
-const documentUploader_1 = require("./documentUploader");
-const dummyClient = new platform_client_1.default({ accessToken: 'my_token' });
-const dummyAPI = new APICore_1.APICore('my_token');
-const dummyStrategy = {
-    upload: jest.fn(),
-    preUpload: jest.fn(),
-    postUpload: jest.fn(),
-};
-describe('documentUploader', () => {
-    describe('#uploadDocument', () => {
-        const upload = (options) => (0, documentUploader_1.uploadDocument)(dummyClient, new __1.DocumentBuilder('http://some.url', 'Some document'), new URL('https://fake.upload.url'), dummyAPI, options);
-        it('should get field report from FieldAnalyser', async () => {
-            await upload({ createFields: true });
-            expect(fieldAnalyser_1.FieldAnalyser.prototype.report).toHaveBeenCalled();
-        });
-        it('should create missing fields from report', async () => {
-            await upload({ createFields: true });
-            expect(fieldUtils_1.createFieldsFromReport).toHaveBeenCalled();
-        });
-        it('should not create missing fields', async () => {
-            await upload({ createFields: false });
-            expect(fieldUtils_1.createFieldsFromReport).not.toHaveBeenCalled();
-        });
-        it('should upload document', async () => {
-            await upload();
-            expect(APICore_1.APICore.prototype.put).toBeCalledWith('https://fake.upload.url/?documentId=http%3A%2F%2Fsome.url', expect.objectContaining({
-                documentId: 'http://some.url',
-                title: 'Some document',
-            }), false);
-        });
-    });
-    describe('#uploadBatch', () => {
-        const batch = {
-            addOrUpdate: [new __1.DocumentBuilder('http://some.url', 'Some document')],
-            delete: [{ documentId: 'foo_bar', deleteChildren: true }],
-        };
-        const upload = (options) => (0, documentUploader_1.uploadBatch)(dummyClient, dummyStrategy, batch, options);
-        it('should get field report from FieldAnalyser', async () => {
-            await upload({ createFields: true });
-            expect(fieldAnalyser_1.FieldAnalyser.prototype.report).toHaveBeenCalled();
-        });
-        it('should create missing fields from report', async () => {
-            await upload({ createFields: true });
-            expect(fieldUtils_1.createFieldsFromReport).toHaveBeenCalled();
-        });
-        it('should not create missing fields', async () => {
-            await upload({ createFields: false });
-            expect(fieldUtils_1.createFieldsFromReport).not.toHaveBeenCalled();
-        });
-        it('should execute the pre-upload strategy logic', async () => {
-            await upload();
-            expect(dummyStrategy.preUpload).toHaveBeenCalled();
-        });
-        it('should execute the upload strategy logic', async () => {
-            await upload();
-            expect(dummyStrategy.upload).toHaveBeenCalledWith({
-                addOrUpdate: [
-                    expect.objectContaining({
-                        uri: 'http://some.url',
-                    }),
-                ],
-                delete: [
-                    {
-                        deleteChildren: true,
-                        documentId: 'foo_bar',
-                    },
-                ],
-            });
-        });
-        it('should execute the post-upload strategy logic', async () => {
-            await upload();
-            expect(dummyStrategy.postUpload).toHaveBeenCalled();
-        });
-    });
-    describe('#uploadBatchFromFile', () => {
-        const dummyCallback = jest.fn();
-        it('should call BatchUploadDocumentsFromFilesReturn with default options', () => {
-            (0, documentUploader_1.uploadBatchFromFile)(dummyClient, dummyStrategy, [
-                'path/to/file',
-                'other/path',
-            ]);
-            expect(batchUploadDocumentsFromFile_1.BatchUploadDocumentsFromFilesReturn).toHaveBeenCalledWith(dummyClient, dummyStrategy, ['path/to/file', 'other/path'], {
-                callback: function_1.noop,
-                createFields: true,
-                fieldNameTransformer: transformer_1.BuiltInTransformers.identity,
-                maxConcurrent: 10,
-            });
-        });
-        it('should call BatchUploadDocumentsFromFilesReturn with custom options', () => {
-            (0, documentUploader_1.uploadBatchFromFile)(dummyClient, dummyStrategy, ['path/to/file', 'other/path'], {
-                createFields: false,
-                maxConcurrent: 3,
-                fieldNameTransformer: transformer_1.BuiltInTransformers.toLowerCase,
-                callback: dummyCallback,
-            });
-            expect(batchUploadDocumentsFromFile_1.BatchUploadDocumentsFromFilesReturn).toHaveBeenCalledWith(dummyClient, dummyStrategy, ['path/to/file', 'other/path'], {
-                callback: dummyCallback,
-                createFields: false,
-                fieldNameTransformer: transformer_1.BuiltInTransformers.toLowerCase,
-                maxConcurrent: 3,
-            });
-        });
-    });
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+jest.mock('../fieldAnalyser/fieldAnalyser');
+jest.mock('../fieldAnalyser/fieldUtils');
+jest.mock('../APICore');
+jest.mock('./batchUploadDocumentsFromFile');
+const platform_client_1 = require("@coveo/platform-client");
+const __1 = require("..");
+const APICore_1 = require("../APICore");
+const fieldAnalyser_1 = require("../fieldAnalyser/fieldAnalyser");
+const fieldUtils_1 = require("../fieldAnalyser/fieldUtils");
+const function_1 = require("../help/function");
+const batchUploadDocumentsFromFile_1 = require("./batchUploadDocumentsFromFile");
+const transformer_1 = require("../validation/transformers/transformer");
+const documentUploader_1 = require("./documentUploader");
+const dummyClient = new platform_client_1.default({ accessToken: 'my_token' });
+const dummyAPI = new APICore_1.APICore('my_token');
+const dummyStrategy = {
+    upload: jest.fn(),
+    preUpload: jest.fn(),
+    postUpload: jest.fn(),
+};
+describe('documentUploader', () => {
+    describe('#uploadDocument', () => {
+        const upload = (options) => (0, documentUploader_1.uploadDocument)(dummyClient, new __1.DocumentBuilder('http://some.url', 'Some document'), new URL('https://fake.upload.url'), dummyAPI, options);
+        it('should get field report from FieldAnalyser', async () => {
+            await upload({ createFields: true });
+            expect(fieldAnalyser_1.FieldAnalyser.prototype.report).toHaveBeenCalled();
+        });
+        it('should create missing fields from report', async () => {
+            await upload({ createFields: true });
+            expect(fieldUtils_1.createFieldsFromReport).toHaveBeenCalled();
+        });
+        it('should not create missing fields', async () => {
+            await upload({ createFields: false });
+            expect(fieldUtils_1.createFieldsFromReport).not.toHaveBeenCalled();
+        });
+        it('should upload document', async () => {
+            await upload();
+            expect(APICore_1.APICore.prototype.put).toBeCalledWith('https://fake.upload.url/?documentId=http%3A%2F%2Fsome.url', expect.objectContaining({
+                documentId: 'http://some.url',
+                title: 'Some document',
+            }), false);
+        });
+    });
+    describe('#uploadBatch', () => {
+        const batch = {
+            addOrUpdate: [new __1.DocumentBuilder('http://some.url', 'Some document')],
+            delete: [{ documentId: 'foo_bar', deleteChildren: true }],
+        };
+        const upload = (options) => (0, documentUploader_1.uploadBatch)(dummyClient, dummyStrategy, batch, options);
+        it('should get field report from FieldAnalyser', async () => {
+            await upload({ createFields: true });
+            expect(fieldAnalyser_1.FieldAnalyser.prototype.report).toHaveBeenCalled();
+        });
+        it('should create missing fields from report', async () => {
+            await upload({ createFields: true });
+            expect(fieldUtils_1.createFieldsFromReport).toHaveBeenCalled();
+        });
+        it('should not create missing fields', async () => {
+            await upload({ createFields: false });
+            expect(fieldUtils_1.createFieldsFromReport).not.toHaveBeenCalled();
+        });
+        it('should execute the pre-upload strategy logic', async () => {
+            await upload();
+            expect(dummyStrategy.preUpload).toHaveBeenCalled();
+        });
+        it('should execute the upload strategy logic', async () => {
+            await upload();
+            expect(dummyStrategy.upload).toHaveBeenCalledWith({
+                addOrUpdate: [
+                    expect.objectContaining({
+                        uri: 'http://some.url',
+                    }),
+                ],
+                delete: [
+                    {
+                        deleteChildren: true,
+                        documentId: 'foo_bar',
+                    },
+                ],
+            });
+        });
+        it('should execute the post-upload strategy logic', async () => {
+            await upload();
+            expect(dummyStrategy.postUpload).toHaveBeenCalled();
+        });
+    });
+    describe('#uploadBatchFromFile', () => {
+        const dummyCallback = jest.fn();
+        it('should call BatchUploadDocumentsFromFilesReturn with default options', () => {
+            (0, documentUploader_1.uploadBatchFromFile)(dummyClient, dummyStrategy, [
+                'path/to/file',
+                'other/path',
+            ]);
+            expect(batchUploadDocumentsFromFile_1.BatchUploadDocumentsFromFilesReturn).toHaveBeenCalledWith(dummyClient, dummyStrategy, ['path/to/file', 'other/path'], {
+                callback: function_1.noop,
+                createFields: true,
+                fieldNameTransformer: transformer_1.BuiltInTransformers.identity,
+                maxConcurrent: 10,
+            });
+        });
+        it('should call BatchUploadDocumentsFromFilesReturn with custom options', () => {
+            (0, documentUploader_1.uploadBatchFromFile)(dummyClient, dummyStrategy, ['path/to/file', 'other/path'], {
+                createFields: false,
+                maxConcurrent: 3,
+                fieldNameTransformer: transformer_1.BuiltInTransformers.toLowerCase,
+                callback: dummyCallback,
+            });
+            expect(batchUploadDocumentsFromFile_1.BatchUploadDocumentsFromFilesReturn).toHaveBeenCalledWith(dummyClient, dummyStrategy, ['path/to/file', 'other/path'], {
+                callback: dummyCallback,
+                createFields: false,
+                fieldNameTransformer: transformer_1.BuiltInTransformers.toLowerCase,
+                maxConcurrent: 3,
+            });
+        });
+    });
+});
 //# sourceMappingURL=documentUploader.spec.js.map

package/dist/source/push.js

@@ -1,141 +1,141 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PushSource = exports.SourceVisibility = void 0;
-require("fetch-undici-polyfill");
-const platform_client_1 = require("@coveo/platform-client");
-var platform_client_2 = require("@coveo/platform-client");
-Object.defineProperty(exports, "SourceVisibility", { enumerable: true, get: function () { return platform_client_2.SourceVisibility; } });
-const dayjs = require("dayjs");
-const url_1 = require("url");
-const environment_1 = require("../environment");
-const securityIdenty_1 = require("./securityIdenty");
-const documentUploader_1 = require("./documentUploader");
-const urlUtils_1 = require("../help/urlUtils");
-const uploadStrategy_1 = require("../uploadStrategy");
-const fieldUtils_1 = require("../fieldAnalyser/fieldUtils");
-const APICore_1 = require("../APICore");
-/**
- * Manage a push source.
- *
- * Allows you to create a new push source, manage security identities and documents in a Coveo organization.
- */
-class PushSource {
-    /**
-     *
-     * @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(apikey, organizationid, options) {
-        this.apikey = apikey;
-        this.organizationid = organizationid;
-        this.api = new APICore_1.APICore(this.apikey);
-        this.options = Object.assign(Object.assign({}, PushSource.defaultOptions), options);
-        this.platformClient = new platform_client_1.PlatformClient({
-            accessToken: this.apikey,
-            environment: (0, environment_1.castEnvironmentToPlatformClient)(this.options.environment),
-            organizationId: this.organizationid,
-            region: this.options.region,
-        });
-    }
-    /**
-     * Create a new push source
-     * @param name The name of the source to create.
-     * @param sourceVisibility The security option that should be applied to the content of the source. See [Content Security](https://docs.coveo.com/en/1779).
-     * @returns
-     */
-    create(name, sourceVisibility) {
-        return this.platformClient.source.create({
-            sourceType: platform_client_1.SourceType.PUSH,
-            pushEnabled: true,
-            name,
-            sourceVisibility,
-        });
-    }
-    get identity() {
-        return new securityIdenty_1.SecurityIdentity(this.platformClient);
-    }
-    /**
-     * Adds or updates an individual item in a push source. See [Adding a Single Item in a Push Source](https://docs.coveo.com/en/133).
-     * @param sourceID
-     * @param docBuilder
-     * @param {BatchUpdateDocumentsOptions}
-     * @returns
-     */
-    addOrUpdateDocument(sourceID, docBuilder, options) {
-        const addURL = new url_1.URL(`${this.urlBuilder(sourceID).baseURL}/documents`);
-        return (0, documentUploader_1.uploadDocument)(this.platformClient, docBuilder, addURL, this.api, options);
-    }
-    /**
-     * Manage batches of items in a push source. See [Manage Batches of Items in a Push Source](https://docs.coveo.com/en/90)
-     * @param sourceID
-     * @param batch
-     * @returns
-     */
-    batchUpdateDocuments(sourceID, batch, options) {
-        return (0, documentUploader_1.uploadBatch)(this.platformClient, this.fileContainerStrategy(sourceID), batch, options);
-    }
-    /**
-     *
-     * Manage batches of items in a push source from a list of JSON files. See [Manage Batches of Items in a Push Source](https://docs.coveo.com/en/90)
-     * @param {string} sourceID The unique identifier of the target Push source
-     * @param {string[]} filesOrDirectories A list of JSON files or directories (containing JSON files) from which to extract documents.
-     * @param {UploadBatchCallback} callback Callback executed when a batch of documents is either successfully uploaded or when an error occurs during the upload
-     * @param {BatchUpdateDocumentsFromFiles} options
-     */
-    batchUpdateDocumentsFromFiles(sourceID, filesOrDirectories, options) {
-        return (0, documentUploader_1.uploadBatchFromFile)(this.platformClient, this.fileContainerStrategy(sourceID), filesOrDirectories, options);
-    }
-    /**
-     * Deletes a specific item from a Push source. Optionally, the child items of that item can also be deleted. See [Deleting an Item in a Push Source](https://docs.coveo.com/en/171).
-     * @param sourceID
-     * @param documentId
-     * @param deleteChildren
-     * @returns
-     */
-    deleteDocument(sourceID, documentId, deleteChildren = false) {
-        const deleteURL = new url_1.URL(`${this.urlBuilder(sourceID).baseURL}/documents`);
-        deleteURL.searchParams.append('documentId', documentId);
-        deleteURL.searchParams.append('deleteChildren', `${deleteChildren}`);
-        return this.api.delete(deleteURL.toString(), false);
-    }
-    /**
-     * Deletes all items whose last update was made by a Push API operation whose orderingId is strictly lower than a specified value. See [Deleting Old Items in a Push Source](https://docs.coveo.com/en/131).
-     * @param sourceID
-     * @param olderThan
-     * @returns
-     */
-    deleteDocumentsOlderThan(sourceID, olderThan) {
-        const date = dayjs(olderThan);
-        const deleteURL = new url_1.URL(`${this.urlBuilder(sourceID).baseURL}/documents/olderthan`);
-        deleteURL.searchParams.append('orderingId', `${date.valueOf()}`);
-        return this.api.delete(deleteURL.toString(), false);
-    }
-    /**
-     * Set the status of a push source. See [Updating the Status of a Push Source](https://docs.coveo.com/en/35/)
-     * @param sourceID
-     * @param status
-     * @returns {Promise<void>}
-     */
-    async setSourceStatus(sourceID, status) {
-        const urlStatus = new url_1.URL(`${this.urlBuilder(sourceID).baseURL}/status`);
-        urlStatus.searchParams.append('statusType', status);
-        await this.api.post(urlStatus.toString());
-    }
-    async createFields(analyser) {
-        const report = analyser.report();
-        await (0, fieldUtils_1.createFieldsFromReport)(this.platformClient, report);
-    }
-    urlBuilder(sourceId) {
-        return new urlUtils_1.PushUrlBuilder(sourceId, this.organizationid, this.options);
-    }
-    fileContainerStrategy(sourceId) {
-        const urlBuilder = this.urlBuilder(sourceId);
-        return new uploadStrategy_1.FileContainerStrategy(urlBuilder, this.api);
-    }
-}
-exports.PushSource = PushSource;
-PushSource.defaultOptions = {
-    region: environment_1.DEFAULT_REGION,
-    environment: environment_1.DEFAULT_ENVIRONMENT,
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PushSource = exports.SourceVisibility = void 0;
+require("fetch-undici-polyfill");
+const platform_client_1 = require("@coveo/platform-client");
+var platform_client_2 = require("@coveo/platform-client");
+Object.defineProperty(exports, "SourceVisibility", { enumerable: true, get: function () { return platform_client_2.SourceVisibility; } });
+const dayjs = require("dayjs");
+const url_1 = require("url");
+const environment_1 = require("../environment");
+const securityIdenty_1 = require("./securityIdenty");
+const documentUploader_1 = require("./documentUploader");
+const urlUtils_1 = require("../help/urlUtils");
+const uploadStrategy_1 = require("../uploadStrategy");
+const fieldUtils_1 = require("../fieldAnalyser/fieldUtils");
+const APICore_1 = require("../APICore");
+/**
+ * Manage a push source.
+ *
+ * Allows you to create a new push source, manage security identities and documents in a Coveo organization.
+ */
+class PushSource {
+    /**
+     *
+     * @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(apikey, organizationid, options) {
+        this.apikey = apikey;
+        this.organizationid = organizationid;
+        this.api = new APICore_1.APICore(this.apikey);
+        this.options = Object.assign(Object.assign({}, PushSource.defaultOptions), options);
+        this.platformClient = new platform_client_1.PlatformClient({
+            accessToken: this.apikey,
+            environment: (0, environment_1.castEnvironmentToPlatformClient)(this.options.environment),
+            organizationId: this.organizationid,
+            region: this.options.region,
+        });
+    }
+    /**
+     * Create a new push source
+     * @param name The name of the source to create.
+     * @param sourceVisibility The security option that should be applied to the content of the source. See [Content Security](https://docs.coveo.com/en/1779).
+     * @returns
+     */
+    create(name, sourceVisibility) {
+        return this.platformClient.source.create({
+            sourceType: platform_client_1.SourceType.PUSH,
+            pushEnabled: true,
+            name,
+            sourceVisibility,
+        });
+    }
+    get identity() {
+        return new securityIdenty_1.SecurityIdentity(this.platformClient);
+    }
+    /**
+     * Adds or updates an individual item in a push source. See [Adding a Single Item in a Push Source](https://docs.coveo.com/en/133).
+     * @param sourceID
+     * @param docBuilder
+     * @param {BatchUpdateDocumentsOptions}
+     * @returns
+     */
+    addOrUpdateDocument(sourceID, docBuilder, options) {
+        const addURL = new url_1.URL(`${this.urlBuilder(sourceID).baseURL}/documents`);
+        return (0, documentUploader_1.uploadDocument)(this.platformClient, docBuilder, addURL, this.api, options);
+    }
+    /**
+     * Manage batches of items in a push source. See [Manage Batches of Items in a Push Source](https://docs.coveo.com/en/90)
+     * @param sourceID
+     * @param batch
+     * @returns
+     */
+    batchUpdateDocuments(sourceID, batch, options) {
+        return (0, documentUploader_1.uploadBatch)(this.platformClient, this.fileContainerStrategy(sourceID), batch, options);
+    }
+    /**
+     *
+     * Manage batches of items in a push source from a list of JSON files. See [Manage Batches of Items in a Push Source](https://docs.coveo.com/en/90)
+     * @param {string} sourceID The unique identifier of the target Push source
+     * @param {string[]} filesOrDirectories A list of JSON files or directories (containing JSON files) from which to extract documents.
+     * @param {UploadBatchCallback} callback Callback executed when a batch of documents is either successfully uploaded or when an error occurs during the upload
+     * @param {BatchUpdateDocumentsFromFiles} options
+     */
+    batchUpdateDocumentsFromFiles(sourceID, filesOrDirectories, options) {
+        return (0, documentUploader_1.uploadBatchFromFile)(this.platformClient, this.fileContainerStrategy(sourceID), filesOrDirectories, options);
+    }
+    /**
+     * Deletes a specific item from a Push source. Optionally, the child items of that item can also be deleted. See [Deleting an Item in a Push Source](https://docs.coveo.com/en/171).
+     * @param sourceID
+     * @param documentId
+     * @param deleteChildren
+     * @returns
+     */
+    deleteDocument(sourceID, documentId, deleteChildren = false) {
+        const deleteURL = new url_1.URL(`${this.urlBuilder(sourceID).baseURL}/documents`);
+        deleteURL.searchParams.append('documentId', documentId);
+        deleteURL.searchParams.append('deleteChildren', `${deleteChildren}`);
+        return this.api.delete(deleteURL.toString(), false);
+    }
+    /**
+     * Deletes all items whose last update was made by a Push API operation whose orderingId is strictly lower than a specified value. See [Deleting Old Items in a Push Source](https://docs.coveo.com/en/131).
+     * @param sourceID
+     * @param olderThan
+     * @returns
+     */
+    deleteDocumentsOlderThan(sourceID, olderThan) {
+        const date = dayjs(olderThan);
+        const deleteURL = new url_1.URL(`${this.urlBuilder(sourceID).baseURL}/documents/olderthan`);
+        deleteURL.searchParams.append('orderingId', `${date.valueOf()}`);
+        return this.api.delete(deleteURL.toString(), false);
+    }
+    /**
+     * Set the status of a push source. See [Updating the Status of a Push Source](https://docs.coveo.com/en/35/)
+     * @param sourceID
+     * @param status
+     * @returns {Promise<void>}
+     */
+    async setSourceStatus(sourceID, status) {
+        const urlStatus = new url_1.URL(`${this.urlBuilder(sourceID).baseURL}/status`);
+        urlStatus.searchParams.append('statusType', status);
+        await this.api.post(urlStatus.toString());
+    }
+    async createFields(analyser) {
+        const report = analyser.report();
+        await (0, fieldUtils_1.createFieldsFromReport)(this.platformClient, report);
+    }
+    urlBuilder(sourceId) {
+        return new urlUtils_1.PushUrlBuilder(sourceId, this.organizationid, this.options);
+    }
+    fileContainerStrategy(sourceId) {
+        const urlBuilder = this.urlBuilder(sourceId);
+        return new uploadStrategy_1.FileContainerStrategy(urlBuilder, this.api);
+    }
+}
+exports.PushSource = PushSource;
+PushSource.defaultOptions = {
+    region: environment_1.DEFAULT_REGION,
+    environment: environment_1.DEFAULT_ENVIRONMENT,
+};
 //# sourceMappingURL=push.js.map