@algolia/client-search 5.0.0-beta.9 → 5.0.2

package/model/index.ts

@@ -9,7 +9,6 @@ export * from './anchoring';
 export * from './apiKey';
 export * from './apiKeyOperation';
 export * from './aroundPrecision';
-export * from './aroundPrecisionFromValueInner';
 export * from './aroundRadius';
 export * from './aroundRadiusAll';
 export * from './assignUserIdParams';
@@ -28,11 +27,13 @@ export * from './batchParams';
 export * from './batchRequest';
 export * from './batchResponse';
 export * from './batchWriteParams';
+export * from './browsePagination';
 export * from './browseParams';
 export * from './browseParamsObject';
 export * from './browseResponse';
 export * from './builtInOperation';
 export * from './builtInOperationType';
+export * from './builtInOperationValue';
 export * from './condition';
 export * from './consequence';
 export * from './consequenceHide';
@@ -48,6 +49,7 @@ export * from './deletedAtResponse';
 export * from './dictionaryAction';
 export * from './dictionaryEntry';
 export * from './dictionaryEntryState';
+export * from './dictionaryEntryType';
 export * from './dictionaryLanguage';
 export * from './dictionarySettingsParams';
 export * from './dictionaryType';
@@ -101,11 +103,12 @@ export * from './promote';
 export * from './promoteObjectID';
 export * from './promoteObjectIDs';
 export * from './queryType';
+export * from './range';
 export * from './rankingInfo';
 export * from './reRankingApplyFilter';
 export * from './redirect';
+export * from './redirectRuleIndexData';
 export * from './redirectRuleIndexMetadata';
-export * from './redirectRuleIndexMetadataData';
 export * from './redirectURL';
 export * from './removeStopWords';
 export * from './removeUserIdResponse';
@@ -127,6 +130,7 @@ export * from './searchForHits';
 export * from './searchForHitsOptions';
 export * from './searchHits';
 export * from './searchMethodParams';
+export * from './searchPagination';
 export * from './searchParams';
 export * from './searchParamsObject';
 export * from './searchParamsQuery';
@@ -146,6 +150,7 @@ export * from './searchUserIdsParams';
 export * from './searchUserIdsResponse';
 export * from './securedApiKeyRestrictions';
 export * from './semanticSearch';
+export * from './settingsResponse';
 export * from './snippetResult';
 export * from './snippetResultOption';
 export * from './sortRemainingBy';
@@ -167,4 +172,5 @@ export * from './userHighlightResult';
 export * from './userHit';
 export * from './userId';
 export * from './value';
+export * from './withPrimary';
 export * from './clientMethodProps';

package/model/indexSettingsAsSearchParams.ts

@@ -108,7 +108,7 @@ export type IndexSettingsAsSearchParams = {
   queryLanguages?: SupportedLanguage[];
 
   /**
-   * Whether to split compound words into their building blocks.  For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian.
+   * Whether to split compound words in the query into their building blocks.  For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn\'t work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won\'t be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
    */
   decompoundQuery?: boolean;
 

package/model/multipleBatchRequest.ts

@@ -8,7 +8,7 @@ export type MultipleBatchRequest = {
   /**
    * Operation arguments (varies with specified `action`).
    */
-  body: Record<string, any>;
+  body?: Record<string, any>;
 
   /**
    * Index name (case-sensitive).

package/model/{aroundPrecisionFromValueInner.ts → range.ts}

@@ -3,7 +3,7 @@
 /**
  * Range object with lower and upper values in meters to define custom ranges.
  */
-export type AroundPrecisionFromValueInner = {
+export type Range = {
   /**
    * Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
    */

package/model/{redirectRuleIndexMetadataData.ts → redirectRuleIndexData.ts}

@@ -3,6 +3,6 @@
 /**
  * Redirect rule data.
  */
-export type RedirectRuleIndexMetadataData = {
+export type RedirectRuleIndexData = {
   ruleObjectID: string;
 };

package/model/redirectRuleIndexMetadata.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { RedirectRuleIndexMetadataData } from './redirectRuleIndexMetadataData';
+import type { RedirectRuleIndexData } from './redirectRuleIndexData';
 
 export type RedirectRuleIndexMetadata = {
   /**
@@ -23,5 +23,5 @@ export type RedirectRuleIndexMetadata = {
    */
   succeed: boolean;
 
-  data: RedirectRuleIndexMetadataData;
+  data: RedirectRuleIndexData;
 };

package/model/searchPagination.ts

@@ -0,0 +1,23 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type SearchPagination = {
+  /**
+   * Page of search results to retrieve.
+   */
+  page: number;
+
+  /**
+   * Number of results (hits).
+   */
+  nbHits: number;
+
+  /**
+   * Number of pages of results.
+   */
+  nbPages: number;
+
+  /**
+   * Number of hits per page.
+   */
+  hitsPerPage: number;
+};

package/model/searchParamsString.ts

@@ -1,5 +1,8 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
+/**
+ * Search parameters as query string.
+ */
 export type SearchParamsString = {
   /**
    * Search parameters as a URL-encoded query string.

package/model/searchResponse.ts

@@ -2,6 +2,8 @@
 
 import type { BaseSearchResponse } from './baseSearchResponse';
 import type { SearchHits } from './searchHits';
+import type { SearchPagination } from './searchPagination';
 
 export type SearchResponse<T = Record<string, any>> = BaseSearchResponse &
-  SearchHits<T>;
+  SearchHits<T> &
+  SearchPagination;

package/model/settingsResponse.ts

@@ -0,0 +1,6 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { IndexSettings } from './indexSettings';
+import type { WithPrimary } from './withPrimary';
+
+export type SettingsResponse = IndexSettings & WithPrimary;

package/model/snippetResult.ts

@@ -5,4 +5,5 @@ import type { SnippetResultOption } from './snippetResultOption';
 export type SnippetResult =
   | Record<string, SnippetResultOption>
   | SnippetResultOption
-  | SnippetResultOption[];
+  | SnippetResultOption[]
+  | { [key: string]: SnippetResult };

package/model/withPrimary.ts

@@ -0,0 +1,8 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type WithPrimary = {
+  /**
+   * Replica indices only: the name of the primary index for this replica.
+   */
+  primary?: string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-search",
-  "version": "5.0.0-beta.9",
+  "version": "5.0.2",
   "description": "JavaScript client for client-search",
   "repository": {
     "type": "git",
@@ -42,14 +42,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-beta.10",
-    "@algolia/requester-browser-xhr": "5.0.0-beta.10",
-    "@algolia/requester-node-http": "5.0.0-beta.10"
+    "@algolia/client-common": "5.0.2",
+    "@algolia/requester-browser-xhr": "5.0.2",
+    "@algolia/requester-node-http": "5.0.2"
   },
   "devDependencies": {
-    "@types/node": "20.14.10",
-    "rollup": "4.18.0",
-    "typescript": "5.5.3"
+    "@types/node": "22.2.0",
+    "rollup": "4.20.0",
+    "typescript": "5.5.4"
   },
   "engines": {
     "node": ">= 14.0.0"

package/dist/model/aroundPrecisionFromValueInner.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"aroundPrecisionFromValueInner.d.ts","sourceRoot":"","sources":["../../model/aroundPrecisionFromValueInner.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/model/redirectRuleIndexMetadataData.d.ts

@@ -1,7 +0,0 @@
-/**
- * Redirect rule data.
- */
-export type RedirectRuleIndexMetadataData = {
-    ruleObjectID: string;
-};
-//# sourceMappingURL=redirectRuleIndexMetadataData.d.ts.map

package/dist/model/redirectRuleIndexMetadataData.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"redirectRuleIndexMetadataData.d.ts","sourceRoot":"","sources":["../../model/redirectRuleIndexMetadataData.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC"}