@algolia/client-search 5.0.0-alpha.91 → 5.0.0-alpha.97
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/client-search.cjs +82 -82
- package/dist/client-search.esm.browser.js +125 -101
- package/dist/client-search.esm.node.js +82 -82
- package/dist/client-search.umd.js +2 -2
- package/dist/model/clientMethodProps.d.ts +49 -49
- package/dist/model/clientMethodProps.d.ts.map +1 -1
- package/dist/model/highlightResult.d.ts +1 -1
- package/dist/model/highlightResult.d.ts.map +1 -1
- package/dist/model/searchForFacetValuesResponse.d.ts +8 -0
- package/dist/model/searchForFacetValuesResponse.d.ts.map +1 -1
- package/dist/model/searchResponses.d.ts +2 -2
- package/dist/model/searchResponses.d.ts.map +1 -1
- package/dist/model/searchResult.d.ts +1 -1
- package/dist/model/searchResult.d.ts.map +1 -1
- package/dist/model/snippetResult.d.ts +1 -1
- package/dist/model/snippetResult.d.ts.map +1 -1
- package/dist/model/userHighlightResult.d.ts +2 -8
- package/dist/model/userHighlightResult.d.ts.map +1 -1
- package/dist/src/searchClient.d.ts +40 -40
- package/dist/src/searchClient.d.ts.map +1 -1
- package/model/clientMethodProps.ts +52 -52
- package/model/highlightResult.ts +3 -1
- package/model/searchForFacetValuesResponse.ts +10 -0
- package/model/searchResponses.ts +2 -2
- package/model/searchResult.ts +3 -1
- package/model/snippetResult.ts +3 -1
- package/model/userHighlightResult.ts +2 -8
- package/package.json +7 -7
|
@@ -1,12 +1,6 @@
|
|
|
1
1
|
import type { HighlightResult } from './highlightResult';
|
|
2
2
|
export type UserHighlightResult = {
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
*/
|
|
6
|
-
userID: Record<string, HighlightResult>;
|
|
7
|
-
/**
|
|
8
|
-
* Show highlighted section and words matched on a query.
|
|
9
|
-
*/
|
|
10
|
-
clusterName: Record<string, HighlightResult>;
|
|
3
|
+
userID: HighlightResult;
|
|
4
|
+
clusterName: HighlightResult;
|
|
11
5
|
};
|
|
12
6
|
//# sourceMappingURL=userHighlightResult.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"userHighlightResult.d.ts","sourceRoot":"","sources":["../../model/userHighlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,mBAAmB,GAAG;IAChC
|
|
1
|
+
{"version":3,"file":"userHighlightResult.d.ts","sourceRoot":"","sources":["../../model/userHighlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,eAAe,CAAC;IAExB,WAAW,EAAE,eAAe,CAAC;CAC9B,CAAC"}
|
|
@@ -4,7 +4,7 @@ import type { ApiKey } from '../model/apiKey';
|
|
|
4
4
|
import type { BatchParams } from '../model/batchParams';
|
|
5
5
|
import type { BatchResponse } from '../model/batchResponse';
|
|
6
6
|
import type { BrowseResponse } from '../model/browseResponse';
|
|
7
|
-
import type { BrowseOptions, WaitForTaskOptions, WaitForApiKeyOptions, AddOrUpdateObjectProps, AssignUserIdProps, BatchProps, BatchAssignUserIdsProps, BatchDictionaryEntriesProps, BrowseProps, ClearAllSynonymsProps, ClearObjectsProps, ClearRulesProps,
|
|
7
|
+
import type { BrowseOptions, WaitForTaskOptions, WaitForApiKeyOptions, AddOrUpdateObjectProps, AssignUserIdProps, BatchProps, BatchAssignUserIdsProps, BatchDictionaryEntriesProps, BrowseProps, ClearAllSynonymsProps, ClearObjectsProps, ClearRulesProps, CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteApiKeyProps, DeleteByProps, DeleteIndexProps, DeleteObjectProps, DeleteRuleProps, DeleteSourceProps, DeleteSynonymProps, GetApiKeyProps, GetLogsProps, GetObjectProps, GetRuleProps, GetSettingsProps, GetSynonymProps, GetTaskProps, GetUserIdProps, HasPendingMappingsProps, ListIndicesProps, ListUserIdsProps, OperationIndexProps, PartialUpdateObjectProps, RemoveUserIdProps, ReplaceSourcesProps, RestoreApiKeyProps, SaveObjectProps, SaveRuleProps, SaveRulesProps, SaveSynonymProps, SaveSynonymsProps, LegacySearchMethodProps, SearchDictionaryEntriesProps, SearchForFacetValuesProps, SearchRulesProps, SearchSingleIndexProps, SearchSynonymsProps, SetSettingsProps, UpdateApiKeyProps } from '../model/clientMethodProps';
|
|
8
8
|
import type { CreatedAtResponse } from '../model/createdAtResponse';
|
|
9
9
|
import type { DeleteApiKeyResponse } from '../model/deleteApiKeyResponse';
|
|
10
10
|
import type { DeleteSourceResponse } from '../model/deleteSourceResponse';
|
|
@@ -45,7 +45,7 @@ import type { UpdatedAtResponse } from '../model/updatedAtResponse';
|
|
|
45
45
|
import type { UpdatedAtWithObjectIdResponse } from '../model/updatedAtWithObjectIdResponse';
|
|
46
46
|
import type { UpdatedRuleResponse } from '../model/updatedRuleResponse';
|
|
47
47
|
import type { UserId } from '../model/userId';
|
|
48
|
-
export declare const apiClientVersion = "5.0.0-alpha.
|
|
48
|
+
export declare const apiClientVersion = "5.0.0-alpha.97";
|
|
49
49
|
export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
|
|
50
50
|
transporter: import("@algolia/client-common").Transporter;
|
|
51
51
|
/**
|
|
@@ -259,12 +259,44 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
259
259
|
* This method allow you to send requests to the Algolia REST API.
|
|
260
260
|
*
|
|
261
261
|
* @summary Send requests to the Algolia REST API.
|
|
262
|
-
* @param
|
|
263
|
-
* @param
|
|
264
|
-
* @param
|
|
262
|
+
* @param customDelete - The customDelete object.
|
|
263
|
+
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
264
|
+
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
265
265
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
266
266
|
*/
|
|
267
|
-
|
|
267
|
+
customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
268
|
+
/**
|
|
269
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
270
|
+
*
|
|
271
|
+
* @summary Send requests to the Algolia REST API.
|
|
272
|
+
* @param customGet - The customGet object.
|
|
273
|
+
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
274
|
+
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
275
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
276
|
+
*/
|
|
277
|
+
customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
278
|
+
/**
|
|
279
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
280
|
+
*
|
|
281
|
+
* @summary Send requests to the Algolia REST API.
|
|
282
|
+
* @param customPost - The customPost object.
|
|
283
|
+
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
284
|
+
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
285
|
+
* @param customPost.body - Parameters to send with the custom request.
|
|
286
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
287
|
+
*/
|
|
288
|
+
customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
289
|
+
/**
|
|
290
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
291
|
+
*
|
|
292
|
+
* @summary Send requests to the Algolia REST API.
|
|
293
|
+
* @param customPut - The customPut object.
|
|
294
|
+
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
295
|
+
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
296
|
+
* @param customPut.body - Parameters to send with the custom request.
|
|
297
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
298
|
+
*/
|
|
299
|
+
customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
268
300
|
/**
|
|
269
301
|
* Delete an existing API key. The request must be authenticated with the admin API key.
|
|
270
302
|
*
|
|
@@ -334,16 +366,6 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
334
366
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
335
367
|
*/
|
|
336
368
|
deleteSynonym({ indexName, objectID, forwardToReplicas }: DeleteSynonymProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
|
|
337
|
-
/**
|
|
338
|
-
* This method allow you to send requests to the Algolia REST API.
|
|
339
|
-
*
|
|
340
|
-
* @summary Send requests to the Algolia REST API.
|
|
341
|
-
* @param get - The get object.
|
|
342
|
-
* @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
343
|
-
* @param get.parameters - Query parameters to apply to the current query.
|
|
344
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
345
|
-
*/
|
|
346
|
-
get({ path, parameters }: GetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
347
369
|
/**
|
|
348
370
|
* Get the permissions and restrictions of a specific API key. When authenticating with the admin API key, you can request information for any of your application\'s keys. When authenticating with other API keys, you can only retrieve information for that key.
|
|
349
371
|
*
|
|
@@ -533,28 +555,6 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
533
555
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
534
556
|
*/
|
|
535
557
|
partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }: PartialUpdateObjectProps, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
|
|
536
|
-
/**
|
|
537
|
-
* This method allow you to send requests to the Algolia REST API.
|
|
538
|
-
*
|
|
539
|
-
* @summary Send requests to the Algolia REST API.
|
|
540
|
-
* @param post - The post object.
|
|
541
|
-
* @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
542
|
-
* @param post.parameters - Query parameters to apply to the current query.
|
|
543
|
-
* @param post.body - Parameters to send with the custom request.
|
|
544
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
545
|
-
*/
|
|
546
|
-
post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
547
|
-
/**
|
|
548
|
-
* This method allow you to send requests to the Algolia REST API.
|
|
549
|
-
*
|
|
550
|
-
* @summary Send requests to the Algolia REST API.
|
|
551
|
-
* @param put - The put object.
|
|
552
|
-
* @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
553
|
-
* @param put.parameters - Query parameters to apply to the current query.
|
|
554
|
-
* @param put.body - Parameters to send with the custom request.
|
|
555
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
556
|
-
*/
|
|
557
|
-
put({ path, parameters, body }: PutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
558
558
|
/**
|
|
559
559
|
* Remove a userID and its associated data from the multi-clusters.
|
|
560
560
|
*
|
|
@@ -647,7 +647,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
647
647
|
* @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
|
|
648
648
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
649
649
|
*/
|
|
650
|
-
search(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<SearchResponses
|
|
650
|
+
search<T_4>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<SearchResponses<T_4>>;
|
|
651
651
|
/**
|
|
652
652
|
* Search for standard and [custom](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/) entries in the [stop words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plurals](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), or [segmentation (compounds)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) dictionaries.
|
|
653
653
|
*
|
|
@@ -688,7 +688,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
688
688
|
* @param searchSingleIndex.searchParams - The searchParams object.
|
|
689
689
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
690
690
|
*/
|
|
691
|
-
searchSingleIndex<
|
|
691
|
+
searchSingleIndex<T_5>({ indexName, searchParams }: SearchSingleIndexProps, requestOptions?: RequestOptions): Promise<SearchResponse<T_5>>;
|
|
692
692
|
/**
|
|
693
693
|
* Search for synonyms in your index. You can control and filter the search with parameters. To get all synonyms, send an empty request body.
|
|
694
694
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchClient.d.ts","sourceRoot":"","sources":["../../src/searchClient.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEd,QAAQ,EAET,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EACV,aAAa,EACb,kBAAkB,EAClB,oBAAoB,EACpB,sBAAsB,EACtB,iBAAiB,EACjB,UAAU,EACV,uBAAuB,EACvB,2BAA2B,EAC3B,WAAW,EACX,qBAAqB,EACrB,iBAAiB,EACjB,eAAe,EACf,
|
|
1
|
+
{"version":3,"file":"searchClient.d.ts","sourceRoot":"","sources":["../../src/searchClient.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEd,QAAQ,EAET,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EACV,aAAa,EACb,kBAAkB,EAClB,oBAAoB,EACpB,sBAAsB,EACtB,iBAAiB,EACjB,UAAU,EACV,uBAAuB,EACvB,2BAA2B,EAC3B,WAAW,EACX,qBAAqB,EACrB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,cAAc,EACd,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,wBAAwB,EACxB,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,uBAAuB,EACvB,4BAA4B,EAC5B,yBAAyB,EACzB,gBAAgB,EAChB,sBAAsB,EACtB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE9C,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAsCjD,wBAAgB,kBAAkB,CAAC,EACjC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;;;OAUG;6DAQE,kBAAkB,mBACJ,cAAc,GAC9B,QAAQ,eAAe,CAAC;IAgB3B;;;;;;;;;;;OAWG;oEASE,oBAAoB,mBACN,cAAc,GAC9B,QAAQ,QAAQ,GAAG,iBAAiB,CAAC;IAoDxC;;;;;;;;;;OAUG;0TAOgB,cAAc;IAoBjC;;;;;;;;;;OAUG;yEAME,cAAc,mBAAmB,CAAC,GAAG,gBAAgB,mBACvC,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA0B/B;;;;;;;;;OASG;kFAOE,cAAc,sBAAsB,CAAC,GAAG,mBAAmB,mBAC7C,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IAwBlC;;;;;;;OAOG;2CAEmB,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc;;;IAOjC;;;;;;;OAOG;wCAEmB,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc,GAC9B,QAAQ;QAAE,OAAO,EAAE,4BAA4B,EAAE,CAAA;KAAE,CAAC;IAKvD;;;;;;OAMG;sBAEO,MAAM,mBACG,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;;OASG;qDAE8B,sBAAsB,mBACpC,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAoCzC;;;;;;OAMG;yBAEO,MAAM,mBACG,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;OAQG;yDAEuC,iBAAiB,mBACxC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAsC7B;;;;;;;;OAQG;2CAEgC,UAAU,mBAC1B,cAAc,GAC9B,QAAQ,aAAa,CAAC;IAqCzB;;;;;;;;OAQG;qEAE6C,uBAAuB,mBACpD,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA2C7B;;;;;;;;OAQG;8EAKE,2BAA2B,mBACb,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAqC7B;;;;;;;;OAQG;6CAE4B,WAAW,mBACvB,cAAc;IA0BjC;;;;;;;;OAQG;uDAEiC,qBAAqB,mBACtC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;OAOG;gCAEc,iBAAiB,mBACf,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;iDAEiC,eAAe,mBAChC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;OAQG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;;OASG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;OAOG;0BAEQ,iBAAiB,mBACT,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;OAQG;4CAE8B,aAAa,mBAC3B,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA+B7B;;;;;;;OAOG;+BAEc,gBAAgB,mBACd,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;0CAEwB,iBAAiB,mBACzB,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA6B7B;;;;;;;;;OASG;2DAE2C,eAAe,mBAC1C,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAiC7B;;;;;;;OAOG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;;OASG;8DAE2C,kBAAkB,mBAC7C,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAiC7B;;;;;;;OAOG;uBAEQ,cAAc,mBACN,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;OAKG;4CAEgB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,SAAS,CAAC,CAAC;IAerC;;;;;OAKG;2CAEgB,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAezC;;;;;;;;;;OAUG;kDAEoC,YAAY,mBACjC,cAAc,GAAG,SAAS,GACzC,QAAQ,eAAe,CAAC;IA+B3B;;;;;;;;;OASG;6DAE8C,cAAc,mBAC5C,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,MAAM,CAAC,CAAC;IAiClC;;;;;;OAMG;sCAEiB,gBAAgB,mBACjB,cAAc;IA+BjC;;;;;;;;OAQG;qCAEwB,YAAY,mBACpB,cAAc,GAC9B,QAAQ,IAAI,CAAC;IA6BhB;;;;;;;OAOG;+BAEc,gBAAgB,mBACd,cAAc,GAC9B,QAAQ,aAAa,CAAC;IAwBzB;;;;;OAKG;gCACyB,cAAc,GAAG,QAAQ,MAAM,EAAE,CAAC;IAe9D;;;;;;;;OAQG;wCAEwB,eAAe,mBACvB,cAAc,GAC9B,QAAQ,UAAU,CAAC;IA6BtB;;;;;;;;OAQG;mCAEsB,YAAY,mBAClB,cAAc,GAC9B,QAAQ,eAAe,CAAC;IA6B3B;;;;;OAKG;mCAEgB,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAejC;;;;;;;OAOG;0BAEW,cAAc,mBACT,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAwBlB;;;;;;;OAOG;yCAEgB,uBAAuB,mBACxB,cAAc,GAAG,SAAS,GACzC,QAAQ,0BAA0B,CAAC;IAmBtC;;;;;OAKG;iCAC0B,cAAc,GAAG,QAAQ,mBAAmB,CAAC;IAe1E;;;;;OAKG;kCAEgB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAehC;;;;;;;;OAQG;wCAEsB,gBAAgB,mBACvB,cAAc,GAAG,SAAS,GACzC,QAAQ,mBAAmB,CAAC;IAuB/B;;;;;;;;OAQG;wCAEsB,gBAAgB,mBACvB,cAAc,GAAG,SAAS,GACzC,QAAQ,mBAAmB,CAAC;IAuB/B;;;;;;OAMG;+BAEY,WAAW,mBACP,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IA4BjC;;;;;;;;OAQG;wDAEoC,mBAAmB,mBACvC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA0C7B;;;;;;;;;;OAUG;yFAOE,wBAAwB,mBACV,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAwCzC;;;;;;;OAOG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;OAOG;+BAEW,mBAAmB,mBACd,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAsBjC;;;;;;;OAOG;2BAEQ,kBAAkB,mBACV,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;oCAEoB,eAAe,mBACnB,cAAc,GAC9B,QAAQ,kBAAkB,CAAC;IA+B9B;;;;;;;;;;OAUG;+DAEiD,aAAa,mBAC9C,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA8C/B;;;;;;;;;;OAUG;4EAOE,cAAc,mBACA,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAuC7B;;;;;;;;;;OAUG;wEAEuD,gBAAgB,mBACvD,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IAmD/B;;;;;;;;;;OAUG;yFAOE,iBAAiB,mBACH,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwC7B;;;;;;OAMG;oCAEmB,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc;IAwDjC;;;;;;;;OAQG;gFAKE,4BAA4B,mBACd,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAuC7B;;;;;;;;;OASG;iFAME,yBAAyB,mBACX,cAAc,GAC9B,QAAQ,4BAA4B,CAAC;IAgCxC;;;;;;;;OAQG;kDAEiC,gBAAgB,mBACjC,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA2B/B;;;;;;;;OAQG;wDAE4B,sBAAsB,mBAClC,cAAc;IA4BjC;;;;;;;;;;;OAWG;kFAQE,mBAAmB,mBACL,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IAuClC;;;;;;OAMG;uCAEoB,mBAAmB,mBACvB,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IA8BjC;;;;;;OAMG;oDAEyB,wBAAwB,mBACjC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;;OASG;iEAEgD,gBAAgB,mBAChD,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAmC7B;;;;;;;;OAQG;kCAEgB,iBAAiB,mBACjB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;EAqCnC;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC"}
|
|
@@ -139,9 +139,9 @@ export type ClearRulesProps = {
|
|
|
139
139
|
};
|
|
140
140
|
|
|
141
141
|
/**
|
|
142
|
-
* Properties for the `
|
|
142
|
+
* Properties for the `customDelete` method.
|
|
143
143
|
*/
|
|
144
|
-
export type
|
|
144
|
+
export type CustomDeleteProps = {
|
|
145
145
|
/**
|
|
146
146
|
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
147
147
|
*/
|
|
@@ -152,6 +152,56 @@ export type DelProps = {
|
|
|
152
152
|
parameters?: Record<string, any>;
|
|
153
153
|
};
|
|
154
154
|
|
|
155
|
+
/**
|
|
156
|
+
* Properties for the `customGet` method.
|
|
157
|
+
*/
|
|
158
|
+
export type CustomGetProps = {
|
|
159
|
+
/**
|
|
160
|
+
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
161
|
+
*/
|
|
162
|
+
path: string;
|
|
163
|
+
/**
|
|
164
|
+
* Query parameters to apply to the current query.
|
|
165
|
+
*/
|
|
166
|
+
parameters?: Record<string, any>;
|
|
167
|
+
};
|
|
168
|
+
|
|
169
|
+
/**
|
|
170
|
+
* Properties for the `customPost` method.
|
|
171
|
+
*/
|
|
172
|
+
export type CustomPostProps = {
|
|
173
|
+
/**
|
|
174
|
+
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
175
|
+
*/
|
|
176
|
+
path: string;
|
|
177
|
+
/**
|
|
178
|
+
* Query parameters to apply to the current query.
|
|
179
|
+
*/
|
|
180
|
+
parameters?: Record<string, any>;
|
|
181
|
+
/**
|
|
182
|
+
* Parameters to send with the custom request.
|
|
183
|
+
*/
|
|
184
|
+
body?: Record<string, any>;
|
|
185
|
+
};
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
* Properties for the `customPut` method.
|
|
189
|
+
*/
|
|
190
|
+
export type CustomPutProps = {
|
|
191
|
+
/**
|
|
192
|
+
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
193
|
+
*/
|
|
194
|
+
path: string;
|
|
195
|
+
/**
|
|
196
|
+
* Query parameters to apply to the current query.
|
|
197
|
+
*/
|
|
198
|
+
parameters?: Record<string, any>;
|
|
199
|
+
/**
|
|
200
|
+
* Parameters to send with the custom request.
|
|
201
|
+
*/
|
|
202
|
+
body?: Record<string, any>;
|
|
203
|
+
};
|
|
204
|
+
|
|
155
205
|
/**
|
|
156
206
|
* Properties for the `deleteApiKey` method.
|
|
157
207
|
*/
|
|
@@ -243,20 +293,6 @@ export type DeleteSynonymProps = {
|
|
|
243
293
|
forwardToReplicas?: boolean;
|
|
244
294
|
};
|
|
245
295
|
|
|
246
|
-
/**
|
|
247
|
-
* Properties for the `get` method.
|
|
248
|
-
*/
|
|
249
|
-
export type GetProps = {
|
|
250
|
-
/**
|
|
251
|
-
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
252
|
-
*/
|
|
253
|
-
path: string;
|
|
254
|
-
/**
|
|
255
|
-
* Query parameters to apply to the current query.
|
|
256
|
-
*/
|
|
257
|
-
parameters?: Record<string, any>;
|
|
258
|
-
};
|
|
259
|
-
|
|
260
296
|
/**
|
|
261
297
|
* Properties for the `getApiKey` method.
|
|
262
298
|
*/
|
|
@@ -440,42 +476,6 @@ export type PartialUpdateObjectProps = {
|
|
|
440
476
|
createIfNotExists?: boolean;
|
|
441
477
|
};
|
|
442
478
|
|
|
443
|
-
/**
|
|
444
|
-
* Properties for the `post` method.
|
|
445
|
-
*/
|
|
446
|
-
export type PostProps = {
|
|
447
|
-
/**
|
|
448
|
-
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
449
|
-
*/
|
|
450
|
-
path: string;
|
|
451
|
-
/**
|
|
452
|
-
* Query parameters to apply to the current query.
|
|
453
|
-
*/
|
|
454
|
-
parameters?: Record<string, any>;
|
|
455
|
-
/**
|
|
456
|
-
* Parameters to send with the custom request.
|
|
457
|
-
*/
|
|
458
|
-
body?: Record<string, any>;
|
|
459
|
-
};
|
|
460
|
-
|
|
461
|
-
/**
|
|
462
|
-
* Properties for the `put` method.
|
|
463
|
-
*/
|
|
464
|
-
export type PutProps = {
|
|
465
|
-
/**
|
|
466
|
-
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
467
|
-
*/
|
|
468
|
-
path: string;
|
|
469
|
-
/**
|
|
470
|
-
* Query parameters to apply to the current query.
|
|
471
|
-
*/
|
|
472
|
-
parameters?: Record<string, any>;
|
|
473
|
-
/**
|
|
474
|
-
* Parameters to send with the custom request.
|
|
475
|
-
*/
|
|
476
|
-
body?: Record<string, any>;
|
|
477
|
-
};
|
|
478
|
-
|
|
479
479
|
/**
|
|
480
480
|
* Properties for the `removeUserId` method.
|
|
481
481
|
*/
|
package/model/highlightResult.ts
CHANGED
|
@@ -4,4 +4,14 @@ import type { FacetHits } from './facetHits';
|
|
|
4
4
|
|
|
5
5
|
export type SearchForFacetValuesResponse = {
|
|
6
6
|
facetHits: FacetHits[];
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* See the `facetsCount` field of the `exhaustive` object in the response.
|
|
10
|
+
*/
|
|
11
|
+
exhaustiveFacetsCount: boolean;
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Time the server took to process the request, in milliseconds.
|
|
15
|
+
*/
|
|
16
|
+
processingTimeMS?: number;
|
|
7
17
|
};
|
package/model/searchResponses.ts
CHANGED
package/model/searchResult.ts
CHANGED
|
@@ -3,4 +3,6 @@
|
|
|
3
3
|
import type { SearchForFacetValuesResponse } from './searchForFacetValuesResponse';
|
|
4
4
|
import type { SearchResponse } from './searchResponse';
|
|
5
5
|
|
|
6
|
-
export type SearchResult =
|
|
6
|
+
export type SearchResult<T = Record<string, any>> =
|
|
7
|
+
| SearchForFacetValuesResponse
|
|
8
|
+
| SearchResponse<T>;
|
package/model/snippetResult.ts
CHANGED
|
@@ -3,13 +3,7 @@
|
|
|
3
3
|
import type { HighlightResult } from './highlightResult';
|
|
4
4
|
|
|
5
5
|
export type UserHighlightResult = {
|
|
6
|
-
|
|
7
|
-
* Show highlighted section and words matched on a query.
|
|
8
|
-
*/
|
|
9
|
-
userID: Record<string, HighlightResult>;
|
|
6
|
+
userID: HighlightResult;
|
|
10
7
|
|
|
11
|
-
|
|
12
|
-
* Show highlighted section and words matched on a query.
|
|
13
|
-
*/
|
|
14
|
-
clusterName: Record<string, HighlightResult>;
|
|
8
|
+
clusterName: HighlightResult;
|
|
15
9
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@algolia/client-search",
|
|
3
|
-
"version": "5.0.0-alpha.
|
|
3
|
+
"version": "5.0.0-alpha.97",
|
|
4
4
|
"description": "JavaScript client for client-search",
|
|
5
5
|
"repository": "algolia/algoliasearch-client-javascript",
|
|
6
6
|
"license": "MIT",
|
|
@@ -39,14 +39,14 @@
|
|
|
39
39
|
"clean": "rm -rf ./dist || true"
|
|
40
40
|
},
|
|
41
41
|
"dependencies": {
|
|
42
|
-
"@algolia/client-common": "5.0.0-alpha.
|
|
43
|
-
"@algolia/requester-browser-xhr": "5.0.0-alpha.
|
|
44
|
-
"@algolia/requester-node-http": "5.0.0-alpha.
|
|
42
|
+
"@algolia/client-common": "5.0.0-alpha.98",
|
|
43
|
+
"@algolia/requester-browser-xhr": "5.0.0-alpha.98",
|
|
44
|
+
"@algolia/requester-node-http": "5.0.0-alpha.98"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
|
-
"@types/node": "20.
|
|
48
|
-
"rollup": "4.
|
|
49
|
-
"typescript": "5.
|
|
47
|
+
"@types/node": "20.11.1",
|
|
48
|
+
"rollup": "4.9.5",
|
|
49
|
+
"typescript": "5.3.3"
|
|
50
50
|
},
|
|
51
51
|
"engines": {
|
|
52
52
|
"node": ">= 14.0.0"
|