@proj-airi/server-sdk 0.8.1-beta.6 → 0.8.1-beta.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/index.d.mts +13 -1
  2. package/dist/index.mjs +65 -2
  3. package/dist/index.mjs.map +1 -1
  4. package/package.json +2 -2
package/dist/index.d.mts CHANGED
@@ -1,4 +1,4 @@
1
- import { ContextUpdateStrategy, WebSocketBaseEvent, WebSocketEventOptionalSource, WebSocketEventSource, WebSocketEvents } from "@proj-airi/server-shared/types";
1
+ import { ContextUpdateStrategy, MessageHeartbeat, MetadataEventSource, WebSocketBaseEvent, WebSocketEventOptionalSource, WebSocketEventSource, WebSocketEvents } from "@proj-airi/server-shared/types";
2
2
  export * from "@proj-airi/server-shared/types";
3
3
 
4
4
  //#region src/client.d.ts
@@ -7,6 +7,11 @@ interface ClientOptions<C = undefined> {
7
7
  name: string;
8
8
  possibleEvents?: Array<keyof WebSocketEvents<C>>;
9
9
  token?: string;
10
+ identity?: MetadataEventSource;
11
+ heartbeat?: {
12
+ readTimeout?: number;
13
+ message?: MessageHeartbeat | string;
14
+ };
10
15
  onError?: (error: unknown) => void;
11
16
  onClose?: () => void;
12
17
  autoConnect?: boolean;
@@ -20,6 +25,8 @@ declare class Client<C = undefined> {
20
25
  private shouldClose;
21
26
  private connectAttempt?;
22
27
  private connectTask?;
28
+ private heartbeatTimer?;
29
+ private readonly identity;
23
30
  private readonly opts;
24
31
  private readonly eventListeners;
25
32
  constructor(options: ClientOptions<C>);
@@ -36,6 +43,11 @@ declare class Client<C = undefined> {
36
43
  send(data: WebSocketEventOptionalSource<C>): void;
37
44
  sendRaw(data: string | ArrayBufferLike | ArrayBufferView): void;
38
45
  close(): void;
46
+ private startHeartbeat;
47
+ private stopHeartbeat;
48
+ private sendNativeHeartbeat;
49
+ private sendHeartbeatPing;
50
+ private sendHeartbeatPong;
39
51
  private _reconnectDueToUnauthorized;
40
52
  }
41
53
  //#endregion
package/dist/index.mjs CHANGED
@@ -1,11 +1,14 @@
1
1
  import WebSocket from "crossws/websocket";
2
- import { ContextUpdateStrategy, WebSocketEventSource } from "@proj-airi/server-shared/types";
2
+ import { ContextUpdateStrategy, MessageHeartbeat, MessageHeartbeatKind, WebSocketEventSource } from "@proj-airi/server-shared/types";
3
3
 
4
4
  //#region ../../node_modules/.pnpm/@moeru+std@0.1.0-beta.14/node_modules/@moeru/std/dist/sleep/index.js
5
5
  const sleep = async (delay) => new Promise((resolve) => setTimeout(resolve, delay));
6
6
 
7
7
  //#endregion
8
8
  //#region src/client.ts
9
+ function createInstanceId() {
10
+ return `${Date.now().toString(36)}-${Math.random().toString(36).slice(2, 8)}`;
11
+ }
9
12
  var Client = class {
10
13
  connected = false;
11
14
  connecting = false;
@@ -13,9 +16,15 @@ var Client = class {
13
16
  shouldClose = false;
14
17
  connectAttempt;
15
18
  connectTask;
19
+ heartbeatTimer;
20
+ identity;
16
21
  opts;
17
22
  eventListeners = /* @__PURE__ */ new Map();
18
23
  constructor(options) {
24
+ const identity = options.identity ?? {
25
+ plugin: options.name,
26
+ instanceId: createInstanceId()
27
+ };
19
28
  this.opts = {
20
29
  url: "ws://localhost:6121/ws",
21
30
  possibleEvents: [],
@@ -24,8 +33,14 @@ var Client = class {
24
33
  autoConnect: true,
25
34
  autoReconnect: true,
26
35
  maxReconnectAttempts: -1,
27
- ...options
36
+ heartbeat: {
37
+ readTimeout: 3e4,
38
+ message: MessageHeartbeat.Ping
39
+ },
40
+ ...options,
41
+ identity
28
42
  };
43
+ this.identity = identity;
29
44
  this.onEvent("module:authenticated", async (event) => {
30
45
  if (event.data.authenticated) this.tryAnnounce();
31
46
  else await this.retryWithExponentialBackoff(() => this.tryAuthenticate());
@@ -33,6 +48,9 @@ var Client = class {
33
48
  this.onEvent("error", async (event) => {
34
49
  if (event.data.message === "not authenticated") await this._reconnectDueToUnauthorized();
35
50
  });
51
+ this.onEvent("transport:connection:heartbeat", (event) => {
52
+ if (event.data.kind === MessageHeartbeatKind.Ping) this.sendHeartbeatPong();
53
+ });
36
54
  if (this.opts.autoConnect) this.connect();
37
55
  }
38
56
  async retryWithExponentialBackoff(fn) {
@@ -89,6 +107,7 @@ var Client = class {
89
107
  }
90
108
  if (this.connected) {
91
109
  this.connected = false;
110
+ this.stopHeartbeat();
92
111
  this.opts.onClose?.();
93
112
  }
94
113
  if (this.opts.autoReconnect && !this.shouldClose) this.tryReconnectWithExponentialBackoff();
@@ -96,6 +115,7 @@ var Client = class {
96
115
  ws.onopen = () => {
97
116
  settle(() => {
98
117
  this.connected = true;
118
+ this.startHeartbeat();
99
119
  if (this.opts.token) this.tryAuthenticate();
100
120
  else this.tryAnnounce();
101
121
  resolve();
@@ -115,6 +135,7 @@ var Client = class {
115
135
  type: "module:announce",
116
136
  data: {
117
137
  name: this.opts.name,
138
+ identity: this.identity,
118
139
  possibleEvents: this.opts.possibleEvents
119
140
  }
120
141
  });
@@ -160,6 +181,7 @@ var Client = class {
160
181
  send(data) {
161
182
  if (this.websocket && this.connected) this.websocket.send(JSON.stringify({
162
183
  source: this.opts.name,
184
+ metadata: { source: this.identity },
163
185
  ...data
164
186
  }));
165
187
  }
@@ -168,11 +190,52 @@ var Client = class {
168
190
  }
169
191
  close() {
170
192
  this.shouldClose = true;
193
+ this.stopHeartbeat();
171
194
  if (this.websocket) {
172
195
  this.websocket.close();
173
196
  this.connected = false;
174
197
  }
175
198
  }
199
+ startHeartbeat() {
200
+ if (!this.opts.heartbeat?.readTimeout) return;
201
+ this.stopHeartbeat();
202
+ const ping = () => this.sendHeartbeatPing();
203
+ ping();
204
+ this.heartbeatTimer = setInterval(ping, this.opts.heartbeat.readTimeout);
205
+ }
206
+ stopHeartbeat() {
207
+ if (this.heartbeatTimer) {
208
+ clearInterval(this.heartbeatTimer);
209
+ this.heartbeatTimer = void 0;
210
+ }
211
+ }
212
+ sendNativeHeartbeat(kind) {
213
+ const websocket = this.websocket;
214
+ if (kind === "ping") websocket.ping?.();
215
+ else websocket.pong?.();
216
+ }
217
+ sendHeartbeatPing() {
218
+ this.send({
219
+ type: "transport:connection:heartbeat",
220
+ data: {
221
+ kind: MessageHeartbeatKind.Ping,
222
+ message: this.opts.heartbeat?.message ?? MessageHeartbeat.Ping,
223
+ at: Date.now()
224
+ }
225
+ });
226
+ this.sendNativeHeartbeat("ping");
227
+ }
228
+ sendHeartbeatPong() {
229
+ this.send({
230
+ type: "transport:connection:heartbeat",
231
+ data: {
232
+ kind: MessageHeartbeatKind.Pong,
233
+ message: MessageHeartbeat.Pong,
234
+ at: Date.now()
235
+ }
236
+ });
237
+ this.sendNativeHeartbeat("pong");
238
+ }
176
239
  async _reconnectDueToUnauthorized() {
177
240
  if (this.shouldClose) return;
178
241
  const ws = this.websocket;
package/dist/index.mjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","names":["executions: Promise<void>[]"],"sources":["../../../node_modules/.pnpm/@moeru+std@0.1.0-beta.14/node_modules/@moeru/std/dist/sleep/index.js","../src/client.ts"],"sourcesContent":["const sleep = async (delay) => new Promise((resolve) => setTimeout(resolve, delay));\n\nexport { sleep };\n","import type {\n WebSocketBaseEvent,\n WebSocketEvent,\n WebSocketEventOptionalSource,\n WebSocketEvents,\n WebSocketEventSource,\n} from '@proj-airi/server-shared/types'\n\nimport WebSocket from 'crossws/websocket'\n\nimport { sleep } from '@moeru/std'\n\nexport interface ClientOptions<C = undefined> {\n url?: string\n name: string\n possibleEvents?: Array<keyof WebSocketEvents<C>>\n token?: string\n onError?: (error: unknown) => void\n onClose?: () => void\n autoConnect?: boolean\n autoReconnect?: boolean\n maxReconnectAttempts?: number\n}\n\nexport class Client<C = undefined> {\n private connected = false\n private connecting = false\n private websocket?: WebSocket\n private shouldClose = false\n private connectAttempt?: Promise<void>\n private connectTask?: Promise<void>\n\n private readonly opts: Required<Omit<ClientOptions<C>, 'token'>> & Pick<ClientOptions<C>, 'token'>\n private readonly eventListeners = new Map<\n keyof WebSocketEvents<C>,\n Set<(data: WebSocketBaseEvent<any, any>) => void | Promise<void>>\n >()\n\n constructor(options: ClientOptions<C>) {\n this.opts = {\n url: 'ws://localhost:6121/ws',\n possibleEvents: [],\n onError: () => {},\n onClose: () => {},\n autoConnect: true,\n autoReconnect: true,\n maxReconnectAttempts: -1,\n ...options,\n }\n\n // Authentication listener is registered once only\n this.onEvent('module:authenticated', async (event) => {\n if (event.data.authenticated) {\n this.tryAnnounce()\n }\n else {\n await this.retryWithExponentialBackoff(() => this.tryAuthenticate())\n }\n })\n\n this.onEvent('error', async (event) => {\n if (event.data.message === 'not authenticated') {\n await this._reconnectDueToUnauthorized()\n }\n })\n\n if (this.opts.autoConnect) {\n void this.connect()\n }\n }\n\n private async retryWithExponentialBackoff(fn: () => void | Promise<void>) {\n const { maxReconnectAttempts } = this.opts\n let attempts = 0\n\n // Loop until attempts exceed maxReconnectAttempts, or unlimited if -1\n while (true) {\n if (maxReconnectAttempts !== -1 && attempts >= maxReconnectAttempts) {\n console.error(`Maximum retry attempts (${maxReconnectAttempts}) reached`)\n return\n }\n\n try {\n await fn()\n return\n }\n catch (err) {\n this.opts.onError?.(err)\n const delay = Math.min(2 ** attempts * 1000, 30_000) // capped exponential backoff\n await sleep(delay)\n attempts++\n }\n }\n }\n\n private async tryReconnectWithExponentialBackoff() {\n if (this.shouldClose) {\n throw new Error('Client is closed')\n }\n\n await this.retryWithExponentialBackoff(() => this._connect())\n }\n\n private _connect(): Promise<void> {\n if (this.shouldClose || this.connected) {\n return Promise.resolve()\n }\n if (this.connecting) {\n return this.connectAttempt ?? Promise.resolve()\n }\n\n this.connectAttempt = new Promise((resolve, reject) => {\n this.connecting = true\n let settled = false\n\n const settle = (fn: () => void) => {\n if (settled)\n return\n\n settled = true\n this.connecting = false\n this.connectAttempt = undefined\n fn()\n }\n\n const ws = new WebSocket(this.opts.url)\n this.websocket = ws\n\n ws.onmessage = this.handleMessageBound\n ws.onerror = (event: any) => {\n settle(() => {\n this.connected = false\n\n this.opts.onError?.(event)\n reject(event?.error ?? new Error('WebSocket error'))\n })\n }\n ws.onclose = () => {\n if (!settled && !this.connected) {\n settle(() => {\n reject(new Error('WebSocket closed before open'))\n })\n return\n }\n\n if (this.connected) {\n this.connected = false\n this.opts.onClose?.()\n }\n if (this.opts.autoReconnect && !this.shouldClose) {\n void this.tryReconnectWithExponentialBackoff()\n }\n }\n ws.onopen = () => {\n settle(() => {\n this.connected = true\n\n if (this.opts.token)\n this.tryAuthenticate()\n else\n this.tryAnnounce()\n\n resolve()\n })\n }\n })\n\n return this.connectAttempt\n }\n\n async connect() {\n if (this.connected) {\n return\n }\n if (this.connectTask) {\n return this.connectTask\n }\n\n this.connectTask = this.tryReconnectWithExponentialBackoff().finally(() => (this.connectTask = undefined))\n\n return this.connectTask\n }\n\n private tryAnnounce() {\n this.send({\n type: 'module:announce',\n data: {\n name: this.opts.name,\n possibleEvents: this.opts.possibleEvents,\n },\n })\n }\n\n private tryAuthenticate() {\n if (this.opts.token) {\n this.send({\n type: 'module:authenticate',\n data: { token: this.opts.token },\n })\n }\n }\n\n // bound reference avoids new closure allocation on every connect\n private readonly handleMessageBound = (event: MessageEvent) => {\n void this.handleMessage(event)\n }\n\n private async handleMessage(event: MessageEvent) {\n try {\n const data = JSON.parse(event.data as string) as WebSocketEvent<C>\n const listeners = this.eventListeners.get(data.type)\n if (!listeners?.size) {\n return\n }\n\n // Execute all listeners concurrently\n const executions: Promise<void>[] = []\n for (const listener of listeners) {\n executions.push(Promise.resolve(listener(data as any)))\n }\n\n await Promise.allSettled(executions)\n }\n catch (err) {\n console.error('Failed to parse message:', err)\n this.opts.onError?.(err)\n }\n }\n\n onEvent<E extends keyof WebSocketEvents<C>>(\n event: E,\n callback: (data: WebSocketBaseEvent<E, WebSocketEvents<C>[E]>) => void | Promise<void>,\n ): void {\n let listeners = this.eventListeners.get(event)\n if (!listeners) {\n listeners = new Set()\n this.eventListeners.set(event, listeners)\n }\n listeners.add(callback as any)\n }\n\n offEvent<E extends keyof WebSocketEvents<C>>(\n event: E,\n callback?: (data: WebSocketBaseEvent<E, WebSocketEvents<C>[E]>) => void,\n ): void {\n const listeners = this.eventListeners.get(event)\n if (!listeners) {\n return\n }\n\n if (callback) {\n listeners.delete(callback as any)\n if (!listeners.size) {\n this.eventListeners.delete(event)\n }\n }\n else {\n this.eventListeners.delete(event)\n }\n }\n\n send(data: WebSocketEventOptionalSource<C>): void {\n if (this.websocket && this.connected) {\n this.websocket.send(JSON.stringify({ source: this.opts.name as WebSocketEventSource | string, ...data } as WebSocketEvent<C>))\n }\n }\n\n sendRaw(data: string | ArrayBufferLike | ArrayBufferView): void {\n if (this.websocket && this.connected) {\n this.websocket.send(data)\n }\n }\n\n close(): void {\n this.shouldClose = true\n if (this.websocket) {\n this.websocket.close()\n this.connected = false\n }\n }\n\n private async _reconnectDueToUnauthorized() {\n if (this.shouldClose)\n return\n\n const ws = this.websocket\n this.connected = false\n if (ws && ws.readyState !== WebSocket.CLOSED && ws.readyState !== WebSocket.CLOSING) {\n ws.close()\n }\n\n await this.connect()\n }\n}\n"],"x_google_ignoreList":[0],"mappings":";;;;AAAA,MAAM,QAAQ,OAAO,UAAU,IAAI,SAAS,YAAY,WAAW,SAAS,MAAM,CAAC;;;;ACwBnF,IAAa,SAAb,MAAmC;CACjC,AAAQ,YAAY;CACpB,AAAQ,aAAa;CACrB,AAAQ;CACR,AAAQ,cAAc;CACtB,AAAQ;CACR,AAAQ;CAER,AAAiB;CACjB,AAAiB,iCAAiB,IAAI,KAGnC;CAEH,YAAY,SAA2B;AACrC,OAAK,OAAO;GACV,KAAK;GACL,gBAAgB,EAAE;GAClB,eAAe;GACf,eAAe;GACf,aAAa;GACb,eAAe;GACf,sBAAsB;GACtB,GAAG;GACJ;AAGD,OAAK,QAAQ,wBAAwB,OAAO,UAAU;AACpD,OAAI,MAAM,KAAK,cACb,MAAK,aAAa;OAGlB,OAAM,KAAK,kCAAkC,KAAK,iBAAiB,CAAC;IAEtE;AAEF,OAAK,QAAQ,SAAS,OAAO,UAAU;AACrC,OAAI,MAAM,KAAK,YAAY,oBACzB,OAAM,KAAK,6BAA6B;IAE1C;AAEF,MAAI,KAAK,KAAK,YACZ,CAAK,KAAK,SAAS;;CAIvB,MAAc,4BAA4B,IAAgC;EACxE,MAAM,EAAE,yBAAyB,KAAK;EACtC,IAAI,WAAW;AAGf,SAAO,MAAM;AACX,OAAI,yBAAyB,MAAM,YAAY,sBAAsB;AACnE,YAAQ,MAAM,2BAA2B,qBAAqB,WAAW;AACzE;;AAGF,OAAI;AACF,UAAM,IAAI;AACV;YAEK,KAAK;AACV,SAAK,KAAK,UAAU,IAAI;AAExB,UAAM,MADQ,KAAK,IAAI,KAAK,WAAW,KAAM,IAAO,CAClC;AAClB;;;;CAKN,MAAc,qCAAqC;AACjD,MAAI,KAAK,YACP,OAAM,IAAI,MAAM,mBAAmB;AAGrC,QAAM,KAAK,kCAAkC,KAAK,UAAU,CAAC;;CAG/D,AAAQ,WAA0B;AAChC,MAAI,KAAK,eAAe,KAAK,UAC3B,QAAO,QAAQ,SAAS;AAE1B,MAAI,KAAK,WACP,QAAO,KAAK,kBAAkB,QAAQ,SAAS;AAGjD,OAAK,iBAAiB,IAAI,SAAS,SAAS,WAAW;AACrD,QAAK,aAAa;GAClB,IAAI,UAAU;GAEd,MAAM,UAAU,OAAmB;AACjC,QAAI,QACF;AAEF,cAAU;AACV,SAAK,aAAa;AAClB,SAAK,iBAAiB;AACtB,QAAI;;GAGN,MAAM,KAAK,IAAI,UAAU,KAAK,KAAK,IAAI;AACvC,QAAK,YAAY;AAEjB,MAAG,YAAY,KAAK;AACpB,MAAG,WAAW,UAAe;AAC3B,iBAAa;AACX,UAAK,YAAY;AAEjB,UAAK,KAAK,UAAU,MAAM;AAC1B,YAAO,OAAO,yBAAS,IAAI,MAAM,kBAAkB,CAAC;MACpD;;AAEJ,MAAG,gBAAgB;AACjB,QAAI,CAAC,WAAW,CAAC,KAAK,WAAW;AAC/B,kBAAa;AACX,6BAAO,IAAI,MAAM,+BAA+B,CAAC;OACjD;AACF;;AAGF,QAAI,KAAK,WAAW;AAClB,UAAK,YAAY;AACjB,UAAK,KAAK,WAAW;;AAEvB,QAAI,KAAK,KAAK,iBAAiB,CAAC,KAAK,YACnC,CAAK,KAAK,oCAAoC;;AAGlD,MAAG,eAAe;AAChB,iBAAa;AACX,UAAK,YAAY;AAEjB,SAAI,KAAK,KAAK,MACZ,MAAK,iBAAiB;SAEtB,MAAK,aAAa;AAEpB,cAAS;MACT;;IAEJ;AAEF,SAAO,KAAK;;CAGd,MAAM,UAAU;AACd,MAAI,KAAK,UACP;AAEF,MAAI,KAAK,YACP,QAAO,KAAK;AAGd,OAAK,cAAc,KAAK,oCAAoC,CAAC,cAAe,KAAK,cAAc,OAAW;AAE1G,SAAO,KAAK;;CAGd,AAAQ,cAAc;AACpB,OAAK,KAAK;GACR,MAAM;GACN,MAAM;IACJ,MAAM,KAAK,KAAK;IAChB,gBAAgB,KAAK,KAAK;IAC3B;GACF,CAAC;;CAGJ,AAAQ,kBAAkB;AACxB,MAAI,KAAK,KAAK,MACZ,MAAK,KAAK;GACR,MAAM;GACN,MAAM,EAAE,OAAO,KAAK,KAAK,OAAO;GACjC,CAAC;;CAKN,AAAiB,sBAAsB,UAAwB;AAC7D,EAAK,KAAK,cAAc,MAAM;;CAGhC,MAAc,cAAc,OAAqB;AAC/C,MAAI;GACF,MAAM,OAAO,KAAK,MAAM,MAAM,KAAe;GAC7C,MAAM,YAAY,KAAK,eAAe,IAAI,KAAK,KAAK;AACpD,OAAI,CAAC,WAAW,KACd;GAIF,MAAMA,aAA8B,EAAE;AACtC,QAAK,MAAM,YAAY,UACrB,YAAW,KAAK,QAAQ,QAAQ,SAAS,KAAY,CAAC,CAAC;AAGzD,SAAM,QAAQ,WAAW,WAAW;WAE/B,KAAK;AACV,WAAQ,MAAM,4BAA4B,IAAI;AAC9C,QAAK,KAAK,UAAU,IAAI;;;CAI5B,QACE,OACA,UACM;EACN,IAAI,YAAY,KAAK,eAAe,IAAI,MAAM;AAC9C,MAAI,CAAC,WAAW;AACd,+BAAY,IAAI,KAAK;AACrB,QAAK,eAAe,IAAI,OAAO,UAAU;;AAE3C,YAAU,IAAI,SAAgB;;CAGhC,SACE,OACA,UACM;EACN,MAAM,YAAY,KAAK,eAAe,IAAI,MAAM;AAChD,MAAI,CAAC,UACH;AAGF,MAAI,UAAU;AACZ,aAAU,OAAO,SAAgB;AACjC,OAAI,CAAC,UAAU,KACb,MAAK,eAAe,OAAO,MAAM;QAInC,MAAK,eAAe,OAAO,MAAM;;CAIrC,KAAK,MAA6C;AAChD,MAAI,KAAK,aAAa,KAAK,UACzB,MAAK,UAAU,KAAK,KAAK,UAAU;GAAE,QAAQ,KAAK,KAAK;GAAuC,GAAG;GAAM,CAAsB,CAAC;;CAIlI,QAAQ,MAAwD;AAC9D,MAAI,KAAK,aAAa,KAAK,UACzB,MAAK,UAAU,KAAK,KAAK;;CAI7B,QAAc;AACZ,OAAK,cAAc;AACnB,MAAI,KAAK,WAAW;AAClB,QAAK,UAAU,OAAO;AACtB,QAAK,YAAY;;;CAIrB,MAAc,8BAA8B;AAC1C,MAAI,KAAK,YACP;EAEF,MAAM,KAAK,KAAK;AAChB,OAAK,YAAY;AACjB,MAAI,MAAM,GAAG,eAAe,UAAU,UAAU,GAAG,eAAe,UAAU,QAC1E,IAAG,OAAO;AAGZ,QAAM,KAAK,SAAS"}
1
+ {"version":3,"file":"index.mjs","names":["executions: Promise<void>[]"],"sources":["../../../node_modules/.pnpm/@moeru+std@0.1.0-beta.14/node_modules/@moeru/std/dist/sleep/index.js","../src/client.ts"],"sourcesContent":["const sleep = async (delay) => new Promise((resolve) => setTimeout(resolve, delay));\n\nexport { sleep };\n","import type {\n MetadataEventSource,\n WebSocketBaseEvent,\n WebSocketEvent,\n WebSocketEventOptionalSource,\n WebSocketEvents,\n WebSocketEventSource,\n} from '@proj-airi/server-shared/types'\n\nimport WebSocket from 'crossws/websocket'\n\nimport { sleep } from '@moeru/std'\nimport {\n MessageHeartbeat,\n MessageHeartbeatKind,\n} from '@proj-airi/server-shared/types'\n\nexport interface ClientOptions<C = undefined> {\n url?: string\n name: string\n possibleEvents?: Array<keyof WebSocketEvents<C>>\n token?: string\n identity?: MetadataEventSource\n heartbeat?: {\n readTimeout?: number\n message?: MessageHeartbeat | string\n }\n onError?: (error: unknown) => void\n onClose?: () => void\n autoConnect?: boolean\n autoReconnect?: boolean\n maxReconnectAttempts?: number\n}\n\nfunction createInstanceId() {\n return `${Date.now().toString(36)}-${Math.random().toString(36).slice(2, 8)}`\n}\n\nexport class Client<C = undefined> {\n private connected = false\n private connecting = false\n private websocket?: WebSocket\n private shouldClose = false\n private connectAttempt?: Promise<void>\n private connectTask?: Promise<void>\n private heartbeatTimer?: ReturnType<typeof setInterval>\n private readonly identity: MetadataEventSource\n\n private readonly opts: Required<Omit<ClientOptions<C>, 'token'>> & Pick<ClientOptions<C>, 'token'>\n private readonly eventListeners = new Map<\n keyof WebSocketEvents<C>,\n Set<(data: WebSocketBaseEvent<any, any>) => void | Promise<void>>\n >()\n\n constructor(options: ClientOptions<C>) {\n const identity = options.identity ?? {\n plugin: options.name,\n instanceId: createInstanceId(),\n }\n\n this.opts = {\n url: 'ws://localhost:6121/ws',\n possibleEvents: [],\n onError: () => {},\n onClose: () => {},\n autoConnect: true,\n autoReconnect: true,\n maxReconnectAttempts: -1,\n heartbeat: {\n readTimeout: 30_000,\n message: MessageHeartbeat.Ping,\n },\n ...options,\n identity,\n }\n\n this.identity = identity\n\n // Authentication listener is registered once only\n this.onEvent('module:authenticated', async (event) => {\n if (event.data.authenticated) {\n this.tryAnnounce()\n }\n else {\n await this.retryWithExponentialBackoff(() => this.tryAuthenticate())\n }\n })\n\n this.onEvent('error', async (event) => {\n if (event.data.message === 'not authenticated') {\n await this._reconnectDueToUnauthorized()\n }\n })\n\n this.onEvent('transport:connection:heartbeat', (event) => {\n if (event.data.kind === MessageHeartbeatKind.Ping) {\n this.sendHeartbeatPong()\n }\n })\n\n if (this.opts.autoConnect) {\n void this.connect()\n }\n }\n\n private async retryWithExponentialBackoff(fn: () => void | Promise<void>) {\n const { maxReconnectAttempts } = this.opts\n let attempts = 0\n\n // Loop until attempts exceed maxReconnectAttempts, or unlimited if -1\n while (true) {\n if (maxReconnectAttempts !== -1 && attempts >= maxReconnectAttempts) {\n console.error(`Maximum retry attempts (${maxReconnectAttempts}) reached`)\n return\n }\n\n try {\n await fn()\n return\n }\n catch (err) {\n this.opts.onError?.(err)\n const delay = Math.min(2 ** attempts * 1000, 30_000) // capped exponential backoff\n await sleep(delay)\n attempts++\n }\n }\n }\n\n private async tryReconnectWithExponentialBackoff() {\n if (this.shouldClose) {\n throw new Error('Client is closed')\n }\n\n await this.retryWithExponentialBackoff(() => this._connect())\n }\n\n private _connect(): Promise<void> {\n if (this.shouldClose || this.connected) {\n return Promise.resolve()\n }\n if (this.connecting) {\n return this.connectAttempt ?? Promise.resolve()\n }\n\n this.connectAttempt = new Promise((resolve, reject) => {\n this.connecting = true\n let settled = false\n\n const settle = (fn: () => void) => {\n if (settled)\n return\n\n settled = true\n this.connecting = false\n this.connectAttempt = undefined\n fn()\n }\n\n const ws = new WebSocket(this.opts.url)\n this.websocket = ws\n\n ws.onmessage = this.handleMessageBound\n ws.onerror = (event: any) => {\n settle(() => {\n this.connected = false\n\n this.opts.onError?.(event)\n reject(event?.error ?? new Error('WebSocket error'))\n })\n }\n ws.onclose = () => {\n if (!settled && !this.connected) {\n settle(() => {\n reject(new Error('WebSocket closed before open'))\n })\n return\n }\n\n if (this.connected) {\n this.connected = false\n this.stopHeartbeat()\n this.opts.onClose?.()\n }\n if (this.opts.autoReconnect && !this.shouldClose) {\n void this.tryReconnectWithExponentialBackoff()\n }\n }\n ws.onopen = () => {\n settle(() => {\n this.connected = true\n\n this.startHeartbeat()\n\n if (this.opts.token)\n this.tryAuthenticate()\n else\n this.tryAnnounce()\n\n resolve()\n })\n }\n })\n\n return this.connectAttempt\n }\n\n async connect() {\n if (this.connected) {\n return\n }\n if (this.connectTask) {\n return this.connectTask\n }\n\n this.connectTask = this.tryReconnectWithExponentialBackoff().finally(() => (this.connectTask = undefined))\n\n return this.connectTask\n }\n\n private tryAnnounce() {\n this.send({\n type: 'module:announce',\n data: {\n name: this.opts.name,\n identity: this.identity,\n possibleEvents: this.opts.possibleEvents,\n },\n })\n }\n\n private tryAuthenticate() {\n if (this.opts.token) {\n this.send({\n type: 'module:authenticate',\n data: { token: this.opts.token },\n })\n }\n }\n\n // bound reference avoids new closure allocation on every connect\n private readonly handleMessageBound = (event: MessageEvent) => {\n void this.handleMessage(event)\n }\n\n private async handleMessage(event: MessageEvent) {\n try {\n const data = JSON.parse(event.data as string) as WebSocketEvent<C>\n const listeners = this.eventListeners.get(data.type)\n if (!listeners?.size) {\n return\n }\n\n // Execute all listeners concurrently\n const executions: Promise<void>[] = []\n for (const listener of listeners) {\n executions.push(Promise.resolve(listener(data as any)))\n }\n\n await Promise.allSettled(executions)\n }\n catch (err) {\n console.error('Failed to parse message:', err)\n this.opts.onError?.(err)\n }\n }\n\n onEvent<E extends keyof WebSocketEvents<C>>(\n event: E,\n callback: (data: WebSocketBaseEvent<E, WebSocketEvents<C>[E]>) => void | Promise<void>,\n ): void {\n let listeners = this.eventListeners.get(event)\n if (!listeners) {\n listeners = new Set()\n this.eventListeners.set(event, listeners)\n }\n listeners.add(callback as any)\n }\n\n offEvent<E extends keyof WebSocketEvents<C>>(\n event: E,\n callback?: (data: WebSocketBaseEvent<E, WebSocketEvents<C>[E]>) => void,\n ): void {\n const listeners = this.eventListeners.get(event)\n if (!listeners) {\n return\n }\n\n if (callback) {\n listeners.delete(callback as any)\n if (!listeners.size) {\n this.eventListeners.delete(event)\n }\n }\n else {\n this.eventListeners.delete(event)\n }\n }\n\n send(data: WebSocketEventOptionalSource<C>): void {\n if (this.websocket && this.connected) {\n this.websocket.send(JSON.stringify({\n source: this.opts.name as WebSocketEventSource | string,\n metadata: { source: this.identity },\n ...data,\n } as WebSocketEvent<C>))\n }\n }\n\n sendRaw(data: string | ArrayBufferLike | ArrayBufferView): void {\n if (this.websocket && this.connected) {\n this.websocket.send(data)\n }\n }\n\n close(): void {\n this.shouldClose = true\n this.stopHeartbeat()\n if (this.websocket) {\n this.websocket.close()\n this.connected = false\n }\n }\n\n private startHeartbeat() {\n if (!this.opts.heartbeat?.readTimeout) {\n return\n }\n\n this.stopHeartbeat()\n\n const ping = () => this.sendHeartbeatPing()\n\n ping()\n this.heartbeatTimer = setInterval(ping, this.opts.heartbeat.readTimeout)\n }\n\n private stopHeartbeat() {\n if (this.heartbeatTimer) {\n clearInterval(this.heartbeatTimer)\n this.heartbeatTimer = undefined\n }\n }\n\n private sendNativeHeartbeat(kind: 'ping' | 'pong') {\n const websocket = this.websocket as WebSocket & {\n ping?: () => void\n pong?: () => void\n }\n\n if (kind === 'ping') {\n websocket.ping?.()\n }\n else {\n websocket.pong?.()\n }\n }\n\n private sendHeartbeatPing() {\n this.send({\n type: 'transport:connection:heartbeat',\n data: {\n kind: MessageHeartbeatKind.Ping,\n message: this.opts.heartbeat?.message ?? MessageHeartbeat.Ping,\n at: Date.now(),\n },\n })\n this.sendNativeHeartbeat('ping')\n }\n\n private sendHeartbeatPong() {\n this.send({\n type: 'transport:connection:heartbeat',\n data: {\n kind: MessageHeartbeatKind.Pong,\n message: MessageHeartbeat.Pong,\n at: Date.now(),\n },\n })\n this.sendNativeHeartbeat('pong')\n }\n\n private async _reconnectDueToUnauthorized() {\n if (this.shouldClose)\n return\n\n const ws = this.websocket\n this.connected = false\n if (ws && ws.readyState !== WebSocket.CLOSED && ws.readyState !== WebSocket.CLOSING) {\n ws.close()\n }\n\n await this.connect()\n }\n}\n"],"x_google_ignoreList":[0],"mappings":";;;;AAAA,MAAM,QAAQ,OAAO,UAAU,IAAI,SAAS,YAAY,WAAW,SAAS,MAAM,CAAC;;;;ACkCnF,SAAS,mBAAmB;AAC1B,QAAO,GAAG,KAAK,KAAK,CAAC,SAAS,GAAG,CAAC,GAAG,KAAK,QAAQ,CAAC,SAAS,GAAG,CAAC,MAAM,GAAG,EAAE;;AAG7E,IAAa,SAAb,MAAmC;CACjC,AAAQ,YAAY;CACpB,AAAQ,aAAa;CACrB,AAAQ;CACR,AAAQ,cAAc;CACtB,AAAQ;CACR,AAAQ;CACR,AAAQ;CACR,AAAiB;CAEjB,AAAiB;CACjB,AAAiB,iCAAiB,IAAI,KAGnC;CAEH,YAAY,SAA2B;EACrC,MAAM,WAAW,QAAQ,YAAY;GACnC,QAAQ,QAAQ;GAChB,YAAY,kBAAkB;GAC/B;AAED,OAAK,OAAO;GACV,KAAK;GACL,gBAAgB,EAAE;GAClB,eAAe;GACf,eAAe;GACf,aAAa;GACb,eAAe;GACf,sBAAsB;GACtB,WAAW;IACT,aAAa;IACb,SAAS,iBAAiB;IAC3B;GACD,GAAG;GACH;GACD;AAED,OAAK,WAAW;AAGhB,OAAK,QAAQ,wBAAwB,OAAO,UAAU;AACpD,OAAI,MAAM,KAAK,cACb,MAAK,aAAa;OAGlB,OAAM,KAAK,kCAAkC,KAAK,iBAAiB,CAAC;IAEtE;AAEF,OAAK,QAAQ,SAAS,OAAO,UAAU;AACrC,OAAI,MAAM,KAAK,YAAY,oBACzB,OAAM,KAAK,6BAA6B;IAE1C;AAEF,OAAK,QAAQ,mCAAmC,UAAU;AACxD,OAAI,MAAM,KAAK,SAAS,qBAAqB,KAC3C,MAAK,mBAAmB;IAE1B;AAEF,MAAI,KAAK,KAAK,YACZ,CAAK,KAAK,SAAS;;CAIvB,MAAc,4BAA4B,IAAgC;EACxE,MAAM,EAAE,yBAAyB,KAAK;EACtC,IAAI,WAAW;AAGf,SAAO,MAAM;AACX,OAAI,yBAAyB,MAAM,YAAY,sBAAsB;AACnE,YAAQ,MAAM,2BAA2B,qBAAqB,WAAW;AACzE;;AAGF,OAAI;AACF,UAAM,IAAI;AACV;YAEK,KAAK;AACV,SAAK,KAAK,UAAU,IAAI;AAExB,UAAM,MADQ,KAAK,IAAI,KAAK,WAAW,KAAM,IAAO,CAClC;AAClB;;;;CAKN,MAAc,qCAAqC;AACjD,MAAI,KAAK,YACP,OAAM,IAAI,MAAM,mBAAmB;AAGrC,QAAM,KAAK,kCAAkC,KAAK,UAAU,CAAC;;CAG/D,AAAQ,WAA0B;AAChC,MAAI,KAAK,eAAe,KAAK,UAC3B,QAAO,QAAQ,SAAS;AAE1B,MAAI,KAAK,WACP,QAAO,KAAK,kBAAkB,QAAQ,SAAS;AAGjD,OAAK,iBAAiB,IAAI,SAAS,SAAS,WAAW;AACrD,QAAK,aAAa;GAClB,IAAI,UAAU;GAEd,MAAM,UAAU,OAAmB;AACjC,QAAI,QACF;AAEF,cAAU;AACV,SAAK,aAAa;AAClB,SAAK,iBAAiB;AACtB,QAAI;;GAGN,MAAM,KAAK,IAAI,UAAU,KAAK,KAAK,IAAI;AACvC,QAAK,YAAY;AAEjB,MAAG,YAAY,KAAK;AACpB,MAAG,WAAW,UAAe;AAC3B,iBAAa;AACX,UAAK,YAAY;AAEjB,UAAK,KAAK,UAAU,MAAM;AAC1B,YAAO,OAAO,yBAAS,IAAI,MAAM,kBAAkB,CAAC;MACpD;;AAEJ,MAAG,gBAAgB;AACjB,QAAI,CAAC,WAAW,CAAC,KAAK,WAAW;AAC/B,kBAAa;AACX,6BAAO,IAAI,MAAM,+BAA+B,CAAC;OACjD;AACF;;AAGF,QAAI,KAAK,WAAW;AAClB,UAAK,YAAY;AACjB,UAAK,eAAe;AACpB,UAAK,KAAK,WAAW;;AAEvB,QAAI,KAAK,KAAK,iBAAiB,CAAC,KAAK,YACnC,CAAK,KAAK,oCAAoC;;AAGlD,MAAG,eAAe;AAChB,iBAAa;AACX,UAAK,YAAY;AAEjB,UAAK,gBAAgB;AAErB,SAAI,KAAK,KAAK,MACZ,MAAK,iBAAiB;SAEtB,MAAK,aAAa;AAEpB,cAAS;MACT;;IAEJ;AAEF,SAAO,KAAK;;CAGd,MAAM,UAAU;AACd,MAAI,KAAK,UACP;AAEF,MAAI,KAAK,YACP,QAAO,KAAK;AAGd,OAAK,cAAc,KAAK,oCAAoC,CAAC,cAAe,KAAK,cAAc,OAAW;AAE1G,SAAO,KAAK;;CAGd,AAAQ,cAAc;AACpB,OAAK,KAAK;GACR,MAAM;GACN,MAAM;IACJ,MAAM,KAAK,KAAK;IAChB,UAAU,KAAK;IACf,gBAAgB,KAAK,KAAK;IAC3B;GACF,CAAC;;CAGJ,AAAQ,kBAAkB;AACxB,MAAI,KAAK,KAAK,MACZ,MAAK,KAAK;GACR,MAAM;GACN,MAAM,EAAE,OAAO,KAAK,KAAK,OAAO;GACjC,CAAC;;CAKN,AAAiB,sBAAsB,UAAwB;AAC7D,EAAK,KAAK,cAAc,MAAM;;CAGhC,MAAc,cAAc,OAAqB;AAC/C,MAAI;GACF,MAAM,OAAO,KAAK,MAAM,MAAM,KAAe;GAC7C,MAAM,YAAY,KAAK,eAAe,IAAI,KAAK,KAAK;AACpD,OAAI,CAAC,WAAW,KACd;GAIF,MAAMA,aAA8B,EAAE;AACtC,QAAK,MAAM,YAAY,UACrB,YAAW,KAAK,QAAQ,QAAQ,SAAS,KAAY,CAAC,CAAC;AAGzD,SAAM,QAAQ,WAAW,WAAW;WAE/B,KAAK;AACV,WAAQ,MAAM,4BAA4B,IAAI;AAC9C,QAAK,KAAK,UAAU,IAAI;;;CAI5B,QACE,OACA,UACM;EACN,IAAI,YAAY,KAAK,eAAe,IAAI,MAAM;AAC9C,MAAI,CAAC,WAAW;AACd,+BAAY,IAAI,KAAK;AACrB,QAAK,eAAe,IAAI,OAAO,UAAU;;AAE3C,YAAU,IAAI,SAAgB;;CAGhC,SACE,OACA,UACM;EACN,MAAM,YAAY,KAAK,eAAe,IAAI,MAAM;AAChD,MAAI,CAAC,UACH;AAGF,MAAI,UAAU;AACZ,aAAU,OAAO,SAAgB;AACjC,OAAI,CAAC,UAAU,KACb,MAAK,eAAe,OAAO,MAAM;QAInC,MAAK,eAAe,OAAO,MAAM;;CAIrC,KAAK,MAA6C;AAChD,MAAI,KAAK,aAAa,KAAK,UACzB,MAAK,UAAU,KAAK,KAAK,UAAU;GACjC,QAAQ,KAAK,KAAK;GAClB,UAAU,EAAE,QAAQ,KAAK,UAAU;GACnC,GAAG;GACJ,CAAsB,CAAC;;CAI5B,QAAQ,MAAwD;AAC9D,MAAI,KAAK,aAAa,KAAK,UACzB,MAAK,UAAU,KAAK,KAAK;;CAI7B,QAAc;AACZ,OAAK,cAAc;AACnB,OAAK,eAAe;AACpB,MAAI,KAAK,WAAW;AAClB,QAAK,UAAU,OAAO;AACtB,QAAK,YAAY;;;CAIrB,AAAQ,iBAAiB;AACvB,MAAI,CAAC,KAAK,KAAK,WAAW,YACxB;AAGF,OAAK,eAAe;EAEpB,MAAM,aAAa,KAAK,mBAAmB;AAE3C,QAAM;AACN,OAAK,iBAAiB,YAAY,MAAM,KAAK,KAAK,UAAU,YAAY;;CAG1E,AAAQ,gBAAgB;AACtB,MAAI,KAAK,gBAAgB;AACvB,iBAAc,KAAK,eAAe;AAClC,QAAK,iBAAiB;;;CAI1B,AAAQ,oBAAoB,MAAuB;EACjD,MAAM,YAAY,KAAK;AAKvB,MAAI,SAAS,OACX,WAAU,QAAQ;MAGlB,WAAU,QAAQ;;CAItB,AAAQ,oBAAoB;AAC1B,OAAK,KAAK;GACR,MAAM;GACN,MAAM;IACJ,MAAM,qBAAqB;IAC3B,SAAS,KAAK,KAAK,WAAW,WAAW,iBAAiB;IAC1D,IAAI,KAAK,KAAK;IACf;GACF,CAAC;AACF,OAAK,oBAAoB,OAAO;;CAGlC,AAAQ,oBAAoB;AAC1B,OAAK,KAAK;GACR,MAAM;GACN,MAAM;IACJ,MAAM,qBAAqB;IAC3B,SAAS,iBAAiB;IAC1B,IAAI,KAAK,KAAK;IACf;GACF,CAAC;AACF,OAAK,oBAAoB,OAAO;;CAGlC,MAAc,8BAA8B;AAC1C,MAAI,KAAK,YACP;EAEF,MAAM,KAAK,KAAK;AAChB,OAAK,YAAY;AACjB,MAAI,MAAM,GAAG,eAAe,UAAU,UAAU,GAAG,eAAe,UAAU,QAC1E,IAAG,OAAO;AAGZ,QAAM,KAAK,SAAS"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@proj-airi/server-sdk",
3
3
  "type": "module",
4
- "version": "0.8.1-beta.6",
4
+ "version": "0.8.1-beta.8",
5
5
  "description": "Client-side SDK implementation for connecting to AIRI server components and runtimes",
6
6
  "author": {
7
7
  "name": "Moeru AI Project AIRI Team",
@@ -34,7 +34,7 @@
34
34
  "dependencies": {
35
35
  "crossws": "^0.4.1",
36
36
  "defu": "^6.1.4",
37
- "@proj-airi/server-shared": "^0.8.1-beta.6"
37
+ "@proj-airi/server-shared": "^0.8.1-beta.8"
38
38
  },
39
39
  "devDependencies": {
40
40
  "@moeru/std": "0.1.0-beta.14"