@enigmax/primitives 0.3.0 → 0.4.0

package/dist/chunk-UZFEEFMF.js

@@ -0,0 +1,145 @@
+// src/core/search.ts
+var DEFAULT_DEBOUNCE = 120;
+function fold(value) {
+  return value.normalize("NFD").replace(/\p{Diacritic}/gu, "").toLowerCase();
+}
+function readPath(item, path) {
+  let cursor = item;
+  for (const step of path.split(".")) {
+    if (cursor == null || typeof cursor !== "object") return "";
+    cursor = cursor[step];
+  }
+  return cursor == null ? "" : String(cursor);
+}
+function substringMatcher(query, items, keys) {
+  const needle = fold(query);
+  const results = [];
+  for (const item of items) {
+    const fields = keys.length ? keys : [""];
+    let best = null;
+    for (let index = 0; index < fields.length; index++) {
+      const key = fields[index];
+      const haystack = fold(key ? readPath(item, key) : String(item));
+      const at = haystack.indexOf(needle);
+      if (at < 0) continue;
+      const score = haystack === needle ? 0 : (at + 1) / (haystack.length + 1) + index * 0.01;
+      if (!best || score < best.score) best = { item, score, key: key || void 0 };
+    }
+    if (best) results.push(best);
+  }
+  return results.sort((left, right) => left.score - right.score);
+}
+function createSearch(options = {}) {
+  let opts = { ...options };
+  let items = opts.items ?? [];
+  let query = "";
+  let results = [];
+  let timer = null;
+  let engine = null;
+  let destroyed = false;
+  const listeners = /* @__PURE__ */ new Set();
+  function buildEngine() {
+    engine = null;
+    if (opts.matcher || !opts.fuse) return;
+    engine = new opts.fuse(items, { keys: opts.keys ?? [], includeScore: true, includeMatches: true, threshold: 0.4, ...opts.fuseOptions });
+  }
+  function run(next) {
+    const trimmed = next.trim();
+    const minLength = opts.minLength ?? 1;
+    let found;
+    if (trimmed.length < minLength) {
+      found = (opts.empty ?? "none") === "all" ? items.map((item) => ({ item, score: 0 })) : [];
+    } else if (opts.matcher) {
+      found = opts.matcher(trimmed, items);
+    } else if (engine) {
+      found = engine.search(trimmed).map((hit) => ({
+        item: hit.item,
+        score: hit.score ?? 0,
+        key: hit.matches?.[0]?.key
+      }));
+    } else {
+      found = substringMatcher(trimmed, items, opts.keys ?? []);
+    }
+    return opts.limit != null ? found.slice(0, opts.limit) : found;
+  }
+  function publish(next) {
+    query = next;
+    results = run(next);
+    opts.onResults?.(results, query);
+    for (const listener of listeners) listener(results, query);
+    return results;
+  }
+  function clearTimer() {
+    if (timer === null) return;
+    clearTimeout(timer);
+    timer = null;
+  }
+  buildEngine();
+  return {
+    get query() {
+      return query;
+    },
+    get results() {
+      return results;
+    },
+    search(next) {
+      if (destroyed) return;
+      clearTimer();
+      const wait = opts.debounce ?? DEFAULT_DEBOUNCE;
+      if (wait <= 0) {
+        publish(next);
+        return;
+      }
+      timer = setTimeout(() => {
+        timer = null;
+        publish(next);
+      }, wait);
+    },
+    searchNow(next) {
+      clearTimer();
+      return publish(next);
+    },
+    setItems(next) {
+      items = next;
+      buildEngine();
+      if (query) publish(query);
+    },
+    update(next) {
+      opts = { ...opts, ...next };
+      if (next.items) items = next.items;
+      buildEngine();
+      if (query) publish(query);
+    },
+    attach(input) {
+      const onInput = () => this.search(input.value);
+      const onKeyDown = (event) => {
+        if (event.key !== "Escape" || !input.value) return;
+        event.stopPropagation();
+        input.value = "";
+        this.searchNow("");
+      };
+      input.addEventListener("input", onInput);
+      input.addEventListener("keydown", onKeyDown);
+      input.dataset.enigmaSearch = "";
+      return () => {
+        input.removeEventListener("input", onInput);
+        input.removeEventListener("keydown", onKeyDown);
+        delete input.dataset.enigmaSearch;
+      };
+    },
+    subscribe(listener) {
+      listeners.add(listener);
+      return () => {
+        listeners.delete(listener);
+      };
+    },
+    destroy() {
+      destroyed = true;
+      clearTimer();
+      listeners.clear();
+      engine = null;
+    }
+  };
+}
+
+export { createSearch };

package/dist/{chunk-OKNWKBQI.js → chunk-W2DRHYC2.js}

@@ -470,148 +470,4 @@ function createInput(input, options = {}) {
   };
 }
 
-// src/core/search.ts
-var DEFAULT_DEBOUNCE = 120;
-function fold(value) {
-  return value.normalize("NFD").replace(/\p{Diacritic}/gu, "").toLowerCase();
-}
-function readPath(item, path) {
-  let cursor = item;
-  for (const step of path.split(".")) {
-    if (cursor == null || typeof cursor !== "object") return "";
-    cursor = cursor[step];
-  }
-  return cursor == null ? "" : String(cursor);
-}
-function substringMatcher(query, items, keys) {
-  const needle = fold(query);
-  const results = [];
-  for (const item of items) {
-    const fields = keys.length ? keys : [""];
-    let best = null;
-    for (let index = 0; index < fields.length; index++) {
-      const key = fields[index];
-      const haystack = fold(key ? readPath(item, key) : String(item));
-      const at = haystack.indexOf(needle);
-      if (at < 0) continue;
-      const score = haystack === needle ? 0 : (at + 1) / (haystack.length + 1) + index * 0.01;
-      if (!best || score < best.score) best = { item, score, key: key || void 0 };
-    }
-    if (best) results.push(best);
-  }
-  return results.sort((left, right) => left.score - right.score);
-}
-function createSearch(options = {}) {
-  let opts = { ...options };
-  let items = opts.items ?? [];
-  let query = "";
-  let results = [];
-  let timer = null;
-  let engine = null;
-  let destroyed = false;
-  const listeners = /* @__PURE__ */ new Set();
-  function buildEngine() {
-    engine = null;
-    if (opts.matcher || !opts.fuse) return;
-    engine = new opts.fuse(items, { keys: opts.keys ?? [], includeScore: true, includeMatches: true, threshold: 0.4, ...opts.fuseOptions });
-  }
-  function run(next) {
-    const trimmed = next.trim();
-    const minLength = opts.minLength ?? 1;
-    let found;
-    if (trimmed.length < minLength) {
-      found = (opts.empty ?? "none") === "all" ? items.map((item) => ({ item, score: 0 })) : [];
-    } else if (opts.matcher) {
-      found = opts.matcher(trimmed, items);
-    } else if (engine) {
-      found = engine.search(trimmed).map((hit) => ({
-        item: hit.item,
-        score: hit.score ?? 0,
-        key: hit.matches?.[0]?.key
-      }));
-    } else {
-      found = substringMatcher(trimmed, items, opts.keys ?? []);
-    }
-    return opts.limit != null ? found.slice(0, opts.limit) : found;
-  }
-  function publish(next) {
-    query = next;
-    results = run(next);
-    opts.onResults?.(results, query);
-    for (const listener of listeners) listener(results, query);
-    return results;
-  }
-  function clearTimer() {
-    if (timer === null) return;
-    clearTimeout(timer);
-    timer = null;
-  }
-  buildEngine();
-  return {
-    get query() {
-      return query;
-    },
-    get results() {
-      return results;
-    },
-    search(next) {
-      if (destroyed) return;
-      clearTimer();
-      const wait = opts.debounce ?? DEFAULT_DEBOUNCE;
-      if (wait <= 0) {
-        publish(next);
-        return;
-      }
-      timer = setTimeout(() => {
-        timer = null;
-        publish(next);
-      }, wait);
-    },
-    searchNow(next) {
-      clearTimer();
-      return publish(next);
-    },
-    setItems(next) {
-      items = next;
-      buildEngine();
-      if (query) publish(query);
-    },
-    update(next) {
-      opts = { ...opts, ...next };
-      if (next.items) items = next.items;
-      buildEngine();
-      if (query) publish(query);
-    },
-    attach(input) {
-      const onInput = () => this.search(input.value);
-      const onKeyDown = (event) => {
-        if (event.key !== "Escape" || !input.value) return;
-        event.stopPropagation();
-        input.value = "";
-        this.searchNow("");
-      };
-      input.addEventListener("input", onInput);
-      input.addEventListener("keydown", onKeyDown);
-      input.dataset.enigmaSearch = "";
-      return () => {
-        input.removeEventListener("input", onInput);
-        input.removeEventListener("keydown", onKeyDown);
-        delete input.dataset.enigmaSearch;
-      };
-    },
-    subscribe(listener) {
-      listeners.add(listener);
-      return () => {
-        listeners.delete(listener);
-      };
-    },
-    destroy() {
-      destroyed = true;
-      clearTimer();
-      listeners.clear();
-      engine = null;
-    }
-  };
-}
-
-export { createInput, createMarquee, createSearch };
+export { createInput, createMarquee };

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+export { F as FuseConstructor, a as FuseLike, S as SearchInstance, b as SearchMatch, c as SearchOptions, d as createSearch } from './search-CsO3L1Lw.js';
+
 /**
  * Draggable infinite marquee: the behaviour engine, with no styling of its own.
  *
@@ -145,71 +147,4 @@ interface InputInstance {
  */
 declare function createInput(input: HTMLInputElement, options?: InputOptions): InputInstance;
 
-/**
- * Search-as-you-type: debouncing, ordering, cancellation and the field wiring, with the
- * matching left pluggable.
- *
- * Fuse.js is NOT a dependency of this package. Hand it the constructor and you get fuzzy
- * matching configured exactly as if you had called it yourself - `fuseOptions` is passed
- * through untouched. Hand it nothing and a built-in accent-insensitive substring matcher
- * runs instead, so the primitive works with zero dependencies. Hand it a `matcher` and
- * every part of this is replaced by your own.
- */
-interface SearchMatch<T> {
-    item: T;
-    /** Lower is better, matching Fuse's convention. 0 is an exact hit. */
-    score: number;
-    /** Which key matched, when the matcher reports it. */
-    key?: string;
-}
-/** The shape of Fuse's constructor, declared here so the package need not depend on it. */
-interface FuseLike<T> {
-    search(query: string): {
-        item: T;
-        score?: number;
-        matches?: {
-            key?: string;
-        }[];
-    }[];
-}
-type FuseConstructor = new <T>(items: readonly T[], options?: Record<string, unknown>) => FuseLike<T>;
-interface SearchOptions<T> {
-    items?: readonly T[];
-    /** Fields to search. Dotted paths work with the built-in matcher and with Fuse. */
-    keys?: string[];
-    /**
-     * Pass Fuse.js's constructor to get fuzzy matching. Omit it for the built-in
-     * substring matcher. Ignored when `matcher` is set.
-     */
-    fuse?: FuseConstructor;
-    /** Handed to Fuse verbatim, so any Fuse option behaves exactly as documented there. */
-    fuseOptions?: Record<string, unknown>;
-    /** Replaces the engine entirely. Return the results in the order you want them. */
-    matcher?: (query: string, items: readonly T[]) => SearchMatch<T>[];
-    /** ms to wait after the last keystroke. 0 searches on every one. */
-    debounce?: number;
-    /** Queries shorter than this return nothing rather than everything. */
-    minLength?: number;
-    /** Cap the result list. */
-    limit?: number;
-    /** What an empty query returns. "none" (default) or "all". */
-    empty?: "none" | "all";
-    onResults?: (results: SearchMatch<T>[], query: string) => void;
-}
-interface SearchInstance<T> {
-    readonly query: string;
-    readonly results: SearchMatch<T>[];
-    /** Debounced. */
-    search(query: string): void;
-    /** Skips the debounce, e.g. on Enter. */
-    searchNow(query: string): SearchMatch<T>[];
-    setItems(items: readonly T[]): void;
-    update(options: Partial<SearchOptions<T>>): void;
-    /** Bind to a field: input events search, Escape clears. Returns an unbind. */
-    attach(input: HTMLInputElement): () => void;
-    subscribe(listener: (results: SearchMatch<T>[], query: string) => void): () => void;
-    destroy(): void;
-}
-declare function createSearch<T>(options?: SearchOptions<T>): SearchInstance<T>;
-
-export { type FuseConstructor, type FuseLike, type InputAction, type InputActionState, type InputIcon, type InputInstance, type InputOptions, type MarqueeInstance, type MarqueeOptions, type SearchInstance, type SearchMatch, type SearchOptions, createInput, createMarquee, createSearch };
+export { type InputAction, type InputActionState, type InputIcon, type InputInstance, type InputOptions, type MarqueeInstance, type MarqueeOptions, createInput, createMarquee };

package/dist/index.js

@@ -1 +1,2 @@
-export { createInput, createMarquee, createSearch } from './chunk-OKNWKBQI.js';
+export { createInput, createMarquee } from './chunk-W2DRHYC2.js';
+export { createSearch } from './chunk-UZFEEFMF.js';

package/dist/react/index.d.ts

@@ -1,6 +1,8 @@
 import { RefObject } from 'react';
-import { MarqueeOptions, InputOptions, SearchMatch, SearchOptions } from '../index.js';
-export { FuseConstructor, InputAction, InputIcon, MarqueeInstance } from '../index.js';
+import { MarqueeOptions, InputOptions } from '../index.js';
+export { InputAction, InputIcon, MarqueeInstance } from '../index.js';
+import { b as SearchMatch, c as SearchOptions } from '../search-CsO3L1Lw.js';
+export { F as FuseConstructor } from '../search-CsO3L1Lw.js';
 
 interface UseMarqueeResult {
     /** Attach to the clipping viewport. */

package/dist/react/index.js

@@ -1,4 +1,5 @@
-import { createMarquee, createInput, createSearch } from '../chunk-OKNWKBQI.js';
+import { createMarquee, createInput } from '../chunk-W2DRHYC2.js';
+import { createSearch } from '../chunk-UZFEEFMF.js';
 import { useRef, useState, useMemo, useEffect, useLayoutEffect } from 'react';
 
 var useIsomorphicLayoutEffect = typeof window === "undefined" ? useEffect : useLayoutEffect;

package/dist/search/index.d.ts

@@ -0,0 +1,29 @@
+import { c as SearchOptions, S as SearchInstance } from '../search-CsO3L1Lw.js';
+export { b as SearchMatch } from '../search-CsO3L1Lw.js';
+
+/**
+ * Search with Fuse.js already wired: the batteries-included entry point.
+ *
+ * `@enigmax/primitives` stays dependency-free, so someone who only wants the marquee
+ * never pulls a search engine into their bundle. Importing THIS subpath is the explicit
+ * opt-in, and it is what `enigma add search` sets a project up for - it installs fuse.js
+ * alongside the package.
+ *
+ * Everything else is identical to `createSearch` from the main entry: pass `fuseOptions`
+ * to configure Fuse, or `matcher` to replace it outright.
+ */
+
+/**
+ * Search as you type, fuzzy by default.
+ *
+ * ```js
+ * import { createSearch } from "@enigmax/primitives/search";
+ *
+ * const search = createSearch({ items: docs, keys: ["title", "body"] });
+ * ```
+ *
+ * Pass `fuse: undefined` explicitly to fall back to the built-in substring matcher.
+ */
+declare function createSearch<T>(options?: SearchOptions<T>): SearchInstance<T>;
+
+export { SearchInstance, SearchOptions, createSearch };

package/dist/search/index.js

@@ -0,0 +1,12 @@
+import { createSearch } from '../chunk-UZFEEFMF.js';
+import Fuse from 'fuse.js';
+
+function createSearch2(options = {}) {
+  return createSearch({
+    // A caller-supplied `fuse` or `matcher` still wins; this only fills the blank.
+    fuse: Fuse,
+    ...options
+  });
+}
+
+export { createSearch2 as createSearch };

package/dist/search-CsO3L1Lw.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Search-as-you-type: debouncing, ordering, cancellation and the field wiring, with the
+ * matching left pluggable.
+ *
+ * Fuse.js is NOT a dependency of this package. Hand it the constructor and you get fuzzy
+ * matching configured exactly as if you had called it yourself - `fuseOptions` is passed
+ * through untouched. Hand it nothing and a built-in accent-insensitive substring matcher
+ * runs instead, so the primitive works with zero dependencies. Hand it a `matcher` and
+ * every part of this is replaced by your own.
+ */
+interface SearchMatch<T> {
+    item: T;
+    /** Lower is better, matching Fuse's convention. 0 is an exact hit. */
+    score: number;
+    /** Which key matched, when the matcher reports it. */
+    key?: string;
+}
+/** The shape of Fuse's constructor, declared here so the package need not depend on it. */
+interface FuseLike<T> {
+    search(query: string): {
+        item: T;
+        score?: number;
+        matches?: {
+            key?: string;
+        }[];
+    }[];
+}
+type FuseConstructor = new <T>(items: readonly T[], options?: Record<string, unknown>) => FuseLike<T>;
+interface SearchOptions<T> {
+    items?: readonly T[];
+    /** Fields to search. Dotted paths work with the built-in matcher and with Fuse. */
+    keys?: string[];
+    /**
+     * Pass Fuse.js's constructor to get fuzzy matching. Omit it for the built-in
+     * substring matcher. Ignored when `matcher` is set.
+     */
+    fuse?: FuseConstructor;
+    /** Handed to Fuse verbatim, so any Fuse option behaves exactly as documented there. */
+    fuseOptions?: Record<string, unknown>;
+    /** Replaces the engine entirely. Return the results in the order you want them. */
+    matcher?: (query: string, items: readonly T[]) => SearchMatch<T>[];
+    /** ms to wait after the last keystroke. 0 searches on every one. */
+    debounce?: number;
+    /** Queries shorter than this return nothing rather than everything. */
+    minLength?: number;
+    /** Cap the result list. */
+    limit?: number;
+    /** What an empty query returns. "none" (default) or "all". */
+    empty?: "none" | "all";
+    onResults?: (results: SearchMatch<T>[], query: string) => void;
+}
+interface SearchInstance<T> {
+    readonly query: string;
+    readonly results: SearchMatch<T>[];
+    /** Debounced. */
+    search(query: string): void;
+    /** Skips the debounce, e.g. on Enter. */
+    searchNow(query: string): SearchMatch<T>[];
+    setItems(items: readonly T[]): void;
+    update(options: Partial<SearchOptions<T>>): void;
+    /** Bind to a field: input events search, Escape clears. Returns an unbind. */
+    attach(input: HTMLInputElement): () => void;
+    subscribe(listener: (results: SearchMatch<T>[], query: string) => void): () => void;
+    destroy(): void;
+}
+declare function createSearch<T>(options?: SearchOptions<T>): SearchInstance<T>;
+
+export { type FuseConstructor as F, type SearchInstance as S, type FuseLike as a, type SearchMatch as b, type SearchOptions as c, createSearch as d };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enigmax/primitives",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Headless interaction primitives: the behaviour, the timing and the accessibility of components like a draggable infinite marquee, with no styles of their own. Framework-agnostic core plus thin adapters.",
   "type": "module",
   "main": "./dist/index.js",
@@ -14,7 +14,11 @@
       "types": "./dist/react/index.d.ts",
       "import": "./dist/react/index.js"
     },
-    "./registry.json": "./registry.json"
+    "./registry.json": "./registry.json",
+    "./search": {
+      "types": "./dist/search/index.d.ts",
+      "import": "./dist/search/index.js"
+    }
   },
   "scripts": {
     "build": "tsup",

package/registry.json

@@ -180,15 +180,15 @@
     {
       "name": "search",
       "title": "Search as you type",
-      "description": "Debouncing, ranking, cancellation and the field wiring, with the matching pluggable. Pass Fuse.js for fuzzy search, your own function to replace the engine, or neither for the built-in accent-insensitive substring matcher.",
+      "description": "Search as you type, fuzzy by default with Fuse.js. Debouncing, ranking and cancellation are the primitive's; the matching is replaceable, and dropping Fuse falls back to a built-in accent-insensitive substring matcher.",
       "targets": [
         "vanilla",
         "astro",
         "react"
       ],
       "entry": {
-        "vanilla": "@enigmax/primitives",
-        "astro": "@enigmax/primitives",
+        "vanilla": "@enigmax/primitives/search",
+        "astro": "@enigmax/primitives/search",
         "react": "@enigmax/primitives/react"
       },
       "exports": {
@@ -241,7 +241,10 @@
       "docs": "docs/notes/primitives.md#search",
       "recipes": [
         "tailwind"
-      ]
+      ],
+      "dependencies": {
+        "fuse.js": "^7.0.0"
+      }
     }
   ]
 }

package/src/search/index.ts

@@ -0,0 +1,35 @@
+/**
+ * Search with Fuse.js already wired: the batteries-included entry point.
+ *
+ * `@enigmax/primitives` stays dependency-free, so someone who only wants the marquee
+ * never pulls a search engine into their bundle. Importing THIS subpath is the explicit
+ * opt-in, and it is what `enigma add search` sets a project up for - it installs fuse.js
+ * alongside the package.
+ *
+ * Everything else is identical to `createSearch` from the main entry: pass `fuseOptions`
+ * to configure Fuse, or `matcher` to replace it outright.
+ */
+
+import Fuse from "fuse.js";
+import { createSearch as createBaseSearch, type SearchOptions, type SearchInstance } from "@/core/search";
+
+export type { SearchOptions, SearchInstance, SearchMatch } from "@/core/search";
+
+/**
+ * Search as you type, fuzzy by default.
+ *
+ * ```js
+ * import { createSearch } from "@enigmax/primitives/search";
+ *
+ * const search = createSearch({ items: docs, keys: ["title", "body"] });
+ * ```
+ *
+ * Pass `fuse: undefined` explicitly to fall back to the built-in substring matcher.
+ */
+export function createSearch<T>(options: SearchOptions<T> = {}): SearchInstance<T> {
+    return createBaseSearch<T>({
+        // A caller-supplied `fuse` or `matcher` still wins; this only fills the blank.
+        fuse: Fuse as never,
+        ...options
+    });
+}