instantsearch.js 4.37.0 → 4.38.0

package/es/helpers/reverseHighlight.js

@@ -1,4 +1,4 @@
-import { TAG_REPLACEMENT, getPropertyByPath, getHighlightedParts, reverseHighlightedParts, concatHighlightedParts } from "../lib/utils/index.js";
+import { TAG_REPLACEMENT, getPropertyByPath, getHighlightedParts, reverseHighlightedParts, concatHighlightedParts, warning } from "../lib/utils/index.js";
 import { component } from "../lib/suit.js";
 var suit = component('ReverseHighlight');
 export default function reverseHighlight(_ref) {
@@ -8,8 +8,11 @@ export default function reverseHighlight(_ref) {
       hit = _ref.hit,
       _ref$cssClasses = _ref.cssClasses,
       cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+  var highlightAttributeResult = getPropertyByPath(hit._highlightResult, attribute); // @MAJOR fallback to attribute value if highlight is not found
 
-  var _ref2 = getPropertyByPath(hit._highlightResult, attribute) || {},
+  process.env.NODE_ENV === 'development' ? warning(highlightAttributeResult, "Could not enable reverse highlight for \"".concat(attribute, "\", will display an empty string.\nPlease check whether this attribute exists and is either searchable or specified in `attributesToHighlight`.\n\nSee: https://alg.li/highlighting\n")) : void 0;
+
+  var _ref2 = highlightAttributeResult || {},
       _ref2$value = _ref2.value,
       attributeValue = _ref2$value === void 0 ? '' : _ref2$value; // cx is not used, since it would be bundled as a dependency for Vue & Angular
 

package/es/helpers/reverseSnippet.js

@@ -1,4 +1,4 @@
-import { TAG_REPLACEMENT, getPropertyByPath, getHighlightedParts, reverseHighlightedParts, concatHighlightedParts } from "../lib/utils/index.js";
+import { TAG_REPLACEMENT, getPropertyByPath, getHighlightedParts, reverseHighlightedParts, concatHighlightedParts, warning } from "../lib/utils/index.js";
 import { component } from "../lib/suit.js";
 var suit = component('ReverseSnippet');
 export default function reverseSnippet(_ref) {
@@ -8,8 +8,11 @@ export default function reverseSnippet(_ref) {
       hit = _ref.hit,
       _ref$cssClasses = _ref.cssClasses,
       cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+  var snippetAttributeResult = getPropertyByPath(hit._snippetResult, attribute); // @MAJOR fallback to attribute value if snippet is not found
 
-  var _ref2 = getPropertyByPath(hit._snippetResult, attribute) || {},
+  process.env.NODE_ENV === 'development' ? warning(snippetAttributeResult, "Could not enable reverse snippet for \"".concat(attribute, "\", will display an empty string.\nPlease check whether this attribute exists and is specified in `attributesToSnippet`.\n\nSee: https://alg.li/highlighting\n")) : void 0;
+
+  var _ref2 = snippetAttributeResult || {},
       _ref2$value = _ref2.value,
       attributeValue = _ref2$value === void 0 ? '' : _ref2$value; // cx is not used, since it would be bundled as a dependency for Vue & Angular
 

package/es/helpers/snippet.js

@@ -1,5 +1,5 @@
 import { component } from "../lib/suit.js";
-import { TAG_REPLACEMENT, getPropertyByPath } from "../lib/utils/index.js";
+import { TAG_REPLACEMENT, getPropertyByPath, warning } from "../lib/utils/index.js";
 var suit = component('Snippet');
 export default function snippet(_ref) {
   var attribute = _ref.attribute,
@@ -8,8 +8,11 @@ export default function snippet(_ref) {
       hit = _ref.hit,
       _ref$cssClasses = _ref.cssClasses,
       cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+  var snippetAttributeResult = getPropertyByPath(hit._snippetResult, attribute); // @MAJOR fallback to attribute value if snippet is not found
 
-  var _ref2 = getPropertyByPath(hit._snippetResult, attribute) || {},
+  process.env.NODE_ENV === 'development' ? warning(snippetAttributeResult, "Could not enable snippet for \"".concat(attribute, "\", will display an empty string.\nPlease check whether this attribute exists and is specified in `attributesToSnippet`.\n\nSee: https://alg.li/highlighting\n")) : void 0;
+
+  var _ref2 = snippetAttributeResult || {},
       _ref2$value = _ref2.value,
       attributeValue = _ref2$value === void 0 ? '' : _ref2$value; // cx is not used, since it would be bundled as a dependency for Vue & Angular
 

package/es/lib/InstantSearch.js

@@ -425,10 +425,15 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
 
       mainHelper.on('error', function (_ref4) {
         var error = _ref4.error;
-
-        _this3.emit('error', {
-          error: error
-        });
+        // If an error is emitted, it is re-thrown by events. In previous versions
+        // we emitted {error}, which is thrown as:
+        // "Uncaught, unspecified \"error\" event. ([object Object])"
+        // To avoid breaking changes, we make the error available in both
+        // `error` and `error.error`
+        // @MAJOR emit only error
+        error.error = error;
+
+        _this3.emit('error', error);
       });
       this.mainHelper = mainHelper;
       this.middleware.forEach(function (_ref5) {

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.37.0";
+declare const _default: "4.38.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.37.0';
+export default '4.38.0';

package/es/package.json

@@ -1 +1 @@
-{"type":"module"}
+{"type":"module","sideEffects":false}

package/es/types/widget.d.ts

@@ -129,10 +129,13 @@ declare type RenderStateLifeCycle<TWidgetDescription extends WidgetDescription &
 export declare type Widget<TWidgetDescription extends WidgetDescription & WidgetParams = {
     $$type: string;
 }> = Expand<RequiredWidgetLifeCycle<TWidgetDescription> & WidgetType<TWidgetDescription> & UiStateLifeCycle<TWidgetDescription> & RenderStateLifeCycle<TWidgetDescription>>;
+export declare type TransformItemsMetadata = {
+    results?: SearchResults;
+};
 /**
  * Transforms the given items.
  */
-export declare type TransformItems<TItem> = (items: TItem[]) => TItem[];
+export declare type TransformItems<TItem, TMetadata = TransformItemsMetadata> = (items: TItem[], metadata: TMetadata) => TItem[];
 /**
  * Transforms the given items.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.37.0",
+  "version": "4.38.0",
   "description": "InstantSearch.js is a JavaScript library for building performant and instant search experiences with Algolia.",
   "homepage": "https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/",
   "types": "es/index.d.ts",
@@ -25,7 +25,7 @@
     "build": "yarn run build:cjs && yarn run build:es && yarn run build:umd && yarn run build:types",
     "build:umd": "rm -rf dist && BABEL_ENV=umd rollup --config scripts/rollup/config.js",
     "build:cjs": "rm -rf cjs && BABEL_ENV=cjs babel src --extensions '.js,.ts,.tsx' --out-dir cjs/ --ignore 'src/index.es.ts','**/__tests__','**/__mocks__' --quiet",
-    "build:es": "rm -rf es && BABEL_ENV=es babel src --extensions '.js,.ts,.tsx' --out-dir es/ --ignore 'src/index.es.ts','**/__tests__','**/__mocks__' --quiet && BABEL_ENV=es babel src/index.es.ts --out-file es/index.js --quiet && echo '{\"type\":\"module\"}' > es/package.json",
+    "build:es": "rm -rf es && BABEL_ENV=es babel src --extensions '.js,.ts,.tsx' --out-dir es/ --ignore 'src/index.es.ts','**/__tests__','**/__mocks__' --quiet && BABEL_ENV=es babel src/index.es.ts --out-file es/index.js --quiet && echo '{\"type\":\"module\",\"sideEffects\":false}' > es/package.json",
     "build:types": "./scripts/typescript/extract.js",
     "doctoc": "doctoc --no-title --maxlevel 3 README.md CONTRIBUTING.md",
     "storybook": "start-storybook --quiet --port 6006 --ci --static-dir .storybook/static",
@@ -140,7 +140,7 @@
     "rollup-plugin-uglify": "6.0.4",
     "scriptjs": "2.5.9",
     "semver": "6.3.0",
-    "shelljs": "0.8.3",
+    "shelljs": "0.8.4",
     "shipjs": "0.21.0",
     "typescript": "4.3.5",
     "webpack": "4.41.5"

package/cjs/components/Pagination/PaginationLink.js

@@ -1,60 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _preact = require("preact");
-
-var _classnames = _interopRequireDefault(require("classnames"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/** @jsx h */
-function PaginationLink(_ref) {
-  var label = _ref.label,
-      ariaLabel = _ref.ariaLabel,
-      pageNumber = _ref.pageNumber,
-      _ref$additionalClassN = _ref.additionalClassName,
-      additionalClassName = _ref$additionalClassN === void 0 ? null : _ref$additionalClassN,
-      _ref$isDisabled = _ref.isDisabled,
-      isDisabled = _ref$isDisabled === void 0 ? false : _ref$isDisabled,
-      _ref$isSelected = _ref.isSelected,
-      isSelected = _ref$isSelected === void 0 ? false : _ref$isSelected,
-      cssClasses = _ref.cssClasses,
-      createURL = _ref.createURL,
-      handleClick = _ref.handleClick;
-  var classes = {
-    item: (0, _classnames.default)(cssClasses.item, additionalClassName, isDisabled && cssClasses.disabledItem, isSelected && cssClasses.selectedItem),
-    link: cssClasses.link
-  };
-
-  if (isDisabled) {
-    return (0, _preact.h)("li", {
-      className: classes.item
-    }, (0, _preact.h)("span", {
-      className: classes.link,
-      dangerouslySetInnerHTML: {
-        __html: label
-      }
-    }));
-  }
-
-  return (0, _preact.h)("li", {
-    className: classes.item
-  }, (0, _preact.h)("a", {
-    className: classes.link,
-    "aria-label": ariaLabel,
-    href: createURL(pageNumber),
-    onClick: function onClick(event) {
-      return handleClick(pageNumber, event);
-    },
-    dangerouslySetInnerHTML: {
-      __html: label
-    }
-  }));
-}
-
-var _default = PaginationLink;
-exports.default = _default;