@algolia/recommend 5.0.0-alpha.2 → 5.0.0-alpha.20

package/model/personalization.ts

@@ -5,10 +5,12 @@ export type Personalization = {
    * The score of the filters.
    */
   filtersScore?: number;
+
   /**
    * The score of the ranking.
    */
   rankingScore?: number;
+
   /**
    * The score of the event.
    */

package/model/rankingInfo.ts

@@ -8,44 +8,56 @@ 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.
    */

package/model/recommendHit.ts

@@ -12,16 +12,21 @@ 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.
    */

package/model/snippetResultOption.ts

@@ -10,5 +10,6 @@ export type SnippetResultOption = {
    * Markup text with occurrences highlighted.
    */
   value: string;
+
   matchLevel: MatchLevel;
 };

package/model/value.ts

@@ -7,5 +7,6 @@ export type Value = {
    * Pinned order of facet lists.
    */
   order?: string[];
+
   sortRemainingBy?: SortRemainingBy;
 };

package/package.json

@@ -1,16 +1,32 @@
 {
   "name": "@algolia/recommend",
-  "version": "5.0.0-alpha.2",
+  "version": "5.0.0-alpha.20",
   "description": "JavaScript client for recommend",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
   "author": "Algolia",
-  "main": "index.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",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/recommend.esm.node.js",
+        "module": "./dist/recommend.esm.node.js",
+        "require": "./dist/recommend.cjs.js",
+        "default": "./dist/recommend.cjs.js"
+      },
+      "default": {
+        "umd": "./dist/recommend.umd.js",
+        "module": "./dist/recommend.esm.browser.js",
+        "import": "./dist/recommend.esm.browser.js",
+        "default": "./dist/recommend.umd.js"
+      }
+    },
+    "./src/*": "./src/*.ts",
+    "./model": "./model/index.ts"
+  },
+  "jsdelivr": "./dist/recommend.umd.js",
+  "unpkg": "./dist/recommend.umd.js",
+  "browser": "./dist/recommend.umd.js",
+  "types": "./index.d.ts",
   "files": [
     "dist",
     "model",
@@ -18,16 +34,18 @@
     "index.d.ts"
   ],
   "scripts": {
-    "clean": "rm -rf ./dist"
+    "build": "yarn clean && rollup --config",
+    "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.2",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.2",
-    "@algolia/requester-node-http": "5.0.0-alpha.2"
+    "@algolia/client-common": "5.0.0-alpha.20",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.20",
+    "@algolia/requester-node-http": "5.0.0-alpha.20"
   },
   "devDependencies": {
-    "@types/node": "16.11.45",
-    "typescript": "4.7.4"
+    "@types/node": "16.11.58",
+    "rollup": "2.79.0",
+    "typescript": "4.8.3"
   },
   "engines": {
     "node": ">= 14.0.0"