wirejs-resources 0.1.59 → 0.1.61-realtime

package/dist/client/index.js

@@ -52,6 +52,50 @@ async function callApi(INTERNAL_API_URL, method, ...args) {
         throw new Error(error);
     }
     const value = body[0].data;
+    if (typeof value === 'object' && value.__wjstype === 'realtime') {
+        const subscribers = [];
+        const ws = new WebSocket(value.url, value.protocol);
+        ws.onmessage = (event) => {
+            const data = JSON.parse(event.data);
+            if (data.data) {
+                for (const subscriber of subscribers) {
+                    try {
+                        subscriber.onmessage(data.data);
+                    }
+                    catch (error) {
+                        console.error('Error in subscriber onmessage:', error);
+                    }
+                }
+            }
+        };
+        ws.onclose = event => {
+            for (const subscriber of subscribers) {
+                if (subscriber.onclose) {
+                    try {
+                        subscriber.onclose();
+                    }
+                    catch (error) {
+                        console.error('Error in subscriber onclose:', error);
+                    }
+                }
+            }
+            console.log('closed', event);
+        };
+        return {
+            subscribe(subscriber) {
+                subscribers.push(subscriber);
+                return () => {
+                    const index = subscribers.indexOf(subscriber);
+                    if (index !== -1) {
+                        subscribers.splice(index, 1);
+                    }
+                    if (subscribers.length === 0) {
+                        ws.close();
+                    }
+                };
+            }
+        };
+    }
     return value;
 }
 ;

package/dist/index.d.ts

@@ -10,3 +10,4 @@ export { DistributedTable, PassThruParser, matchesFilter, indexName } from './re
 export type * from './resources/distributed-table.js';
 export * from './types/index.js';
 export * from './derived-types.js';
+export * from './services/realtime.js';

package/dist/index.js

@@ -9,3 +9,4 @@ export { Secret } from './resources/secret.js';
 export { DistributedTable, PassThruParser, matchesFilter, indexName } from './resources/distributed-table.js';
 export * from './types/index.js';
 export * from './derived-types.js';
+export * from './services/realtime.js';

package/dist/overrides.d.ts

@@ -1,6 +1,7 @@
 import type { FileService } from "./services/file";
 import type { AuthenticationService } from "./services/authentication";
 import type { Secret } from "./resources/secret";
+import type { RealtimeService } from "./services/realtime";
 /**
  * Used by hosting providers to provide service overrides.
  */
@@ -9,4 +10,5 @@ export declare const overrides: {
     DistributedTable?: typeof AuthenticationService;
     FileService?: typeof FileService;
     Secret?: typeof Secret;
+    RealtimeService?: typeof RealtimeService;
 };

package/dist/resources/distributed-table.js

@@ -158,48 +158,3 @@ export class DistributedTable extends Resource {
         });
     }
 }
-// export type Todo = {
-// 	id: string;
-// 	text: string;
-// 	order: number;
-// };
-// const userTodos = new DistributedTable('app', 'userTodos', {
-// 	parse: PassThruParser<Todo & { userId: string }>,
-// 	key: {
-// 		partition: { field: 'userId', type: 'string' },
-// 		sort: { field: 'order', type: 'number' }
-// 		// sort: { field: 'id', type: 'string' }
-// 		// sort: { }
-// 	},
-// 	indexes: [
-// 		{
-// 			partition: { field: 'text', type: 'string' },
-// 			sort: { field: 'userId', type: 'string' }
-// 			// sort: { field: 'order', type: 'number' }
-// 		}
-// 	]
-// });
-// type I = typeof userTodos['key'];
-// type T1 = typeof userTodos['key']['partition']['field'];
-// type T2 = typeof userTodos['key']['sort']['field'];
-// type T3 = typeof userTodos['indexes'];
-// type TTT1 = AllIndexes<typeof userTodos>;
-// type TTT2 = AllIndexesByName<typeof userTodos>;
-// type AnyIndex = Index<any>;
-// type TEST1 = I extends Index<any> ? 'yes' : 'no';
-// userTodos.query({
-// 	by: 'userId-order',
-// 	where: {
-// 		// maybe the key here can be the actual name of the field.
-// 		// maybe even follow the filter pattern, but only expose the `eq` operation:
-// 		// { [field]: { eq: T } }
-// 		userId: { eq: 'something' },
-// 		// id: {
-// 		// 	eq: 'something'
-// 		// }
-// 		// same here. name of the actual sort key field.
-// 		// id: {
-// 		// 	beginsWith: 'something'
-// 		// },
-// 	},
-// })

package/dist/services/realtime.d.ts

@@ -1,4 +1,13 @@
 import { Resource } from '../resource.js';
+export type MessageStream<T = any> = {
+    /**
+     * Returns a function to close the subscription.
+     */
+    subscribe(subscriber: {
+        onmessage: (data: T) => void;
+        onclose?: () => void;
+    }): () => void;
+};
 export declare class RealtimeService<T = any> extends Resource {
     #private;
     constructor(scope: Resource | string, id: string);
@@ -6,9 +15,6 @@ export declare class RealtimeService<T = any> extends Resource {
      * The address the client will need to connect to.
      */
     get address(): string;
-    publish(channel: string, data: T): void;
-    buildSubscriptionAuthorization(channel: string): Promise<{
-        url: string;
-        protocol: string;
-    }>;
+    publish(channel: string, data: T): Promise<void>;
+    getStream(channel: string): Promise<MessageStream<T>>;
 }

package/dist/services/realtime.js

@@ -3,44 +3,6 @@ import { WebSocketServer, WebSocket } from 'ws';
 import { Resource } from '../resource.js';
 import { Secret } from '../resources/secret.js';
 import { overrides } from '../overrides.js';
-// TODO: this interface is very much a work in progress.
-// currently thinking that we will want to expose a couple different
-// "realtime" services or resources that are purpose built for three
-// distinct use-cases:
-//
-// 1. a "p2p" rt service as a fallback for WebRTC messaging.
-//    this would put the full burden of validating messages on the
-//    client. we could still gate onsubscribe, but the intent would
-//    be that clients can then send messages freely. goal is hyper-efficient
-//    messaging between clients with minimal server overhead.
-//
-// 2. sending messages from server to client.
-//    the implication is that the client subscribes to specific channels,
-//    such as updates to a specific table. the server, again, gates
-//    subscriptions to the channel. and messages *to* the channel can
-//    originate *only* from the server, ensuring they are delivered in the
-//    expected format and that they can be trusted.
-//
-// 3. low-trust p2p messaging.
-//    this would be a hybrid of the first two. clients can send messages
-//    to each other, but the server is responsible for validating the
-//    messages. unless option 1, which is more of a fallback when WebRTC
-//    cannot be established, this option accepts much higher overhead,
-//    latency, and cloud costs at the benefit of server-side validation.
-//    this allows the client to trust messages, and allows p2p messages
-//    to have side effects, such as leaving behind a durable record.
-//
-// notably, option 3 can be mimicked with option 2 + the regular API's we
-// already support. so, it should be the last option we put serious time
-// and consideration to. but, we should at least know how we might achieve it.
-//
-// debatable whether each of these use-cases should be fulfilled with a
-// single constructor or triggered by purpose-built constructors.
-//
-// using purpose-built constructors might help clarify the optimizations
-// each use-case asks for from hosting providers. might also help streamline
-// development of the service, as we can focus on a single use-case at a time.
-//
 const servers = new Map();
 const channels = new Map();
 export class RealtimeService extends Resource {
@@ -149,7 +111,7 @@ export class RealtimeService extends Resource {
             throw new Error('Server address is not available');
         }
     }
-    publish(channel, data) {
+    async publish(channel, data) {
         this.#requireServer();
         this.#validateChannelName(channel);
         console.log('Publishing to channel:', channel, data);
@@ -159,7 +121,7 @@ export class RealtimeService extends Resource {
             }
         });
     }
-    async buildSubscriptionAuthorization(channel) {
+    async getStream(channel) {
         this.#requireServer();
         this.#validateChannelName(channel);
         const channelString = Buffer.from(channel).toString('base64');
@@ -169,7 +131,10 @@ export class RealtimeService extends Resource {
             .setIssuedAt()
             .setExpirationTime(`10s`)
             .sign(new TextEncoder().encode(await this.#secret.read()));
+        // The type we return is not at all what we actually return.
+        // It's the metadata needed to satisfy the contract client-side.
         return {
+            __wjstype: 'realtime',
             url: `${this.address}/${channelString}`,
             protocol: jwt
         };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wirejs-resources",
-	"version": "0.1.59",
+	"version": "0.1.61-realtime",
 	"description": "Basic services and server-side resources for wirejs apps",
 	"type": "module",
 	"main": "./dist/index.js",
@@ -34,9 +34,11 @@
 	},
 	"homepage": "https://github.com/svidgen/create-wirejs-app#readme",
 	"dependencies": {
-		"jose": "^5.9.6"
+		"jose": "^5.9.6",
+		"ws": "^8.18.2"
 	},
 	"devDependencies": {
+		"@types/ws": "^8.18.1",
 		"typescript": "^5.7.3"
 	},
 	"files": [