@ox0/hooks 0.2.2 → 0.3.0

package/dist/index.d.ts

@@ -11,6 +11,7 @@ export * from "./use-hover";
 export * from "./use-interval";
 export * from "./use-key-down";
 export * from "./use-stored-state";
+export * from "./use-search-history";
 export * from "./use-long-press";
 export * from "./use-press";
 export * from "./use-media-query";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAA;AAC3C,cAAc,kBAAkB,CAAA;AAChC,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,yBAAyB,CAAA;AACvC,cAAc,uBAAuB,CAAA;AACrC,cAAc,yBAAyB,CAAA;AACvC,cAAc,kBAAkB,CAAA;AAChC,cAAc,sBAAsB,CAAA;AACpC,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,oBAAoB,CAAA;AAClC,cAAc,kBAAkB,CAAA;AAChC,cAAc,aAAa,CAAA;AAC3B,cAAc,mBAAmB,CAAA;AACjC,cAAc,wBAAwB,CAAA;AACtC,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,sBAAsB,CAAA;AACpC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAA;AAC3C,cAAc,kBAAkB,CAAA;AAChC,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,yBAAyB,CAAA;AACvC,cAAc,uBAAuB,CAAA;AACrC,cAAc,yBAAyB,CAAA;AACvC,cAAc,kBAAkB,CAAA;AAChC,cAAc,sBAAsB,CAAA;AACpC,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,oBAAoB,CAAA;AAClC,cAAc,sBAAsB,CAAA;AACpC,cAAc,kBAAkB,CAAA;AAChC,cAAc,aAAa,CAAA;AAC3B,cAAc,mBAAmB,CAAA;AACjC,cAAc,wBAAwB,CAAA;AACtC,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,sBAAsB,CAAA;AACpC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,mBAAmB,CAAA"}

package/dist/index.js

@@ -502,6 +502,49 @@ function useSessionState(key, parser, options) {
 function useSessionSharedState(key, parser, options) {
     return useStoredState("session", key, parser, options, true);
 }
+const entriesParser = {
+    parse (value) {
+        if (!Array.isArray(value)) throw new Error("search history is not a list");
+        return value.filter((entry)=>"string" == typeof entry);
+    }
+};
+function searchHistoryIdentity(entry) {
+    return entry.trim().replace(/\s+/g, " ").toLowerCase();
+}
+function useSearchHistory(key, options = {}) {
+    const { limit = 15, storage = "persistent" } = options;
+    const storageKey = `search-history:${key}`;
+    const persistent = usePersistentSharedState(storageKey, entriesParser, {
+        defaultValue: []
+    });
+    const session = useSessionSharedState(storageKey, entriesParser, {
+        defaultValue: []
+    });
+    const [entries, setEntries] = "session" === storage ? session : persistent;
+    return useMemo(()=>({
+            entries,
+            add (entry) {
+                const text = entry.trim();
+                if ("" === text) return;
+                const identity = searchHistoryIdentity(text);
+                setEntries((previous)=>[
+                        text,
+                        ...previous.filter((existing)=>searchHistoryIdentity(existing) !== identity)
+                    ].slice(0, limit));
+            },
+            remove (entry) {
+                const identity = searchHistoryIdentity(entry);
+                setEntries((previous)=>previous.filter((existing)=>searchHistoryIdentity(existing) !== identity));
+            },
+            clear () {
+                setEntries([]);
+            }
+        }), [
+        entries,
+        limit,
+        setEntries
+    ]);
+}
 function useLongPress({ delayMs = 500, moveThresholdPx = 8, disabled = false, onLongPress }) {
     const timerRef = useRef(null);
     const pointerIdRef = useRef(null);
@@ -717,4 +760,4 @@ function useWindowSize() {
     return size;
 }
 export { isFocusVisible, usePress } from "@react-aria/interactions";
-export { StorageProvider, useBeforeUnloadWarning, useBreakpoint, useContainerSize, useControllableState, useCopyToClipboard, useDebouncedValue, useDeferredPresence, useDisclosure, useEventListener, useHover, useInterval, useKeyDown, useLongPress, useMediaQuery, useNavigatorOnline, useNow, useOS, usePersistentSharedState, usePersistentState, usePointerCoarse, usePrefersReducedMotion, usePrevious, useSessionSharedState, useSessionState, useTimeout, useViewport, useWindowSize };
+export { StorageProvider, useBeforeUnloadWarning, useBreakpoint, useContainerSize, useControllableState, useCopyToClipboard, useDebouncedValue, useDeferredPresence, useDisclosure, useEventListener, useHover, useInterval, useKeyDown, useLongPress, useMediaQuery, useNavigatorOnline, useNow, useOS, usePersistentSharedState, usePersistentState, usePointerCoarse, usePrefersReducedMotion, usePrevious, useSearchHistory, useSessionSharedState, useSessionState, useTimeout, useViewport, useWindowSize };

package/dist/use-search-history.d.ts

@@ -0,0 +1,24 @@
+/** Recent searches, newest first. Pass it to a search box (`QueryBar`, `GlobalSearch`) as `history`. */
+export type SearchHistory = {
+    readonly entries: readonly string[];
+    /** Records a search: moves it (or an earlier copy of it) to the top, and trims to the limit. */
+    readonly add: (entry: string) => void;
+    readonly remove: (entry: string) => void;
+    readonly clear: () => void;
+};
+export type SearchHistoryOptions = {
+    /** How many entries to keep. Default 15. */
+    readonly limit?: number;
+    /**
+     * `"persistent"` (default): kept across sessions in localStorage. `"session"`: forgotten when the
+     * tab closes — consider it when searches can contain personal data.
+     */
+    readonly storage?: "persistent" | "session";
+};
+/**
+ * Recent searches for one search box, kept per user through `StorageProvider` and shared between
+ * tabs. Entries are deduplicated ignoring case and spacing; blank searches aren't recorded. Use a
+ * key per box (`"payments"`, `"global-search"`) so their histories stay apart.
+ */
+export declare function useSearchHistory(key: string, options?: SearchHistoryOptions): SearchHistory;
+//# sourceMappingURL=use-search-history.d.ts.map

package/dist/use-search-history.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-search-history.d.ts","sourceRoot":"","sources":["../src/use-search-history.ts"],"names":[],"mappings":"AAIA,wGAAwG;AACxG,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAA;IACnC,gGAAgG;IAChG,QAAQ,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IACrC,QAAQ,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IACxC,QAAQ,CAAC,KAAK,EAAE,MAAM,IAAI,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,4CAA4C;IAC5C,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,SAAS,CAAA;CAC5C,CAAA;AAcD;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB,GAAG,aAAa,CAiC/F"}

package/dist/use-search-history.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=use-search-history.test.d.ts.map

package/dist/use-search-history.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-search-history.test.d.ts","sourceRoot":"","sources":["../src/use-search-history.test.tsx"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ox0/hooks",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/esturcke/ox0-platform.git",
@@ -27,7 +27,7 @@
     "react": "^19.0.0"
   },
   "scripts": {
-    "build": "rslib build -c ../../rslib.config.ts && tsc --build --force tsconfig.build.json",
+    "build": "rslib build -c ../../rslib.config.ts && rm -f tsconfig.build.tsbuildinfo && tsc -p tsconfig.build.json",
     "typecheck": "tsc -p tsconfig.json",
     "lint": "oxlint .",
     "test": "vitest run"