@coveo/platform-client 69.3.0 → 69.4.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 +4 -0
- package/dist/cjs/resources/Search/Search.js.map +1 -1
- package/dist/esm/resources/Search/Search.js +4 -0
- package/dist/esm/resources/Search/Search.js.map +1 -1
- package/dist/types/resources/HostedInterfacesCore/HostedInterfaceVersionsCore.d.ts +4 -0
- package/dist/types/resources/Search/Search.d.ts +3 -1
- package/dist/types/resources/Search/SearchInterfaces.d.ts +10 -0
- package/package.json +1 -1
|
@@ -5,9 +5,13 @@ const APICore_js_1 = tslib_1.__importDefault(require("../../APICore.js"));
|
|
|
5
5
|
const Resource_js_1 = tslib_1.__importDefault(require("../Resource.js"));
|
|
6
6
|
class Search extends Resource_js_1.default {
|
|
7
7
|
static baseUrl = `/rest/search/v2`;
|
|
8
|
+
static authenticationBaseUrl = `/rest/organizations/${APICore_js_1.default.orgPlaceholder}/authentication`;
|
|
8
9
|
createToken(tokenParams) {
|
|
9
10
|
return this.api.post(`${Search.baseUrl}/token?organizationId=${APICore_js_1.default.orgPlaceholder}`, tokenParams);
|
|
10
11
|
}
|
|
12
|
+
listSamlIdentityProviders() {
|
|
13
|
+
return this.api.get(`${Search.authenticationBaseUrl}/saml`);
|
|
14
|
+
}
|
|
11
15
|
listFields(params) {
|
|
12
16
|
return this.api.get(this.buildPath(`${Search.baseUrl}/fields`, {
|
|
13
17
|
...params,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Search.js","sourceRoot":"","sources":["../../../../src/resources/Search/Search.ts"],"names":[],"mappings":";;;AAAA,0EAAmC;AACnC,yEAAsC;
|
|
1
|
+
{"version":3,"file":"Search.js","sourceRoot":"","sources":["../../../../src/resources/Search/Search.ts"],"names":[],"mappings":";;;AAAA,0EAAmC;AACnC,yEAAsC;AAkBtC,MAAqB,MAAO,SAAQ,qBAAQ;IACxC,MAAM,CAAC,OAAO,GAAG,iBAAiB,CAAC;IACnC,MAAM,CAAC,qBAAqB,GAAG,uBAAuB,oBAAG,CAAC,cAAc,iBAAiB,CAAC;IAE1F,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,yBAAyB;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAkC,GAAG,MAAM,CAAC,qBAAqB,OAAO,CAAC,CAAC;IACjG,CAAC;IAED,UAAU,CAAC,MAA+B;QACtC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CACV,GAAG,MAAM,CAAC,OAAO,SAAS,EAC1B;YACI,GAAG,MAAM;YACT,cAAc,EAAE,MAAM,EAAE,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SACpE,EACD,EAAC,eAAe,EAAE,KAAK,EAAC,CAC3B,CACJ,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;;;;OAIG;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,8DAA8D;QAC9D,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;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EACR,gBAAgB,EAChB,QAAQ,EACR,YAAY,EACZ,cAAc,EACd,IAAI,EACJ,mBAAmB,EACnB,QAAQ,EACR,cAAc,EACd,GAAG,IAAI,EACiB;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,OAAO,EAAE;YACrC,gBAAgB;YAChB,QAAQ;YACR,YAAY;YACZ,IAAI;YACJ,mBAAmB;YACnB,QAAQ;YACR,cAAc;YACd,cAAc,EAAE,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SAC5D,CAAC,EACF,IAAI,EACJ,EAAC,kBAAkB,EAAE,MAAM,EAAC,CAC/B,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,MAA4B;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CACV,GAAG,MAAM,CAAC,OAAO,WAAW,EAC5B;YACI,GAAG,MAAM;YACT,cAAc,EAAE,MAAM,CAAC,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SACnE,EACD,EAAC,eAAe,EAAE,KAAK,EAAC,CAC3B,CACJ,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,MAAiC;QACzC,MAAM,EAAC,cAAc,EAAE,cAAc,EAAE,GAAG,cAAc,EAAC,GAAG,MAAM,CAAC;QAEnE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,QAAQ,EAAE;YACtC,cAAc,EAAE,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;YACzD,cAAc;SACjB,CAAC,EACF,cAAc,CACjB,CAAC;IACN,CAAC;;AApJL,yBAqJC"}
|
|
@@ -2,9 +2,13 @@ import API from '../../APICore.js';
|
|
|
2
2
|
import Resource from '../Resource.js';
|
|
3
3
|
export default class Search extends Resource {
|
|
4
4
|
static baseUrl = `/rest/search/v2`;
|
|
5
|
+
static authenticationBaseUrl = `/rest/organizations/${API.orgPlaceholder}/authentication`;
|
|
5
6
|
createToken(tokenParams) {
|
|
6
7
|
return this.api.post(`${Search.baseUrl}/token?organizationId=${API.orgPlaceholder}`, tokenParams);
|
|
7
8
|
}
|
|
9
|
+
listSamlIdentityProviders() {
|
|
10
|
+
return this.api.get(`${Search.authenticationBaseUrl}/saml`);
|
|
11
|
+
}
|
|
8
12
|
listFields(params) {
|
|
9
13
|
return this.api.get(this.buildPath(`${Search.baseUrl}/fields`, {
|
|
10
14
|
...params,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Search.js","sourceRoot":"","sources":["../../../../src/resources/Search/Search.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AACnC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"Search.js","sourceRoot":"","sources":["../../../../src/resources/Search/Search.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AACnC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAkBtC,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,QAAQ;IACxC,MAAM,CAAC,OAAO,GAAG,iBAAiB,CAAC;IACnC,MAAM,CAAC,qBAAqB,GAAG,uBAAuB,GAAG,CAAC,cAAc,iBAAiB,CAAC;IAE1F,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,yBAAyB;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAkC,GAAG,MAAM,CAAC,qBAAqB,OAAO,CAAC,CAAC;IACjG,CAAC;IAED,UAAU,CAAC,MAA+B;QACtC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CACV,GAAG,MAAM,CAAC,OAAO,SAAS,EAC1B;YACI,GAAG,MAAM;YACT,cAAc,EAAE,MAAM,EAAE,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SACpE,EACD,EAAC,eAAe,EAAE,KAAK,EAAC,CAC3B,CACJ,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;;;;OAIG;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,8DAA8D;QAC9D,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;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EACR,gBAAgB,EAChB,QAAQ,EACR,YAAY,EACZ,cAAc,EACd,IAAI,EACJ,mBAAmB,EACnB,QAAQ,EACR,cAAc,EACd,GAAG,IAAI,EACiB;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,OAAO,EAAE;YACrC,gBAAgB;YAChB,QAAQ;YACR,YAAY;YACZ,IAAI;YACJ,mBAAmB;YACnB,QAAQ;YACR,cAAc;YACd,cAAc,EAAE,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SAC5D,CAAC,EACF,IAAI,EACJ,EAAC,kBAAkB,EAAE,MAAM,EAAC,CAC/B,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,MAA4B;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CACV,GAAG,MAAM,CAAC,OAAO,WAAW,EAC5B;YACI,GAAG,MAAM;YACT,cAAc,EAAE,MAAM,CAAC,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;SACnE,EACD,EAAC,eAAe,EAAE,KAAK,EAAC,CAC3B,CACJ,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,MAAiC;QACzC,MAAM,EAAC,cAAc,EAAE,cAAc,EAAE,GAAG,cAAc,EAAC,GAAG,MAAM,CAAC;QAEnE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,QAAQ,EAAE;YACtC,cAAc,EAAE,cAAc,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc;YACzD,cAAc;SACjB,CAAC,EACF,cAAc,CACjB,CAAC;IACN,CAAC"}
|
|
@@ -140,6 +140,10 @@ export interface IAccesses {
|
|
|
140
140
|
* @default false
|
|
141
141
|
*/
|
|
142
142
|
sharingDomainEnabled?: boolean;
|
|
143
|
+
/**
|
|
144
|
+
* The name of the Search API SAML identity provider used to authenticate Search Page viewers.
|
|
145
|
+
*/
|
|
146
|
+
samlProvider?: string;
|
|
143
147
|
}
|
|
144
148
|
export interface ISortCriteria {
|
|
145
149
|
/**
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
import Resource from '../Resource.js';
|
|
2
|
-
import { ItemPreviewHtmlParameters, ListFieldValuesResponse, RestFacetSearchParameters, RestFacetSearchResponse, RestQueryParams, RestQueryResult, RestTokenParams, SearchListFieldsParams, SearchListFieldsResponse, SearchResponse, SingleItemParameters, TokenModel } from './SearchInterfaces.js';
|
|
2
|
+
import { ItemPreviewHtmlParameters, ListFieldValuesResponse, RestFacetSearchParameters, RestFacetSearchResponse, RestQueryParams, RestQueryResult, RestTokenParams, SearchApiSamlIdentityProvider, SearchListFieldsParams, SearchListFieldsResponse, SearchResponse, SingleItemParameters, TokenModel } from './SearchInterfaces.js';
|
|
3
3
|
import { ListFieldValuesBodyQueryParams, PostSearchQuerySuggestBodyParams } from './index.js';
|
|
4
4
|
export default class Search extends Resource {
|
|
5
5
|
static baseUrl: string;
|
|
6
|
+
static authenticationBaseUrl: string;
|
|
6
7
|
createToken(tokenParams: RestTokenParams): Promise<TokenModel>;
|
|
8
|
+
listSamlIdentityProviders(): Promise<SearchApiSamlIdentityProvider[]>;
|
|
7
9
|
listFields(params?: SearchListFieldsParams): Promise<SearchListFieldsResponse>;
|
|
8
10
|
getFieldValues(fieldName: string, params?: ListFieldValuesBodyQueryParams): Promise<ListFieldValuesResponse>;
|
|
9
11
|
query(restQueryParameters: RestQueryParams): Promise<SearchResponse>;
|
|
@@ -2509,4 +2509,14 @@ export interface RestFacetSearchResponse {
|
|
|
2509
2509
|
*/
|
|
2510
2510
|
moreValuesAvailable: boolean;
|
|
2511
2511
|
}
|
|
2512
|
+
export interface SearchApiSamlIdentityProvider {
|
|
2513
|
+
/**
|
|
2514
|
+
* Unique identifier of the SAML provider.
|
|
2515
|
+
*/
|
|
2516
|
+
id: string;
|
|
2517
|
+
/**
|
|
2518
|
+
* Unique name of the SAML proivder used to connect via the Search API.
|
|
2519
|
+
*/
|
|
2520
|
+
name: string;
|
|
2521
|
+
}
|
|
2512
2522
|
export {};
|