@taladb/next 0.9.3 → 0.10.0
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 +202 -21
- package/dist/server.d.mts +152 -1
- package/dist/server.d.ts +152 -1
- package/dist/server.js +64 -0
- package/dist/server.mjs +61 -0
- package/package.json +7 -7
package/LICENSE
CHANGED
|
@@ -1,21 +1,202 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2025-2026 thinkgrid-labs
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/dist/server.d.mts
CHANGED
|
@@ -1,5 +1,156 @@
|
|
|
1
1
|
import { TalaDB } from 'taladb';
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* Server helpers for coverage-first replication.
|
|
5
|
+
*
|
|
6
|
+
* Implements the two endpoints a client needs to build a **trustworthy** local
|
|
7
|
+
* replica of a table:
|
|
8
|
+
*
|
|
9
|
+
* - `GET ?page=&limit=&snapshot=` — the bootstrap walk
|
|
10
|
+
* - `GET ?since=<cursor>` — the delta feed
|
|
11
|
+
*
|
|
12
|
+
* Framework-neutral: it takes a `Request` and returns a `Response`, so it drops
|
|
13
|
+
* into a Next route handler, a Remix loader, a Hono route, or an Express adapter.
|
|
14
|
+
*
|
|
15
|
+
* ## Why the snapshot matters more than it looks
|
|
16
|
+
*
|
|
17
|
+
* The obvious way to build a replica is to walk `?page=1,2,3…` and stop. It is
|
|
18
|
+
* also **wrong on live data**, and wrong in a way nothing detects.
|
|
19
|
+
*
|
|
20
|
+
* Fetch page 1. A row gets deleted. Every later row shifts up one. Fetch page 2 at
|
|
21
|
+
* offset 100 — but the row that *was* at offset 100 is now at 99, which you already
|
|
22
|
+
* passed. It is never fetched. The walk completes, the client marks the collection
|
|
23
|
+
* complete, and from then on every query is served locally from a replica with a
|
|
24
|
+
* silent hole in it. No error, no warning, just a product that quietly doesn't
|
|
25
|
+
* exist for that user until the next full rebuild.
|
|
26
|
+
*
|
|
27
|
+
* A snapshot token fixes it: the client echoes it back on every page, and the
|
|
28
|
+
* server answers each page from the *same logical view* of the table. On Postgres
|
|
29
|
+
* this is a monotonic revision column and a `rev <= :snapshot` predicate — no
|
|
30
|
+
* long-lived transaction required.
|
|
31
|
+
*
|
|
32
|
+
* An origin that cannot do this is still usable, but the client caps its coverage
|
|
33
|
+
* at `best-effort` and keeps serving reads from the network, because it cannot
|
|
34
|
+
* prove the replica is whole. That is the honest outcome, and it is why
|
|
35
|
+
* {@link createReplicationHandlers} pushes you toward supporting it.
|
|
36
|
+
*/
|
|
37
|
+
/** A row as your database returns it. Must carry a stable primary key. */
|
|
38
|
+
type Row = Record<string, unknown>;
|
|
39
|
+
interface BootstrapArgs {
|
|
40
|
+
/** Offset (or opaque page token) to resume from. `null` on the first page. */
|
|
41
|
+
page: string | number | null;
|
|
42
|
+
/** Rows requested. Already clamped to `maxLimit`. */
|
|
43
|
+
limit: number;
|
|
44
|
+
/**
|
|
45
|
+
* The snapshot to read from — `null` on the first page, when you should *issue*
|
|
46
|
+
* one. Every later page echoes it back, and you must answer from that same view.
|
|
47
|
+
*/
|
|
48
|
+
snapshot: string | null;
|
|
49
|
+
/** The authorized scope (tenant, user, store). Never serve across scopes. */
|
|
50
|
+
scope: string;
|
|
51
|
+
}
|
|
52
|
+
interface BootstrapResult {
|
|
53
|
+
rows: Row[];
|
|
54
|
+
/** Resume token for the next page; `null` when the walk is done. */
|
|
55
|
+
nextPage: string | number | null;
|
|
56
|
+
/**
|
|
57
|
+
* Issue this on the first page. Omitting it caps the client at `best-effort`
|
|
58
|
+
* coverage — reads keep hitting the network forever. See the module doc.
|
|
59
|
+
*/
|
|
60
|
+
snapshot?: string;
|
|
61
|
+
/**
|
|
62
|
+
* The cursor the delta feed should resume from — issued **on the first page**,
|
|
63
|
+
* i.e. as of the snapshot. Issuing it after the walk instead would lose anything
|
|
64
|
+
* that changed *during* the walk: it would fall between "bootstrap ended" and
|
|
65
|
+
* "delta began".
|
|
66
|
+
*/
|
|
67
|
+
deltaCursor?: string;
|
|
68
|
+
/** Total rows in scope, if cheap to know. Drives the client's progress bar. */
|
|
69
|
+
total?: number;
|
|
70
|
+
}
|
|
71
|
+
interface DeltaArgs {
|
|
72
|
+
/** The cursor the client last stored. */
|
|
73
|
+
since: string;
|
|
74
|
+
scope: string;
|
|
75
|
+
}
|
|
76
|
+
interface DeltaResult {
|
|
77
|
+
changed: Row[];
|
|
78
|
+
/**
|
|
79
|
+
* Primary keys deleted since `since`.
|
|
80
|
+
*
|
|
81
|
+
* **This is the only way a REST replica ever learns about a deletion.** A paged
|
|
82
|
+
* GET returns survivors, and a row's absence is ambiguous — deleted, or merely
|
|
83
|
+
* shifted to another page? The client refuses to guess (guessing eventually
|
|
84
|
+
* deletes live data), so if you don't report deletions here, deleted rows live
|
|
85
|
+
* on in every client forever. A soft-delete table or an `is_deleted` flag with a
|
|
86
|
+
* revision is the usual answer.
|
|
87
|
+
*/
|
|
88
|
+
deleted: Array<string | number>;
|
|
89
|
+
cursor: string;
|
|
90
|
+
hasMore?: boolean;
|
|
91
|
+
}
|
|
92
|
+
interface CreateReplicationHandlersOptions {
|
|
93
|
+
bootstrap(args: BootstrapArgs): Promise<BootstrapResult>;
|
|
94
|
+
delta?(args: DeltaArgs): Promise<DeltaResult>;
|
|
95
|
+
/**
|
|
96
|
+
* Identify the caller and return a scope key — **your security boundary**.
|
|
97
|
+
* Return `null` to reject with 401. Omit only for genuinely public data: without
|
|
98
|
+
* it every caller shares one scope, and a replica hydrated by one user is served
|
|
99
|
+
* to the next.
|
|
100
|
+
*/
|
|
101
|
+
authorize?(req: Request): Promise<string | null | undefined> | string | null | undefined;
|
|
102
|
+
/** Largest page a client may request. Default 1000. */
|
|
103
|
+
maxLimit?: number;
|
|
104
|
+
/** Page size when the client doesn't ask. Default 500. */
|
|
105
|
+
defaultLimit?: number;
|
|
106
|
+
}
|
|
107
|
+
interface ReplicationHandlers {
|
|
108
|
+
/** Mount as the `GET` handler for your collection endpoint. */
|
|
109
|
+
GET(req: Request): Promise<Response>;
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* Build the `GET` handler that serves both the bootstrap walk and the delta feed.
|
|
113
|
+
*
|
|
114
|
+
* The two are distinguished by the query string: `?since=` means delta, anything
|
|
115
|
+
* else means bootstrap.
|
|
116
|
+
*
|
|
117
|
+
* @example
|
|
118
|
+
* // app/api/products/route.ts
|
|
119
|
+
* export const { GET } = createReplicationHandlers({
|
|
120
|
+
* authorize: (req) => getSession(req)?.storeId ?? null,
|
|
121
|
+
* async bootstrap({ page, limit, snapshot, scope }) {
|
|
122
|
+
* // Issue a snapshot on the first page: the current max revision. Later pages
|
|
123
|
+
* // read `rev <= snapshot`, so the walk sees one consistent view of the table
|
|
124
|
+
* // even while it is being written to.
|
|
125
|
+
* const rev = snapshot ?? String(await currentRevision());
|
|
126
|
+
* const offset = Number(page ?? 0);
|
|
127
|
+
* const rows = await sql`
|
|
128
|
+
* SELECT id, name, price, category, rev FROM products
|
|
129
|
+
* WHERE store_id = ${scope} AND rev <= ${rev} AND NOT is_deleted
|
|
130
|
+
* ORDER BY id LIMIT ${limit} OFFSET ${offset}`;
|
|
131
|
+
* return {
|
|
132
|
+
* rows,
|
|
133
|
+
* nextPage: rows.length < limit ? null : offset + limit,
|
|
134
|
+
* snapshot: rev,
|
|
135
|
+
* deltaCursor: rev,
|
|
136
|
+
* total: await countProducts(scope, rev),
|
|
137
|
+
* };
|
|
138
|
+
* },
|
|
139
|
+
* async delta({ since, scope }) {
|
|
140
|
+
* const rows = await sql`
|
|
141
|
+
* SELECT id, name, price, category, rev, is_deleted FROM products
|
|
142
|
+
* WHERE store_id = ${scope} AND rev > ${since}`;
|
|
143
|
+
* const now = String(await currentRevision());
|
|
144
|
+
* return {
|
|
145
|
+
* changed: rows.filter((r) => !r.is_deleted),
|
|
146
|
+
* deleted: rows.filter((r) => r.is_deleted).map((r) => r.id),
|
|
147
|
+
* cursor: now,
|
|
148
|
+
* };
|
|
149
|
+
* },
|
|
150
|
+
* });
|
|
151
|
+
*/
|
|
152
|
+
declare function createReplicationHandlers(options: CreateReplicationHandlersOptions): ReplicationHandlers;
|
|
153
|
+
|
|
3
154
|
/** The fields of a TalaDB change record the store keys on. Everything else in
|
|
4
155
|
* a record is opaque — store it verbatim. */
|
|
5
156
|
interface ChangeRecord {
|
|
@@ -82,4 +233,4 @@ declare function memorySyncStore(): SyncStore;
|
|
|
82
233
|
*/
|
|
83
234
|
declare function taladbSyncStore(db: TalaDB, collectionName?: string): SyncStore;
|
|
84
235
|
|
|
85
|
-
export { type ChangeRecord, type CreateSyncHandlersOptions, type SyncHandlers, type SyncStore, createSyncHandlers, memorySyncStore, taladbSyncStore };
|
|
236
|
+
export { type BootstrapArgs, type BootstrapResult, type ChangeRecord, type CreateReplicationHandlersOptions, type CreateSyncHandlersOptions, type DeltaArgs, type DeltaResult, type ReplicationHandlers, type Row, type SyncHandlers, type SyncStore, createReplicationHandlers, createSyncHandlers, memorySyncStore, taladbSyncStore };
|
package/dist/server.d.ts
CHANGED
|
@@ -1,5 +1,156 @@
|
|
|
1
1
|
import { TalaDB } from 'taladb';
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* Server helpers for coverage-first replication.
|
|
5
|
+
*
|
|
6
|
+
* Implements the two endpoints a client needs to build a **trustworthy** local
|
|
7
|
+
* replica of a table:
|
|
8
|
+
*
|
|
9
|
+
* - `GET ?page=&limit=&snapshot=` — the bootstrap walk
|
|
10
|
+
* - `GET ?since=<cursor>` — the delta feed
|
|
11
|
+
*
|
|
12
|
+
* Framework-neutral: it takes a `Request` and returns a `Response`, so it drops
|
|
13
|
+
* into a Next route handler, a Remix loader, a Hono route, or an Express adapter.
|
|
14
|
+
*
|
|
15
|
+
* ## Why the snapshot matters more than it looks
|
|
16
|
+
*
|
|
17
|
+
* The obvious way to build a replica is to walk `?page=1,2,3…` and stop. It is
|
|
18
|
+
* also **wrong on live data**, and wrong in a way nothing detects.
|
|
19
|
+
*
|
|
20
|
+
* Fetch page 1. A row gets deleted. Every later row shifts up one. Fetch page 2 at
|
|
21
|
+
* offset 100 — but the row that *was* at offset 100 is now at 99, which you already
|
|
22
|
+
* passed. It is never fetched. The walk completes, the client marks the collection
|
|
23
|
+
* complete, and from then on every query is served locally from a replica with a
|
|
24
|
+
* silent hole in it. No error, no warning, just a product that quietly doesn't
|
|
25
|
+
* exist for that user until the next full rebuild.
|
|
26
|
+
*
|
|
27
|
+
* A snapshot token fixes it: the client echoes it back on every page, and the
|
|
28
|
+
* server answers each page from the *same logical view* of the table. On Postgres
|
|
29
|
+
* this is a monotonic revision column and a `rev <= :snapshot` predicate — no
|
|
30
|
+
* long-lived transaction required.
|
|
31
|
+
*
|
|
32
|
+
* An origin that cannot do this is still usable, but the client caps its coverage
|
|
33
|
+
* at `best-effort` and keeps serving reads from the network, because it cannot
|
|
34
|
+
* prove the replica is whole. That is the honest outcome, and it is why
|
|
35
|
+
* {@link createReplicationHandlers} pushes you toward supporting it.
|
|
36
|
+
*/
|
|
37
|
+
/** A row as your database returns it. Must carry a stable primary key. */
|
|
38
|
+
type Row = Record<string, unknown>;
|
|
39
|
+
interface BootstrapArgs {
|
|
40
|
+
/** Offset (or opaque page token) to resume from. `null` on the first page. */
|
|
41
|
+
page: string | number | null;
|
|
42
|
+
/** Rows requested. Already clamped to `maxLimit`. */
|
|
43
|
+
limit: number;
|
|
44
|
+
/**
|
|
45
|
+
* The snapshot to read from — `null` on the first page, when you should *issue*
|
|
46
|
+
* one. Every later page echoes it back, and you must answer from that same view.
|
|
47
|
+
*/
|
|
48
|
+
snapshot: string | null;
|
|
49
|
+
/** The authorized scope (tenant, user, store). Never serve across scopes. */
|
|
50
|
+
scope: string;
|
|
51
|
+
}
|
|
52
|
+
interface BootstrapResult {
|
|
53
|
+
rows: Row[];
|
|
54
|
+
/** Resume token for the next page; `null` when the walk is done. */
|
|
55
|
+
nextPage: string | number | null;
|
|
56
|
+
/**
|
|
57
|
+
* Issue this on the first page. Omitting it caps the client at `best-effort`
|
|
58
|
+
* coverage — reads keep hitting the network forever. See the module doc.
|
|
59
|
+
*/
|
|
60
|
+
snapshot?: string;
|
|
61
|
+
/**
|
|
62
|
+
* The cursor the delta feed should resume from — issued **on the first page**,
|
|
63
|
+
* i.e. as of the snapshot. Issuing it after the walk instead would lose anything
|
|
64
|
+
* that changed *during* the walk: it would fall between "bootstrap ended" and
|
|
65
|
+
* "delta began".
|
|
66
|
+
*/
|
|
67
|
+
deltaCursor?: string;
|
|
68
|
+
/** Total rows in scope, if cheap to know. Drives the client's progress bar. */
|
|
69
|
+
total?: number;
|
|
70
|
+
}
|
|
71
|
+
interface DeltaArgs {
|
|
72
|
+
/** The cursor the client last stored. */
|
|
73
|
+
since: string;
|
|
74
|
+
scope: string;
|
|
75
|
+
}
|
|
76
|
+
interface DeltaResult {
|
|
77
|
+
changed: Row[];
|
|
78
|
+
/**
|
|
79
|
+
* Primary keys deleted since `since`.
|
|
80
|
+
*
|
|
81
|
+
* **This is the only way a REST replica ever learns about a deletion.** A paged
|
|
82
|
+
* GET returns survivors, and a row's absence is ambiguous — deleted, or merely
|
|
83
|
+
* shifted to another page? The client refuses to guess (guessing eventually
|
|
84
|
+
* deletes live data), so if you don't report deletions here, deleted rows live
|
|
85
|
+
* on in every client forever. A soft-delete table or an `is_deleted` flag with a
|
|
86
|
+
* revision is the usual answer.
|
|
87
|
+
*/
|
|
88
|
+
deleted: Array<string | number>;
|
|
89
|
+
cursor: string;
|
|
90
|
+
hasMore?: boolean;
|
|
91
|
+
}
|
|
92
|
+
interface CreateReplicationHandlersOptions {
|
|
93
|
+
bootstrap(args: BootstrapArgs): Promise<BootstrapResult>;
|
|
94
|
+
delta?(args: DeltaArgs): Promise<DeltaResult>;
|
|
95
|
+
/**
|
|
96
|
+
* Identify the caller and return a scope key — **your security boundary**.
|
|
97
|
+
* Return `null` to reject with 401. Omit only for genuinely public data: without
|
|
98
|
+
* it every caller shares one scope, and a replica hydrated by one user is served
|
|
99
|
+
* to the next.
|
|
100
|
+
*/
|
|
101
|
+
authorize?(req: Request): Promise<string | null | undefined> | string | null | undefined;
|
|
102
|
+
/** Largest page a client may request. Default 1000. */
|
|
103
|
+
maxLimit?: number;
|
|
104
|
+
/** Page size when the client doesn't ask. Default 500. */
|
|
105
|
+
defaultLimit?: number;
|
|
106
|
+
}
|
|
107
|
+
interface ReplicationHandlers {
|
|
108
|
+
/** Mount as the `GET` handler for your collection endpoint. */
|
|
109
|
+
GET(req: Request): Promise<Response>;
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* Build the `GET` handler that serves both the bootstrap walk and the delta feed.
|
|
113
|
+
*
|
|
114
|
+
* The two are distinguished by the query string: `?since=` means delta, anything
|
|
115
|
+
* else means bootstrap.
|
|
116
|
+
*
|
|
117
|
+
* @example
|
|
118
|
+
* // app/api/products/route.ts
|
|
119
|
+
* export const { GET } = createReplicationHandlers({
|
|
120
|
+
* authorize: (req) => getSession(req)?.storeId ?? null,
|
|
121
|
+
* async bootstrap({ page, limit, snapshot, scope }) {
|
|
122
|
+
* // Issue a snapshot on the first page: the current max revision. Later pages
|
|
123
|
+
* // read `rev <= snapshot`, so the walk sees one consistent view of the table
|
|
124
|
+
* // even while it is being written to.
|
|
125
|
+
* const rev = snapshot ?? String(await currentRevision());
|
|
126
|
+
* const offset = Number(page ?? 0);
|
|
127
|
+
* const rows = await sql`
|
|
128
|
+
* SELECT id, name, price, category, rev FROM products
|
|
129
|
+
* WHERE store_id = ${scope} AND rev <= ${rev} AND NOT is_deleted
|
|
130
|
+
* ORDER BY id LIMIT ${limit} OFFSET ${offset}`;
|
|
131
|
+
* return {
|
|
132
|
+
* rows,
|
|
133
|
+
* nextPage: rows.length < limit ? null : offset + limit,
|
|
134
|
+
* snapshot: rev,
|
|
135
|
+
* deltaCursor: rev,
|
|
136
|
+
* total: await countProducts(scope, rev),
|
|
137
|
+
* };
|
|
138
|
+
* },
|
|
139
|
+
* async delta({ since, scope }) {
|
|
140
|
+
* const rows = await sql`
|
|
141
|
+
* SELECT id, name, price, category, rev, is_deleted FROM products
|
|
142
|
+
* WHERE store_id = ${scope} AND rev > ${since}`;
|
|
143
|
+
* const now = String(await currentRevision());
|
|
144
|
+
* return {
|
|
145
|
+
* changed: rows.filter((r) => !r.is_deleted),
|
|
146
|
+
* deleted: rows.filter((r) => r.is_deleted).map((r) => r.id),
|
|
147
|
+
* cursor: now,
|
|
148
|
+
* };
|
|
149
|
+
* },
|
|
150
|
+
* });
|
|
151
|
+
*/
|
|
152
|
+
declare function createReplicationHandlers(options: CreateReplicationHandlersOptions): ReplicationHandlers;
|
|
153
|
+
|
|
3
154
|
/** The fields of a TalaDB change record the store keys on. Everything else in
|
|
4
155
|
* a record is opaque — store it verbatim. */
|
|
5
156
|
interface ChangeRecord {
|
|
@@ -82,4 +233,4 @@ declare function memorySyncStore(): SyncStore;
|
|
|
82
233
|
*/
|
|
83
234
|
declare function taladbSyncStore(db: TalaDB, collectionName?: string): SyncStore;
|
|
84
235
|
|
|
85
|
-
export { type ChangeRecord, type CreateSyncHandlersOptions, type SyncHandlers, type SyncStore, createSyncHandlers, memorySyncStore, taladbSyncStore };
|
|
236
|
+
export { type BootstrapArgs, type BootstrapResult, type ChangeRecord, type CreateReplicationHandlersOptions, type CreateSyncHandlersOptions, type DeltaArgs, type DeltaResult, type ReplicationHandlers, type Row, type SyncHandlers, type SyncStore, createReplicationHandlers, createSyncHandlers, memorySyncStore, taladbSyncStore };
|
package/dist/server.js
CHANGED
|
@@ -20,11 +20,74 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
|
|
|
20
20
|
// src/server.ts
|
|
21
21
|
var server_exports = {};
|
|
22
22
|
__export(server_exports, {
|
|
23
|
+
createReplicationHandlers: () => createReplicationHandlers,
|
|
23
24
|
createSyncHandlers: () => createSyncHandlers,
|
|
24
25
|
memorySyncStore: () => memorySyncStore,
|
|
25
26
|
taladbSyncStore: () => taladbSyncStore
|
|
26
27
|
});
|
|
27
28
|
module.exports = __toCommonJS(server_exports);
|
|
29
|
+
|
|
30
|
+
// src/replication.ts
|
|
31
|
+
var json = (body, status = 200) => new Response(JSON.stringify(body), {
|
|
32
|
+
status,
|
|
33
|
+
headers: { "content-type": "application/json" }
|
|
34
|
+
});
|
|
35
|
+
function createReplicationHandlers(options) {
|
|
36
|
+
const {
|
|
37
|
+
bootstrap,
|
|
38
|
+
delta,
|
|
39
|
+
authorize,
|
|
40
|
+
maxLimit = 1e3,
|
|
41
|
+
defaultLimit = 500
|
|
42
|
+
} = options;
|
|
43
|
+
return {
|
|
44
|
+
async GET(req) {
|
|
45
|
+
let scope = "default";
|
|
46
|
+
if (authorize) {
|
|
47
|
+
const result2 = await authorize(req);
|
|
48
|
+
if (!result2) return json({ error: "unauthorized" }, 401);
|
|
49
|
+
scope = result2;
|
|
50
|
+
}
|
|
51
|
+
const url = new URL(req.url);
|
|
52
|
+
const since = url.searchParams.get("since");
|
|
53
|
+
if (since !== null) {
|
|
54
|
+
if (!delta) {
|
|
55
|
+
return json(
|
|
56
|
+
{
|
|
57
|
+
error: "this endpoint has no delta feed; the client cannot refresh incrementally and deletions will never propagate"
|
|
58
|
+
},
|
|
59
|
+
501
|
|
60
|
+
);
|
|
61
|
+
}
|
|
62
|
+
const result2 = await delta({ since, scope });
|
|
63
|
+
return json({
|
|
64
|
+
data: result2.changed,
|
|
65
|
+
deleted: result2.deleted,
|
|
66
|
+
cursor: result2.cursor,
|
|
67
|
+
hasMore: result2.hasMore ?? false
|
|
68
|
+
});
|
|
69
|
+
}
|
|
70
|
+
const rawLimit = Number(url.searchParams.get("limit") ?? defaultLimit);
|
|
71
|
+
const limit = Number.isFinite(rawLimit) && rawLimit > 0 ? Math.min(Math.floor(rawLimit), maxLimit) : defaultLimit;
|
|
72
|
+
const pageParam = url.searchParams.get("page");
|
|
73
|
+
const result = await bootstrap({
|
|
74
|
+
page: pageParam === null ? null : pageParam,
|
|
75
|
+
limit,
|
|
76
|
+
snapshot: url.searchParams.get("snapshot"),
|
|
77
|
+
scope
|
|
78
|
+
});
|
|
79
|
+
return json({
|
|
80
|
+
data: result.rows,
|
|
81
|
+
nextPage: result.nextPage,
|
|
82
|
+
...result.snapshot !== void 0 ? { snapshot: result.snapshot } : {},
|
|
83
|
+
...result.deltaCursor !== void 0 ? { deltaCursor: result.deltaCursor } : {},
|
|
84
|
+
...result.total !== void 0 ? { total: result.total } : {}
|
|
85
|
+
});
|
|
86
|
+
}
|
|
87
|
+
};
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
// src/server.ts
|
|
28
91
|
function createSyncHandlers(options) {
|
|
29
92
|
const { store } = options;
|
|
30
93
|
const maxBodyBytes = options.maxBodyBytes ?? 1024 * 1024;
|
|
@@ -162,6 +225,7 @@ function taladbSyncStore(db, collectionName = "sync_changes") {
|
|
|
162
225
|
}
|
|
163
226
|
// Annotate the CommonJS export names for ESM import in node:
|
|
164
227
|
0 && (module.exports = {
|
|
228
|
+
createReplicationHandlers,
|
|
165
229
|
createSyncHandlers,
|
|
166
230
|
memorySyncStore,
|
|
167
231
|
taladbSyncStore
|
package/dist/server.mjs
CHANGED
|
@@ -1,3 +1,63 @@
|
|
|
1
|
+
// src/replication.ts
|
|
2
|
+
var json = (body, status = 200) => new Response(JSON.stringify(body), {
|
|
3
|
+
status,
|
|
4
|
+
headers: { "content-type": "application/json" }
|
|
5
|
+
});
|
|
6
|
+
function createReplicationHandlers(options) {
|
|
7
|
+
const {
|
|
8
|
+
bootstrap,
|
|
9
|
+
delta,
|
|
10
|
+
authorize,
|
|
11
|
+
maxLimit = 1e3,
|
|
12
|
+
defaultLimit = 500
|
|
13
|
+
} = options;
|
|
14
|
+
return {
|
|
15
|
+
async GET(req) {
|
|
16
|
+
let scope = "default";
|
|
17
|
+
if (authorize) {
|
|
18
|
+
const result2 = await authorize(req);
|
|
19
|
+
if (!result2) return json({ error: "unauthorized" }, 401);
|
|
20
|
+
scope = result2;
|
|
21
|
+
}
|
|
22
|
+
const url = new URL(req.url);
|
|
23
|
+
const since = url.searchParams.get("since");
|
|
24
|
+
if (since !== null) {
|
|
25
|
+
if (!delta) {
|
|
26
|
+
return json(
|
|
27
|
+
{
|
|
28
|
+
error: "this endpoint has no delta feed; the client cannot refresh incrementally and deletions will never propagate"
|
|
29
|
+
},
|
|
30
|
+
501
|
|
31
|
+
);
|
|
32
|
+
}
|
|
33
|
+
const result2 = await delta({ since, scope });
|
|
34
|
+
return json({
|
|
35
|
+
data: result2.changed,
|
|
36
|
+
deleted: result2.deleted,
|
|
37
|
+
cursor: result2.cursor,
|
|
38
|
+
hasMore: result2.hasMore ?? false
|
|
39
|
+
});
|
|
40
|
+
}
|
|
41
|
+
const rawLimit = Number(url.searchParams.get("limit") ?? defaultLimit);
|
|
42
|
+
const limit = Number.isFinite(rawLimit) && rawLimit > 0 ? Math.min(Math.floor(rawLimit), maxLimit) : defaultLimit;
|
|
43
|
+
const pageParam = url.searchParams.get("page");
|
|
44
|
+
const result = await bootstrap({
|
|
45
|
+
page: pageParam === null ? null : pageParam,
|
|
46
|
+
limit,
|
|
47
|
+
snapshot: url.searchParams.get("snapshot"),
|
|
48
|
+
scope
|
|
49
|
+
});
|
|
50
|
+
return json({
|
|
51
|
+
data: result.rows,
|
|
52
|
+
nextPage: result.nextPage,
|
|
53
|
+
...result.snapshot !== void 0 ? { snapshot: result.snapshot } : {},
|
|
54
|
+
...result.deltaCursor !== void 0 ? { deltaCursor: result.deltaCursor } : {},
|
|
55
|
+
...result.total !== void 0 ? { total: result.total } : {}
|
|
56
|
+
});
|
|
57
|
+
}
|
|
58
|
+
};
|
|
59
|
+
}
|
|
60
|
+
|
|
1
61
|
// src/server.ts
|
|
2
62
|
function createSyncHandlers(options) {
|
|
3
63
|
const { store } = options;
|
|
@@ -135,6 +195,7 @@ function taladbSyncStore(db, collectionName = "sync_changes") {
|
|
|
135
195
|
};
|
|
136
196
|
}
|
|
137
197
|
export {
|
|
198
|
+
createReplicationHandlers,
|
|
138
199
|
createSyncHandlers,
|
|
139
200
|
memorySyncStore,
|
|
140
201
|
taladbSyncStore
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@taladb/next",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.10.0",
|
|
4
4
|
"description": "First-party Next.js integration for TalaDB — sync route handlers for the server, a SyncProvider for the client",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"exports": {
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
"offline",
|
|
27
27
|
"taladb"
|
|
28
28
|
],
|
|
29
|
-
"license": "
|
|
29
|
+
"license": "Apache-2.0",
|
|
30
30
|
"repository": {
|
|
31
31
|
"type": "git",
|
|
32
32
|
"url": "https://github.com/thinkgrid-labs/taladb.git",
|
|
@@ -40,9 +40,9 @@
|
|
|
40
40
|
"node": ">=18"
|
|
41
41
|
},
|
|
42
42
|
"peerDependencies": {
|
|
43
|
-
"@taladb/react": "^0.
|
|
43
|
+
"@taladb/react": "^0.10.0",
|
|
44
44
|
"react": ">=18.0.0",
|
|
45
|
-
"taladb": "^0.
|
|
45
|
+
"taladb": "^0.10.0"
|
|
46
46
|
},
|
|
47
47
|
"peerDependenciesMeta": {
|
|
48
48
|
"@taladb/react": {
|
|
@@ -59,9 +59,9 @@
|
|
|
59
59
|
"tsup": "^8.0.0",
|
|
60
60
|
"typescript": "^5.9.3",
|
|
61
61
|
"vitest": "^3.2.0",
|
|
62
|
-
"@taladb/
|
|
63
|
-
"@taladb/
|
|
64
|
-
"taladb": "0.
|
|
62
|
+
"@taladb/react": "0.10.0",
|
|
63
|
+
"@taladb/node": "0.10.0",
|
|
64
|
+
"taladb": "0.10.0"
|
|
65
65
|
},
|
|
66
66
|
"scripts": {
|
|
67
67
|
"build": "tsup",
|