@syncular/relay 0.0.1-60
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/dist/client-role/forward-engine.d.ts +63 -0
- package/dist/client-role/forward-engine.d.ts.map +1 -0
- package/dist/client-role/forward-engine.js +263 -0
- package/dist/client-role/forward-engine.js.map +1 -0
- package/dist/client-role/index.d.ts +9 -0
- package/dist/client-role/index.d.ts.map +1 -0
- package/dist/client-role/index.js +9 -0
- package/dist/client-role/index.js.map +1 -0
- package/dist/client-role/pull-engine.d.ts +70 -0
- package/dist/client-role/pull-engine.d.ts.map +1 -0
- package/dist/client-role/pull-engine.js +233 -0
- package/dist/client-role/pull-engine.js.map +1 -0
- package/dist/client-role/sequence-mapper.d.ts +65 -0
- package/dist/client-role/sequence-mapper.d.ts.map +1 -0
- package/dist/client-role/sequence-mapper.js +161 -0
- package/dist/client-role/sequence-mapper.js.map +1 -0
- package/dist/index.d.ts +37 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +44 -0
- package/dist/index.js.map +1 -0
- package/dist/migrate.d.ts +18 -0
- package/dist/migrate.d.ts.map +1 -0
- package/dist/migrate.js +99 -0
- package/dist/migrate.js.map +1 -0
- package/dist/mode-manager.d.ts +60 -0
- package/dist/mode-manager.d.ts.map +1 -0
- package/dist/mode-manager.js +114 -0
- package/dist/mode-manager.js.map +1 -0
- package/dist/realtime.d.ts +102 -0
- package/dist/realtime.d.ts.map +1 -0
- package/dist/realtime.js +305 -0
- package/dist/realtime.js.map +1 -0
- package/dist/relay.d.ts +188 -0
- package/dist/relay.d.ts.map +1 -0
- package/dist/relay.js +315 -0
- package/dist/relay.js.map +1 -0
- package/dist/schema.d.ts +158 -0
- package/dist/schema.d.ts.map +1 -0
- package/dist/schema.js +7 -0
- package/dist/schema.js.map +1 -0
- package/dist/server-role/index.d.ts +54 -0
- package/dist/server-role/index.d.ts.map +1 -0
- package/dist/server-role/index.js +198 -0
- package/dist/server-role/index.js.map +1 -0
- package/dist/server-role/pull.d.ts +25 -0
- package/dist/server-role/pull.d.ts.map +1 -0
- package/dist/server-role/pull.js +24 -0
- package/dist/server-role/pull.js.map +1 -0
- package/dist/server-role/push.d.ts +27 -0
- package/dist/server-role/push.d.ts.map +1 -0
- package/dist/server-role/push.js +98 -0
- package/dist/server-role/push.js.map +1 -0
- package/package.json +61 -0
- package/src/__tests__/relay.test.ts +464 -0
- package/src/bun-types.d.ts +50 -0
- package/src/client-role/forward-engine.ts +352 -0
- package/src/client-role/index.ts +9 -0
- package/src/client-role/pull-engine.ts +301 -0
- package/src/client-role/sequence-mapper.ts +201 -0
- package/src/index.ts +50 -0
- package/src/migrate.ts +113 -0
- package/src/mode-manager.ts +142 -0
- package/src/realtime.ts +370 -0
- package/src/relay.ts +421 -0
- package/src/schema.ts +171 -0
- package/src/server-role/index.ts +342 -0
- package/src/server-role/pull.ts +37 -0
- package/src/server-role/push.ts +130 -0
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @syncular/relay - Realtime WebSocket Manager
|
|
3
|
+
*
|
|
4
|
+
* Manages WebSocket connections for local clients to receive
|
|
5
|
+
* instant notifications when data changes.
|
|
6
|
+
*
|
|
7
|
+
* Adapted from @syncular/server-hono/ws.ts for relay use.
|
|
8
|
+
*/
|
|
9
|
+
/**
|
|
10
|
+
* WebSocket event data for sync notifications.
|
|
11
|
+
*/
|
|
12
|
+
export interface RelayWebSocketEvent {
|
|
13
|
+
event: 'sync' | 'heartbeat' | 'error';
|
|
14
|
+
data: {
|
|
15
|
+
cursor?: number;
|
|
16
|
+
error?: string;
|
|
17
|
+
timestamp: number;
|
|
18
|
+
};
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* WebSocket connection interface for the relay.
|
|
22
|
+
*/
|
|
23
|
+
export interface RelayWebSocketConnection {
|
|
24
|
+
sendSync(cursor: number): void;
|
|
25
|
+
sendHeartbeat(): void;
|
|
26
|
+
sendError(message: string): void;
|
|
27
|
+
close(code?: number, reason?: string): void;
|
|
28
|
+
isOpen: boolean;
|
|
29
|
+
actorId: string;
|
|
30
|
+
clientId: string;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Realtime manager for relay WebSocket connections.
|
|
34
|
+
*
|
|
35
|
+
* Tracks active connections by client ID and scope key for
|
|
36
|
+
* efficient notification routing.
|
|
37
|
+
*/
|
|
38
|
+
export declare class RelayRealtime {
|
|
39
|
+
private connectionsByClientId;
|
|
40
|
+
private scopeKeysByClientId;
|
|
41
|
+
private connectionsByScopeKey;
|
|
42
|
+
private heartbeatIntervalMs;
|
|
43
|
+
private heartbeatTimer;
|
|
44
|
+
constructor(options?: {
|
|
45
|
+
heartbeatIntervalMs?: number;
|
|
46
|
+
});
|
|
47
|
+
/**
|
|
48
|
+
* Register a connection for a client.
|
|
49
|
+
* Returns a cleanup function to unregister.
|
|
50
|
+
*/
|
|
51
|
+
register(connection: RelayWebSocketConnection, initialScopeKeys?: string[]): () => void;
|
|
52
|
+
/**
|
|
53
|
+
* Update the effective tables/scopes for an already-connected client.
|
|
54
|
+
* In the new scope model, this is called with table names.
|
|
55
|
+
*/
|
|
56
|
+
updateClientTables(clientId: string, tables: string[]): void;
|
|
57
|
+
/**
|
|
58
|
+
* Alias for backwards compatibility.
|
|
59
|
+
*/
|
|
60
|
+
updateClientScopeKeys(clientId: string, scopeKeys: string[]): void;
|
|
61
|
+
private _updateScopeKeys;
|
|
62
|
+
/**
|
|
63
|
+
* Notify clients that new data is available for the given scopes.
|
|
64
|
+
*/
|
|
65
|
+
notifyScopeKeys(scopeKeys: string[], cursor: number, opts?: {
|
|
66
|
+
excludeClientIds?: string[];
|
|
67
|
+
}): void;
|
|
68
|
+
/**
|
|
69
|
+
* Get the number of active connections for a client.
|
|
70
|
+
*/
|
|
71
|
+
getConnectionCount(clientId: string): number;
|
|
72
|
+
/**
|
|
73
|
+
* Get total number of active connections.
|
|
74
|
+
*/
|
|
75
|
+
getTotalConnections(): number;
|
|
76
|
+
/**
|
|
77
|
+
* Close all connections for a client.
|
|
78
|
+
*/
|
|
79
|
+
closeClientConnections(clientId: string): void;
|
|
80
|
+
/**
|
|
81
|
+
* Close all connections.
|
|
82
|
+
*/
|
|
83
|
+
closeAll(): void;
|
|
84
|
+
private ensureHeartbeat;
|
|
85
|
+
private sendHeartbeats;
|
|
86
|
+
private unregister;
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* Create a WebSocket connection wrapper.
|
|
90
|
+
*
|
|
91
|
+
* Use this with your WebSocket library to create connections
|
|
92
|
+
* compatible with RelayRealtime.
|
|
93
|
+
*/
|
|
94
|
+
export declare function createRelayWebSocketConnection(ws: {
|
|
95
|
+
send(message: string): void;
|
|
96
|
+
close(code?: number, reason?: string): void;
|
|
97
|
+
readyState: number;
|
|
98
|
+
}, args: {
|
|
99
|
+
actorId: string;
|
|
100
|
+
clientId: string;
|
|
101
|
+
}): RelayWebSocketConnection;
|
|
102
|
+
//# sourceMappingURL=realtime.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"realtime.d.ts","sourceRoot":"","sources":["../src/realtime.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,GAAG,WAAW,GAAG,OAAO,CAAC;IACtC,IAAI,EAAE;QACJ,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,aAAa,IAAI,IAAI,CAAC;IACtB,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5C,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;GAKG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,qBAAqB,CAGzB;IACJ,OAAO,CAAC,mBAAmB,CAAkC;IAC7D,OAAO,CAAC,qBAAqB,CAGzB;IAEJ,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,cAAc,CAA+C;IAErE,YAAY,OAAO,CAAC,EAAE;QAAE,mBAAmB,CAAC,EAAE,MAAM,CAAA;KAAE,EAErD;IAED;;;OAGG;IACH,QAAQ,CACN,UAAU,EAAE,wBAAwB,EACpC,gBAAgB,GAAE,MAAM,EAAO,GAC9B,MAAM,IAAI,CA8BZ;IAED;;;OAGG;IACH,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAE3D;IAED;;OAEG;IACH,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAEjE;IAED,OAAO,CAAC,gBAAgB;IA0CxB;;OAEG;IACH,eAAe,CACb,SAAS,EAAE,MAAM,EAAE,EACnB,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE;QAAE,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GACrC,IAAI,CAeN;IAED;;OAEG;IACH,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAE3C;IAED;;OAEG;IACH,mBAAmB,IAAI,MAAM,CAM5B;IAED;;OAEG;IACH,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAmB7C;IAED;;OAEG;IACH,QAAQ,IAAI,IAAI,CAUf;IAED,OAAO,CAAC,eAAe;IAoBvB,OAAO,CAAC,cAAc;IAoBtB,OAAO,CAAC,UAAU;CAoBnB;AAED;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAC5C,EAAE,EAAE;IACF,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5C,UAAU,EAAE,MAAM,CAAC;CACpB,EACD,IAAI,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GAC1C,wBAAwB,CA2D1B"}
|
package/dist/realtime.js
ADDED
|
@@ -0,0 +1,305 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @syncular/relay - Realtime WebSocket Manager
|
|
3
|
+
*
|
|
4
|
+
* Manages WebSocket connections for local clients to receive
|
|
5
|
+
* instant notifications when data changes.
|
|
6
|
+
*
|
|
7
|
+
* Adapted from @syncular/server-hono/ws.ts for relay use.
|
|
8
|
+
*/
|
|
9
|
+
/**
|
|
10
|
+
* Realtime manager for relay WebSocket connections.
|
|
11
|
+
*
|
|
12
|
+
* Tracks active connections by client ID and scope key for
|
|
13
|
+
* efficient notification routing.
|
|
14
|
+
*/
|
|
15
|
+
export class RelayRealtime {
|
|
16
|
+
connectionsByClientId = new Map();
|
|
17
|
+
scopeKeysByClientId = new Map();
|
|
18
|
+
connectionsByScopeKey = new Map();
|
|
19
|
+
heartbeatIntervalMs;
|
|
20
|
+
heartbeatTimer = null;
|
|
21
|
+
constructor(options) {
|
|
22
|
+
this.heartbeatIntervalMs = options?.heartbeatIntervalMs ?? 30_000;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Register a connection for a client.
|
|
26
|
+
* Returns a cleanup function to unregister.
|
|
27
|
+
*/
|
|
28
|
+
register(connection, initialScopeKeys = []) {
|
|
29
|
+
const clientId = connection.clientId;
|
|
30
|
+
let clientConns = this.connectionsByClientId.get(clientId);
|
|
31
|
+
if (!clientConns) {
|
|
32
|
+
clientConns = new Set();
|
|
33
|
+
this.connectionsByClientId.set(clientId, clientConns);
|
|
34
|
+
}
|
|
35
|
+
clientConns.add(connection);
|
|
36
|
+
if (!this.scopeKeysByClientId.has(clientId)) {
|
|
37
|
+
this.scopeKeysByClientId.set(clientId, new Set(initialScopeKeys));
|
|
38
|
+
}
|
|
39
|
+
const scopeKeys = this.scopeKeysByClientId.get(clientId) ?? new Set();
|
|
40
|
+
for (const k of scopeKeys) {
|
|
41
|
+
let scopeConns = this.connectionsByScopeKey.get(k);
|
|
42
|
+
if (!scopeConns) {
|
|
43
|
+
scopeConns = new Set();
|
|
44
|
+
this.connectionsByScopeKey.set(k, scopeConns);
|
|
45
|
+
}
|
|
46
|
+
scopeConns.add(connection);
|
|
47
|
+
}
|
|
48
|
+
this.ensureHeartbeat();
|
|
49
|
+
return () => {
|
|
50
|
+
this.unregister(connection);
|
|
51
|
+
this.ensureHeartbeat();
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Update the effective tables/scopes for an already-connected client.
|
|
56
|
+
* In the new scope model, this is called with table names.
|
|
57
|
+
*/
|
|
58
|
+
updateClientTables(clientId, tables) {
|
|
59
|
+
this._updateScopeKeys(clientId, tables);
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Alias for backwards compatibility.
|
|
63
|
+
*/
|
|
64
|
+
updateClientScopeKeys(clientId, scopeKeys) {
|
|
65
|
+
this._updateScopeKeys(clientId, scopeKeys);
|
|
66
|
+
}
|
|
67
|
+
_updateScopeKeys(clientId, keys) {
|
|
68
|
+
const conns = this.connectionsByClientId.get(clientId);
|
|
69
|
+
if (!conns || conns.size === 0)
|
|
70
|
+
return;
|
|
71
|
+
const next = new Set(keys);
|
|
72
|
+
const prev = this.scopeKeysByClientId.get(clientId) ?? new Set();
|
|
73
|
+
// No-op when unchanged
|
|
74
|
+
if (prev.size === next.size) {
|
|
75
|
+
let unchanged = true;
|
|
76
|
+
for (const k of prev) {
|
|
77
|
+
if (!next.has(k)) {
|
|
78
|
+
unchanged = false;
|
|
79
|
+
break;
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
if (unchanged)
|
|
83
|
+
return;
|
|
84
|
+
}
|
|
85
|
+
this.scopeKeysByClientId.set(clientId, next);
|
|
86
|
+
// Remove from old scopes
|
|
87
|
+
for (const k of prev) {
|
|
88
|
+
if (next.has(k))
|
|
89
|
+
continue;
|
|
90
|
+
const set = this.connectionsByScopeKey.get(k);
|
|
91
|
+
if (!set)
|
|
92
|
+
continue;
|
|
93
|
+
for (const conn of conns)
|
|
94
|
+
set.delete(conn);
|
|
95
|
+
if (set.size === 0)
|
|
96
|
+
this.connectionsByScopeKey.delete(k);
|
|
97
|
+
}
|
|
98
|
+
// Add to new scopes
|
|
99
|
+
for (const k of next) {
|
|
100
|
+
if (prev.has(k))
|
|
101
|
+
continue;
|
|
102
|
+
let set = this.connectionsByScopeKey.get(k);
|
|
103
|
+
if (!set) {
|
|
104
|
+
set = new Set();
|
|
105
|
+
this.connectionsByScopeKey.set(k, set);
|
|
106
|
+
}
|
|
107
|
+
for (const conn of conns)
|
|
108
|
+
set.add(conn);
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* Notify clients that new data is available for the given scopes.
|
|
113
|
+
*/
|
|
114
|
+
notifyScopeKeys(scopeKeys, cursor, opts) {
|
|
115
|
+
const exclude = new Set(opts?.excludeClientIds ?? []);
|
|
116
|
+
const targets = new Set();
|
|
117
|
+
for (const k of scopeKeys) {
|
|
118
|
+
const conns = this.connectionsByScopeKey.get(k);
|
|
119
|
+
if (!conns)
|
|
120
|
+
continue;
|
|
121
|
+
for (const conn of conns)
|
|
122
|
+
targets.add(conn);
|
|
123
|
+
}
|
|
124
|
+
for (const conn of targets) {
|
|
125
|
+
if (!conn.isOpen)
|
|
126
|
+
continue;
|
|
127
|
+
if (exclude.has(conn.clientId))
|
|
128
|
+
continue;
|
|
129
|
+
conn.sendSync(cursor);
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* Get the number of active connections for a client.
|
|
134
|
+
*/
|
|
135
|
+
getConnectionCount(clientId) {
|
|
136
|
+
return this.connectionsByClientId.get(clientId)?.size ?? 0;
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* Get total number of active connections.
|
|
140
|
+
*/
|
|
141
|
+
getTotalConnections() {
|
|
142
|
+
let total = 0;
|
|
143
|
+
for (const conns of this.connectionsByClientId.values()) {
|
|
144
|
+
total += conns.size;
|
|
145
|
+
}
|
|
146
|
+
return total;
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* Close all connections for a client.
|
|
150
|
+
*/
|
|
151
|
+
closeClientConnections(clientId) {
|
|
152
|
+
const conns = this.connectionsByClientId.get(clientId);
|
|
153
|
+
if (!conns)
|
|
154
|
+
return;
|
|
155
|
+
const scopeKeys = this.scopeKeysByClientId.get(clientId) ?? new Set();
|
|
156
|
+
for (const k of scopeKeys) {
|
|
157
|
+
const set = this.connectionsByScopeKey.get(k);
|
|
158
|
+
if (!set)
|
|
159
|
+
continue;
|
|
160
|
+
for (const conn of conns)
|
|
161
|
+
set.delete(conn);
|
|
162
|
+
if (set.size === 0)
|
|
163
|
+
this.connectionsByScopeKey.delete(k);
|
|
164
|
+
}
|
|
165
|
+
for (const conn of conns) {
|
|
166
|
+
conn.close(1000, 'client closed');
|
|
167
|
+
}
|
|
168
|
+
this.connectionsByClientId.delete(clientId);
|
|
169
|
+
this.scopeKeysByClientId.delete(clientId);
|
|
170
|
+
this.ensureHeartbeat();
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
* Close all connections.
|
|
174
|
+
*/
|
|
175
|
+
closeAll() {
|
|
176
|
+
for (const conns of this.connectionsByClientId.values()) {
|
|
177
|
+
for (const conn of conns) {
|
|
178
|
+
conn.close(1000, 'server shutdown');
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
this.connectionsByClientId.clear();
|
|
182
|
+
this.scopeKeysByClientId.clear();
|
|
183
|
+
this.connectionsByScopeKey.clear();
|
|
184
|
+
this.ensureHeartbeat();
|
|
185
|
+
}
|
|
186
|
+
ensureHeartbeat() {
|
|
187
|
+
if (this.heartbeatIntervalMs <= 0)
|
|
188
|
+
return;
|
|
189
|
+
const total = this.getTotalConnections();
|
|
190
|
+
if (total === 0) {
|
|
191
|
+
if (this.heartbeatTimer) {
|
|
192
|
+
clearInterval(this.heartbeatTimer);
|
|
193
|
+
this.heartbeatTimer = null;
|
|
194
|
+
}
|
|
195
|
+
return;
|
|
196
|
+
}
|
|
197
|
+
if (this.heartbeatTimer)
|
|
198
|
+
return;
|
|
199
|
+
this.heartbeatTimer = setInterval(() => {
|
|
200
|
+
this.sendHeartbeats();
|
|
201
|
+
}, this.heartbeatIntervalMs);
|
|
202
|
+
}
|
|
203
|
+
sendHeartbeats() {
|
|
204
|
+
const closed = [];
|
|
205
|
+
for (const conns of this.connectionsByClientId.values()) {
|
|
206
|
+
for (const conn of conns) {
|
|
207
|
+
if (!conn.isOpen) {
|
|
208
|
+
closed.push(conn);
|
|
209
|
+
continue;
|
|
210
|
+
}
|
|
211
|
+
conn.sendHeartbeat();
|
|
212
|
+
}
|
|
213
|
+
}
|
|
214
|
+
for (const conn of closed) {
|
|
215
|
+
this.unregister(conn);
|
|
216
|
+
}
|
|
217
|
+
this.ensureHeartbeat();
|
|
218
|
+
}
|
|
219
|
+
unregister(connection) {
|
|
220
|
+
const clientId = connection.clientId;
|
|
221
|
+
const scopeKeys = this.scopeKeysByClientId.get(clientId) ?? new Set();
|
|
222
|
+
for (const k of scopeKeys) {
|
|
223
|
+
const set = this.connectionsByScopeKey.get(k);
|
|
224
|
+
if (!set)
|
|
225
|
+
continue;
|
|
226
|
+
set.delete(connection);
|
|
227
|
+
if (set.size === 0)
|
|
228
|
+
this.connectionsByScopeKey.delete(k);
|
|
229
|
+
}
|
|
230
|
+
const conns = this.connectionsByClientId.get(clientId);
|
|
231
|
+
if (!conns)
|
|
232
|
+
return;
|
|
233
|
+
conns.delete(connection);
|
|
234
|
+
if (conns.size > 0)
|
|
235
|
+
return;
|
|
236
|
+
this.connectionsByClientId.delete(clientId);
|
|
237
|
+
this.scopeKeysByClientId.delete(clientId);
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
/**
|
|
241
|
+
* Create a WebSocket connection wrapper.
|
|
242
|
+
*
|
|
243
|
+
* Use this with your WebSocket library to create connections
|
|
244
|
+
* compatible with RelayRealtime.
|
|
245
|
+
*/
|
|
246
|
+
export function createRelayWebSocketConnection(ws, args) {
|
|
247
|
+
let closed = false;
|
|
248
|
+
function safeSend(message) {
|
|
249
|
+
try {
|
|
250
|
+
ws.send(message);
|
|
251
|
+
return true;
|
|
252
|
+
}
|
|
253
|
+
catch {
|
|
254
|
+
return false;
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
const connection = {
|
|
258
|
+
get isOpen() {
|
|
259
|
+
if (closed)
|
|
260
|
+
return false;
|
|
261
|
+
return ws.readyState === 1;
|
|
262
|
+
},
|
|
263
|
+
actorId: args.actorId,
|
|
264
|
+
clientId: args.clientId,
|
|
265
|
+
sendSync(cursor) {
|
|
266
|
+
if (!connection.isOpen)
|
|
267
|
+
return;
|
|
268
|
+
const ok = safeSend(JSON.stringify({
|
|
269
|
+
event: 'sync',
|
|
270
|
+
data: { cursor, timestamp: Date.now() },
|
|
271
|
+
}));
|
|
272
|
+
if (!ok)
|
|
273
|
+
closed = true;
|
|
274
|
+
},
|
|
275
|
+
sendHeartbeat() {
|
|
276
|
+
if (!connection.isOpen)
|
|
277
|
+
return;
|
|
278
|
+
const ok = safeSend(JSON.stringify({ event: 'heartbeat', data: { timestamp: Date.now() } }));
|
|
279
|
+
if (!ok)
|
|
280
|
+
closed = true;
|
|
281
|
+
},
|
|
282
|
+
sendError(message) {
|
|
283
|
+
if (connection.isOpen) {
|
|
284
|
+
safeSend(JSON.stringify({
|
|
285
|
+
event: 'error',
|
|
286
|
+
data: { error: message, timestamp: Date.now() },
|
|
287
|
+
}));
|
|
288
|
+
}
|
|
289
|
+
connection.close(1011, 'server error');
|
|
290
|
+
},
|
|
291
|
+
close(code, reason) {
|
|
292
|
+
if (closed)
|
|
293
|
+
return;
|
|
294
|
+
closed = true;
|
|
295
|
+
try {
|
|
296
|
+
ws.close(code, reason);
|
|
297
|
+
}
|
|
298
|
+
catch {
|
|
299
|
+
// ignore
|
|
300
|
+
}
|
|
301
|
+
},
|
|
302
|
+
};
|
|
303
|
+
return connection;
|
|
304
|
+
}
|
|
305
|
+
//# sourceMappingURL=realtime.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"realtime.js","sourceRoot":"","sources":["../src/realtime.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AA2BH;;;;;GAKG;AACH,MAAM,OAAO,aAAa;IAChB,qBAAqB,GAAG,IAAI,GAAG,EAGpC,CAAC;IACI,mBAAmB,GAAG,IAAI,GAAG,EAAuB,CAAC;IACrD,qBAAqB,GAAG,IAAI,GAAG,EAGpC,CAAC;IAEI,mBAAmB,CAAS;IAC5B,cAAc,GAA0C,IAAI,CAAC;IAErE,YAAY,OAA0C,EAAE;QACtD,IAAI,CAAC,mBAAmB,GAAG,OAAO,EAAE,mBAAmB,IAAI,MAAM,CAAC;IAAA,CACnE;IAED;;;OAGG;IACH,QAAQ,CACN,UAAoC,EACpC,gBAAgB,GAAa,EAAE,EACnB;QACZ,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACrC,IAAI,WAAW,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC3D,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,WAAW,GAAG,IAAI,GAAG,EAAE,CAAC;YACxB,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QACxD,CAAC;QACD,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAE5B,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC;QACpE,CAAC;QAED,MAAM,SAAS,GACb,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,GAAG,EAAU,CAAC;QAC9D,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;YAC1B,IAAI,UAAU,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACnD,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,UAAU,GAAG,IAAI,GAAG,EAAE,CAAC;gBACvB,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;YAChD,CAAC;YACD,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC7B,CAAC;QAED,IAAI,CAAC,eAAe,EAAE,CAAC;QAEvB,OAAO,GAAG,EAAE,CAAC;YACX,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAC5B,IAAI,CAAC,eAAe,EAAE,CAAC;QAAA,CACxB,CAAC;IAAA,CACH;IAED;;;OAGG;IACH,kBAAkB,CAAC,QAAgB,EAAE,MAAgB,EAAQ;QAC3D,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAAA,CACzC;IAED;;OAEG;IACH,qBAAqB,CAAC,QAAgB,EAAE,SAAmB,EAAQ;QACjE,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAAA,CAC5C;IAEO,gBAAgB,CAAC,QAAgB,EAAE,IAAc,EAAQ;QAC/D,MAAM,KAAK,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC;YAAE,OAAO;QAEvC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAS,IAAI,CAAC,CAAC;QACnC,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,GAAG,EAAU,CAAC;QAEzE,uBAAuB;QACvB,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;YAC5B,IAAI,SAAS,GAAG,IAAI,CAAC;YACrB,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;gBACrB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;oBACjB,SAAS,GAAG,KAAK,CAAC;oBAClB,MAAM;gBACR,CAAC;YACH,CAAC;YACD,IAAI,SAAS;gBAAE,OAAO;QACxB,CAAC;QAED,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAE7C,yBAAyB;QACzB,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACrB,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;gBAAE,SAAS;YAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC9C,IAAI,CAAC,GAAG;gBAAE,SAAS;YACnB,KAAK,MAAM,IAAI,IAAI,KAAK;gBAAE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC3C,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC;gBAAE,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC3D,CAAC;QAED,oBAAoB;QACpB,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACrB,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;gBAAE,SAAS;YAC1B,IAAI,GAAG,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC5C,IAAI,CAAC,GAAG,EAAE,CAAC;gBACT,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;gBAChB,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACzC,CAAC;YACD,KAAK,MAAM,IAAI,IAAI,KAAK;gBAAE,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1C,CAAC;IAAA,CACF;IAED;;OAEG;IACH,eAAe,CACb,SAAmB,EACnB,MAAc,EACd,IAAsC,EAChC;QACN,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,gBAAgB,IAAI,EAAE,CAAC,CAAC;QACtD,MAAM,OAAO,GAAG,IAAI,GAAG,EAA4B,CAAC;QAEpD,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;YAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAChD,IAAI,CAAC,KAAK;gBAAE,SAAS;YACrB,KAAK,MAAM,IAAI,IAAI,KAAK;gBAAE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC9C,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC,MAAM;gBAAE,SAAS;YAC3B,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAAE,SAAS;YACzC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC;IAAA,CACF;IAED;;OAEG;IACH,kBAAkB,CAAC,QAAgB,EAAU;QAC3C,OAAO,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC;IAAA,CAC5D;IAED;;OAEG;IACH,mBAAmB,GAAW;QAC5B,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,EAAE,CAAC;YACxD,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC;QACtB,CAAC;QACD,OAAO,KAAK,CAAC;IAAA,CACd;IAED;;OAEG;IACH,sBAAsB,CAAC,QAAgB,EAAQ;QAC7C,MAAM,KAAK,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK;YAAE,OAAO;QAEnB,MAAM,SAAS,GACb,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,GAAG,EAAU,CAAC;QAC9D,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;YAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC9C,IAAI,CAAC,GAAG;gBAAE,SAAS;YACnB,KAAK,MAAM,IAAI,IAAI,KAAK;gBAAE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC3C,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC;gBAAE,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC3D,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QACpC,CAAC;QACD,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC1C,IAAI,CAAC,eAAe,EAAE,CAAC;IAAA,CACxB;IAED;;OAEG;IACH,QAAQ,GAAS;QACf,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,EAAE,CAAC;YACxD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;QACD,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC;QACjC,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,eAAe,EAAE,CAAC;IAAA,CACxB;IAEO,eAAe,GAAS;QAC9B,IAAI,IAAI,CAAC,mBAAmB,IAAI,CAAC;YAAE,OAAO;QAE1C,MAAM,KAAK,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAEzC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YAChB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBACxB,aAAa,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBACnC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;YAC7B,CAAC;YACD,OAAO;QACT,CAAC;QAED,IAAI,IAAI,CAAC,cAAc;YAAE,OAAO;QAEhC,IAAI,CAAC,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;YACtC,IAAI,CAAC,cAAc,EAAE,CAAC;QAAA,CACvB,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAAA,CAC9B;IAEO,cAAc,GAAS;QAC7B,MAAM,MAAM,GAA+B,EAAE,CAAC;QAE9C,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,EAAE,CAAC;YACxD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;oBACjB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBAClB,SAAS;gBACX,CAAC;gBACD,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,CAAC;QACH,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;QAED,IAAI,CAAC,eAAe,EAAE,CAAC;IAAA,CACxB;IAEO,UAAU,CAAC,UAAoC,EAAQ;QAC7D,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QAErC,MAAM,SAAS,GACb,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,GAAG,EAAU,CAAC;QAC9D,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;YAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC9C,IAAI,CAAC,GAAG;gBAAE,SAAS;YACnB,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACvB,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC;gBAAE,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC3D,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK;YAAE,OAAO;QACnB,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACzB,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC;YAAE,OAAO;QAE3B,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAAA,CAC3C;CACF;AAED;;;;;GAKG;AACH,MAAM,UAAU,8BAA8B,CAC5C,EAIC,EACD,IAA2C,EACjB;IAC1B,IAAI,MAAM,GAAG,KAAK,CAAC;IAEnB,SAAS,QAAQ,CAAC,OAAe,EAAW;QAC1C,IAAI,CAAC;YACH,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACjB,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IAAA,CACF;IAED,MAAM,UAAU,GAA6B;QAC3C,IAAI,MAAM,GAAG;YACX,IAAI,MAAM;gBAAE,OAAO,KAAK,CAAC;YACzB,OAAO,EAAE,CAAC,UAAU,KAAK,CAAC,CAAC;QAAA,CAC5B;QACD,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,QAAQ,CAAC,MAAc,EAAE;YACvB,IAAI,CAAC,UAAU,CAAC,MAAM;gBAAE,OAAO;YAC/B,MAAM,EAAE,GAAG,QAAQ,CACjB,IAAI,CAAC,SAAS,CAAC;gBACb,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE;aACxC,CAAC,CACH,CAAC;YACF,IAAI,CAAC,EAAE;gBAAE,MAAM,GAAG,IAAI,CAAC;QAAA,CACxB;QACD,aAAa,GAAG;YACd,IAAI,CAAC,UAAU,CAAC,MAAM;gBAAE,OAAO;YAC/B,MAAM,EAAE,GAAG,QAAQ,CACjB,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC,CACxE,CAAC;YACF,IAAI,CAAC,EAAE;gBAAE,MAAM,GAAG,IAAI,CAAC;QAAA,CACxB;QACD,SAAS,CAAC,OAAe,EAAE;YACzB,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;gBACtB,QAAQ,CACN,IAAI,CAAC,SAAS,CAAC;oBACb,KAAK,EAAE,OAAO;oBACd,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE;iBAChD,CAAC,CACH,CAAC;YACJ,CAAC;YACD,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAAA,CACxC;QACD,KAAK,CAAC,IAAa,EAAE,MAAe,EAAE;YACpC,IAAI,MAAM;gBAAE,OAAO;YACnB,MAAM,GAAG,IAAI,CAAC;YACd,IAAI,CAAC;gBACH,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACzB,CAAC;YAAC,MAAM,CAAC;gBACP,SAAS;YACX,CAAC;QAAA,CACF;KACF,CAAC;IAEF,OAAO,UAAU,CAAC;AAAA,CACnB"}
|
package/dist/relay.d.ts
ADDED
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @syncular/relay - Relay Server
|
|
3
|
+
*
|
|
4
|
+
* An edge relay server that acts as a local server to nearby clients
|
|
5
|
+
* while simultaneously acting as a client to the main server.
|
|
6
|
+
*
|
|
7
|
+
* Enables offline-first architectures where local network devices
|
|
8
|
+
* continue syncing when internet is lost.
|
|
9
|
+
*/
|
|
10
|
+
import type { ScopeValues, SyncTransport } from '@syncular/core';
|
|
11
|
+
import type { ServerSyncDialect, TableRegistry } from '@syncular/server';
|
|
12
|
+
import type { Hono } from 'hono';
|
|
13
|
+
import type { Kysely } from 'kysely';
|
|
14
|
+
import { type RelayMode } from './mode-manager';
|
|
15
|
+
import { RelayRealtime } from './realtime';
|
|
16
|
+
import type { ForwardConflictEntry, RelayDatabase } from './schema';
|
|
17
|
+
/**
|
|
18
|
+
* Events emitted by the relay server.
|
|
19
|
+
*/
|
|
20
|
+
export interface RelayEvents {
|
|
21
|
+
modeChange: (mode: RelayMode) => void;
|
|
22
|
+
forwardConflict: (conflict: ForwardConflictEntry) => void;
|
|
23
|
+
error: (error: Error) => void;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Configuration options for creating a relay server.
|
|
27
|
+
*/
|
|
28
|
+
export interface RelayServerOptions<DB extends RelayDatabase = RelayDatabase> {
|
|
29
|
+
/** Kysely database instance */
|
|
30
|
+
db: Kysely<DB>;
|
|
31
|
+
/** Server sync dialect (e.g., SQLite or Postgres) */
|
|
32
|
+
dialect: ServerSyncDialect;
|
|
33
|
+
/** Transport for communicating with the main server */
|
|
34
|
+
mainServerTransport: SyncTransport;
|
|
35
|
+
/** Client ID used when communicating with the main server */
|
|
36
|
+
mainServerClientId: string;
|
|
37
|
+
/** Actor ID used when communicating with the main server */
|
|
38
|
+
mainServerActorId: string;
|
|
39
|
+
/** Tables this relay subscribes to from the main server */
|
|
40
|
+
tables: string[];
|
|
41
|
+
/** Scope values for subscriptions to the main server */
|
|
42
|
+
scopes: ScopeValues;
|
|
43
|
+
/** Shape registry for handling operations */
|
|
44
|
+
shapes: TableRegistry<DB>;
|
|
45
|
+
/** Optional: WebSocket heartbeat interval in milliseconds (default: 30000) */
|
|
46
|
+
heartbeatIntervalMs?: number;
|
|
47
|
+
/** Optional: Forward engine retry interval in milliseconds (default: 5000) */
|
|
48
|
+
forwardRetryIntervalMs?: number;
|
|
49
|
+
/** Optional: Pull engine interval in milliseconds (default: 10000) */
|
|
50
|
+
pullIntervalMs?: number;
|
|
51
|
+
/** Optional: Health check interval in milliseconds (default: 30000) */
|
|
52
|
+
healthCheckIntervalMs?: number;
|
|
53
|
+
/** Optional: Prune interval in milliseconds (default: 3600000 = 1 hour). Set to 0 to disable. */
|
|
54
|
+
pruneIntervalMs?: number;
|
|
55
|
+
/** Optional: Maximum age of completed relay data before pruning (default: 604800000 = 7 days) */
|
|
56
|
+
pruneMaxAgeMs?: number;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Result of relay data pruning.
|
|
60
|
+
*/
|
|
61
|
+
export interface PruneRelayResult {
|
|
62
|
+
deletedMappings: number;
|
|
63
|
+
deletedOutbox: number;
|
|
64
|
+
deletedConflicts: number;
|
|
65
|
+
}
|
|
66
|
+
type EventHandler<K extends keyof RelayEvents> = RelayEvents[K];
|
|
67
|
+
/**
|
|
68
|
+
* Relay server that acts as an edge relay between local clients and a main server.
|
|
69
|
+
*
|
|
70
|
+
* @example
|
|
71
|
+
* ```typescript
|
|
72
|
+
* import { createRelayServer } from '@syncular/relay';
|
|
73
|
+
* import { createSqliteServerDialect } from '@syncular/server-dialect-sqlite';
|
|
74
|
+
*
|
|
75
|
+
* const relay = createRelayServer({
|
|
76
|
+
* db: sqliteDb,
|
|
77
|
+
* dialect: createSqliteServerDialect(),
|
|
78
|
+
* mainServerTransport: createHttpTransport({ baseUrl: 'https://main.example.com/sync' }),
|
|
79
|
+
* mainServerClientId: 'relay-branch-001',
|
|
80
|
+
* mainServerActorId: 'relay-service',
|
|
81
|
+
* tables: ['tasks', 'projects'],
|
|
82
|
+
* scopes: { project_id: 'acme' },
|
|
83
|
+
* shapes: shapeRegistry,
|
|
84
|
+
* });
|
|
85
|
+
*
|
|
86
|
+
* // Mount routes for local clients
|
|
87
|
+
* app.route('/sync', relay.getRoutes());
|
|
88
|
+
*
|
|
89
|
+
* // Start background sync with main
|
|
90
|
+
* await relay.start();
|
|
91
|
+
*
|
|
92
|
+
* // Events
|
|
93
|
+
* relay.on('modeChange', (mode) => console.log(mode));
|
|
94
|
+
* relay.on('forwardConflict', (conflict) => handleConflict(conflict));
|
|
95
|
+
* ```
|
|
96
|
+
*/
|
|
97
|
+
export declare class RelayServer<DB extends RelayDatabase = RelayDatabase> {
|
|
98
|
+
private readonly db;
|
|
99
|
+
private readonly dialect;
|
|
100
|
+
private readonly mainServerTransport;
|
|
101
|
+
private readonly mainServerClientId;
|
|
102
|
+
private readonly mainServerActorId;
|
|
103
|
+
private readonly tables;
|
|
104
|
+
private readonly scopes;
|
|
105
|
+
private readonly shapes;
|
|
106
|
+
private readonly modeManager;
|
|
107
|
+
private readonly sequenceMapper;
|
|
108
|
+
private readonly forwardEngine;
|
|
109
|
+
private readonly pullEngine;
|
|
110
|
+
private readonly realtime;
|
|
111
|
+
private readonly eventHandlers;
|
|
112
|
+
private readonly pruneIntervalMs;
|
|
113
|
+
private readonly pruneMaxAgeMs;
|
|
114
|
+
private lastPruneAtMs;
|
|
115
|
+
private pruneInFlight;
|
|
116
|
+
private started;
|
|
117
|
+
private schemaInitialized;
|
|
118
|
+
private routes;
|
|
119
|
+
constructor(options: RelayServerOptions<DB>);
|
|
120
|
+
/**
|
|
121
|
+
* Subscribe to relay events.
|
|
122
|
+
*/
|
|
123
|
+
on<K extends keyof RelayEvents>(event: K, handler: EventHandler<K>): () => void;
|
|
124
|
+
/**
|
|
125
|
+
* Get the current mode (online/offline/reconnecting).
|
|
126
|
+
*/
|
|
127
|
+
getMode(): RelayMode;
|
|
128
|
+
/**
|
|
129
|
+
* Get the tables this relay subscribes to.
|
|
130
|
+
*/
|
|
131
|
+
getTables(): readonly string[];
|
|
132
|
+
/**
|
|
133
|
+
* Get the scope values for subscriptions.
|
|
134
|
+
*/
|
|
135
|
+
getScopes(): ScopeValues;
|
|
136
|
+
/**
|
|
137
|
+
* Get the realtime manager for WebSocket connections.
|
|
138
|
+
*/
|
|
139
|
+
getRealtime(): RelayRealtime;
|
|
140
|
+
/**
|
|
141
|
+
* Start the relay server background processes.
|
|
142
|
+
*
|
|
143
|
+
* This initializes the database schema and starts:
|
|
144
|
+
* - Forward engine (sends local commits to main)
|
|
145
|
+
* - Pull engine (receives changes from main)
|
|
146
|
+
* - Mode manager (tracks online/offline state)
|
|
147
|
+
*/
|
|
148
|
+
start(): Promise<void>;
|
|
149
|
+
/**
|
|
150
|
+
* Stop the relay server background processes.
|
|
151
|
+
*/
|
|
152
|
+
stop(): Promise<void>;
|
|
153
|
+
/**
|
|
154
|
+
* Manually trigger a forward cycle (useful for testing).
|
|
155
|
+
*/
|
|
156
|
+
forwardOnce(): Promise<boolean>;
|
|
157
|
+
/**
|
|
158
|
+
* Manually trigger a pull cycle (useful for testing).
|
|
159
|
+
*/
|
|
160
|
+
pullOnce(): Promise<boolean>;
|
|
161
|
+
/**
|
|
162
|
+
* Prune old relay data (sequence mappings, forwarded outbox, resolved conflicts).
|
|
163
|
+
*/
|
|
164
|
+
pruneRelay(options?: {
|
|
165
|
+
maxAgeMs?: number;
|
|
166
|
+
}): Promise<PruneRelayResult>;
|
|
167
|
+
/**
|
|
168
|
+
* Rate-limited pruning. Skips if called within `pruneIntervalMs` of last prune.
|
|
169
|
+
* Returns zero counts if skipped or if pruning is disabled.
|
|
170
|
+
*/
|
|
171
|
+
maybePruneRelay(): Promise<PruneRelayResult>;
|
|
172
|
+
/**
|
|
173
|
+
* Get Hono routes for local clients.
|
|
174
|
+
*
|
|
175
|
+
* Mount these routes to serve local sync clients:
|
|
176
|
+
* - POST /pull
|
|
177
|
+
* - POST /push
|
|
178
|
+
* - GET /realtime (WebSocket)
|
|
179
|
+
*/
|
|
180
|
+
getRoutes(): Hono;
|
|
181
|
+
private emit;
|
|
182
|
+
}
|
|
183
|
+
/**
|
|
184
|
+
* Create a new relay server instance.
|
|
185
|
+
*/
|
|
186
|
+
export declare function createRelayServer(options: RelayServerOptions): RelayServer;
|
|
187
|
+
export {};
|
|
188
|
+
//# sourceMappingURL=relay.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"relay.d.ts","sourceRoot":"","sources":["../src/relay.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACzE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AACjC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAMrC,OAAO,EAAe,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC;IACtC,eAAe,EAAE,CAAC,QAAQ,EAAE,oBAAoB,KAAK,IAAI,CAAC;IAC1D,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,EAAE,SAAS,aAAa,GAAG,aAAa;IAC1E,+BAA+B;IAC/B,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;IACf,qDAAqD;IACrD,OAAO,EAAE,iBAAiB,CAAC;IAC3B,uDAAuD;IACvD,mBAAmB,EAAE,aAAa,CAAC;IACnC,6DAA6D;IAC7D,kBAAkB,EAAE,MAAM,CAAC;IAC3B,4DAA4D;IAC5D,iBAAiB,EAAE,MAAM,CAAC;IAC1B,2DAA2D;IAC3D,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,wDAAwD;IACxD,MAAM,EAAE,WAAW,CAAC;IACpB,6CAA6C;IAC7C,MAAM,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC;IAC1B,8EAA8E;IAC9E,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,8EAA8E;IAC9E,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,sEAAsE;IACtE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,uEAAuE;IACvE,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,iGAAiG;IACjG,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iGAAiG;IACjG,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,KAAK,YAAY,CAAC,CAAC,SAAS,MAAM,WAAW,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,WAAW,CAAC,EAAE,SAAS,aAAa,GAAG,aAAa;IAC/D,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAa;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;IAC5C,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAgB;IACpD,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAS;IAC5C,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAS;IAC3C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAW;IAClC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAoB;IAE3C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;IAC1C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAqB;IACpD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAoB;IAClD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAiB;IAC5C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IAEzC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAG1B;IAEJ,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,aAAa,CAAK;IAC1B,OAAO,CAAC,aAAa,CAA0C;IAE/D,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,MAAM,CAAqB;IAEnC,YAAY,OAAO,EAAE,kBAAkB,CAAC,EAAE,CAAC,EAyD1C;IAED;;OAEG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,WAAW,EAC5B,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,GACvB,MAAM,IAAI,CAWZ;IAED;;OAEG;IACH,OAAO,IAAI,SAAS,CAEnB;IAED;;OAEG;IACH,SAAS,IAAI,SAAS,MAAM,EAAE,CAE7B;IAED;;OAEG;IACH,SAAS,IAAI,WAAW,CAEvB;IAED;;OAEG;IACH,WAAW,IAAI,aAAa,CAE3B;IAED;;;;;;;OAOG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CA8B3B;IAED;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAQ1B;IAED;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,CAEpC;IAED;;OAEG;IACG,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAEjC;IAED;;OAEG;IACG,UAAU,CAAC,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAsB3E;IAED;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAuBjD;IAED;;;;;;;OAOG;IACH,SAAS,IAAI,IAAI,CAsBhB;IAED,OAAO,CAAC,IAAI;CAeb;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,GAAG,WAAW,CAE1E"}
|