@pluv/client 0.36.0 → 0.37.1

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/client@0.36.0 build /home/runner/work/pluv/pluv/packages/client
+> @pluv/client@0.37.1 build /home/runner/work/pluv/pluv/packages/client
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -8,11 +8,11 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 47.24 KB
-ESM ⚡️ Build success in 135ms
-CJS dist/index.js 48.56 KB
-CJS ⚡️ Build success in 138ms
+ESM dist/index.mjs 47.44 KB
+ESM ⚡️ Build success in 120ms
+CJS dist/index.js 48.76 KB
+CJS ⚡️ Build success in 121ms
 DTS Build start
-DTS ⚡️ Build success in 3381ms
-DTS dist/index.d.mts 22.82 KB
-DTS dist/index.d.ts  22.82 KB
+DTS ⚡️ Build success in 3590ms
+DTS dist/index.d.mts 23.10 KB
+DTS dist/index.d.ts  23.10 KB

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @pluv/client
 
+## 0.37.1
+
+### Patch Changes
+
+- e923a8d: Added support for specifying the `publicKey` param for `createClient` as a function with metadata. This is particularly useful for non-static Next.js applications built with Cloudflare Pages.
+
+  ```ts
+  import { createClient } from "@pluv/client";
+  import { z } from "zod";
+
+  export const client = createClient({
+    // Can be a string
+    publicKey: "pk_abc123...",
+
+    // Or can be a function
+    metadata: z.object({
+      publicKey: z.string().min(1, "Required"),
+    }),
+    publicKey: ({ metadata }) => metadata.publicKey,
+  });
+  ```
+
+  - @pluv/crdt@0.37.1
+  - @pluv/types@0.37.1
+
+## 0.37.0
+
+### Patch Changes
+
+- @pluv/crdt@0.37.0
+- @pluv/types@0.37.0
+
 ## 0.36.0
 
 ### Minor Changes

package/dist/index.d.mts

@@ -31,6 +31,10 @@ type MergeEventRecords<TEventRecords extends EventRecord<string, any>[], TRoot e
 ] ? MergeEventRecords<ITail, Omit<TRoot, keyof IHead> & {
     [P in keyof IHead]: TRoot extends Record<P, any> ? TRoot[P] | IHead[P] : IHead[P];
 }> : Id<TRoot>;
+interface PublicKeyParams<TMetadata extends JsonObject> {
+    metadata: TMetadata;
+}
+type PublicKey<TMetadata extends JsonObject> = string | ((params: PublicKeyParams<TMetadata>) => string);
 type UpdateMyPresenceAction<TPresence extends JsonObject> = Partial<TPresence> | ((oldPresence: TPresence | null) => Partial<TPresence>);
 interface UserInfo<TIO extends IOLike, TPresence extends JsonObject = {}> {
     connectionId: string;
@@ -190,7 +194,7 @@ type RoomConfig<TIO extends IOLike, TMetadata extends JsonObject = {}, TPresence
     addons?: readonly PluvRoomAddon<TIO, TMetadata, TPresence, TStorage>[];
     debug?: boolean | PluvRoomDebug<TIO>;
     onAuthorizationFail?: (error: Error) => void;
-    publicKey?: string;
+    publicKey?: PublicKey<TMetadata>;
     router?: PluvRouter<TIO, TPresence, TStorage, TEvents>;
 } & RoomEndpoints<TIO, TMetadata> & Pick<CrdtManagerOptions<TStorage>, "initialStorage"> & UsersManagerConfig<TPresence> & (keyof TMetadata extends never ? {
     metadata?: undefined;
@@ -257,6 +261,7 @@ declare class PluvRoom<TIO extends IOLike<any, any>, TMetadata extends JsonObjec
     private _getAddon;
     private _getAuthFetchOptions;
     private _getAuthorization;
+    private _getPublicKey;
     private _getWsEndpoint;
     private _handleExit;
     private _handlePresenceUpdatedMessage;
@@ -299,7 +304,7 @@ type PluvClientOptions<TIO extends IOLike<any, any>, TPresence extends JsonObjec
     initialStorage?: AbstractCrdtDocFactory<TStorage>;
     metadata?: InputZodLike<TMetadata>;
     presence?: InputZodLike<TPresence>;
-    publicKey?: string;
+    publicKey?: PublicKey<TMetadata>;
     types: InferCallback<TIO>;
 };
 type CreateRoomOptions<TIO extends IOLike<any, any>, TPresence extends JsonObject, TStorage extends Record<string, CrdtType<any, any>>, TMetadata extends JsonObject, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> = {
@@ -393,4 +398,4 @@ declare const register: <TMetadata extends JsonObject>(params: RegisterParams<TM
     wsEndpoint: (params: EndpointParams<TMetadata>) => string;
 };
 
-export { AbstractRoom, AbstractStorageStore, ConnectionState, type CreateRoomOptions, type InferCallback, type MergeEvents, MockedRoom, type MockedRoomConfig, type MockedRoomEvents, PluvClient, type PluvClientOptions, type PluvProcedureConfig, PluvRoom, type PluvRoomAddon, type PluvRoomAddonInput, type PluvRoomAddonResult, type PluvRoomDebug, PluvRouter, type PluvRouterEventConfig, type RegisterParams, type RoomEndpoints, type UserInfo, type WebSocketConnection, type WebSocketState, createClient, infer, register };
+export { AbstractRoom, AbstractStorageStore, ConnectionState, type CreateRoomOptions, type InferCallback, type MergeEvents, MockedRoom, type MockedRoomConfig, type MockedRoomEvents, PluvClient, type PluvClientOptions, type PluvProcedureConfig, PluvRoom, type PluvRoomAddon, type PluvRoomAddonInput, type PluvRoomAddonResult, type PluvRoomDebug, PluvRouter, type PluvRouterEventConfig, type PublicKey, type PublicKeyParams, type RegisterParams, type RoomEndpoints, type UserInfo, type WebSocketConnection, type WebSocketState, createClient, infer, register };

package/dist/index.d.ts

@@ -31,6 +31,10 @@ type MergeEventRecords<TEventRecords extends EventRecord<string, any>[], TRoot e
 ] ? MergeEventRecords<ITail, Omit<TRoot, keyof IHead> & {
     [P in keyof IHead]: TRoot extends Record<P, any> ? TRoot[P] | IHead[P] : IHead[P];
 }> : Id<TRoot>;
+interface PublicKeyParams<TMetadata extends JsonObject> {
+    metadata: TMetadata;
+}
+type PublicKey<TMetadata extends JsonObject> = string | ((params: PublicKeyParams<TMetadata>) => string);
 type UpdateMyPresenceAction<TPresence extends JsonObject> = Partial<TPresence> | ((oldPresence: TPresence | null) => Partial<TPresence>);
 interface UserInfo<TIO extends IOLike, TPresence extends JsonObject = {}> {
     connectionId: string;
@@ -190,7 +194,7 @@ type RoomConfig<TIO extends IOLike, TMetadata extends JsonObject = {}, TPresence
     addons?: readonly PluvRoomAddon<TIO, TMetadata, TPresence, TStorage>[];
     debug?: boolean | PluvRoomDebug<TIO>;
     onAuthorizationFail?: (error: Error) => void;
-    publicKey?: string;
+    publicKey?: PublicKey<TMetadata>;
     router?: PluvRouter<TIO, TPresence, TStorage, TEvents>;
 } & RoomEndpoints<TIO, TMetadata> & Pick<CrdtManagerOptions<TStorage>, "initialStorage"> & UsersManagerConfig<TPresence> & (keyof TMetadata extends never ? {
     metadata?: undefined;
@@ -257,6 +261,7 @@ declare class PluvRoom<TIO extends IOLike<any, any>, TMetadata extends JsonObjec
     private _getAddon;
     private _getAuthFetchOptions;
     private _getAuthorization;
+    private _getPublicKey;
     private _getWsEndpoint;
     private _handleExit;
     private _handlePresenceUpdatedMessage;
@@ -299,7 +304,7 @@ type PluvClientOptions<TIO extends IOLike<any, any>, TPresence extends JsonObjec
     initialStorage?: AbstractCrdtDocFactory<TStorage>;
     metadata?: InputZodLike<TMetadata>;
     presence?: InputZodLike<TPresence>;
-    publicKey?: string;
+    publicKey?: PublicKey<TMetadata>;
     types: InferCallback<TIO>;
 };
 type CreateRoomOptions<TIO extends IOLike<any, any>, TPresence extends JsonObject, TStorage extends Record<string, CrdtType<any, any>>, TMetadata extends JsonObject, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> = {
@@ -393,4 +398,4 @@ declare const register: <TMetadata extends JsonObject>(params: RegisterParams<TM
     wsEndpoint: (params: EndpointParams<TMetadata>) => string;
 };
 
-export { AbstractRoom, AbstractStorageStore, ConnectionState, type CreateRoomOptions, type InferCallback, type MergeEvents, MockedRoom, type MockedRoomConfig, type MockedRoomEvents, PluvClient, type PluvClientOptions, type PluvProcedureConfig, PluvRoom, type PluvRoomAddon, type PluvRoomAddonInput, type PluvRoomAddonResult, type PluvRoomDebug, PluvRouter, type PluvRouterEventConfig, type RegisterParams, type RoomEndpoints, type UserInfo, type WebSocketConnection, type WebSocketState, createClient, infer, register };
+export { AbstractRoom, AbstractStorageStore, ConnectionState, type CreateRoomOptions, type InferCallback, type MergeEvents, MockedRoom, type MockedRoomConfig, type MockedRoomEvents, PluvClient, type PluvClientOptions, type PluvProcedureConfig, PluvRoom, type PluvRoomAddon, type PluvRoomAddonInput, type PluvRoomAddonResult, type PluvRoomDebug, PluvRouter, type PluvRouterEventConfig, type PublicKey, type PublicKeyParams, type RegisterParams, type RoomEndpoints, type UserInfo, type WebSocketConnection, type WebSocketState, createClient, infer, register };

package/dist/index.js

@@ -617,7 +617,7 @@ var PluvRoom = class extends AbstractRoom {
     this._endpoints = { authEndpoint, wsEndpoint };
     this._storageStore = storage;
     if (typeof metadata !== "undefined") this._metadata = metadata;
-    if (typeof publicKey === "string") this._publicKey = publicKey;
+    if (!!publicKey) this._publicKey = publicKey;
     this._listeners = {
       onAuthorizationFail: (error) => {
         this._clearTimeout(this._timeouts.reconnect);
@@ -655,9 +655,10 @@ var PluvRoom = class extends AbstractRoom {
       let authToken = null;
       let webSocket;
       try {
+        const publicKey = this._getPublicKey();
         authToken = yield this._getAuthorization(this.id);
         authToken && url.searchParams.set("token", encodeURIComponent(authToken));
-        this._publicKey && url.searchParams.set("public_key", encodeURIComponent(this._publicKey));
+        publicKey && url.searchParams.set("public_key", encodeURIComponent(publicKey));
         webSocket = new WebSocket(url.toString());
       } catch (err) {
         yield this._storageStore.destroy();
@@ -830,6 +831,11 @@ var PluvRoom = class extends AbstractRoom {
       }
     });
   }
+  _getPublicKey() {
+    if (!this._publicKey) return null;
+    if (typeof this._publicKey === "string") return this._publicKey;
+    return this._publicKey({ metadata: this._metadata });
+  }
   _getWsEndpoint(room) {
     switch (typeof this._endpoints.wsEndpoint) {
       case "undefined":

package/dist/index.mjs

@@ -586,7 +586,7 @@ var PluvRoom = class extends AbstractRoom {
     this._endpoints = { authEndpoint, wsEndpoint };
     this._storageStore = storage;
     if (typeof metadata !== "undefined") this._metadata = metadata;
-    if (typeof publicKey === "string") this._publicKey = publicKey;
+    if (!!publicKey) this._publicKey = publicKey;
     this._listeners = {
       onAuthorizationFail: (error) => {
         this._clearTimeout(this._timeouts.reconnect);
@@ -624,9 +624,10 @@ var PluvRoom = class extends AbstractRoom {
       let authToken = null;
       let webSocket;
       try {
+        const publicKey = this._getPublicKey();
         authToken = yield this._getAuthorization(this.id);
         authToken && url.searchParams.set("token", encodeURIComponent(authToken));
-        this._publicKey && url.searchParams.set("public_key", encodeURIComponent(this._publicKey));
+        publicKey && url.searchParams.set("public_key", encodeURIComponent(publicKey));
         webSocket = new WebSocket(url.toString());
       } catch (err) {
         yield this._storageStore.destroy();
@@ -799,6 +800,11 @@ var PluvRoom = class extends AbstractRoom {
       }
     });
   }
+  _getPublicKey() {
+    if (!this._publicKey) return null;
+    if (typeof this._publicKey === "string") return this._publicKey;
+    return this._publicKey({ metadata: this._metadata });
+  }
   _getWsEndpoint(room) {
     switch (typeof this._endpoints.wsEndpoint) {
       case "undefined":

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/client",
-  "version": "0.36.0",
+  "version": "0.37.1",
   "description": "@pluv/io frontend client",
   "author": "leedavidcs",
   "license": "MIT",
@@ -18,15 +18,15 @@
   },
   "dependencies": {
     "wonka": "^6.3.4",
-    "@pluv/crdt": "^0.36.0",
-    "@pluv/types": "^0.36.0"
+    "@pluv/crdt": "^0.37.1",
+    "@pluv/types": "^0.37.1"
   },
   "devDependencies": {
     "eslint": "^8.57.1",
     "tsup": "^8.4.0",
-    "typescript": "^5.7.3",
-    "@pluv/tsconfig": "^0.36.0",
-    "eslint-config-pluv": "^0.36.0"
+    "typescript": "^5.8.2",
+    "@pluv/tsconfig": "^0.37.1",
+    "eslint-config-pluv": "^0.37.1"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/PluvClient.ts

@@ -6,6 +6,7 @@ import type { AuthEndpoint, PluvRoomAddon, PluvRoomDebug, RoomConfig, RoomEndpoi
 import { PluvRoom } from "./PluvRoom";
 import type { PluvRouterEventConfig } from "./PluvRouter";
 import { PluvRouter } from "./PluvRouter";
+import type { PublicKey } from "./types";
 
 export type PluvClientOptions<
     TIO extends IOLike<any, any>,
@@ -17,7 +18,7 @@ export type PluvClientOptions<
     initialStorage?: AbstractCrdtDocFactory<TStorage>;
     metadata?: InputZodLike<TMetadata>;
     presence?: InputZodLike<TPresence>;
-    publicKey?: string;
+    publicKey?: PublicKey<TMetadata>;
     types: InferCallback<TIO>;
 };
 

package/src/PluvRoom.ts

@@ -35,6 +35,7 @@ import type {
     EventResolver,
     EventResolverContext,
     InternalSubscriptions,
+    PublicKey,
     UpdateMyPresenceAction,
     UserInfo,
     WebSocketConnection,
@@ -147,7 +148,7 @@ export type RoomConfig<
         addons?: readonly PluvRoomAddon<TIO, TMetadata, TPresence, TStorage>[];
         debug?: boolean | PluvRoomDebug<TIO>;
         onAuthorizationFail?: (error: Error) => void;
-        publicKey?: string;
+        publicKey?: PublicKey<TMetadata>;
         router?: PluvRouter<TIO, TPresence, TStorage, TEvents>;
     } & RoomEndpoints<TIO, TMetadata> &
         Pick<CrdtManagerOptions<TStorage>, "initialStorage"> &
@@ -174,7 +175,7 @@ export class PluvRoom<
     private readonly _listeners: InternalListeners;
     private readonly _metadata: TMetadata = {} as TMetadata;
     private readonly _otherNotifier = new OtherNotifier<TIO>();
-    private readonly _publicKey: string | null = null;
+    private readonly _publicKey: PublicKey<TMetadata> | null = null;
     private readonly _router: PluvRouter<TIO, TPresence, TStorage, TEvents>;
     private readonly _stateNotifier = new StateNotifier<TIO, TPresence>();
     private readonly _storageStore: AbstractStorageStore;
@@ -231,7 +232,7 @@ export class PluvRoom<
         this._storageStore = storage;
 
         if (typeof metadata !== "undefined") this._metadata = metadata;
-        if (typeof publicKey === "string") this._publicKey = publicKey;
+        if (!!publicKey) this._publicKey = publicKey;
 
         this._listeners = {
             onAuthorizationFail: (error) => {
@@ -350,10 +351,12 @@ export class PluvRoom<
         let webSocket: WebSocket;
 
         try {
+            const publicKey = this._getPublicKey();
+
             authToken = await this._getAuthorization(this.id);
 
             authToken && url.searchParams.set("token", encodeURIComponent(authToken));
-            this._publicKey && url.searchParams.set("public_key", encodeURIComponent(this._publicKey));
+            publicKey && url.searchParams.set("public_key", encodeURIComponent(publicKey));
 
             webSocket = new WebSocket(url.toString());
         } catch (err) {
@@ -734,6 +737,13 @@ export class PluvRoom<
         }
     }
 
+    private _getPublicKey(): string | null {
+        if (!this._publicKey) return null;
+        if (typeof this._publicKey === "string") return this._publicKey;
+
+        return this._publicKey({ metadata: this._metadata });
+    }
+
     private _getWsEndpoint(room: string): string {
         switch (typeof this._endpoints.wsEndpoint) {
             case "undefined":

package/src/index.ts

@@ -16,4 +16,4 @@ export type { PluvRoomAddon, PluvRoomAddonInput, PluvRoomAddonResult, PluvRoomDe
 export type { MergeEvents, PluvRouter, PluvRouterEventConfig } from "./PluvRouter";
 export { register } from "./register";
 export type { RegisterParams } from "./register";
-export type { UserInfo, WebSocketConnection, WebSocketState } from "./types";
+export type { PublicKey, PublicKeyParams, UserInfo, WebSocketConnection, WebSocketState } from "./types";

package/src/types.ts

@@ -53,6 +53,11 @@ export type MergeEventRecords<
       >
     : Id<TRoot>;
 
+export interface PublicKeyParams<TMetadata extends JsonObject> {
+    metadata: TMetadata;
+}
+export type PublicKey<TMetadata extends JsonObject> = string | ((params: PublicKeyParams<TMetadata>) => string);
+
 export type UpdateMyPresenceAction<TPresence extends JsonObject> =
     | Partial<TPresence>
     | ((oldPresence: TPresence | null) => Partial<TPresence>);