@coveo/push-api-client 3.0.116 → 3.0.122

package/dist/errors/privilegeError.js

@@ -1,13 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PrivilegeError = void 0;
-const baseError_1 = require("./baseError");
-class PrivilegeError extends baseError_1.PushApiClientBaseError {
-    constructor(message) {
-        super(message);
-        this.message = message;
-        this.name = 'Privilege Error';
-    }
-}
-exports.PrivilegeError = PrivilegeError;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PrivilegeError = void 0;
+const baseError_1 = require("./baseError");
+class PrivilegeError extends baseError_1.PushApiClientBaseError {
+    constructor(message) {
+        super(message);
+        this.message = message;
+        this.name = 'Privilege Error';
+    }
+}
+exports.PrivilegeError = PrivilegeError;
 //# sourceMappingURL=privilegeError.js.map

package/dist/errors/validatorErrors.js

@@ -1,41 +1,41 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnsupportedAttribute = exports.InvalidDocument = exports.NotAJsonFileError = exports.NotAFileError = void 0;
-const baseError_1 = require("./baseError");
-class NotAFileError extends baseError_1.PushApiClientBaseError {
-    constructor(p) {
-        super(`${p} is not a valid file, or does not exists.`);
-        this.name = 'Not A File Error';
-    }
-}
-exports.NotAFileError = NotAFileError;
-class NotAJsonFileError extends baseError_1.PushApiClientBaseError {
-    constructor(p) {
-        super(`${p} is not a valid JSON file.`);
-        this.name = 'Not A JSON File Error';
-    }
-}
-exports.NotAJsonFileError = NotAJsonFileError;
-class InvalidDocument extends baseError_1.PushApiClientBaseError {
-    constructor(p, doc, explanation) {
-        super([
-            `${p} is not a valid JSON: ${explanation}`,
-            'Document in error:',
-            JSON.stringify(doc, null, 2),
-            '',
-            'Helpful links on the expected JSON format:',
-            ' • JSON file example: https://github.com/coveo/push-api-client.js/tree/main/samples/json',
-            ' • Document Body reference: https://docs.coveo.com/en/75#documentbody',
-        ].join('\n'));
-        this.name = 'Invalid JSON Document Error';
-    }
-}
-exports.InvalidDocument = InvalidDocument;
-class UnsupportedAttribute extends baseError_1.PushApiClientBaseError {
-    constructor(p, unsupported) {
-        super(`${p} contains a currently unsupported document attribute: ${unsupported}`);
-        this.name = 'Unsupported Attribute Error';
-    }
-}
-exports.UnsupportedAttribute = UnsupportedAttribute;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnsupportedAttribute = exports.InvalidDocument = exports.NotAJsonFileError = exports.NotAFileError = void 0;
+const baseError_1 = require("./baseError");
+class NotAFileError extends baseError_1.PushApiClientBaseError {
+    constructor(p) {
+        super(`${p} is not a valid file, or does not exists.`);
+        this.name = 'Not A File Error';
+    }
+}
+exports.NotAFileError = NotAFileError;
+class NotAJsonFileError extends baseError_1.PushApiClientBaseError {
+    constructor(p) {
+        super(`${p} is not a valid JSON file.`);
+        this.name = 'Not A JSON File Error';
+    }
+}
+exports.NotAJsonFileError = NotAJsonFileError;
+class InvalidDocument extends baseError_1.PushApiClientBaseError {
+    constructor(p, doc, explanation) {
+        super([
+            `${p} is not a valid JSON: ${explanation}`,
+            'Document in error:',
+            JSON.stringify(doc, null, 2),
+            '',
+            'Helpful links on the expected JSON format:',
+            ' • JSON file example: https://github.com/coveo/push-api-client.js/tree/main/samples/json',
+            ' • Document Body reference: https://docs.coveo.com/en/75#documentbody',
+        ].join('\n'));
+        this.name = 'Invalid JSON Document Error';
+    }
+}
+exports.InvalidDocument = InvalidDocument;
+class UnsupportedAttribute extends baseError_1.PushApiClientBaseError {
+    constructor(p, unsupported) {
+        super(`${p} contains a currently unsupported document attribute: ${unsupported}`);
+        this.name = 'Unsupported Attribute Error';
+    }
+}
+exports.UnsupportedAttribute = UnsupportedAttribute;
 //# sourceMappingURL=validatorErrors.js.map

package/dist/fieldAnalyser/fieldAnalyser.js

@@ -1,96 +1,96 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FieldAnalyser = void 0;
-const platform_client_1 = require("@coveo/platform-client");
-const fieldUtils_1 = require("./fieldUtils");
-const fieldStore_1 = require("./fieldStore");
-const inconsistencies_1 = require("./inconsistencies");
-const fieldErrors_1 = require("../errors/fieldErrors");
-const typeUtils_1 = require("./typeUtils");
-/**
- * Analyse documents to detect type inconsistencies and missing fields in your index.
- *
- */
-class FieldAnalyser {
-    constructor(platformClient) {
-        this.platformClient = platformClient;
-        this.inconsistencies = new inconsistencies_1.Inconsistencies();
-        this.missingFields = new fieldStore_1.FieldStore();
-    }
-    /**
-     * Adds a batch of document builders to the analyser to extract all the missing fields that need to be created in the organization.
-     * This method can be called as many time as needed as it will take into consideration document builders previously added.
-     *
-     * @param {DocumentBuilder[]} batch
-     * @return {*}
-     */
-    async add(batch) {
-        const existingFields = await this.ensureExistingFields();
-        batch.flatMap((doc) => {
-            const documentMetadata = Object.entries(Object.assign({}, doc.build().metadata));
-            for (const [metadataKey, metadataValue] of documentMetadata) {
-                if (existingFields.some((field) => field.name === metadataKey)) {
-                    continue;
-                }
-                this.storeMetadata(metadataKey, metadataValue);
-            }
-        });
-        return this;
-    }
-    /**
-     * Returns the analyser report containing the fields to create as well as the type inconsistencies in the documents
-     *
-     * @return {*}  {FieldAnalyserReport}
-     */
-    report() {
-        this.ensurePermanentId(this.missingFields);
-        this.removeInconsistentFields();
-        return {
-            fields: this.missingFields.marshal(),
-            inconsistencies: this.inconsistencies,
-        };
-    }
-    removeInconsistentFields() {
-        for (const fieldname of this.inconsistencies.keys()) {
-            this.missingFields.delete(fieldname);
-        }
-    }
-    storeMetadata(metadataKey, metadataValue) {
-        const alreadyGuessedType = this.missingFields.get(metadataKey);
-        const firstTypeGuess = (0, typeUtils_1.getGuessedTypeFromValue)(metadataValue);
-        if (!alreadyGuessedType) {
-            this.missingFields.set(metadataKey, firstTypeGuess);
-            return;
-        }
-        const secondTypeGuess = (0, typeUtils_1.getMostEnglobingType)(alreadyGuessedType, firstTypeGuess);
-        if (secondTypeGuess) {
-            this.missingFields.set(metadataKey, secondTypeGuess);
-        }
-        else {
-            this.inconsistencies.add(metadataKey, [
-                alreadyGuessedType,
-                firstTypeGuess,
-            ]);
-        }
-    }
-    async ensureExistingFields() {
-        if (this.existingFields === undefined) {
-            this.existingFields = await (0, fieldUtils_1.listAllFieldsFromOrg)(this.platformClient);
-        }
-        return this.existingFields;
-    }
-    ensurePermanentId(fieldStore) {
-        var _a;
-        const permanentid = (_a = this.existingFields) === null || _a === void 0 ? void 0 : _a.find((field) => field.name === 'permanentid');
-        if (permanentid) {
-            if (permanentid.type !== platform_client_1.FieldTypes.STRING) {
-                throw new fieldErrors_1.InvalidPermanentId(permanentid);
-            }
-        }
-        else {
-            fieldStore.set('permanentid', platform_client_1.FieldTypes.STRING);
-        }
-    }
-}
-exports.FieldAnalyser = FieldAnalyser;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldAnalyser = void 0;
+const platform_client_1 = require("@coveo/platform-client");
+const fieldUtils_1 = require("./fieldUtils");
+const fieldStore_1 = require("./fieldStore");
+const inconsistencies_1 = require("./inconsistencies");
+const fieldErrors_1 = require("../errors/fieldErrors");
+const typeUtils_1 = require("./typeUtils");
+/**
+ * Analyse documents to detect type inconsistencies and missing fields in your index.
+ *
+ */
+class FieldAnalyser {
+    constructor(platformClient) {
+        this.platformClient = platformClient;
+        this.inconsistencies = new inconsistencies_1.Inconsistencies();
+        this.missingFields = new fieldStore_1.FieldStore();
+    }
+    /**
+     * Adds a batch of document builders to the analyser to extract all the missing fields that need to be created in the organization.
+     * This method can be called as many time as needed as it will take into consideration document builders previously added.
+     *
+     * @param {DocumentBuilder[]} batch
+     * @return {*}
+     */
+    async add(batch) {
+        const existingFields = await this.ensureExistingFields();
+        batch.flatMap((doc) => {
+            const documentMetadata = Object.entries(Object.assign({}, doc.build().metadata));
+            for (const [metadataKey, metadataValue] of documentMetadata) {
+                if (existingFields.some((field) => field.name === metadataKey)) {
+                    continue;
+                }
+                this.storeMetadata(metadataKey, metadataValue);
+            }
+        });
+        return this;
+    }
+    /**
+     * Returns the analyser report containing the fields to create as well as the type inconsistencies in the documents
+     *
+     * @return {*}  {FieldAnalyserReport}
+     */
+    report() {
+        this.ensurePermanentId(this.missingFields);
+        this.removeInconsistentFields();
+        return {
+            fields: this.missingFields.marshal(),
+            inconsistencies: this.inconsistencies,
+        };
+    }
+    removeInconsistentFields() {
+        for (const fieldname of this.inconsistencies.keys()) {
+            this.missingFields.delete(fieldname);
+        }
+    }
+    storeMetadata(metadataKey, metadataValue) {
+        const alreadyGuessedType = this.missingFields.get(metadataKey);
+        const firstTypeGuess = (0, typeUtils_1.getGuessedTypeFromValue)(metadataValue);
+        if (!alreadyGuessedType) {
+            this.missingFields.set(metadataKey, firstTypeGuess);
+            return;
+        }
+        const secondTypeGuess = (0, typeUtils_1.getMostEnglobingType)(alreadyGuessedType, firstTypeGuess);
+        if (secondTypeGuess) {
+            this.missingFields.set(metadataKey, secondTypeGuess);
+        }
+        else {
+            this.inconsistencies.add(metadataKey, [
+                alreadyGuessedType,
+                firstTypeGuess,
+            ]);
+        }
+    }
+    async ensureExistingFields() {
+        if (this.existingFields === undefined) {
+            this.existingFields = await (0, fieldUtils_1.listAllFieldsFromOrg)(this.platformClient);
+        }
+        return this.existingFields;
+    }
+    ensurePermanentId(fieldStore) {
+        var _a;
+        const permanentid = (_a = this.existingFields) === null || _a === void 0 ? void 0 : _a.find((field) => field.name === 'permanentid');
+        if (permanentid) {
+            if (permanentid.type !== platform_client_1.FieldTypes.STRING) {
+                throw new fieldErrors_1.InvalidPermanentId(permanentid);
+            }
+        }
+        else {
+            fieldStore.set('permanentid', platform_client_1.FieldTypes.STRING);
+        }
+    }
+}
+exports.FieldAnalyser = FieldAnalyser;
 //# sourceMappingURL=fieldAnalyser.js.map