@pluv/client 0.7.0 → 0.8.1

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/client@0.7.0 build /home/runner/work/pluv/pluv/packages/client
+> @pluv/client@0.8.1 build /home/runner/work/pluv/pluv/packages/client
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -8,10 +8,10 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 34.72 KB
-ESM ⚡️ Build success in 138ms
-CJS dist/index.js 35.86 KB
-CJS ⚡️ Build success in 138ms
+ESM dist/index.mjs 35.08 KB
+ESM ⚡️ Build success in 90ms
+CJS dist/index.js 36.22 KB
+CJS ⚡️ Build success in 92ms
 DTS Build start
-DTS ⚡️ Build success in 5111ms
-DTS dist/index.d.ts 11.71 KB
+DTS ⚡️ Build success in 3816ms
+DTS dist/index.d.ts 11.73 KB

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @pluv/client
 
+## 0.8.1
+
+### Patch Changes
+
+- 2c9c5c3: changed my-presence to be non-nullable
+
+## 0.8.0
+
+### Minor Changes
+
+- fde89cf: added defaults to the client to align it with createPluvClient by default
+
+### Patch Changes
+
+- 5bbfb98: fix not properly handling unauthorized checks
+- b85a232: bumped dependencies
+- Updated dependencies [b85a232]
+  - @pluv/crdt-yjs@0.3.8
+  - @pluv/types@0.2.0
+
 ## 0.7.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -53,7 +53,7 @@ declare abstract class AbstractRoom<TIO extends IOLike, TPresence extends JsonOb
     abstract broadcast<TEvent extends keyof InferIOInput<TIO>>(event: TEvent, data: Id<InferIOInput<TIO>[TEvent]>): void;
     abstract event<TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>): () => void;
     abstract getConnection(): WebSocketConnection;
-    abstract getMyPresence(): TPresence | null;
+    abstract getMyPresence(): TPresence;
     abstract getMyself(): Id<UserInfo<TIO, TPresence>> | null;
     abstract getOther(connectionId: string): Id<UserInfo<TIO, TPresence>> | null;
     abstract getOthers(): readonly Id<UserInfo<TIO, TPresence>>[];
@@ -81,18 +81,18 @@ declare global {
         };
     };
 }
-type AuthEndpoint = string | ((room: string) => FetchOptions);
+type AuthEndpoint = string | ((room: string) => string | FetchOptions) | true;
 type WsEndpoint = string | ((room: string) => string);
-type FetchOptions = string | {
+type FetchOptions = {
     url: string;
     options?: RequestInit;
 };
 type RoomEndpoints<TIO extends IOLike> = {
-    wsEndpoint: WsEndpoint;
+    wsEndpoint?: WsEndpoint;
 } & (InferIOAuthorizeRequired<InferIOAuthorize<TIO>> extends true ? {
     authEndpoint: AuthEndpoint;
 } : {
-    authEndpoint?: AuthEndpoint;
+    authEndpoint?: undefined;
 });
 type PluvRoomDebug<TIO extends IOLike> = Id<{
     output: readonly (keyof InferIOOutput<TIO>)[];
@@ -127,7 +127,7 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     disconnect(): void;
     event: <TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => (() => void);
     getConnection(): WebSocketConnection;
-    getMyPresence: () => TPresence | null;
+    getMyPresence: () => TPresence;
     getMyself: () => Id<UserInfo<TIO, TPresence>> | null;
     getOther: (connectionId: string) => Id<UserInfo<TIO, TPresence>> | null;
     getOthers: () => readonly Id<UserInfo<TIO, TPresence>>[];
@@ -144,6 +144,7 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     private _detachWindowListeners;
     private _detachWsListeners;
     private _getAuthorization;
+    private _getAuthFetchOptions;
     private _getWsEndpoint;
     private _handleExit;
     private _handlePresenceUpdatedMessage;
@@ -220,7 +221,7 @@ declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject = {},
     broadcast<TEvent extends keyof InferIOInput<TIO>>(event: TEvent, data: Id<InferIOInput<TIO>[TEvent]>): void;
     event: <TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => (() => void);
     getConnection(): WebSocketConnection;
-    getMyPresence: () => TPresence | null;
+    getMyPresence: () => TPresence;
     getMyself: () => Id<UserInfo<TIO, TPresence>> | null;
     getOther: (connectionId: string) => Id<UserInfo<TIO, TPresence>> | null;
     getOthers: () => readonly Id<UserInfo<TIO, TPresence>>[];

package/dist/index.js

@@ -331,8 +331,7 @@ var PluvRoom = class extends AbstractRoom {
       return this._eventNotifier.subscribe(event, callback);
     };
     this.getMyPresence = () => {
-      var _a, _b;
-      return (_b = (_a = this._usersManager.myself) == null ? void 0 : _a.presence) != null ? _b : null;
+      return this._usersManager.myPresence;
     };
     this.getMyself = () => {
       return this._usersManager.myself;
@@ -369,10 +368,7 @@ var PluvRoom = class extends AbstractRoom {
       );
     };
     this._debug = debug;
-    this._endpoints = {
-      authEndpoint,
-      wsEndpoint
-    };
+    this._endpoints = { authEndpoint, wsEndpoint };
     this._listeners = {
       onAuthorizationFail: (error) => {
         this._clearTimeout(this._timeouts.reconnect);
@@ -585,24 +581,50 @@ var PluvRoom = class extends AbstractRoom {
   }
   _getAuthorization(room) {
     return __async(this, null, function* () {
-      if (!this._endpoints.authEndpoint)
+      const fetchOptions = this._getAuthFetchOptions(room);
+      if (!fetchOptions)
         return null;
-      if (typeof this._endpoints.authEndpoint === "string") {
-        const token2 = yield fetch(this._endpoints.authEndpoint).then((res) => res.text()).then((text2) => text2.trim());
-        return token2;
+      const { url, options } = fetchOptions;
+      const res = yield fetch(url, options);
+      if (!res.ok || res.status !== 200) {
+        throw new Error("Room is unauthorized");
+      }
+      try {
+        return yield res.text().then((text2) => text2.trim());
+      } catch (err) {
+        throw new Error(
+          err instanceof Error ? err.message : "Room is unauthorized"
+        );
       }
-      const config = this._endpoints.authEndpoint(room);
-      const endpoint = typeof config === "string" ? config : config.url;
-      const options = typeof config === "string" ? void 0 : config.options;
-      const token = yield fetch(endpoint, options).then((res) => res.text()).then((text2) => text2.trim());
-      return token;
     });
   }
+  _getAuthFetchOptions(room) {
+    if (typeof this._endpoints.authEndpoint === "undefined")
+      return null;
+    if (this._endpoints.authEndpoint === true) {
+      return {
+        url: `/api/pluv/authorize?room=${room}`,
+        options: {}
+      };
+    }
+    if (typeof this._endpoints.authEndpoint === "string") {
+      return {
+        url: this._endpoints.authEndpoint,
+        options: {}
+      };
+    }
+    const result = this._endpoints.authEndpoint(room);
+    return typeof result === "string" ? { url: result, options: {} } : result;
+  }
   _getWsEndpoint(room) {
-    if (typeof this._endpoints.wsEndpoint === "string") {
-      return this._endpoints.wsEndpoint;
+    switch (typeof this._endpoints.wsEndpoint) {
+      case "undefined":
+        return `/api/pluv/room/${room}`;
+      case "string":
+        return this._endpoints.wsEndpoint;
+      default:
+        return this._endpoints.wsEndpoint(room);
     }
-    return this._endpoints.wsEndpoint(room);
   }
   _handleExit(message) {
     const { connectionId } = message;
@@ -1083,8 +1105,7 @@ var MockedRoom = class extends AbstractRoom {
       return this._eventNotifier.subscribe(event, callback);
     };
     this.getMyPresence = () => {
-      var _a, _b;
-      return (_b = (_a = this._usersManager.myself) == null ? void 0 : _a.presence) != null ? _b : null;
+      return this._usersManager.myPresence;
     };
     this.getMyself = () => {
       return this._usersManager.myself;

package/dist/index.mjs

@@ -306,8 +306,7 @@ var PluvRoom = class extends AbstractRoom {
       return this._eventNotifier.subscribe(event, callback);
     };
     this.getMyPresence = () => {
-      var _a, _b;
-      return (_b = (_a = this._usersManager.myself) == null ? void 0 : _a.presence) != null ? _b : null;
+      return this._usersManager.myPresence;
     };
     this.getMyself = () => {
       return this._usersManager.myself;
@@ -344,10 +343,7 @@ var PluvRoom = class extends AbstractRoom {
       );
     };
     this._debug = debug;
-    this._endpoints = {
-      authEndpoint,
-      wsEndpoint
-    };
+    this._endpoints = { authEndpoint, wsEndpoint };
     this._listeners = {
       onAuthorizationFail: (error) => {
         this._clearTimeout(this._timeouts.reconnect);
@@ -560,24 +556,50 @@ var PluvRoom = class extends AbstractRoom {
   }
   _getAuthorization(room) {
     return __async(this, null, function* () {
-      if (!this._endpoints.authEndpoint)
+      const fetchOptions = this._getAuthFetchOptions(room);
+      if (!fetchOptions)
         return null;
-      if (typeof this._endpoints.authEndpoint === "string") {
-        const token2 = yield fetch(this._endpoints.authEndpoint).then((res) => res.text()).then((text2) => text2.trim());
-        return token2;
+      const { url, options } = fetchOptions;
+      const res = yield fetch(url, options);
+      if (!res.ok || res.status !== 200) {
+        throw new Error("Room is unauthorized");
+      }
+      try {
+        return yield res.text().then((text2) => text2.trim());
+      } catch (err) {
+        throw new Error(
+          err instanceof Error ? err.message : "Room is unauthorized"
+        );
       }
-      const config = this._endpoints.authEndpoint(room);
-      const endpoint = typeof config === "string" ? config : config.url;
-      const options = typeof config === "string" ? void 0 : config.options;
-      const token = yield fetch(endpoint, options).then((res) => res.text()).then((text2) => text2.trim());
-      return token;
     });
   }
+  _getAuthFetchOptions(room) {
+    if (typeof this._endpoints.authEndpoint === "undefined")
+      return null;
+    if (this._endpoints.authEndpoint === true) {
+      return {
+        url: `/api/pluv/authorize?room=${room}`,
+        options: {}
+      };
+    }
+    if (typeof this._endpoints.authEndpoint === "string") {
+      return {
+        url: this._endpoints.authEndpoint,
+        options: {}
+      };
+    }
+    const result = this._endpoints.authEndpoint(room);
+    return typeof result === "string" ? { url: result, options: {} } : result;
+  }
   _getWsEndpoint(room) {
-    if (typeof this._endpoints.wsEndpoint === "string") {
-      return this._endpoints.wsEndpoint;
+    switch (typeof this._endpoints.wsEndpoint) {
+      case "undefined":
+        return `/api/pluv/room/${room}`;
+      case "string":
+        return this._endpoints.wsEndpoint;
+      default:
+        return this._endpoints.wsEndpoint(room);
     }
-    return this._endpoints.wsEndpoint(room);
   }
   _handleExit(message) {
     const { connectionId } = message;
@@ -1058,8 +1080,7 @@ var MockedRoom = class extends AbstractRoom {
       return this._eventNotifier.subscribe(event, callback);
     };
     this.getMyPresence = () => {
-      var _a, _b;
-      return (_b = (_a = this._usersManager.myself) == null ? void 0 : _a.presence) != null ? _b : null;
+      return this._usersManager.myPresence;
     };
     this.getMyself = () => {
       return this._usersManager.myself;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/client",
-  "version": "0.7.0",
+  "version": "0.8.1",
   "description": "@pluv/io frontend client",
   "author": "leedavidcs",
   "license": "MIT",
@@ -18,7 +18,7 @@
   },
   "dependencies": {
     "wonka": "^6.3.2",
-    "@pluv/crdt-yjs": "^0.3.7",
+    "@pluv/crdt-yjs": "^0.3.8",
     "@pluv/types": "^0.2.0"
   },
   "peerDependencies": {
@@ -27,9 +27,9 @@
   "devDependencies": {
     "tsup": "^6.7.0",
     "typescript": "^5.0.4",
-    "yjs": "^13.6.0",
+    "yjs": "^13.6.1",
     "@pluv/tsconfig": "^0.1.6",
-    "eslint-config-pluv": "^0.1.11"
+    "eslint-config-pluv": "^0.1.12"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/AbstractRoom.ts

@@ -38,7 +38,7 @@ export abstract class AbstractRoom<
 
     public abstract getConnection(): WebSocketConnection;
 
-    public abstract getMyPresence(): TPresence | null;
+    public abstract getMyPresence(): TPresence;
 
     public abstract getMyself(): Id<UserInfo<TIO, TPresence>> | null;
 

package/src/MockedRoom.ts

@@ -131,8 +131,8 @@ export class MockedRoom<
         );
     }
 
-    public getMyPresence = (): TPresence | null => {
-        return this._usersManager.myself?.presence ?? null;
+    public getMyPresence = (): TPresence => {
+        return this._usersManager.myPresence;
     };
 
     public getMyself = (): Id<UserInfo<TIO, TPresence>> | null => {

package/src/PluvClient.ts

@@ -5,6 +5,7 @@ import type {
     RoomEndpoints,
     PluvRoomOptions,
     WsEndpoint,
+    RoomConfig,
 } from "./PluvRoom";
 import { PluvRoom } from "./PluvRoom";
 
@@ -13,9 +14,9 @@ export type PluvClientOptions<TIO extends IOLike> = RoomEndpoints<TIO> & {
 };
 
 export class PluvClient<TIO extends IOLike = IOLike> {
-    private _authEndpoint: AuthEndpoint;
+    private _authEndpoint: AuthEndpoint | undefined;
     private _debug: boolean;
-    private _wsEndpoint: WsEndpoint;
+    private _wsEndpoint: WsEndpoint | undefined;
 
     private _rooms = new Map<string, PluvRoom<TIO, any, any>>();
 
@@ -45,7 +46,7 @@ export class PluvClient<TIO extends IOLike = IOLike> {
             initialStorage: options.initialStorage,
             onAuthorizationFail: options.onAuthorizationFail,
             wsEndpoint: this._wsEndpoint,
-        });
+        } as RoomConfig<TIO, TPresence, TStorage>);
 
         this._rooms.set(room, newRoom);
 

package/src/PluvRoom.ts

@@ -1,4 +1,4 @@
-import { doc, InferYjsSharedTypeJson } from "@pluv/crdt-yjs";
+import { InferYjsSharedTypeJson } from "@pluv/crdt-yjs";
 import type {
     BaseIOEventRecord,
     EventMessage,
@@ -70,21 +70,19 @@ interface TimeoutIds {
     reconnect: number | null;
 }
 
-export type AuthEndpoint = string | ((room: string) => FetchOptions);
+export type AuthEndpoint =
+    | string
+    | ((room: string) => string | FetchOptions)
+    | true;
 export type WsEndpoint = string | ((room: string) => string);
 
-export interface RoomConfigOptions {
-    authEndpoint?: AuthEndpoint;
-    wsEndpoint: WsEndpoint;
-}
-
-type FetchOptions = string | { url: string; options?: RequestInit };
+type FetchOptions = { url: string; options?: RequestInit };
 
 export type RoomEndpoints<TIO extends IOLike> = {
-    wsEndpoint: WsEndpoint;
+    wsEndpoint?: WsEndpoint;
 } & (InferIOAuthorizeRequired<InferIOAuthorize<TIO>> extends true
     ? { authEndpoint: AuthEndpoint }
-    : { authEndpoint?: AuthEndpoint });
+    : { authEndpoint?: undefined });
 
 interface InternalListeners {
     onAuthorizationFail: (error: Error) => void;
@@ -167,12 +165,7 @@ export class PluvRoom<
 
         this._debug = debug;
 
-        this._endpoints = {
-            authEndpoint: authEndpoint as
-                | string
-                | ((room: string) => FetchOptions),
-            wsEndpoint,
-        };
+        this._endpoints = { authEndpoint, wsEndpoint } as RoomEndpoints<TIO>;
 
         this._listeners = {
             onAuthorizationFail: (error) => {
@@ -310,8 +303,8 @@ export class PluvRoom<
         );
     }
 
-    public getMyPresence = (): TPresence | null => {
-        return this._usersManager.myself?.presence ?? null;
+    public getMyPresence = (): TPresence => {
+        return this._usersManager.myPresence;
     };
 
     public getMyself = (): Id<UserInfo<TIO, TPresence>> | null => {
@@ -494,33 +487,60 @@ export class PluvRoom<
     }
 
     private async _getAuthorization(room: string): Promise<string | null> {
-        if (!this._endpoints.authEndpoint) return null;
+        const fetchOptions = this._getAuthFetchOptions(room);
 
-        if (typeof this._endpoints.authEndpoint === "string") {
-            const token = await fetch(this._endpoints.authEndpoint)
-                .then((res) => res.text())
-                .then((text) => text.trim());
+        if (!fetchOptions) return null;
+
+        const { url, options } = fetchOptions;
+
+        const res = await fetch(url, options);
+
+        if (!res.ok || res.status !== 200) {
+            throw new Error("Room is unauthorized");
+        }
+
+        try {
+            return await res.text().then((text) => text.trim());
+        } catch (err) {
+            throw new Error(
+                err instanceof Error ? err.message : "Room is unauthorized"
+            );
+        }
+    }
 
-            return token;
+    private _getAuthFetchOptions(room: string): FetchOptions | null {
+        if (typeof this._endpoints.authEndpoint === "undefined") return null;
+
+        if (this._endpoints.authEndpoint === true) {
+            return {
+                url: `/api/pluv/authorize?room=${room}`,
+                options: {},
+            };
         }
 
-        const config = this._endpoints.authEndpoint(room);
-        const endpoint = typeof config === "string" ? config : config.url;
-        const options = typeof config === "string" ? undefined : config.options;
+        if (typeof this._endpoints.authEndpoint === "string") {
+            return {
+                url: this._endpoints.authEndpoint,
+                options: {},
+            };
+        }
 
-        const token = await fetch(endpoint, options)
-            .then((res) => res.text())
-            .then((text) => text.trim());
+        const result = this._endpoints.authEndpoint(room);
 
-        return token;
+        return typeof result === "string"
+            ? { url: result, options: {} }
+            : result;
     }
 
     private _getWsEndpoint(room: string): string {
-        if (typeof this._endpoints.wsEndpoint === "string") {
-            return this._endpoints.wsEndpoint;
+        switch (typeof this._endpoints.wsEndpoint) {
+            case "undefined":
+                return `/api/pluv/room/${room}`;
+            case "string":
+                return this._endpoints.wsEndpoint;
+            default:
+                return this._endpoints.wsEndpoint(room);
         }
-
-        return this._endpoints.wsEndpoint(room);
     }
 
     private _handleExit(message: IOEventMessage<TIO>): void {