@awesomate/sdk 0.17.0 → 0.18.1

package/dist/index.d.ts

@@ -24,7 +24,7 @@
  * Docs: https://hub.awesomate.ai/docs/sdk/
  */
 /** This package's version, sent to the hub with every server call. */
-export declare const VERSION = "0.17.0";
+export declare const VERSION = "0.18.1";
 /** Augmented by the generated awesomate.d.ts, so each kind's rows are typed. */
 export interface Kinds {
 }
@@ -290,7 +290,7 @@ export declare class AwesomateClient {
         move: (from: string, to: string) => Promise<FileEntry>;
         /** Move a file from private/ or temp/ to the same place under public/, and answer its public_url. Anyone with the address can open it. */
         makePublic: (path: string) => Promise<FileEntry>;
-        /** Move a file out of public/ into private/. Its public address stops serving it, though Cloudflare can keep showing the last copy for up to 4 hours. */
+        /** Move a file out of public/ into private/. Its public address stops serving it within seconds (a browser that already opened it may keep its own copy for a while). */
         makePrivate: (path: string) => Promise<FileEntry>;
         /** Move to the trash. Not erased, and no longer counted toward the Files space. */
         remove: (path: string) => Promise<{
@@ -830,7 +830,7 @@ export interface HereHandle {
      * stopped (on send or blur). Without another call, typing ends on its own after a few seconds.
      */
     typing(on: boolean): void;
-    /** Close the record: the others stop seeing this person on it. */
+    /** Close the record: the others stop seeing this person on it once every part of the page that opened it has left. */
     leave(): void;
 }
 /** What live() calls. */
@@ -1007,7 +1007,9 @@ export declare class AwesomateAppClient {
      * Open a record (a job's conversation) for who-is-here: onPeople gets everyone else who has it
      * open with their tab in front, and who is typing, at first and on every change; the app's
      * assistant appears while it writes a reply. The hub checks this person may read the record, and
-     * keeps checking; onError hears a refusal. Shares the one live connection. Returns typing() and leave().
+     * keeps checking; onError hears a refusal. Shares the one live connection. Two parts of a page (a
+     * thread and a sidebar) can open the same record: each hears onPeople, and it stays open until both
+     * have left. Returns typing() and leave().
      */
     here(recordId: string, onPeople: (people: HerePerson[]) => void, onError?: (err: AwesomateError) => void): HereHandle;
 }

package/dist/index.js

@@ -24,7 +24,7 @@
  * Docs: https://hub.awesomate.ai/docs/sdk/
  */
 /** This package's version, sent to the hub with every server call. */
-export const VERSION = '0.17.0';
+export const VERSION = '0.18.1';
 const DEFAULT_BASE = 'https://hub.awesomate.ai';
 const ERROR_CODES = ['unauthenticated', 'forbidden', 'not_found', 'validation', 'consent_blocked', 'rate_limited', 'conflict', 'unavailable'];
 /**
@@ -220,7 +220,7 @@ export class AwesomateClient {
                 throw new AwesomateError('validation', 'Name a file inside the folder.', 0, 'path');
             return this.files.move(path, `public/${rest.join('/')}`);
         },
-        /** Move a file out of public/ into private/. Its public address stops serving it, though Cloudflare can keep showing the last copy for up to 4 hours. */
+        /** Move a file out of public/ into private/. Its public address stops serving it within seconds (a browser that already opened it may keep its own copy for a while). */
         makePrivate: async (path) => {
             const [top, ...rest] = path.replace(/^\/+/, '').split('/');
             if (top !== 'public' || !rest.length)
@@ -799,7 +799,9 @@ export class AwesomateAppClient {
      * Open a record (a job's conversation) for who-is-here: onPeople gets everyone else who has it
      * open with their tab in front, and who is typing, at first and on every change; the app's
      * assistant appears while it writes a reply. The hub checks this person may read the record, and
-     * keeps checking; onError hears a refusal. Shares the one live connection. Returns typing() and leave().
+     * keeps checking; onError hears a refusal. Shares the one live connection. Two parts of a page (a
+     * thread and a sidebar) can open the same record: each hears onPeople, and it stays open until both
+     * have left. Returns typing() and leave().
      */
     here(recordId, onPeople, onError) {
         return this.liveSocket().join(recordId, onPeople, onError);
@@ -842,32 +844,57 @@ class LiveSocket {
         if (this.ready && typeof d?.visibilityState === 'string')
             this.send({ type: 'presence', visible: d.visibilityState === 'visible' });
     }
-    /** Records open with here(): who else is on them goes to onPeople. */
+    /**
+     * Records open with here(), one per record id however many parts of the page opened it: the hub
+     * hears `here on` once and `here off` when the last of them leaves, and every one of them gets
+     * onPeople. Typing is the person's, so one resend clock per record, shared by them all.
+     */
     rooms = new Map();
     get wanted() {
         return this.entries.size > 0 || this.rooms.size > 0;
     }
     join(id, onPeople, onError) {
-        const room = { onPeople, onError, typingSentAt: 0 };
-        this.rooms.set(id, room);
-        if (this.ready)
-            this.send({ type: 'here', id, on: true });
-        else if (!this.ws && !this.connecting)
-            void this.connect();
+        const listener = { onPeople, onError };
+        let room = this.rooms.get(id);
+        if (room) {
+            room.listeners.add(listener);
+            // Already open: the hub sends nothing new for a second join, so hand over who it last said was there.
+            const people = room.people;
+            if (people)
+                queueMicrotask(() => { if (this.rooms.get(id)?.listeners.has(listener))
+                    onPeople(people); });
+        }
+        else {
+            room = { listeners: new Set([listener]), typingSentAt: 0, people: null };
+            this.rooms.set(id, room);
+            if (this.ready)
+                this.send({ type: 'here', id, on: true });
+            else if (!this.ws && !this.connecting)
+                void this.connect();
+        }
+        const open = () => {
+            const r = this.rooms.get(id);
+            return r?.listeners.has(listener) ? r : undefined;
+        };
         return {
             typing: (on) => {
-                if (this.rooms.get(id) !== room || !this.ready)
+                const r = open();
+                if (!r || !this.ready)
                     return;
                 const now = Date.now();
-                if (on && now - room.typingSentAt < TYPING_RESEND_MS)
+                if (on && now - r.typingSentAt < TYPING_RESEND_MS)
                     return;
-                if (!on && !room.typingSentAt)
+                if (!on && !r.typingSentAt)
                     return;
-                room.typingSentAt = on ? now : 0;
+                r.typingSentAt = on ? now : 0;
                 this.send({ type: 'typing', id, on });
             },
             leave: () => {
-                if (this.rooms.get(id) !== room)
+                const r = open();
+                if (!r)
+                    return;
+                r.listeners.delete(listener);
+                if (r.listeners.size)
                     return;
                 this.rooms.delete(id);
                 if (this.ready)
@@ -948,7 +975,13 @@ class LiveSocket {
             return;
         }
         if (f.type === 'people' && typeof f.id === 'string') {
-            this.rooms.get(f.id)?.onPeople(Array.isArray(f.people) ? f.people : []);
+            const room = this.rooms.get(f.id);
+            if (!room)
+                return;
+            const people = Array.isArray(f.people) ? f.people : [];
+            room.people = people;
+            for (const l of [...room.listeners])
+                l.onPeople(people);
             return;
         }
         if (f.type === 'error' && typeof f.id === 'string' && f.id.startsWith('here:')) {
@@ -958,7 +991,9 @@ class LiveSocket {
                 return;
             this.rooms.delete(id);
             const code = ERROR_CODES.includes(String(f.code)) ? f.code : 'unavailable';
-            room.onError?.(new AwesomateError(code, String(f.message ?? 'Refused.'), 0, undefined, String(f.code)));
+            const err = new AwesomateError(code, String(f.message ?? 'Refused.'), 0, undefined, String(f.code));
+            for (const l of room.listeners)
+                l.onError?.(err);
             if (!this.wanted)
                 this.shut();
             return;
@@ -1013,6 +1048,8 @@ class LiveSocket {
         if (this.retry)
             clearTimeout(this.retry);
         this.pinger = this.retry = null;
+        for (const room of this.rooms.values())
+            room.people = null;
         if (ws && ws.readyState <= 1) {
             try {
                 ws.send(JSON.stringify({ type: 'bye' }));
@@ -1039,6 +1076,9 @@ class LiveSocket {
         if (this.pinger)
             clearInterval(this.pinger);
         this.pinger = null;
+        // Who was there is the old connection's word: a part opening a record now waits for the new one.
+        for (const room of this.rooms.values())
+            room.people = null;
         if (this.stopped || !this.wanted)
             return;
         if (code === 4401) {
@@ -1060,7 +1100,8 @@ class LiveSocket {
         for (const e of all)
             e.handlers.onError?.(err);
         for (const r of rooms)
-            r.onError?.(err);
+            for (const l of r.listeners)
+                l.onError?.(err);
         this.shut();
     }
     shut() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awesomate/sdk",
-  "version": "0.17.0",
+  "version": "0.18.1",
   "description": "Your own Awesomate data from Node and the browser: query contacts and app data with generated types, and sign your app's own users in",
   "license": "MIT",
   "type": "module",