@docsearch/react 3.6.0 → 3.6.2

package/dist/esm/icons/SourceIcon.js

@@ -1,57 +0,0 @@
-import React from 'react';
-
-var LvlIcon = function LvlIcon() {
-  return /*#__PURE__*/React.createElement("svg", {
-    width: "20",
-    height: "20",
-    viewBox: "0 0 20 20"
-  }, /*#__PURE__*/React.createElement("path", {
-    d: "M17 6v12c0 .52-.2 1-1 1H4c-.7 0-1-.33-1-1V2c0-.55.42-1 1-1h8l5 5zM14 8h-3.13c-.51 0-.87-.34-.87-.87V4",
-    stroke: "currentColor",
-    fill: "none",
-    fillRule: "evenodd",
-    strokeLinejoin: "round"
-  }));
-};
-
-export function SourceIcon(props) {
-  switch (props.type) {
-    case 'lvl1':
-      return /*#__PURE__*/React.createElement(LvlIcon, null);
-
-    case 'content':
-      return /*#__PURE__*/React.createElement(ContentIcon, null);
-
-    default:
-      return /*#__PURE__*/React.createElement(AnchorIcon, null);
-  }
-}
-
-function AnchorIcon() {
-  return /*#__PURE__*/React.createElement("svg", {
-    width: "20",
-    height: "20",
-    viewBox: "0 0 20 20"
-  }, /*#__PURE__*/React.createElement("path", {
-    d: "M13 13h4-4V8H7v5h6v4-4H7V8H3h4V3v5h6V3v5h4-4v5zm-6 0v4-4H3h4z",
-    stroke: "currentColor",
-    fill: "none",
-    fillRule: "evenodd",
-    strokeLinecap: "round",
-    strokeLinejoin: "round"
-  }));
-}
-
-function ContentIcon() {
-  return /*#__PURE__*/React.createElement("svg", {
-    width: "20",
-    height: "20",
-    viewBox: "0 0 20 20"
-  }, /*#__PURE__*/React.createElement("path", {
-    d: "M17 5H3h14zm0 5H3h14zm0 5H3h14z",
-    stroke: "currentColor",
-    fill: "none",
-    fillRule: "evenodd",
-    strokeLinejoin: "round"
-  }));
-}

package/dist/esm/icons/StarIcon.d.ts

@@ -1 +0,0 @@
-export declare function StarIcon(): JSX.Element;

package/dist/esm/icons/StarIcon.js

@@ -1,14 +0,0 @@
-import React from 'react';
-export function StarIcon() {
-  return /*#__PURE__*/React.createElement("svg", {
-    width: "20",
-    height: "20",
-    viewBox: "0 0 20 20"
-  }, /*#__PURE__*/React.createElement("path", {
-    d: "M10 14.2L5 17l1-5.6-4-4 5.5-.7 2.5-5 2.5 5 5.6.8-4 4 .9 5.5z",
-    stroke: "currentColor",
-    fill: "none",
-    fillRule: "evenodd",
-    strokeLinejoin: "round"
-  }));
-}

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

@@ -1,10 +0,0 @@
-export * from './GoToExternalIcon';
-export * from './LoadingIcon';
-export * from './RecentIcon';
-export * from './ResetIcon';
-export * from './SearchIcon';
-export * from './SelectIcon';
-export * from './SourceIcon';
-export * from './StarIcon';
-export * from './ErrorIcon';
-export * from './NoResultsIcon';

package/dist/esm/icons/index.js

@@ -1,10 +0,0 @@
-export * from './GoToExternalIcon';
-export * from './LoadingIcon';
-export * from './RecentIcon';
-export * from './ResetIcon';
-export * from './SearchIcon';
-export * from './SelectIcon';
-export * from './SourceIcon';
-export * from './StarIcon';
-export * from './ErrorIcon';
-export * from './NoResultsIcon';

package/dist/esm/stored-searches.d.ts

@@ -1,12 +0,0 @@
-import type { StoredDocSearchHit } from './types';
-declare type CreateStoredSearchesOptions = {
-    key: string;
-    limit?: number;
-};
-export declare type StoredSearchPlugin<TItem> = {
-    add: (item: TItem) => void;
-    remove: (item: TItem) => void;
-    getAll: () => TItem[];
-};
-export declare function createStoredSearches<TItem extends StoredDocSearchHit>({ key, limit, }: CreateStoredSearchesOptions): StoredSearchPlugin<TItem>;
-export {};

package/dist/esm/stored-searches.js

@@ -1,75 +0,0 @@
-var _excluded = ["_highlightResult", "_snippetResult"];
-
-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 isLocalStorageSupported() {
-  var key = '__TEST_KEY__';
-
-  try {
-    localStorage.setItem(key, '');
-    localStorage.removeItem(key);
-    return true;
-  } catch (error) {
-    return false;
-  }
-}
-
-function createStorage(key) {
-  if (isLocalStorageSupported() === false) {
-    return {
-      setItem: function setItem() {},
-      getItem: function getItem() {
-        return [];
-      }
-    };
-  }
-
-  return {
-    setItem: function setItem(item) {
-      return window.localStorage.setItem(key, JSON.stringify(item));
-    },
-    getItem: function getItem() {
-      var item = window.localStorage.getItem(key);
-      return item ? JSON.parse(item) : [];
-    }
-  };
-}
-
-export function createStoredSearches(_ref) {
-  var key = _ref.key,
-      _ref$limit = _ref.limit,
-      limit = _ref$limit === void 0 ? 5 : _ref$limit;
-  var storage = createStorage(key);
-  var items = storage.getItem().slice(0, limit);
-  return {
-    add: function add(item) {
-      var _ref2 = item,
-          _highlightResult = _ref2._highlightResult,
-          _snippetResult = _ref2._snippetResult,
-          hit = _objectWithoutProperties(_ref2, _excluded);
-
-      var isQueryAlreadySaved = items.findIndex(function (x) {
-        return x.objectID === hit.objectID;
-      });
-
-      if (isQueryAlreadySaved > -1) {
-        items.splice(isQueryAlreadySaved, 1);
-      }
-
-      items.unshift(hit);
-      items = items.slice(0, limit);
-      storage.setItem(items);
-    },
-    remove: function remove(item) {
-      items = items.filter(function (x) {
-        return x.objectID !== item.objectID;
-      });
-      storage.setItem(items);
-    },
-    getAll: function getAll() {
-      return items;
-    }
-  };
-}

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

@@ -1,75 +0,0 @@
-declare type ContentType = 'content' | 'lvl0' | 'lvl1' | 'lvl2' | 'lvl3' | 'lvl4' | 'lvl5' | 'lvl6';
-interface DocSearchHitAttributeHighlightResult {
-    value: string;
-    matchLevel: 'full' | 'none' | 'partial';
-    matchedWords: string[];
-    fullyHighlighted?: boolean;
-}
-interface DocSearchHitHighlightResultHierarchy {
-    lvl0: DocSearchHitAttributeHighlightResult;
-    lvl1: DocSearchHitAttributeHighlightResult;
-    lvl2: DocSearchHitAttributeHighlightResult;
-    lvl3: DocSearchHitAttributeHighlightResult;
-    lvl4: DocSearchHitAttributeHighlightResult;
-    lvl5: DocSearchHitAttributeHighlightResult;
-    lvl6: DocSearchHitAttributeHighlightResult;
-}
-interface DocSearchHitHighlightResult {
-    content: DocSearchHitAttributeHighlightResult;
-    hierarchy: DocSearchHitHighlightResultHierarchy;
-    hierarchy_camel: DocSearchHitHighlightResultHierarchy[];
-}
-interface DocSearchHitAttributeSnippetResult {
-    value: string;
-    matchLevel: 'full' | 'none' | 'partial';
-}
-interface DocSearchHitSnippetResult {
-    content: DocSearchHitAttributeSnippetResult;
-    hierarchy: DocSearchHitHighlightResultHierarchy;
-    hierarchy_camel: DocSearchHitHighlightResultHierarchy[];
-}
-export declare type DocSearchHit = {
-    objectID: string;
-    content: string | null;
-    url: string;
-    url_without_anchor: string;
-    type: ContentType;
-    anchor: string | null;
-    hierarchy: {
-        lvl0: string;
-        lvl1: string;
-        lvl2: string | null;
-        lvl3: string | null;
-        lvl4: string | null;
-        lvl5: string | null;
-        lvl6: string | null;
-    };
-    _highlightResult: DocSearchHitHighlightResult;
-    _snippetResult: DocSearchHitSnippetResult;
-    _rankingInfo?: {
-        promoted: boolean;
-        nbTypos: number;
-        firstMatchedWord: number;
-        proximityDistance?: number;
-        geoDistance: number;
-        geoPrecision?: number;
-        nbExactWords: number;
-        words: number;
-        filters: number;
-        userScore: number;
-        matchedGeoLocation?: {
-            lat: number;
-            lng: number;
-            distance: number;
-        };
-    };
-    _distinctSeqID?: number;
-    __autocomplete_indexName?: string;
-    __autocomplete_queryID?: string;
-    __autocomplete_algoliaCredentials?: {
-        appId: string;
-        apiKey: string;
-    };
-    __autocomplete_id?: number;
-};
-export {};

package/dist/esm/types/DocSearchHit.js

@@ -1 +0,0 @@
-export {};

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

@@ -1,10 +0,0 @@
-import type { AutocompleteContext, AutocompleteInsightsApi, AutocompleteState, BaseItem } from '@algolia/autocomplete-core';
-interface DocSearchContext extends AutocompleteContext {
-    algoliaInsightsPlugin?: {
-        insights: AutocompleteInsightsApi;
-    };
-}
-export interface DocSearchState<TItem extends BaseItem> extends AutocompleteState<TItem> {
-    context: DocSearchContext;
-}
-export {};

package/dist/esm/types/DocSearchState.js

@@ -1 +0,0 @@
-export {};

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

@@ -1,4 +0,0 @@
-import type { DocSearchHit } from './DocSearchHit';
-export declare type InternalDocSearchHit = DocSearchHit & {
-    __docsearch_parent: InternalDocSearchHit | null;
-};

package/dist/esm/types/InternalDocSearchHit.js

@@ -1 +0,0 @@
-export {};

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

@@ -1,2 +0,0 @@
-import type { DocSearchHit } from './DocSearchHit';
-export declare type StoredDocSearchHit = Omit<DocSearchHit, '_highlightResult' | '_snippetResult'>;

package/dist/esm/types/StoredDocSearchHit.js

@@ -1 +0,0 @@
-export {};

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

@@ -1,4 +0,0 @@
-export * from './DocSearchHit';
-export * from './DocSearchState';
-export * from './InternalDocSearchHit';
-export * from './StoredDocSearchHit';

package/dist/esm/types/index.js

@@ -1,4 +0,0 @@
-export * from './DocSearchHit';
-export * from './DocSearchState';
-export * from './InternalDocSearchHit';
-export * from './StoredDocSearchHit';

package/dist/esm/useDocSearchKeyboardEvents.d.ts

@@ -1,9 +0,0 @@
-import React from 'react';
-export interface UseDocSearchKeyboardEventsProps {
-    isOpen: boolean;
-    onOpen: () => void;
-    onClose: () => void;
-    onInput?: (event: KeyboardEvent) => void;
-    searchButtonRef?: React.RefObject<HTMLButtonElement>;
-}
-export declare function useDocSearchKeyboardEvents({ isOpen, onOpen, onClose, onInput, searchButtonRef, }: UseDocSearchKeyboardEventsProps): void;

package/dist/esm/useDocSearchKeyboardEvents.js

@@ -1,55 +0,0 @@
-import React from 'react';
-
-function isEditingContent(event) {
-  var element = event.target;
-  var tagName = element.tagName;
-  return element.isContentEditable || tagName === 'INPUT' || tagName === 'SELECT' || tagName === 'TEXTAREA';
-}
-
-export function useDocSearchKeyboardEvents(_ref) {
-  var isOpen = _ref.isOpen,
-      onOpen = _ref.onOpen,
-      onClose = _ref.onClose,
-      onInput = _ref.onInput,
-      searchButtonRef = _ref.searchButtonRef;
-  React.useEffect(function () {
-    function onKeyDown(event) {
-      var _event$key;
-
-      function open() {
-        // We check that no other DocSearch modal is showing before opening
-        // another one.
-        if (!document.body.classList.contains('DocSearch--active')) {
-          onOpen();
-        }
-      }
-
-      if (event.keyCode === 27 && isOpen || // The `Cmd+K` shortcut both opens and closes the modal.
-      // We need to check for `event.key` because it can be `undefined` with
-      // Chrome's autofill feature.
-      // See https://github.com/paperjs/paper.js/issues/1398
-      ((_event$key = event.key) === null || _event$key === void 0 ? void 0 : _event$key.toLowerCase()) === 'k' && (event.metaKey || event.ctrlKey) || // The `/` shortcut opens but doesn't close the modal because it's
-      // a character.
-      !isEditingContent(event) && event.key === '/' && !isOpen) {
-        event.preventDefault();
-
-        if (isOpen) {
-          onClose();
-        } else if (!document.body.classList.contains('DocSearch--active')) {
-          open();
-        }
-      }
-
-      if (searchButtonRef && searchButtonRef.current === document.activeElement && onInput) {
-        if (/[a-zA-Z0-9]/.test(String.fromCharCode(event.keyCode))) {
-          onInput(event);
-        }
-      }
-    }
-
-    window.addEventListener('keydown', onKeyDown);
-    return function () {
-      window.removeEventListener('keydown', onKeyDown);
-    };
-  }, [isOpen, onOpen, onClose, onInput, searchButtonRef]);
-}

package/dist/esm/useSearchClient.d.ts

@@ -1,2 +0,0 @@
-import type { SearchClient } from 'algoliasearch/lite';
-export declare function useSearchClient(appId: string, apiKey: string, transformSearchClient: (searchClient: SearchClient) => SearchClient): SearchClient;

package/dist/esm/useSearchClient.js

@@ -1,20 +0,0 @@
-import algoliasearch from 'algoliasearch/dist/algoliasearch-lite.esm.browser';
-import React from 'react';
-import { version } from './version';
-export function useSearchClient(appId, apiKey, transformSearchClient) {
-  var searchClient = React.useMemo(function () {
-    var client = algoliasearch(appId, apiKey);
-    client.addAlgoliaAgent('docsearch', version); // Since DocSearch.js relies on DocSearch React with an alias to Preact,
-    // we cannot add the `docsearch-react` user agent by default, otherwise
-    // it would also be sent on a DocSearch.js integration.
-    // We therefore only add the `docsearch-react` user agent if `docsearch.js`
-    // is not present.
-
-    if (/docsearch.js \(.*\)/.test(client.transporter.userAgent.value) === false) {
-      client.addAlgoliaAgent('docsearch-react', version);
-    }
-
-    return transformSearchClient(client);
-  }, [appId, apiKey, transformSearchClient]);
-  return searchClient;
-}

package/dist/esm/useTouchEvents.d.ts

@@ -1,9 +0,0 @@
-import type { AutocompleteApi } from '@algolia/autocomplete-core';
-interface UseTouchEventsProps {
-    getEnvironmentProps: AutocompleteApi<any>['getEnvironmentProps'];
-    panelElement: HTMLDivElement | null;
-    formElement: HTMLDivElement | null;
-    inputElement: HTMLInputElement | null;
-}
-export declare function useTouchEvents({ getEnvironmentProps, panelElement, formElement, inputElement, }: UseTouchEventsProps): void;
-export {};

package/dist/esm/useTouchEvents.js

@@ -1,27 +0,0 @@
-import React from 'react';
-export function useTouchEvents(_ref) {
-  var getEnvironmentProps = _ref.getEnvironmentProps,
-      panelElement = _ref.panelElement,
-      formElement = _ref.formElement,
-      inputElement = _ref.inputElement;
-  React.useEffect(function () {
-    if (!(panelElement && formElement && inputElement)) {
-      return undefined;
-    }
-
-    var _getEnvironmentProps = getEnvironmentProps({
-      panelElement: panelElement,
-      formElement: formElement,
-      inputElement: inputElement
-    }),
-        onTouchStart = _getEnvironmentProps.onTouchStart,
-        onTouchMove = _getEnvironmentProps.onTouchMove;
-
-    window.addEventListener('touchstart', onTouchStart);
-    window.addEventListener('touchmove', onTouchMove);
-    return function () {
-      window.removeEventListener('touchstart', onTouchStart);
-      window.removeEventListener('touchmove', onTouchMove);
-    };
-  }, [getEnvironmentProps, panelElement, formElement, inputElement]);
-}

package/dist/esm/useTrapFocus.d.ts

@@ -1,5 +0,0 @@
-interface UseTrapFocusProps {
-    container: HTMLElement | null;
-}
-export declare function useTrapFocus({ container }: UseTrapFocusProps): void;
-export {};

package/dist/esm/useTrapFocus.js

@@ -1,34 +0,0 @@
-import React from 'react';
-export function useTrapFocus(_ref) {
-  var container = _ref.container;
-  React.useEffect(function () {
-    if (!container) {
-      return undefined;
-    }
-
-    var focusableElements = container.querySelectorAll('a[href]:not([disabled]), button:not([disabled]), input:not([disabled])');
-    var firstElement = focusableElements[0];
-    var lastElement = focusableElements[focusableElements.length - 1];
-
-    function trapFocus(event) {
-      if (event.key !== 'Tab') {
-        return;
-      }
-
-      if (event.shiftKey) {
-        if (document.activeElement === firstElement) {
-          event.preventDefault();
-          lastElement.focus();
-        }
-      } else if (document.activeElement === lastElement) {
-        event.preventDefault();
-        firstElement.focus();
-      }
-    }
-
-    container.addEventListener('keydown', trapFocus);
-    return function () {
-      container.removeEventListener('keydown', trapFocus);
-    };
-  }, [container]);
-}

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

@@ -1 +0,0 @@
-export declare function groupBy<TValue extends Record<string, unknown>>(values: TValue[], predicate: (value: TValue) => string, maxResultsPerGroup?: number): Record<string, TValue[]>;

package/dist/esm/utils/groupBy.js

@@ -1,17 +0,0 @@
-export function groupBy(values, predicate, maxResultsPerGroup) {
-  return values.reduce(function (acc, item) {
-    var key = predicate(item);
-
-    if (!acc.hasOwnProperty(key)) {
-      acc[key] = [];
-    } // We limit each section to show 5 hits maximum.
-    // This acts as a frontend alternative to `distinct`.
-
-
-    if (acc[key].length < (maxResultsPerGroup || 5)) {
-      acc[key].push(item);
-    }
-
-    return acc;
-  }, {});
-}

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

@@ -1 +0,0 @@
-export declare function identity<TParam>(x: TParam): TParam;

package/dist/esm/utils/identity.js

@@ -1,3 +0,0 @@
-export function identity(x) {
-  return x;
-}

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

@@ -1,5 +0,0 @@
-export * from './groupBy';
-export * from './identity';
-export * from './isModifierEvent';
-export * from './noop';
-export * from './removeHighlightTags';

package/dist/esm/utils/index.js

@@ -1,5 +0,0 @@
-export * from './groupBy';
-export * from './identity';
-export * from './isModifierEvent';
-export * from './noop';
-export * from './removeHighlightTags';

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

@@ -1,5 +0,0 @@
-/**
- * Detect when an event is modified with a special key to let the browser
- * trigger its default behavior.
- */
-export declare function isModifierEvent<TEvent extends KeyboardEvent | MouseEvent>(event: TEvent): boolean;

package/dist/esm/utils/isModifierEvent.js

@@ -1,8 +0,0 @@
-/**
- * Detect when an event is modified with a special key to let the browser
- * trigger its default behavior.
- */
-export function isModifierEvent(event) {
-  var isMiddleClick = event.button === 1;
-  return isMiddleClick || event.altKey || event.ctrlKey || event.metaKey || event.shiftKey;
-}

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

@@ -1 +0,0 @@
-export declare function noop(..._args: any[]): void;

package/dist/esm/utils/noop.js

@@ -1 +0,0 @@
-export function noop() {}

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

@@ -1,2 +0,0 @@
-import type { DocSearchHit, InternalDocSearchHit } from '../types';
-export declare function removeHighlightTags(hit: DocSearchHit | InternalDocSearchHit): string;

package/dist/esm/utils/removeHighlightTags.js

@@ -1,16 +0,0 @@
-var regexHighlightTags = /(<mark>|<\/mark>)/g;
-var regexHasHighlightTags = RegExp(regexHighlightTags.source);
-export function removeHighlightTags(hit) {
-  var _internalDocSearchHit, _hit$_highlightResult;
-
-  var internalDocSearchHit = hit;
-
-  if (!internalDocSearchHit.__docsearch_parent && !hit._highlightResult) {
-    return hit.hierarchy.lvl0;
-  }
-
-  var _ref = (internalDocSearchHit.__docsearch_parent ? (_internalDocSearchHit = internalDocSearchHit.__docsearch_parent) === null || _internalDocSearchHit === void 0 || (_internalDocSearchHit = _internalDocSearchHit._highlightResult) === null || _internalDocSearchHit === void 0 || (_internalDocSearchHit = _internalDocSearchHit.hierarchy) === null || _internalDocSearchHit === void 0 ? void 0 : _internalDocSearchHit.lvl0 : (_hit$_highlightResult = hit._highlightResult) === null || _hit$_highlightResult === void 0 || (_hit$_highlightResult = _hit$_highlightResult.hierarchy) === null || _hit$_highlightResult === void 0 ? void 0 : _hit$_highlightResult.lvl0) || {},
-      value = _ref.value;
-
-  return value && regexHasHighlightTags.test(value) ? value.replace(regexHighlightTags, '') : value;
-}

package/dist/esm/version.d.ts

@@ -1 +0,0 @@
-export declare const version = "3.6.0";

package/dist/esm/version.js

@@ -1 +0,0 @@
-export var version = '3.6.0';