@coveo/platform-client 44.8.1 → 44.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/resources/Search/Search.js +6 -0
- package/dist/cjs/resources/Search/Search.js.map +1 -1
- package/dist/esm/resources/Search/Search.js +6 -0
- package/dist/esm/resources/Search/Search.js.map +1 -1
- package/dist/types/resources/Search/Search.d.ts +2 -1
- package/dist/types/resources/Search/SearchInterfaces.d.ts +27 -0
- package/package.json +5 -5
|
@@ -10,6 +10,12 @@ class Search extends Resource_js_1.default {
|
|
|
10
10
|
createToken(tokenParams) {
|
|
11
11
|
return this.api.post(`${Search.baseUrl}/token?organizationId=${APICore_js_1.default.orgPlaceholder}`, tokenParams);
|
|
12
12
|
}
|
|
13
|
+
listFields(params) {
|
|
14
|
+
return this.api.get(this.buildPath(`${Search.baseUrl}/fields`, {
|
|
15
|
+
...params,
|
|
16
|
+
organizationId: params?.organizationId ?? this.api.organizationId,
|
|
17
|
+
}));
|
|
18
|
+
}
|
|
13
19
|
getFieldValues(fieldName, params) {
|
|
14
20
|
return this.api.get(this.buildPath(`${Search.baseUrl}/values`, {
|
|
15
21
|
field: encodeURI(`${fieldName}`),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Search.js","sourceRoot":"","sources":["../../../../src/resources/Search/Search.ts"],"names":[],"mappings":";;;;;AACA,kEAAmC;AACnC,iEAAuC;
|
|
1
|
+
{"version":3,"file":"Search.js","sourceRoot":"","sources":["../../../../src/resources/Search/Search.ts"],"names":[],"mappings":";;;;;AACA,kEAAmC;AACnC,iEAAuC;AASvC,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;;AAhDL,yBAiDC"}
|
|
@@ -5,6 +5,12 @@ export default class Search extends Ressource {
|
|
|
5
5
|
createToken(tokenParams) {
|
|
6
6
|
return this.api.post(`${Search.baseUrl}/token?organizationId=${API.orgPlaceholder}`, tokenParams);
|
|
7
7
|
}
|
|
8
|
+
listFields(params) {
|
|
9
|
+
return this.api.get(this.buildPath(`${Search.baseUrl}/fields`, {
|
|
10
|
+
...params,
|
|
11
|
+
organizationId: params?.organizationId ?? this.api.organizationId,
|
|
12
|
+
}));
|
|
13
|
+
}
|
|
8
14
|
getFieldValues(fieldName, params) {
|
|
9
15
|
return this.api.get(this.buildPath(`${Search.baseUrl}/values`, {
|
|
10
16
|
field: encodeURI(`${fieldName}`),
|
|
@@ -1 +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;
|
|
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;AASvC,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"}
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
import { ListFieldValuesBodyQueryParams, PostSearchQuerySuggestBodyParams } from './index.js';
|
|
2
2
|
import Ressource from '../Resource.js';
|
|
3
|
-
import { RestQueryParams, RestTokenParams, TokenModel } from './SearchInterfaces.js';
|
|
3
|
+
import { RestQueryParams, RestTokenParams, SearchListFieldsParams, SearchListFieldsResponse, TokenModel } from './SearchInterfaces.js';
|
|
4
4
|
export default class Search extends Ressource {
|
|
5
5
|
static baseUrl: string;
|
|
6
6
|
createToken(tokenParams: RestTokenParams): Promise<TokenModel>;
|
|
7
|
+
listFields(params?: SearchListFieldsParams): Promise<SearchListFieldsResponse>;
|
|
7
8
|
getFieldValues(fieldName: string, params?: ListFieldValuesBodyQueryParams): Promise<any>;
|
|
8
9
|
query(restQueryParameters: RestQueryParams & any): Promise<any>;
|
|
9
10
|
querySuggestPost(restQuerySuggestParameters: PostSearchQuerySuggestBodyParams): Promise<any>;
|
|
@@ -1,4 +1,31 @@
|
|
|
1
1
|
import { RestUserIdType } from '../Enums.js';
|
|
2
|
+
export interface SearchListFieldsParams {
|
|
3
|
+
/**
|
|
4
|
+
* The unique identifier of the target Coveo Cloud organization.
|
|
5
|
+
* Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.
|
|
6
|
+
*/
|
|
7
|
+
organizationId?: string;
|
|
8
|
+
/**
|
|
9
|
+
* Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege.
|
|
10
|
+
*/
|
|
11
|
+
viewAllContent?: boolean;
|
|
12
|
+
}
|
|
13
|
+
export interface SearchListFieldsResponse {
|
|
14
|
+
fields: Array<{
|
|
15
|
+
type: string;
|
|
16
|
+
name: string;
|
|
17
|
+
nativeName: string;
|
|
18
|
+
description: string;
|
|
19
|
+
defaultValue: string;
|
|
20
|
+
fieldType: string;
|
|
21
|
+
fieldSourceType: string;
|
|
22
|
+
includeInQuery: boolean;
|
|
23
|
+
includeInResults: boolean;
|
|
24
|
+
groupByField: boolean;
|
|
25
|
+
splitGroupByField: boolean;
|
|
26
|
+
sortByField: boolean;
|
|
27
|
+
}>;
|
|
28
|
+
}
|
|
2
29
|
export interface RestTokenParams {
|
|
3
30
|
userIds: RestUserId[];
|
|
4
31
|
userGroups?: string[];
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@coveo/platform-client",
|
|
3
|
-
"version": "44.
|
|
3
|
+
"version": "44.9.0",
|
|
4
4
|
"description": "",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"exports": {
|
|
@@ -35,14 +35,14 @@
|
|
|
35
35
|
"@commitlint/cli": "17.6.5",
|
|
36
36
|
"@commitlint/config-conventional": "17.6.5",
|
|
37
37
|
"@types/jest": "29.5.2",
|
|
38
|
-
"@typescript-eslint/eslint-plugin": "5.
|
|
39
|
-
"@typescript-eslint/parser": "5.
|
|
38
|
+
"@typescript-eslint/eslint-plugin": "5.60.0",
|
|
39
|
+
"@typescript-eslint/parser": "5.60.0",
|
|
40
40
|
"abortcontroller-polyfill": "1.7.5",
|
|
41
41
|
"cz-conventional-changelog": "3.3.0",
|
|
42
|
-
"eslint": "8.
|
|
42
|
+
"eslint": "8.43.0",
|
|
43
43
|
"eslint-config-prettier": "8.8.0",
|
|
44
44
|
"eslint-config-typescript": "3.0.0",
|
|
45
|
-
"eslint-plugin-jest": "27.2.
|
|
45
|
+
"eslint-plugin-jest": "27.2.2",
|
|
46
46
|
"eslint-plugin-prettier": "4.2.1",
|
|
47
47
|
"husky": "8.0.3",
|
|
48
48
|
"jest": "29.5.0",
|