@algolia/autocomplete-js 1.6.1 → 1.7.0

package/dist/esm/autocomplete.js

@@ -1,3 +1,9 @@
+var _excluded = ["components"];
+
+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 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; }
@@ -14,7 +20,7 @@ import { getDefaultOptions } from './getDefaultOptions';
 import { getPanelPlacementStyle } from './getPanelPlacementStyle';
 import { renderPanel, renderSearchBox } from './render';
 import { userAgents } from './userAgents';
-import { mergeDeep, setProperties } from './utils';
+import { mergeDeep, pickBy, setProperties } from './utils';
 export function autocomplete(options) {
   var _createEffectWrapper = createEffectWrapper(),
       runEffect = _createEffectWrapper.runEffect,
@@ -273,7 +279,21 @@ export function autocomplete(options) {
   function update() {
     var updatedOptions = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     cleanupEffects();
-    optionsRef.current = mergeDeep(props.value.renderer, props.value.core, {
+
+    var _props$value$renderer = props.value.renderer,
+        components = _props$value$renderer.components,
+        rendererProps = _objectWithoutProperties(_props$value$renderer, _excluded);
+
+    optionsRef.current = mergeDeep(rendererProps, props.value.core, {
+      // We need to filter out default components so they can be replaced with
+      // a new `renderer`, without getting rid of user components.
+      // @MAJOR Deal with registering components with the same name as the
+      // default ones. If we disallow overriding default components, we'd just
+      // need to pass all `components` here.
+      components: pickBy(components, function (_ref4) {
+        var value = _ref4.value;
+        return !value.hasOwnProperty('__autocomplete_componentName');
+      }),
       initialState: lastStateRef.current
     }, updatedOptions);
     runReactives();

package/dist/esm/components/Highlight.d.ts

@@ -1,3 +1,6 @@
 /// <reference types="react" />
 import { AutocompleteRenderer, HighlightHitParams } from '../types';
-export declare function createHighlightComponent({ createElement, Fragment, }: AutocompleteRenderer): <THit>({ hit, attribute, tagName, }: HighlightHitParams<THit>) => JSX.Element;
+export declare function createHighlightComponent({ createElement, Fragment, }: AutocompleteRenderer): {
+    <THit>({ hit, attribute, tagName, }: HighlightHitParams<THit>): JSX.Element;
+    __autocomplete_componentName: string;
+};

package/dist/esm/components/Highlight.js

@@ -2,7 +2,8 @@ import { parseAlgoliaHitHighlight } from '@algolia/autocomplete-preset-algolia';
 export function createHighlightComponent(_ref) {
   var createElement = _ref.createElement,
       Fragment = _ref.Fragment;
-  return function Highlight(_ref2) {
+
+  function Highlight(_ref2) {
     var hit = _ref2.hit,
         attribute = _ref2.attribute,
         _ref2$tagName = _ref2.tagName,
@@ -15,5 +16,8 @@ export function createHighlightComponent(_ref) {
         key: index
       }, x.value) : x.value;
     }));
-  };
+  }
+
+  Highlight.__autocomplete_componentName = 'Highlight';
+  return Highlight;
 }

package/dist/esm/components/ReverseHighlight.d.ts

@@ -1,3 +1,6 @@
 /// <reference types="react" />
 import { AutocompleteRenderer, HighlightHitParams } from '../types';
-export declare function createReverseHighlightComponent({ createElement, Fragment, }: AutocompleteRenderer): <THit>({ hit, attribute, tagName, }: HighlightHitParams<THit>) => JSX.Element;
+export declare function createReverseHighlightComponent({ createElement, Fragment, }: AutocompleteRenderer): {
+    <THit>({ hit, attribute, tagName, }: HighlightHitParams<THit>): JSX.Element;
+    __autocomplete_componentName: string;
+};

package/dist/esm/components/ReverseHighlight.js

@@ -2,7 +2,8 @@ import { parseAlgoliaHitReverseHighlight } from '@algolia/autocomplete-preset-al
 export function createReverseHighlightComponent(_ref) {
   var createElement = _ref.createElement,
       Fragment = _ref.Fragment;
-  return function ReverseHighlight(_ref2) {
+
+  function ReverseHighlight(_ref2) {
     var hit = _ref2.hit,
         attribute = _ref2.attribute,
         _ref2$tagName = _ref2.tagName,
@@ -15,5 +16,8 @@ export function createReverseHighlightComponent(_ref) {
         key: index
       }, x.value) : x.value;
     }));
-  };
+  }
+
+  ReverseHighlight.__autocomplete_componentName = 'ReverseHighlight';
+  return ReverseHighlight;
 }

package/dist/esm/components/ReverseSnippet.d.ts

@@ -1,3 +1,6 @@
 /// <reference types="react" />
 import { AutocompleteRenderer, HighlightHitParams } from '../types';
-export declare function createReverseSnippetComponent({ createElement, Fragment, }: AutocompleteRenderer): <THit>({ hit, attribute, tagName, }: HighlightHitParams<THit>) => JSX.Element;
+export declare function createReverseSnippetComponent({ createElement, Fragment, }: AutocompleteRenderer): {
+    <THit>({ hit, attribute, tagName, }: HighlightHitParams<THit>): JSX.Element;
+    __autocomplete_componentName: string;
+};

package/dist/esm/components/ReverseSnippet.js

@@ -2,7 +2,8 @@ import { parseAlgoliaHitReverseSnippet } from '@algolia/autocomplete-preset-algo
 export function createReverseSnippetComponent(_ref) {
   var createElement = _ref.createElement,
       Fragment = _ref.Fragment;
-  return function ReverseSnippet(_ref2) {
+
+  function ReverseSnippet(_ref2) {
     var hit = _ref2.hit,
         attribute = _ref2.attribute,
         _ref2$tagName = _ref2.tagName,
@@ -15,5 +16,8 @@ export function createReverseSnippetComponent(_ref) {
         key: index
       }, x.value) : x.value;
     }));
-  };
+  }
+
+  ReverseSnippet.__autocomplete_componentName = 'ReverseSnippet';
+  return ReverseSnippet;
 }

package/dist/esm/components/Snippet.d.ts

@@ -1,3 +1,6 @@
 /// <reference types="react" />
 import { AutocompleteRenderer, HighlightHitParams } from '../types';
-export declare function createSnippetComponent({ createElement, Fragment, }: AutocompleteRenderer): <THit>({ hit, attribute, tagName, }: HighlightHitParams<THit>) => JSX.Element;
+export declare function createSnippetComponent({ createElement, Fragment, }: AutocompleteRenderer): {
+    <THit>({ hit, attribute, tagName, }: HighlightHitParams<THit>): JSX.Element;
+    __autocomplete_componentName: string;
+};

package/dist/esm/components/Snippet.js

@@ -2,7 +2,8 @@ import { parseAlgoliaHitSnippet } from '@algolia/autocomplete-preset-algolia';
 export function createSnippetComponent(_ref) {
   var createElement = _ref.createElement,
       Fragment = _ref.Fragment;
-  return function Snippet(_ref2) {
+
+  function Snippet(_ref2) {
     var hit = _ref2.hit,
         attribute = _ref2.attribute,
         _ref2$tagName = _ref2.tagName,
@@ -15,5 +16,8 @@ export function createSnippetComponent(_ref) {
         key: index
       }, x.value) : x.value;
     }));
-  };
+  }
+
+  Snippet.__autocomplete_componentName = 'Snippet';
+  return Snippet;
 }

package/dist/esm/createAutocompleteDom.js

@@ -78,10 +78,7 @@ export function createAutocompleteDom(_ref) {
     getInputProps: propGetters.getInputProps,
     getInputPropsCore: autocomplete.getInputProps,
     autocompleteScopeApi: autocompleteScopeApi,
-    onDetachedEscape: isDetached ? function () {
-      autocomplete.setIsOpen(false);
-      setIsModalOpen(false);
-    } : undefined
+    isDetached: isDetached
   });
   var inputWrapperPrefix = createDomElement('div', {
     class: classNames.inputWrapperPrefix,

package/dist/esm/elements/Input.d.ts

@@ -6,7 +6,7 @@ declare type InputProps = {
     environment: AutocompleteEnvironment;
     getInputProps: AutocompletePropGetters<any>['getInputProps'];
     getInputPropsCore: AutocompleteCoreApi<any>['getInputProps'];
-    onDetachedEscape?(): void;
+    isDetached: boolean;
     state: AutocompleteState<any>;
 };
 export declare const Input: AutocompleteElement<InputProps, HTMLInputElement>;

package/dist/esm/elements/Input.js

@@ -1,4 +1,4 @@
-var _excluded = ["autocompleteScopeApi", "environment", "classNames", "getInputProps", "getInputPropsCore", "onDetachedEscape", "state"];
+var _excluded = ["autocompleteScopeApi", "environment", "classNames", "getInputProps", "getInputPropsCore", "isDetached", "state"];
 
 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; }
 
@@ -18,7 +18,7 @@ export var Input = function Input(_ref) {
       classNames = _ref.classNames,
       getInputProps = _ref.getInputProps,
       getInputPropsCore = _ref.getInputPropsCore,
-      onDetachedEscape = _ref.onDetachedEscape,
+      isDetached = _ref.isDetached,
       state = _ref.state,
       props = _objectWithoutProperties(_ref, _excluded);
 
@@ -33,9 +33,8 @@ export var Input = function Input(_ref) {
   }, autocompleteScopeApi));
   setProperties(element, _objectSpread(_objectSpread({}, inputProps), {}, {
     onKeyDown: function onKeyDown(event) {
-      if (onDetachedEscape && event.key === 'Escape') {
-        event.preventDefault();
-        onDetachedEscape();
+      // In detached mode we don't want to close the panel when hittin `Tab`.
+      if (isDetached && event.key === 'Tab') {
         return;
       }
 

package/dist/esm/getDefaultOptions.d.ts

@@ -9,12 +9,14 @@ export declare function getDefaultOptions<TItem extends BaseItem>(options: Autoc
             props: {
                 onTouchStart(event: TouchEvent): void;
                 onTouchMove(event: TouchEvent): void;
+                onMouseDown(event: MouseEvent): void;
             };
         } & {
             state: import("./types").AutocompleteState<TItem>;
         } & import("@algolia/autocomplete-core").AutocompleteScopeApi<TItem>) => {
             onTouchStart(event: TouchEvent): void;
             onTouchMove(event: TouchEvent): void;
+            onMouseDown(event: MouseEvent): void;
         };
         getFormProps: (params: {
             props: {

package/dist/esm/getDefaultOptions.js

@@ -83,7 +83,7 @@ export function getDefaultOptions(options) {
 
   var containerElement = getHTMLElement(environment, container);
   invariant(containerElement.tagName !== 'INPUT', 'The `container` option does not support `input` elements. You need to change the container to a `div`.');
-  process.env.NODE_ENV !== 'production' ? warn(Boolean(!render || (renderer === null || renderer === void 0 ? void 0 : renderer.render)), "You provided the `render` option but did not provide a `renderer.render`. Since v1.6.0, you can provide a `render` function directly in `renderer`." + "\nTo get rid of this warning, do any of the following depending on your use case." + "\n- If you are using the `render` option only to override Autocomplete's default `render` function, pass the `render` function into `renderer` and remove the `render` option." + '\n- If you are using the `render` option to customize the layout, pass your `render` function into `renderer` and use it from the provided parameters of the `render` option.' + '\nSee https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-render') : void 0;
+  process.env.NODE_ENV !== 'production' ? warn(!(render && renderer && !(renderer !== null && renderer !== void 0 && renderer.render)), "You provided the `render` option but did not provide a `renderer.render`. Since v1.6.0, you can provide a `render` function directly in `renderer`." + "\nTo get rid of this warning, do any of the following depending on your use case." + "\n- If you are using the `render` option only to override Autocomplete's default `render` function, pass the `render` function into `renderer` and remove the `render` option." + '\n- If you are using the `render` option to customize the layout, pass your `render` function into `renderer` and use it from the provided parameters of the `render` option.' + '\n- If you are using the `render` option to work with React 18, pass an empty `render` function into `renderer`.' + '\nSee https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-render') : void 0;
   process.env.NODE_ENV !== 'production' ? warn(!renderer || render || renderer.Fragment && renderer.createElement && renderer.render, "You provided an incomplete `renderer` (missing: ".concat([!(renderer !== null && renderer !== void 0 && renderer.createElement) && '`renderer.createElement`', !(renderer !== null && renderer !== void 0 && renderer.Fragment) && '`renderer.Fragment`', !(renderer !== null && renderer !== void 0 && renderer.render) && '`renderer.render`'].filter(Boolean).join(', '), "). This can cause rendering issues.") + '\nSee https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-renderer') : void 0;
 
   var defaultedRenderer = _objectSpread(_objectSpread({}, defaultRenderer), renderer);

package/dist/esm/types/AutocompleteRenderer.d.ts

@@ -1,13 +1,13 @@
 /// <reference types="react" />
 export declare type Pragma = (type: any, props: Record<string, any> | null, ...children: ComponentChildren[]) => JSX.Element;
 export declare type PragmaFrag = any;
-declare type ComponentChild = VNode<any> | object | string | number | boolean | null | undefined;
+declare type ComponentChild = VNode<any> | string | number | boolean | null | undefined;
 declare type ComponentChildren = ComponentChild[] | ComponentChild;
-export declare type VNode<TProps = any> = {
+export declare type VNode<TProps = {}> = {
     type: any;
+    key: string | number | any;
     props: TProps & {
         children: ComponentChildren;
-        key?: any;
     };
 };
 export declare type Render = (vnode: ComponentChild, parent: Element | Document | ShadowRoot | DocumentFragment, replaceNode?: Element | Text | undefined) => void;

package/dist/esm/utils/index.d.ts

@@ -1,4 +1,5 @@
 export * from './getHTMLElement';
 export * from './mergeClassNames';
 export * from './mergeDeep';
+export * from './pickBy';
 export * from './setProperties';

package/dist/esm/utils/index.js

@@ -1,4 +1,5 @@
 export * from './getHTMLElement';
 export * from './mergeClassNames';
 export * from './mergeDeep';
+export * from './pickBy';
 export * from './setProperties';

package/dist/esm/utils/pickBy.d.ts

@@ -0,0 +1,4 @@
+export declare function pickBy<TValue = unknown>(obj: Record<string, TValue>, predicate: (value: {
+    key: string;
+    value: TValue;
+}) => boolean): Record<string, TValue>;

package/dist/esm/utils/pickBy.js

@@ -0,0 +1,34 @@
+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) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+export function pickBy(obj, predicate) {
+  return Object.entries(obj).reduce(function (acc, _ref) {
+    var _ref2 = _slicedToArray(_ref, 2),
+        key = _ref2[0],
+        value = _ref2[1];
+
+    if (predicate({
+      key: key,
+      value: value
+    })) {
+      return _objectSpread(_objectSpread({}, acc), {}, _defineProperty({}, key, value));
+    }
+
+    return acc;
+  }, {});
+}