algoliasearch 5.8.1 → 5.9.1

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 (45) hide show
  1. package/README.md +5 -5
  2. package/builds/browser.ts +69 -20
  3. package/builds/fetch.ts +69 -20
  4. package/builds/models.ts +65 -18
  5. package/builds/node.ts +69 -20
  6. package/dist/algoliasearch.umd.js +15 -8
  7. package/dist/browser.d.ts +32 -21
  8. package/dist/browser.js +53 -6
  9. package/dist/browser.js.map +1 -1
  10. package/dist/browser.min.js +1 -1
  11. package/dist/browser.min.js.map +1 -1
  12. package/dist/fetch.d.ts +32 -21
  13. package/dist/fetch.js +53 -6
  14. package/dist/fetch.js.map +1 -1
  15. package/dist/lite/browser.d.ts +12 -8
  16. package/dist/lite/builds/browser.js +1 -1
  17. package/dist/lite/builds/browser.js.map +1 -1
  18. package/dist/lite/builds/browser.min.js +1 -1
  19. package/dist/lite/builds/browser.min.js.map +1 -1
  20. package/dist/lite/builds/browser.umd.js +1 -1
  21. package/dist/lite/builds/node.cjs +1 -1
  22. package/dist/lite/builds/node.cjs.map +1 -1
  23. package/dist/lite/builds/node.js +1 -1
  24. package/dist/lite/builds/node.js.map +1 -1
  25. package/dist/lite/node.d.cts +12 -8
  26. package/dist/lite/node.d.ts +12 -8
  27. package/dist/lite/src/liteClient.cjs +1 -1
  28. package/dist/lite/src/liteClient.cjs.map +1 -1
  29. package/dist/lite/src/liteClient.js +1 -1
  30. package/dist/lite/src/liteClient.js.map +1 -1
  31. package/dist/node.cjs +52 -9
  32. package/dist/node.cjs.map +1 -1
  33. package/dist/node.d.cts +32 -21
  34. package/dist/node.d.ts +32 -21
  35. package/dist/node.js +53 -6
  36. package/dist/node.js.map +1 -1
  37. package/lite/model/baseGetApiKeyResponse.ts +1 -1
  38. package/lite/model/baseIndexSettings.ts +2 -2
  39. package/lite/model/baseRecommendIndexSettings.ts +1 -1
  40. package/lite/model/baseSearchResponse.ts +5 -0
  41. package/lite/model/indexSettingsAsSearchParams.ts +1 -1
  42. package/lite/model/recommendHit.ts +1 -1
  43. package/lite/model/trendingFacetHit.ts +1 -1
  44. package/lite/src/liteClient.ts +1 -1
  45. package/package.json +18 -14
package/dist/node.d.ts CHANGED
@@ -1,19 +1,32 @@
1
- import { Region as Region$1, AbtestingClient } from '@algolia/client-abtesting';
2
- export * from '@algolia/client-abtesting';
3
- export { Region as AbTestingRegion } from '@algolia/client-abtesting';
4
- import { Region as Region$2, AnalyticsClient } from '@algolia/client-analytics';
5
- export * from '@algolia/client-analytics';
6
- export { Region as AnalyticsRegion } from '@algolia/client-analytics';
7
1
  import { ClientOptions } from '@algolia/client-common';
8
- import { Region as Region$3, PersonalizationClient } from '@algolia/client-personalization';
9
- export * from '@algolia/client-personalization';
10
2
  import { SearchClient } from '@algolia/client-search';
11
3
  export * from '@algolia/client-search';
12
- export { AdvancedSyntaxFeatures, AlternativesAsExact, Anchoring, AroundPrecision, AroundRadius, AroundRadiusAll, AutomaticFacetFilter, AutomaticFacetFilters, Banner, BannerImage, BannerImageUrl, BannerLink, BaseIndexSettings, BaseSearchParams, BaseSearchParamsWithoutQuery, BaseSearchResponse, BooleanString, Condition, Consequence, ConsequenceHide, ConsequenceParams, ConsequenceQuery, ConsequenceQueryObject, CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeletedAtResponse, Distinct, Edit, EditType, ErrorBase, ExactOnSingleWordQuery, Exhaustive, FacetFilters, FacetOrdering, FacetStats, Facets, HighlightResult, HighlightResultOption, IgnorePlurals, IndexSettingsAsSearchParams, MatchLevel, MatchedGeoLocation, Mode, NumericFilters, OptionalFilters, Params, Personalization, Promote, PromoteObjectID, PromoteObjectIDs, QueryType, Range, RankingInfo, ReRankingApplyFilter, Redirect, RedirectRuleIndexData, RedirectRuleIndexMetadata, RedirectURL, RemoveStopWords, RemoveWordsIfNoResults, RenderingContent, SearchPagination, SearchParams, SearchParamsObject, SearchParamsQuery, SemanticSearch, SnippetResult, SnippetResultOption, SortRemainingBy, SupportedLanguage, TagFilters, TaskStatus, TimeRange, TypoTolerance, TypoToleranceEnum, Value, Widgets, apiClientVersion } from '@algolia/client-search';
4
+ export { Action, AdvancedSyntaxFeatures, AlternativesAsExact, Anchoring, AroundPrecision, AroundRadius, AroundRadiusAll, AutomaticFacetFilter, AutomaticFacetFilters, Banner, BannerImage, BannerImageUrl, BannerLink, BaseIndexSettings, BaseSearchParams, BaseSearchParamsWithoutQuery, BaseSearchResponse, BooleanString, Condition, Consequence, ConsequenceHide, ConsequenceParams, ConsequenceQuery, ConsequenceQueryObject, CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteSourceProps, DeletedAtResponse, Distinct, Edit, EditType, ErrorBase, ExactOnSingleWordQuery, Exhaustive, FacetFilters, FacetOrdering, FacetStats, Facets, GetTaskProps, HighlightResult, HighlightResultOption, IgnorePlurals, IndexSettingsAsSearchParams, Languages, MatchLevel, MatchedGeoLocation, Mode, NumericFilters, OptionalFilters, Params, Personalization, Promote, PromoteObjectID, PromoteObjectIDs, QueryType, Range, RankingInfo, ReRankingApplyFilter, Redirect, RedirectRuleIndexData, RedirectRuleIndexMetadata, RedirectURL, RemoveStopWords, RemoveWordsIfNoResults, RenderingContent, SearchPagination, SearchParams, SearchParamsObject, SearchParamsQuery, SemanticSearch, SnippetResult, SnippetResultOption, SortRemainingBy, Source, SupportedLanguage, TagFilters, TaskStatus, TimeRange, TypoTolerance, TypoToleranceEnum, Value, Widgets, apiClientVersion } from '@algolia/client-search';
5
+ import { Region as Region$1, RegionOptions as RegionOptions$1, AbtestingClient } from '@algolia/client-abtesting';
6
+ export * from '@algolia/client-abtesting';
7
+ export { Region as AbtestingRegion, RegionOptions as AbtestingRegionOptions, Status } from '@algolia/client-abtesting';
8
+ import { Region as Region$2, RegionOptions as RegionOptions$2, AnalyticsClient } from '@algolia/client-analytics';
9
+ export * from '@algolia/client-analytics';
10
+ export { Region as AnalyticsRegion, RegionOptions as AnalyticsRegionOptions } from '@algolia/client-analytics';
11
+ import { Region as Region$4, RegionOptions as RegionOptions$4, InsightsClient } from '@algolia/client-insights';
12
+ export * from '@algolia/client-insights';
13
+ export { Region as InsightsRegion, RegionOptions as InsightsRegionOptions } from '@algolia/client-insights';
14
+ import { Region as Region$5, RegionOptions as RegionOptions$5, PersonalizationClient } from '@algolia/client-personalization';
15
+ export * from '@algolia/client-personalization';
16
+ export { EventType, Region as PersonalizationRegion, RegionOptions as PersonalizationRegionOptions } from '@algolia/client-personalization';
17
+ import { Region as Region$6, RegionOptions as RegionOptions$6, QuerySuggestionsClient } from '@algolia/client-query-suggestions';
18
+ export * from '@algolia/client-query-suggestions';
19
+ export { Region as QuerySuggestionsRegion, RegionOptions as QuerySuggestionsRegionOptions } from '@algolia/client-query-suggestions';
20
+ import { Region as Region$3, RegionOptions as RegionOptions$3, IngestionClient } from '@algolia/ingestion';
21
+ export * from '@algolia/ingestion';
22
+ export { Region as IngestionRegion, RegionOptions as IngestionRegionOptions } from '@algolia/ingestion';
23
+ import { MonitoringClient } from '@algolia/monitoring';
24
+ export * from '@algolia/monitoring';
13
25
  import { RecommendClient } from '@algolia/recommend';
14
26
  export * from '@algolia/recommend';
15
27
 
16
- type Region = Region$1 | Region$2;
28
+ type Region = Region$1 | Region$2 | Region$3 | Region$4 | Region$5 | Region$6;
29
+ type RegionOptions = RegionOptions$1 | RegionOptions$2 | RegionOptions$3 | RegionOptions$4 | RegionOptions$5 | RegionOptions$6;
17
30
 
18
31
  /**
19
32
  * Options forwarded to the client initialized via the `init` method.
@@ -29,19 +42,17 @@ type InitClientOptions = Partial<{
29
42
  apiKey: string;
30
43
  options: ClientOptions;
31
44
  }>;
32
- type InitClientRegion<TRegion> = Partial<{
33
- /**
34
- * Available regions of the initialized client.
35
- */
36
- region: TRegion;
37
- }>;
38
45
 
39
46
  type Algoliasearch = SearchClient & {
40
- initRecommend: (initOptions?: InitClientOptions) => RecommendClient;
41
- initAnalytics: (initOptions?: InitClientOptions & InitClientRegion<Region$2>) => AnalyticsClient;
42
- initAbtesting: (initOptions?: InitClientOptions & InitClientRegion<Region$1>) => AbtestingClient;
43
- initPersonalization: (initOptions: InitClientOptions & Required<InitClientRegion<Region$3>>) => PersonalizationClient;
47
+ initAbtesting: (initOptions: InitClientOptions & RegionOptions$1) => AbtestingClient;
48
+ initAnalytics: (initOptions: InitClientOptions & RegionOptions$2) => AnalyticsClient;
49
+ initIngestion: (initOptions: InitClientOptions & RegionOptions$3) => IngestionClient;
50
+ initInsights: (initOptions: InitClientOptions & RegionOptions$4) => InsightsClient;
51
+ initMonitoring: (initOptions: InitClientOptions) => MonitoringClient;
52
+ initPersonalization: (initOptions: InitClientOptions & RegionOptions$5) => PersonalizationClient;
53
+ initQuerySuggestions: (initOptions: InitClientOptions & RegionOptions$6) => QuerySuggestionsClient;
54
+ initRecommend: (initOptions: InitClientOptions) => RecommendClient;
44
55
  };
45
56
  declare function algoliasearch(appId: string, apiKey: string, options?: ClientOptions): Algoliasearch;
46
57
 
47
- export { type Algoliasearch, type InitClientOptions, type InitClientRegion, type Region, algoliasearch };
58
+ export { type Algoliasearch, type InitClientOptions, type Region, type RegionOptions, algoliasearch };
package/dist/node.js CHANGED
@@ -19,30 +19,48 @@ var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "defau
19
19
  // builds/node.ts
20
20
  var node_exports = {};
21
21
  __export(node_exports, {
22
+ EventType: () => EventType,
23
+ Status: () => Status,
22
24
  algoliasearch: () => algoliasearch,
23
25
  apiClientVersion: () => apiClientVersion
24
26
  });
27
+ import { searchClient } from "@algolia/client-search";
25
28
  import { abtestingClient } from "@algolia/client-abtesting";
26
29
  import { analyticsClient } from "@algolia/client-analytics";
30
+ import { insightsClient } from "@algolia/client-insights";
27
31
  import { personalizationClient } from "@algolia/client-personalization";
28
- import { searchClient } from "@algolia/client-search";
32
+ import { querySuggestionsClient } from "@algolia/client-query-suggestions";
33
+ import { ingestionClient } from "@algolia/ingestion";
34
+ import { monitoringClient } from "@algolia/monitoring";
29
35
  import { recommendClient } from "@algolia/recommend";
30
36
 
31
37
  // builds/models.ts
32
38
  var models_exports = {};
33
39
  __export(models_exports, {
40
+ EventType: () => EventType,
41
+ Status: () => Status,
34
42
  apiClientVersion: () => apiClientVersion
35
43
  });
36
44
  __reExport(models_exports, client_abtesting_star);
37
45
  __reExport(models_exports, client_analytics_star);
46
+ __reExport(models_exports, client_insights_star);
38
47
  __reExport(models_exports, client_personalization_star);
48
+ __reExport(models_exports, client_query_suggestions_star);
39
49
  __reExport(models_exports, client_search_star);
50
+ __reExport(models_exports, ingestion_star);
51
+ __reExport(models_exports, monitoring_star);
40
52
  __reExport(models_exports, recommend_star);
53
+ import { Status } from "@algolia/client-abtesting";
54
+ import { EventType } from "@algolia/client-personalization";
41
55
  import { apiClientVersion } from "@algolia/client-search";
42
56
  import * as client_abtesting_star from "@algolia/client-abtesting";
43
57
  import * as client_analytics_star from "@algolia/client-analytics";
58
+ import * as client_insights_star from "@algolia/client-insights";
44
59
  import * as client_personalization_star from "@algolia/client-personalization";
60
+ import * as client_query_suggestions_star from "@algolia/client-query-suggestions";
45
61
  import * as client_search_star from "@algolia/client-search";
62
+ import * as ingestion_star from "@algolia/ingestion";
63
+ import * as monitoring_star from "@algolia/monitoring";
46
64
  import * as recommend_star from "@algolia/recommend";
47
65
 
48
66
  // builds/node.ts
@@ -63,10 +81,15 @@ function algoliasearch(appId, apiKey, options) {
63
81
  get _ua() {
64
82
  return client.transporter.algoliaAgent.value;
65
83
  },
66
- initRecommend: (initOptions = {}) => {
67
- return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
84
+ initAbtesting: (initOptions) => {
85
+ return abtestingClient(
86
+ initOptions.appId || appId,
87
+ initOptions.apiKey || apiKey,
88
+ initOptions.region,
89
+ initOptions.options
90
+ );
68
91
  },
69
- initAnalytics: (initOptions = {}) => {
92
+ initAnalytics: (initOptions) => {
70
93
  return analyticsClient(
71
94
  initOptions.appId || appId,
72
95
  initOptions.apiKey || apiKey,
@@ -74,14 +97,25 @@ function algoliasearch(appId, apiKey, options) {
74
97
  initOptions.options
75
98
  );
76
99
  },
77
- initAbtesting: (initOptions = {}) => {
78
- return abtestingClient(
100
+ initIngestion: (initOptions) => {
101
+ return ingestionClient(
79
102
  initOptions.appId || appId,
80
103
  initOptions.apiKey || apiKey,
81
104
  initOptions.region,
82
105
  initOptions.options
83
106
  );
84
107
  },
108
+ initInsights: (initOptions) => {
109
+ return insightsClient(
110
+ initOptions.appId || appId,
111
+ initOptions.apiKey || apiKey,
112
+ initOptions.region,
113
+ initOptions.options
114
+ );
115
+ },
116
+ initMonitoring: (initOptions) => {
117
+ return monitoringClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
118
+ },
85
119
  initPersonalization: (initOptions) => {
86
120
  return personalizationClient(
87
121
  initOptions.appId || appId,
@@ -89,10 +123,23 @@ function algoliasearch(appId, apiKey, options) {
89
123
  initOptions.region,
90
124
  initOptions.options
91
125
  );
126
+ },
127
+ initQuerySuggestions: (initOptions) => {
128
+ return querySuggestionsClient(
129
+ initOptions.appId || appId,
130
+ initOptions.apiKey || apiKey,
131
+ initOptions.region,
132
+ initOptions.options
133
+ );
134
+ },
135
+ initRecommend: (initOptions) => {
136
+ return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
92
137
  }
93
138
  };
94
139
  }
95
140
  export {
141
+ EventType,
142
+ Status,
96
143
  algoliasearch,
97
144
  apiClientVersion
98
145
  };
package/dist/node.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../builds/node.ts","../builds/models.ts"],"sourcesContent":["// 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.\n\nimport type { AbtestingClient, Region as AbtestingRegion } from '@algolia/client-abtesting';\nimport type { AnalyticsClient, Region as AnalyticsRegion } from '@algolia/client-analytics';\nimport type { ClientOptions } from '@algolia/client-common';\nimport type { PersonalizationClient, Region as PersonalizationRegion } from '@algolia/client-personalization';\nimport type { SearchClient } from '@algolia/client-search';\nimport type { RecommendClient } from '@algolia/recommend';\n\nimport { abtestingClient } from '@algolia/client-abtesting';\nimport { analyticsClient } from '@algolia/client-analytics';\nimport { personalizationClient } from '@algolia/client-personalization';\nimport { searchClient } from '@algolia/client-search';\nimport { recommendClient } from '@algolia/recommend';\n\nimport type { InitClientOptions, InitClientRegion } from './models';\n\nexport * from './models';\n\nexport type Algoliasearch = SearchClient & {\n initRecommend: (initOptions?: InitClientOptions) => RecommendClient;\n initAnalytics: (initOptions?: InitClientOptions & InitClientRegion<AnalyticsRegion>) => AnalyticsClient;\n initAbtesting: (initOptions?: InitClientOptions & InitClientRegion<AbtestingRegion>) => AbtestingClient;\n initPersonalization: (\n initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>,\n ) => PersonalizationClient;\n};\n\nexport function algoliasearch(appId: string, apiKey: string, options?: ClientOptions): Algoliasearch {\n if (!appId || typeof appId !== 'string') {\n throw new Error('`appId` is missing.');\n }\n\n if (!apiKey || typeof apiKey !== 'string') {\n throw new Error('`apiKey` is missing.');\n }\n\n const client = searchClient(appId, apiKey, options);\n\n return {\n ...client,\n /**\n * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.\n */\n get _ua(): string {\n return client.transporter.algoliaAgent.value;\n },\n initRecommend: (initOptions: InitClientOptions = {}): RecommendClient => {\n return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);\n },\n\n initAnalytics: (initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}): AnalyticsClient => {\n return analyticsClient(\n initOptions.appId || appId,\n initOptions.apiKey || apiKey,\n initOptions.region,\n initOptions.options,\n );\n },\n\n initAbtesting: (initOptions: InitClientOptions & InitClientRegion<AbtestingRegion> = {}): AbtestingClient => {\n return abtestingClient(\n initOptions.appId || appId,\n initOptions.apiKey || apiKey,\n initOptions.region,\n initOptions.options,\n );\n },\n\n initPersonalization: (\n initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>,\n ): PersonalizationClient => {\n return personalizationClient(\n initOptions.appId || appId,\n initOptions.apiKey || apiKey,\n initOptions.region,\n initOptions.options,\n );\n },\n };\n}\n","// 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.\n\nimport type { Region as AbTestingRegion } from '@algolia/client-abtesting';\nimport type { Region as AnalyticsRegion } from '@algolia/client-analytics';\nimport type { ClientOptions } from '@algolia/client-common';\nimport type {\n AdvancedSyntaxFeatures,\n AlternativesAsExact,\n Anchoring,\n AroundPrecision,\n AroundRadius,\n AroundRadiusAll,\n AutomaticFacetFilter,\n AutomaticFacetFilters,\n Banner,\n BannerImage,\n BannerImageUrl,\n BannerLink,\n BaseIndexSettings,\n BaseSearchParams,\n BaseSearchParamsWithoutQuery,\n BaseSearchResponse,\n BooleanString,\n Condition,\n Consequence,\n ConsequenceHide,\n ConsequenceParams,\n ConsequenceQuery,\n ConsequenceQueryObject,\n CustomDeleteProps,\n CustomGetProps,\n CustomPostProps,\n CustomPutProps,\n DeletedAtResponse,\n Distinct,\n Edit,\n EditType,\n ErrorBase,\n ExactOnSingleWordQuery,\n Exhaustive,\n FacetFilters,\n FacetOrdering,\n Facets,\n FacetStats,\n HighlightResult,\n HighlightResultOption,\n IgnorePlurals,\n IndexSettingsAsSearchParams,\n MatchedGeoLocation,\n MatchLevel,\n Mode,\n NumericFilters,\n OptionalFilters,\n Params,\n Personalization,\n Promote,\n PromoteObjectID,\n PromoteObjectIDs,\n QueryType,\n Range,\n RankingInfo,\n Redirect,\n RedirectRuleIndexData,\n RedirectRuleIndexMetadata,\n RedirectURL,\n RemoveStopWords,\n RemoveWordsIfNoResults,\n RenderingContent,\n ReRankingApplyFilter,\n SearchPagination,\n SearchParams,\n SearchParamsObject,\n SearchParamsQuery,\n SemanticSearch,\n SnippetResult,\n SnippetResultOption,\n SortRemainingBy,\n SupportedLanguage,\n TagFilters,\n TaskStatus,\n TimeRange,\n TypoTolerance,\n TypoToleranceEnum,\n Value,\n Widgets,\n} from '@algolia/client-search';\nimport { apiClientVersion } from '@algolia/client-search';\n\ntype Region = AbTestingRegion | AnalyticsRegion;\n\nexport * from '@algolia/client-abtesting';\nexport * from '@algolia/client-analytics';\nexport * from '@algolia/client-personalization';\nexport * from '@algolia/client-search';\nexport * from '@algolia/recommend';\n\nexport {\n AbTestingRegion,\n AdvancedSyntaxFeatures,\n AlternativesAsExact,\n AnalyticsRegion,\n Anchoring,\n apiClientVersion,\n AroundPrecision,\n AroundRadius,\n AroundRadiusAll,\n AutomaticFacetFilter,\n AutomaticFacetFilters,\n Banner,\n BannerImage,\n BannerImageUrl,\n BannerLink,\n BaseIndexSettings,\n BaseSearchParams,\n BaseSearchParamsWithoutQuery,\n BaseSearchResponse,\n BooleanString,\n Condition,\n Consequence,\n ConsequenceHide,\n ConsequenceParams,\n ConsequenceQuery,\n ConsequenceQueryObject,\n CustomDeleteProps,\n CustomGetProps,\n CustomPostProps,\n CustomPutProps,\n DeletedAtResponse,\n Distinct,\n Edit,\n EditType,\n ErrorBase,\n ExactOnSingleWordQuery,\n Exhaustive,\n FacetFilters,\n FacetOrdering,\n Facets,\n FacetStats,\n HighlightResult,\n HighlightResultOption,\n IgnorePlurals,\n IndexSettingsAsSearchParams,\n MatchedGeoLocation,\n MatchLevel,\n Mode,\n NumericFilters,\n OptionalFilters,\n Params,\n Personalization,\n Promote,\n PromoteObjectID,\n PromoteObjectIDs,\n QueryType,\n Range,\n RankingInfo,\n Redirect,\n RedirectRuleIndexData,\n RedirectRuleIndexMetadata,\n RedirectURL,\n Region,\n RemoveStopWords,\n RemoveWordsIfNoResults,\n RenderingContent,\n ReRankingApplyFilter,\n SearchPagination,\n SearchParams,\n SearchParamsObject,\n SearchParamsQuery,\n SemanticSearch,\n SnippetResult,\n SnippetResultOption,\n SortRemainingBy,\n SupportedLanguage,\n TagFilters,\n TaskStatus,\n TimeRange,\n TypoTolerance,\n TypoToleranceEnum,\n Value,\n Widgets,\n};\n\n/**\n * Options forwarded to the client initialized via the `init` method.\n */\nexport type InitClientOptions = Partial<{\n /**\n * App to target with the initialized client, defaults to the `algoliasearch` appId.\n */\n appId: string;\n /**\n * API key of the targeted app ID, defaults to the `algoliasearch` apiKey.\n */\n apiKey: string;\n options: ClientOptions;\n}>;\n\nexport type InitClientRegion<TRegion> = Partial<{\n /**\n * Available regions of the initialized client.\n */\n region: TRegion;\n}>;\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AASA,SAAS,uBAAuB;AAChC,SAAS,uBAAuB;AAChC,SAAS,6BAA6B;AACtC,SAAS,oBAAoB;AAC7B,SAAS,uBAAuB;;;ACbhC;AAAA;AAAA;AAAA;AA0FA;AACA;AACA;AACA;AACA;AARA,SAAS,wBAAwB;AAIjC,uCAAc;AACd,uCAAc;AACd,6CAAc;AACd,oCAAc;AACd,gCAAc;;;AD7Ed,yBAAc;AAWP,SAAS,cAAc,OAAe,QAAgB,SAAwC;AACnG,MAAI,CAAC,SAAS,OAAO,UAAU,UAAU;AACvC,UAAM,IAAI,MAAM,qBAAqB;AAAA,EACvC;AAEA,MAAI,CAAC,UAAU,OAAO,WAAW,UAAU;AACzC,UAAM,IAAI,MAAM,sBAAsB;AAAA,EACxC;AAEA,QAAM,SAAS,aAAa,OAAO,QAAQ,OAAO;AAElD,SAAO;AAAA,IACL,GAAG;AAAA;AAAA;AAAA;AAAA,IAIH,IAAI,MAAc;AAChB,aAAO,OAAO,YAAY,aAAa;AAAA,IACzC;AAAA,IACA,eAAe,CAAC,cAAiC,CAAC,MAAuB;AACvE,aAAO,gBAAgB,YAAY,SAAS,OAAO,YAAY,UAAU,QAAQ,YAAY,OAAO;AAAA,IACtG;AAAA,IAEA,eAAe,CAAC,cAAqE,CAAC,MAAuB;AAC3G,aAAO;AAAA,QACL,YAAY,SAAS;AAAA,QACrB,YAAY,UAAU;AAAA,QACtB,YAAY;AAAA,QACZ,YAAY;AAAA,MACd;AAAA,IACF;AAAA,IAEA,eAAe,CAAC,cAAqE,CAAC,MAAuB;AAC3G,aAAO;AAAA,QACL,YAAY,SAAS;AAAA,QACrB,YAAY,UAAU;AAAA,QACtB,YAAY;AAAA,QACZ,YAAY;AAAA,MACd;AAAA,IACF;AAAA,IAEA,qBAAqB,CACnB,gBAC0B;AAC1B,aAAO;AAAA,QACL,YAAY,SAAS;AAAA,QACrB,YAAY,UAAU;AAAA,QACtB,YAAY;AAAA,QACZ,YAAY;AAAA,MACd;AAAA,IACF;AAAA,EACF;AACF;","names":[]}
1
+ {"version":3,"sources":["../builds/node.ts","../builds/models.ts"],"sourcesContent":["// 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.\n\nimport type { ClientOptions } from '@algolia/client-common';\nimport type { SearchClient } from '@algolia/client-search';\nimport { searchClient } from '@algolia/client-search';\n\nimport type { AbtestingClient } from '@algolia/client-abtesting';\nimport { abtestingClient } from '@algolia/client-abtesting';\nimport type { AnalyticsClient } from '@algolia/client-analytics';\nimport { analyticsClient } from '@algolia/client-analytics';\nimport type { InsightsClient } from '@algolia/client-insights';\nimport { insightsClient } from '@algolia/client-insights';\nimport type { PersonalizationClient } from '@algolia/client-personalization';\nimport { personalizationClient } from '@algolia/client-personalization';\nimport type { QuerySuggestionsClient } from '@algolia/client-query-suggestions';\nimport { querySuggestionsClient } from '@algolia/client-query-suggestions';\nimport type { IngestionClient } from '@algolia/ingestion';\nimport { ingestionClient } from '@algolia/ingestion';\nimport type { MonitoringClient } from '@algolia/monitoring';\nimport { monitoringClient } from '@algolia/monitoring';\nimport type { RecommendClient } from '@algolia/recommend';\nimport { recommendClient } from '@algolia/recommend';\n\nimport type {\n AbtestingRegionOptions,\n AnalyticsRegionOptions,\n IngestionRegionOptions,\n InitClientOptions,\n InsightsRegionOptions,\n PersonalizationRegionOptions,\n QuerySuggestionsRegionOptions,\n} from './models';\n\nexport * from './models';\n\nexport type Algoliasearch = SearchClient & {\n initAbtesting: (initOptions: InitClientOptions & AbtestingRegionOptions) => AbtestingClient;\n initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions) => AnalyticsClient;\n initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions) => IngestionClient;\n initInsights: (initOptions: InitClientOptions & InsightsRegionOptions) => InsightsClient;\n initMonitoring: (initOptions: InitClientOptions) => MonitoringClient;\n initPersonalization: (initOptions: InitClientOptions & PersonalizationRegionOptions) => PersonalizationClient;\n initQuerySuggestions: (initOptions: InitClientOptions & QuerySuggestionsRegionOptions) => QuerySuggestionsClient;\n initRecommend: (initOptions: InitClientOptions) => RecommendClient;\n};\n\nexport function algoliasearch(appId: string, apiKey: string, options?: ClientOptions): Algoliasearch {\n if (!appId || typeof appId !== 'string') {\n throw new Error('`appId` is missing.');\n }\n\n if (!apiKey || typeof apiKey !== 'string') {\n throw new Error('`apiKey` is missing.');\n }\n\n const client = searchClient(appId, apiKey, options);\n\n return {\n ...client,\n\n /**\n * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.\n */\n get _ua(): string {\n return client.transporter.algoliaAgent.value;\n },\n\n initAbtesting: (initOptions: InitClientOptions & AbtestingRegionOptions): AbtestingClient => {\n return abtestingClient(\n initOptions.appId || appId,\n initOptions.apiKey || apiKey,\n initOptions.region,\n initOptions.options,\n );\n },\n\n initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions): AnalyticsClient => {\n return analyticsClient(\n initOptions.appId || appId,\n initOptions.apiKey || apiKey,\n initOptions.region,\n initOptions.options,\n );\n },\n\n initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions): IngestionClient => {\n return ingestionClient(\n initOptions.appId || appId,\n initOptions.apiKey || apiKey,\n initOptions.region,\n initOptions.options,\n );\n },\n\n initInsights: (initOptions: InitClientOptions & InsightsRegionOptions): InsightsClient => {\n return insightsClient(\n initOptions.appId || appId,\n initOptions.apiKey || apiKey,\n initOptions.region,\n initOptions.options,\n );\n },\n\n initMonitoring: (initOptions: InitClientOptions): MonitoringClient => {\n return monitoringClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);\n },\n\n initPersonalization: (initOptions: InitClientOptions & PersonalizationRegionOptions): PersonalizationClient => {\n return personalizationClient(\n initOptions.appId || appId,\n initOptions.apiKey || apiKey,\n initOptions.region,\n initOptions.options,\n );\n },\n\n initQuerySuggestions: (initOptions: InitClientOptions & QuerySuggestionsRegionOptions): QuerySuggestionsClient => {\n return querySuggestionsClient(\n initOptions.appId || appId,\n initOptions.apiKey || apiKey,\n initOptions.region,\n initOptions.options,\n );\n },\n\n initRecommend: (initOptions: InitClientOptions): RecommendClient => {\n return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);\n },\n };\n}\n","// 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.\n\nimport type { Region as AbtestingRegion, RegionOptions as AbtestingRegionOptions } from '@algolia/client-abtesting';\nimport type { Region as AnalyticsRegion, RegionOptions as AnalyticsRegionOptions } from '@algolia/client-analytics';\nimport type { Region as InsightsRegion, RegionOptions as InsightsRegionOptions } from '@algolia/client-insights';\nimport type { Region as IngestionRegion, RegionOptions as IngestionRegionOptions } from '@algolia/ingestion';\n\nimport type {\n Region as PersonalizationRegion,\n RegionOptions as PersonalizationRegionOptions,\n} from '@algolia/client-personalization';\nimport type {\n Region as QuerySuggestionsRegion,\n RegionOptions as QuerySuggestionsRegionOptions,\n} from '@algolia/client-query-suggestions';\n\nimport { Status } from '@algolia/client-abtesting';\nimport type { ClientOptions } from '@algolia/client-common';\nimport { EventType } from '@algolia/client-personalization';\nimport type {\n Action,\n AdvancedSyntaxFeatures,\n AlternativesAsExact,\n Anchoring,\n AroundPrecision,\n AroundRadius,\n AroundRadiusAll,\n AutomaticFacetFilter,\n AutomaticFacetFilters,\n Banner,\n BannerImage,\n BannerImageUrl,\n BannerLink,\n BaseIndexSettings,\n BaseSearchParams,\n BaseSearchParamsWithoutQuery,\n BaseSearchResponse,\n BooleanString,\n Condition,\n Consequence,\n ConsequenceHide,\n ConsequenceParams,\n ConsequenceQuery,\n ConsequenceQueryObject,\n CustomDeleteProps,\n CustomGetProps,\n CustomPostProps,\n CustomPutProps,\n DeleteSourceProps,\n DeletedAtResponse,\n Distinct,\n Edit,\n EditType,\n ErrorBase,\n ExactOnSingleWordQuery,\n Exhaustive,\n FacetFilters,\n FacetOrdering,\n FacetStats,\n Facets,\n GetTaskProps,\n HighlightResult,\n HighlightResultOption,\n IgnorePlurals,\n IndexSettingsAsSearchParams,\n Languages,\n MatchLevel,\n MatchedGeoLocation,\n Mode,\n NumericFilters,\n OptionalFilters,\n Params,\n Personalization,\n Promote,\n PromoteObjectID,\n PromoteObjectIDs,\n QueryType,\n Range,\n RankingInfo,\n ReRankingApplyFilter,\n Redirect,\n RedirectRuleIndexData,\n RedirectRuleIndexMetadata,\n RedirectURL,\n RemoveStopWords,\n RemoveWordsIfNoResults,\n RenderingContent,\n SearchPagination,\n SearchParams,\n SearchParamsObject,\n SearchParamsQuery,\n SemanticSearch,\n SnippetResult,\n SnippetResultOption,\n SortRemainingBy,\n Source,\n SupportedLanguage,\n TagFilters,\n TaskStatus,\n TimeRange,\n TypoTolerance,\n TypoToleranceEnum,\n Value,\n Widgets,\n} from '@algolia/client-search';\nimport { apiClientVersion } from '@algolia/client-search';\n\ntype Region =\n | AbtestingRegion\n | AnalyticsRegion\n | IngestionRegion\n | InsightsRegion\n | PersonalizationRegion\n | QuerySuggestionsRegion;\ntype RegionOptions =\n | AbtestingRegionOptions\n | AnalyticsRegionOptions\n | IngestionRegionOptions\n | InsightsRegionOptions\n | PersonalizationRegionOptions\n | QuerySuggestionsRegionOptions;\n\nexport * from '@algolia/client-abtesting';\nexport * from '@algolia/client-analytics';\nexport * from '@algolia/client-insights';\nexport * from '@algolia/client-personalization';\nexport * from '@algolia/client-query-suggestions';\nexport * from '@algolia/client-search';\nexport * from '@algolia/ingestion';\nexport * from '@algolia/monitoring';\nexport * from '@algolia/recommend';\n\nexport {\n AbtestingRegion,\n AbtestingRegionOptions,\n Action,\n AdvancedSyntaxFeatures,\n AlternativesAsExact,\n AnalyticsRegion,\n AnalyticsRegionOptions,\n Anchoring,\n AroundPrecision,\n AroundRadius,\n AroundRadiusAll,\n AutomaticFacetFilter,\n AutomaticFacetFilters,\n Banner,\n BannerImage,\n BannerImageUrl,\n BannerLink,\n BaseIndexSettings,\n BaseSearchParams,\n BaseSearchParamsWithoutQuery,\n BaseSearchResponse,\n BooleanString,\n Condition,\n Consequence,\n ConsequenceHide,\n ConsequenceParams,\n ConsequenceQuery,\n ConsequenceQueryObject,\n CustomDeleteProps,\n CustomGetProps,\n CustomPostProps,\n CustomPutProps,\n DeleteSourceProps,\n DeletedAtResponse,\n Distinct,\n Edit,\n EditType,\n ErrorBase,\n EventType,\n ExactOnSingleWordQuery,\n Exhaustive,\n FacetFilters,\n FacetOrdering,\n FacetStats,\n Facets,\n GetTaskProps,\n HighlightResult,\n HighlightResultOption,\n IgnorePlurals,\n IndexSettingsAsSearchParams,\n IngestionRegion,\n IngestionRegionOptions,\n InsightsRegion,\n InsightsRegionOptions,\n Languages,\n MatchLevel,\n MatchedGeoLocation,\n Mode,\n NumericFilters,\n OptionalFilters,\n Params,\n Personalization,\n PersonalizationRegion,\n PersonalizationRegionOptions,\n Promote,\n PromoteObjectID,\n PromoteObjectIDs,\n QuerySuggestionsRegion,\n QuerySuggestionsRegionOptions,\n QueryType,\n Range,\n RankingInfo,\n ReRankingApplyFilter,\n Redirect,\n RedirectRuleIndexData,\n RedirectRuleIndexMetadata,\n RedirectURL,\n Region,\n RegionOptions,\n RemoveStopWords,\n RemoveWordsIfNoResults,\n RenderingContent,\n SearchPagination,\n SearchParams,\n SearchParamsObject,\n SearchParamsQuery,\n SemanticSearch,\n SnippetResult,\n SnippetResultOption,\n SortRemainingBy,\n Source,\n Status,\n SupportedLanguage,\n TagFilters,\n TaskStatus,\n TimeRange,\n TypoTolerance,\n TypoToleranceEnum,\n Value,\n Widgets,\n apiClientVersion,\n};\n\n/**\n * Options forwarded to the client initialized via the `init` method.\n */\nexport type InitClientOptions = Partial<{\n /**\n * App to target with the initialized client, defaults to the `algoliasearch` appId.\n */\n appId: string;\n /**\n * API key of the targeted app ID, defaults to the `algoliasearch` apiKey.\n */\n apiKey: string;\n options: ClientOptions;\n}>;\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAIA,SAAS,oBAAoB;AAG7B,SAAS,uBAAuB;AAEhC,SAAS,uBAAuB;AAEhC,SAAS,sBAAsB;AAE/B,SAAS,6BAA6B;AAEtC,SAAS,8BAA8B;AAEvC,SAAS,uBAAuB;AAEhC,SAAS,wBAAwB;AAEjC,SAAS,uBAAuB;;;ACrBhC;AAAA;AAAA;AAAA;AAAA;AAAA;AA0HA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAlHA,SAAS,cAAc;AAEvB,SAAS,iBAAiB;AAuF1B,SAAS,wBAAwB;AAiBjC,uCAAc;AACd,uCAAc;AACd,sCAAc;AACd,6CAAc;AACd,+CAAc;AACd,oCAAc;AACd,gCAAc;AACd,iCAAc;AACd,gCAAc;;;ADjGd,yBAAc;AAaP,SAAS,cAAc,OAAe,QAAgB,SAAwC;AACnG,MAAI,CAAC,SAAS,OAAO,UAAU,UAAU;AACvC,UAAM,IAAI,MAAM,qBAAqB;AAAA,EACvC;AAEA,MAAI,CAAC,UAAU,OAAO,WAAW,UAAU;AACzC,UAAM,IAAI,MAAM,sBAAsB;AAAA,EACxC;AAEA,QAAM,SAAS,aAAa,OAAO,QAAQ,OAAO;AAElD,SAAO;AAAA,IACL,GAAG;AAAA;AAAA;AAAA;AAAA,IAKH,IAAI,MAAc;AAChB,aAAO,OAAO,YAAY,aAAa;AAAA,IACzC;AAAA,IAEA,eAAe,CAAC,gBAA6E;AAC3F,aAAO;AAAA,QACL,YAAY,SAAS;AAAA,QACrB,YAAY,UAAU;AAAA,QACtB,YAAY;AAAA,QACZ,YAAY;AAAA,MACd;AAAA,IACF;AAAA,IAEA,eAAe,CAAC,gBAA6E;AAC3F,aAAO;AAAA,QACL,YAAY,SAAS;AAAA,QACrB,YAAY,UAAU;AAAA,QACtB,YAAY;AAAA,QACZ,YAAY;AAAA,MACd;AAAA,IACF;AAAA,IAEA,eAAe,CAAC,gBAA6E;AAC3F,aAAO;AAAA,QACL,YAAY,SAAS;AAAA,QACrB,YAAY,UAAU;AAAA,QACtB,YAAY;AAAA,QACZ,YAAY;AAAA,MACd;AAAA,IACF;AAAA,IAEA,cAAc,CAAC,gBAA2E;AACxF,aAAO;AAAA,QACL,YAAY,SAAS;AAAA,QACrB,YAAY,UAAU;AAAA,QACtB,YAAY;AAAA,QACZ,YAAY;AAAA,MACd;AAAA,IACF;AAAA,IAEA,gBAAgB,CAAC,gBAAqD;AACpE,aAAO,iBAAiB,YAAY,SAAS,OAAO,YAAY,UAAU,QAAQ,YAAY,OAAO;AAAA,IACvG;AAAA,IAEA,qBAAqB,CAAC,gBAAyF;AAC7G,aAAO;AAAA,QACL,YAAY,SAAS;AAAA,QACrB,YAAY,UAAU;AAAA,QACtB,YAAY;AAAA,QACZ,YAAY;AAAA,MACd;AAAA,IACF;AAAA,IAEA,sBAAsB,CAAC,gBAA2F;AAChH,aAAO;AAAA,QACL,YAAY,SAAS;AAAA,QACrB,YAAY,UAAU;AAAA,QACtB,YAAY;AAAA,QACZ,YAAY;AAAA,MACd;AAAA,IACF;AAAA,IAEA,eAAe,CAAC,gBAAoD;AAClE,aAAO,gBAAgB,YAAY,SAAS,OAAO,YAAY,UAAU,QAAQ,YAAY,OAAO;AAAA,IACtG;AAAA,EACF;AACF;","names":[]}
@@ -4,7 +4,7 @@ export type BaseGetApiKeyResponse = {
4
4
  /**
5
5
  * API key.
6
6
  */
7
- value?: string;
7
+ value: string;
8
8
 
9
9
  /**
10
10
  * Timestamp when the object was created, in milliseconds since the Unix epoch.
@@ -24,7 +24,7 @@ export type BaseIndexSettings = {
24
24
  unretrievableAttributes?: Array<string>;
25
25
 
26
26
  /**
27
- * Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
27
+ * Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
28
28
  */
29
29
  disableTypoToleranceOnWords?: Array<string>;
30
30
 
@@ -64,7 +64,7 @@ export type BaseIndexSettings = {
64
64
  numericAttributesForFiltering?: Array<string>;
65
65
 
66
66
  /**
67
- * Controls which separators are indexed. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren\'t indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches.
67
+ * Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
68
68
  */
69
69
  separatorsToIndex?: string;
70
70
 
@@ -127,7 +127,7 @@ export type BaseRecommendIndexSettings = {
127
127
  exactOnSingleWordQuery?: ExactOnSingleWordQuery;
128
128
 
129
129
  /**
130
- * Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
130
+ * Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)). - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
131
131
  */
132
132
  alternativesAsExact?: Array<AlternativesAsExact>;
133
133
 
@@ -28,6 +28,11 @@ export type BaseSearchResponse = Record<string, any> & {
28
28
 
29
29
  exhaustive?: Exhaustive;
30
30
 
31
+ /**
32
+ * Rules applied to the query.
33
+ */
34
+ appliedRules?: Array<Record<string, unknown>>;
35
+
31
36
  /**
32
37
  * See the `facetsCount` field of the `exhaustive` object in the response.
33
38
  */
@@ -148,7 +148,7 @@ export type IndexSettingsAsSearchParams = {
148
148
  exactOnSingleWordQuery?: ExactOnSingleWordQuery;
149
149
 
150
150
  /**
151
- * Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
151
+ * Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)). - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
152
152
  */
153
153
  alternativesAsExact?: Array<AlternativesAsExact>;
154
154
 
@@ -30,5 +30,5 @@ export type RecommendHit = Record<string, any> & {
30
30
  /**
31
31
  * Recommendation score.
32
32
  */
33
- _score: number;
33
+ _score?: number;
34
34
  };
@@ -7,7 +7,7 @@ export type TrendingFacetHit = {
7
7
  /**
8
8
  * Recommendation score.
9
9
  */
10
- _score: number;
10
+ _score?: number;
11
11
 
12
12
  /**
13
13
  * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
@@ -24,7 +24,7 @@ import type {
24
24
  import type { SearchForFacetValuesResponse } from '../model/searchForFacetValuesResponse';
25
25
  import type { SearchResponse } from '../model/searchResponse';
26
26
 
27
- export const apiClientVersion = '5.8.1';
27
+ export const apiClientVersion = '5.9.1';
28
28
 
29
29
  function getDefaultHosts(appId: string): Host[] {
30
30
  return (
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "5.8.1",
2
+ "version": "5.9.1",
3
3
  "repository": {
4
4
  "type": "git",
5
5
  "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -73,27 +73,31 @@
73
73
  "lite.d.ts"
74
74
  ],
75
75
  "dependencies": {
76
- "@algolia/client-abtesting": "5.8.1",
77
- "@algolia/client-analytics": "5.8.1",
78
- "@algolia/client-common": "5.8.1",
79
- "@algolia/client-personalization": "5.8.1",
80
- "@algolia/client-search": "5.8.1",
81
- "@algolia/recommend": "5.8.1",
82
- "@algolia/requester-browser-xhr": "5.8.1",
83
- "@algolia/requester-fetch": "5.8.1",
84
- "@algolia/requester-node-http": "5.8.1"
76
+ "@algolia/client-abtesting": "5.9.1",
77
+ "@algolia/client-analytics": "5.9.1",
78
+ "@algolia/client-common": "5.9.1",
79
+ "@algolia/client-insights": "5.9.1",
80
+ "@algolia/client-personalization": "5.9.1",
81
+ "@algolia/client-query-suggestions": "5.9.1",
82
+ "@algolia/client-search": "5.9.1",
83
+ "@algolia/ingestion": "1.9.1",
84
+ "@algolia/monitoring": "1.9.1",
85
+ "@algolia/recommend": "5.9.1",
86
+ "@algolia/requester-browser-xhr": "5.9.1",
87
+ "@algolia/requester-fetch": "5.9.1",
88
+ "@algolia/requester-node-http": "5.9.1"
85
89
  },
86
90
  "devDependencies": {
87
- "@algolia/requester-testing": "5.8.1",
91
+ "@algolia/requester-testing": "5.9.1",
88
92
  "@arethetypeswrong/cli": "0.16.4",
89
- "@types/node": "22.7.4",
93
+ "@types/node": "22.7.5",
90
94
  "jsdom": "25.0.1",
91
95
  "publint": "0.2.11",
92
96
  "rollup": "4.24.0",
93
97
  "tsup": "8.3.0",
94
- "typescript": "5.6.2",
98
+ "typescript": "5.6.3",
95
99
  "vitest": "2.1.2",
96
- "vitest-environment-miniflare": "2.14.3"
100
+ "vitest-environment-miniflare": "2.14.4"
97
101
  },
98
102
  "engines": {
99
103
  "node": ">= 14.0.0"