@algolia/client-search 5.25.0 → 5.27.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.
Files changed (24) hide show
  1. package/README.md +4 -4
  2. package/dist/browser.d.ts +71 -13
  3. package/dist/builds/browser.js +5 -5
  4. package/dist/builds/browser.js.map +1 -1
  5. package/dist/builds/browser.min.js +1 -1
  6. package/dist/builds/browser.min.js.map +1 -1
  7. package/dist/builds/browser.umd.js +2 -2
  8. package/dist/builds/fetch.js +5 -5
  9. package/dist/builds/fetch.js.map +1 -1
  10. package/dist/builds/node.cjs +5 -5
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +6 -6
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/builds/worker.js +5 -5
  15. package/dist/builds/worker.js.map +1 -1
  16. package/dist/fetch.d.ts +71 -13
  17. package/dist/node.d.cts +71 -13
  18. package/dist/node.d.ts +71 -13
  19. package/dist/src/searchClient.cjs +5 -5
  20. package/dist/src/searchClient.cjs.map +1 -1
  21. package/dist/src/searchClient.js +5 -5
  22. package/dist/src/searchClient.js.map +1 -1
  23. package/dist/worker.d.ts +71 -13
  24. package/package.json +8 -8
package/README.md CHANGED
@@ -41,11 +41,11 @@ All of our clients comes with type definition, and are available for both browse
41
41
  ### With a package manager
42
42
 
43
43
  ```bash
44
- yarn add @algolia/client-search@5.25.0
44
+ yarn add @algolia/client-search@5.27.0
45
45
  # or
46
- npm install @algolia/client-search@5.25.0
46
+ npm install @algolia/client-search@5.27.0
47
47
  # or
48
- pnpm add @algolia/client-search@5.25.0
48
+ pnpm add @algolia/client-search@5.27.0
49
49
  ```
50
50
 
51
51
  ### Without a package manager
@@ -53,7 +53,7 @@ pnpm add @algolia/client-search@5.25.0
53
53
  Add the following JavaScript snippet to the <head> of your website:
54
54
 
55
55
  ```html
56
- <script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.25.0/dist/builds/browser.umd.js"></script>
56
+ <script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.27.0/dist/builds/browser.umd.js"></script>
57
57
  ```
58
58
 
59
59
  ### Usage
package/dist/browser.d.ts CHANGED
@@ -1240,7 +1240,7 @@ type SemanticSearch = {
1240
1240
  /**
1241
1241
  * - `min`. Return matches with the lowest number of typos. For example, if you have matches without typos, only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos. With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.
1242
1242
  */
1243
- type TypoToleranceEnum = 'min' | 'strict';
1243
+ type TypoToleranceEnum = 'min' | 'strict' | 'true' | 'false';
1244
1244
 
1245
1245
  /**
1246
1246
  * Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active.
@@ -2269,7 +2269,7 @@ type SecuredApiKeyRestrictions = {
2269
2269
  /**
2270
2270
  * Properties for the `addOrUpdateObject` method.
2271
2271
  */
2272
- type AddOrUpdateObjectProps = {
2272
+ type AddOrUpdateObjectProps<T extends object> = {
2273
2273
  /**
2274
2274
  * Name of the index on which to perform the operation.
2275
2275
  */
@@ -2281,7 +2281,7 @@ type AddOrUpdateObjectProps = {
2281
2281
  /**
2282
2282
  * The record. A schemaless object with attributes that are useful in the context of search and discovery.
2283
2283
  */
2284
- body: Record<string, unknown>;
2284
+ body: T;
2285
2285
  };
2286
2286
  /**
2287
2287
  * Properties for the `assignUserId` method.
@@ -2729,7 +2729,7 @@ type RestoreApiKeyProps = {
2729
2729
  /**
2730
2730
  * Properties for the `saveObject` method.
2731
2731
  */
2732
- type SaveObjectProps = {
2732
+ type SaveObjectProps<T extends object> = {
2733
2733
  /**
2734
2734
  * Name of the index on which to perform the operation.
2735
2735
  */
@@ -2737,7 +2737,7 @@ type SaveObjectProps = {
2737
2737
  /**
2738
2738
  * The record. A schemaless object with attributes that are useful in the context of search and discovery.
2739
2739
  */
2740
- body: Record<string, unknown>;
2740
+ body: T;
2741
2741
  };
2742
2742
  /**
2743
2743
  * Properties for the `saveRule` method.
@@ -3047,7 +3047,7 @@ type AccountCopyIndexOptions = {
3047
3047
  destinationIndexName: string;
3048
3048
  };
3049
3049
 
3050
- declare const apiClientVersion = "5.25.0";
3050
+ declare const apiClientVersion = "5.27.0";
3051
3051
  declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
3052
3052
  transporter: _algolia_client_common.Transporter;
3053
3053
  /**
@@ -3174,7 +3174,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3174
3174
  * @param saveObjects - The `saveObjects` object.
3175
3175
  * @param saveObjects.indexName - The `indexName` to save `objects` in.
3176
3176
  * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
3177
- * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
3177
+ * @param saveObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
3178
3178
  * @param saveObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
3179
3179
  * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
3180
3180
  */
@@ -3186,7 +3186,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3186
3186
  * @param deleteObjects - The `deleteObjects` object.
3187
3187
  * @param deleteObjects.indexName - The `indexName` to delete `objectIDs` from.
3188
3188
  * @param deleteObjects.objectIDs - The objectIDs to delete.
3189
- * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
3189
+ * @param deleteObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
3190
3190
  * @param deleteObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
3191
3191
  * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
3192
3192
  */
@@ -3199,7 +3199,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3199
3199
  * @param partialUpdateObjects.indexName - The `indexName` to update `objects` in.
3200
3200
  * @param partialUpdateObjects.objects - The array of `objects` to update in the given Algolia `indexName`.
3201
3201
  * @param partialUpdateObjects.createIfNotExists - To be provided if non-existing objects are passed, otherwise, the call will fail..
3202
- * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
3202
+ * @param partialUpdateObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
3203
3203
  * @param partialUpdateObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
3204
3204
  * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
3205
3205
  */
@@ -3260,7 +3260,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3260
3260
  * @param addOrUpdateObject.body - The record. A schemaless object with attributes that are useful in the context of search and discovery.
3261
3261
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3262
3262
  */
3263
- addOrUpdateObject({ indexName, objectID, body }: AddOrUpdateObjectProps, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
3263
+ addOrUpdateObject<T extends object>({ indexName, objectID, body }: AddOrUpdateObjectProps<T>, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
3264
3264
  /**
3265
3265
  * Adds a source to the list of allowed sources.
3266
3266
  *
@@ -3552,7 +3552,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3552
3552
  * Retrieves an object with non-null index settings.
3553
3553
  *
3554
3554
  * Required API Key ACLs:
3555
- * - search
3555
+ * - settings
3556
3556
  * @param getSettings - The getSettings object.
3557
3557
  * @param getSettings.indexName - Name of the index on which to perform the operation.
3558
3558
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3736,7 +3736,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3736
3736
  * @param saveObject.body - The record. A schemaless object with attributes that are useful in the context of search and discovery.
3737
3737
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3738
3738
  */
3739
- saveObject({ indexName, body }: SaveObjectProps, requestOptions?: RequestOptions): Promise<SaveObjectResponse>;
3739
+ saveObject<T extends object>({ indexName, body }: SaveObjectProps<T>, requestOptions?: RequestOptions): Promise<SaveObjectResponse>;
3740
3740
  /**
3741
3741
  * If a rule with the specified object ID doesn\'t exist, it\'s created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
3742
3742
  *
@@ -3923,7 +3923,65 @@ type ErrorBase = Record<string, any> & {
3923
3923
  message?: string;
3924
3924
  };
3925
3925
 
3926
+ type EventStatus = 'created' | 'started' | 'retried' | 'failed' | 'succeeded' | 'critical';
3927
+
3928
+ type EventType = 'fetch' | 'record' | 'log' | 'transform';
3929
+
3930
+ /**
3931
+ * An event describe a step of the task execution flow..
3932
+ */
3933
+ type Event = {
3934
+ /**
3935
+ * Universally unique identifier (UUID) of an event.
3936
+ */
3937
+ eventID: string;
3938
+ /**
3939
+ * Universally unique identifier (UUID) of a task run.
3940
+ */
3941
+ runID: string;
3942
+ status: EventStatus | null;
3943
+ type: EventType;
3944
+ /**
3945
+ * The extracted record batch size.
3946
+ */
3947
+ batchSize: number;
3948
+ data?: {
3949
+ [key: string]: any;
3950
+ } | null;
3951
+ /**
3952
+ * Date of publish RFC 3339 format.
3953
+ */
3954
+ publishedAt: string;
3955
+ };
3956
+
3957
+ type WatchResponse = {
3958
+ /**
3959
+ * Universally unique identifier (UUID) of a task run.
3960
+ */
3961
+ runID: string;
3962
+ /**
3963
+ * Universally unique identifier (UUID) of an event.
3964
+ */
3965
+ eventID?: string;
3966
+ /**
3967
+ * This field is always null when used with the Push endpoint. When used for a source discover or source validate run, it will include the sampled data of the source.
3968
+ */
3969
+ data?: Array<Record<string, unknown>>;
3970
+ /**
3971
+ * in case of error, observability events will be added to the response.
3972
+ */
3973
+ events?: Array<Event>;
3974
+ /**
3975
+ * a message describing the outcome of the operation that has been ran (push, discover or validate) run.
3976
+ */
3977
+ message?: string;
3978
+ /**
3979
+ * Date of creation in RFC 3339 format.
3980
+ */
3981
+ createdAt?: string;
3982
+ };
3983
+
3926
3984
  declare function searchClient(appId: string, apiKey: string, options?: ClientOptions): SearchClient;
3927
3985
  type SearchClient = ReturnType<typeof createSearchClient>;
3928
3986
 
3929
- export { type AccountCopyIndexOptions, type Acl, type Action, type AddApiKeyResponse, type AddOrUpdateObjectProps, type AdvancedSyntaxFeatures, type AlternativesAsExact, type Anchoring, type ApiKey, type ApiKeyOperation, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type AssignUserIdParams, type AssignUserIdProps, type AttributeToUpdate, type AutomaticFacetFilter, type AutomaticFacetFilters, type Banner, type BannerImage, type BannerImageUrl, type BannerLink, type BaseGetApiKeyResponse, type BaseIndexSettings, type BaseSearchParams, type BaseSearchParamsWithoutQuery, type BaseSearchResponse, type BatchAssignUserIdsParams, type BatchAssignUserIdsProps, type BatchDictionaryEntriesParams, type BatchDictionaryEntriesProps, type BatchDictionaryEntriesRequest, type BatchParams, type BatchProps, type BatchRequest, type BatchResponse, type BatchWriteParams, type BooleanString, type BrowseOptions, type BrowsePagination, type BrowseParams, type BrowseParamsObject, type BrowseProps, type BrowseResponse, type BuiltInOperation, type BuiltInOperationType, type BuiltInOperationValue, type ChunkedBatchOptions, type ClearObjectsProps, type ClearRulesProps, type ClearSynonymsProps, type Condition, type Consequence, type ConsequenceHide, type ConsequenceParams, type ConsequenceQuery, type ConsequenceQueryObject, type CreatedAtResponse, type Cursor, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteApiKeyProps, type DeleteApiKeyResponse, type DeleteByParams, type DeleteByProps, type DeleteIndexProps, type DeleteObjectProps, type DeleteObjectsOptions, type DeleteRuleProps, type DeleteSourceProps, type DeleteSourceResponse, type DeleteSynonymProps, type DeletedAtResponse, type DictionaryAction, type DictionaryEntry, type DictionaryEntryState, type DictionaryEntryType, type DictionaryLanguage, type DictionarySettingsParams, type DictionaryType, type Distinct, type Edit, type EditType, type ErrorBase, type ExactOnSingleWordQuery, type Exhaustive, type FacetFilters, type FacetHits, type FacetOrdering, type FacetStats, type Facets, type FetchedIndex, type GenerateSecuredApiKeyOptions, type GetApiKeyProps, type GetApiKeyResponse, type GetAppTaskProps, type GetDictionarySettingsResponse, type GetLogsProps, type GetLogsResponse, type GetObjectProps, type GetObjectsParams, type GetObjectsRequest, type GetObjectsResponse, type GetRuleProps, type GetSecuredApiKeyRemainingValidityOptions, type GetSettingsProps, type GetSynonymProps, type GetTaskProps, type GetTaskResponse, type GetTopUserIdsResponse, type GetUserIdProps, type HasPendingMappingsProps, type HasPendingMappingsResponse, type HighlightResult, type HighlightResultOption, type Hit, type IgnorePlurals, type IndexSettings, type IndexSettingsAsSearchParams, type InsideBoundingBox, type Languages, type LegacySearchMethodProps, type ListApiKeysResponse, type ListClustersResponse, type ListIndicesProps, type ListIndicesResponse, type ListUserIdsProps, type ListUserIdsResponse, type Log, type LogQuery, type LogType, type MatchLevel, type MatchedGeoLocation, type Mode, type MultipleBatchRequest, type MultipleBatchResponse, type NumericFilters, type OperationIndexParams, type OperationIndexProps, type OperationType, type OptionalFilters, type OptionalWords, type Params, type PartialUpdateObjectProps, type PartialUpdateObjectsOptions, type Personalization, type Promote, type PromoteObjectID, type PromoteObjectIDs, type QueryType, type Range, type RankingInfo, type ReRankingApplyFilter, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RemoveStopWords, type RemoveUserIdProps, type RemoveUserIdResponse, type RemoveWordsIfNoResults, type RenderingContent, type ReplaceAllObjectsOptions, type ReplaceAllObjectsResponse, type ReplaceSourceResponse, type ReplaceSourcesProps, type RestoreApiKeyProps, type Rule, type SaveObjectProps, type SaveObjectResponse, type SaveObjectsOptions, type SaveRuleProps, type SaveRulesProps, type SaveSynonymProps, type SaveSynonymResponse, type SaveSynonymsProps, type ScopeType, type SearchClient, type SearchClientNodeHelpers, type SearchDictionaryEntriesParams, type SearchDictionaryEntriesProps, type SearchDictionaryEntriesResponse, type SearchForFacetValuesProps, type SearchForFacetValuesRequest, type SearchForFacetValuesResponse, type SearchForFacets, type SearchForFacetsOptions, type SearchForHits, type SearchForHitsOptions, type SearchHits, type SearchMethodParams, type SearchPagination, type SearchParams, type SearchParamsObject, type SearchParamsQuery, type SearchParamsString, type SearchQuery, type SearchResponse, type SearchResponses, type SearchResult, type SearchRulesParams, type SearchRulesProps, type SearchRulesResponse, type SearchSingleIndexProps, type SearchStrategy, type SearchSynonymsParams, type SearchSynonymsProps, type SearchSynonymsResponse, type SearchTypeDefault, type SearchTypeFacet, type SearchUserIdsParams, type SearchUserIdsResponse, type SecuredApiKeyRestrictions, type SemanticSearch, type SetSettingsProps, type SettingsResponse, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type Source, type StandardEntries, type SupportedLanguage, type SynonymHit, type SynonymType, type TagFilters, type TaskStatus, type TimeRange, type TypoTolerance, type TypoToleranceEnum, type UpdateApiKeyProps, type UpdateApiKeyResponse, type UpdatedAtResponse, type UpdatedAtWithObjectIdResponse, type UserHighlightResult, type UserHit, type UserId, type Value, type WaitForApiKeyOptions, type WaitForAppTaskOptions, type WaitForTaskOptions, type Widgets, type WithPrimary, apiClientVersion, searchClient };
3987
+ export { type AccountCopyIndexOptions, type Acl, type Action, type AddApiKeyResponse, type AddOrUpdateObjectProps, type AdvancedSyntaxFeatures, type AlternativesAsExact, type Anchoring, type ApiKey, type ApiKeyOperation, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type AssignUserIdParams, type AssignUserIdProps, type AttributeToUpdate, type AutomaticFacetFilter, type AutomaticFacetFilters, type Banner, type BannerImage, type BannerImageUrl, type BannerLink, type BaseGetApiKeyResponse, type BaseIndexSettings, type BaseSearchParams, type BaseSearchParamsWithoutQuery, type BaseSearchResponse, type BatchAssignUserIdsParams, type BatchAssignUserIdsProps, type BatchDictionaryEntriesParams, type BatchDictionaryEntriesProps, type BatchDictionaryEntriesRequest, type BatchParams, type BatchProps, type BatchRequest, type BatchResponse, type BatchWriteParams, type BooleanString, type BrowseOptions, type BrowsePagination, type BrowseParams, type BrowseParamsObject, type BrowseProps, type BrowseResponse, type BuiltInOperation, type BuiltInOperationType, type BuiltInOperationValue, type ChunkedBatchOptions, type ClearObjectsProps, type ClearRulesProps, type ClearSynonymsProps, type Condition, type Consequence, type ConsequenceHide, type ConsequenceParams, type ConsequenceQuery, type ConsequenceQueryObject, type CreatedAtResponse, type Cursor, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteApiKeyProps, type DeleteApiKeyResponse, type DeleteByParams, type DeleteByProps, type DeleteIndexProps, type DeleteObjectProps, type DeleteObjectsOptions, type DeleteRuleProps, type DeleteSourceProps, type DeleteSourceResponse, type DeleteSynonymProps, type DeletedAtResponse, type DictionaryAction, type DictionaryEntry, type DictionaryEntryState, type DictionaryEntryType, type DictionaryLanguage, type DictionarySettingsParams, type DictionaryType, type Distinct, type Edit, type EditType, type ErrorBase, type Event, type EventStatus, type EventType, type ExactOnSingleWordQuery, type Exhaustive, type FacetFilters, type FacetHits, type FacetOrdering, type FacetStats, type Facets, type FetchedIndex, type GenerateSecuredApiKeyOptions, type GetApiKeyProps, type GetApiKeyResponse, type GetAppTaskProps, type GetDictionarySettingsResponse, type GetLogsProps, type GetLogsResponse, type GetObjectProps, type GetObjectsParams, type GetObjectsRequest, type GetObjectsResponse, type GetRuleProps, type GetSecuredApiKeyRemainingValidityOptions, type GetSettingsProps, type GetSynonymProps, type GetTaskProps, type GetTaskResponse, type GetTopUserIdsResponse, type GetUserIdProps, type HasPendingMappingsProps, type HasPendingMappingsResponse, type HighlightResult, type HighlightResultOption, type Hit, type IgnorePlurals, type IndexSettings, type IndexSettingsAsSearchParams, type InsideBoundingBox, type Languages, type LegacySearchMethodProps, type ListApiKeysResponse, type ListClustersResponse, type ListIndicesProps, type ListIndicesResponse, type ListUserIdsProps, type ListUserIdsResponse, type Log, type LogQuery, type LogType, type MatchLevel, type MatchedGeoLocation, type Mode, type MultipleBatchRequest, type MultipleBatchResponse, type NumericFilters, type OperationIndexParams, type OperationIndexProps, type OperationType, type OptionalFilters, type OptionalWords, type Params, type PartialUpdateObjectProps, type PartialUpdateObjectsOptions, type Personalization, type Promote, type PromoteObjectID, type PromoteObjectIDs, type QueryType, type Range, type RankingInfo, type ReRankingApplyFilter, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RemoveStopWords, type RemoveUserIdProps, type RemoveUserIdResponse, type RemoveWordsIfNoResults, type RenderingContent, type ReplaceAllObjectsOptions, type ReplaceAllObjectsResponse, type ReplaceSourceResponse, type ReplaceSourcesProps, type RestoreApiKeyProps, type Rule, type SaveObjectProps, type SaveObjectResponse, type SaveObjectsOptions, type SaveRuleProps, type SaveRulesProps, type SaveSynonymProps, type SaveSynonymResponse, type SaveSynonymsProps, type ScopeType, type SearchClient, type SearchClientNodeHelpers, type SearchDictionaryEntriesParams, type SearchDictionaryEntriesProps, type SearchDictionaryEntriesResponse, type SearchForFacetValuesProps, type SearchForFacetValuesRequest, type SearchForFacetValuesResponse, type SearchForFacets, type SearchForFacetsOptions, type SearchForHits, type SearchForHitsOptions, type SearchHits, type SearchMethodParams, type SearchPagination, type SearchParams, type SearchParamsObject, type SearchParamsQuery, type SearchParamsString, type SearchQuery, type SearchResponse, type SearchResponses, type SearchResult, type SearchRulesParams, type SearchRulesProps, type SearchRulesResponse, type SearchSingleIndexProps, type SearchStrategy, type SearchSynonymsParams, type SearchSynonymsProps, type SearchSynonymsResponse, type SearchTypeDefault, type SearchTypeFacet, type SearchUserIdsParams, type SearchUserIdsResponse, type SecuredApiKeyRestrictions, type SemanticSearch, type SetSettingsProps, type SettingsResponse, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type Source, type StandardEntries, type SupportedLanguage, type SynonymHit, type SynonymType, type TagFilters, type TaskStatus, type TimeRange, type TypoTolerance, type TypoToleranceEnum, type UpdateApiKeyProps, type UpdateApiKeyResponse, type UpdatedAtResponse, type UpdatedAtWithObjectIdResponse, type UserHighlightResult, type UserHit, type UserId, type Value, type WaitForApiKeyOptions, type WaitForAppTaskOptions, type WaitForTaskOptions, type WatchResponse, type Widgets, type WithPrimary, apiClientVersion, searchClient };
package/dist/builds/browser.js CHANGED
@@ -16,7 +16,7 @@ import {
16
16
  getAlgoliaAgent,
17
17
  shuffle
18
18
  } from "@algolia/client-common";
19
- var apiClientVersion = "5.25.0";
19
+ var apiClientVersion = "5.27.0";
20
20
  function getDefaultHosts(appId) {
21
21
  return [
22
22
  {
@@ -377,7 +377,7 @@ function createSearchClient({
377
377
  * @param saveObjects - The `saveObjects` object.
378
378
  * @param saveObjects.indexName - The `indexName` to save `objects` in.
379
379
  * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
380
- * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
380
+ * @param saveObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
381
381
  * @param saveObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
382
382
  * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
383
383
  */
@@ -394,7 +394,7 @@ function createSearchClient({
394
394
  * @param deleteObjects - The `deleteObjects` object.
395
395
  * @param deleteObjects.indexName - The `indexName` to delete `objectIDs` from.
396
396
  * @param deleteObjects.objectIDs - The objectIDs to delete.
397
- * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
397
+ * @param deleteObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
398
398
  * @param deleteObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
399
399
  * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
400
400
  */
@@ -418,7 +418,7 @@ function createSearchClient({
418
418
  * @param partialUpdateObjects.indexName - The `indexName` to update `objects` in.
419
419
  * @param partialUpdateObjects.objects - The array of `objects` to update in the given Algolia `indexName`.
420
420
  * @param partialUpdateObjects.createIfNotExists - To be provided if non-existing objects are passed, otherwise, the call will fail..
421
- * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
421
+ * @param partialUpdateObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
422
422
  * @param partialUpdateObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
423
423
  * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
424
424
  */
@@ -1371,7 +1371,7 @@ function createSearchClient({
1371
1371
  * Retrieves an object with non-null index settings.
1372
1372
  *
1373
1373
  * Required API Key ACLs:
1374
- * - search
1374
+ * - settings
1375
1375
  * @param getSettings - The getSettings object.
1376
1376
  * @param getSettings.indexName - Name of the index on which to perform the operation.
1377
1377
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.