@trackunit/react-components 3.8.1 → 3.8.2-alpha-775ca1816d6.0

package/src/hooks/persistence/useMigrateLegacySearchParam.d.ts

@@ -1,62 +0,0 @@
-type UseMigrateLegacySearchParamOptions<TState> = {
-    readonly key: string;
-    readonly enabled: boolean;
-    /**
-     * Pure decoder for the raw search-param string. Should not throw — return
-     * `undefined` when the input can't be decoded.
-     */
-    readonly decode: (rawSearchValue: string) => unknown;
-    /**
-     * Optional transform applied to the decoded payload before validation
-     * (mirrors `usePersistedState`'s `fromUrlValue`).
-     */
-    readonly fromUrlValue?: (decoded: unknown) => unknown;
-    /**
-     * Schema validator. Return the parsed state on success, `undefined`
-     * otherwise.
-     */
-    readonly validate: (raw: unknown) => TState | undefined;
-    /**
-     * When `true`, the hash already carries a valid value for this key. The
-     * hook still strips the legacy search param (so the URL is clean) but
-     * does NOT fire `onMigrated` — the hash is canonical and we must not
-     * stomp on it.
-     */
-    readonly hashAlreadyHasValue: boolean;
-    /**
-     * Called at most once when a valid legacy search-param value is found
-     * and the hash is currently empty. Pipe through your normal
-     * `persistState` so the value ends up in both the hash and localStorage.
-     */
-    readonly onMigrated: (state: TState) => void;
-};
-/**
- * One-shot migration: if the URL still carries a legacy `?<key>=...`
- * search param from before this hook moved table-style state to the
- * fragment, decode it, hand it to the caller via `onMigrated`, then strip
- * the search param via a `replace` navigation so back/forward history
- * isn't polluted.
- *
- * Invariants:
- *  - The strip navigation fires at most once per mount (guarded by
- *    `hasStrippedRef`) so we don't loop on the navigation we ourselves
- *    triggered.
- *  - `onMigrated` is also fired at most once per mount (guarded by
- *    `hasMigratedRef`), but its gating is independent of the strip:
- *    if `hashAlreadyHasValue` flips `true → false` after the strip
- *    (e.g. an external actor clears the canonical hash mid-mount), the
- *    next render still gets a chance to migrate the legacy value into
- *    the hash. Conflating the two flags would have permanently lost
- *    the legacy state in that race.
- *  - Never throws — a decode/validate failure silently drops the value
- *    and still strips the search param. The legacy key is owned by this
- *    codebase's persistence convention (camelCase + `Tp` suffix), so
- *    stripping unparseable values cannot destroy third-party data.
- *  - When `hashAlreadyHasValue` is `true` the hash wins: the search
- *    param is stripped but `onMigrated` is not fired.
- *  - The `location.hash` is preserved verbatim across the strip
- *    navigation so any concurrent hash content (including a freshly
- *    written value) survives the cleanup.
- */
-export declare const useMigrateLegacySearchParam: <TState>({ key, enabled, decode, fromUrlValue, validate, hashAlreadyHasValue, onMigrated, }: UseMigrateLegacySearchParamOptions<TState>) => void;
-export {};