@authoric/js 0.0.0-stage → 0.1.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 +21 -0
- package/README.md +94 -3
- package/bin/authoric.mjs +340 -0
- package/dist/cjs/app-actions.js +40 -0
- package/dist/cjs/app-actions.js.map +1 -0
- package/dist/cjs/auth.js +335 -0
- package/dist/cjs/auth.js.map +1 -0
- package/dist/cjs/client.js +121 -0
- package/dist/cjs/client.js.map +1 -0
- package/dist/cjs/cookies.js +137 -0
- package/dist/cjs/cookies.js.map +1 -0
- package/dist/cjs/data.js +197 -0
- package/dist/cjs/data.js.map +1 -0
- package/dist/cjs/errors.js +70 -0
- package/dist/cjs/errors.js.map +1 -0
- package/dist/cjs/files.js +188 -0
- package/dist/cjs/files.js.map +1 -0
- package/dist/cjs/generated/error-codes.js +433 -0
- package/dist/cjs/generated/error-codes.js.map +1 -0
- package/dist/cjs/index.js +31 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/package.json +3 -0
- package/dist/cjs/realtime.js +191 -0
- package/dist/cjs/realtime.js.map +1 -0
- package/dist/cjs/routes.js +113 -0
- package/dist/cjs/routes.js.map +1 -0
- package/dist/cjs/session.js +430 -0
- package/dist/cjs/session.js.map +1 -0
- package/dist/cjs/storage-adapters.js +83 -0
- package/dist/cjs/storage-adapters.js.map +1 -0
- package/dist/cjs/teams.js +152 -0
- package/dist/cjs/teams.js.map +1 -0
- package/dist/cjs/transport.js +189 -0
- package/dist/cjs/transport.js.map +1 -0
- package/dist/cjs/types.js +7 -0
- package/dist/cjs/types.js.map +1 -0
- package/dist/esm/app-actions.d.ts +32 -0
- package/dist/esm/app-actions.d.ts.map +1 -0
- package/dist/esm/app-actions.js +37 -0
- package/dist/esm/app-actions.js.map +1 -0
- package/dist/esm/auth.d.ts +259 -0
- package/dist/esm/auth.d.ts.map +1 -0
- package/dist/esm/auth.js +331 -0
- package/dist/esm/auth.js.map +1 -0
- package/dist/esm/client.d.ts +82 -0
- package/dist/esm/client.d.ts.map +1 -0
- package/dist/esm/client.js +115 -0
- package/dist/esm/client.js.map +1 -0
- package/dist/esm/cookies.d.ts +66 -0
- package/dist/esm/cookies.d.ts.map +1 -0
- package/dist/esm/cookies.js +129 -0
- package/dist/esm/cookies.js.map +1 -0
- package/dist/esm/data.d.ts +211 -0
- package/dist/esm/data.d.ts.map +1 -0
- package/dist/esm/data.js +191 -0
- package/dist/esm/data.js.map +1 -0
- package/dist/esm/errors.d.ts +61 -0
- package/dist/esm/errors.d.ts.map +1 -0
- package/dist/esm/errors.js +63 -0
- package/dist/esm/errors.js.map +1 -0
- package/dist/esm/files.d.ts +76 -0
- package/dist/esm/files.d.ts.map +1 -0
- package/dist/esm/files.js +184 -0
- package/dist/esm/files.js.map +1 -0
- package/dist/esm/generated/error-codes.d.ts +5 -0
- package/dist/esm/generated/error-codes.d.ts.map +1 -0
- package/dist/esm/generated/error-codes.js +430 -0
- package/dist/esm/generated/error-codes.js.map +1 -0
- package/dist/esm/index.d.ts +22 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +9 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/realtime.d.ts +33 -0
- package/dist/esm/realtime.d.ts.map +1 -0
- package/dist/esm/realtime.js +186 -0
- package/dist/esm/realtime.js.map +1 -0
- package/dist/esm/routes.d.ts +75 -0
- package/dist/esm/routes.d.ts.map +1 -0
- package/dist/esm/routes.js +108 -0
- package/dist/esm/routes.js.map +1 -0
- package/dist/esm/session.d.ts +99 -0
- package/dist/esm/session.d.ts.map +1 -0
- package/dist/esm/session.js +425 -0
- package/dist/esm/session.js.map +1 -0
- package/dist/esm/storage-adapters.d.ts +31 -0
- package/dist/esm/storage-adapters.d.ts.map +1 -0
- package/dist/esm/storage-adapters.js +76 -0
- package/dist/esm/storage-adapters.js.map +1 -0
- package/dist/esm/teams.d.ts +157 -0
- package/dist/esm/teams.d.ts.map +1 -0
- package/dist/esm/teams.js +146 -0
- package/dist/esm/teams.js.map +1 -0
- package/dist/esm/transport.d.ts +56 -0
- package/dist/esm/transport.d.ts.map +1 -0
- package/dist/esm/transport.js +185 -0
- package/dist/esm/transport.js.map +1 -0
- package/dist/esm/types.d.ts +203 -0
- package/dist/esm/types.d.ts.map +1 -0
- package/dist/esm/types.js +6 -0
- package/dist/esm/types.js.map +1 -0
- package/package.json +54 -6
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
// Governed realtime: a table's row changes over Server-Sent Events.
|
|
2
|
+
//
|
|
3
|
+
// Native EventSource cannot send an Authorization header, so this is SSE over fetch: one GET with the
|
|
4
|
+
// bearer token, read as a stream, parsed per the SSE spec. It reconnects with backoff and jitter,
|
|
5
|
+
// resumes from the last event id (the server backfills from its outbox), and refreshes the token when
|
|
6
|
+
// the server says it expired. A refusal that will not change on retry (signed out, no permission, no
|
|
7
|
+
// such table) stops it and is reported once.
|
|
8
|
+
import { AuthoricError, clientError } from "./errors.js";
|
|
9
|
+
import { ROUTES } from "./routes.js";
|
|
10
|
+
/** Split an SSE byte stream into messages (https://html.spec.whatwg.org/#event-stream-interpretation). */
|
|
11
|
+
export async function* parseSse(stream) {
|
|
12
|
+
const reader = stream.getReader();
|
|
13
|
+
const decoder = new TextDecoder();
|
|
14
|
+
let buffer = "";
|
|
15
|
+
let event = "";
|
|
16
|
+
let data = [];
|
|
17
|
+
let id = null;
|
|
18
|
+
try {
|
|
19
|
+
for (;;) {
|
|
20
|
+
const { value, done } = await reader.read();
|
|
21
|
+
if (done)
|
|
22
|
+
break;
|
|
23
|
+
buffer += decoder.decode(value, { stream: true });
|
|
24
|
+
let index;
|
|
25
|
+
while ((index = buffer.search(/\r\n|\r|\n/)) !== -1) {
|
|
26
|
+
const line = buffer.slice(0, index);
|
|
27
|
+
const newline = buffer[index] === "\r" && buffer[index + 1] === "\n" ? 2 : 1;
|
|
28
|
+
buffer = buffer.slice(index + newline);
|
|
29
|
+
if (line === "") {
|
|
30
|
+
if (data.length > 0)
|
|
31
|
+
yield { event: event || "message", data: data.join("\n"), id };
|
|
32
|
+
event = "";
|
|
33
|
+
data = [];
|
|
34
|
+
continue;
|
|
35
|
+
}
|
|
36
|
+
if (line.startsWith(":"))
|
|
37
|
+
continue;
|
|
38
|
+
const colon = line.indexOf(":");
|
|
39
|
+
const field = colon === -1 ? line : line.slice(0, colon);
|
|
40
|
+
let fieldValue = colon === -1 ? "" : line.slice(colon + 1);
|
|
41
|
+
if (fieldValue.startsWith(" "))
|
|
42
|
+
fieldValue = fieldValue.slice(1);
|
|
43
|
+
if (field === "event")
|
|
44
|
+
event = fieldValue;
|
|
45
|
+
else if (field === "data")
|
|
46
|
+
data.push(fieldValue);
|
|
47
|
+
else if (field === "id" && !fieldValue.includes("\u0000"))
|
|
48
|
+
id = fieldValue;
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
finally {
|
|
53
|
+
reader.releaseLock();
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
const STOP_STATUSES = new Set([400, 401, 403, 404, 423]);
|
|
57
|
+
const jitter = (ms) => Math.round(ms / 2 + Math.random() * (ms / 2));
|
|
58
|
+
export const subscribeToTable = (transport, session, table, handler, options = {}) => {
|
|
59
|
+
const controller = new AbortController();
|
|
60
|
+
const maxBackoff = options.maxBackoffMs ?? 30000;
|
|
61
|
+
let lastEventId = options.lastEventId ?? null;
|
|
62
|
+
let closed = false;
|
|
63
|
+
const report = (error, willRetry) => {
|
|
64
|
+
try {
|
|
65
|
+
options.onError?.(error, { willRetry });
|
|
66
|
+
}
|
|
67
|
+
catch {
|
|
68
|
+
// The app's handler must not break the stream.
|
|
69
|
+
}
|
|
70
|
+
};
|
|
71
|
+
const deliver = (message) => {
|
|
72
|
+
if (message.id)
|
|
73
|
+
lastEventId = message.id;
|
|
74
|
+
if (message.event === "connected") {
|
|
75
|
+
try {
|
|
76
|
+
options.onOpen?.();
|
|
77
|
+
}
|
|
78
|
+
catch {
|
|
79
|
+
// as above
|
|
80
|
+
}
|
|
81
|
+
return;
|
|
82
|
+
}
|
|
83
|
+
let payload;
|
|
84
|
+
try {
|
|
85
|
+
payload = JSON.parse(message.data);
|
|
86
|
+
}
|
|
87
|
+
catch {
|
|
88
|
+
return;
|
|
89
|
+
}
|
|
90
|
+
const eventId = message.id;
|
|
91
|
+
let change = null;
|
|
92
|
+
if (message.event === "resync") {
|
|
93
|
+
change = { op: "resync", table, reason: String(payload.reason ?? "resync"), eventId };
|
|
94
|
+
}
|
|
95
|
+
else if (payload.op === "delete" && typeof payload.rowUid === "string") {
|
|
96
|
+
change = { op: "delete", table: String(payload.table ?? table), rowUid: payload.rowUid, eventId };
|
|
97
|
+
}
|
|
98
|
+
else if ((payload.op === "insert" || payload.op === "update") && payload.row && typeof payload.row === "object") {
|
|
99
|
+
change = { op: payload.op, table: String(payload.table ?? table), row: payload.row, eventId };
|
|
100
|
+
}
|
|
101
|
+
if (!change)
|
|
102
|
+
return;
|
|
103
|
+
try {
|
|
104
|
+
handler(change);
|
|
105
|
+
}
|
|
106
|
+
catch {
|
|
107
|
+
// as above
|
|
108
|
+
}
|
|
109
|
+
};
|
|
110
|
+
const pause = (ms) => new Promise((resolve) => {
|
|
111
|
+
const timer = setTimeout(resolve, Math.min(ms, maxBackoff));
|
|
112
|
+
controller.signal.addEventListener("abort", () => {
|
|
113
|
+
clearTimeout(timer);
|
|
114
|
+
resolve();
|
|
115
|
+
}, { once: true });
|
|
116
|
+
});
|
|
117
|
+
const run = async () => {
|
|
118
|
+
let backoff = 1000;
|
|
119
|
+
let refreshed = false;
|
|
120
|
+
while (!closed) {
|
|
121
|
+
const opened = Date.now();
|
|
122
|
+
try {
|
|
123
|
+
const response = await transport.request(ROUTES.rowsSubscribe, {
|
|
124
|
+
params: { table },
|
|
125
|
+
headers: lastEventId ? { "Last-Event-ID": lastEventId } : undefined,
|
|
126
|
+
accept: "text/event-stream",
|
|
127
|
+
responseType: "response",
|
|
128
|
+
signal: controller.signal,
|
|
129
|
+
});
|
|
130
|
+
if (!response.body)
|
|
131
|
+
throw clientError("AUTHORIC_BAD_RESPONSE", "The subscription returned no stream.");
|
|
132
|
+
backoff = 1000;
|
|
133
|
+
refreshed = false;
|
|
134
|
+
for await (const message of parseSse(response.body)) {
|
|
135
|
+
if (closed)
|
|
136
|
+
break;
|
|
137
|
+
deliver(message);
|
|
138
|
+
}
|
|
139
|
+
// The server closed the stream (a deploy, an idle timeout): reconnect and resume. A stream
|
|
140
|
+
// that closes at once, again and again, backs off like a failure rather than spinning.
|
|
141
|
+
if (!closed && Date.now() - opened < 10000) {
|
|
142
|
+
await pause(jitter(backoff));
|
|
143
|
+
backoff = Math.min(maxBackoff, backoff * 2);
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
catch (error) {
|
|
147
|
+
if (closed || controller.signal.aborted)
|
|
148
|
+
return;
|
|
149
|
+
const failure = error instanceof AuthoricError
|
|
150
|
+
? error
|
|
151
|
+
: clientError("AUTHORIC_NETWORK_ERROR", "The subscription's connection dropped.", error);
|
|
152
|
+
// The transport already refreshed once on an expired token; one more try after a long-lived
|
|
153
|
+
// stream outlived its token is still fine, then a 401 is final.
|
|
154
|
+
if (failure.status === 401 && !refreshed && failure.code !== "SESSION_ENDED") {
|
|
155
|
+
refreshed = true;
|
|
156
|
+
const renewed = await session.refresh({ force: true }).catch(() => null);
|
|
157
|
+
if (renewed)
|
|
158
|
+
continue;
|
|
159
|
+
}
|
|
160
|
+
if (failure.code === "AUTHORIC_NOT_SIGNED_IN" || STOP_STATUSES.has(failure.status ?? 0)) {
|
|
161
|
+
closed = true;
|
|
162
|
+
report(failure, false);
|
|
163
|
+
return;
|
|
164
|
+
}
|
|
165
|
+
report(failure, true);
|
|
166
|
+
const wait = failure.retryAfterSeconds != null ? failure.retryAfterSeconds * 1000 : jitter(backoff);
|
|
167
|
+
backoff = Math.min(maxBackoff, backoff * 2);
|
|
168
|
+
await pause(wait);
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
};
|
|
172
|
+
void run();
|
|
173
|
+
return {
|
|
174
|
+
close() {
|
|
175
|
+
closed = true;
|
|
176
|
+
controller.abort();
|
|
177
|
+
},
|
|
178
|
+
get lastEventId() {
|
|
179
|
+
return lastEventId;
|
|
180
|
+
},
|
|
181
|
+
get closed() {
|
|
182
|
+
return closed;
|
|
183
|
+
},
|
|
184
|
+
};
|
|
185
|
+
};
|
|
186
|
+
//# sourceMappingURL=realtime.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"realtime.js","sourceRoot":"","sources":["../../src/realtime.ts"],"names":[],"mappings":"AAAA,oEAAoE;AACpE,EAAE;AACF,sGAAsG;AACtG,kGAAkG;AAClG,sGAAsG;AACtG,qGAAqG;AACrG,6CAA6C;AAC7C,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AA8BrC,0GAA0G;AAC1G,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,QAAQ,CAAC,MAAkC;IACjE,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;IAClC,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;IAClC,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,IAAI,IAAI,GAAa,EAAE,CAAC;IACxB,IAAI,EAAE,GAAkB,IAAI,CAAC;IAC7B,IAAI,CAAC;QACJ,SAAS,CAAC;YACT,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;YAC5C,IAAI,IAAI;gBAAE,MAAM;YAChB,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;YAClD,IAAI,KAAa,CAAC;YAClB,OAAO,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBACrD,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBACpC,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC7E,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,OAAO,CAAC,CAAC;gBACvC,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;oBACjB,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;wBAAE,MAAM,EAAE,KAAK,EAAE,KAAK,IAAI,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC;oBACpF,KAAK,GAAG,EAAE,CAAC;oBACX,IAAI,GAAG,EAAE,CAAC;oBACV,SAAS;gBACV,CAAC;gBACD,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;oBAAE,SAAS;gBACnC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBAChC,MAAM,KAAK,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBACzD,IAAI,UAAU,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;gBAC3D,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC;oBAAE,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACjE,IAAI,KAAK,KAAK,OAAO;oBAAE,KAAK,GAAG,UAAU,CAAC;qBACrC,IAAI,KAAK,KAAK,MAAM;oBAAE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;qBAC5C,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC;oBAAE,EAAE,GAAG,UAAU,CAAC;YAC5E,CAAC;QACF,CAAC;IACF,CAAC;YAAS,CAAC;QACV,MAAM,CAAC,WAAW,EAAE,CAAC;IACtB,CAAC;AACF,CAAC;AAED,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAEzD,MAAM,MAAM,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;AAE7E,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC/B,SAAoB,EACpB,OAAuB,EACvB,KAAa,EACb,OAA0C,EAC1C,UAA4B,EAAE,EACf,EAAE;IACjB,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;IACzC,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,IAAI,KAAM,CAAC;IAClD,IAAI,WAAW,GAAkB,OAAO,CAAC,WAAW,IAAI,IAAI,CAAC;IAC7D,IAAI,MAAM,GAAG,KAAK,CAAC;IAEnB,MAAM,MAAM,GAAG,CAAC,KAAoB,EAAE,SAAkB,EAAE,EAAE;QAC3D,IAAI,CAAC;YACJ,OAAO,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QACzC,CAAC;QAAC,MAAM,CAAC;YACR,+CAA+C;QAChD,CAAC;IACF,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,CAAC,OAAmB,EAAE,EAAE;QACvC,IAAI,OAAO,CAAC,EAAE;YAAE,WAAW,GAAG,OAAO,CAAC,EAAE,CAAC;QACzC,IAAI,OAAO,CAAC,KAAK,KAAK,WAAW,EAAE,CAAC;YACnC,IAAI,CAAC;gBACJ,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;YACpB,CAAC;YAAC,MAAM,CAAC;gBACR,WAAW;YACZ,CAAC;YACD,OAAO;QACR,CAAC;QACD,IAAI,OAAgC,CAAC;QACrC,IAAI,CAAC;YACJ,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;QAAC,MAAM,CAAC;YACR,OAAO;QACR,CAAC;QACD,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,CAAC;QAC3B,IAAI,MAAM,GAA4B,IAAI,CAAC;QAC3C,IAAI,OAAO,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YAChC,MAAM,GAAG,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,IAAI,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;QACvF,CAAC;aAAM,IAAI,OAAO,CAAC,EAAE,KAAK,QAAQ,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC1E,MAAM,GAAG,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;QACnG,CAAC;aAAM,IAAI,CAAC,OAAO,CAAC,EAAE,KAAK,QAAQ,IAAI,OAAO,CAAC,EAAE,KAAK,QAAQ,CAAC,IAAI,OAAO,CAAC,GAAG,IAAI,OAAO,OAAO,CAAC,GAAG,KAAK,QAAQ,EAAE,CAAC;YACnH,MAAM,GAAG,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAU,EAAE,OAAO,EAAE,CAAC;QACtG,CAAC;QACD,IAAI,CAAC,MAAM;YAAE,OAAO;QACpB,IAAI,CAAC;YACJ,OAAO,CAAC,MAAM,CAAC,CAAC;QACjB,CAAC;QAAC,MAAM,CAAC;YACR,WAAW;QACZ,CAAC;IACF,CAAC,CAAC;IAEF,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,EAAE,CAC5B,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC;QAC5D,UAAU,CAAC,MAAM,CAAC,gBAAgB,CACjC,OAAO,EACP,GAAG,EAAE;YACJ,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,OAAO,EAAE,CAAC;QACX,CAAC,EACD,EAAE,IAAI,EAAE,IAAI,EAAE,CACd,CAAC;IACH,CAAC,CAAC,CAAC;IAEJ,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;QACtB,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,IAAI,SAAS,GAAG,KAAK,CAAC;QACtB,OAAO,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAC1B,IAAI,CAAC;gBACJ,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,OAAO,CAAW,MAAM,CAAC,aAAa,EAAE;oBACxE,MAAM,EAAE,EAAE,KAAK,EAAE;oBACjB,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS;oBACnE,MAAM,EAAE,mBAAmB;oBAC3B,YAAY,EAAE,UAAU;oBACxB,MAAM,EAAE,UAAU,CAAC,MAAM;iBACzB,CAAC,CAAC;gBACH,IAAI,CAAC,QAAQ,CAAC,IAAI;oBAAE,MAAM,WAAW,CAAC,uBAAuB,EAAE,sCAAsC,CAAC,CAAC;gBACvG,OAAO,GAAG,IAAI,CAAC;gBACf,SAAS,GAAG,KAAK,CAAC;gBAClB,IAAI,KAAK,EAAE,MAAM,OAAO,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;oBACrD,IAAI,MAAM;wBAAE,MAAM;oBAClB,OAAO,CAAC,OAAO,CAAC,CAAC;gBAClB,CAAC;gBACD,2FAA2F;gBAC3F,uFAAuF;gBACvF,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,GAAG,KAAM,EAAE,CAAC;oBAC7C,MAAM,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;oBAC7B,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC;gBAC7C,CAAC;YACF,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBAChB,IAAI,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,OAAO;oBAAE,OAAO;gBAChD,MAAM,OAAO,GACZ,KAAK,YAAY,aAAa;oBAC7B,CAAC,CAAC,KAAK;oBACP,CAAC,CAAC,WAAW,CAAC,wBAAwB,EAAE,wCAAwC,EAAE,KAAK,CAAC,CAAC;gBAC3F,4FAA4F;gBAC5F,gEAAgE;gBAChE,IAAI,OAAO,CAAC,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;oBAC9E,SAAS,GAAG,IAAI,CAAC;oBACjB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;oBACzE,IAAI,OAAO;wBAAE,SAAS;gBACvB,CAAC;gBACD,IAAI,OAAO,CAAC,IAAI,KAAK,wBAAwB,IAAI,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC,EAAE,CAAC;oBACzF,MAAM,GAAG,IAAI,CAAC;oBACd,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;oBACvB,OAAO;gBACR,CAAC;gBACD,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;gBACtB,MAAM,IAAI,GAAG,OAAO,CAAC,iBAAiB,IAAI,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBACpG,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC;gBAC5C,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;YACnB,CAAC;QACF,CAAC;IACF,CAAC,CAAC;IAEF,KAAK,GAAG,EAAE,CAAC;IAEX,OAAO;QACN,KAAK;YACJ,MAAM,GAAG,IAAI,CAAC;YACd,UAAU,CAAC,KAAK,EAAE,CAAC;QACpB,CAAC;QACD,IAAI,WAAW;YACd,OAAO,WAAW,CAAC;QACpB,CAAC;QACD,IAAI,MAAM;YACT,OAAO,MAAM,CAAC;QACf,CAAC;KACD,CAAC;AACH,CAAC,CAAC"}
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
export interface Route {
|
|
2
|
+
readonly method: "GET" | "POST" | "PATCH" | "DELETE";
|
|
3
|
+
readonly path: string;
|
|
4
|
+
}
|
|
5
|
+
export declare const ROUTES: Readonly<{
|
|
6
|
+
authMethods: Route;
|
|
7
|
+
signUp: Route;
|
|
8
|
+
signIn: Route;
|
|
9
|
+
passwordResetRequest: Route;
|
|
10
|
+
passwordResetConfirm: Route;
|
|
11
|
+
magicLinkRequest: Route;
|
|
12
|
+
magicLinkVerify: Route;
|
|
13
|
+
otpRequest: Route;
|
|
14
|
+
otpVerify: Route;
|
|
15
|
+
oauthStart: Route;
|
|
16
|
+
oauthExchange: Route;
|
|
17
|
+
mfaVerify: Route;
|
|
18
|
+
mfaResend: Route;
|
|
19
|
+
refresh: Route;
|
|
20
|
+
signOut: Route;
|
|
21
|
+
me: Route;
|
|
22
|
+
meUpdate: Route;
|
|
23
|
+
accountDelete: Route;
|
|
24
|
+
reverify: Route;
|
|
25
|
+
reverifyEmailCode: Route;
|
|
26
|
+
passwordChange: Route;
|
|
27
|
+
verifyEmailRequest: Route;
|
|
28
|
+
verifyEmailConfirm: Route;
|
|
29
|
+
emailChange: Route;
|
|
30
|
+
emailChangeConfirm: Route;
|
|
31
|
+
identitiesList: Route;
|
|
32
|
+
identityUpdate: Route;
|
|
33
|
+
identityRemove: Route;
|
|
34
|
+
mfaList: Route;
|
|
35
|
+
mfaEnroll: Route;
|
|
36
|
+
mfaConfirm: Route;
|
|
37
|
+
mfaRecoveryCodes: Route;
|
|
38
|
+
mfaForgetDevices: Route;
|
|
39
|
+
mfaForgetDevice: Route;
|
|
40
|
+
mfaSetEnabled: Route;
|
|
41
|
+
mfaRemove: Route;
|
|
42
|
+
orgSecurityGet: Route;
|
|
43
|
+
orgSecuritySet: Route;
|
|
44
|
+
sessionsList: Route;
|
|
45
|
+
sessionsRevokeAll: Route;
|
|
46
|
+
sessionRevoke: Route;
|
|
47
|
+
rowsList: Route;
|
|
48
|
+
rowCreate: Route;
|
|
49
|
+
rowGet: Route;
|
|
50
|
+
rowUpdate: Route;
|
|
51
|
+
rowDelete: Route;
|
|
52
|
+
rowsSubscribe: Route;
|
|
53
|
+
rowsAggregate: Route;
|
|
54
|
+
rowsBatch: Route;
|
|
55
|
+
storagesList: Route;
|
|
56
|
+
storageFiles: Route;
|
|
57
|
+
storageUpload: Route;
|
|
58
|
+
storagePresign: Route;
|
|
59
|
+
storageConfirm: Route;
|
|
60
|
+
storageCreateFolder: Route;
|
|
61
|
+
fileGet: Route;
|
|
62
|
+
fileUrl: Route;
|
|
63
|
+
fileContent: Route;
|
|
64
|
+
fileUpdate: Route;
|
|
65
|
+
fileDelete: Route;
|
|
66
|
+
}>;
|
|
67
|
+
export type RouteName = keyof typeof ROUTES;
|
|
68
|
+
/**
|
|
69
|
+
* A route's path with its `:params` filled. Every value is URL-encoded as ONE segment, so a value can
|
|
70
|
+
* never add a segment, climb with `..`, or start a query.
|
|
71
|
+
*/
|
|
72
|
+
export declare const fillPath: (path: string, params?: Record<string, string>) => string;
|
|
73
|
+
/** A custom endpoint action's path: `/autocrud/:table/actions/<path>`, each segment encoded. */
|
|
74
|
+
export declare const actionPath: (table: string, path: string) => string;
|
|
75
|
+
//# sourceMappingURL=routes.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../../src/routes.ts"],"names":[],"mappings":"AASA,MAAM,WAAW,KAAK;IACrB,QAAQ,CAAC,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;IACrD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACtB;AAID,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoEjB,CAAC;AAEH,MAAM,MAAM,SAAS,GAAG,MAAM,OAAO,MAAM,CAAC;AAE5C;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,MAAM,MAAM,EAAE,SAAQ,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,KAAG,MAQ1E,CAAC;AAKJ,gGAAgG;AAChG,eAAO,MAAM,UAAU,GAAI,OAAO,MAAM,EAAE,MAAM,MAAM,KAAG,MAYxD,CAAC"}
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
// Every API route the client SDK calls, in ONE table.
|
|
2
|
+
//
|
|
3
|
+
// The backend suite reads this file (api/tests/clientSdkRoutes.parity.test.js) and checks each entry
|
|
4
|
+
// against the server's own routers, so a route renamed on the server without the SDK moving fails
|
|
5
|
+
// there instead of in a customer's app. The same test refuses any platform, agent or MCP route: the
|
|
6
|
+
// client SDK speaks for an app's end users and nothing else.
|
|
7
|
+
//
|
|
8
|
+
// Paths are relative to `/{appUid}`. A `:name` segment is filled, URL-encoded, by `fillPath`.
|
|
9
|
+
const route = (method, path) => Object.freeze({ method, path });
|
|
10
|
+
export const ROUTES = Object.freeze({
|
|
11
|
+
// ── Sign-in: anonymous ──────────────────────────────────────────────────────────────────────
|
|
12
|
+
authMethods: route("GET", "/auth/methods"),
|
|
13
|
+
signUp: route("POST", "/auth/signup"),
|
|
14
|
+
signIn: route("POST", "/auth/login"),
|
|
15
|
+
passwordResetRequest: route("POST", "/auth/request-password-reset"),
|
|
16
|
+
passwordResetConfirm: route("POST", "/auth/confirm-password-reset"),
|
|
17
|
+
magicLinkRequest: route("POST", "/auth/magic-link/request"),
|
|
18
|
+
magicLinkVerify: route("POST", "/auth/magic-link/verify"),
|
|
19
|
+
otpRequest: route("POST", "/auth/otp/request"),
|
|
20
|
+
otpVerify: route("POST", "/auth/otp/verify"),
|
|
21
|
+
oauthStart: route("POST", "/auth/oauth/:provider/start"),
|
|
22
|
+
oauthExchange: route("POST", "/auth/oauth/exchange"),
|
|
23
|
+
mfaVerify: route("POST", "/auth/mfa/verify"),
|
|
24
|
+
mfaResend: route("POST", "/auth/mfa/resend"),
|
|
25
|
+
refresh: route("POST", "/auth/token"),
|
|
26
|
+
signOut: route("DELETE", "/auth/logout"),
|
|
27
|
+
// ── The signed-in user's own account ─────────────────────────────────────────────────────────
|
|
28
|
+
me: route("GET", "/auth/me"),
|
|
29
|
+
meUpdate: route("PATCH", "/auth/me"),
|
|
30
|
+
accountDelete: route("DELETE", "/auth/me"),
|
|
31
|
+
reverify: route("POST", "/auth/reverify"),
|
|
32
|
+
reverifyEmailCode: route("POST", "/auth/reverify/email-code"),
|
|
33
|
+
passwordChange: route("POST", "/auth/password"),
|
|
34
|
+
verifyEmailRequest: route("POST", "/auth/verify-email/request"),
|
|
35
|
+
verifyEmailConfirm: route("POST", "/auth/verify-email/confirm"),
|
|
36
|
+
emailChange: route("POST", "/auth/email"),
|
|
37
|
+
emailChangeConfirm: route("POST", "/auth/email/confirm"),
|
|
38
|
+
identitiesList: route("GET", "/auth/identities"),
|
|
39
|
+
identityUpdate: route("PATCH", "/auth/identities/:identityUid"),
|
|
40
|
+
identityRemove: route("DELETE", "/auth/identities/:identityUid"),
|
|
41
|
+
mfaList: route("GET", "/auth/mfa"),
|
|
42
|
+
mfaEnroll: route("POST", "/auth/mfa/enroll"),
|
|
43
|
+
mfaConfirm: route("POST", "/auth/mfa/confirm"),
|
|
44
|
+
mfaRecoveryCodes: route("POST", "/auth/mfa/recovery"),
|
|
45
|
+
mfaForgetDevices: route("DELETE", "/auth/mfa/devices"),
|
|
46
|
+
mfaForgetDevice: route("DELETE", "/auth/mfa/devices/:uid"),
|
|
47
|
+
mfaSetEnabled: route("PATCH", "/auth/mfa/:kind"),
|
|
48
|
+
mfaRemove: route("DELETE", "/auth/mfa/:kind"),
|
|
49
|
+
orgSecurityGet: route("GET", "/auth/org-security"),
|
|
50
|
+
orgSecuritySet: route("POST", "/auth/org-security"),
|
|
51
|
+
sessionsList: route("GET", "/auth/sessions"),
|
|
52
|
+
sessionsRevokeAll: route("DELETE", "/auth/sessions"),
|
|
53
|
+
sessionRevoke: route("DELETE", "/auth/sessions/:uid"),
|
|
54
|
+
// ── Data ─────────────────────────────────────────────────────────────────────────────────────
|
|
55
|
+
rowsList: route("GET", "/autocrud/:table"),
|
|
56
|
+
rowCreate: route("POST", "/autocrud/:table"),
|
|
57
|
+
rowGet: route("GET", "/autocrud/:table/:rowUid"),
|
|
58
|
+
rowUpdate: route("PATCH", "/autocrud/:table/:rowUid"),
|
|
59
|
+
rowDelete: route("DELETE", "/autocrud/:table/:rowUid"),
|
|
60
|
+
rowsSubscribe: route("GET", "/autocrud/:table/subscribe"),
|
|
61
|
+
rowsAggregate: route("GET", "/autocrud/:table/aggregate"),
|
|
62
|
+
rowsBatch: route("POST", "/autocrud/:table/batch"),
|
|
63
|
+
// ── Storage ──────────────────────────────────────────────────────────────────────────────────
|
|
64
|
+
storagesList: route("GET", "/storage"),
|
|
65
|
+
storageFiles: route("GET", "/storage/:storageUid/files"),
|
|
66
|
+
storageUpload: route("POST", "/storage/:storageUid/files"),
|
|
67
|
+
storagePresign: route("POST", "/storage/:storageUid/presign"),
|
|
68
|
+
storageConfirm: route("POST", "/storage/:storageUid/confirm"),
|
|
69
|
+
storageCreateFolder: route("POST", "/storage/:storageUid/folders"),
|
|
70
|
+
fileGet: route("GET", "/storage/files/:fileUid"),
|
|
71
|
+
fileUrl: route("GET", "/storage/files/:fileUid/url"),
|
|
72
|
+
fileContent: route("GET", "/storage/files/:fileUid/content"),
|
|
73
|
+
fileUpdate: route("PATCH", "/storage/files/:fileUid"),
|
|
74
|
+
fileDelete: route("DELETE", "/storage/files/:fileUid"),
|
|
75
|
+
});
|
|
76
|
+
/**
|
|
77
|
+
* A route's path with its `:params` filled. Every value is URL-encoded as ONE segment, so a value can
|
|
78
|
+
* never add a segment, climb with `..`, or start a query.
|
|
79
|
+
*/
|
|
80
|
+
export const fillPath = (path, params = {}) => path.replace(/:([A-Za-z]+)/g, (_match, name) => {
|
|
81
|
+
const value = params[name];
|
|
82
|
+
if (typeof value !== "string" || value.length === 0) {
|
|
83
|
+
throw new TypeError(`Missing path parameter "${name}"`);
|
|
84
|
+
}
|
|
85
|
+
if (value === "." || value === "..")
|
|
86
|
+
throw new TypeError(`Invalid path parameter "${name}"`);
|
|
87
|
+
return encodeSegment(value);
|
|
88
|
+
});
|
|
89
|
+
// encodeURIComponent leaves ":" alone, and a ":" in a filled path would read as a parameter.
|
|
90
|
+
const encodeSegment = (value) => encodeURIComponent(value).replace(/:/g, "%3A");
|
|
91
|
+
/** A custom endpoint action's path: `/autocrud/:table/actions/<path>`, each segment encoded. */
|
|
92
|
+
export const actionPath = (table, path) => {
|
|
93
|
+
const segments = String(path)
|
|
94
|
+
.split("/")
|
|
95
|
+
.filter((segment) => segment.length > 0);
|
|
96
|
+
// An action's stored path may carry the segment already ("/actions/invite"); the server
|
|
97
|
+
// normalizes both spellings to one route (helpers/getActionsURLSegment.js), and so does this.
|
|
98
|
+
if (segments[0]?.toLowerCase() === "actions")
|
|
99
|
+
segments.shift();
|
|
100
|
+
if (segments.length === 0)
|
|
101
|
+
throw new TypeError("An action needs a path, such as \"/invite\"");
|
|
102
|
+
for (const segment of segments) {
|
|
103
|
+
if (segment === "." || segment === "..")
|
|
104
|
+
throw new TypeError("An action path cannot contain . or ..");
|
|
105
|
+
}
|
|
106
|
+
return `${fillPath("/autocrud/:table", { table })}/actions/${segments.map(encodeSegment).join("/")}`;
|
|
107
|
+
};
|
|
108
|
+
//# sourceMappingURL=routes.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"routes.js","sourceRoot":"","sources":["../../src/routes.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,EAAE;AACF,qGAAqG;AACrG,kGAAkG;AAClG,oGAAoG;AACpG,6DAA6D;AAC7D,EAAE;AACF,8FAA8F;AAO9F,MAAM,KAAK,GAAG,CAAC,MAAuB,EAAE,IAAY,EAAS,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;AAEhG,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IACnC,+FAA+F;IAC/F,WAAW,EAAE,KAAK,CAAC,KAAK,EAAE,eAAe,CAAC;IAC1C,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,cAAc,CAAC;IACrC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC;IACpC,oBAAoB,EAAE,KAAK,CAAC,MAAM,EAAE,8BAA8B,CAAC;IACnE,oBAAoB,EAAE,KAAK,CAAC,MAAM,EAAE,8BAA8B,CAAC;IACnE,gBAAgB,EAAE,KAAK,CAAC,MAAM,EAAE,0BAA0B,CAAC;IAC3D,eAAe,EAAE,KAAK,CAAC,MAAM,EAAE,yBAAyB,CAAC;IACzD,UAAU,EAAE,KAAK,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAC9C,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,kBAAkB,CAAC;IAC5C,UAAU,EAAE,KAAK,CAAC,MAAM,EAAE,6BAA6B,CAAC;IACxD,aAAa,EAAE,KAAK,CAAC,MAAM,EAAE,sBAAsB,CAAC;IACpD,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,kBAAkB,CAAC;IAC5C,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,kBAAkB,CAAC;IAC5C,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC;IACrC,OAAO,EAAE,KAAK,CAAC,QAAQ,EAAE,cAAc,CAAC;IAExC,gGAAgG;IAChG,EAAE,EAAE,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC;IAC5B,QAAQ,EAAE,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC;IACpC,aAAa,EAAE,KAAK,CAAC,QAAQ,EAAE,UAAU,CAAC;IAC1C,QAAQ,EAAE,KAAK,CAAC,MAAM,EAAE,gBAAgB,CAAC;IACzC,iBAAiB,EAAE,KAAK,CAAC,MAAM,EAAE,2BAA2B,CAAC;IAC7D,cAAc,EAAE,KAAK,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAC/C,kBAAkB,EAAE,KAAK,CAAC,MAAM,EAAE,4BAA4B,CAAC;IAC/D,kBAAkB,EAAE,KAAK,CAAC,MAAM,EAAE,4BAA4B,CAAC;IAC/D,WAAW,EAAE,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC;IACzC,kBAAkB,EAAE,KAAK,CAAC,MAAM,EAAE,qBAAqB,CAAC;IACxD,cAAc,EAAE,KAAK,CAAC,KAAK,EAAE,kBAAkB,CAAC;IAChD,cAAc,EAAE,KAAK,CAAC,OAAO,EAAE,+BAA+B,CAAC;IAC/D,cAAc,EAAE,KAAK,CAAC,QAAQ,EAAE,+BAA+B,CAAC;IAChE,OAAO,EAAE,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC;IAClC,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,kBAAkB,CAAC;IAC5C,UAAU,EAAE,KAAK,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAC9C,gBAAgB,EAAE,KAAK,CAAC,MAAM,EAAE,oBAAoB,CAAC;IACrD,gBAAgB,EAAE,KAAK,CAAC,QAAQ,EAAE,mBAAmB,CAAC;IACtD,eAAe,EAAE,KAAK,CAAC,QAAQ,EAAE,wBAAwB,CAAC;IAC1D,aAAa,EAAE,KAAK,CAAC,OAAO,EAAE,iBAAiB,CAAC;IAChD,SAAS,EAAE,KAAK,CAAC,QAAQ,EAAE,iBAAiB,CAAC;IAC7C,cAAc,EAAE,KAAK,CAAC,KAAK,EAAE,oBAAoB,CAAC;IAClD,cAAc,EAAE,KAAK,CAAC,MAAM,EAAE,oBAAoB,CAAC;IACnD,YAAY,EAAE,KAAK,CAAC,KAAK,EAAE,gBAAgB,CAAC;IAC5C,iBAAiB,EAAE,KAAK,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpD,aAAa,EAAE,KAAK,CAAC,QAAQ,EAAE,qBAAqB,CAAC;IAErD,gGAAgG;IAChG,QAAQ,EAAE,KAAK,CAAC,KAAK,EAAE,kBAAkB,CAAC;IAC1C,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,kBAAkB,CAAC;IAC5C,MAAM,EAAE,KAAK,CAAC,KAAK,EAAE,0BAA0B,CAAC;IAChD,SAAS,EAAE,KAAK,CAAC,OAAO,EAAE,0BAA0B,CAAC;IACrD,SAAS,EAAE,KAAK,CAAC,QAAQ,EAAE,0BAA0B,CAAC;IACtD,aAAa,EAAE,KAAK,CAAC,KAAK,EAAE,4BAA4B,CAAC;IACzD,aAAa,EAAE,KAAK,CAAC,KAAK,EAAE,4BAA4B,CAAC;IACzD,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,wBAAwB,CAAC;IAElD,gGAAgG;IAChG,YAAY,EAAE,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC;IACtC,YAAY,EAAE,KAAK,CAAC,KAAK,EAAE,4BAA4B,CAAC;IACxD,aAAa,EAAE,KAAK,CAAC,MAAM,EAAE,4BAA4B,CAAC;IAC1D,cAAc,EAAE,KAAK,CAAC,MAAM,EAAE,8BAA8B,CAAC;IAC7D,cAAc,EAAE,KAAK,CAAC,MAAM,EAAE,8BAA8B,CAAC;IAC7D,mBAAmB,EAAE,KAAK,CAAC,MAAM,EAAE,8BAA8B,CAAC;IAClE,OAAO,EAAE,KAAK,CAAC,KAAK,EAAE,yBAAyB,CAAC;IAChD,OAAO,EAAE,KAAK,CAAC,KAAK,EAAE,6BAA6B,CAAC;IACpD,WAAW,EAAE,KAAK,CAAC,KAAK,EAAE,iCAAiC,CAAC;IAC5D,UAAU,EAAE,KAAK,CAAC,OAAO,EAAE,yBAAyB,CAAC;IACrD,UAAU,EAAE,KAAK,CAAC,QAAQ,EAAE,yBAAyB,CAAC;CACtD,CAAC,CAAC;AAIH;;;GAGG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,SAAiC,EAAE,EAAU,EAAE,CACrF,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,MAAM,EAAE,IAAY,EAAE,EAAE;IACtD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAC3B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrD,MAAM,IAAI,SAAS,CAAC,2BAA2B,IAAI,GAAG,CAAC,CAAC;IACzD,CAAC;IACD,IAAI,KAAK,KAAK,GAAG,IAAI,KAAK,KAAK,IAAI;QAAE,MAAM,IAAI,SAAS,CAAC,2BAA2B,IAAI,GAAG,CAAC,CAAC;IAC7F,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC,CAAC,CAAC;AAEJ,6FAA6F;AAC7F,MAAM,aAAa,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAExF,gGAAgG;AAChG,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,IAAY,EAAU,EAAE;IACjE,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC;SAC3B,KAAK,CAAC,GAAG,CAAC;SACV,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC1C,wFAAwF;IACxF,8FAA8F;IAC9F,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,KAAK,SAAS;QAAE,QAAQ,CAAC,KAAK,EAAE,CAAC;IAC/D,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAC;IAC9F,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAChC,IAAI,OAAO,KAAK,GAAG,IAAI,OAAO,KAAK,IAAI;YAAE,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;IACvG,CAAC;IACD,OAAO,GAAG,QAAQ,CAAC,kBAAkB,EAAE,EAAE,KAAK,EAAE,CAAC,YAAY,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;AACtG,CAAC,CAAC"}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import type { SessionStorageAdapter } from "./storage-adapters.js";
|
|
2
|
+
import type { Account, Session } from "./types.js";
|
|
3
|
+
export type SessionEvent = "signedIn" | "tokenRefreshed" | "signedOut" | "orgSwitched";
|
|
4
|
+
export interface SessionChange {
|
|
5
|
+
event: SessionEvent;
|
|
6
|
+
session: Session | null;
|
|
7
|
+
/** Why a session ended, when it did: the server's `SESSION_ENDED` reason, or "signed_out". */
|
|
8
|
+
reason?: string;
|
|
9
|
+
}
|
|
10
|
+
/** The raw exchange the session manager needs from the transport: POST /auth/token. */
|
|
11
|
+
export type RefreshExchange = (refreshToken: string, activeOrgUid?: string) => Promise<Record<string, unknown>>;
|
|
12
|
+
/**
|
|
13
|
+
* Every Authoric secret is labelled: `au_agent_` (an agent API key), `au_deploy_` (a deploy key),
|
|
14
|
+
* `au_approver_` (an approver token), and the legacy `plak_` agent key. None of them ever belongs in
|
|
15
|
+
* a client, which speaks only for an app's own signed-in users.
|
|
16
|
+
*/
|
|
17
|
+
export declare const SECRET_SHAPE: RegExp;
|
|
18
|
+
/** Refuse anything that is a secret rather than an end user's token. */
|
|
19
|
+
export declare const assertNotSecret: (token: unknown) => void;
|
|
20
|
+
export interface SessionManagerOptions {
|
|
21
|
+
appUid: string;
|
|
22
|
+
storage: SessionStorageAdapter;
|
|
23
|
+
exchange: RefreshExchange;
|
|
24
|
+
/** Tests and non-browser runtimes may pass their own; null disables cross-tab coordination. */
|
|
25
|
+
channel?: BroadcastChannelLike | null;
|
|
26
|
+
now?: () => number;
|
|
27
|
+
/** A server client's cookie keeps the access token too (createServerClient). Never set in a browser. */
|
|
28
|
+
persistAccessToken?: boolean;
|
|
29
|
+
}
|
|
30
|
+
export interface BroadcastChannelLike {
|
|
31
|
+
postMessage(message: unknown): void;
|
|
32
|
+
addEventListener(type: "message", listener: (event: {
|
|
33
|
+
data: unknown;
|
|
34
|
+
}) => void): void;
|
|
35
|
+
close(): void;
|
|
36
|
+
}
|
|
37
|
+
export declare class SessionManager {
|
|
38
|
+
private readonly appUid;
|
|
39
|
+
private readonly storage;
|
|
40
|
+
private readonly exchange;
|
|
41
|
+
private readonly channel;
|
|
42
|
+
private readonly now;
|
|
43
|
+
private readonly persistAccessToken;
|
|
44
|
+
private readonly listeners;
|
|
45
|
+
private accessToken;
|
|
46
|
+
private accessExpiresAt;
|
|
47
|
+
private record;
|
|
48
|
+
private loaded;
|
|
49
|
+
private inflight;
|
|
50
|
+
readonly storageKey: string;
|
|
51
|
+
readonly deviceKey: string;
|
|
52
|
+
constructor(options: SessionManagerOptions);
|
|
53
|
+
private load;
|
|
54
|
+
private readStored;
|
|
55
|
+
private snapshot;
|
|
56
|
+
getSession(): Promise<Session | null>;
|
|
57
|
+
/** A usable access token, refreshed first when it is missing or about to expire. Null when signed out. */
|
|
58
|
+
getAccessToken(): Promise<string | null>;
|
|
59
|
+
getDeviceToken(): Promise<string | null>;
|
|
60
|
+
onChange(listener: (change: SessionChange) => void): () => void;
|
|
61
|
+
private emit;
|
|
62
|
+
/**
|
|
63
|
+
* Adopt a session payload from a sign-in door (`{ …account, org, auth: { accessToken,
|
|
64
|
+
* refreshToken, activeOrgUid } }`) or from a refresh (`{ accessToken, refreshToken, activeOrgUid,
|
|
65
|
+
* org }`), the two shapes the API answers with.
|
|
66
|
+
*/
|
|
67
|
+
adopt(payload: Record<string, unknown>, event: SessionEvent): Promise<Session>;
|
|
68
|
+
/**
|
|
69
|
+
* Restore a session from a refresh token the app holds itself (server-side rendering, a native
|
|
70
|
+
* secure store). The next request mints an access token from it.
|
|
71
|
+
*/
|
|
72
|
+
setRefreshToken(refreshToken: string, user: Account): Promise<void>;
|
|
73
|
+
private setTokens;
|
|
74
|
+
private persist;
|
|
75
|
+
private safeSet;
|
|
76
|
+
private safeRemove;
|
|
77
|
+
/**
|
|
78
|
+
* Trade the refresh token for a fresh pair. One at a time in this page, and one at a time across
|
|
79
|
+
* every tab of the app. `force` refreshes even when the access token is still good (after the user
|
|
80
|
+
* adds a 2FA factor); `activeOrgUid` makes the exchange an org switch.
|
|
81
|
+
*/
|
|
82
|
+
refresh(options?: {
|
|
83
|
+
force?: boolean;
|
|
84
|
+
activeOrgUid?: string;
|
|
85
|
+
}): Promise<Session | null>;
|
|
86
|
+
private refreshLocked;
|
|
87
|
+
/** Forget the session in this page and every other tab. Local only: `auth.signOut()` also tells the server. */
|
|
88
|
+
end(reason?: string, { forgetDevice }?: {
|
|
89
|
+
forgetDevice?: boolean;
|
|
90
|
+
}): Promise<void>;
|
|
91
|
+
/** Keep the remembered account in step after the user changes it (a new name). */
|
|
92
|
+
updateUser(fields: Partial<Pick<Account, "fname" | "lname">>): Promise<void>;
|
|
93
|
+
/** The refresh token, for `auth.signOut()` to end the session on the server. Internal. */
|
|
94
|
+
currentRefreshToken(): Promise<string | null>;
|
|
95
|
+
private broadcast;
|
|
96
|
+
private onBroadcast;
|
|
97
|
+
close(): void;
|
|
98
|
+
}
|
|
99
|
+
//# sourceMappingURL=session.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"session.d.ts","sourceRoot":"","sources":["../../src/session.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,KAAK,EAAE,OAAO,EAAuB,OAAO,EAAc,MAAM,YAAY,CAAC;AAMpF,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,gBAAgB,GAAG,WAAW,GAAG,aAAa,CAAC;AAEvF,MAAM,WAAW,aAAa;IAC7B,KAAK,EAAE,YAAY,CAAC;IACpB,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACxB,8FAA8F;IAC9F,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAeD,uFAAuF;AACvF,MAAM,MAAM,eAAe,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAwChH;;;;GAIG;AACH,eAAO,MAAM,YAAY,QAAwC,CAAC;AAElE,wEAAwE;AACxE,eAAO,MAAM,eAAe,GAAI,OAAO,OAAO,SAO7C,CAAC;AAmBF,MAAM,WAAW,qBAAqB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,qBAAqB,CAAC;IAC/B,QAAQ,EAAE,eAAe,CAAC;IAC1B,+FAA+F;IAC/F,OAAO,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;IACtC,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;IACnB,wGAAwG;IACxG,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,oBAAoB;IACpC,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACpC,gBAAgB,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,GAAG,IAAI,CAAC;IACtF,KAAK,IAAI,IAAI,CAAC;CACd;AAED,qBAAa,cAAc;IAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAwB;IAChD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAkB;IAC3C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA8B;IACtD,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAe;IACnC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAU;IAC7C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA8C;IACxE,OAAO,CAAC,WAAW,CAAuB;IAC1C,OAAO,CAAC,eAAe,CAAuB;IAC9C,OAAO,CAAC,MAAM,CAA6B;IAC3C,OAAO,CAAC,MAAM,CAA8B;IAC5C,OAAO,CAAC,QAAQ,CAAwC;IAExD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;gBAEf,OAAO,EAAE,qBAAqB;YAc5B,IAAI;YAeJ,UAAU;IAmBxB,OAAO,CAAC,QAAQ;IAYV,UAAU,IAAI,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAK3C,0GAA0G;IACpG,cAAc,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAUxC,cAAc,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAQ9C,QAAQ,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,KAAK,IAAI,GAAG,MAAM,IAAI;IAO/D,OAAO,CAAC,IAAI;IAYZ;;;;OAIG;IACG,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IA4CpF;;;OAGG;IACG,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBzE,OAAO,CAAC,SAAS;YAMH,OAAO;YAOP,OAAO;YAWP,UAAU;IAUxB;;;;OAIG;IACH,OAAO,CAAC,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;YAmB5E,aAAa;IAuC3B,+GAA+G;IACzG,GAAG,CAAC,MAAM,SAAe,EAAE,EAAE,YAAoB,EAAE,GAAE;QAAE,YAAY,CAAC,EAAE,OAAO,CAAA;KAAO;IAY1F,kFAAkF;IAC5E,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAQlF,0FAA0F;IACpF,mBAAmB,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAOnD,OAAO,CAAC,SAAS;IAQjB,OAAO,CAAC,WAAW;IA6BnB,KAAK;CAIL"}
|