instantsearch.js 4.43.1 → 4.45.0

package/es/helpers/components/ReverseHighlight.js

@@ -0,0 +1,44 @@
+function _extends() { _extends = Object.assign || 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); }
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+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; }
+
+/** @jsx h */
+import { h } from 'preact';
+import { ReverseHighlight as ReverseHighlightUiComponent } from "../../components/ReverseHighlight/ReverseHighlight.js";
+import getHighlightedParts from "../../lib/utils/getHighlightedParts.js";
+import getPropertyByPath from "../../lib/utils/getPropertyByPath.js";
+import unescape from "../../lib/utils/unescape.js";
+import { warning } from "../../lib/utils/logger.js";
+export function ReverseHighlight(_ref) {
+  var hit = _ref.hit,
+      attribute = _ref.attribute,
+      cssClasses = _ref.cssClasses,
+      props = _objectWithoutProperties(_ref, ["hit", "attribute", "cssClasses"]);
+
+  var property = getPropertyByPath(hit._highlightResult, attribute) || [];
+  var properties = Array.isArray(property) ? property : [property];
+  process.env.NODE_ENV === 'development' ? warning(Boolean(properties.length), "Could not enable highlight for \"".concat(attribute.toString(), "\", 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 parts = properties.map(function (_ref2) {
+    var value = _ref2.value;
+    return getHighlightedParts(unescape(value || '')).map(function (_ref3) {
+      var isHighlighted = _ref3.isHighlighted,
+          rest = _objectWithoutProperties(_ref3, ["isHighlighted"]);
+
+      return _objectSpread(_objectSpread({}, rest), {}, {
+        isHighlighted: !isHighlighted
+      });
+    });
+  });
+  return h(ReverseHighlightUiComponent, _extends({}, props, {
+    parts: parts,
+    classNames: cssClasses
+  }));
+}

package/es/helpers/components/ReverseSnippet.d.ts

@@ -0,0 +1,10 @@
+/** @jsx h */
+import { h } from 'preact';
+import type { BaseHit, Hit, PartialKeys } from '../../types';
+import type { ReverseSnippetProps as ReverseSnippetUiComponentProps } from '../../components/ReverseSnippet/ReverseSnippet';
+export declare type ReverseSnippetProps<THit extends Hit<BaseHit>> = {
+    hit: THit;
+    attribute: keyof THit | string[];
+    cssClasses?: ReverseSnippetUiComponentProps['classNames'];
+} & PartialKeys<Omit<ReverseSnippetUiComponentProps, 'parts' | 'classNames'>, 'highlightedTagName' | 'nonHighlightedTagName' | 'separator'>;
+export declare function ReverseSnippet<THit extends Hit<BaseHit>>({ hit, attribute, cssClasses, ...props }: ReverseSnippetProps<THit>): h.JSX.Element;

package/es/helpers/components/ReverseSnippet.js

@@ -0,0 +1,44 @@
+function _extends() { _extends = Object.assign || 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); }
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+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; }
+
+/** @jsx h */
+import { h } from 'preact';
+import { ReverseSnippet as ReverseSnippetUiComponent } from "../../components/ReverseSnippet/ReverseSnippet.js";
+import getHighlightedParts from "../../lib/utils/getHighlightedParts.js";
+import getPropertyByPath from "../../lib/utils/getPropertyByPath.js";
+import unescape from "../../lib/utils/unescape.js";
+import { warning } from "../../lib/utils/logger.js";
+export function ReverseSnippet(_ref) {
+  var hit = _ref.hit,
+      attribute = _ref.attribute,
+      cssClasses = _ref.cssClasses,
+      props = _objectWithoutProperties(_ref, ["hit", "attribute", "cssClasses"]);
+
+  var property = getPropertyByPath(hit._snippetResult, attribute) || [];
+  var properties = Array.isArray(property) ? property : [property];
+  process.env.NODE_ENV === 'development' ? warning(Boolean(properties.length), "Could not enable snippet for \"".concat(attribute.toString(), "\", 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 parts = properties.map(function (_ref2) {
+    var value = _ref2.value;
+    return getHighlightedParts(unescape(value || '')).map(function (_ref3) {
+      var isHighlighted = _ref3.isHighlighted,
+          rest = _objectWithoutProperties(_ref3, ["isHighlighted"]);
+
+      return _objectSpread(_objectSpread({}, rest), {}, {
+        isHighlighted: !isHighlighted
+      });
+    });
+  });
+  return h(ReverseSnippetUiComponent, _extends({}, props, {
+    parts: parts,
+    classNames: cssClasses
+  }));
+}

package/es/helpers/components/Snippet.d.ts

@@ -0,0 +1,10 @@
+/** @jsx h */
+import { h } from 'preact';
+import type { BaseHit, Hit, PartialKeys } from '../../types';
+import type { SnippetProps as SnippetUiComponentProps } from '../../components/Snippet/Snippet';
+export declare type SnippetProps<THit extends Hit<BaseHit>> = {
+    hit: THit;
+    attribute: keyof THit | string[];
+    cssClasses?: SnippetUiComponentProps['classNames'];
+} & PartialKeys<Omit<SnippetUiComponentProps, 'parts' | 'classNames'>, 'highlightedTagName' | 'nonHighlightedTagName' | 'separator'>;
+export declare function Snippet<THit extends Hit<BaseHit>>({ hit, attribute, cssClasses, ...props }: SnippetProps<THit>): h.JSX.Element;

package/es/helpers/components/Snippet.js

@@ -0,0 +1,31 @@
+function _extends() { _extends = Object.assign || 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); }
+
+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; }
+
+/** @jsx h */
+import { h } from 'preact';
+import { Snippet as SnippetUiComponent } from "../../components/Snippet/Snippet.js";
+import getHighlightedParts from "../../lib/utils/getHighlightedParts.js";
+import getPropertyByPath from "../../lib/utils/getPropertyByPath.js";
+import unescape from "../../lib/utils/unescape.js";
+import { warning } from "../../lib/utils/logger.js";
+export function Snippet(_ref) {
+  var hit = _ref.hit,
+      attribute = _ref.attribute,
+      cssClasses = _ref.cssClasses,
+      props = _objectWithoutProperties(_ref, ["hit", "attribute", "cssClasses"]);
+
+  var property = getPropertyByPath(hit._snippetResult, attribute) || [];
+  var properties = Array.isArray(property) ? property : [property];
+  process.env.NODE_ENV === 'development' ? warning(Boolean(properties.length), "Could not enable snippet for \"".concat(attribute.toString(), "\", 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 parts = properties.map(function (_ref2) {
+    var value = _ref2.value;
+    return getHighlightedParts(unescape(value || ''));
+  });
+  return h(SnippetUiComponent, _extends({}, props, {
+    parts: parts,
+    classNames: cssClasses
+  }));
+}

package/es/helpers/components/index.d.ts

@@ -0,0 +1,4 @@
+export * from './Highlight';
+export * from './ReverseHighlight';
+export * from './ReverseSnippet';
+export * from './Snippet';

package/es/helpers/components/index.js

@@ -0,0 +1,4 @@
+export * from "./Highlight.js";
+export * from "./ReverseHighlight.js";
+export * from "./ReverseSnippet.js";
+export * from "./Snippet.js";

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.43.1";
+declare const _default: "4.45.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.43.1';
+export default '4.45.0';

package/es/types/utils.d.ts

@@ -10,3 +10,7 @@ export declare type Expand<T> = T extends infer O ? {
 } : never;
 export declare type RequiredKeys<TObject, TKeys extends keyof TObject> = Expand<Required<Pick<TObject, TKeys>> & Omit<TObject, TKeys>>;
 export declare type Awaited<T> = T extends PromiseLike<infer U> ? Awaited<U> : T;
+/**
+ * Make certain keys of an object optional.
+ */
+export declare type PartialKeys<TObj, TKeys extends keyof TObj> = Omit<TObj, TKeys> & Partial<Pick<TObj, TKeys>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.43.1",
+  "version": "4.45.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",
@@ -54,12 +54,15 @@
   ],
   "dependencies": {
     "@algolia/events": "^4.0.1",
+    "@algolia/ui-components-highlight-vdom": "^1.1.2",
+    "@algolia/ui-components-shared": "^1.1.2",
     "@types/google.maps": "^3.45.3",
     "@types/hogan.js": "^3.0.0",
     "@types/qs": "^6.5.3",
     "algoliasearch-helper": "^3.10.0",
     "classnames": "^2.2.5",
     "hogan.js": "^3.0.2",
+    "htm": "^3.0.0",
     "preact": "^10.6.0",
     "qs": "^6.5.1 < 6.10",
     "search-insights": "^2.1.0"
@@ -154,11 +157,11 @@
   "bundlesize": [
     {
       "path": "./dist/instantsearch.production.min.js",
-      "maxSize": "70.25 kB"
+      "maxSize": "70.50 kB"
     },
     {
       "path": "./dist/instantsearch.development.js",
-      "maxSize": "155.00 kB"
+      "maxSize": "152.00 kB"
     }
   ]
 }