@rindle/tanstack 0.7.10
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.
- package/LICENSE +201 -0
- package/README.md +7 -0
- package/dist/index.d.ts +61 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +84 -0
- package/dist/index.js.map +1 -0
- package/package.json +47 -0
- package/src/index.ts +172 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# @rindle/tanstack
|
|
2
|
+
|
|
3
|
+
TanStack Router/Start integration for Rindle route preloading, navigation readiness, SSR
|
|
4
|
+
dehydration, and the seed-to-live client handoff.
|
|
5
|
+
|
|
6
|
+
Full setup and API guidance: **[Server rendering](https://rindle.sh/docs/ssr)** · markdown mirror:
|
|
7
|
+
[`ssr.md`](https://rindle.sh/docs/ssr.md) · for agents: [llms.txt](https://rindle.sh/llms.txt)
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import { createElement, type ReactNode } from "react";
|
|
2
|
+
import type { AnyQuery, ColsMap, DehydratedState, EnsureQueryUntil, QueryEnsurer, Schema, Store } from "@rindle/client";
|
|
3
|
+
/** The loader-data field serialized by TanStack Start and consumed by {@link Provider}. */
|
|
4
|
+
export declare const RINDLE_LOADER_DATA_KEY: "rindle";
|
|
5
|
+
/** The stable subset of TanStack's loader context exposed to route query factories. TanStack passes
|
|
6
|
+
* a richer object at runtime; keeping this structural avoids coupling the adapter to a generated
|
|
7
|
+
* router's route-tree generics while still contextually typing the common fields. */
|
|
8
|
+
export interface RindleLoaderContext {
|
|
9
|
+
abortController: AbortController;
|
|
10
|
+
preload: boolean;
|
|
11
|
+
params: Record<string, string>;
|
|
12
|
+
deps: Record<string, unknown>;
|
|
13
|
+
context: unknown;
|
|
14
|
+
location: unknown;
|
|
15
|
+
cause: "preload" | "enter" | "stay";
|
|
16
|
+
}
|
|
17
|
+
export interface RindleLoaderData {
|
|
18
|
+
rindle: DehydratedState;
|
|
19
|
+
}
|
|
20
|
+
export interface RindleTanStackClient<S extends ColsMap> extends QueryEnsurer {
|
|
21
|
+
store: Store<S>;
|
|
22
|
+
}
|
|
23
|
+
export interface RindleTanStackOptions<S extends ColsMap> {
|
|
24
|
+
schema: Schema<S>;
|
|
25
|
+
/** Browser-only lazy client boot. The adapter calls it at most once and shares that client
|
|
26
|
+
* between route loaders and the provider. It is never called during SSR. */
|
|
27
|
+
boot: () => Promise<RindleTanStackClient<S>>;
|
|
28
|
+
/** Server-side named-query preload. A dynamic implementation keeps server authority code out of
|
|
29
|
+
* the browser bundle; the full loader context is forwarded for request-scoped auth/policy. */
|
|
30
|
+
preload: (queries: readonly AnyQuery[], context: RindleLoaderContext) => Promise<DehydratedState>;
|
|
31
|
+
}
|
|
32
|
+
type QueryList = AnyQuery | readonly AnyQuery[];
|
|
33
|
+
export interface RindleRouteLoaderOptions<Context extends RindleLoaderContext = RindleLoaderContext> {
|
|
34
|
+
/** Query (or queries) that blocks client route entry and is always included in the SSR seed. */
|
|
35
|
+
query?: (context: Context) => QueryList;
|
|
36
|
+
/** Additional queries needed for SSR first paint but not worth blocking client navigation on. */
|
|
37
|
+
ssr?: (context: Context) => QueryList;
|
|
38
|
+
/** Client readiness policy for `query`. Defaults to server-authoritative `complete`. */
|
|
39
|
+
until?: EnsureQueryUntil;
|
|
40
|
+
}
|
|
41
|
+
export interface RindleRouteLoader<Context extends RindleLoaderContext = RindleLoaderContext> {
|
|
42
|
+
handler(context: Context): Promise<RindleLoaderData>;
|
|
43
|
+
/** Re-entry must not commit a stale match while its Rindle query is being warmed. */
|
|
44
|
+
staleReloadMode: "blocking";
|
|
45
|
+
}
|
|
46
|
+
export interface RindleProviderProps {
|
|
47
|
+
children?: ReactNode;
|
|
48
|
+
}
|
|
49
|
+
export interface RindleTanStackIntegration<S extends ColsMap> {
|
|
50
|
+
loader<Context extends RindleLoaderContext = RindleLoaderContext>(options: RindleRouteLoaderOptions<Context>): RindleRouteLoader<Context>;
|
|
51
|
+
Provider(props: RindleProviderProps): ReturnType<typeof createElement>;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Bind one Rindle client/server pair to TanStack Router. The returned `loader` is used by routes;
|
|
55
|
+
* `Provider` replaces the app's manual `useMatches()` dehydration merge plus `<RindleSSR>` glue.
|
|
56
|
+
*/
|
|
57
|
+
export declare function createRindleTanStack<S extends ColsMap>(options: RindleTanStackOptions<S>): RindleTanStackIntegration<S>;
|
|
58
|
+
/** Merge the serialized Rindle slice from every matched route. Exported for custom providers/tests. */
|
|
59
|
+
export declare function mergeRindleLoaderData(loaderData: readonly unknown[]): DehydratedState;
|
|
60
|
+
export {};
|
|
61
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAW,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAG/D,OAAO,KAAK,EACV,QAAQ,EACR,OAAO,EACP,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,MAAM,EACN,KAAK,EACN,MAAM,gBAAgB,CAAC;AAGxB,2FAA2F;AAC3F,eAAO,MAAM,sBAAsB,EAAG,QAAiB,CAAC;AAExD;;sFAEsF;AACtF,MAAM,WAAW,mBAAmB;IAClC,eAAe,EAAE,eAAe,CAAC;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,SAAS,GAAG,OAAO,GAAG,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,eAAe,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,OAAO,CAAE,SAAQ,YAAY;IAC3E,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB,CAAC,CAAC,SAAS,OAAO;IACtD,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAClB;iFAC6E;IAC7E,IAAI,EAAE,MAAM,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7C;mGAC+F;IAC/F,OAAO,EAAE,CACP,OAAO,EAAE,SAAS,QAAQ,EAAE,EAC5B,OAAO,EAAE,mBAAmB,KACzB,OAAO,CAAC,eAAe,CAAC,CAAC;CAC/B;AAED,KAAK,SAAS,GAAG,QAAQ,GAAG,SAAS,QAAQ,EAAE,CAAC;AAEhD,MAAM,WAAW,wBAAwB,CAAC,OAAO,SAAS,mBAAmB,GAAG,mBAAmB;IACjG,gGAAgG;IAChG,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC;IACxC,iGAAiG;IACjG,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC;IACtC,wFAAwF;IACxF,KAAK,CAAC,EAAE,gBAAgB,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB,CAAC,OAAO,SAAS,mBAAmB,GAAG,mBAAmB;IAC1F,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACrD,qFAAqF;IACrF,eAAe,EAAE,UAAU,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB,CAAC,CAAC,SAAS,OAAO;IAC1D,MAAM,CAAC,OAAO,SAAS,mBAAmB,GAAG,mBAAmB,EAC9D,OAAO,EAAE,wBAAwB,CAAC,OAAO,CAAC,GACzC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,mBAAmB,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;CACxE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,OAAO,EACpD,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAChC,yBAAyB,CAAC,CAAC,CAAC,CAuD9B;AAED,uGAAuG;AACvG,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,SAAS,OAAO,EAAE,GAAG,eAAe,CASrF"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
// @rindle/tanstack — the route-level bridge between TanStack Router and Rindle. Routes declare
|
|
2
|
+
// data intent; this adapter owns SSR/client branching, loader dehydration, navigation readiness,
|
|
3
|
+
// stale re-entry behavior, cancellation, and the SSR-seed → live-store provider handoff.
|
|
4
|
+
import { createElement, useMemo } from "react";
|
|
5
|
+
import { useMatches } from "@tanstack/react-router";
|
|
6
|
+
import { stableKey } from "@rindle/client";
|
|
7
|
+
import { RindleSSR } from "@rindle/react";
|
|
8
|
+
/** The loader-data field serialized by TanStack Start and consumed by {@link Provider}. */
|
|
9
|
+
export const RINDLE_LOADER_DATA_KEY = "rindle";
|
|
10
|
+
/**
|
|
11
|
+
* Bind one Rindle client/server pair to TanStack Router. The returned `loader` is used by routes;
|
|
12
|
+
* `Provider` replaces the app's manual `useMatches()` dehydration merge plus `<RindleSSR>` glue.
|
|
13
|
+
*/
|
|
14
|
+
export function createRindleTanStack(options) {
|
|
15
|
+
let bootPromise;
|
|
16
|
+
const boot = () => {
|
|
17
|
+
// Both TanStack loaders and <RindleSSR> can be the first browser caller. Cache the in-flight
|
|
18
|
+
// result so they always retain and render through the same live store.
|
|
19
|
+
bootPromise ??= Promise.resolve().then(() => options.boot());
|
|
20
|
+
return bootPromise;
|
|
21
|
+
};
|
|
22
|
+
const loader = (route) => ({
|
|
23
|
+
staleReloadMode: "blocking",
|
|
24
|
+
handler: async (context) => {
|
|
25
|
+
if (!route.query && !route.ssr) {
|
|
26
|
+
throw new Error("rindle.loader: expected at least one query or ssr query.");
|
|
27
|
+
}
|
|
28
|
+
const primary = route.query ? queryList(route.query(context)) : [];
|
|
29
|
+
if (typeof window === "undefined") {
|
|
30
|
+
const extras = route.ssr ? queryList(route.ssr(context)) : [];
|
|
31
|
+
return { rindle: await options.preload(uniqueQueries([...primary, ...extras]), context) };
|
|
32
|
+
}
|
|
33
|
+
// An SSR-only declaration contributes to the first document render, but it should be a no-op
|
|
34
|
+
// when TanStack invokes the same loader during browser navigation.
|
|
35
|
+
if (primary.length === 0)
|
|
36
|
+
return { rindle: {} };
|
|
37
|
+
const client = await boot();
|
|
38
|
+
await Promise.all(primary.map((query) => client.ensure(query, {
|
|
39
|
+
until: route.until,
|
|
40
|
+
signal: context.abortController.signal,
|
|
41
|
+
})));
|
|
42
|
+
return { rindle: {} };
|
|
43
|
+
},
|
|
44
|
+
});
|
|
45
|
+
function Provider({ children }) {
|
|
46
|
+
const matches = useMatches();
|
|
47
|
+
const ssrState = useMemo(() => mergeRindleLoaderData(matches.map((match) => match.loaderData)), [matches]);
|
|
48
|
+
return createElement((RindleSSR), {
|
|
49
|
+
schema: options.schema,
|
|
50
|
+
ssrState,
|
|
51
|
+
boot,
|
|
52
|
+
children,
|
|
53
|
+
});
|
|
54
|
+
}
|
|
55
|
+
return { loader, Provider };
|
|
56
|
+
}
|
|
57
|
+
/** Merge the serialized Rindle slice from every matched route. Exported for custom providers/tests. */
|
|
58
|
+
export function mergeRindleLoaderData(loaderData) {
|
|
59
|
+
const merged = {};
|
|
60
|
+
for (const data of loaderData) {
|
|
61
|
+
if (data === null || typeof data !== "object")
|
|
62
|
+
continue;
|
|
63
|
+
const slice = data[RINDLE_LOADER_DATA_KEY];
|
|
64
|
+
// Later matched routes intentionally win when two slices contain the same query key.
|
|
65
|
+
if (slice)
|
|
66
|
+
Object.assign(merged, slice);
|
|
67
|
+
}
|
|
68
|
+
return merged;
|
|
69
|
+
}
|
|
70
|
+
function queryList(value) {
|
|
71
|
+
return Array.isArray(value) ? value : [value];
|
|
72
|
+
}
|
|
73
|
+
function uniqueQueries(queries) {
|
|
74
|
+
const seen = new Set();
|
|
75
|
+
return queries.filter((query) => {
|
|
76
|
+
const remote = typeof query.name === "string" ? { name: query.name, args: query.args } : undefined;
|
|
77
|
+
const key = stableKey({ ast: query.ast(), remote });
|
|
78
|
+
if (seen.has(key))
|
|
79
|
+
return false;
|
|
80
|
+
seen.add(key);
|
|
81
|
+
return true;
|
|
82
|
+
});
|
|
83
|
+
}
|
|
84
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,+FAA+F;AAC/F,iGAAiG;AACjG,yFAAyF;AAEzF,OAAO,EAAE,aAAa,EAAE,OAAO,EAAkB,MAAM,OAAO,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAU3C,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C,2FAA2F;AAC3F,MAAM,CAAC,MAAM,sBAAsB,GAAG,QAAiB,CAAC;AAgExD;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAClC,OAAiC;IAEjC,IAAI,WAAyD,CAAC;IAC9D,MAAM,IAAI,GAAG,GAAqC,EAAE;QAClD,6FAA6F;QAC7F,uEAAuE;QACvE,WAAW,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QAC7D,OAAO,WAAW,CAAC;IACrB,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,CACb,KAAwC,EACZ,EAAE,CAAC,CAAC;QAChC,eAAe,EAAE,UAAU;QAC3B,OAAO,EAAE,KAAK,EAAE,OAAgB,EAA6B,EAAE;YAC7D,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;YAC9E,CAAC;YACD,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACnE,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;gBAClC,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,CAAC;YAC5F,CAAC;YAED,6FAA6F;YAC7F,mEAAmE;YACnE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;YAEhD,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;YAC5B,MAAM,OAAO,CAAC,GAAG,CACf,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACpB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE;gBACnB,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,MAAM;aACvC,CAAC,CACH,CACF,CAAC;YACF,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QACxB,CAAC;KACF,CAAC,CAAC;IAEH,SAAS,QAAQ,CAAC,EAAE,QAAQ,EAAuB;QACjD,MAAM,OAAO,GAAG,UAAU,EAAyC,CAAC;QACpE,MAAM,QAAQ,GAAG,OAAO,CACtB,GAAG,EAAE,CAAC,qBAAqB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,EACrE,CAAC,OAAO,CAAC,CACV,CAAC;QACF,OAAO,aAAa,CAAC,CAAA,SAAY,CAAA,EAAE;YACjC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,QAAQ;YACR,IAAI;YACJ,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;AAC9B,CAAC;AAED,uGAAuG;AACvG,MAAM,UAAU,qBAAqB,CAAC,UAA8B;IAClE,MAAM,MAAM,GAAoB,EAAE,CAAC;IACnC,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;QAC9B,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,SAAS;QACxD,MAAM,KAAK,GAAI,IAAkC,CAAC,sBAAsB,CAAC,CAAC;QAC1E,qFAAqF;QACrF,IAAI,KAAK;YAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,SAAS,CAAC,KAAgB;IACjC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAiB,CAAC,CAAC;AAC5D,CAAC;AAED,SAAS,aAAa,CAAC,OAA4B;IACjD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QAC9B,MAAM,MAAM,GAAG,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACnG,MAAM,GAAG,GAAG,SAAS,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QACpD,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QAChC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@rindle/tanstack",
|
|
3
|
+
"version": "0.7.10",
|
|
4
|
+
"license": "Apache-2.0",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "git+https://github.com/rindle-sh/rindle.git",
|
|
8
|
+
"directory": "packages/tanstack"
|
|
9
|
+
},
|
|
10
|
+
"type": "module",
|
|
11
|
+
"description": "TanStack Router integration for Rindle route preloading and SSR hydration.",
|
|
12
|
+
"main": "./dist/index.js",
|
|
13
|
+
"types": "./dist/index.d.ts",
|
|
14
|
+
"sideEffects": false,
|
|
15
|
+
"exports": {
|
|
16
|
+
".": {
|
|
17
|
+
"@rindle/source": "./src/index.ts",
|
|
18
|
+
"types": "./dist/index.d.ts",
|
|
19
|
+
"default": "./dist/index.js"
|
|
20
|
+
}
|
|
21
|
+
},
|
|
22
|
+
"files": [
|
|
23
|
+
"dist",
|
|
24
|
+
"src",
|
|
25
|
+
"README.md"
|
|
26
|
+
],
|
|
27
|
+
"dependencies": {
|
|
28
|
+
"@rindle/client": "0.7.10",
|
|
29
|
+
"@rindle/react": "0.7.10"
|
|
30
|
+
},
|
|
31
|
+
"peerDependencies": {
|
|
32
|
+
"@tanstack/react-router": ">=1.167.0",
|
|
33
|
+
"react": ">=18.0.0"
|
|
34
|
+
},
|
|
35
|
+
"devDependencies": {
|
|
36
|
+
"@tanstack/react-router": "1.170.18",
|
|
37
|
+
"@types/node": "^22.10.0",
|
|
38
|
+
"@types/react": "^19.0.0",
|
|
39
|
+
"react": "^19.1.0",
|
|
40
|
+
"typescript": "^5.7.0"
|
|
41
|
+
},
|
|
42
|
+
"scripts": {
|
|
43
|
+
"build": "tsc -p tsconfig.build.json",
|
|
44
|
+
"typecheck": "tsc --noEmit",
|
|
45
|
+
"test": "tsc --noEmit && node --conditions=@rindle/source --test test/*.test.ts"
|
|
46
|
+
}
|
|
47
|
+
}
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
// @rindle/tanstack — the route-level bridge between TanStack Router and Rindle. Routes declare
|
|
2
|
+
// data intent; this adapter owns SSR/client branching, loader dehydration, navigation readiness,
|
|
3
|
+
// stale re-entry behavior, cancellation, and the SSR-seed → live-store provider handoff.
|
|
4
|
+
|
|
5
|
+
import { createElement, useMemo, type ReactNode } from "react";
|
|
6
|
+
import { useMatches } from "@tanstack/react-router";
|
|
7
|
+
import { stableKey } from "@rindle/client";
|
|
8
|
+
import type {
|
|
9
|
+
AnyQuery,
|
|
10
|
+
ColsMap,
|
|
11
|
+
DehydratedState,
|
|
12
|
+
EnsureQueryUntil,
|
|
13
|
+
QueryEnsurer,
|
|
14
|
+
Schema,
|
|
15
|
+
Store,
|
|
16
|
+
} from "@rindle/client";
|
|
17
|
+
import { RindleSSR } from "@rindle/react";
|
|
18
|
+
|
|
19
|
+
/** The loader-data field serialized by TanStack Start and consumed by {@link Provider}. */
|
|
20
|
+
export const RINDLE_LOADER_DATA_KEY = "rindle" as const;
|
|
21
|
+
|
|
22
|
+
/** The stable subset of TanStack's loader context exposed to route query factories. TanStack passes
|
|
23
|
+
* a richer object at runtime; keeping this structural avoids coupling the adapter to a generated
|
|
24
|
+
* router's route-tree generics while still contextually typing the common fields. */
|
|
25
|
+
export interface RindleLoaderContext {
|
|
26
|
+
abortController: AbortController;
|
|
27
|
+
preload: boolean;
|
|
28
|
+
params: Record<string, string>;
|
|
29
|
+
deps: Record<string, unknown>;
|
|
30
|
+
context: unknown;
|
|
31
|
+
location: unknown;
|
|
32
|
+
cause: "preload" | "enter" | "stay";
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
export interface RindleLoaderData {
|
|
36
|
+
rindle: DehydratedState;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
export interface RindleTanStackClient<S extends ColsMap> extends QueryEnsurer {
|
|
40
|
+
store: Store<S>;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
export interface RindleTanStackOptions<S extends ColsMap> {
|
|
44
|
+
schema: Schema<S>;
|
|
45
|
+
/** Browser-only lazy client boot. The adapter calls it at most once and shares that client
|
|
46
|
+
* between route loaders and the provider. It is never called during SSR. */
|
|
47
|
+
boot: () => Promise<RindleTanStackClient<S>>;
|
|
48
|
+
/** Server-side named-query preload. A dynamic implementation keeps server authority code out of
|
|
49
|
+
* the browser bundle; the full loader context is forwarded for request-scoped auth/policy. */
|
|
50
|
+
preload: (
|
|
51
|
+
queries: readonly AnyQuery[],
|
|
52
|
+
context: RindleLoaderContext,
|
|
53
|
+
) => Promise<DehydratedState>;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
type QueryList = AnyQuery | readonly AnyQuery[];
|
|
57
|
+
|
|
58
|
+
export interface RindleRouteLoaderOptions<Context extends RindleLoaderContext = RindleLoaderContext> {
|
|
59
|
+
/** Query (or queries) that blocks client route entry and is always included in the SSR seed. */
|
|
60
|
+
query?: (context: Context) => QueryList;
|
|
61
|
+
/** Additional queries needed for SSR first paint but not worth blocking client navigation on. */
|
|
62
|
+
ssr?: (context: Context) => QueryList;
|
|
63
|
+
/** Client readiness policy for `query`. Defaults to server-authoritative `complete`. */
|
|
64
|
+
until?: EnsureQueryUntil;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
export interface RindleRouteLoader<Context extends RindleLoaderContext = RindleLoaderContext> {
|
|
68
|
+
handler(context: Context): Promise<RindleLoaderData>;
|
|
69
|
+
/** Re-entry must not commit a stale match while its Rindle query is being warmed. */
|
|
70
|
+
staleReloadMode: "blocking";
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export interface RindleProviderProps {
|
|
74
|
+
children?: ReactNode;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export interface RindleTanStackIntegration<S extends ColsMap> {
|
|
78
|
+
loader<Context extends RindleLoaderContext = RindleLoaderContext>(
|
|
79
|
+
options: RindleRouteLoaderOptions<Context>,
|
|
80
|
+
): RindleRouteLoader<Context>;
|
|
81
|
+
Provider(props: RindleProviderProps): ReturnType<typeof createElement>;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
/**
|
|
85
|
+
* Bind one Rindle client/server pair to TanStack Router. The returned `loader` is used by routes;
|
|
86
|
+
* `Provider` replaces the app's manual `useMatches()` dehydration merge plus `<RindleSSR>` glue.
|
|
87
|
+
*/
|
|
88
|
+
export function createRindleTanStack<S extends ColsMap>(
|
|
89
|
+
options: RindleTanStackOptions<S>,
|
|
90
|
+
): RindleTanStackIntegration<S> {
|
|
91
|
+
let bootPromise: Promise<RindleTanStackClient<S>> | undefined;
|
|
92
|
+
const boot = (): Promise<RindleTanStackClient<S>> => {
|
|
93
|
+
// Both TanStack loaders and <RindleSSR> can be the first browser caller. Cache the in-flight
|
|
94
|
+
// result so they always retain and render through the same live store.
|
|
95
|
+
bootPromise ??= Promise.resolve().then(() => options.boot());
|
|
96
|
+
return bootPromise;
|
|
97
|
+
};
|
|
98
|
+
|
|
99
|
+
const loader = <Context extends RindleLoaderContext = RindleLoaderContext>(
|
|
100
|
+
route: RindleRouteLoaderOptions<Context>,
|
|
101
|
+
): RindleRouteLoader<Context> => ({
|
|
102
|
+
staleReloadMode: "blocking",
|
|
103
|
+
handler: async (context: Context): Promise<RindleLoaderData> => {
|
|
104
|
+
if (!route.query && !route.ssr) {
|
|
105
|
+
throw new Error("rindle.loader: expected at least one query or ssr query.");
|
|
106
|
+
}
|
|
107
|
+
const primary = route.query ? queryList(route.query(context)) : [];
|
|
108
|
+
if (typeof window === "undefined") {
|
|
109
|
+
const extras = route.ssr ? queryList(route.ssr(context)) : [];
|
|
110
|
+
return { rindle: await options.preload(uniqueQueries([...primary, ...extras]), context) };
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
// An SSR-only declaration contributes to the first document render, but it should be a no-op
|
|
114
|
+
// when TanStack invokes the same loader during browser navigation.
|
|
115
|
+
if (primary.length === 0) return { rindle: {} };
|
|
116
|
+
|
|
117
|
+
const client = await boot();
|
|
118
|
+
await Promise.all(
|
|
119
|
+
primary.map((query) =>
|
|
120
|
+
client.ensure(query, {
|
|
121
|
+
until: route.until,
|
|
122
|
+
signal: context.abortController.signal,
|
|
123
|
+
}),
|
|
124
|
+
),
|
|
125
|
+
);
|
|
126
|
+
return { rindle: {} };
|
|
127
|
+
},
|
|
128
|
+
});
|
|
129
|
+
|
|
130
|
+
function Provider({ children }: RindleProviderProps): ReturnType<typeof createElement> {
|
|
131
|
+
const matches = useMatches() as readonly { loaderData?: unknown }[];
|
|
132
|
+
const ssrState = useMemo(
|
|
133
|
+
() => mergeRindleLoaderData(matches.map((match) => match.loaderData)),
|
|
134
|
+
[matches],
|
|
135
|
+
);
|
|
136
|
+
return createElement(RindleSSR<S>, {
|
|
137
|
+
schema: options.schema,
|
|
138
|
+
ssrState,
|
|
139
|
+
boot,
|
|
140
|
+
children,
|
|
141
|
+
});
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
return { loader, Provider };
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
/** Merge the serialized Rindle slice from every matched route. Exported for custom providers/tests. */
|
|
148
|
+
export function mergeRindleLoaderData(loaderData: readonly unknown[]): DehydratedState {
|
|
149
|
+
const merged: DehydratedState = {};
|
|
150
|
+
for (const data of loaderData) {
|
|
151
|
+
if (data === null || typeof data !== "object") continue;
|
|
152
|
+
const slice = (data as Partial<RindleLoaderData>)[RINDLE_LOADER_DATA_KEY];
|
|
153
|
+
// Later matched routes intentionally win when two slices contain the same query key.
|
|
154
|
+
if (slice) Object.assign(merged, slice);
|
|
155
|
+
}
|
|
156
|
+
return merged;
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
function queryList(value: QueryList): readonly AnyQuery[] {
|
|
160
|
+
return Array.isArray(value) ? value : [value as AnyQuery];
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
function uniqueQueries(queries: readonly AnyQuery[]): readonly AnyQuery[] {
|
|
164
|
+
const seen = new Set<string>();
|
|
165
|
+
return queries.filter((query) => {
|
|
166
|
+
const remote = typeof query.name === "string" ? { name: query.name, args: query.args } : undefined;
|
|
167
|
+
const key = stableKey({ ast: query.ast(), remote });
|
|
168
|
+
if (seen.has(key)) return false;
|
|
169
|
+
seen.add(key);
|
|
170
|
+
return true;
|
|
171
|
+
});
|
|
172
|
+
}
|