@tanstack/router-core 1.121.19 → 1.121.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. package/dist/cjs/Matches.cjs +13 -0
  2. package/dist/cjs/Matches.cjs.map +1 -0
  3. package/dist/cjs/Matches.d.cts +109 -0
  4. package/dist/cjs/RouterProvider.d.cts +26 -0
  5. package/dist/cjs/defer.cjs +25 -0
  6. package/dist/cjs/defer.cjs.map +1 -0
  7. package/dist/cjs/defer.d.cts +20 -0
  8. package/dist/cjs/fileRoute.d.cts +23 -0
  9. package/dist/cjs/history.d.cts +8 -0
  10. package/dist/cjs/index.cjs +79 -0
  11. package/dist/cjs/index.cjs.map +1 -0
  12. package/dist/cjs/index.d.cts +41 -0
  13. package/dist/cjs/link.cjs +5 -0
  14. package/dist/cjs/link.cjs.map +1 -0
  15. package/dist/cjs/link.d.cts +212 -0
  16. package/dist/cjs/location.d.cts +12 -0
  17. package/dist/cjs/manifest.d.cts +24 -0
  18. package/dist/cjs/not-found.cjs +13 -0
  19. package/dist/cjs/not-found.cjs.map +1 -0
  20. package/dist/cjs/not-found.d.cts +20 -0
  21. package/dist/cjs/path.cjs +412 -0
  22. package/dist/cjs/path.cjs.map +1 -0
  23. package/dist/cjs/path.d.cts +56 -0
  24. package/dist/cjs/qss.cjs +36 -0
  25. package/dist/cjs/qss.cjs.map +1 -0
  26. package/dist/cjs/qss.d.cts +31 -0
  27. package/dist/cjs/redirect.cjs +42 -0
  28. package/dist/cjs/redirect.cjs.map +1 -0
  29. package/dist/cjs/redirect.d.cts +41 -0
  30. package/dist/cjs/root.cjs +5 -0
  31. package/dist/cjs/root.cjs.map +1 -0
  32. package/dist/cjs/root.d.cts +2 -0
  33. package/dist/cjs/route.cjs +119 -0
  34. package/dist/cjs/route.cjs.map +1 -0
  35. package/dist/cjs/route.d.cts +432 -0
  36. package/dist/cjs/routeInfo.d.cts +54 -0
  37. package/dist/cjs/router.cjs +1805 -0
  38. package/dist/cjs/router.cjs.map +1 -0
  39. package/dist/cjs/router.d.cts +627 -0
  40. package/dist/cjs/scroll-restoration.cjs +207 -0
  41. package/dist/cjs/scroll-restoration.cjs.map +1 -0
  42. package/dist/cjs/scroll-restoration.d.cts +38 -0
  43. package/dist/cjs/searchMiddleware.cjs +42 -0
  44. package/dist/cjs/searchMiddleware.cjs.map +1 -0
  45. package/dist/cjs/searchMiddleware.d.cts +5 -0
  46. package/dist/cjs/searchParams.cjs +61 -0
  47. package/dist/cjs/searchParams.cjs.map +1 -0
  48. package/dist/cjs/searchParams.d.cts +7 -0
  49. package/dist/cjs/serializer.d.cts +22 -0
  50. package/dist/cjs/structuralSharing.d.cts +4 -0
  51. package/dist/cjs/typePrimitives.d.cts +65 -0
  52. package/dist/cjs/useLoaderData.d.cts +5 -0
  53. package/dist/cjs/useLoaderDeps.d.cts +5 -0
  54. package/dist/cjs/useNavigate.d.cts +3 -0
  55. package/dist/cjs/useParams.d.cts +5 -0
  56. package/dist/cjs/useRouteContext.d.cts +9 -0
  57. package/dist/cjs/useSearch.d.cts +5 -0
  58. package/dist/cjs/utils.cjs +165 -0
  59. package/dist/cjs/utils.cjs.map +1 -0
  60. package/dist/cjs/utils.d.cts +94 -0
  61. package/dist/cjs/validators.d.cts +51 -0
  62. package/dist/esm/Matches.d.ts +109 -0
  63. package/dist/esm/Matches.js +13 -0
  64. package/dist/esm/Matches.js.map +1 -0
  65. package/dist/esm/RouterProvider.d.ts +26 -0
  66. package/dist/esm/defer.d.ts +20 -0
  67. package/dist/esm/defer.js +25 -0
  68. package/dist/esm/defer.js.map +1 -0
  69. package/dist/esm/fileRoute.d.ts +23 -0
  70. package/dist/esm/history.d.ts +8 -0
  71. package/dist/esm/index.d.ts +41 -0
  72. package/dist/esm/index.js +79 -0
  73. package/dist/esm/index.js.map +1 -0
  74. package/dist/esm/link.d.ts +212 -0
  75. package/dist/esm/link.js +5 -0
  76. package/dist/esm/link.js.map +1 -0
  77. package/dist/esm/location.d.ts +12 -0
  78. package/dist/esm/manifest.d.ts +24 -0
  79. package/dist/esm/not-found.d.ts +20 -0
  80. package/dist/esm/not-found.js +13 -0
  81. package/dist/esm/not-found.js.map +1 -0
  82. package/dist/esm/path.d.ts +56 -0
  83. package/dist/esm/path.js +412 -0
  84. package/dist/esm/path.js.map +1 -0
  85. package/dist/esm/qss.d.ts +31 -0
  86. package/dist/esm/qss.js +36 -0
  87. package/dist/esm/qss.js.map +1 -0
  88. package/dist/esm/redirect.d.ts +41 -0
  89. package/dist/esm/redirect.js +42 -0
  90. package/dist/esm/redirect.js.map +1 -0
  91. package/dist/esm/root.d.ts +2 -0
  92. package/dist/esm/root.js +5 -0
  93. package/dist/esm/root.js.map +1 -0
  94. package/dist/esm/route.d.ts +432 -0
  95. package/dist/esm/route.js +119 -0
  96. package/dist/esm/route.js.map +1 -0
  97. package/dist/esm/routeInfo.d.ts +54 -0
  98. package/dist/esm/router.d.ts +627 -0
  99. package/dist/esm/router.js +1805 -0
  100. package/dist/esm/router.js.map +1 -0
  101. package/dist/esm/scroll-restoration.d.ts +38 -0
  102. package/dist/esm/scroll-restoration.js +207 -0
  103. package/dist/esm/scroll-restoration.js.map +1 -0
  104. package/dist/esm/searchMiddleware.d.ts +5 -0
  105. package/dist/esm/searchMiddleware.js +42 -0
  106. package/dist/esm/searchMiddleware.js.map +1 -0
  107. package/dist/esm/searchParams.d.ts +7 -0
  108. package/dist/esm/searchParams.js +61 -0
  109. package/dist/esm/searchParams.js.map +1 -0
  110. package/dist/esm/serializer.d.ts +22 -0
  111. package/dist/esm/structuralSharing.d.ts +4 -0
  112. package/dist/esm/typePrimitives.d.ts +65 -0
  113. package/dist/esm/useLoaderData.d.ts +5 -0
  114. package/dist/esm/useLoaderDeps.d.ts +5 -0
  115. package/dist/esm/useNavigate.d.ts +3 -0
  116. package/dist/esm/useParams.d.ts +5 -0
  117. package/dist/esm/useRouteContext.d.ts +9 -0
  118. package/dist/esm/useSearch.d.ts +5 -0
  119. package/dist/esm/utils.d.ts +94 -0
  120. package/dist/esm/utils.js +165 -0
  121. package/dist/esm/utils.js.map +1 -0
  122. package/dist/esm/validators.d.ts +51 -0
  123. package/package.json +2 -2
@@ -0,0 +1,207 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
+ const utils = require("./utils.cjs");
4
+ function getSafeSessionStorage() {
5
+ try {
6
+ if (typeof window !== "undefined" && typeof window.sessionStorage === "object") {
7
+ return window.sessionStorage;
8
+ }
9
+ } catch {
10
+ return void 0;
11
+ }
12
+ return void 0;
13
+ }
14
+ const storageKey = "tsr-scroll-restoration-v1_3";
15
+ const throttle = (fn, wait) => {
16
+ let timeout;
17
+ return (...args) => {
18
+ if (!timeout) {
19
+ timeout = setTimeout(() => {
20
+ fn(...args);
21
+ timeout = null;
22
+ }, wait);
23
+ }
24
+ };
25
+ };
26
+ function createScrollRestorationCache() {
27
+ const safeSessionStorage = getSafeSessionStorage();
28
+ if (!safeSessionStorage) {
29
+ return void 0;
30
+ }
31
+ const persistedState = safeSessionStorage.getItem(storageKey);
32
+ let state = persistedState ? JSON.parse(persistedState) : {};
33
+ return {
34
+ state,
35
+ // This setter is simply to make sure that we set the sessionStorage right
36
+ // after the state is updated. It doesn't necessarily need to be a functional
37
+ // update.
38
+ set: (updater) => (state = utils.functionalUpdate(updater, state) || state, safeSessionStorage.setItem(storageKey, JSON.stringify(state)))
39
+ };
40
+ }
41
+ const scrollRestorationCache = createScrollRestorationCache();
42
+ const defaultGetScrollRestorationKey = (location) => {
43
+ return location.state.key || location.href;
44
+ };
45
+ function getCssSelector(el) {
46
+ const path = [];
47
+ let parent;
48
+ while (parent = el.parentNode) {
49
+ path.unshift(
50
+ `${el.tagName}:nth-child(${[].indexOf.call(parent.children, el) + 1})`
51
+ );
52
+ el = parent;
53
+ }
54
+ return `${path.join(" > ")}`.toLowerCase();
55
+ }
56
+ let ignoreScroll = false;
57
+ function restoreScroll(storageKey2, key, behavior, shouldScrollRestoration, scrollToTopSelectors) {
58
+ var _a;
59
+ let byKey;
60
+ try {
61
+ byKey = JSON.parse(sessionStorage.getItem(storageKey2) || "{}");
62
+ } catch (error) {
63
+ console.error(error);
64
+ return;
65
+ }
66
+ const resolvedKey = key || ((_a = window.history.state) == null ? void 0 : _a.key);
67
+ const elementEntries = byKey[resolvedKey];
68
+ ignoreScroll = true;
69
+ (() => {
70
+ if (shouldScrollRestoration && elementEntries) {
71
+ for (const elementSelector in elementEntries) {
72
+ const entry = elementEntries[elementSelector];
73
+ if (elementSelector === "window") {
74
+ window.scrollTo({
75
+ top: entry.scrollY,
76
+ left: entry.scrollX,
77
+ behavior
78
+ });
79
+ } else if (elementSelector) {
80
+ const element = document.querySelector(elementSelector);
81
+ if (element) {
82
+ element.scrollLeft = entry.scrollX;
83
+ element.scrollTop = entry.scrollY;
84
+ }
85
+ }
86
+ }
87
+ return;
88
+ }
89
+ const hash = window.location.hash.split("#")[1];
90
+ if (hash) {
91
+ const hashScrollIntoViewOptions = (window.history.state || {}).__hashScrollIntoViewOptions ?? true;
92
+ if (hashScrollIntoViewOptions) {
93
+ const el = document.getElementById(hash);
94
+ if (el) {
95
+ el.scrollIntoView(hashScrollIntoViewOptions);
96
+ }
97
+ }
98
+ return;
99
+ }
100
+ [
101
+ "window",
102
+ ...(scrollToTopSelectors == null ? void 0 : scrollToTopSelectors.filter((d) => d !== "window")) ?? []
103
+ ].forEach((selector) => {
104
+ const element = selector === "window" ? window : typeof selector === "function" ? selector() : document.querySelector(selector);
105
+ if (element) {
106
+ element.scrollTo({
107
+ top: 0,
108
+ left: 0,
109
+ behavior
110
+ });
111
+ }
112
+ });
113
+ })();
114
+ ignoreScroll = false;
115
+ }
116
+ function setupScrollRestoration(router, force) {
117
+ if (scrollRestorationCache === void 0) {
118
+ return;
119
+ }
120
+ const shouldScrollRestoration = force ?? router.options.scrollRestoration ?? false;
121
+ if (shouldScrollRestoration) {
122
+ router.isScrollRestoring = true;
123
+ }
124
+ if (typeof document === "undefined" || router.isScrollRestorationSetup) {
125
+ return;
126
+ }
127
+ router.isScrollRestorationSetup = true;
128
+ ignoreScroll = false;
129
+ const getKey = router.options.getScrollRestorationKey || defaultGetScrollRestorationKey;
130
+ window.history.scrollRestoration = "manual";
131
+ const onScroll = (event) => {
132
+ if (ignoreScroll || !router.isScrollRestoring) {
133
+ return;
134
+ }
135
+ let elementSelector = "";
136
+ if (event.target === document || event.target === window) {
137
+ elementSelector = "window";
138
+ } else {
139
+ const attrId = event.target.getAttribute(
140
+ "data-scroll-restoration-id"
141
+ );
142
+ if (attrId) {
143
+ elementSelector = `[data-scroll-restoration-id="${attrId}"]`;
144
+ } else {
145
+ elementSelector = getCssSelector(event.target);
146
+ }
147
+ }
148
+ const restoreKey = getKey(router.state.location);
149
+ scrollRestorationCache.set((state) => {
150
+ const keyEntry = state[restoreKey] = state[restoreKey] || {};
151
+ const elementEntry = keyEntry[elementSelector] = keyEntry[elementSelector] || {};
152
+ if (elementSelector === "window") {
153
+ elementEntry.scrollX = window.scrollX || 0;
154
+ elementEntry.scrollY = window.scrollY || 0;
155
+ } else if (elementSelector) {
156
+ const element = document.querySelector(elementSelector);
157
+ if (element) {
158
+ elementEntry.scrollX = element.scrollLeft || 0;
159
+ elementEntry.scrollY = element.scrollTop || 0;
160
+ }
161
+ }
162
+ return state;
163
+ });
164
+ };
165
+ if (typeof document !== "undefined") {
166
+ document.addEventListener("scroll", throttle(onScroll, 100), true);
167
+ }
168
+ router.subscribe("onRendered", (event) => {
169
+ const cacheKey = getKey(event.toLocation);
170
+ if (!router.resetNextScroll) {
171
+ router.resetNextScroll = true;
172
+ return;
173
+ }
174
+ restoreScroll(
175
+ storageKey,
176
+ cacheKey,
177
+ router.options.scrollRestorationBehavior || void 0,
178
+ router.isScrollRestoring || void 0,
179
+ router.options.scrollToTopSelectors || void 0
180
+ );
181
+ if (router.isScrollRestoring) {
182
+ scrollRestorationCache.set((state) => {
183
+ state[cacheKey] = state[cacheKey] || {};
184
+ return state;
185
+ });
186
+ }
187
+ });
188
+ }
189
+ function handleHashScroll(router) {
190
+ if (typeof document !== "undefined" && document.querySelector) {
191
+ const hashScrollIntoViewOptions = router.state.location.state.__hashScrollIntoViewOptions ?? true;
192
+ if (hashScrollIntoViewOptions && router.state.location.hash !== "") {
193
+ const el = document.getElementById(router.state.location.hash);
194
+ if (el) {
195
+ el.scrollIntoView(hashScrollIntoViewOptions);
196
+ }
197
+ }
198
+ }
199
+ }
200
+ exports.defaultGetScrollRestorationKey = defaultGetScrollRestorationKey;
201
+ exports.getCssSelector = getCssSelector;
202
+ exports.handleHashScroll = handleHashScroll;
203
+ exports.restoreScroll = restoreScroll;
204
+ exports.scrollRestorationCache = scrollRestorationCache;
205
+ exports.setupScrollRestoration = setupScrollRestoration;
206
+ exports.storageKey = storageKey;
207
+ //# sourceMappingURL=scroll-restoration.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"scroll-restoration.cjs","sources":["../../src/scroll-restoration.ts"],"sourcesContent":["import { functionalUpdate } from './utils'\nimport type { AnyRouter } from './router'\nimport type { ParsedLocation } from './location'\nimport type { NonNullableUpdater } from './utils'\n\nexport type ScrollRestorationEntry = { scrollX: number; scrollY: number }\n\nexport type ScrollRestorationByElement = Record<string, ScrollRestorationEntry>\n\nexport type ScrollRestorationByKey = Record<string, ScrollRestorationByElement>\n\nexport type ScrollRestorationCache = {\n state: ScrollRestorationByKey\n set: (updater: NonNullableUpdater<ScrollRestorationByKey>) => void\n}\nexport type ScrollRestorationOptions = {\n getKey?: (location: ParsedLocation) => string\n scrollBehavior?: ScrollToOptions['behavior']\n}\n\nfunction getSafeSessionStorage() {\n try {\n if (\n typeof window !== 'undefined' &&\n typeof window.sessionStorage === 'object'\n ) {\n return window.sessionStorage\n }\n } catch {\n return undefined\n }\n return undefined\n}\n\nexport const storageKey = 'tsr-scroll-restoration-v1_3'\n\nconst throttle = (fn: (...args: Array<any>) => void, wait: number) => {\n let timeout: any\n return (...args: Array<any>) => {\n if (!timeout) {\n timeout = setTimeout(() => {\n fn(...args)\n timeout = null\n }, wait)\n }\n }\n}\n\nfunction createScrollRestorationCache(): ScrollRestorationCache | undefined {\n const safeSessionStorage = getSafeSessionStorage()\n if (!safeSessionStorage) {\n return undefined\n }\n\n const persistedState = safeSessionStorage.getItem(storageKey)\n let state: ScrollRestorationByKey = persistedState\n ? JSON.parse(persistedState)\n : {}\n\n return {\n state,\n // This setter is simply to make sure that we set the sessionStorage right\n // after the state is updated. It doesn't necessarily need to be a functional\n // update.\n set: (updater) => (\n (state = functionalUpdate(updater, state) || state),\n safeSessionStorage.setItem(storageKey, JSON.stringify(state))\n ),\n }\n}\n\nexport const scrollRestorationCache = createScrollRestorationCache()\n\n/**\n * The default `getKey` function for `useScrollRestoration`.\n * It returns the `key` from the location state or the `href` of the location.\n *\n * The `location.href` is used as a fallback to support the use case where the location state is not available like the initial render.\n */\n\nexport const defaultGetScrollRestorationKey = (location: ParsedLocation) => {\n return location.state.key! || location.href\n}\n\nexport function getCssSelector(el: any): string {\n const path = []\n let parent\n while ((parent = el.parentNode)) {\n path.unshift(\n `${el.tagName}:nth-child(${([].indexOf as any).call(parent.children, el) + 1})`,\n )\n el = parent\n }\n return `${path.join(' > ')}`.toLowerCase()\n}\n\nlet ignoreScroll = false\n\n// NOTE: This function must remain pure and not use any outside variables\n// unless they are passed in as arguments. Why? Because we need to be able to\n// toString() it into a script tag to execute as early as possible in the browser\n// during SSR. Additionally, we also call it from within the router lifecycle\nexport function restoreScroll(\n storageKey: string,\n key: string | undefined,\n behavior: ScrollToOptions['behavior'] | undefined,\n shouldScrollRestoration: boolean | undefined,\n scrollToTopSelectors:\n | Array<string | (() => Element | null | undefined)>\n | undefined,\n) {\n let byKey: ScrollRestorationByKey\n\n try {\n byKey = JSON.parse(sessionStorage.getItem(storageKey) || '{}')\n } catch (error: any) {\n console.error(error)\n return\n }\n\n const resolvedKey = key || window.history.state?.key\n const elementEntries = byKey[resolvedKey]\n\n //\n ignoreScroll = true\n\n //\n ;(() => {\n // If we have a cached entry for this location state,\n // we always need to prefer that over the hash scroll.\n if (shouldScrollRestoration && elementEntries) {\n for (const elementSelector in elementEntries) {\n const entry = elementEntries[elementSelector]!\n if (elementSelector === 'window') {\n window.scrollTo({\n top: entry.scrollY,\n left: entry.scrollX,\n behavior,\n })\n } else if (elementSelector) {\n const element = document.querySelector(elementSelector)\n if (element) {\n element.scrollLeft = entry.scrollX\n element.scrollTop = entry.scrollY\n }\n }\n }\n\n return\n }\n\n // If we don't have a cached entry for the hash,\n // Which means we've never seen this location before,\n // we need to check if there is a hash in the URL.\n // If there is, we need to scroll it's ID into view.\n const hash = window.location.hash.split('#')[1]\n\n if (hash) {\n const hashScrollIntoViewOptions =\n (window.history.state || {}).__hashScrollIntoViewOptions ?? true\n\n if (hashScrollIntoViewOptions) {\n const el = document.getElementById(hash)\n if (el) {\n el.scrollIntoView(hashScrollIntoViewOptions)\n }\n }\n\n return\n }\n\n // If there is no cached entry for the hash and there is no hash in the URL,\n // we need to scroll to the top of the page for every scrollToTop element\n ;[\n 'window',\n ...(scrollToTopSelectors?.filter((d) => d !== 'window') ?? []),\n ].forEach((selector) => {\n const element =\n selector === 'window'\n ? window\n : typeof selector === 'function'\n ? selector()\n : document.querySelector(selector)\n if (element) {\n element.scrollTo({\n top: 0,\n left: 0,\n behavior,\n })\n }\n })\n })()\n\n //\n ignoreScroll = false\n}\n\nexport function setupScrollRestoration(router: AnyRouter, force?: boolean) {\n if (scrollRestorationCache === undefined) {\n return\n }\n const shouldScrollRestoration =\n force ?? router.options.scrollRestoration ?? false\n\n if (shouldScrollRestoration) {\n router.isScrollRestoring = true\n }\n\n if (typeof document === 'undefined' || router.isScrollRestorationSetup) {\n return\n }\n\n router.isScrollRestorationSetup = true\n\n //\n ignoreScroll = false\n\n const getKey =\n router.options.getScrollRestorationKey || defaultGetScrollRestorationKey\n\n window.history.scrollRestoration = 'manual'\n\n // // Create a MutationObserver to monitor DOM changes\n // const mutationObserver = new MutationObserver(() => {\n // ;ignoreScroll = true\n // requestAnimationFrame(() => {\n // ;ignoreScroll = false\n\n // // Attempt to restore scroll position on each dom\n // // mutation until the user scrolls. We do this\n // // because dynamic content may come in at different\n // // ticks after the initial render and we want to\n // // keep up with that content as much as possible.\n // // As soon as the user scrolls, we no longer need\n // // to attempt router.\n // // console.log('mutation observer restoreScroll')\n // restoreScroll(\n // storageKey,\n // getKey(router.state.location),\n // router.options.scrollRestorationBehavior,\n // )\n // })\n // })\n\n // const observeDom = () => {\n // // Observe changes to the entire document\n // mutationObserver.observe(document, {\n // childList: true, // Detect added or removed child nodes\n // subtree: true, // Monitor all descendants\n // characterData: true, // Detect text content changes\n // })\n // }\n\n // const unobserveDom = () => {\n // mutationObserver.disconnect()\n // }\n\n // observeDom()\n\n const onScroll = (event: Event) => {\n // unobserveDom()\n\n if (ignoreScroll || !router.isScrollRestoring) {\n return\n }\n\n let elementSelector = ''\n\n if (event.target === document || event.target === window) {\n elementSelector = 'window'\n } else {\n const attrId = (event.target as Element).getAttribute(\n 'data-scroll-restoration-id',\n )\n\n if (attrId) {\n elementSelector = `[data-scroll-restoration-id=\"${attrId}\"]`\n } else {\n elementSelector = getCssSelector(event.target)\n }\n }\n\n const restoreKey = getKey(router.state.location)\n\n scrollRestorationCache.set((state) => {\n const keyEntry = (state[restoreKey] =\n state[restoreKey] || ({} as ScrollRestorationByElement))\n\n const elementEntry = (keyEntry[elementSelector] =\n keyEntry[elementSelector] || ({} as ScrollRestorationEntry))\n\n if (elementSelector === 'window') {\n elementEntry.scrollX = window.scrollX || 0\n elementEntry.scrollY = window.scrollY || 0\n } else if (elementSelector) {\n const element = document.querySelector(elementSelector)\n if (element) {\n elementEntry.scrollX = element.scrollLeft || 0\n elementEntry.scrollY = element.scrollTop || 0\n }\n }\n\n return state\n })\n }\n\n // Throttle the scroll event to avoid excessive updates\n if (typeof document !== 'undefined') {\n document.addEventListener('scroll', throttle(onScroll, 100), true)\n }\n\n router.subscribe('onRendered', (event) => {\n // unobserveDom()\n\n const cacheKey = getKey(event.toLocation)\n\n // If the user doesn't want to restore the scroll position,\n // we don't need to do anything.\n if (!router.resetNextScroll) {\n router.resetNextScroll = true\n return\n }\n\n restoreScroll(\n storageKey,\n cacheKey,\n router.options.scrollRestorationBehavior || undefined,\n router.isScrollRestoring || undefined,\n router.options.scrollToTopSelectors || undefined,\n )\n\n if (router.isScrollRestoring) {\n // Mark the location as having been seen\n scrollRestorationCache.set((state) => {\n state[cacheKey] = state[cacheKey] || ({} as ScrollRestorationByElement)\n\n return state\n })\n }\n })\n}\n\n/**\n * @internal\n * Handles hash-based scrolling after navigation completes.\n * To be used in framework-specific <Transitioner> components during the onResolved event.\n *\n * Provides hash scrolling for programmatic navigation when default browser handling is prevented.\n * @param router The router instance containing current location and state\n */\nexport function handleHashScroll(router: AnyRouter) {\n if (typeof document !== 'undefined' && (document as any).querySelector) {\n const hashScrollIntoViewOptions =\n router.state.location.state.__hashScrollIntoViewOptions ?? true\n\n if (hashScrollIntoViewOptions && router.state.location.hash !== '') {\n const el = document.getElementById(router.state.location.hash)\n if (el) {\n el.scrollIntoView(hashScrollIntoViewOptions)\n }\n }\n }\n}\n"],"names":["functionalUpdate","storageKey"],"mappings":";;;AAoBA,SAAS,wBAAwB;AAC3B,MAAA;AACF,QACE,OAAO,WAAW,eAClB,OAAO,OAAO,mBAAmB,UACjC;AACA,aAAO,OAAO;AAAA,IAAA;AAAA,EAChB,QACM;AACC,WAAA;AAAA,EAAA;AAEF,SAAA;AACT;AAEO,MAAM,aAAa;AAE1B,MAAM,WAAW,CAAC,IAAmC,SAAiB;AAChE,MAAA;AACJ,SAAO,IAAI,SAAqB;AAC9B,QAAI,CAAC,SAAS;AACZ,gBAAU,WAAW,MAAM;AACzB,WAAG,GAAG,IAAI;AACA,kBAAA;AAAA,SACT,IAAI;AAAA,IAAA;AAAA,EAEX;AACF;AAEA,SAAS,+BAAmE;AAC1E,QAAM,qBAAqB,sBAAsB;AACjD,MAAI,CAAC,oBAAoB;AAChB,WAAA;AAAA,EAAA;AAGH,QAAA,iBAAiB,mBAAmB,QAAQ,UAAU;AAC5D,MAAI,QAAgC,iBAChC,KAAK,MAAM,cAAc,IACzB,CAAC;AAEE,SAAA;AAAA,IACL;AAAA;AAAA;AAAA;AAAA,IAIA,KAAK,CAAC,aACH,QAAQA,MAAAA,iBAAiB,SAAS,KAAK,KAAK,OAC7C,mBAAmB,QAAQ,YAAY,KAAK,UAAU,KAAK,CAAC;AAAA,EAEhE;AACF;AAEO,MAAM,yBAAyB,6BAA6B;AAStD,MAAA,iCAAiC,CAAC,aAA6B;AACnE,SAAA,SAAS,MAAM,OAAQ,SAAS;AACzC;AAEO,SAAS,eAAe,IAAiB;AAC9C,QAAM,OAAO,CAAC;AACV,MAAA;AACI,SAAA,SAAS,GAAG,YAAa;AAC1B,SAAA;AAAA,MACH,GAAG,GAAG,OAAO,cAAe,CAAA,EAAG,QAAgB,KAAK,OAAO,UAAU,EAAE,IAAI,CAAC;AAAA,IAC9E;AACK,SAAA;AAAA,EAAA;AAEP,SAAO,GAAG,KAAK,KAAK,KAAK,CAAC,GAAG,YAAY;AAC3C;AAEA,IAAI,eAAe;AAMZ,SAAS,cACdC,aACA,KACA,UACA,yBACA,sBAGA;;AACI,MAAA;AAEA,MAAA;AACF,YAAQ,KAAK,MAAM,eAAe,QAAQA,WAAU,KAAK,IAAI;AAAA,WACtD,OAAY;AACnB,YAAQ,MAAM,KAAK;AACnB;AAAA,EAAA;AAGF,QAAM,cAAc,SAAO,YAAO,QAAQ,UAAf,mBAAsB;AAC3C,QAAA,iBAAiB,MAAM,WAAW;AAGzB,iBAAA;AAGd,GAAC,MAAM;AAGN,QAAI,2BAA2B,gBAAgB;AAC7C,iBAAW,mBAAmB,gBAAgB;AACtC,cAAA,QAAQ,eAAe,eAAe;AAC5C,YAAI,oBAAoB,UAAU;AAChC,iBAAO,SAAS;AAAA,YACd,KAAK,MAAM;AAAA,YACX,MAAM,MAAM;AAAA,YACZ;AAAA,UAAA,CACD;AAAA,mBACQ,iBAAiB;AACpB,gBAAA,UAAU,SAAS,cAAc,eAAe;AACtD,cAAI,SAAS;AACX,oBAAQ,aAAa,MAAM;AAC3B,oBAAQ,YAAY,MAAM;AAAA,UAAA;AAAA,QAC5B;AAAA,MACF;AAGF;AAAA,IAAA;AAOF,UAAM,OAAO,OAAO,SAAS,KAAK,MAAM,GAAG,EAAE,CAAC;AAE9C,QAAI,MAAM;AACR,YAAM,6BACH,OAAO,QAAQ,SAAS,CAAA,GAAI,+BAA+B;AAE9D,UAAI,2BAA2B;AACvB,cAAA,KAAK,SAAS,eAAe,IAAI;AACvC,YAAI,IAAI;AACN,aAAG,eAAe,yBAAyB;AAAA,QAAA;AAAA,MAC7C;AAGF;AAAA,IAAA;AAKD;AAAA,MACC;AAAA,MACA,IAAI,6DAAsB,OAAO,CAAC,MAAM,MAAM,cAAa,CAAA;AAAA,IAAC,EAC5D,QAAQ,CAAC,aAAa;AAChB,YAAA,UACJ,aAAa,WACT,SACA,OAAO,aAAa,aAClB,SAAS,IACT,SAAS,cAAc,QAAQ;AACvC,UAAI,SAAS;AACX,gBAAQ,SAAS;AAAA,UACf,KAAK;AAAA,UACL,MAAM;AAAA,UACN;AAAA,QAAA,CACD;AAAA,MAAA;AAAA,IACH,CACD;AAAA,EAAA,GACA;AAGY,iBAAA;AACjB;AAEgB,SAAA,uBAAuB,QAAmB,OAAiB;AACzE,MAAI,2BAA2B,QAAW;AACxC;AAAA,EAAA;AAEF,QAAM,0BACJ,SAAS,OAAO,QAAQ,qBAAqB;AAE/C,MAAI,yBAAyB;AAC3B,WAAO,oBAAoB;AAAA,EAAA;AAG7B,MAAI,OAAO,aAAa,eAAe,OAAO,0BAA0B;AACtE;AAAA,EAAA;AAGF,SAAO,2BAA2B;AAGnB,iBAAA;AAET,QAAA,SACJ,OAAO,QAAQ,2BAA2B;AAE5C,SAAO,QAAQ,oBAAoB;AAuC7B,QAAA,WAAW,CAAC,UAAiB;AAG7B,QAAA,gBAAgB,CAAC,OAAO,mBAAmB;AAC7C;AAAA,IAAA;AAGF,QAAI,kBAAkB;AAEtB,QAAI,MAAM,WAAW,YAAY,MAAM,WAAW,QAAQ;AACtC,wBAAA;AAAA,IAAA,OACb;AACC,YAAA,SAAU,MAAM,OAAmB;AAAA,QACvC;AAAA,MACF;AAEA,UAAI,QAAQ;AACV,0BAAkB,gCAAgC,MAAM;AAAA,MAAA,OACnD;AACa,0BAAA,eAAe,MAAM,MAAM;AAAA,MAAA;AAAA,IAC/C;AAGF,UAAM,aAAa,OAAO,OAAO,MAAM,QAAQ;AAExB,2BAAA,IAAI,CAAC,UAAU;AACpC,YAAM,WAAY,MAAM,UAAU,IAChC,MAAM,UAAU,KAAM,CAAC;AAEzB,YAAM,eAAgB,SAAS,eAAe,IAC5C,SAAS,eAAe,KAAM,CAAC;AAEjC,UAAI,oBAAoB,UAAU;AACnB,qBAAA,UAAU,OAAO,WAAW;AAC5B,qBAAA,UAAU,OAAO,WAAW;AAAA,iBAChC,iBAAiB;AACpB,cAAA,UAAU,SAAS,cAAc,eAAe;AACtD,YAAI,SAAS;AACE,uBAAA,UAAU,QAAQ,cAAc;AAChC,uBAAA,UAAU,QAAQ,aAAa;AAAA,QAAA;AAAA,MAC9C;AAGK,aAAA;AAAA,IAAA,CACR;AAAA,EACH;AAGI,MAAA,OAAO,aAAa,aAAa;AACnC,aAAS,iBAAiB,UAAU,SAAS,UAAU,GAAG,GAAG,IAAI;AAAA,EAAA;AAG5D,SAAA,UAAU,cAAc,CAAC,UAAU;AAGlC,UAAA,WAAW,OAAO,MAAM,UAAU;AAIpC,QAAA,CAAC,OAAO,iBAAiB;AAC3B,aAAO,kBAAkB;AACzB;AAAA,IAAA;AAGF;AAAA,MACE;AAAA,MACA;AAAA,MACA,OAAO,QAAQ,6BAA6B;AAAA,MAC5C,OAAO,qBAAqB;AAAA,MAC5B,OAAO,QAAQ,wBAAwB;AAAA,IACzC;AAEA,QAAI,OAAO,mBAAmB;AAEL,6BAAA,IAAI,CAAC,UAAU;AACpC,cAAM,QAAQ,IAAI,MAAM,QAAQ,KAAM,CAAC;AAEhC,eAAA;AAAA,MAAA,CACR;AAAA,IAAA;AAAA,EACH,CACD;AACH;AAUO,SAAS,iBAAiB,QAAmB;AAClD,MAAI,OAAO,aAAa,eAAgB,SAAiB,eAAe;AACtE,UAAM,4BACJ,OAAO,MAAM,SAAS,MAAM,+BAA+B;AAE7D,QAAI,6BAA6B,OAAO,MAAM,SAAS,SAAS,IAAI;AAClE,YAAM,KAAK,SAAS,eAAe,OAAO,MAAM,SAAS,IAAI;AAC7D,UAAI,IAAI;AACN,WAAG,eAAe,yBAAyB;AAAA,MAAA;AAAA,IAC7C;AAAA,EACF;AAEJ;;;;;;;;"}
@@ -0,0 +1,38 @@
1
+ import { AnyRouter } from './router.cjs';
2
+ import { ParsedLocation } from './location.cjs';
3
+ import { NonNullableUpdater } from './utils.cjs';
4
+ export type ScrollRestorationEntry = {
5
+ scrollX: number;
6
+ scrollY: number;
7
+ };
8
+ export type ScrollRestorationByElement = Record<string, ScrollRestorationEntry>;
9
+ export type ScrollRestorationByKey = Record<string, ScrollRestorationByElement>;
10
+ export type ScrollRestorationCache = {
11
+ state: ScrollRestorationByKey;
12
+ set: (updater: NonNullableUpdater<ScrollRestorationByKey>) => void;
13
+ };
14
+ export type ScrollRestorationOptions = {
15
+ getKey?: (location: ParsedLocation) => string;
16
+ scrollBehavior?: ScrollToOptions['behavior'];
17
+ };
18
+ export declare const storageKey = "tsr-scroll-restoration-v1_3";
19
+ export declare const scrollRestorationCache: ScrollRestorationCache | undefined;
20
+ /**
21
+ * The default `getKey` function for `useScrollRestoration`.
22
+ * It returns the `key` from the location state or the `href` of the location.
23
+ *
24
+ * The `location.href` is used as a fallback to support the use case where the location state is not available like the initial render.
25
+ */
26
+ export declare const defaultGetScrollRestorationKey: (location: ParsedLocation) => string;
27
+ export declare function getCssSelector(el: any): string;
28
+ export declare function restoreScroll(storageKey: string, key: string | undefined, behavior: ScrollToOptions['behavior'] | undefined, shouldScrollRestoration: boolean | undefined, scrollToTopSelectors: Array<string | (() => Element | null | undefined)> | undefined): void;
29
+ export declare function setupScrollRestoration(router: AnyRouter, force?: boolean): void;
30
+ /**
31
+ * @internal
32
+ * Handles hash-based scrolling after navigation completes.
33
+ * To be used in framework-specific <Transitioner> components during the onResolved event.
34
+ *
35
+ * Provides hash scrolling for programmatic navigation when default browser handling is prevented.
36
+ * @param router The router instance containing current location and state
37
+ */
38
+ export declare function handleHashScroll(router: AnyRouter): void;
@@ -0,0 +1,42 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
+ const utils = require("./utils.cjs");
4
+ function retainSearchParams(keys) {
5
+ return ({ search, next }) => {
6
+ const result = next(search);
7
+ if (keys === true) {
8
+ return { ...search, ...result };
9
+ }
10
+ keys.forEach((key) => {
11
+ if (!(key in result)) {
12
+ result[key] = search[key];
13
+ }
14
+ });
15
+ return result;
16
+ };
17
+ }
18
+ function stripSearchParams(input) {
19
+ return ({ search, next }) => {
20
+ if (input === true) {
21
+ return {};
22
+ }
23
+ const result = next(search);
24
+ if (Array.isArray(input)) {
25
+ input.forEach((key) => {
26
+ delete result[key];
27
+ });
28
+ } else {
29
+ Object.entries(input).forEach(
30
+ ([key, value]) => {
31
+ if (utils.deepEqual(result[key], value)) {
32
+ delete result[key];
33
+ }
34
+ }
35
+ );
36
+ }
37
+ return result;
38
+ };
39
+ }
40
+ exports.retainSearchParams = retainSearchParams;
41
+ exports.stripSearchParams = stripSearchParams;
42
+ //# sourceMappingURL=searchMiddleware.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"searchMiddleware.cjs","sources":["../../src/searchMiddleware.ts"],"sourcesContent":["import { deepEqual } from './utils'\nimport type { NoInfer, PickOptional } from './utils'\nimport type { SearchMiddleware } from './route'\nimport type { IsRequiredParams } from './link'\n\nexport function retainSearchParams<TSearchSchema extends object>(\n keys: Array<keyof TSearchSchema> | true,\n): SearchMiddleware<TSearchSchema> {\n return ({ search, next }) => {\n const result = next(search)\n if (keys === true) {\n return { ...search, ...result }\n }\n // add missing keys from search to result\n keys.forEach((key) => {\n if (!(key in result)) {\n result[key] = search[key]\n }\n })\n return result\n }\n}\n\nexport function stripSearchParams<\n TSearchSchema,\n TOptionalProps = PickOptional<NoInfer<TSearchSchema>>,\n const TValues =\n | Partial<NoInfer<TOptionalProps>>\n | Array<keyof TOptionalProps>,\n const TInput = IsRequiredParams<TSearchSchema> extends never\n ? TValues | true\n : TValues,\n>(input: NoInfer<TInput>): SearchMiddleware<TSearchSchema> {\n return ({ search, next }) => {\n if (input === true) {\n return {}\n }\n const result = next(search) as Record<string, unknown>\n if (Array.isArray(input)) {\n input.forEach((key) => {\n delete result[key]\n })\n } else {\n Object.entries(input as Record<string, unknown>).forEach(\n ([key, value]) => {\n if (deepEqual(result[key], value)) {\n delete result[key]\n }\n },\n )\n }\n return result as any\n }\n}\n"],"names":["deepEqual"],"mappings":";;;AAKO,SAAS,mBACd,MACiC;AACjC,SAAO,CAAC,EAAE,QAAQ,WAAW;AACrB,UAAA,SAAS,KAAK,MAAM;AAC1B,QAAI,SAAS,MAAM;AACjB,aAAO,EAAE,GAAG,QAAQ,GAAG,OAAO;AAAA,IAAA;AAG3B,SAAA,QAAQ,CAAC,QAAQ;AAChB,UAAA,EAAE,OAAO,SAAS;AACb,eAAA,GAAG,IAAI,OAAO,GAAG;AAAA,MAAA;AAAA,IAC1B,CACD;AACM,WAAA;AAAA,EACT;AACF;AAEO,SAAS,kBASd,OAAyD;AACzD,SAAO,CAAC,EAAE,QAAQ,WAAW;AAC3B,QAAI,UAAU,MAAM;AAClB,aAAO,CAAC;AAAA,IAAA;AAEJ,UAAA,SAAS,KAAK,MAAM;AACtB,QAAA,MAAM,QAAQ,KAAK,GAAG;AAClB,YAAA,QAAQ,CAAC,QAAQ;AACrB,eAAO,OAAO,GAAG;AAAA,MAAA,CAClB;AAAA,IAAA,OACI;AACE,aAAA,QAAQ,KAAgC,EAAE;AAAA,QAC/C,CAAC,CAAC,KAAK,KAAK,MAAM;AAChB,cAAIA,MAAU,UAAA,OAAO,GAAG,GAAG,KAAK,GAAG;AACjC,mBAAO,OAAO,GAAG;AAAA,UAAA;AAAA,QACnB;AAAA,MAEJ;AAAA,IAAA;AAEK,WAAA;AAAA,EACT;AACF;;;"}
@@ -0,0 +1,5 @@
1
+ import { NoInfer, PickOptional } from './utils.cjs';
2
+ import { SearchMiddleware } from './route.cjs';
3
+ import { IsRequiredParams } from './link.cjs';
4
+ export declare function retainSearchParams<TSearchSchema extends object>(keys: Array<keyof TSearchSchema> | true): SearchMiddleware<TSearchSchema>;
5
+ export declare function stripSearchParams<TSearchSchema, TOptionalProps = PickOptional<NoInfer<TSearchSchema>>, const TValues = Partial<NoInfer<TOptionalProps>> | Array<keyof TOptionalProps>, const TInput = IsRequiredParams<TSearchSchema> extends never ? TValues | true : TValues>(input: NoInfer<TInput>): SearchMiddleware<TSearchSchema>;
@@ -0,0 +1,61 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
+ const qss = require("./qss.cjs");
4
+ const defaultParseSearch = parseSearchWith(JSON.parse);
5
+ const defaultStringifySearch = stringifySearchWith(
6
+ JSON.stringify,
7
+ JSON.parse
8
+ );
9
+ function parseSearchWith(parser) {
10
+ return (searchStr) => {
11
+ if (searchStr.substring(0, 1) === "?") {
12
+ searchStr = searchStr.substring(1);
13
+ }
14
+ const query = qss.decode(searchStr);
15
+ for (const key in query) {
16
+ const value = query[key];
17
+ if (typeof value === "string") {
18
+ try {
19
+ query[key] = parser(value);
20
+ } catch (err) {
21
+ }
22
+ }
23
+ }
24
+ return query;
25
+ };
26
+ }
27
+ function stringifySearchWith(stringify, parser) {
28
+ function stringifyValue(val) {
29
+ if (typeof val === "object" && val !== null) {
30
+ try {
31
+ return stringify(val);
32
+ } catch (err) {
33
+ }
34
+ } else if (typeof val === "string" && typeof parser === "function") {
35
+ try {
36
+ parser(val);
37
+ return stringify(val);
38
+ } catch (err) {
39
+ }
40
+ }
41
+ return val;
42
+ }
43
+ return (search) => {
44
+ search = { ...search };
45
+ Object.keys(search).forEach((key) => {
46
+ const val = search[key];
47
+ if (typeof val === "undefined" || val === void 0) {
48
+ delete search[key];
49
+ } else {
50
+ search[key] = stringifyValue(val);
51
+ }
52
+ });
53
+ const searchStr = qss.encode(search).toString();
54
+ return searchStr ? `?${searchStr}` : "";
55
+ };
56
+ }
57
+ exports.defaultParseSearch = defaultParseSearch;
58
+ exports.defaultStringifySearch = defaultStringifySearch;
59
+ exports.parseSearchWith = parseSearchWith;
60
+ exports.stringifySearchWith = stringifySearchWith;
61
+ //# sourceMappingURL=searchParams.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"searchParams.cjs","sources":["../../src/searchParams.ts"],"sourcesContent":["import { decode, encode } from './qss'\nimport type { AnySchema } from './validators'\n\nexport const defaultParseSearch = parseSearchWith(JSON.parse)\nexport const defaultStringifySearch = stringifySearchWith(\n JSON.stringify,\n JSON.parse,\n)\n\nexport function parseSearchWith(parser: (str: string) => any) {\n return (searchStr: string): AnySchema => {\n if (searchStr.substring(0, 1) === '?') {\n searchStr = searchStr.substring(1)\n }\n\n const query: Record<string, unknown> = decode(searchStr)\n\n // Try to parse any query params that might be json\n for (const key in query) {\n const value = query[key]\n if (typeof value === 'string') {\n try {\n query[key] = parser(value)\n } catch (err) {\n //\n }\n }\n }\n\n return query\n }\n}\n\nexport function stringifySearchWith(\n stringify: (search: any) => string,\n parser?: (str: string) => any,\n) {\n function stringifyValue(val: any) {\n if (typeof val === 'object' && val !== null) {\n try {\n return stringify(val)\n } catch (err) {\n // silent\n }\n } else if (typeof val === 'string' && typeof parser === 'function') {\n try {\n // Check if it's a valid parseable string.\n // If it is, then stringify it again.\n parser(val)\n return stringify(val)\n } catch (err) {\n // silent\n }\n }\n return val\n }\n\n return (search: Record<string, any>) => {\n search = { ...search }\n\n Object.keys(search).forEach((key) => {\n const val = search[key]\n if (typeof val === 'undefined' || val === undefined) {\n delete search[key]\n } else {\n search[key] = stringifyValue(val)\n }\n })\n\n const searchStr = encode(search as Record<string, string>).toString()\n\n return searchStr ? `?${searchStr}` : ''\n }\n}\n\nexport type SearchSerializer = (searchObj: Record<string, any>) => string\nexport type SearchParser = (searchStr: string) => Record<string, any>\n"],"names":["decode","encode"],"mappings":";;;AAGa,MAAA,qBAAqB,gBAAgB,KAAK,KAAK;AACrD,MAAM,yBAAyB;AAAA,EACpC,KAAK;AAAA,EACL,KAAK;AACP;AAEO,SAAS,gBAAgB,QAA8B;AAC5D,SAAO,CAAC,cAAiC;AACvC,QAAI,UAAU,UAAU,GAAG,CAAC,MAAM,KAAK;AACzB,kBAAA,UAAU,UAAU,CAAC;AAAA,IAAA;AAG7B,UAAA,QAAiCA,WAAO,SAAS;AAGvD,eAAW,OAAO,OAAO;AACjB,YAAA,QAAQ,MAAM,GAAG;AACnB,UAAA,OAAO,UAAU,UAAU;AACzB,YAAA;AACI,gBAAA,GAAG,IAAI,OAAO,KAAK;AAAA,iBAClB,KAAK;AAAA,QAAA;AAAA,MAEd;AAAA,IACF;AAGK,WAAA;AAAA,EACT;AACF;AAEgB,SAAA,oBACd,WACA,QACA;AACA,WAAS,eAAe,KAAU;AAChC,QAAI,OAAO,QAAQ,YAAY,QAAQ,MAAM;AACvC,UAAA;AACF,eAAO,UAAU,GAAG;AAAA,eACb,KAAK;AAAA,MAAA;AAAA,eAGL,OAAO,QAAQ,YAAY,OAAO,WAAW,YAAY;AAC9D,UAAA;AAGF,eAAO,GAAG;AACV,eAAO,UAAU,GAAG;AAAA,eACb,KAAK;AAAA,MAAA;AAAA,IAEd;AAEK,WAAA;AAAA,EAAA;AAGT,SAAO,CAAC,WAAgC;AAC7B,aAAA,EAAE,GAAG,OAAO;AAErB,WAAO,KAAK,MAAM,EAAE,QAAQ,CAAC,QAAQ;AAC7B,YAAA,MAAM,OAAO,GAAG;AACtB,UAAI,OAAO,QAAQ,eAAe,QAAQ,QAAW;AACnD,eAAO,OAAO,GAAG;AAAA,MAAA,OACZ;AACE,eAAA,GAAG,IAAI,eAAe,GAAG;AAAA,MAAA;AAAA,IAClC,CACD;AAED,UAAM,YAAYC,IAAAA,OAAO,MAAgC,EAAE,SAAS;AAE7D,WAAA,YAAY,IAAI,SAAS,KAAK;AAAA,EACvC;AACF;;;;;"}
@@ -0,0 +1,7 @@
1
+ import { AnySchema } from './validators.cjs';
2
+ export declare const defaultParseSearch: (searchStr: string) => AnySchema;
3
+ export declare const defaultStringifySearch: (search: Record<string, any>) => string;
4
+ export declare function parseSearchWith(parser: (str: string) => any): (searchStr: string) => AnySchema;
5
+ export declare function stringifySearchWith(stringify: (search: any) => string, parser?: (str: string) => any): (search: Record<string, any>) => string;
6
+ export type SearchSerializer = (searchObj: Record<string, any>) => string;
7
+ export type SearchParser = (searchStr: string) => Record<string, any>;
@@ -0,0 +1,22 @@
1
+ export interface StartSerializer {
2
+ stringify: (obj: unknown) => string;
3
+ parse: (str: string) => unknown;
4
+ encode: <T>(value: T) => T;
5
+ decode: <T>(value: T) => T;
6
+ }
7
+ export type SerializerStringifyBy<T, TSerializable> = T extends TSerializable ? T : T extends (...args: Array<any>) => any ? 'Function is not serializable' : {
8
+ [K in keyof T]: SerializerStringifyBy<T[K], TSerializable>;
9
+ };
10
+ export type SerializerParseBy<T, TSerializable> = T extends TSerializable ? T : unknown extends SerializerExtensions['ReadableStream'] ? {
11
+ [K in keyof T]: SerializerParseBy<T[K], TSerializable>;
12
+ } : T extends SerializerExtensions['ReadableStream'] ? ReadableStream : {
13
+ [K in keyof T]: SerializerParseBy<T[K], TSerializable>;
14
+ };
15
+ export interface DefaultSerializerExtensions {
16
+ ReadableStream: unknown;
17
+ }
18
+ export interface SerializerExtensions extends DefaultSerializerExtensions {
19
+ }
20
+ export type Serializable = Date | undefined | Error | FormData | bigint;
21
+ export type SerializerStringify<T> = SerializerStringifyBy<T, Serializable>;
22
+ export type SerializerParse<T> = SerializerParseBy<T, Serializable>;
@@ -0,0 +1,4 @@
1
+ import { Constrain } from './utils.cjs';
2
+ export interface OptionalStructuralSharing<TStructuralSharing, TConstraint> {
3
+ readonly structuralSharing?: Constrain<TStructuralSharing, TConstraint> | undefined;
4
+ }
@@ -0,0 +1,65 @@
1
+ import { FromPathOption, NavigateOptions, PathParamOptions, SearchParamOptions, ToPathOption } from './link.cjs';
2
+ import { RedirectOptions } from './redirect.cjs';
3
+ import { RouteIds } from './routeInfo.cjs';
4
+ import { AnyRouter, RegisteredRouter } from './router.cjs';
5
+ import { UseParamsResult } from './useParams.cjs';
6
+ import { UseSearchResult } from './useSearch.cjs';
7
+ import { Constrain, ConstrainLiteral } from './utils.cjs';
8
+ export type ValidateFromPath<TRouter extends AnyRouter = RegisteredRouter, TFrom = string> = FromPathOption<TRouter, TFrom>;
9
+ export type ValidateToPath<TRouter extends AnyRouter = RegisteredRouter, TTo extends string | undefined = undefined, TFrom extends string = string> = ToPathOption<TRouter, TFrom, TTo>;
10
+ export type ValidateSearch<TRouter extends AnyRouter = RegisteredRouter, TTo extends string | undefined = undefined, TFrom extends string = string> = SearchParamOptions<TRouter, TFrom, TTo>;
11
+ export type ValidateParams<TRouter extends AnyRouter = RegisteredRouter, TTo extends string | undefined = undefined, TFrom extends string = string> = PathParamOptions<TRouter, TFrom, TTo>;
12
+ /**
13
+ * @internal
14
+ */
15
+ export type InferFrom<TOptions, TDefaultFrom extends string = string> = TOptions extends {
16
+ from: infer TFrom extends string;
17
+ } ? TFrom : TDefaultFrom;
18
+ /**
19
+ * @internal
20
+ */
21
+ export type InferTo<TOptions> = TOptions extends {
22
+ to: infer TTo extends string;
23
+ } ? TTo : undefined;
24
+ /**
25
+ * @internal
26
+ */
27
+ export type InferMaskTo<TOptions> = TOptions extends {
28
+ mask: {
29
+ to: infer TTo extends string;
30
+ };
31
+ } ? TTo : '';
32
+ export type InferMaskFrom<TOptions> = TOptions extends {
33
+ mask: {
34
+ from: infer TFrom extends string;
35
+ };
36
+ } ? TFrom : string;
37
+ export type ValidateNavigateOptions<TRouter extends AnyRouter = RegisteredRouter, TOptions = unknown, TDefaultFrom extends string = string> = Constrain<TOptions, NavigateOptions<TRouter, InferFrom<TOptions, TDefaultFrom>, InferTo<TOptions>, InferMaskFrom<TOptions>, InferMaskTo<TOptions>>>;
38
+ export type ValidateNavigateOptionsArray<TRouter extends AnyRouter = RegisteredRouter, TOptions extends ReadonlyArray<any> = ReadonlyArray<unknown>, TDefaultFrom extends string = string> = {
39
+ [K in keyof TOptions]: ValidateNavigateOptions<TRouter, TOptions[K], TDefaultFrom>;
40
+ };
41
+ export type ValidateRedirectOptions<TRouter extends AnyRouter = RegisteredRouter, TOptions = unknown, TDefaultFrom extends string = string> = Constrain<TOptions, RedirectOptions<TRouter, InferFrom<TOptions, TDefaultFrom>, InferTo<TOptions>, InferMaskFrom<TOptions>, InferMaskTo<TOptions>>>;
42
+ export type ValidateRedirectOptionsArray<TRouter extends AnyRouter = RegisteredRouter, TOptions extends ReadonlyArray<any> = ReadonlyArray<unknown>, TDefaultFrom extends string = string> = {
43
+ [K in keyof TOptions]: ValidateRedirectOptions<TRouter, TOptions[K], TDefaultFrom>;
44
+ };
45
+ export type ValidateId<TRouter extends AnyRouter = RegisteredRouter, TId extends string = string> = ConstrainLiteral<TId, RouteIds<TRouter['routeTree']>>;
46
+ /**
47
+ * @internal
48
+ */
49
+ export type InferStrict<TOptions> = TOptions extends {
50
+ strict: infer TStrict extends boolean;
51
+ } ? TStrict : true;
52
+ /**
53
+ * @internal
54
+ */
55
+ export type InferShouldThrow<TOptions> = TOptions extends {
56
+ shouldThrow: infer TShouldThrow extends boolean;
57
+ } ? TShouldThrow : true;
58
+ /**
59
+ * @internal
60
+ */
61
+ export type InferSelected<TOptions> = TOptions extends {
62
+ select: (...args: Array<any>) => infer TSelected;
63
+ } ? TSelected : unknown;
64
+ export type ValidateUseSearchResult<TOptions, TRouter extends AnyRouter = RegisteredRouter> = UseSearchResult<TRouter, InferFrom<TOptions>, InferStrict<TOptions>, InferSelected<TOptions>>;
65
+ export type ValidateUseParamsResult<TOptions, TRouter extends AnyRouter = RegisteredRouter> = Constrain<TOptions, UseParamsResult<TRouter, InferFrom<TOptions>, InferStrict<TOptions>, InferSelected<TOptions>>>;
@@ -0,0 +1,5 @@
1
+ import { AllLoaderData, RouteById } from './routeInfo.cjs';
2
+ import { AnyRouter } from './router.cjs';
3
+ import { Expand } from './utils.cjs';
4
+ export type ResolveUseLoaderData<TRouter extends AnyRouter, TFrom, TStrict extends boolean> = TStrict extends false ? AllLoaderData<TRouter['routeTree']> : Expand<RouteById<TRouter['routeTree'], TFrom>['types']['loaderData']>;
5
+ export type UseLoaderDataResult<TRouter extends AnyRouter, TFrom, TStrict extends boolean, TSelected> = unknown extends TSelected ? ResolveUseLoaderData<TRouter, TFrom, TStrict> : TSelected;
@@ -0,0 +1,5 @@
1
+ import { RouteById } from './routeInfo.cjs';
2
+ import { AnyRouter } from './router.cjs';
3
+ import { Expand } from './utils.cjs';
4
+ export type ResolveUseLoaderDeps<TRouter extends AnyRouter, TFrom> = Expand<RouteById<TRouter['routeTree'], TFrom>['types']['loaderDeps']>;
5
+ export type UseLoaderDepsResult<TRouter extends AnyRouter, TFrom, TSelected> = unknown extends TSelected ? ResolveUseLoaderDeps<TRouter, TFrom> : TSelected;
@@ -0,0 +1,3 @@
1
+ import { NavigateOptions } from './link.cjs';
2
+ import { RegisteredRouter } from './router.cjs';
3
+ export type UseNavigateResult<TDefaultFrom extends string> = <TRouter extends RegisteredRouter, TTo extends string | undefined, TFrom extends string = TDefaultFrom, TMaskFrom extends string = TFrom, TMaskTo extends string = ''>({ from, ...rest }: NavigateOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>) => Promise<void>;
@@ -0,0 +1,5 @@
1
+ import { AllParams, RouteById } from './routeInfo.cjs';
2
+ import { AnyRouter } from './router.cjs';
3
+ import { Expand } from './utils.cjs';
4
+ export type ResolveUseParams<TRouter extends AnyRouter, TFrom, TStrict extends boolean> = TStrict extends false ? AllParams<TRouter['routeTree']> : Expand<RouteById<TRouter['routeTree'], TFrom>['types']['allParams']>;
5
+ export type UseParamsResult<TRouter extends AnyRouter, TFrom, TStrict extends boolean, TSelected> = unknown extends TSelected ? ResolveUseParams<TRouter, TFrom, TStrict> : TSelected;
@@ -0,0 +1,9 @@
1
+ import { AllContext, RouteById } from './routeInfo.cjs';
2
+ import { AnyRouter } from './router.cjs';
3
+ import { Expand, StrictOrFrom } from './utils.cjs';
4
+ export interface UseRouteContextBaseOptions<TRouter extends AnyRouter, TFrom, TStrict extends boolean, TSelected> {
5
+ select?: (search: ResolveUseRouteContext<TRouter, TFrom, TStrict>) => TSelected;
6
+ }
7
+ export type UseRouteContextOptions<TRouter extends AnyRouter, TFrom extends string | undefined, TStrict extends boolean, TSelected> = StrictOrFrom<TRouter, TFrom, TStrict> & UseRouteContextBaseOptions<TRouter, TFrom, TStrict, TSelected>;
8
+ export type ResolveUseRouteContext<TRouter extends AnyRouter, TFrom, TStrict extends boolean> = TStrict extends false ? AllContext<TRouter['routeTree']> : Expand<RouteById<TRouter['routeTree'], TFrom>['types']['allContext']>;
9
+ export type UseRouteContextResult<TRouter extends AnyRouter, TFrom, TStrict extends boolean, TSelected> = unknown extends TSelected ? ResolveUseRouteContext<TRouter, TFrom, TStrict> : TSelected;
@@ -0,0 +1,5 @@
1
+ import { FullSearchSchema, RouteById } from './routeInfo.cjs';
2
+ import { AnyRouter } from './router.cjs';
3
+ import { Expand } from './utils.cjs';
4
+ export type UseSearchResult<TRouter extends AnyRouter, TFrom, TStrict extends boolean, TSelected> = unknown extends TSelected ? ResolveUseSearch<TRouter, TFrom, TStrict> : TSelected;
5
+ export type ResolveUseSearch<TRouter extends AnyRouter, TFrom, TStrict extends boolean> = TStrict extends false ? FullSearchSchema<TRouter['routeTree']> : Expand<RouteById<TRouter['routeTree'], TFrom>['types']['fullSearchSchema']>;