@coveo/platform-client 44.11.2 → 45.1.0

package/dist/cjs/resources/Search/Search.js

@@ -33,6 +33,19 @@ class Search extends Resource_js_1.default {
             viewAllContent: viewAllContent ? 1 : undefined,
         }), bodyParameters);
     }
+    /**
+     * Exports search results to a Microsoft Excel™ spreadsheet
+     *
+     * @param restQueryParameters Parameters of the query
+     * @returns A .xlsx file containing the search results of the specified query
+     */
+    exportQuery(restQueryParameters) {
+        const { viewAllContent, ...bodyParameters } = restQueryParameters;
+        return this.api.post(this.buildPath(Search.baseUrl, {
+            organizationId: this.api.organizationId,
+            viewAllContent: viewAllContent ? 1 : undefined,
+        }), { ...bodyParameters, format: 'xlsx' }, { responseBodyFormat: 'blob' });
+    }
     querySuggestPost(restQuerySuggestParameters) {
         return this.api.post(this.buildPath(`${Search.baseUrl}/querySuggest`, {
             organizationId: this.api.organizationId,
@@ -47,6 +60,15 @@ class Search extends Resource_js_1.default {
             organizationId: params.organizationId ?? this.api.organizationId,
         }), { responseBodyFormat: 'text' });
     }
+    /**
+     * Get item in JSON format
+     */
+    getDocument(params) {
+        return this.api.get(this.buildPath(`${Search.baseUrl}/document`, {
+            ...params,
+            organizationId: params.organizationId ?? this.api.organizationId,
+        }));
+    }
 }
 exports.default = Search;
 //# sourceMappingURL=Search.js.map

package/dist/cjs/resources/Search/Search.js.map

@@ -1 +1 @@
-{"version":3,"file":"Search.js","sourceRoot":"","sources":["../../../../src/resources/Search/Search.ts"],"names":[],"mappings":";;;;;AACA,kEAAmC;AACnC,iEAAuC;AAUvC,MAAqB,MAAO,SAAQ,qBAAS;IACzC,MAAM,CAAC,OAAO,GAAG,iBAAiB,CAAC;IAEnC,WAAW,CAAC,WAA4B;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAa,GAAG,MAAM,CAAC,OAAO,yBAAyB,oBAAG,CAAC,cAAc,EAAE,EAAE,WAAW,CAAC,CAAC;IAClH,CAAC;IAED,UAAU,CAAC,MAA+B;QACtC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,SAAS,EAAE;YACvC,GAAG,MAAM;YACT,cAAc,EAAE,MAAM,EAAE,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SACpE,CAAC,CACL,CAAC;IACN,CAAC;IAED,cAAc,CAAC,SAAiB,EAAE,MAAuC;QACrE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,SAAS,EAAE;YACvC,KAAK,EAAE,SAAS,CAAC,GAAG,SAAS,EAAE,CAAC;YAChC,GAAG,MAAM;YACT,cAAc,EAAE,MAAM,EAAE,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SACpE,CAAC,CACL,CAAC;IACN,CAAC;IAED,2DAA2D;IAC3D,wFAAwF;IACxF,+FAA+F;IAC/F,KAAK,CAAC,mBAA0C;QAC5C,MAAM,EAAC,cAAc,EAAE,GAAG,cAAc,EAAC,GAAG,mBAAmB,CAAC;QAEhE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE;YAC3B,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;YACvC,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;SACjD,CAAC,EACF,cAAc,CACjB,CAAC;IACN,CAAC;IAED,gBAAgB,CAAC,0BAA4D;QACzE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,eAAe,EAAE;YAC7C,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;SAC1C,CAAC,EACF,0BAA0B,CAC7B,CAAC;IACN,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAAiC;QACzC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,OAAO,EAAE;YACrC,GAAG,MAAM;YACT,cAAc,EAAE,MAAM,CAAC,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SACnE,CAAC,EACF,EAAC,kBAAkB,EAAE,MAAM,EAAC,CAC/B,CAAC;IACN,CAAC;;AA7DL,yBA8DC"}
+{"version":3,"file":"Search.js","sourceRoot":"","sources":["../../../../src/resources/Search/Search.ts"],"names":[],"mappings":";;;;;AACA,kEAAmC;AACnC,iEAAuC;AAavC,MAAqB,MAAO,SAAQ,qBAAS;IACzC,MAAM,CAAC,OAAO,GAAG,iBAAiB,CAAC;IAEnC,WAAW,CAAC,WAA4B;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAa,GAAG,MAAM,CAAC,OAAO,yBAAyB,oBAAG,CAAC,cAAc,EAAE,EAAE,WAAW,CAAC,CAAC;IAClH,CAAC;IAED,UAAU,CAAC,MAA+B;QACtC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,SAAS,EAAE;YACvC,GAAG,MAAM;YACT,cAAc,EAAE,MAAM,EAAE,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SACpE,CAAC,CACL,CAAC;IACN,CAAC;IAED,cAAc,CAAC,SAAiB,EAAE,MAAuC;QACrE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,SAAS,EAAE;YACvC,KAAK,EAAE,SAAS,CAAC,GAAG,SAAS,EAAE,CAAC;YAChC,GAAG,MAAM;YACT,cAAc,EAAE,MAAM,EAAE,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SACpE,CAAC,CACL,CAAC;IACN,CAAC;IAED,2DAA2D;IAC3D,wFAAwF;IACxF,+FAA+F;IAC/F,KAAK,CAAC,mBAAoC;QACtC,MAAM,EAAC,cAAc,EAAE,GAAG,cAAc,EAAC,GAAG,mBAAmB,CAAC;QAEhE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE;YAC3B,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;YACvC,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;SACjD,CAAC,EACF,cAAc,CACjB,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,mBAAoC;QAC5C,MAAM,EAAC,cAAc,EAAE,GAAG,cAAc,EAAC,GAAG,mBAAmB,CAAC;QAEhE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE;YAC3B,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;YACvC,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;SACjD,CAAC,EACF,EAAC,GAAG,cAAc,EAAE,MAAM,EAAE,MAAM,EAAC,EACnC,EAAC,kBAAkB,EAAE,MAAM,EAAC,CAC/B,CAAC;IACN,CAAC;IAED,gBAAgB,CAAC,0BAA4D;QACzE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,eAAe,EAAE;YAC7C,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;SAC1C,CAAC,EACF,0BAA0B,CAC7B,CAAC;IACN,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAAiC;QACzC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,OAAO,EAAE;YACrC,GAAG,MAAM;YACT,cAAc,EAAE,MAAM,CAAC,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SACnE,CAAC,EACF,EAAC,kBAAkB,EAAE,MAAM,EAAC,CAC/B,CAAC;IACN,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAA4B;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,WAAW,EAAE;YACzC,GAAG,MAAM;YACT,cAAc,EAAE,MAAM,CAAC,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SACnE,CAAC,CACL,CAAC;IACN,CAAC;;AA5FL,yBA6FC"}

package/dist/esm/resources/Search/Search.js

@@ -28,6 +28,19 @@ export default class Search extends Ressource {
             viewAllContent: viewAllContent ? 1 : undefined,
         }), bodyParameters);
     }
+    /**
+     * Exports search results to a Microsoft Excel™ spreadsheet
+     *
+     * @param restQueryParameters Parameters of the query
+     * @returns A .xlsx file containing the search results of the specified query
+     */
+    exportQuery(restQueryParameters) {
+        const { viewAllContent, ...bodyParameters } = restQueryParameters;
+        return this.api.post(this.buildPath(Search.baseUrl, {
+            organizationId: this.api.organizationId,
+            viewAllContent: viewAllContent ? 1 : undefined,
+        }), { ...bodyParameters, format: 'xlsx' }, { responseBodyFormat: 'blob' });
+    }
     querySuggestPost(restQuerySuggestParameters) {
         return this.api.post(this.buildPath(`${Search.baseUrl}/querySuggest`, {
             organizationId: this.api.organizationId,
@@ -42,5 +55,14 @@ export default class Search extends Ressource {
             organizationId: params.organizationId ?? this.api.organizationId,
         }), { responseBodyFormat: 'text' });
     }
+    /**
+     * Get item in JSON format
+     */
+    getDocument(params) {
+        return this.api.get(this.buildPath(`${Search.baseUrl}/document`, {
+            ...params,
+            organizationId: params.organizationId ?? this.api.organizationId,
+        }));
+    }
 }
 //# sourceMappingURL=Search.js.map

package/dist/esm/resources/Search/Search.js.map

@@ -1 +1 @@
-{"version":3,"file":"Search.js","sourceRoot":"","sources":["../../../../src/resources/Search/Search.ts"],"names":[],"mappings":"AACA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AACnC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAUvC,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,SAAS;IACzC,MAAM,CAAC,OAAO,GAAG,iBAAiB,CAAC;IAEnC,WAAW,CAAC,WAA4B;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAa,GAAG,MAAM,CAAC,OAAO,yBAAyB,GAAG,CAAC,cAAc,EAAE,EAAE,WAAW,CAAC,CAAC;IAClH,CAAC;IAED,UAAU,CAAC,MAA+B;QACtC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,SAAS,EAAE;YACvC,GAAG,MAAM;YACT,cAAc,EAAE,MAAM,EAAE,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SACpE,CAAC,CACL,CAAC;IACN,CAAC;IAED,cAAc,CAAC,SAAiB,EAAE,MAAuC;QACrE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,SAAS,EAAE;YACvC,KAAK,EAAE,SAAS,CAAC,GAAG,SAAS,EAAE,CAAC;YAChC,GAAG,MAAM;YACT,cAAc,EAAE,MAAM,EAAE,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SACpE,CAAC,CACL,CAAC;IACN,CAAC;IAED,2DAA2D;IAC3D,wFAAwF;IACxF,+FAA+F;IAC/F,KAAK,CAAC,mBAA0C;QAC5C,MAAM,EAAC,cAAc,EAAE,GAAG,cAAc,EAAC,GAAG,mBAAmB,CAAC;QAEhE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE;YAC3B,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;YACvC,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;SACjD,CAAC,EACF,cAAc,CACjB,CAAC;IACN,CAAC;IAED,gBAAgB,CAAC,0BAA4D;QACzE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,eAAe,EAAE;YAC7C,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;SAC1C,CAAC,EACF,0BAA0B,CAC7B,CAAC;IACN,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAAiC;QACzC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,OAAO,EAAE;YACrC,GAAG,MAAM;YACT,cAAc,EAAE,MAAM,CAAC,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SACnE,CAAC,EACF,EAAC,kBAAkB,EAAE,MAAM,EAAC,CAC/B,CAAC;IACN,CAAC"}
+{"version":3,"file":"Search.js","sourceRoot":"","sources":["../../../../src/resources/Search/Search.ts"],"names":[],"mappings":"AACA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AACnC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAavC,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,SAAS;IACzC,MAAM,CAAC,OAAO,GAAG,iBAAiB,CAAC;IAEnC,WAAW,CAAC,WAA4B;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAa,GAAG,MAAM,CAAC,OAAO,yBAAyB,GAAG,CAAC,cAAc,EAAE,EAAE,WAAW,CAAC,CAAC;IAClH,CAAC;IAED,UAAU,CAAC,MAA+B;QACtC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,SAAS,EAAE;YACvC,GAAG,MAAM;YACT,cAAc,EAAE,MAAM,EAAE,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SACpE,CAAC,CACL,CAAC;IACN,CAAC;IAED,cAAc,CAAC,SAAiB,EAAE,MAAuC;QACrE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,SAAS,EAAE;YACvC,KAAK,EAAE,SAAS,CAAC,GAAG,SAAS,EAAE,CAAC;YAChC,GAAG,MAAM;YACT,cAAc,EAAE,MAAM,EAAE,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SACpE,CAAC,CACL,CAAC;IACN,CAAC;IAED,2DAA2D;IAC3D,wFAAwF;IACxF,+FAA+F;IAC/F,KAAK,CAAC,mBAAoC;QACtC,MAAM,EAAC,cAAc,EAAE,GAAG,cAAc,EAAC,GAAG,mBAAmB,CAAC;QAEhE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE;YAC3B,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;YACvC,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;SACjD,CAAC,EACF,cAAc,CACjB,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,mBAAoC;QAC5C,MAAM,EAAC,cAAc,EAAE,GAAG,cAAc,EAAC,GAAG,mBAAmB,CAAC;QAEhE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE;YAC3B,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;YACvC,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;SACjD,CAAC,EACF,EAAC,GAAG,cAAc,EAAE,MAAM,EAAE,MAAM,EAAC,EACnC,EAAC,kBAAkB,EAAE,MAAM,EAAC,CAC/B,CAAC;IACN,CAAC;IAED,gBAAgB,CAAC,0BAA4D;QACzE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,eAAe,EAAE;YAC7C,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;SAC1C,CAAC,EACF,0BAA0B,CAC7B,CAAC;IACN,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAAiC;QACzC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,OAAO,EAAE;YACrC,GAAG,MAAM;YACT,cAAc,EAAE,MAAM,CAAC,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SACnE,CAAC,EACF,EAAC,kBAAkB,EAAE,MAAM,EAAC,CAC/B,CAAC;IACN,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAA4B;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,WAAW,EAAE;YACzC,GAAG,MAAM;YACT,cAAc,EAAE,MAAM,CAAC,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SACnE,CAAC,CACL,CAAC;IACN,CAAC"}

package/dist/types/resources/Search/Search.d.ts

@@ -1,15 +1,26 @@
 import { ListFieldValuesBodyQueryParams, PostSearchQuerySuggestBodyParams } from './index.js';
 import Ressource from '../Resource.js';
-import { ItemPreviewHtmlParameters, RestQueryParams, RestTokenParams, SearchListFieldsParams, SearchListFieldsResponse, TokenModel } from './SearchInterfaces.js';
+import { SingleItemParameters, ItemPreviewHtmlParameters, RestQueryParams, RestQueryResult, RestTokenParams, SearchListFieldsParams, SearchListFieldsResponse, SearchResponse, TokenModel } from './SearchInterfaces.js';
 export default class Search extends Ressource {
     static baseUrl: string;
     createToken(tokenParams: RestTokenParams): Promise<TokenModel>;
     listFields(params?: SearchListFieldsParams): Promise<SearchListFieldsResponse>;
     getFieldValues(fieldName: string, params?: ListFieldValuesBodyQueryParams): Promise<any>;
-    query(restQueryParameters: RestQueryParams & any): Promise<any>;
+    query(restQueryParameters: RestQueryParams): Promise<SearchResponse>;
+    /**
+     * Exports search results to a Microsoft Excel™ spreadsheet
+     *
+     * @param restQueryParameters Parameters of the query
+     * @returns A .xlsx file containing the search results of the specified query
+     */
+    exportQuery(restQueryParameters: RestQueryParams): Promise<Blob>;
     querySuggestPost(restQuerySuggestParameters: PostSearchQuerySuggestBodyParams): Promise<any>;
     /**
      * Get an item's preview in HTML format
      */
     previewHTML(params: ItemPreviewHtmlParameters): Promise<string>;
+    /**
+     * Get item in JSON format
+     */
+    getDocument(params: SingleItemParameters): Promise<RestQueryResult>;
 }

package/dist/types/resources/Search/SearchInterfaces.d.ts

@@ -2183,4 +2183,478 @@ export interface ItemPreviewHtmlParameters extends PostSearchQueryStringParams {
      */
     requestedOutputSize?: number;
 }
+export interface RestCategoryFacetValue {
+    numberOfResults?: number[];
+    value?: string;
+}
+export interface RestCategoryFacetResponse {
+    field?: string;
+    parentValues?: RestCategoryFacetValue[];
+    values?: RestCategoryFacetValue[];
+}
+export interface RestHierarchicalFacetResponseValue {
+    /**
+     * The number of query results that can be expected if the facet value is selected in the search interface.
+     *
+     * Note: This property only gets populated when the facet currently has no selected or excluded values.
+     */
+    numberOfResults: number;
+    path: string[];
+    /**
+     * The current facet value state in the search interface.
+     *
+     * @default 'idle'
+     */
+    state: 'idle' | 'selected' | 'excluded';
+    /**
+     * The facet value name.
+     *
+     * Note: In the case of a hierarchical facet value, this represents a single path segment.
+     */
+    value: string;
+    /**
+     * The children of this hierarchical facet value.
+     *
+     * Each child is a full-fledged hierarchical facet value that may in turn have its own children and so forth, up to a maximum depth of 50 levels.
+     */
+    children?: RestHierarchicalFacetResponseValue[];
+    /**
+     * Whether the facet value was automatically selected by Coveo ML.
+     */
+    isAutoSelected?: boolean;
+    /**
+     * Whether the hierarchical value is a childless node.
+     */
+    isLeafValue?: boolean;
+    /**
+     * Whether additional values are available for the facet.
+     */
+    moreValuesAvailable?: boolean;
+}
+export interface RestFacetResultValue extends RestHierarchicalFacetResponseValue {
+    /**
+     * The end of the range.
+     */
+    end?: string | number;
+    /**
+     * Whether to include the `end` value in the range.
+     *
+     * @default false
+     */
+    endInclusive?: boolean;
+    isSuggested?: boolean;
+    /**
+     * The start of the range.
+     */
+    start?: string | number;
+}
+export interface RestFacetResult {
+    /**
+     * The name of the field on which the facet is based.
+     *
+     * @example 'author'
+     */
+    field: string;
+    /**
+     * The ranking score computed by the index for this facet.
+     */
+    indexScore: number;
+    /**
+     * Whether additional values are available for the facet.
+     */
+    moreValuesAvailable: boolean;
+    /**
+     * The returned facet values
+     */
+    values: RestFacetResultValue[];
+    /**
+     * Whether the facet was recommended by Coveo ML.
+     */
+    isFromAutoSelect?: boolean;
+    /**
+     * The ranking score computed by Coveo ML DNE for this facet.
+     */
+    mlScore?: number;
+}
+export interface RestGroupByValue {
+    /**
+     * The results of the computed fields (see the computedFields Group By parameter).
+     */
+    computedFieldResults: number[];
+    /**
+     * The number of query result items having this field value.
+     */
+    numberOfResults: number;
+    /**
+     * The Group By value score, computed from the numberOfResults value as well as from the position of the items having this value in the ranked query result set.
+     */
+    score: number;
+    /**
+     * The Group By value name.
+     */
+    value: string;
+    /**
+     * The type of Group By value.
+     */
+    valueType: string;
+}
+export interface RestGroupByResult {
+    /**
+     * The field on which the Group By operation was executed.
+     */
+    field: string;
+    /**
+     * The global computed fields that were processed by the index.
+     */
+    globalComputedFieldResults: number[];
+    /**
+     * The resulting Group By values.
+     */
+    values: RestGroupByValue[];
+}
+export interface RestWordCorrection {
+    /**
+     * The suggested word correction.
+     */
+    correctedWord: string;
+    /**
+     * The length (in number of characters) of the corrected word.
+     */
+    length: number;
+    /**
+     * The offset (in number of characters) of the corrected word, from the beginning of the resulting query expression correction suggestion.
+     */
+    offset: number;
+    /**
+     * The original, un-corrected word.
+     */
+    originalWord: string;
+}
+export interface RestQueryCorrection {
+    /**
+     * The resulting query expression correction suggestion.
+     */
+    correctedQuery: string;
+    /**
+     * The word correction suggestions.
+     */
+    wordCorrections: RestWordCorrection[];
+}
+export interface RestHighlightResponse {
+    /**
+     * The length (in number of characters) of the word to highlight.
+     */
+    length: number;
+    /**
+     * The 0-based index position of the first character of the word to highlight in the string.
+     */
+    offset: number;
+}
+export interface RestQueryResult {
+    /**
+     * The basic query expression terms which this query result item does not match.
+     *
+     * Note: This property is populated by terms from the query pipeline-processed `q` value (not from the original `q` value).
+     */
+    absentTerms: string[];
+    /**
+     * An array of references to the children of this item, if result folding was applied (see the `filterField` query parameter). The query results contained in this field will have both their parent and child results set to `null`.
+     */
+    childResults: RestQueryResult[];
+    /**
+     * The hyperlinkable item URI.
+     *
+     * Notes:
+     * - Use the `clickUri` value when you want to create hyperlinks to the item, rather than the `uri` or `printableUri` value.
+     * - The `clickUri` value is not necessarily unique for each item.
+     */
+    clickUri: string;
+    /**
+     * The contextual excerpt generated for the item (see the excerptLength query parameter).
+     */
+    excerpt: string;
+    /**
+     * The length and offset of each word to highlight in the item `excerpt` string.
+     */
+    excerptHighlights: RestHighlightResponse[];
+    /**
+     * The first sentences retrieved from the item (see the `retrieveFirstSentences` query parameter).
+     */
+    firstSentences: string;
+    /**
+     * The length and offset of each word to highlight in the item `firstSentences` string.
+     */
+    firstSentencesHighlights: RestHighlightResponse[];
+    /**
+     * The flags that are set on the item by the index. Distinct values are separated by semicolons.
+     */
+    flags: string;
+    /**
+     * Whether the index contains an HTML version of this item.
+     */
+    hasHtmlVersion: boolean;
+    /**
+     * Whether the index contains a mobile HTML version of this item.
+     */
+    hasMobileHtmlVersion: boolean;
+    /**
+     * Whether the item score was boosted as a Coveo ML recommendation.
+     */
+    isRecommendation: boolean;
+    /**
+     * Whether the item score was boosted by a featured result rule in the query pipeline.
+     */
+    isTopResult: boolean;
+    /**
+     * Whether the item score was boosted as a Coveo ML recommendation.
+     */
+    isUserActionView: boolean;
+    parentResult: RestQueryResult;
+    /**
+     * The item ranking score expressed as a percentage (see the `sortCriteria` and `rankingFunctions` query parameters).
+     */
+    percentScore: number;
+    /**
+     * The human readable item URI.
+     *
+     * Note: Avoid using the `printableUri` value to create hyperlinks to the item. Use the `clickUri` value instead.
+     */
+    printableUri: string;
+    /**
+     * The length and offset of each word to highlight in the item printableUri string.
+     */
+    printableUriHighlights: RestHighlightResponse[];
+    /**
+     * The raw debug information generated by the index to detail how the item was ranked. This property is `null` unless the `debug` query parameter is set to `true`.
+     */
+    rankingInfo: string;
+    /**
+     * The item rating (see the enableCollaborativeRating query parameter).
+     *
+     * Note: Unless collaborative rating is enabled for your index, the value of this property is always 3.
+     */
+    rating: number;
+    /**
+     * The values of the fields which were retrieved for this item (see the fieldsToInclude and fieldsToExclude query parameters).
+     */
+    raw: Record<string, any>;
+    /**
+     * The total ranking score computed for the item (see the `sortCriteria` and `rankingFunctions` query parameters).
+     */
+    score: number;
+    /**
+     * The item summary (see the `summaryLength` query parameter).
+     */
+    summary: string;
+    /**
+     * The length and offset of each word to highlight in the item `summary` string.
+     */
+    summaryHighlights: RestHighlightResponse[];
+    /**
+     * The item title.
+     *
+     * Note: When logging a **Click** usage analytics event for an opened query result item, the `documentTitle` field of that event should be set to the `title` value of the opened query result item.
+     */
+    title: string;
+    /**
+     * The length and offset of each word to highlight in the item title string.
+     */
+    titleHighlights: RestHighlightResponse[];
+    /**
+     * The total number of children available in the index for this item, if result folding was applied (see the `filterField` query parameter).
+     */
+    totalNumberOfChildResults: number;
+    /**
+     * The unique item identifier. You should consider the `uniqueId` value as an opaque string.
+     */
+    uniqueId: string;
+    /**
+     * The item URI.
+     *
+     * Notes:
+     * - Avoid using the `uri` value to create hyperlinks to the item. Use the `clickUri` value instead.
+     * - When logging a **Click** usage analytics event for an opened query result item, the `documentUrl` field of that event should be set to the `uri` value of the opened query result item.
+     */
+    uri: string;
+    /**
+     * Additional undocumented or deprecated properties that might be sent by the Search API
+     */
+    [key: string]: unknown;
+}
+export interface RestSuggestedFacetValue {
+    /**
+     * A DNE facet value suggestion.
+     *
+     * @example 'Alice Smith'
+     */
+    value: string;
+    /**
+     * The path to the suggested facet value (only applies to hierarchical facet value suggestions).
+     *
+     * If the suggested hierarchical facet value is `'Parrot'`, the returned path could be `["Animals", "Birds", "Parrot"]`.
+     */
+    path: string[];
+}
+export interface RestSuggestedFacet {
+    /**
+     * The name of the field on which the DNE facet suggestion is based.
+     *
+     * @example 'author'
+     */
+    field: string;
+    values: RestSuggestedFacetValue[];
+}
+export interface RestTriggerResponse {
+    content: Record<string, unknown>;
+    /**
+     * The type of Coveo Cloud query pipeline **Trigger** statement (see [Managing Query Pipeline Triggers](https://docs.coveo.com/en/1550/)).
+     */
+    type: 'notify' | 'execute' | 'query' | 'redirect';
+}
+export interface RestContentId {
+    contentIdKey: string;
+    contentIdValue: string;
+}
+export interface RestQuestion {
+    answerSnippet: string;
+    documentId: RestContentId;
+    question: string;
+    score: number;
+}
+export interface RestQuestionAnswer extends RestQuestion {
+    allContentIds: RestContentId[];
+    answerFound: boolean;
+    answerId: string;
+    relatedQuestions: RestQuestion[];
+    raw: Record<string, any>;
+}
+export interface SearchResponse {
+    /**
+     * The version of the Search API that sent the query.
+     */
+    apiVersion: number;
+    /**
+     * Hierarchical data results corresponding the to hierarchical data in the query.
+     */
+    categoryFacets: RestCategoryFacetResponse[];
+    /**
+     * The `requestDuration` added to the computing time (in milliseconds) that was required by the Search API.
+     */
+    duration: number;
+    /**
+     * The facet results returned by the query. These results are included in the order they were requested in the facets query parameter.
+     */
+    facets: RestFacetResult[];
+    /**
+     * The Group By results returned by the query. These results are included in the order they were requested in the groupBy query parameter.
+     */
+    groupByResults: RestGroupByResult[];
+    /**
+     * The identifier of the index mirror against which the query was executed (see the indexToken query parameter).
+     */
+    index: string;
+    /**
+     * The time (in milliseconds) that was required by the index to find the query items.
+     */
+    indexDuration: number;
+    /**
+     * The phrases to highlight in each query result item. This property is populated when the basic query expression (see the `q` query parameter) contains one or several exact phrase match requests (terms between double quote characters).
+     */
+    phrasesToHighlight: Record<string, Record<string, string[]>>;
+    /**
+     * The name of the query pipeline to use for this request (bypassing its conditions, if it has any).
+     *
+     * You can pass an empty `pipeline` value to use an empty query pipeline (i.e., `?pipeline=` or `"pipeline": ""`).
+     *
+     * If a query does not contain the `pipeline` parameter, the first query pipeline whose conditions are met by the request is used (query pipelines without conditions are not evaluated). Should the request fail to meet the conditions of each evaluated query pipeline, the default query pipeline of the target Coveo Cloud organization is used (bypassing its conditions, if it has any).
+     *
+     * Notes:
+     * - This parameter will be overridden if the search request is authenticated by a [search token](https://docs.coveo.com/en/56/) that enforces a specific `pipeline`, or a `searchHub` that routes queries to a specific `pipeline` via a query pipeline condition.
+     * - For reporting purposes, when logging a **Search** usage analytics event for a query, the `queryPipeline` field of that event should be set to the `pipeline` value of the query (or to the `"default"` string, if no `pipeline` value was specified in the query).
+     *
+     * See also [Managing Query Pipelines](https://docs.coveo.com/en/1450/).
+     */
+    pipeline: string;
+    /**
+     * The query corrections suggested by the index, if the `enableDidYouMean` query parameter was set to `true`.
+     */
+    queryCorrections: RestQueryCorrection[];
+    /**
+     * The refined keywords used by the Coveo ML automatic relevance tuning model.
+     */
+    refinedKeywords: string[];
+    /**
+     * The indexDuration added to the time (in milliseconds) that was required to establish a connection between the Search API server and the index server.
+     */
+    requestDuration: number;
+    /**
+     * The items returned for the query.
+     */
+    results: RestQueryResult[];
+    /**
+     * The query [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). Each query sent to the Search API has its own randomly generated `searchUid`.
+     *
+     * Note: When logging a **Search** or **Custom* usage analytics event for a query, or a **Click** usage analytics event for an opened query result item, the `searchQueryUid` field of that event should be set to the `searchUid` value of the query response.
+     */
+    searchUid: string;
+    /**
+     * A DNE facet suggestion.
+     */
+    suggestedFacets: RestSuggestedFacet[];
+    /**
+     * The terms to highlight in each query result item. Includes all basic query expression keywords, as well as any word stemmed from a basic query expression keyword (see the `q` query parameter), unless this keyword was preceded by the no stemming Coveo Cloud query syntax operator (`+`).
+     */
+    termsToHighlight: Record<string, string[]>;
+    /**
+     * The total number of items matching the query for the current user (security trimming applied).
+     *
+     * Note: When logging a **Search** usage analytics event for a query, the `numberOfResults` field of that event should be set to the `totalCount` value of the query (for reporting purposes).
+     */
+    totalCount: number;
+    /**
+     * The total number of items matching the query for the current user (security trimming applied) after duplicate filtering has been applied (see the `duplicateFiltering` query parameter).
+     */
+    totalCountFiltered: number;
+    /**
+     * The actions to perform by the client based on the Trigger statements defined in query pipelines (see the pipeline query parameter).
+     *
+     * Note: A Trigger statement must have a condition. Otherwise, the Search API ignores it and does not include it in the `triggers` array of the query response (see [Managing Query Pipeline Triggers](http://www.coveo.com/go?dest=cloudhelp&lcid=9&context=146)).
+     */
+    triggers: RestTriggerResponse[];
+    /**
+     * The errors that critically changed the query behaviour. These should be addressed right away to prevent future errors.
+     */
+    errors?: string[];
+    exception?: {
+        code: string;
+        context?: string;
+    };
+    /**
+     * The Base64 encoded identifier of the index mirror to forward the request to. See also the `index` parameter.
+     *
+     * If you do not specify an `indexToken` (or `index`) value, any index mirror could be used.
+     *
+     * Note: Passing an `indexToken` (or `index`) value has no effect when the results of a specific request can be returned from cache (see the `maximumAge` parameter).
+     */
+    indexToken?: string;
+    /**
+     * Whether the admin session ID was allowed and used by the Coveo for Salesforce search engine. The value will be set to `true` when it is the case, and might be absent or set to `false` otherwise.
+     */
+    isFallbackToAdmin?: boolean;
+    questionAnswer?: RestQuestionAnswer;
+    /**
+     * The errors that did not make the query fail, but should be addressed. They might be security issues, deprecated behaviors, or any other kind of concern.
+     */
+    warnings?: string[];
+    /**
+     * Additional undocumented or deprecated properties that might be sent by the Search API
+     */
+    [key: string]: unknown;
+}
+export interface SingleItemParameters extends PostSearchQueryStringParams {
+    /**
+     * The unique ID of the document.
+     */
+    uniqueId: string;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@coveo/platform-client",
-    "version": "44.11.2",
+    "version": "45.1.0",
     "description": "",
     "type": "module",
     "exports": {
@@ -34,9 +34,9 @@
     "devDependencies": {
         "@commitlint/cli": "17.6.6",
         "@commitlint/config-conventional": "17.6.6",
-        "@types/jest": "29.5.2",
-        "@typescript-eslint/eslint-plugin": "5.61.0",
-        "@typescript-eslint/parser": "5.61.0",
+        "@types/jest": "29.5.3",
+        "@typescript-eslint/eslint-plugin": "5.62.0",
+        "@typescript-eslint/parser": "5.62.0",
         "abortcontroller-polyfill": "1.7.5",
         "cz-conventional-changelog": "3.3.0",
         "eslint": "8.44.0",
@@ -45,12 +45,12 @@
         "eslint-plugin-jest": "27.2.2",
         "eslint-plugin-prettier": "4.2.1",
         "husky": "8.0.3",
-        "jest": "29.5.0",
+        "jest": "29.6.1",
         "jest-fetch-mock": "3.0.3",
         "jest-runner-eslint": "2.1.0",
         "lint-staged": "13.2.3",
         "prettier": "2.8.8",
-        "semantic-release": "21.0.6",
+        "semantic-release": "21.0.7",
         "ts-jest": "29.1.1",
         "tsjs": "4.2.1",
         "tslib": "2.6.0",