@algolia/recommend 5.6.1 → 5.8.0

package/model/recommendRule.ts

@@ -3,6 +3,7 @@
 import type { Condition } from './condition';
 import type { Consequence } from './consequence';
 import type { RuleMetadata } from './ruleMetadata';
+import type { TimeRange } from './timeRange';
 
 /**
  * Recommend rule.
@@ -28,4 +29,9 @@ export type RecommendRule = {
    * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
    */
   enabled?: boolean;
+
+  /**
+   * Time periods when the rule is active.
+   */
+  validity?: Array<TimeRange>;
 };

package/model/recommendSearchParams.ts

@@ -7,4 +7,4 @@ import type { SearchParamsQuery } from './searchParamsQuery';
 /**
  * Search parameters for filtering the recommendations.
  */
-export type RecommendSearchParams = BaseRecommendSearchParams & RecommendIndexSettings & SearchParamsQuery;
+export type RecommendSearchParams = BaseRecommendSearchParams & SearchParamsQuery & RecommendIndexSettings;

package/model/recommendUpdatedAtResponse.ts

@@ -0,0 +1,16 @@
+// 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.
+
+/**
+ * Response, taskID, and update timestamp.
+ */
+export type RecommendUpdatedAtResponse = {
+  /**
+   * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
+   */
+  taskID: number;
+
+  /**
+   * Date and time when the object was updated, in RFC 3339 format.
+   */
+  updatedAt: string;
+};

package/model/recommendationsHit.ts

@@ -1,6 +1,7 @@
 // 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 { RecommendHit } from './recommendHit';
+
 import type { TrendingFacetHit } from './trendingFacetHit';
 
 export type RecommendationsHit = RecommendHit | TrendingFacetHit;

package/model/recommendationsHits.ts

@@ -3,5 +3,5 @@
 import type { RecommendationsHit } from './recommendationsHit';
 
 export type RecommendationsHits = {
-  hits: RecommendationsHit[];
+  hits: Array<RecommendationsHit>;
 };

package/model/recommendationsRequest.ts

@@ -1,7 +1,9 @@
 // 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 { BoughtTogetherQuery } from './boughtTogetherQuery';
+
 import type { LookingSimilarQuery } from './lookingSimilarQuery';
+
 import type { RecommendedForYouQuery } from './recommendedForYouQuery';
 import type { RelatedQuery } from './relatedQuery';
 import type { TrendingFacetsQuery } from './trendingFacetsQuery';
@@ -9,8 +11,8 @@ import type { TrendingItemsQuery } from './trendingItemsQuery';
 
 export type RecommendationsRequest =
   | BoughtTogetherQuery
-  | LookingSimilarQuery
-  | RecommendedForYouQuery
   | RelatedQuery
+  | TrendingItemsQuery
   | TrendingFacetsQuery
-  | TrendingItemsQuery;
+  | LookingSimilarQuery
+  | RecommendedForYouQuery;

package/model/recommendationsResults.ts

@@ -4,4 +4,4 @@ import type { BaseSearchResponse } from './baseSearchResponse';
 import type { RecommendationsHits } from './recommendationsHits';
 import type { SearchPagination } from './searchPagination';
 
-export type RecommendationsResults = BaseSearchResponse & RecommendationsHits & SearchPagination;
+export type RecommendationsResults = BaseSearchResponse & SearchPagination & RecommendationsHits;

package/model/redirect.ts

@@ -6,5 +6,5 @@ import type { RedirectRuleIndexMetadata } from './redirectRuleIndexMetadata';
  * [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this this parameter is for internal use only.
  */
 export type Redirect = {
-  index?: RedirectRuleIndexMetadata[];
+  index?: Array<RedirectRuleIndexMetadata>;
 };

package/model/removeStopWords.ts

@@ -5,4 +5,4 @@ import type { SupportedLanguage } from './supportedLanguage';
 /**
  * Removes stop words from the search query.  Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words.  You should only use this feature for the languages used in your index.
  */
-export type RemoveStopWords = SupportedLanguage[] | boolean;
+export type RemoveStopWords = Array<SupportedLanguage> | boolean;

package/model/removeWordsIfNoResults.ts

@@ -3,4 +3,4 @@
 /**
  * Strategy for removing words from the query when it doesn\'t return any results. This helps to avoid returning empty search results.  - `none`.   No words are removed when a query doesn\'t return results.  - `lastWords`.   Treat the last (then second to last, then third to last) word as optional,   until there are results or at most 5 words have been removed.  - `firstWords`.   Treat the first (then second, then third) word as optional,   until there are results or at most 5 words have been removed.  - `allOptional`.   Treat all words as optional.  For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/).
  */
-export type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
+export type RemoveWordsIfNoResults = 'none' | 'lastWords' | 'firstWords' | 'allOptional';

package/model/renderingContent.ts

@@ -2,12 +2,15 @@
 
 import type { FacetOrdering } from './facetOrdering';
 import type { RedirectURL } from './redirectURL';
+import type { Widgets } from './widgets';
 
 /**
- * Extra data that can be used in the search UI.  You can use this to control aspects of your search UI, such as, the order of facet names and values without changing your frontend code.
+ * Extra data that can be used in the search UI.  You can use this to control aspects of your search UI, such as the order of facet names and values without changing your frontend code.
  */
 export type RenderingContent = {
   facetOrdering?: FacetOrdering;
 
   redirect?: RedirectURL;
+
+  widgets?: Widgets;
 };

package/model/searchRecommendRulesParams.ts

@@ -37,7 +37,7 @@ export type SearchRecommendRulesParams = {
   /**
    * Include facets and facet values in the response. Use `[\'*\']` to include all facets.
    */
-  facets?: string[];
+  facets?: Array<string>;
 
   /**
    * Maximum number of values to return for each facet.

package/model/searchRecommendRulesResponse.ts

@@ -6,7 +6,7 @@ export type SearchRecommendRulesResponse = {
   /**
    * Recommend rules that match the search criteria.
    */
-  hits: RecommendRule[];
+  hits: Array<RecommendRule>;
 
   /**
    * Number of results (hits).

package/model/snippetResult.ts

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

package/model/sortRemainingBy.ts

@@ -3,4 +3,4 @@
 /**
  * Order of facet values that aren\'t explicitly positioned with the `order` setting.  - `count`.   Order remaining facet values by decreasing count.   The count is the number of matching records containing this facet value.  - `alpha`.   Sort facet values alphabetically.  - `hidden`.   Don\'t show facet values that aren\'t explicitly positioned.
  */
-export type SortRemainingBy = 'alpha' | 'count' | 'hidden';
+export type SortRemainingBy = 'count' | 'alpha' | 'hidden';

package/model/supportedLanguage.ts

@@ -52,8 +52,8 @@ export type SupportedLanguage =
   | 'ns'
   | 'pl'
   | 'ps'
-  | 'pt-br'
   | 'pt'
+  | 'pt-br'
   | 'qu'
   | 'ro'
   | 'ru'

package/model/tagFilters.ts

@@ -3,4 +3,4 @@
 /**
  * Filter the search by values of the special `_tags` attribute.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won\'t get a facet count. The same combination and escaping rules apply as for `facetFilters`.
  */
-export type TagFilters = TagFilters[] | string;
+export type TagFilters = Array<TagFilters> | string;

package/model/taskStatus.ts

@@ -3,4 +3,4 @@
 /**
  * Task status, `published` if the task is completed, `notPublished` otherwise.
  */
-export type TaskStatus = 'notPublished' | 'published';
+export type TaskStatus = 'published' | 'notPublished';

package/model/timeRange.ts

@@ -0,0 +1,13 @@
+// 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 TimeRange = {
+  /**
+   * When the rule should start to be active, in Unix epoch time.
+   */
+  from: number;
+
+  /**
+   * When the rule should stop to be active, in Unix epoch time.
+   */
+  until: number;
+};

package/model/typoTolerance.ts

@@ -3,6 +3,6 @@
 import type { TypoToleranceEnum } from './typoToleranceEnum';
 
 /**
- * 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 concetenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) is also active.
+ * 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.
  */
-export type TypoTolerance = TypoToleranceEnum | boolean;
+export type TypoTolerance = boolean | TypoToleranceEnum;

package/model/value.ts

@@ -6,12 +6,12 @@ export type Value = {
   /**
    * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
    */
-  order?: string[];
+  order?: Array<string>;
 
   sortRemainingBy?: SortRemainingBy;
 
   /**
    * Hide facet values.
    */
-  hide?: string[];
+  hide?: Array<string>;
 };

package/model/widgets.ts

@@ -0,0 +1,10 @@
+// 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 { Banners } from './banners';
+
+/**
+ * widgets returned from any rules that are applied to the current search.
+ */
+export type Widgets = {
+  banners?: Banners;
+};

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.6.1",
+  "version": "5.8.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -49,16 +49,16 @@
     "index.d.ts"
   ],
   "dependencies": {
-    "@algolia/client-common": "5.6.1",
-    "@algolia/requester-browser-xhr": "5.6.1",
-    "@algolia/requester-fetch": "5.6.1",
-    "@algolia/requester-node-http": "5.6.1"
+    "@algolia/client-common": "5.8.0",
+    "@algolia/requester-browser-xhr": "5.8.0",
+    "@algolia/requester-fetch": "5.8.0",
+    "@algolia/requester-node-http": "5.8.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.16.4",
-    "@types/node": "22.5.5",
+    "@types/node": "22.7.4",
     "publint": "0.2.11",
-    "rollup": "4.22.4",
+    "rollup": "4.24.0",
     "tsup": "8.3.0",
     "typescript": "5.6.2"
   },