@samline/autocomplete 1.0.0 → 2.0.0

package/dist/types-CPvjhqjb.d.cts

@@ -0,0 +1,118 @@
+type AutocompleteTarget = string | HTMLInputElement;
+type AutocompleteEndpoint = string | URL | ((query: string, input: HTMLInputElement) => string | URL);
+type AutocompleteRequestInit = RequestInit | ((query: string, input: HTMLInputElement) => RequestInit);
+type AutocompleteParser = (response: Response, query: string) => Promise<unknown>;
+type AutocompleteResponseMapper<T> = (payload: unknown, response: Response, query: string) => readonly T[] | Promise<readonly T[]>;
+interface AutocompleteSourceContext {
+    /** Aborted when a newer search starts, the list is dismissed or the instance is destroyed. */
+    readonly signal: AbortSignal;
+    readonly input: HTMLInputElement;
+}
+type AutocompleteSourceFunction<T> = (query: string, context: AutocompleteSourceContext) => readonly T[] | Promise<readonly T[]>;
+/** Static suggestions filtered in the browser, or a function that resolves them. */
+type AutocompleteSource<T> = readonly T[] | AutocompleteSourceFunction<T>;
+interface AutocompleteEndpointOptions<T> {
+    endpoint: AutocompleteEndpoint;
+    /** Query string parameter; `null` leaves the URL untouched. Defaults to `q`. */
+    queryParam?: string | null;
+    requestInit?: AutocompleteRequestInit;
+    parseResponse?: AutocompleteParser;
+    mapResponse?: AutocompleteResponseMapper<T>;
+}
+interface AutocompleteCacheOptions {
+    /** Cached queries kept; the least recently used is evicted. Defaults to 50. */
+    max?: number;
+    /** Milliseconds a cached query stays fresh. Defaults to 300000. */
+    ttl?: number;
+}
+interface AutocompleteMessageContext {
+    query: string;
+    count: number;
+}
+type AutocompleteMessage = string | ((context: AutocompleteMessageContext) => string);
+interface AutocompleteMessages {
+    loading: AutocompleteMessage;
+    empty: AutocompleteMessage;
+    error: AutocompleteMessage;
+    /** Announced to screen readers when suggestions load. */
+    results: AutocompleteMessage;
+}
+interface AutocompleteHighlightPart {
+    text: string;
+    match: boolean;
+}
+interface AutocompleteRenderContext {
+    query: string;
+    index: number;
+    label: string;
+    /** The label split into matching and non-matching parts. */
+    highlight: readonly AutocompleteHighlightPart[];
+}
+interface AutocompleteOptions<T = unknown> {
+    /** Suggestions as an array or a function. Use either `source` or `endpoint`. */
+    source?: AutocompleteSource<T>;
+    endpoint?: AutocompleteEndpoint;
+    queryParam?: string | null;
+    requestInit?: AutocompleteRequestInit;
+    parseResponse?: AutocompleteParser;
+    mapResponse?: AutocompleteResponseMapper<T>;
+    /** Local filter for array sources. Defaults to an accent- and case-insensitive label match. */
+    filter?: (suggestion: T, query: string) => boolean;
+    /** Text normalization used by the default filter and highlighting. */
+    normalize?: (value: string) => string;
+    /** Remember results per query. Defaults to `true` for function and endpoint sources. */
+    cache?: boolean | AutocompleteCacheOptions;
+    /** Wrap the matching parts of each label in `<mark>`. Defaults to `true`. */
+    highlight?: boolean;
+    getId?: (suggestion: T, index: number) => string | number;
+    getLabel?: (suggestion: T) => string;
+    getValue?: (suggestion: T) => string;
+    renderOption?: (element: HTMLElement, suggestion: T, context: AutocompleteRenderContext) => void;
+    minLength?: number;
+    debounce?: number;
+    maxResults?: number;
+    searchOnFocus?: boolean;
+    messages?: Partial<AutocompleteMessages>;
+    onSelect?: (suggestion: T, input: HTMLInputElement) => void;
+    onError?: (error: unknown, input: HTMLInputElement) => void;
+}
+interface AutocompleteController<T = unknown> {
+    readonly element: HTMLInputElement;
+    /** Positioned container holding the listbox and the visible status. */
+    readonly popupElement: HTMLDivElement;
+    readonly listElement: HTMLDivElement;
+    readonly statusElement: HTMLDivElement;
+    /** Visually hidden polite live region. */
+    readonly liveElement: HTMLDivElement;
+    readonly options: Readonly<AutocompleteOptions<T>>;
+    search: (query?: string) => Promise<void>;
+    close: () => void;
+    clear: () => void;
+    cancel: () => void;
+    clearCache: () => void;
+    getSelected: () => T | null;
+    destroy: () => void;
+}
+interface AutocompleteSelectDetail<T = unknown> {
+    suggestion: T;
+    label: string;
+    value: string;
+}
+interface AutocompleteLoadDetail<T = unknown> {
+    query: string;
+    suggestions: readonly T[];
+    /** True when the results came from the cache without calling the source. */
+    cached: boolean;
+}
+interface AutocompleteErrorDetail {
+    query: string;
+    error: unknown;
+}
+interface AutocompleteCache<T> {
+    get: (key: string) => readonly T[] | undefined;
+    set: (key: string, value: readonly T[]) => void;
+    clear: () => void;
+    readonly size: number;
+}
+
+export type { AutocompleteCache as A, AutocompleteCacheOptions as a, AutocompleteController as b, AutocompleteEndpoint as c, AutocompleteEndpointOptions as d, AutocompleteErrorDetail as e, AutocompleteHighlightPart as f, AutocompleteLoadDetail as g, AutocompleteMessage as h, AutocompleteMessageContext as i, AutocompleteMessages as j, AutocompleteOptions as k, AutocompleteParser as l, AutocompleteRenderContext as m, AutocompleteRequestInit as n, AutocompleteResponseMapper as o, AutocompleteSelectDetail as p, AutocompleteSource as q, AutocompleteSourceContext as r, AutocompleteSourceFunction as s, AutocompleteTarget as t };

package/dist/types-CPvjhqjb.d.ts

@@ -0,0 +1,118 @@
+type AutocompleteTarget = string | HTMLInputElement;
+type AutocompleteEndpoint = string | URL | ((query: string, input: HTMLInputElement) => string | URL);
+type AutocompleteRequestInit = RequestInit | ((query: string, input: HTMLInputElement) => RequestInit);
+type AutocompleteParser = (response: Response, query: string) => Promise<unknown>;
+type AutocompleteResponseMapper<T> = (payload: unknown, response: Response, query: string) => readonly T[] | Promise<readonly T[]>;
+interface AutocompleteSourceContext {
+    /** Aborted when a newer search starts, the list is dismissed or the instance is destroyed. */
+    readonly signal: AbortSignal;
+    readonly input: HTMLInputElement;
+}
+type AutocompleteSourceFunction<T> = (query: string, context: AutocompleteSourceContext) => readonly T[] | Promise<readonly T[]>;
+/** Static suggestions filtered in the browser, or a function that resolves them. */
+type AutocompleteSource<T> = readonly T[] | AutocompleteSourceFunction<T>;
+interface AutocompleteEndpointOptions<T> {
+    endpoint: AutocompleteEndpoint;
+    /** Query string parameter; `null` leaves the URL untouched. Defaults to `q`. */
+    queryParam?: string | null;
+    requestInit?: AutocompleteRequestInit;
+    parseResponse?: AutocompleteParser;
+    mapResponse?: AutocompleteResponseMapper<T>;
+}
+interface AutocompleteCacheOptions {
+    /** Cached queries kept; the least recently used is evicted. Defaults to 50. */
+    max?: number;
+    /** Milliseconds a cached query stays fresh. Defaults to 300000. */
+    ttl?: number;
+}
+interface AutocompleteMessageContext {
+    query: string;
+    count: number;
+}
+type AutocompleteMessage = string | ((context: AutocompleteMessageContext) => string);
+interface AutocompleteMessages {
+    loading: AutocompleteMessage;
+    empty: AutocompleteMessage;
+    error: AutocompleteMessage;
+    /** Announced to screen readers when suggestions load. */
+    results: AutocompleteMessage;
+}
+interface AutocompleteHighlightPart {
+    text: string;
+    match: boolean;
+}
+interface AutocompleteRenderContext {
+    query: string;
+    index: number;
+    label: string;
+    /** The label split into matching and non-matching parts. */
+    highlight: readonly AutocompleteHighlightPart[];
+}
+interface AutocompleteOptions<T = unknown> {
+    /** Suggestions as an array or a function. Use either `source` or `endpoint`. */
+    source?: AutocompleteSource<T>;
+    endpoint?: AutocompleteEndpoint;
+    queryParam?: string | null;
+    requestInit?: AutocompleteRequestInit;
+    parseResponse?: AutocompleteParser;
+    mapResponse?: AutocompleteResponseMapper<T>;
+    /** Local filter for array sources. Defaults to an accent- and case-insensitive label match. */
+    filter?: (suggestion: T, query: string) => boolean;
+    /** Text normalization used by the default filter and highlighting. */
+    normalize?: (value: string) => string;
+    /** Remember results per query. Defaults to `true` for function and endpoint sources. */
+    cache?: boolean | AutocompleteCacheOptions;
+    /** Wrap the matching parts of each label in `<mark>`. Defaults to `true`. */
+    highlight?: boolean;
+    getId?: (suggestion: T, index: number) => string | number;
+    getLabel?: (suggestion: T) => string;
+    getValue?: (suggestion: T) => string;
+    renderOption?: (element: HTMLElement, suggestion: T, context: AutocompleteRenderContext) => void;
+    minLength?: number;
+    debounce?: number;
+    maxResults?: number;
+    searchOnFocus?: boolean;
+    messages?: Partial<AutocompleteMessages>;
+    onSelect?: (suggestion: T, input: HTMLInputElement) => void;
+    onError?: (error: unknown, input: HTMLInputElement) => void;
+}
+interface AutocompleteController<T = unknown> {
+    readonly element: HTMLInputElement;
+    /** Positioned container holding the listbox and the visible status. */
+    readonly popupElement: HTMLDivElement;
+    readonly listElement: HTMLDivElement;
+    readonly statusElement: HTMLDivElement;
+    /** Visually hidden polite live region. */
+    readonly liveElement: HTMLDivElement;
+    readonly options: Readonly<AutocompleteOptions<T>>;
+    search: (query?: string) => Promise<void>;
+    close: () => void;
+    clear: () => void;
+    cancel: () => void;
+    clearCache: () => void;
+    getSelected: () => T | null;
+    destroy: () => void;
+}
+interface AutocompleteSelectDetail<T = unknown> {
+    suggestion: T;
+    label: string;
+    value: string;
+}
+interface AutocompleteLoadDetail<T = unknown> {
+    query: string;
+    suggestions: readonly T[];
+    /** True when the results came from the cache without calling the source. */
+    cached: boolean;
+}
+interface AutocompleteErrorDetail {
+    query: string;
+    error: unknown;
+}
+interface AutocompleteCache<T> {
+    get: (key: string) => readonly T[] | undefined;
+    set: (key: string, value: readonly T[]) => void;
+    clear: () => void;
+    readonly size: number;
+}
+
+export type { AutocompleteCache as A, AutocompleteCacheOptions as a, AutocompleteController as b, AutocompleteEndpoint as c, AutocompleteEndpointOptions as d, AutocompleteErrorDetail as e, AutocompleteHighlightPart as f, AutocompleteLoadDetail as g, AutocompleteMessage as h, AutocompleteMessageContext as i, AutocompleteMessages as j, AutocompleteOptions as k, AutocompleteParser as l, AutocompleteRenderContext as m, AutocompleteRequestInit as n, AutocompleteResponseMapper as o, AutocompleteSelectDetail as p, AutocompleteSource as q, AutocompleteSourceContext as r, AutocompleteSourceFunction as s, AutocompleteTarget as t };