@algolia/autocomplete-js 1.8.2 → 1.9.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@algolia/autocomplete-js",
   "description": "Fast and fully-featured autocomplete JavaScript library.",
-  "version": "1.8.2",
+  "version": "1.9.0",
   "license": "MIT",
   "homepage": "https://github.com/algolia/autocomplete",
   "repository": "algolia/autocomplete",
@@ -31,14 +31,14 @@
     "watch": "watch \"yarn on:change\" --ignoreDirectoryPattern \"/dist/\""
   },
   "dependencies": {
-    "@algolia/autocomplete-core": "1.8.2",
-    "@algolia/autocomplete-preset-algolia": "1.8.2",
-    "@algolia/autocomplete-shared": "1.8.2",
+    "@algolia/autocomplete-core": "1.9.0",
+    "@algolia/autocomplete-preset-algolia": "1.9.0",
+    "@algolia/autocomplete-shared": "1.9.0",
     "htm": "^3.1.1",
-    "preact": "^10.0.0"
+    "preact": "^10.13.2"
   },
   "devDependencies": {
-    "@algolia/client-search": "4.14.3"
+    "@algolia/client-search": "4.16.0"
   },
   "peerDependencies": {
     "@algolia/client-search": ">= 4.5.1 < 6",

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

@@ -1,27 +0,0 @@
-export declare type AutocompleteClassNames = {
-    detachedCancelButton: string;
-    detachedFormContainer: string;
-    detachedContainer: string;
-    detachedOverlay: string;
-    detachedSearchButton: string;
-    detachedSearchButtonIcon: string;
-    detachedSearchButtonPlaceholder: string;
-    form: string;
-    input: string;
-    inputWrapper: string;
-    inputWrapperPrefix: string;
-    inputWrapperSuffix: string;
-    item: string;
-    label: string;
-    list: string;
-    loadingIndicator: string;
-    panel: string;
-    panelLayout: string;
-    clearButton: string;
-    root: string;
-    source: string;
-    sourceFooter: string;
-    sourceHeader: string;
-    sourceNoResults: string;
-    submitButton: string;
-};

package/dist/esm/types/AutocompleteClassNames.js

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

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

@@ -1,6 +0,0 @@
-import { BaseItem } from '@algolia/autocomplete-core';
-import { InternalAutocompleteSource } from './AutocompleteSource';
-export interface AutocompleteCollection<TItem extends BaseItem> {
-    source: InternalAutocompleteSource<TItem>;
-    items: TItem[];
-}

package/dist/esm/types/AutocompleteCollection.js

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

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

@@ -1,23 +0,0 @@
-/// <reference types="react" />
-import { HighlightHitParams } from '.';
-declare type AutocompleteHighlightComponent = <THit>({ hit, attribute, tagName, }: HighlightHitParams<THit>) => JSX.Element;
-export declare type PublicAutocompleteComponents = Record<string, (props: any) => JSX.Element>;
-export interface AutocompleteComponents extends PublicAutocompleteComponents {
-    /**
-     * Highlight matches in an Algolia hit.
-     */
-    Highlight: AutocompleteHighlightComponent;
-    /**
-     * Reverse-highlight matches in an Algolia hit.
-     */
-    ReverseHighlight: AutocompleteHighlightComponent;
-    /**
-     * Reverse-highlight and snippets matches in an Algolia hit.
-     */
-    ReverseSnippet: AutocompleteHighlightComponent;
-    /**
-     * Highlight and snippet matches in an Algolia hit.
-     */
-    Snippet: AutocompleteHighlightComponent;
-}
-export {};

package/dist/esm/types/AutocompleteComponents.js

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

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

@@ -1,106 +0,0 @@
-import { AutocompleteScopeApi, AutocompleteOptions as AutocompleteCoreOptions, BaseItem, GetSourcesParams } from '@algolia/autocomplete-core';
-import { MaybePromise } from '@algolia/autocomplete-shared';
-import { AutocompleteClassNames } from './AutocompleteClassNames';
-import { PublicAutocompleteComponents } from './AutocompleteComponents';
-import { AutocompletePlugin } from './AutocompletePlugin';
-import { AutocompletePropGetters } from './AutocompletePropGetters';
-import { AutocompleteRender } from './AutocompleteRender';
-import { AutocompleteRenderer } from './AutocompleteRenderer';
-import { AutocompleteSource } from './AutocompleteSource';
-import { AutocompleteState } from './AutocompleteState';
-import { AutocompleteTranslations } from './AutocompleteTranslations';
-export interface OnStateChangeProps<TItem extends BaseItem> extends AutocompleteScopeApi<TItem> {
-    /**
-     * The current Autocomplete state.
-     */
-    state: AutocompleteState<TItem>;
-    /**
-     * The previous Autocomplete state.
-     */
-    prevState: AutocompleteState<TItem>;
-}
-export declare type GetSources<TItem extends BaseItem> = (params: GetSourcesParams<TItem>) => MaybePromise<Array<AutocompleteSource<TItem> | boolean | undefined>>;
-export interface AutocompleteOptions<TItem extends BaseItem> extends AutocompleteCoreOptions<TItem>, Partial<AutocompletePropGetters<TItem>> {
-    /**
-     * The container for the Autocomplete search box.
-     *
-     * You can either pass a [CSS selector](https://developer.mozilla.org/docs/Web/CSS/CSS_Selectors) or an [Element](https://developer.mozilla.org/docs/Web/API/HTMLElement). If there are several containers matching the selector, Autocomplete picks up the first one.
-     *
-     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-container
-     */
-    container: string | HTMLElement;
-    /**
-     * The container for the Autocomplete panel.
-     *
-     * You can either pass a [CSS selector](https://developer.mozilla.org/docs/Web/CSS/CSS_Selectors) or an [Element](https://developer.mozilla.org/docs/Web/API/HTMLElement). If there are several containers matching the selector, Autocomplete picks up the first one.
-     *
-     * @default document.body
-     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-panelcontainer
-     */
-    panelContainer?: string | HTMLElement;
-    /**
-     * The Media Query to turn Autocomplete into a detached experience.
-     *
-     * @default "(max-width: 680px)"
-     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-detachedmediaquery
-     * @link https://developer.mozilla.org/en-US/docs/Web/CSS/Media_Queries/Using_media_queries
-     */
-    detachedMediaQuery?: string;
-    getSources?: GetSources<TItem>;
-    /**
-     * The panel's horizontal position.
-     *
-     * @default "input-wrapper-width"
-     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-panelplacement
-     */
-    panelPlacement?: 'start' | 'end' | 'full-width' | 'input-wrapper-width';
-    /**
-     * Class names to inject for each created DOM element.
-     *
-     * This is useful to style your autocomplete with external CSS frameworks.
-     *
-     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-classnames
-     */
-    classNames?: Partial<AutocompleteClassNames>;
-    /**
-     * The function that renders the autocomplete panel.
-     *
-     * This is useful to customize the rendering, for example, using multi-row or multi-column layouts.
-     *
-     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-render
-     */
-    render?: AutocompleteRender<TItem>;
-    /**
-     * The function that renders a no results section when there are no hits.
-     *
-     * This is useful to let the user know that the query returned no results.
-     *
-     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-rendernoresults
-     */
-    renderNoResults?: AutocompleteRender<TItem>;
-    initialState?: Partial<AutocompleteState<TItem>>;
-    onStateChange?(props: OnStateChangeProps<TItem>): void;
-    /**
-     * The virtual DOM implementation to plug to Autocomplete. It defaults to Preact.
-     *
-     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-renderer
-     */
-    renderer?: AutocompleteRenderer;
-    plugins?: Array<AutocompletePlugin<any, any>>;
-    /**
-     * Components to register in the Autocomplete rendering lifecycles.
-     *
-     * Registered components become available in [`templates`](https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/templates/), [`render`](https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-render), and in [`renderNoResults`](https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-rendernoresults).
-     *
-     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-components
-     */
-    components?: PublicAutocompleteComponents;
-    /**
-     * A mapping of translation strings.
-     *
-     * Defaults to English values.
-     *
-     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-translations
-     */
-    translations?: Partial<AutocompleteTranslations>;
-}

package/dist/esm/types/AutocompleteOptions.js

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

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

@@ -1,12 +0,0 @@
-import { AutocompletePlugin as AutocompleteCorePlugin, BaseItem } from '@algolia/autocomplete-core';
-import { AutocompleteOptions } from './AutocompleteOptions';
-export declare type AutocompletePlugin<TItem extends BaseItem, TData> = Omit<AutocompleteCorePlugin<TItem, TData>, 'getSources'> & {
-    /**
-     * The [sources](https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/sources/) to get the suggestions from.
-     *
-     * When defined, they’re merged with the sources of your Autocomplete instance.
-     *
-     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/plugins/#param-getsources
-     */
-    getSources?: AutocompleteOptions<TItem>['getSources'];
-};

package/dist/esm/types/AutocompletePlugin.js

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

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

@@ -1,33 +0,0 @@
-import { BaseItem, AutocompleteApi as AutocompleteCoreApi, AutocompleteScopeApi } from '@algolia/autocomplete-core';
-import { AutocompleteState } from './AutocompleteState';
-declare type PropsGetterParams<TItem extends BaseItem, TParam> = TParam & {
-    state: AutocompleteState<TItem>;
-} & AutocompleteScopeApi<TItem>;
-export declare type AutocompletePropGetters<TItem extends BaseItem> = {
-    getEnvironmentProps(params: PropsGetterParams<TItem, {
-        props: ReturnType<AutocompleteCoreApi<TItem>['getEnvironmentProps']>;
-    }>): ReturnType<AutocompleteCoreApi<TItem>['getEnvironmentProps']>;
-    getFormProps(params: PropsGetterParams<TItem, {
-        props: ReturnType<AutocompleteCoreApi<TItem>['getFormProps']>;
-    }>): ReturnType<AutocompleteCoreApi<TItem>['getFormProps']>;
-    getInputProps(params: PropsGetterParams<TItem, {
-        props: ReturnType<AutocompleteCoreApi<TItem>['getInputProps']>;
-        inputElement: HTMLInputElement;
-    }>): ReturnType<AutocompleteCoreApi<TItem>['getInputProps']>;
-    getItemProps(params: PropsGetterParams<TItem, {
-        props: ReturnType<AutocompleteCoreApi<TItem>['getItemProps']>;
-    }>): ReturnType<AutocompleteCoreApi<TItem>['getItemProps']>;
-    getLabelProps(params: PropsGetterParams<TItem, {
-        props: ReturnType<AutocompleteCoreApi<TItem>['getLabelProps']>;
-    }>): ReturnType<AutocompleteCoreApi<TItem>['getLabelProps']>;
-    getListProps(params: PropsGetterParams<TItem, {
-        props: ReturnType<AutocompleteCoreApi<TItem>['getListProps']>;
-    }>): ReturnType<AutocompleteCoreApi<TItem>['getListProps']>;
-    getPanelProps(params: PropsGetterParams<TItem, {
-        props: ReturnType<AutocompleteCoreApi<TItem>['getPanelProps']>;
-    }>): ReturnType<AutocompleteCoreApi<TItem>['getPanelProps']>;
-    getRootProps(params: PropsGetterParams<TItem, {
-        props: ReturnType<AutocompleteCoreApi<TItem>['getRootProps']>;
-    }>): ReturnType<AutocompleteCoreApi<TItem>['getRootProps']>;
-};
-export {};

package/dist/esm/types/AutocompletePropGetters.js

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

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

@@ -1,15 +0,0 @@
-import { AutocompleteScopeApi, BaseItem } from '@algolia/autocomplete-core';
-import { AutocompleteComponents } from './AutocompleteComponents';
-import { HTMLTemplate, Pragma, PragmaFrag, Render, VNode } from './AutocompleteRenderer';
-import { AutocompleteState } from './AutocompleteState';
-export declare type AutocompleteRender<TItem extends BaseItem> = (params: AutocompleteScopeApi<TItem> & {
-    children: VNode;
-    state: AutocompleteState<TItem>;
-    sections: VNode[];
-    elements: Record<string, VNode>;
-    components: AutocompleteComponents;
-    createElement: Pragma;
-    Fragment: PragmaFrag;
-    html: HTMLTemplate;
-    render: Render;
-}, root: HTMLElement) => void;

package/dist/esm/types/AutocompleteRender.js

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

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

@@ -1,33 +0,0 @@
-/// <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> | string | number | boolean | null | undefined;
-declare type ComponentChildren = ComponentChild[] | ComponentChild;
-export declare type VNode<TProps = {}> = {
-    type: any;
-    key: string | number | any;
-    props: TProps & {
-        children: ComponentChildren;
-    };
-};
-export declare type Render = (vnode: ComponentChild, parent: Element | Document | ShadowRoot | DocumentFragment, replaceNode?: Element | Text | undefined) => void;
-export declare type AutocompleteRenderer = {
-    /**
-     * The function to create virtual nodes.
-     *
-     * @default preact.createElement
-     */
-    createElement: Pragma;
-    /**
-     * The component to use to create fragments.
-     *
-     * @default preact.Fragment
-     */
-    Fragment: PragmaFrag;
-    /**
-     * The function to render children to an element.
-     */
-    render?: Render;
-};
-export declare type HTMLTemplate = (strings: TemplateStringsArray, ...values: any[]) => VNode | VNode[];
-export {};

package/dist/esm/types/AutocompleteRenderer.js

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

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

@@ -1,74 +0,0 @@
-import { AutocompleteSource as AutocompleteCoreSource, InternalAutocompleteSource as InternalAutocompleteCoreSource, BaseItem } from '@algolia/autocomplete-core';
-import { AutocompleteComponents } from './AutocompleteComponents';
-import { AutocompleteRenderer, HTMLTemplate, VNode } from './AutocompleteRenderer';
-import { AutocompleteState } from './AutocompleteState';
-declare type Template<TParams> = (params: TParams & AutocompleteRenderer & {
-    components: AutocompleteComponents;
-    html: HTMLTemplate;
-}) => VNode | VNode[] | string;
-/**
- * Templates to display in the autocomplete panel.
- *
- * A template can either return a string, or perform DOM mutations (manipulating DOM elements with JavaScript and attaching events) without returning a string.
- */
-export declare type SourceTemplates<TItem extends BaseItem> = {
-    /**
-     * A function that returns the template for each item of the source.
-     *
-     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/templates/#param-item
-     */
-    item: Template<{
-        item: TItem;
-        state: AutocompleteState<TItem>;
-    }>;
-    /**
-     * A function that returns the template for the header (before the list of items).
-     *
-     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/templates/#param-header
-     */
-    header?: Template<{
-        state: AutocompleteState<TItem>;
-        source: AutocompleteSource<TItem>;
-        items: TItem[];
-    }>;
-    /**
-     * A function that returns the template for the footer (after the list of items).
-     *
-     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/templates/#param-footer
-     */
-    footer?: Template<{
-        state: AutocompleteState<TItem>;
-        source: AutocompleteSource<TItem>;
-        items: TItem[];
-    }>;
-    /**
-     * A function that returns the template for when there are no items.
-     *
-     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/templates/#param-noresults
-     */
-    noResults?: Template<{
-        state: AutocompleteState<TItem>;
-        source: AutocompleteSource<TItem>;
-    }>;
-};
-declare type WithTemplates<TType, TItem extends BaseItem> = TType & {
-    /**
-     * A set of templates to customize how sections and their items are displayed.
-     *
-     * See [**Displaying items with Templates**](templates) for more information.
-     *
-     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/sources/#param-templates
-     */
-    templates: SourceTemplates<TItem>;
-};
-export interface AutocompleteCoreSourceWithDocs<TItem extends BaseItem> extends AutocompleteCoreSource<TItem> {
-    /**
-     * Unique identifier for the source.
-     *
-     * It is used as value for the `data-autocomplete-source-id` attribute of the source `section` container.
-     */
-    sourceId: string;
-}
-export declare type AutocompleteSource<TItem extends BaseItem> = WithTemplates<AutocompleteCoreSourceWithDocs<TItem>, TItem>;
-export declare type InternalAutocompleteSource<TItem extends BaseItem> = WithTemplates<InternalAutocompleteCoreSource<TItem>, TItem>;
-export {};

package/dist/esm/types/AutocompleteSource.js

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

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

@@ -1,10 +0,0 @@
-import { AutocompleteState as AutocompleteCoreState, BaseItem } from '@algolia/autocomplete-core';
-import { AutocompleteCollection } from './AutocompleteCollection';
-export declare type AutocompleteState<TItem extends BaseItem> = Omit<AutocompleteCoreState<TItem>, 'collections'> & {
-    /**
-     * The collections of items.
-     *
-     * @link https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/state/#param-collections
-     */
-    collections: Array<AutocompleteCollection<TItem>>;
-};

package/dist/esm/types/AutocompleteState.js

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

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

@@ -1,5 +0,0 @@
-export declare type AutocompleteTranslations = {
-    detachedCancelButtonText: string;
-    clearButtonTitle: string;
-    submitButtonTitle: string;
-};

package/dist/esm/types/AutocompleteTranslations.js

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

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

@@ -1,18 +0,0 @@
-export declare type HighlightHitParams<THit> = {
-    /**
-     * The Algolia hit whose attribute to retrieve the highlighted parts from.
-     */
-    hit: THit;
-    /**
-     * The attribute to retrieve the highlighted parts from.
-     *
-     * You can use the array syntax to reference nested attributes.
-     */
-    attribute: keyof THit | string[];
-    /**
-     * The tag name to use for highlighted parts.
-     *
-     * @default "mark"
-     */
-    tagName?: string;
-};

package/dist/esm/types/HighlightHitParams.js

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