@algolia/recommend 5.0.0-alpha.73 → 5.0.0-alpha.76

package/model/ruleResponseMetadata.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 RuleResponseMetadata = {
+  /**
+   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+   */
+  lastUpdate?: string;
+};

package/model/searchParamsQuery.ts

@@ -2,7 +2,7 @@
 
 export type SearchParamsQuery = {
   /**
-   * The text to search in the index.
+   * Text to search for in an index.
    */
   query?: string;
 };

package/model/searchRecommendRulesParams.ts

@@ -0,0 +1,36 @@
+// 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.
+
+/**
+ * Recommend rules search parameters.
+ */
+export type SearchRecommendRulesParams = {
+  /**
+   * Full-text query.
+   */
+  query?: string;
+
+  /**
+   * Restricts responses to the specified [contextual rule](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#creating-contextual-rules).
+   */
+  context?: string;
+
+  /**
+   * Requested page (the first page is page 0).
+   */
+  page?: number;
+
+  /**
+   * Maximum number of hits per page.
+   */
+  hitsPerPage?: number;
+
+  /**
+   * Restricts responses to enabled rules. When absent (default), _all_ rules are retrieved.
+   */
+  enabled?: boolean | null;
+
+  /**
+   * Request options to send with the API call.
+   */
+  _requestOptions?: Array<Record<string, any>>;
+};

package/model/searchRecommendRulesResponse.ts

@@ -0,0 +1,25 @@
+// 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 { RuleResponse } from './ruleResponse';
+
+export type SearchRecommendRulesResponse = {
+  /**
+   * Fetched rules.
+   */
+  hits: RuleResponse[];
+
+  /**
+   * Number of fetched rules.
+   */
+  nbHits: number;
+
+  /**
+   * Current page.
+   */
+  page: number;
+
+  /**
+   * Number of pages.
+   */
+  nbPages: number;
+};

package/model/snippetResultOption.ts

@@ -7,7 +7,7 @@ import type { MatchLevel } from './matchLevel';
  */
 export type SnippetResultOption = {
   /**
-   * Markup text with occurrences highlighted.
+   * Markup text with `facetQuery` matches highlighted.
    */
   value: string;
 

package/model/sortRemainingBy.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.
 
 /**
- * How to display the remaining items.   - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
+ * How to display the remaining items:    - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
  */
 export type SortRemainingBy = 'alpha' | 'count' | 'hidden';

package/model/tagFilters.ts

@@ -3,6 +3,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 
 /**
- * Filter hits by tags.
+ * [Filter hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/).
  */
 export type TagFilters = MixedSearchFilters[] | string;

package/model/taskStatus.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.
+
+/**
+ * _published_ if the task has been processed, _notPublished_ otherwise.
+ */
+export type TaskStatus = 'notPublished' | 'published';

package/model/trendingModels.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.
 
 /**
- * The trending model to use.
+ * Trending model.
  */
 export type TrendingModels = 'trending-facets' | 'trending-items';

package/model/typoTolerance.ts

@@ -3,6 +3,6 @@
 import type { TypoToleranceEnum } from './typoToleranceEnum';
 
 /**
- * Controls whether typo tolerance is enabled and how it is applied.
+ * Controls whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
  */
 export type TypoTolerance = TypoToleranceEnum | boolean;

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@algolia/recommend",
-  "version": "5.0.0-alpha.73",
+  "version": "5.0.0-alpha.76",
   "description": "JavaScript client for recommend",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
   "author": "Algolia",
+  "type": "module",
   "exports": {
     ".": {
       "node": {
@@ -38,14 +39,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.73",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.73",
-    "@algolia/requester-node-http": "5.0.0-alpha.73"
+    "@algolia/client-common": "5.0.0-alpha.76",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.76",
+    "@algolia/requester-node-http": "5.0.0-alpha.76"
   },
   "devDependencies": {
-    "@types/node": "18.16.18",
-    "rollup": "2.79.1",
-    "typescript": "5.0.4"
+    "@types/node": "18.17.0",
+    "rollup": "3.26.3",
+    "typescript": "5.1.6"
   },
   "engines": {
     "node": ">= 14.0.0"