@pluv/client 0.25.4 → 0.27.0

package/dist/index.mjs

@@ -52,6 +52,41 @@ var AbstractStorageStore = class {
   }
 };
 
+// src/PluvProcedure.ts
+var PluvProcedure = class _PluvProcedure {
+  constructor(config = {}) {
+    this._broadcast = null;
+    this._input = null;
+    const { broadcast, input } = config;
+    this._broadcast = broadcast != null ? broadcast : null;
+    this._input = input != null ? input : null;
+  }
+  get config() {
+    var _a, _b, _c;
+    return {
+      broadcast: (_b = (_a = this._broadcast) == null ? void 0 : _a.bind(this)) != null ? _b : null,
+      input: (_c = this._input) != null ? _c : null,
+      resolver: this._resolver()
+    };
+  }
+  broadcast(resolver) {
+    const { broadcast } = this.config;
+    if (!!broadcast) throw new Error("Broadcast was already defined for this procedure");
+    return new _PluvProcedure(__spreadProps(__spreadValues({}, this.config), {
+      broadcast: resolver
+    }));
+  }
+  input(input) {
+    return new _PluvProcedure({ input });
+  }
+  _resolver() {
+    return (data, context) => {
+      var _a;
+      return (_a = this._broadcast) == null ? void 0 : _a.call(this, data, context);
+    };
+  }
+};
+
 // src/CrdtManager.ts
 import { noop } from "@pluv/crdt";
 var CrdtManager = class {
@@ -179,6 +214,21 @@ var OtherNotifier = class {
   }
 };
 
+// src/PluvRouter.ts
+var PluvRouter = class _PluvRouter {
+  constructor(events) {
+    this._defs = { events: {} };
+    this._defs = { events };
+  }
+  static merge(...routers) {
+    const events = Object.assign(/* @__PURE__ */ Object.create(null), ...routers.map((router) => router._defs.events));
+    if (Object.keys(events).some((key) => key.startsWith("$"))) {
+      throw new Error('Procedures may not start with "$"');
+    }
+    return new _PluvRouter(events);
+  }
+};
+
 // src/StateNotifier.ts
 import { makeSubject as makeSubject4, subscribe as subscribe4 } from "wonka";
 var StateNotifier = class {
@@ -199,6 +249,31 @@ var StateNotifier = class {
   }
 };
 
+// src/StorageStore.ts
+var StorageStore = class extends AbstractStorageStore {
+  addUpdate() {
+    return Promise.resolve();
+  }
+  applyUpdates() {
+    return Promise.resolve();
+  }
+  destroy() {
+    return Promise.resolve();
+  }
+  flatten() {
+    return Promise.resolve();
+  }
+  getShouldFlatten() {
+    return Promise.resolve(false);
+  }
+  getUpdates() {
+    return Promise.resolve([]);
+  }
+  initialize() {
+    return Promise.resolve();
+  }
+};
+
 // src/UsersManager.ts
 var UsersManager = class {
   constructor(config) {
@@ -292,7 +367,7 @@ var UsersManager = class {
   }
 };
 
-// src/types.ts
+// src/enums.ts
 var ConnectionState = /* @__PURE__ */ ((ConnectionState2) => {
   ConnectionState2["Closed"] = "Closed";
   ConnectionState2["Connecting"] = "Connecting";
@@ -302,179 +377,6 @@ var ConnectionState = /* @__PURE__ */ ((ConnectionState2) => {
   return ConnectionState2;
 })(ConnectionState || {});
 
-// src/MockedRoom.ts
-var MockedRoom = class extends AbstractRoom {
-  constructor(room, options) {
-    const { events, initialPresence, initialStorage, presence } = options;
-    super(room);
-    this._crdtNotifier = new CrdtNotifier();
-    this._eventNotifier = new EventNotifier();
-    this._otherNotifier = new OtherNotifier();
-    this._state = {
-      authorization: {
-        token: null,
-        user: null
-      },
-      connection: {
-        count: 1,
-        id: null,
-        state: "Untouched" /* Untouched */
-      },
-      webSocket: null
-    };
-    this._stateNotifier = new StateNotifier();
-    this._subscriptions = {
-      observeCrdt: null
-    };
-    this.canRedo = () => {
-      return !!this._crdtManager.doc.canRedo();
-    };
-    this.canUndo = () => {
-      return !!this._crdtManager.doc.canUndo();
-    };
-    this.event = (event, callback) => {
-      return this._eventNotifier.subscribe(event, callback);
-    };
-    this.getConnection = () => {
-      return Object.freeze(JSON.parse(JSON.stringify(this._state.connection)));
-    };
-    this.getMyPresence = () => {
-      return this._usersManager.myPresence;
-    };
-    this.getMyself = () => {
-      return this._usersManager.myself;
-    };
-    this.getOther = (connectionId) => {
-      return this._usersManager.getOther(connectionId);
-    };
-    this.getOthers = () => {
-      return this._usersManager.getOthers();
-    };
-    this.getStorage = (type) => {
-      const sharedType = this._crdtManager.get(type);
-      if (typeof sharedType === "undefined") return null;
-      return sharedType;
-    };
-    this.other = (connectionId, callback) => {
-      return this._otherNotifier.subscribe(connectionId, callback);
-    };
-    this.redo = () => {
-      this._crdtManager.doc.redo();
-    };
-    this.storage = (key, fn) => {
-      return this._crdtNotifier.subscribe(key, fn);
-    };
-    this.storageRoot = (fn) => {
-      return this._crdtNotifier.subcribeRoot(fn);
-    };
-    this.subscribe = (name, callback) => {
-      return this._stateNotifier.subscribe(name, callback);
-    };
-    this.transact = (fn, origin) => {
-      const _origin = origin != null ? origin : this._state.connection.id;
-      const crdtManager = this._crdtManager;
-      if (typeof _origin !== "string") return;
-      if (!crdtManager) return;
-      crdtManager.doc.transact(() => {
-        const storage = crdtManager.doc.get();
-        fn(storage);
-      }, _origin);
-    };
-    this.undo = () => {
-      this._crdtManager.doc.undo();
-    };
-    this.updateMyPresence = (presence) => {
-      var _a;
-      const newPresence = typeof presence === "function" ? presence(this.getMyPresence()) : presence;
-      this._usersManager.updateMyPresence(newPresence);
-      const myPresence = this._usersManager.myPresence;
-      const myself = (_a = this._usersManager.myself) != null ? _a : null;
-      this._stateNotifier.subjects["my-presence"].next(myPresence);
-      !!myself && this._stateNotifier.subjects["myself"].next(myself);
-    };
-    this._events = events;
-    this._usersManager = new UsersManager({
-      initialPresence,
-      presence
-    });
-    this._crdtManager = new CrdtManager({
-      initialStorage
-    });
-    this._observeCrdt();
-  }
-  get storageLoaded() {
-    return true;
-  }
-  broadcast(event, data) {
-    if (!this._events) return;
-    const resolver = this._events[event];
-    if (!resolver) return;
-    const result = resolver(data);
-    Object.keys(result).forEach((type) => {
-      const _type = type.toString();
-      const data2 = result[_type];
-      if (!data2) return;
-      this._eventNotifier.subject(_type).next(data2);
-    });
-  }
-  getDoc() {
-    return this._crdtManager.doc;
-  }
-  getStorageJson(type) {
-    if (this._state.connection.id === null) return null;
-    if (typeof type === "undefined") return this._crdtManager.doc.toJson();
-    return this._crdtManager.doc.toJson(type);
-  }
-  _observeCrdt() {
-    var _a, _b;
-    (_b = (_a = this._subscriptions).observeCrdt) == null ? void 0 : _b.call(_a);
-    if (!this._crdtManager) return;
-    const unsubscribe = this._crdtManager.doc.subscribe((event) => {
-      var _a2;
-      const origin = (_a2 = event.origin) != null ? _a2 : null;
-      if (!this._crdtManager) return;
-      if (origin === "$STORAGE_UPDATED") return;
-      const sharedTypes = this._crdtManager.doc.get();
-      const storageRoot = Object.keys(sharedTypes).reduce(
-        (acc, prop) => {
-          if (!this._crdtManager) return acc;
-          const serialized = this._crdtManager.doc.toJson(prop);
-          this._crdtNotifier.subject(prop).next(serialized);
-          return __spreadProps(__spreadValues({}, acc), { [prop]: serialized });
-        },
-        {}
-      );
-      this._crdtNotifier.rootSubject.next(storageRoot);
-    });
-    this._subscriptions.observeCrdt = unsubscribe;
-  }
-};
-
-// src/StorageStore.ts
-var StorageStore = class extends AbstractStorageStore {
-  addUpdate() {
-    return Promise.resolve();
-  }
-  applyUpdates() {
-    return Promise.resolve();
-  }
-  destroy() {
-    return Promise.resolve();
-  }
-  flatten() {
-    return Promise.resolve();
-  }
-  getShouldFlatten() {
-    return Promise.resolve(false);
-  }
-  getUpdates() {
-    return Promise.resolve([]);
-  }
-  initialize() {
-    return Promise.resolve();
-  }
-};
-
 // src/utils/debounce.ts
 var debounce = (fn, options) => {
   const { wait, immediate = false } = options != null ? options : {};
@@ -512,8 +414,10 @@ var PluvRoom = class extends AbstractRoom {
       debug = false,
       initialPresence,
       initialStorage,
+      metadata,
       onAuthorizationFail,
       presence,
+      router,
       wsEndpoint
     } = options;
     super(room);
@@ -522,6 +426,7 @@ var PluvRoom = class extends AbstractRoom {
     this._intervals = {
       heartbeat: null
     };
+    this._metadata = {};
     this._otherNotifier = new OtherNotifier();
     this._state = {
       authorization: {
@@ -546,17 +451,37 @@ var PluvRoom = class extends AbstractRoom {
     this._windowListeners = null;
     this._wsListeners = null;
     this.broadcast = new Proxy(
-      (event, data) => {
+      (event, data) => __async(this, null, function* () {
         if (!this._state.webSocket) return;
         if (this._state.connection.state !== "Open" /* Open */) return;
         const type = event.toString();
-        this._sendMessage({ data, type });
-      },
+        const procedure = this._router._defs.events[type];
+        if (!(procedure == null ? void 0 : procedure.config.broadcast)) {
+          this._sendMessage({ data, type });
+          return;
+        }
+        const myself = this._usersManager.myself;
+        if (!myself) return;
+        const parsed = procedure.config.input ? procedure.config.input.parse(data) : data;
+        const context = {
+          doc: this._crdtManager.doc,
+          others: this._usersManager.getOthers(),
+          room: this.id,
+          user: myself
+        };
+        const output = yield procedure.config.broadcast(
+          parsed,
+          context
+        );
+        Object.entries(output).forEach(([_type, _data]) => {
+          this._sendMessage({ data: _data, type: _type });
+        });
+      }),
       {
         get(fn, prop) {
-          return (data) => {
-            return fn(prop, data);
-          };
+          return (data) => __async(this, null, function* () {
+            return yield fn(prop, data);
+          });
         }
       }
     );
@@ -631,7 +556,10 @@ var PluvRoom = class extends AbstractRoom {
       const myself = (_a = this._usersManager.myself) != null ? _a : null;
       this._stateNotifier.subjects["my-presence"].next(myPresence);
       !!myself && this._stateNotifier.subjects["myself"].next(myself);
-      this.broadcast("$UPDATE_PRESENCE", { presence: newPresence });
+      this.broadcast(
+        "$UPDATE_PRESENCE",
+        { presence: newPresence }
+      );
     };
     this._flattenStorageStore = debounce(
       () => __async(this, null, function* () {
@@ -652,9 +580,10 @@ var PluvRoom = class extends AbstractRoom {
     };
     const addon = this._getAddon(addons);
     const { storage } = __spreadValues(__spreadValues({}, DEFAULT_PLUV_CLIENT_ADDON({ room: this })), addon({ room: this }));
-    this._storageStore = storage;
     this._debug = debug;
     this._endpoints = { authEndpoint, wsEndpoint };
+    this._storageStore = storage;
+    if (!!metadata) this._metadata = metadata;
     this._listeners = {
       onAuthorizationFail: (error) => {
         this._clearTimeout(this._timeouts.reconnect);
@@ -662,6 +591,7 @@ var PluvRoom = class extends AbstractRoom {
         onAuthorizationFail == null ? void 0 : onAuthorizationFail(error);
       }
     };
+    this._router = router != null ? router : new PluvRouter({});
     this._usersManager = new UsersManager({ initialPresence, presence });
     this._crdtManager = new CrdtManager({ initialStorage });
   }
@@ -846,7 +776,7 @@ var PluvRoom = class extends AbstractRoom {
         options: {}
       };
     }
-    const result = this._endpoints.authEndpoint(room);
+    const result = this._endpoints.authEndpoint({ metadata: this._metadata, room });
     return typeof result === "string" ? { url: result, options: {} } : result;
   }
   _getAuthorization(room) {
@@ -872,7 +802,7 @@ var PluvRoom = class extends AbstractRoom {
       case "string":
         return this._endpoints.wsEndpoint;
       default:
-        return this._endpoints.wsEndpoint(room);
+        return this._endpoints.wsEndpoint({ metadata: this._metadata, room });
     }
   }
   _handleExit(message) {
@@ -1230,8 +1160,11 @@ var PluvClient = class {
         authEndpoint: this._authEndpoint,
         debug: options.debug,
         initialPresence: options.initialPresence,
-        initialStorage: options.initialStorage,
+        initialStorage: this._initialStorage,
+        metadata: options.metadata,
         onAuthorizationFail: options.onAuthorizationFail,
+        presence: this._presence,
+        router: options.router,
         wsEndpoint: this._wsEndpoint
       });
       this._rooms.set(room, newRoom);
@@ -1240,9 +1173,7 @@ var PluvClient = class {
     };
     this.enter = (room) => __async(this, null, function* () {
       const toEnter = typeof room === "string" ? this.getRoom(room) : room;
-      if (!toEnter) {
-        throw new Error(`Could not find room: ${room}.`);
-      }
+      if (!toEnter) throw new Error(`Could not find room: ${room}.`);
       this._rooms.set(toEnter.id, toEnter);
       yield toEnter.connect();
       this._logDebug(`Entered room: ${room}`);
@@ -1262,11 +1193,19 @@ var PluvClient = class {
       this._rooms.delete(toLeave.id);
       this._logDebug(`Left and deleted room: ${room}`);
     });
-    const { authEndpoint, debug = false, wsEndpoint } = options;
+    const { authEndpoint, debug = false, initialStorage, presence, wsEndpoint } = options;
     this._authEndpoint = authEndpoint;
     this._debug = debug;
+    this._initialStorage = initialStorage;
+    this._presence = presence;
     this._wsEndpoint = wsEndpoint;
   }
+  get procedure() {
+    return new PluvProcedure();
+  }
+  router(events) {
+    return new PluvRouter(events);
+  }
   _logDebug(...data) {
     var _a;
     if (((_a = process == null ? void 0 : process.env) == null ? void 0 : _a.NODE_ENV) === "production") return;
@@ -1278,6 +1217,196 @@ var PluvClient = class {
 var createClient = (options) => {
   return new PluvClient(options);
 };
+
+// src/MockedRoom.ts
+var MockedRoom = class extends AbstractRoom {
+  constructor(room, options) {
+    const { events, initialPresence, initialStorage, presence, router } = options;
+    super(room);
+    this._crdtNotifier = new CrdtNotifier();
+    this._eventNotifier = new EventNotifier();
+    this._otherNotifier = new OtherNotifier();
+    this._state = {
+      authorization: {
+        token: null,
+        user: null
+      },
+      connection: {
+        count: 1,
+        id: null,
+        state: "Untouched" /* Untouched */
+      },
+      webSocket: null
+    };
+    this._stateNotifier = new StateNotifier();
+    this._subscriptions = {
+      observeCrdt: null
+    };
+    this.broadcast = new Proxy(
+      (event, data) => __async(this, null, function* () {
+        if (!this._state.webSocket) return;
+        if (this._state.connection.state !== "Open" /* Open */) return;
+        const type = event.toString();
+        const procedure = this._router._defs.events[type];
+        if (!(procedure == null ? void 0 : procedure.config.broadcast)) {
+          this._simulateEvent(type, data);
+          return;
+        }
+        const myself = this._usersManager.myself;
+        if (!myself) return;
+        const parsed = procedure.config.input ? procedure.config.input.parse(data) : data;
+        const context = {
+          doc: this._crdtManager.doc,
+          others: this._usersManager.getOthers(),
+          room: this.id,
+          user: myself
+        };
+        const output = yield procedure.config.broadcast(
+          parsed,
+          context
+        );
+        Object.entries(output).forEach(([_type, _data]) => {
+          this._simulateEvent(_type, _data);
+        });
+      }),
+      {
+        get(fn, prop) {
+          return (data) => __async(this, null, function* () {
+            return yield fn(prop, data);
+          });
+        }
+      }
+    );
+    this.canRedo = () => {
+      return !!this._crdtManager.doc.canRedo();
+    };
+    this.canUndo = () => {
+      return !!this._crdtManager.doc.canUndo();
+    };
+    this.event = new Proxy(
+      (event, callback) => this._eventNotifier.subscribe(event, callback),
+      {
+        get(fn, prop) {
+          return (callback) => fn(prop, callback);
+        }
+      }
+    );
+    this.getConnection = () => {
+      return Object.freeze(JSON.parse(JSON.stringify(this._state.connection)));
+    };
+    this.getMyPresence = () => {
+      return this._usersManager.myPresence;
+    };
+    this.getMyself = () => {
+      return this._usersManager.myself;
+    };
+    this.getOther = (connectionId) => {
+      return this._usersManager.getOther(connectionId);
+    };
+    this.getOthers = () => {
+      return this._usersManager.getOthers();
+    };
+    this.getStorage = (type) => {
+      const sharedType = this._crdtManager.get(type);
+      if (typeof sharedType === "undefined") return null;
+      return sharedType;
+    };
+    this.other = (connectionId, callback) => {
+      return this._otherNotifier.subscribe(connectionId, callback);
+    };
+    this.redo = () => {
+      this._crdtManager.doc.redo();
+    };
+    this.storage = (key, fn) => {
+      return this._crdtNotifier.subscribe(key, fn);
+    };
+    this.storageRoot = (fn) => {
+      return this._crdtNotifier.subcribeRoot(fn);
+    };
+    this.subscribe = (name, callback) => {
+      return this._stateNotifier.subscribe(name, callback);
+    };
+    this.transact = (fn, origin) => {
+      const _origin = origin != null ? origin : this._state.connection.id;
+      const crdtManager = this._crdtManager;
+      if (typeof _origin !== "string") return;
+      if (!crdtManager) return;
+      crdtManager.doc.transact(() => {
+        const storage = crdtManager.doc.get();
+        fn(storage);
+      }, _origin);
+    };
+    this.undo = () => {
+      this._crdtManager.doc.undo();
+    };
+    this.updateMyPresence = (presence) => {
+      var _a;
+      const newPresence = typeof presence === "function" ? presence(this.getMyPresence()) : presence;
+      this._usersManager.updateMyPresence(newPresence);
+      const myPresence = this._usersManager.myPresence;
+      const myself = (_a = this._usersManager.myself) != null ? _a : null;
+      this._stateNotifier.subjects["my-presence"].next(myPresence);
+      !!myself && this._stateNotifier.subjects["myself"].next(myself);
+    };
+    this._events = events;
+    this._router = router != null ? router : new PluvRouter({});
+    this._usersManager = new UsersManager({
+      initialPresence,
+      presence
+    });
+    this._crdtManager = new CrdtManager({
+      initialStorage
+    });
+    this._observeCrdt();
+  }
+  get storageLoaded() {
+    return true;
+  }
+  getDoc() {
+    return this._crdtManager.doc;
+  }
+  getStorageJson(type) {
+    if (this._state.connection.id === null) return null;
+    if (typeof type === "undefined") return this._crdtManager.doc.toJson();
+    return this._crdtManager.doc.toJson(type);
+  }
+  _observeCrdt() {
+    var _a, _b;
+    (_b = (_a = this._subscriptions).observeCrdt) == null ? void 0 : _b.call(_a);
+    if (!this._crdtManager) return;
+    const unsubscribe = this._crdtManager.doc.subscribe((event) => {
+      var _a2;
+      const origin = (_a2 = event.origin) != null ? _a2 : null;
+      if (!this._crdtManager) return;
+      if (origin === "$STORAGE_UPDATED") return;
+      const sharedTypes = this._crdtManager.doc.get();
+      const storageRoot = Object.keys(sharedTypes).reduce(
+        (acc, prop) => {
+          if (!this._crdtManager) return acc;
+          const serialized = this._crdtManager.doc.toJson(prop);
+          this._crdtNotifier.subject(prop).next(serialized);
+          return __spreadProps(__spreadValues({}, acc), { [prop]: serialized });
+        },
+        {}
+      );
+      this._crdtNotifier.rootSubject.next(storageRoot);
+    });
+    this._subscriptions.observeCrdt = unsubscribe;
+  }
+  _simulateEvent(event, data) {
+    if (!this._events) return;
+    const type = event.toString();
+    const resolver = this._events[type];
+    if (!resolver) return;
+    const result = resolver(data);
+    Object.keys(result).forEach((type2) => {
+      const _type = type2.toString();
+      const data2 = result[_type];
+      if (!data2) return;
+      this._eventNotifier.subject(_type).next(data2);
+    });
+  }
+};
 export {
   AbstractRoom,
   AbstractStorageStore,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/client",
-  "version": "0.25.4",
+  "version": "0.27.0",
   "description": "@pluv/io frontend client",
   "author": "leedavidcs",
   "license": "MIT",
@@ -18,15 +18,15 @@
   },
   "dependencies": {
     "wonka": "^6.3.4",
-    "@pluv/crdt": "^0.25.4",
-    "@pluv/types": "^0.25.4"
+    "@pluv/crdt": "^0.27.0",
+    "@pluv/types": "^0.27.0"
   },
   "devDependencies": {
     "eslint": "^8.57.0",
-    "tsup": "^8.2.4",
-    "typescript": "^5.5.4",
-    "@pluv/tsconfig": "^0.25.4",
-    "eslint-config-pluv": "^0.25.4"
+    "tsup": "^8.3.0",
+    "typescript": "^5.6.2",
+    "@pluv/tsconfig": "^0.27.0",
+    "eslint-config-pluv": "^0.27.0"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/AbstractRoom.ts

@@ -2,6 +2,7 @@ import type { AbstractCrdtDoc, CrdtType, InferCrdtJson } from "@pluv/crdt";
 import type { IOLike, Id, InferIOInput, InferIOOutput, JsonObject } from "@pluv/types";
 import type { EventNotifierSubscriptionCallback } from "./EventNotifier";
 import type { OtherNotifierSubscriptionCallback } from "./OtherNotifier";
+import type { MergeEvents, PluvRouterEventConfig } from "./PluvRouter";
 import type { StateNotifierSubjects, SubscriptionCallback } from "./StateNotifier";
 import type { UpdateMyPresenceAction, UserInfo, WebSocketConnection } from "./types";
 
@@ -9,6 +10,7 @@ export abstract class AbstractRoom<
     TIO extends IOLike,
     TPresence extends JsonObject = {},
     TStorage extends Record<string, CrdtType<any, any>> = {},
+    TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {},
 > {
     public readonly id: string;
 
@@ -18,9 +20,9 @@ export abstract class AbstractRoom<
 
     public abstract storageLoaded: boolean;
 
-    public abstract broadcast<TEvent extends keyof InferIOInput<TIO>>(
+    public abstract broadcast<TEvent extends keyof InferIOInput<MergeEvents<TEvents, TIO>>>(
         event: TEvent,
-        data: Id<InferIOInput<TIO>[TEvent]>,
+        data: Id<InferIOInput<MergeEvents<TEvents, TIO>>[TEvent]>,
     ): void;
 
     public abstract canRedo(): boolean;
@@ -29,9 +31,9 @@ export abstract class AbstractRoom<
 
     public abstract getDoc(): AbstractCrdtDoc<TStorage>;
 
-    public abstract event<TEvent extends keyof InferIOOutput<TIO>>(
+    public abstract event<TEvent extends keyof InferIOOutput<MergeEvents<TEvents, TIO>>>(
         event: TEvent,
-        callback: EventNotifierSubscriptionCallback<TIO, TEvent>,
+        callback: EventNotifierSubscriptionCallback<MergeEvents<TEvents, TIO>, TEvent>,
     ): () => void;
 
     public abstract getConnection(): WebSocketConnection;