instantsearch.js 4.65.0 → 4.66.1

package/cjs/connectors/answers/connectAnswers.js

@@ -18,6 +18,9 @@ var withUsage = (0, _utils.createDocumentationMessageGenerator)({
   name: 'answers',
   connector: true
 });
+/**
+ * @deprecated the answers service is no longer offered, and this widget will be removed in InstantSearch.js v5
+ */
 var connectAnswers = function connectAnswers(renderFn) {
   var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _utils.noop;
   (0, _utils.checkRendering)(renderFn, withUsage());

package/cjs/connectors/hits/connectHits.js

@@ -108,6 +108,8 @@ var connectHits = function connectHits(renderFn) {
         if (!escapeHTML) {
           return state;
         }
+
+        // @MAJOR: set this globally, not in the Hits widget to allow Hits to be conditionally used
         return state.setQueryParameters(_utils.TAG_PLACEHOLDER);
       }
     };

package/cjs/connectors/infinite-hits/connectInfiniteHits.js

@@ -256,6 +256,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
         var uiState = _ref10.uiState;
         var widgetSearchParameters = searchParameters;
         if (escapeHTML) {
+          // @MAJOR: set this globally, not in the InfiniteHits widget to allow InfiniteHits to be conditionally used
           widgetSearchParameters = searchParameters.setQueryParameters(_utils.TAG_PLACEHOLDER);
         }
 

package/cjs/lib/version.js

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _default = '4.65.0';
+var _default = '4.66.1';
 exports.default = _default;

package/cjs/widgets/answers/answers.js

@@ -48,6 +48,9 @@ var renderer = function renderer(_ref) {
     }), containerNode);
   };
 };
+/**
+ * @deprecated the answers service is no longer offered, and this widget will be removed in InstantSearch.js v5
+ */
 var answersWidget = function answersWidget(widgetParams) {
   var _ref3 = widgetParams || {},
     container = _ref3.container,
@@ -105,5 +108,5 @@ var answersWidget = function answersWidget(widgetParams) {
     $$widgetType: 'ais.answers'
   });
 };
-var _default = answersWidget;
+var _default = (0, _utils.deprecate)(answersWidget, 'The answers widget is deprecated and will be removed in InstantSearch.js 5.0');
 exports.default = _default;

package/cjs/widgets/hits/hits.js

@@ -1,29 +1,37 @@
 "use strict";
 
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
 var _instantsearchUiComponents = require("instantsearch-ui-components");
 var _preact = require("preact");
-var _Hits = _interopRequireDefault(require("../../components/Hits/Hits"));
+var _Template = _interopRequireDefault(require("../../components/Template/Template"));
 var _connectHits = _interopRequireDefault(require("../../connectors/hits/connectHits"));
 var _insights = require("../../lib/insights");
-var _suit = require("../../lib/suit");
+var _listener = require("../../lib/insights/listener");
 var _templating = require("../../lib/templating");
 var _utils = require("../../lib/utils");
 var _defaultTemplates = _interopRequireDefault(require("./defaultTemplates"));
+var _excluded = ["hit", "index"];
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
 function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
+function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
+function _objectDestructuringEmpty(obj) { if (obj == null) throw new TypeError("Cannot destructure " + obj); }
+function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 var withUsage = (0, _utils.createDocumentationMessageGenerator)({
   name: 'hits'
 });
-var suit = (0, _suit.component)('Hits');
+var Hits = (0, _instantsearchUiComponents.createHitsComponent)({
+  createElement: _preact.h,
+  Fragment: _preact.Fragment
+});
 var renderer = function renderer(_ref) {
   var renderState = _ref.renderState,
     cssClasses = _ref.cssClasses,
@@ -44,42 +52,70 @@ var renderer = function renderer(_ref) {
       });
       return;
     }
-    (0, _preact.render)((0, _preact.h)(_Hits.default, {
-      cssClasses: cssClasses,
-      hits: receivedHits,
-      results: results,
-      templateProps: renderState.templateProps,
+    var handleInsightsClick = (0, _listener.createInsightsEventHandler)({
       insights: insights,
+      sendEvent: sendEvent
+    });
+    var emptyComponent = function emptyComponent(_ref3) {
+      var rootProps = _extends({}, (_objectDestructuringEmpty(_ref3), _ref3));
+      return (0, _preact.h)(_Template.default, _extends({}, renderState.templateProps, {
+        rootProps: rootProps,
+        templateKey: "empty",
+        data: results
+      }));
+    };
+
+    // @MAJOR: Move default hit component back to the UI library
+    // once flavour specificities are erased
+    var itemComponent = function itemComponent(_ref4) {
+      var hit = _ref4.hit,
+        index = _ref4.index,
+        rootProps = _objectWithoutProperties(_ref4, _excluded);
+      return (0, _preact.h)(_Template.default, _extends({}, renderState.templateProps, {
+        templateKey: "item",
+        rootTagName: "li",
+        rootProps: _objectSpread(_objectSpread({}, rootProps), {}, {
+          onClick: function onClick(event) {
+            handleInsightsClick(event);
+            rootProps.onClick();
+          },
+          onAuxClick: function onAuxClick(event) {
+            handleInsightsClick(event);
+            rootProps.onAuxClick();
+          }
+        }),
+        data: _objectSpread(_objectSpread({}, hit), {}, {
+          get __hitIndex() {
+            process.env.NODE_ENV === 'development' ? (0, _utils.warning)(false, 'The `__hitIndex` property is deprecated. Use the absolute `__position` instead.') : void 0;
+            return index;
+          }
+        }),
+        bindEvent: bindEvent,
+        sendEvent: sendEvent
+      }));
+    };
+    (0, _preact.render)((0, _preact.h)(Hits, {
+      hits: receivedHits,
+      itemComponent: itemComponent,
       sendEvent: sendEvent,
-      bindEvent: bindEvent
+      classNames: cssClasses,
+      emptyComponent: emptyComponent
     }), containerNode);
   };
 };
 var hits = function hits(widgetParams) {
-  var _ref3 = widgetParams || {},
-    container = _ref3.container,
-    escapeHTML = _ref3.escapeHTML,
-    transformItems = _ref3.transformItems,
-    _ref3$templates = _ref3.templates,
-    templates = _ref3$templates === void 0 ? {} : _ref3$templates,
-    _ref3$cssClasses = _ref3.cssClasses,
-    userCssClasses = _ref3$cssClasses === void 0 ? {} : _ref3$cssClasses;
+  var _ref5 = widgetParams || {},
+    container = _ref5.container,
+    escapeHTML = _ref5.escapeHTML,
+    transformItems = _ref5.transformItems,
+    _ref5$templates = _ref5.templates,
+    templates = _ref5$templates === void 0 ? {} : _ref5$templates,
+    _ref5$cssClasses = _ref5.cssClasses,
+    cssClasses = _ref5$cssClasses === void 0 ? {} : _ref5$cssClasses;
   if (!container) {
     throw new Error(withUsage('The `container` option is required.'));
   }
   var containerNode = (0, _utils.getContainerNode)(container);
-  var cssClasses = {
-    root: (0, _instantsearchUiComponents.cx)(suit(), userCssClasses.root),
-    emptyRoot: (0, _instantsearchUiComponents.cx)(suit({
-      modifierName: 'empty'
-    }), userCssClasses.emptyRoot),
-    list: (0, _instantsearchUiComponents.cx)(suit({
-      descendantName: 'list'
-    }), userCssClasses.list),
-    item: (0, _instantsearchUiComponents.cx)(suit({
-      descendantName: 'item'
-    }), userCssClasses.item)
-  };
   var specializedRenderer = renderer({
     containerNode: containerNode,
     cssClasses: cssClasses,

package/cjs/widgets/places/places.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+var _utils = require("../../lib/utils");
 var _excluded = ["placesReference", "defaultPosition"],
   _excluded2 = ["places"];
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
@@ -20,6 +21,7 @@ function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) r
 /**
  * This widget sets the geolocation value for the search based on the selected
  * result in the Algolia Places autocomplete.
+ * @deprecated the places service is no longer offered, and this widget will be removed in InstantSearch.js v5
  */
 var placesWidget = function placesWidget(widgetParams) {
   var _ref = widgetParams || {},
@@ -105,5 +107,5 @@ var placesWidget = function placesWidget(widgetParams) {
     }
   };
 };
-var _default = placesWidget;
+var _default = (0, _utils.deprecate)(placesWidget, 'The places widget is deprecated and will be removed in InstantSearch.js 5.0.');
 exports.default = _default;

package/dist/instantsearch.development.d.ts

@@ -7,6 +7,7 @@ import { FindAnswersOptions } from 'algoliasearch-helper/types/algoliasearch.js'
 import { h } from 'preact';
 import type { HighlightClassNames as HighlightClassNames_2 } from 'instantsearch-ui-components';
 import type { HighlightProps as HighlightProps_3 } from 'instantsearch-ui-components';
+import type { HitsClassNames } from 'instantsearch-ui-components';
 import type { HoganOptions } from 'hogan.js';
 import type { html } from 'htm/preact';
 import type { InsightsClient as InsightsClient_2 } from 'search-insights';
@@ -1111,6 +1112,8 @@ declare type CustomSendEventForHits = (customPayload: any) => void;
 
 declare type CustomSendEventForToggle = (customPayload: any) => void;
 
+declare const _default: PlacesWidget;
+
 declare type DisposeOptions = {
     helper: AlgoliaSearchHelper;
     state: SearchParameters;
@@ -1863,24 +1866,7 @@ declare type HitsConnectorParams<THit extends BaseHit = BaseHit> = {
     transformItems?: TransformItems<Hit<THit>>;
 };
 
-declare type HitsCSSClasses = Partial<{
-    /**
-     * CSS class to add to the wrapping element.
-     */
-    root: string | string[];
-    /**
-     * CSS class to add to the wrapping element when no results.
-     */
-    emptyRoot: string | string[];
-    /**
-     * CSS class to add to the list of results.
-     */
-    list: string | string[];
-    /**
-     * CSS class to add to each result.
-     */
-    item: string | string[];
-}>;
+declare type HitsCSSClasses = Partial<HitsClassNames>;
 
 declare type HitSnippetResult = {
     [attribute: string]: HitAttributeSnippetResult[] | HitSnippetResult[] | HitAttributeSnippetResult | HitSnippetResult;
@@ -3431,12 +3417,6 @@ declare type PlacesInstance = Places.PlacesInstance;
 
 declare type PlacesWidget = WidgetFactory<PlacesWidgetDescription, PlacesWidgetParams, PlacesWidgetParams>;
 
-/**
- * This widget sets the geolocation value for the search based on the selected
- * result in the Algolia Places autocomplete.
- */
-declare const placesWidget: PlacesWidget;
-
 declare type PlacesWidgetDescription = {
     $$type: 'ais.places';
     $$widgetType: 'ais.places';
@@ -4263,6 +4243,8 @@ declare type RefinementListRenderState = {
     isFromSearch: boolean;
     /**
      * `true` if a refinement can be applied.
+     * @MAJOR: reconsider how `canRefine` is computed so it both accounts for the
+     * items returned in the main search and in SFFV.
      */
     canRefine: boolean;
     /**
@@ -5563,7 +5545,7 @@ declare namespace widgets {
         numericMenu,
         pagination,
         panel,
-        placesWidget as places,
+        _default as places,
         poweredBy,
         queryRuleContext,
         queryRuleCustomData,