@pluv/client 0.32.2 → 0.32.3

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/client@0.32.2 build /home/runner/work/pluv/pluv/packages/client
+> @pluv/client@0.32.3 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 46.91 KB
-ESM ⚡️ Build success in 128ms
-CJS dist/index.js 48.17 KB
-CJS ⚡️ Build success in 128ms
+ESM dist/index.mjs 47.16 KB
+ESM ⚡️ Build success in 91ms
+CJS dist/index.js 48.45 KB
+CJS ⚡️ Build success in 96ms
 DTS Build start
-DTS ⚡️ Build success in 3563ms
-DTS dist/index.d.mts 22.35 KB
-DTS dist/index.d.ts  22.35 KB
+DTS ⚡️ Build success in 3545ms
+DTS dist/index.d.mts 22.72 KB
+DTS dist/index.d.ts  22.72 KB

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @pluv/client
 
+## 0.32.3
+
+### Patch Changes
+
+- b18230f: Add `register` helper to improve client initialization when hosted on pluv.io.
+
+  ```ts
+  import { createClient, register } from "@pluv/client";
+  import type { ioServer } from "./server";
+
+  const client = createClient({
+    infer: (i) => ({ io: i<typeof ioServer> }),
+    // This includes `wsEndpoint` and therefore should no-longer be manually provided
+    ...register({
+      // `authEndpoint` and `publicKey` are now required
+      authEndpoint: ({ room }) =>
+        `${process.env.API_URL}/api/room?room=${room}`,
+      publicKey: "pk_...",
+    }),
+  });
+  ```
+
+  - @pluv/crdt@0.32.3
+  - @pluv/types@0.32.3
+
 ## 0.32.2
 
 ### Patch Changes

package/dist/index.d.mts

@@ -382,4 +382,14 @@ declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject = {},
     private _simulateEvent;
 }
 
-export { AbstractRoom, AbstractStorageStore, ConnectionState, type CreateRoomOptions, 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 UserInfo, type WebSocketConnection, type WebSocketState, createClient };
+interface RegisterParams<TMetadata extends JsonObject> {
+    authEndpoint: AuthEndpoint<TMetadata>;
+    publicKey: string;
+}
+declare const register: <TMetadata extends JsonObject>(params: RegisterParams<TMetadata>) => {
+    authEndpoint: AuthEndpoint<TMetadata>;
+    publicKey: string;
+    wsEndpoint: (params: EndpointParams<TMetadata>) => string;
+};
+
+export { AbstractRoom, AbstractStorageStore, ConnectionState, type CreateRoomOptions, 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 UserInfo, type WebSocketConnection, type WebSocketState, createClient, register };

package/dist/index.d.ts

@@ -382,4 +382,14 @@ declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject = {},
     private _simulateEvent;
 }
 
-export { AbstractRoom, AbstractStorageStore, ConnectionState, type CreateRoomOptions, 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 UserInfo, type WebSocketConnection, type WebSocketState, createClient };
+interface RegisterParams<TMetadata extends JsonObject> {
+    authEndpoint: AuthEndpoint<TMetadata>;
+    publicKey: string;
+}
+declare const register: <TMetadata extends JsonObject>(params: RegisterParams<TMetadata>) => {
+    authEndpoint: AuthEndpoint<TMetadata>;
+    publicKey: string;
+    wsEndpoint: (params: EndpointParams<TMetadata>) => string;
+};
+
+export { AbstractRoom, AbstractStorageStore, ConnectionState, type CreateRoomOptions, 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 UserInfo, type WebSocketConnection, type WebSocketState, createClient, register };

package/dist/index.js

@@ -63,7 +63,8 @@ __export(src_exports, {
   MockedRoom: () => MockedRoom,
   PluvClient: () => PluvClient,
   PluvRoom: () => PluvRoom,
-  createClient: () => createClient
+  createClient: () => createClient,
+  register: () => register
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -1449,6 +1450,17 @@ var MockedRoom = class extends AbstractRoom {
     });
   }
 };
+
+// src/register.ts
+var register = (params) => {
+  const { authEndpoint, publicKey } = params;
+  const wsEndpoint = ({ room }) => `wss://connect.pluv.io/api/room?room=${room}`;
+  return {
+    authEndpoint,
+    publicKey,
+    wsEndpoint
+  };
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AbstractRoom,
@@ -1457,5 +1469,6 @@ var MockedRoom = class extends AbstractRoom {
   MockedRoom,
   PluvClient,
   PluvRoom,
-  createClient
+  createClient,
+  register
 });

package/dist/index.mjs

@@ -1420,6 +1420,17 @@ var MockedRoom = class extends AbstractRoom {
     });
   }
 };
+
+// src/register.ts
+var register = (params) => {
+  const { authEndpoint, publicKey } = params;
+  const wsEndpoint = ({ room }) => `wss://connect.pluv.io/api/room?room=${room}`;
+  return {
+    authEndpoint,
+    publicKey,
+    wsEndpoint
+  };
+};
 export {
   AbstractRoom,
   AbstractStorageStore,
@@ -1427,5 +1438,6 @@ export {
   MockedRoom,
   PluvClient,
   PluvRoom,
-  createClient
+  createClient,
+  register
 };

package/package.json

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

package/src/index.ts

@@ -12,4 +12,6 @@ export type { PluvProcedureConfig } from "./PluvProcedure";
 export { PluvRoom } from "./PluvRoom";
 export type { PluvRoomAddon, PluvRoomAddonInput, PluvRoomAddonResult, PluvRoomDebug } from "./PluvRoom";
 export type { MergeEvents, PluvRouter, PluvRouterEventConfig } from "./PluvRouter";
+export { register } from "./register";
+export type { RegisterParams } from "./register";
 export type { UserInfo, WebSocketConnection, WebSocketState } from "./types";

package/src/register.ts

@@ -0,0 +1,19 @@
+import type { JsonObject } from "@pluv/types";
+import type { AuthEndpoint, WsEndpoint } from "./PluvRoom";
+
+export interface RegisterParams<TMetadata extends JsonObject> {
+    authEndpoint: AuthEndpoint<TMetadata>;
+    publicKey: string;
+}
+
+export const register = <TMetadata extends JsonObject>(params: RegisterParams<TMetadata>) => {
+    const { authEndpoint, publicKey } = params;
+
+    const wsEndpoint: WsEndpoint<TMetadata> = ({ room }) => `wss://connect.pluv.io/api/room?room=${room}`;
+
+    return {
+        authEndpoint,
+        publicKey,
+        wsEndpoint,
+    };
+};