@coveo/push-api-client 3.0.117 → 3.0.122

package/dist/validation/preconditions/platformPrivilege.js

@@ -1,35 +1,35 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeFieldsPrivilege = exports.readFieldsPrivilege = void 0;
-exports.readFieldsPrivilege = {
-    models: [
-        {
-            type: 'VIEW',
-            targetDomain: 'FIELD',
-            targetId: '*',
-            owner: 'PLATFORM',
-        },
-    ],
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeFieldsPrivilege = exports.readFieldsPrivilege = void 0;
+exports.readFieldsPrivilege = {
+    models: [
+        {
+            type: 'VIEW',
+            targetDomain: 'FIELD',
+            targetId: '*',
+            owner: 'PLATFORM',
+        },
+    ],
     unsatisfiedConditionMessage: `Your API key doesn't have the privilege to view fields and their configuration. Make sure to grant this privilege to your API key before running the command again.
-  See https://docs.coveo.com/en/1707#fields-domain`,
-};
-exports.writeFieldsPrivilege = {
-    models: [
-        ...exports.readFieldsPrivilege.models,
-        {
-            type: 'CREATE',
-            targetDomain: 'FIELD',
-            targetId: '*',
-            owner: 'PLATFORM',
-        },
-        {
-            type: 'EDIT',
-            targetDomain: 'FIELD',
-            targetId: '*',
-            owner: 'PLATFORM',
-        },
-    ],
+  See https://docs.coveo.com/en/1707#fields-domain`,
+};
+exports.writeFieldsPrivilege = {
+    models: [
+        ...exports.readFieldsPrivilege.models,
+        {
+            type: 'CREATE',
+            targetDomain: 'FIELD',
+            targetId: '*',
+            owner: 'PLATFORM',
+        },
+        {
+            type: 'EDIT',
+            targetDomain: 'FIELD',
+            targetId: '*',
+            owner: 'PLATFORM',
+        },
+    ],
     unsatisfiedConditionMessage: `Your API key doesn't have the privilege to create or update fields. Make sure to grant this privilege to your API key before running the command again.
-  See https://docs.coveo.com/en/1707#fields-domain`,
-};
+  See https://docs.coveo.com/en/1707#fields-domain`,
+};
 //# sourceMappingURL=platformPrivilege.js.map

package/dist/validation/requiredKeyValidator.js

@@ -1,62 +1,62 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RequiredKeyValidator = void 0;
-class RequiredKeyValidator {
-    constructor(k, doc, schema) {
-        this.doc = doc;
-        this.schema = schema;
-        this.validations = [];
-        if (Array.isArray(k)) {
-            this.keys = k;
-        }
-        else {
-            this.keys = [k];
-        }
-        this.doValidations();
-    }
-    doValidations() {
-        this.validations = this.keys.map((k) => {
-            const value = this.doc.getRecordValue(k);
-            if (this.isValueCorrectType(value)) {
-                return { value, message: null };
-            }
-            return {
-                value: value,
-                message: `Document contains an invalid value for ${k}: ${this.getValidationMessage(value)}`,
-            };
-        });
-    }
-    get isValid() {
-        return this.validEntries.length > 0;
-    }
-    get value() {
-        if (this.isValid) {
-            return this.validEntries[0].value;
-        }
-        return null;
-    }
-    get explanation() {
-        if (this.isValid) {
-            return '';
-        }
-        return this.invalidEntries[0].message;
-    }
-    get validEntries() {
-        return this.validations.filter((validation) => validation.message === null);
-    }
-    get invalidEntries() {
-        return this.validations.filter((validation) => validation.message !== null);
-    }
-    getValidationMessage(value) {
-        return this.schema.validate(value);
-    }
-    isValueCorrectType(value) {
-        const validationMessage = this.getValidationMessage(value);
-        if (validationMessage) {
-            return false;
-        }
-        return true;
-    }
-}
-exports.RequiredKeyValidator = RequiredKeyValidator;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequiredKeyValidator = void 0;
+class RequiredKeyValidator {
+    constructor(k, doc, schema) {
+        this.doc = doc;
+        this.schema = schema;
+        this.validations = [];
+        if (Array.isArray(k)) {
+            this.keys = k;
+        }
+        else {
+            this.keys = [k];
+        }
+        this.doValidations();
+    }
+    doValidations() {
+        this.validations = this.keys.map((k) => {
+            const value = this.doc.getRecordValue(k);
+            if (this.isValueCorrectType(value)) {
+                return { value, message: null };
+            }
+            return {
+                value: value,
+                message: `Document contains an invalid value for ${k}: ${this.getValidationMessage(value)}`,
+            };
+        });
+    }
+    get isValid() {
+        return this.validEntries.length > 0;
+    }
+    get value() {
+        if (this.isValid) {
+            return this.validEntries[0].value;
+        }
+        return null;
+    }
+    get explanation() {
+        if (this.isValid) {
+            return '';
+        }
+        return this.invalidEntries[0].message;
+    }
+    get validEntries() {
+        return this.validations.filter((validation) => validation.message === null);
+    }
+    get invalidEntries() {
+        return this.validations.filter((validation) => validation.message !== null);
+    }
+    getValidationMessage(value) {
+        return this.schema.validate(value);
+    }
+    isValueCorrectType(value) {
+        const validationMessage = this.getValidationMessage(value);
+        if (validationMessage) {
+            return false;
+        }
+        return true;
+    }
+}
+exports.RequiredKeyValidator = RequiredKeyValidator;
 //# sourceMappingURL=requiredKeyValidator.js.map

package/dist/validation/transformers/transformer.js

@@ -1,52 +1,52 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BuiltInTransformers = void 0;
-const toLowerCase = (field) => field
-    .toLowerCase()
-    // Remove non-alpha numeric
-    .replace(/[^a-z0-9]/gi, '')
-    // Remove any leading number
-    .replace(/^[0-9]+/g, '');
-const toSnakeCase = (field) => field
-    .toLowerCase()
-    // Replace non-alpha numeric with underscores
-    .replace(/[^a-z0-9]/gi, '_')
-    // Remove any leading number or underscore
-    .replace(/^[0-9_]+/g, '')
-    // Remove consecutive underscores
-    .replace(/_{2,}/g, '_')
-    // Remove any trailing underscore
-    .replace(/_$/g, '');
-const identity = (field) => field;
-const ThawedBuiltInTransformers = {
-    /**
-     * A transformer that does nothing but return the string supplied to it.
-     * Good as a default transformer function.
-     *
-     * _Transformation examples:_
-     *
-     * - `foo` => `foo`
-     * - `bar` => `bar`
-     */
-    identity,
-    /**
-     * A transformer that removes leading numbers and replaces every non-alphanumeric characters with underscores
-     *
-     * _Transformation examples:_
-     *
-     * - `Field-With=Special+Characters` => `field_with_special_characters`
-     * - `01-Numeric-Field-#01` => `numeric_field_01`
-     */
-    toLowerCase,
-    /**
-     * A transformer that removes leading numbers and non-alphanumeric characters.
-     *
-     * _Transformation examples:_
-     *
-     * - `Field-With=Special+Characters` => `fieldwithspecialcharacters`
-     * - `01-Numeric-Field-#01` => `numericfield01`
-     */
-    toSnakeCase: toSnakeCase,
-};
-exports.BuiltInTransformers = Object.freeze(ThawedBuiltInTransformers);
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BuiltInTransformers = void 0;
+const toLowerCase = (field) => field
+    .toLowerCase()
+    // Remove non-alpha numeric
+    .replace(/[^a-z0-9]/gi, '')
+    // Remove any leading number
+    .replace(/^[0-9]+/g, '');
+const toSnakeCase = (field) => field
+    .toLowerCase()
+    // Replace non-alpha numeric with underscores
+    .replace(/[^a-z0-9]/gi, '_')
+    // Remove any leading number or underscore
+    .replace(/^[0-9_]+/g, '')
+    // Remove consecutive underscores
+    .replace(/_{2,}/g, '_')
+    // Remove any trailing underscore
+    .replace(/_$/g, '');
+const identity = (field) => field;
+const ThawedBuiltInTransformers = {
+    /**
+     * A transformer that does nothing but return the string supplied to it.
+     * Good as a default transformer function.
+     *
+     * _Transformation examples:_
+     *
+     * - `foo` => `foo`
+     * - `bar` => `bar`
+     */
+    identity,
+    /**
+     * A transformer that removes leading numbers and replaces every non-alphanumeric characters with underscores
+     *
+     * _Transformation examples:_
+     *
+     * - `Field-With=Special+Characters` => `field_with_special_characters`
+     * - `01-Numeric-Field-#01` => `numeric_field_01`
+     */
+    toLowerCase,
+    /**
+     * A transformer that removes leading numbers and non-alphanumeric characters.
+     *
+     * _Transformation examples:_
+     *
+     * - `Field-With=Special+Characters` => `fieldwithspecialcharacters`
+     * - `01-Numeric-Field-#01` => `numericfield01`
+     */
+    toSnakeCase: toSnakeCase,
+};
+exports.BuiltInTransformers = Object.freeze(ThawedBuiltInTransformers);
 //# sourceMappingURL=transformer.js.map

package/dist/validation/transformers/transformer.spec.js

@@ -1,22 +1,22 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const transformer_1 = require("./transformer");
-describe('FieldNametransformer', () => {
-    it.each([
-        {
-            transformer: transformer_1.BuiltInTransformers.toLowerCase,
-            expectedKey: 'foo',
-        },
-        {
-            transformer: transformer_1.BuiltInTransformers.toSnakeCase,
-            expectedKey: 'f_o_o',
-        },
-    ])('should format to $expectedKey', ({ expectedKey, transformer }) => {
-        expect(transformer('f-o=o')).toEqual(expectedKey);
-    });
-    it('should transform with custom transformer', () => {
-        const transformer = (s) => `${s}${s}`;
-        expect(transformer('foo')).toEqual('foofoo');
-    });
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const transformer_1 = require("./transformer");
+describe('FieldNametransformer', () => {
+    it.each([
+        {
+            transformer: transformer_1.BuiltInTransformers.toLowerCase,
+            expectedKey: 'foo',
+        },
+        {
+            transformer: transformer_1.BuiltInTransformers.toSnakeCase,
+            expectedKey: 'f_o_o',
+        },
+    ])('should format to $expectedKey', ({ expectedKey, transformer }) => {
+        expect(transformer('f-o=o')).toEqual(expectedKey);
+    });
+    it('should transform with custom transformer', () => {
+        const transformer = (s) => `${s}${s}`;
+        expect(transformer('foo')).toEqual('foofoo');
+    });
+});
 //# sourceMappingURL=transformer.spec.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/push-api-client",
-  "version": "3.0.117",
+  "version": "3.0.122",
   "description": "Push API client",
   "main": "./dist/index.js",
   "files": [
@@ -16,35 +16,35 @@
   "types": "./dist/definitions/index.d.ts",
   "dependencies": {
     "@coveo/bueno": "^0.43.0",
-    "@coveo/platform-client": "40.7.0",
+    "@coveo/platform-client": "40.9.2",
     "dayjs": "^1.10.4",
     "exponential-backoff": "^3.1.0",
     "fetch-undici-polyfill": "^1.1.2",
     "zod": "^3.20.2"
   },
   "devDependencies": {
-    "@coveo/semantic-monorepo-tools": "1.5.21",
+    "@coveo/semantic-monorepo-tools": "1.5.22",
     "@octokit/auth-action": "^2.0.3",
     "@types/jest": "29.4.0",
-    "@types/node": "18.11.19",
-    "@typescript-eslint/eslint-plugin": "5.50.0",
-    "@typescript-eslint/parser": "5.50.0",
+    "@types/node": "18.13.0",
+    "@typescript-eslint/eslint-plugin": "5.52.0",
+    "@typescript-eslint/parser": "5.52.0",
     "conventional-changelog-angular": "5.0.13",
     "cz-conventional-changelog": "3.3.0",
     "detect-indent": "7.0.1",
     "dotenv": "16.0.3",
-    "eslint": "8.33.0",
+    "eslint": "8.34.0",
     "eslint-config-prettier": "8.6.0",
     "gts": "3.1.1",
     "husky": "8.0.3",
-    "jest": "29.4.1",
-    "lint-staged": "13.1.0",
+    "jest": "29.4.2",
+    "lint-staged": "13.1.2",
     "nodemon": "2.0.20",
     "octokit": "2.0.14",
-    "prettier": "2.8.3",
+    "prettier": "2.8.4",
     "ts-jest": "29.0.5",
     "ts-node": "10.9.1",
-    "typedoc": "0.23.24",
+    "typedoc": "0.23.25",
     "typescript": "4.9.5",
     "undici": "^5.16.0"
   },