@coveo/platform-client 44.7.0 → 44.8.0

package/dist/types/resources/Fields/FieldsInterfaces.d.ts

@@ -1,27 +1,118 @@
 import { Paginated } from '../BaseInterfaces.js';
 import { FacetOrSortStatus, FieldOrigin, FieldTypes, SortingOrder } from '../Enums.js';
 export interface FieldModel {
+    /**
+     * Whether this field is to be considered by the facet generator feature.
+     */
+    automaticFacetsCandidate?: boolean;
+    /**
+     * A regex indicating the date format, for some date type fields.
+     */
     dateFormat?: string;
+    /**
+     * A description of the field.
+     */
     description?: string;
+    /**
+     * Whether [Group By](https://docs.coveo.com/en/203/glossary/group-by) operations and [Facet](https://docs.coveo.com/en/198/glossary/facet) requests can be performed on the field.
+     */
     facet?: boolean;
+    /**
+     * Whether the field contains multiple values that form a hierarchy (see also the multiValueFacetTokenizers property).
+     * Note: Applicable to field type STRING only.
+     */
     hierarchicalFacet?: boolean;
+    /**
+     * Whether this field can be referred to in [Coveo Cloud query syntax](https://docs.coveo.com/en/149/index-content/available-boolean-field-options) expressions.
+     */
     includeInQuery?: boolean;
+    /**
+     * Whether the field can be included in the raw property of [query](https://docs.coveo.com/en/231/glossary/query) results.
+     */
     includeInResults?: boolean;
+    /**
+     * Whether field values with differing accents should be considered distinct facet values.
+     * Note: Applicable to field type STRING only.
+     */
     keepAccentsDisplayValueFacet?: boolean;
+    /**
+     * Whether the field is a dictionary field, which contains mappings of keys to values instead of a single value.
+     */
     keyValue?: boolean;
+    /**
+     * A displayable label for the field when used by the facet generator.
+     */
+    label?: string;
+    /**
+     * Whether the field is free text searchable.
+     * Note: Applicable to field type STRING only.
+     */
     mergeWithLexicon?: boolean;
+    /**
+     * Whether the field contains multiple values (see also the multiValueFacetTokenizers property).
+     * Note: Applicable to field type STRING only.
+     */
     multiValueFacet?: boolean;
+    /**
+     * The character to use as a value separator, if the field contains multiple values (see also the multiValueFacet property).
+     */
     multiValueFacetTokenizers?: string;
+    /**
+     * The name of the field, also referred to as the field identifier, or fieldId.
+     * Note: Must match ^([a-z][a-z0-9_]{0,254})$
+     */
     name?: string;
+    /**
+     * Whether to use the field in result ranking calculation only.
+     * Notes:
+     * - Has a significant impact on query performance.
+     * - Applicable to field type STRING
+     */
     ranking?: boolean;
+    /**
+     * Whether to transform date and time string values into semicolon separated number of days/weeks/months/quarters/years since January 1st, 1900.
+     * Note: Applicable to field type DATE only.
+     */
     smartDateFacet?: boolean;
+    /**
+     * Whether query results can be sorted based on the value of the field.
+     */
     sort?: boolean;
+    /**
+     * Whether to allow an item to match the query when the value of this field for this item stems from the same root as one of the query expression keywords.
+     * Notes:
+     * - applicable to STRING type fields only.
+     * - Has a significant impact on query performance.
+     */
     stemming?: boolean;
+    /**
+     * Whether the field is a standard Coveo field.
+     * Note: system option can not be set to true.
+     */
     system?: boolean;
+    /**
+     * The data type of the field.
+     * See [Field Types](https://docs.coveo.com/en/2036/index-content/about-fields#Field2).
+     */
     type?: FieldTypes;
+    /**
+     * Whether to keep computed field data in memory.
+     * Note: Cannot be enabled on STRING type fields.
+     */
     useCacheForComputedFacet?: boolean;
+    /**
+     * Whether to keep the data required to perform nested queries in memory.
+     * Note: only applicable to fields which are faceted or multi-value faceted.
+     */
     useCacheForNestedQuery?: boolean;
+    /**
+     * Whether to keep the data required to execute operations on numeric and date fields in memory.
+     * Note: Cannot be enabled on STRING type fields.
+     */
     useCacheForNumericQuery?: boolean;
+    /**
+     * Whether to keep the entire field in memory for fast sorting.
+     */
     useCacheForSort?: boolean;
 }
 export interface ListFieldsParams extends Paginated {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@coveo/platform-client",
-    "version": "44.7.0",
+    "version": "44.8.0",
     "description": "",
     "type": "module",
     "exports": {
@@ -34,12 +34,12 @@
     "devDependencies": {
         "@commitlint/cli": "17.6.5",
         "@commitlint/config-conventional": "17.6.5",
-        "@types/jest": "29.5.1",
-        "@typescript-eslint/eslint-plugin": "5.59.8",
-        "@typescript-eslint/parser": "5.59.8",
+        "@types/jest": "29.5.2",
+        "@typescript-eslint/eslint-plugin": "5.59.11",
+        "@typescript-eslint/parser": "5.59.11",
         "abortcontroller-polyfill": "1.7.5",
         "cz-conventional-changelog": "3.3.0",
-        "eslint": "8.41.0",
+        "eslint": "8.42.0",
         "eslint-config-prettier": "8.8.0",
         "eslint-config-typescript": "3.0.0",
         "eslint-plugin-jest": "27.2.1",
@@ -47,14 +47,14 @@
         "husky": "8.0.3",
         "jest": "29.5.0",
         "jest-fetch-mock": "3.0.3",
-        "jest-runner-eslint": "2.0.0",
+        "jest-runner-eslint": "2.1.0",
         "lint-staged": "13.2.2",
         "prettier": "2.8.8",
-        "semantic-release": "21.0.2",
+        "semantic-release": "21.0.5",
         "ts-jest": "29.1.0",
         "tsjs": "4.2.1",
-        "tslib": "2.5.2",
-        "typescript": "5.0.4"
+        "tslib": "2.5.3",
+        "typescript": "5.1.3"
     },
     "prettier": "tsjs/prettier-config",
     "lint-staged": {