@algolia/recommend 4.14.2 → 5.0.0-alpha.3

package/model/personalization.ts

@@ -0,0 +1,18 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type Personalization = {
+  /**
+   * The score of the filters.
+   */
+  filtersScore?: number;
+
+  /**
+   * The score of the ranking.
+   */
+  rankingScore?: number;
+
+  /**
+   * The score of the event.
+   */
+  score?: number;
+};

package/model/queryType.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Controls if and how query words are interpreted as prefixes.
+ */
+export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';

package/model/rankingInfo.ts

@@ -0,0 +1,65 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { MatchedGeoLocation } from './matchedGeoLocation';
+import type { Personalization } from './personalization';
+
+export type RankingInfo = {
+  /**
+   * This field is reserved for advanced usage.
+   */
+  filters: number;
+
+  /**
+   * Position of the most important matched attribute in the attributes to index list.
+   */
+  firstMatchedWord: number;
+
+  /**
+   * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
+   */
+  geoDistance: number;
+
+  /**
+   * Precision used when computing the geo distance, in meters.
+   */
+  geoPrecision?: number;
+
+  matchedGeoLocation?: MatchedGeoLocation;
+
+  personalization?: Personalization;
+
+  /**
+   * Number of exactly matched words.
+   */
+  nbExactWords: number;
+
+  /**
+   * Number of typos encountered when matching the record.
+   */
+  nbTypos: number;
+
+  /**
+   * Present and set to true if a Rule promoted the hit.
+   */
+  promoted: boolean;
+
+  /**
+   * When the query contains more than one word, the sum of the distances between matched words (in meters).
+   */
+  proximityDistance?: number;
+
+  /**
+   * Custom ranking for the object, expressed as a single integer value.
+   */
+  userScore: number;
+
+  /**
+   * Number of matched words, including prefixes and typos.
+   */
+  words: number;
+
+  /**
+   * Wether the record are promoted by the re-ranking strategy.
+   */
+  promotedByReRanking?: boolean;
+};

package/model/reRankingApplyFilter.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { MixedSearchFilters } from './mixedSearchFilters';
+
+/**
+ * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
+ */
+export type ReRankingApplyFilter = MixedSearchFilters[] | string;

package/model/recommendHit.ts

@@ -0,0 +1,34 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { HighlightResult } from './highlightResult';
+import type { RankingInfo } from './rankingInfo';
+import type { SnippetResult } from './snippetResult';
+
+/**
+ * A Recommend hit.
+ */
+export type RecommendHit = Record<string, any> & {
+  /**
+   * Unique identifier of the object.
+   */
+  objectID: string;
+
+  /**
+   * Show highlighted section and words matched on a query.
+   */
+  _highlightResult?: Record<string, HighlightResult>;
+
+  /**
+   * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+   */
+  _snippetResult?: Record<string, SnippetResult>;
+
+  _rankingInfo?: RankingInfo;
+
+  _distinctSeqID?: number;
+
+  /**
+   * The recommendation score.
+   */
+  _score: number;
+};

package/model/recommendHits.ts

@@ -0,0 +1,7 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { RecommendHit } from './recommendHit';
+
+export type RecommendHits = {
+  hits: RecommendHit[];
+};

package/model/recommendationModels.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * The recommendation model to use.
+ */
+export type RecommendationModels = 'bought-together' | 'related-products';

package/model/recommendationRequest.ts

@@ -0,0 +1,7 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { BaseRecommendationRequest } from './baseRecommendationRequest';
+
+export type RecommendationRequest = BaseRecommendationRequest &
+  BaseRecommendRequest;

package/model/recommendationsRequest.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { RecommendationRequest } from './recommendationRequest';
+import type { TrendingRequest } from './trendingRequest';
+
+export type RecommendationsRequest = RecommendationRequest | TrendingRequest;

package/model/recommendationsResponse.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { BaseSearchResponse } from './baseSearchResponse';
+import type { RecommendHits } from './recommendHits';
+
+export type RecommendationsResponse = BaseSearchResponse & RecommendHits;

package/model/removeStopWords.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Removes stop (common) words from the query before executing it. RemoveStopWords is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
+ */
+export type RemoveStopWords = string[] | boolean;

package/model/removeWordsIfNoResults.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Selects a strategy to remove words from the query when it doesn\'t match any hits.
+ */
+export type RemoveWordsIfNoResults =
+  | 'allOptional'
+  | 'firstWords'
+  | 'lastWords'
+  | 'none';

package/model/renderingContent.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { FacetOrdering } from './facetOrdering';
+
+/**
+ * Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules.
+ */
+export type RenderingContent = {
+  facetOrdering?: FacetOrdering;
+};

package/model/searchParamsObject.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { BaseSearchParams } from './baseSearchParams';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+
+export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;

package/model/searchParamsQuery.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SearchParamsQuery = {
+  /**
+   * The text to search in the index.
+   */
+  query?: string;
+};

package/model/snippetResult.ts

@@ -0,0 +1,5 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SnippetResultOption } from './snippetResultOption';
+
+export type SnippetResult = SnippetResultOption | SnippetResultOption[];

package/model/snippetResultOption.ts

@@ -0,0 +1,15 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { MatchLevel } from './matchLevel';
+
+/**
+ * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+ */
+export type SnippetResultOption = {
+  /**
+   * Markup text with occurrences highlighted.
+   */
+  value: string;
+
+  matchLevel: MatchLevel;
+};

package/model/sortRemainingBy.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * 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

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { MixedSearchFilters } from './mixedSearchFilters';
+
+/**
+ * Filter hits by tags.
+ */
+export type TagFilters = MixedSearchFilters[] | string;

package/model/trendingModels.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * The trending model to use.
+ */
+export type TrendingModels = 'trending-facets' | 'trending-items';

package/model/trendingRequest.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { BaseTrendingRequest } from './baseTrendingRequest';
+
+export type TrendingRequest = BaseRecommendRequest & BaseTrendingRequest;

package/model/typoTolerance.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { TypoToleranceEnum } from './typoToleranceEnum';
+
+/**
+ * Controls whether typo tolerance is enabled and how it is applied.
+ */
+export type TypoTolerance = TypoToleranceEnum | boolean;

package/model/typoToleranceEnum.ts

@@ -0,0 +1,3 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type TypoToleranceEnum = 'min' | 'strict';

package/model/value.ts

@@ -0,0 +1,12 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SortRemainingBy } from './sortRemainingBy';
+
+export type Value = {
+  /**
+   * Pinned order of facet lists.
+   */
+  order?: string[];
+
+  sortRemainingBy?: SortRemainingBy;
+};

package/package.json

@@ -1,37 +1,35 @@
 {
   "name": "@algolia/recommend",
-  "version": "4.14.2",
-  "private": false,
-  "description": "The perfect starting point to integrate Algolia Recommend within your JavaScript project.",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/algolia/algoliasearch-client-javascript.git"
-  },
+  "version": "5.0.0-alpha.3",
+  "description": "JavaScript client for recommend",
+  "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
-  "sideEffects": false,
+  "author": "Algolia",
   "main": "index.js",
-  "jsdelivr": "./dist/recommend.umd.js",
-  "unpkg": "./dist/recommend.umd.js",
-  "browser": {
-    "./index.js": "./dist/recommend.umd.js"
-  },
+  "jsdelivr": "dist/recommend.umd.js",
+  "unpkg": "dist/recommend.umd.js",
+  "module": "dist/recommend.esm.node.js",
+  "browser": "dist/recommend.umd.js",
   "types": "index.d.ts",
   "files": [
     "dist",
+    "model",
     "index.js",
     "index.d.ts"
   ],
+  "scripts": {
+    "clean": "rm -rf ./dist"
+  },
   "dependencies": {
-    "@algolia/cache-browser-local-storage": "4.14.2",
-    "@algolia/cache-common": "4.14.2",
-    "@algolia/cache-in-memory": "4.14.2",
-    "@algolia/client-common": "4.14.2",
-    "@algolia/client-search": "4.14.2",
-    "@algolia/logger-common": "4.14.2",
-    "@algolia/logger-console": "4.14.2",
-    "@algolia/requester-browser-xhr": "4.14.2",
-    "@algolia/requester-common": "4.14.2",
-    "@algolia/requester-node-http": "4.14.2",
-    "@algolia/transporter": "4.14.2"
+    "@algolia/client-common": "5.0.0-alpha.3",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.3",
+    "@algolia/requester-node-http": "5.0.0-alpha.3"
+  },
+  "devDependencies": {
+    "@types/node": "16.11.45",
+    "typescript": "4.7.4"
+  },
+  "engines": {
+    "node": ">= 14.0.0"
   }
 }

package/README.md

@@ -1,76 +0,0 @@
-<p align="center">
-  <h1>Algolia Recommend</h1>
-
-  <h4>The perfect starting point to integrate <a href="https://www.algolia.com/products/recommendations" target="_blank">Algolia Recommend</a> within your JavaScript project</h4>
-
-  <p align="center">
-    <a href="https://npmjs.org/package/@algolia/recommend"><img src="https://img.shields.io/npm/v/@algolia/recommend.svg?style=flat-square" alt="NPM version"></img></a>
-    <a href="LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License"></a>
-  </p>
-</p>
-
-<p align="center">
-  <a href="https://www.algolia.com/doc/api-client/methods/recommend/" target="_blank">Documentation</a>  •
-  <a href="https://www.algolia.com/doc/ui-libraries/recommend/introduction/what-is-recommend/" target="_blank">UI library</a>  •
-  <a href="https://discourse.algolia.com" target="_blank">Community Forum</a>  •
-  <a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a>  •
-  <a href="https://github.com/algolia/algoliasearch-client-javascript/issues" target="_blank">Report a bug</a>  •
-  <a href="https://www.algolia.com/support" target="_blank">Support</a>
-</p>
-
-## ✨ Features
-
-- Thin & **minimal low-level HTTP client** to interact with Algolia's Recommend API
-- Works both on the **browser** and **node.js**
-- **UMD compatible**, you can use it with any module loader
-- Built with TypeScript
-
-## 💡 Getting Started
-
-First, install Algolia Recommend API Client via the [npm](https://www.npmjs.com/get-npm) package manager:
-
-```bash
-npm install @algolia/recommend
-```
-
-Then, let's retrieve recommendations:
-
-```js
-const algoliarecommend = require('@algolia/recommend');
-
-const client = algoliarecommend('YourApplicationID', 'YourAdminAPIKey');
-
-client
-  .getFrequentlyBoughtTogether([
-    {
-      indexName: 'your_index_name',
-      objectID: 'your_object_id',
-    },
-  ])
-  .then(({ results }) => {
-    console.log(results);
-  })
-  .catch(err => {
-    console.log(err);
-  });
-
-client
-  .getRelatedProducts([
-    {
-      indexName: 'your_index_name',
-      objectID: 'your_object_id',
-    },
-  ])
-  .then(({ results }) => {
-    console.log(results);
-  })
-  .catch(err => {
-    console.log(err);
-  });
-```
-
-For full documentation, visit the **[online documentation](https://www.algolia.com/doc/api-client/methods/recommend/)**.
-
-## 📄 License
-
-Algolia Recommend API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).

package/dist/recommend.d.ts

@@ -1,162 +0,0 @@
-import { AuthModeType } from '@algolia/client-common';
-import { ClientTransporterOptions } from '@algolia/client-common';
-import { Destroyable } from '@algolia/requester-common';
-import { MultipleQueriesResponse } from '@algolia/client-search';
-import { RequestOptions } from '@algolia/transporter';
-import { SearchOptions } from '@algolia/client-search';
-import { Transporter } from '@algolia/transporter';
-
-export declare type BaseRecommendClient = {
-    /**
-     * The application id.
-     */
-    readonly appId: string;
-    /**
-     * The underlying transporter.
-     */
-    readonly transporter: Transporter;
-    /**
-     * Mutates the transporter, adding the given user agent.
-     */
-    readonly addAlgoliaAgent: (segment: string, version?: string) => void;
-    /**
-     * Clears both requests and responses caches.
-     */
-    readonly clearCache: () => Readonly<Promise<void>>;
-};
-
-export declare type FrequentlyBoughtTogetherQuery = Omit<RecommendationsQuery, 'model' | 'fallbackParameters'>;
-
-declare function recommend(appId: string, apiKey: string, options?: RecommendOptions): RecommendClient;
-
-declare namespace recommend {
-    var version: string;
-}
-export default recommend;
-
-export declare type RecommendationsQuery = {
-    /**
-     * The name of the target index.
-     */
-    readonly indexName: string;
-    /**
-     * The name of the Recommendation model to use.
-     */
-    readonly model: RecommendModel;
-    /**
-     * The `objectID` of the item to get recommendations for.
-     */
-    readonly objectID: string;
-    /**
-     * Threshold for the recommendations confidence score (between 0 and 100). Only recommendations with a greater score are returned.
-     */
-    readonly threshold?: number;
-    /**
-     * How many recommendations to retrieve.
-     */
-    readonly maxRecommendations?: number;
-    /**
-     * List of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/) to send.
-     */
-    readonly queryParameters?: RecommendSearchOptions;
-    /**
-     * List of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/) to send.
-     *
-     * Additional filters to use as fallback when there aren’t enough recommendations.
-     */
-    readonly fallbackParameters?: RecommendSearchOptions;
-};
-
-export declare type RecommendClient = WithRecommendMethods<BaseRecommendClient> & Destroyable;
-
-export declare type RecommendClientOptions = {
-    /**
-     * The application id.
-     */
-    readonly appId: string;
-    /**
-     * The api key.
-     */
-    readonly apiKey: string;
-    /**
-     * The auth mode type. In browser environments credentials may
-     * be passed within the headers.
-     */
-    readonly authMode?: AuthModeType;
-};
-
-export declare type RecommendModel = 'related-products' | 'bought-together' | TrendingModel;
-
-export declare type RecommendOptions = Partial<ClientTransporterOptions>;
-
-export declare type RecommendSearchOptions = Omit<SearchOptions, 'page' | 'hitsPerPage' | 'offset' | 'length'>;
-
-export declare type RelatedProductsQuery = Omit<RecommendationsQuery, 'model'>;
-
-export declare type TrendingFacetsQuery = Omit<TrendingQuery, 'model' | 'facetValue'>;
-
-export declare type TrendingItemsQuery = Omit<TrendingQuery, 'model'>;
-
-export declare type TrendingModel = 'trending-items' | 'trending-facets';
-
-export declare type TrendingQuery = {
-    /**
-     * The name of the target index.
-     */
-    readonly indexName: string;
-    /**
-     * The name of the Recommendation model to use.
-     */
-    readonly model: TrendingModel;
-    /**
-     * Threshold for the recommendations confidence score (between 0 and 100). Only recommendations with a greater score are returned.
-     */
-    readonly threshold?: number;
-    /**
-     * How many recommendations to retrieve.
-     */
-    readonly maxRecommendations?: number;
-    /**
-     * List of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/) to send.
-     */
-    readonly queryParameters?: RecommendSearchOptions;
-    /**
-     * List of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/) to send.
-     *
-     * Additional filters to use as fallback when there aren’t enough recommendations.
-     */
-    readonly fallbackParameters?: RecommendSearchOptions;
-    /**
-     * Used for trending model
-     */
-    readonly facetName?: string;
-    /**
-     * Used for trending model
-     */
-    readonly facetValue?: string;
-};
-
-export declare type WithRecommendMethods<TType> = TType & {
-    /**
-     * Returns recommendations.
-     */
-    readonly getRecommendations: <TObject>(queries: readonly RecommendationsQuery[], requestOptions?: RequestOptions & SearchOptions) => Readonly<Promise<MultipleQueriesResponse<TObject>>>;
-    /**
-     * Returns [Related Products](https://algolia.com/doc/guides/algolia-ai/recommend/#related-products).
-     */
-    readonly getRelatedProducts: <TObject>(queries: readonly RelatedProductsQuery[], requestOptions?: RequestOptions & SearchOptions) => Readonly<Promise<MultipleQueriesResponse<TObject>>>;
-    /**
-     * Returns [Frequently Bought Together](https://algolia.com/doc/guides/algolia-ai/recommend/#frequently-bought-together) products.
-     */
-    readonly getFrequentlyBoughtTogether: <TObject>(queries: readonly FrequentlyBoughtTogetherQuery[], requestOptions?: RequestOptions & SearchOptions) => Readonly<Promise<MultipleQueriesResponse<TObject>>>;
-    /**
-     * Returns trending items
-     */
-    readonly getTrendingItems: <TObject>(queries: readonly TrendingItemsQuery[], requestOptions?: RequestOptions & SearchOptions) => Readonly<Promise<MultipleQueriesResponse<TObject>>>;
-    /**
-     * Returns trending items per facet
-     */
-    readonly getTrendingFacets: <TObject>(queries: readonly TrendingFacetsQuery[], requestOptions?: RequestOptions & SearchOptions) => Readonly<Promise<MultipleQueriesResponse<TObject>>>;
-};
-
-export { }