@pluv/io 0.33.0 → 0.34.1

package/src/PluvServer.ts

@@ -1,18 +1,9 @@
 import type { AbstractCrdtDocFactory } from "@pluv/crdt";
 import { noop } from "@pluv/crdt";
-import type {
-    BaseIOAuthorize,
-    IOAuthorize,
-    IOLike,
-    Id,
-    InferIOAuthorize,
-    InferIOAuthorizeUser,
-    JsonObject,
-    Maybe,
-} from "@pluv/types";
+import type { IOLike, Id, InferIOAuthorize, InferIOAuthorizeUser, JsonObject, Maybe } from "@pluv/types";
 import colors from "kleur";
 import type { AbstractPlatform, InferInitContextType, InferRoomContextType } from "./AbstractPlatform";
-import type { IORoomListeners } from "./IORoom";
+import type { IORoomListeners, WebsocketRegisterConfig } from "./IORoom";
 import { IORoom } from "./IORoom";
 import { PluvProcedure } from "./PluvProcedure";
 import type { PluvRouterEventConfig } from "./PluvRouter";
@@ -20,7 +11,14 @@ import { PluvRouter } from "./PluvRouter";
 import type { JWTEncodeParams } from "./authorize";
 import { authorize } from "./authorize";
 import { PING_TIMEOUT_MS } from "./constants";
-import type { GetInitialStorageFn, PluvContext, PluvIOListeners } from "./types";
+import type {
+    BasePluvIOListeners,
+    GetInitialStorageFn,
+    PluvContext,
+    PluvIOAuthorize,
+    PluvIOListeners,
+    ResolvedPluvIOAuthorize,
+} from "./types";
 import { __PLUV_VERSION } from "./version";
 
 export type InferIORoom<TServer extends PluvServer<any, any, any, any>> =
@@ -30,7 +28,7 @@ export type InferIORoom<TServer extends PluvServer<any, any, any, any>> =
 
 export type PluvServerConfig<
     TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>,
-    TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize,
+    TAuthorize extends PluvIOAuthorize<TPlatform, any, any, InferInitContextType<TPlatform>> = any,
     TContext extends Record<string, any> = {},
     TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {},
 > = Partial<PluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
@@ -45,7 +43,7 @@ export type PluvServerConfig<
 
 type BaseCreateRoomOptions<
     TPlatform extends AbstractPlatform<any>,
-    TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>>,
+    TAuthorize extends PluvIOAuthorize<TPlatform, any, any, InferInitContextType<TPlatform>>,
     TContext extends Record<string, any>,
     TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>,
 > = Partial<IORoomListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
@@ -54,7 +52,7 @@ type BaseCreateRoomOptions<
 
 export type CreateRoomOptions<
     TPlatform extends AbstractPlatform<any>,
-    TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>>,
+    TAuthorize extends PluvIOAuthorize<TPlatform, any, any, InferInitContextType<TPlatform>>,
     TContext extends Record<string, any>,
     TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>,
 > = keyof InferRoomContextType<TPlatform> extends never
@@ -63,7 +61,7 @@ export type CreateRoomOptions<
 
 export class PluvServer<
     TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>,
-    TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize,
+    TAuthorize extends PluvIOAuthorize<TPlatform, any, any, InferInitContextType<TPlatform>> = any,
     TContext extends Record<string, any> = {},
     TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {},
 > implements IOLike<TAuthorize, TEvents>
@@ -201,6 +199,12 @@ export class PluvServer<
     private readonly _platform: TPlatform;
     private readonly _router: PluvRouter<TPlatform, TAuthorize, TContext, TEvents>;
 
+    public get fetch() {
+        if (!this._platform._fetch) throw new Error(`\`${this._platform._name}\` does not support \`fetch\``);
+
+        return this._platform._fetch;
+    }
+
     /**
      * @ignore
      * @readonly
@@ -226,15 +230,16 @@ export class PluvServer<
             crdt = noop,
             debug = false,
             getInitialStorage,
-            onRoomDeleted,
-            onRoomMessage,
-            onStorageUpdated,
-            onUserConnected,
-            onUserDisconnected,
+
             platform,
             router = new PluvRouter<TPlatform, TAuthorize, TContext, TEvents>({} as TEvents),
         } = options;
 
+        const { onRoomDeleted, onRoomMessage, onStorageUpdated, onUserConnected, onUserDisconnected } =
+            options as Partial<BasePluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>>;
+
+        platform.validateConfig(options);
+
         this._crdt = crdt;
         this._debug = debug;
         this._platform = platform;
@@ -255,7 +260,7 @@ export class PluvServer<
             onStorageUpdated: (event) => onStorageUpdated?.(event),
             onUserConnected: (event) => onUserConnected?.(event),
             onUserDisconnected: (event) => onUserDisconnected?.(event),
-        } as PluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>;
+        } as BasePluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>;
     }
 
     public createRoom(
@@ -269,6 +274,10 @@ export class PluvServer<
             TEvents
         >[0] & { _meta?: any };
 
+        if (this._platform._config.handleMode !== "io") {
+            throw new Error(`\`createRoom\' is unsupported for \`${this._platform._name}\``);
+        }
+
         if (!/^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$/i.test(room)) throw new Error("Unsupported room name");
 
         const roomContext = platformRoomContext as InferRoomContextType<TPlatform>;
@@ -316,18 +325,33 @@ export class PluvServer<
             throw new Error("IO does not specify authorize during initialization.");
         }
 
-        const ioAuthorize =
-            typeof this._authorize === "function" ? this._authorize(params) : (this._authorize as { secret: string });
+        /**
+         * !HACK
+         * @description Allow the platform to overwrite this behavior as needed. This is introduced
+         * to support platformPluv
+         * @date December 15, 2024
+         */
+        if (this._platform._createToken) return await this._platform._createToken(params);
 
-        const secret = ioAuthorize.secret;
+        const ioAuthorize = this._getIOAuthorize(params);
+        const secret = ioAuthorize?.secret ?? null;
 
-        return await authorize({
-            platform: this._platform,
-            secret,
-        }).encode(params);
+        if (!secret) throw new Error("`authorize` was specified without a valid secret");
+
+        return await authorize({ platform: this._platform, secret }).encode(params);
+    }
+
+    private _getIOAuthorize(
+        options: WebsocketRegisterConfig<TPlatform>,
+    ): ResolvedPluvIOAuthorize<any, any, any> | null {
+        if (typeof this._authorize === "function") {
+            return this._authorize(options);
+        }
+
+        return this._authorize as ResolvedPluvIOAuthorize<any, any, any> | null;
     }
 
-    private _getListeners(): PluvIOListeners<TPlatform, TAuthorize, TContext, TEvents> {
+    private _getListeners(): BasePluvIOListeners<TPlatform, TAuthorize, TContext, TEvents> {
         return (this as any)._listeners;
     }
 

package/src/createIO.ts

@@ -1,7 +1,7 @@
-import type { BaseUser, IOAuthorize } from "@pluv/types";
+import type { BaseUser } from "@pluv/types";
 import type { AbstractPlatform, InferInitContextType } from "./AbstractPlatform";
 import { PluvIO } from "./PluvIO";
-import type { CrdtLibraryType, PluvContext } from "./types";
+import type { CrdtLibraryType, PluvContext, PluvIOAuthorize } from "./types";
 
 export type CreateIOParams<
     TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>,
@@ -9,7 +9,7 @@ export type CreateIOParams<
     TAuthorizeUser extends BaseUser = BaseUser,
     TAuthorizeRequired extends boolean = false,
 > = {
-    authorize?: IOAuthorize<TAuthorizeUser, TAuthorizeRequired, InferInitContextType<TPlatform>>;
+    authorize?: PluvIOAuthorize<TPlatform, TAuthorizeUser, TAuthorizeRequired, InferInitContextType<TPlatform>>;
     context?: PluvContext<TPlatform, TContext>;
     crdt?: CrdtLibraryType;
     debug?: boolean;
@@ -23,15 +23,24 @@ export const createIO = <
     TAuthorizeRequired extends boolean = false,
 >(
     params: CreateIOParams<TPlatform, TContext, TAuthorizeUser, TAuthorizeRequired>,
-): PluvIO<TPlatform, IOAuthorize<TAuthorizeUser, TAuthorizeRequired, InferInitContextType<TPlatform>>, TContext> => {
+): PluvIO<
+    TPlatform,
+    PluvIOAuthorize<TPlatform, TAuthorizeUser, TAuthorizeRequired, InferInitContextType<TPlatform>>,
+    TContext
+> => {
     const { authorize, context, crdt, debug, platform } = params;
 
     return new PluvIO<
         TPlatform,
-        IOAuthorize<TAuthorizeUser, TAuthorizeRequired, InferInitContextType<TPlatform>>,
+        PluvIOAuthorize<TPlatform, TAuthorizeUser, TAuthorizeRequired, InferInitContextType<TPlatform>>,
         TContext
     >({
-        authorize,
+        authorize: authorize as PluvIOAuthorize<
+            TPlatform,
+            TAuthorizeUser,
+            TAuthorizeRequired,
+            InferInitContextType<TPlatform>
+        >,
         context,
         crdt,
         debug,

package/src/index.ts

@@ -7,7 +7,6 @@ export type {
     InferInitContextType,
     InferPlatformWebSocketType,
     InferRoomContextType,
-    WebSocketRegistrationMode,
 } from "./AbstractPlatform";
 export { AbstractPubSub } from "./AbstractPubSub";
 export type { IOPubSubEventMessage } from "./AbstractPubSub";
@@ -38,12 +37,15 @@ export type { CreateRoomOptions, InferIORoom, PluvServerConfig } from "./PluvSer
 export type {
     CrdtLibraryType,
     GetInitialStorageFn,
+    HandleMode,
     IORoomListenerEvent,
     IORoomMessageEvent,
     IOStorageUpdatedEvent,
     IOUserConnectedEvent,
     IOUserDisconnectedEvent,
+    PlatformConfig,
     PluvIOListeners,
+    WebSocketRegistrationMode,
     WebSocketSerializedState,
     WebSocketSession,
 } from "./types";

package/src/types.ts

@@ -1,15 +1,19 @@
 import type { AbstractCrdtDoc, AbstractCrdtDocFactory } from "@pluv/crdt";
 import type {
     BaseIOAuthorize,
+    BaseUser,
     EventRecord,
     IOAuthorize,
     Id,
     InferEventMessage,
     InferEventsOutput,
     InferIOAuthorizeUser,
+    InputZodLike,
     JsonObject,
     Maybe,
     MaybePromise,
+    Spread,
+    UndefinedProps,
 } from "@pluv/types";
 import type {
     AbstractPlatform,
@@ -36,15 +40,22 @@ export interface CrdtLibraryType {
     kind: "loro" | "yjs";
 }
 
+export type EventResolverKind = "broadcast" | "self" | "sync";
+
 export type EventResolver<
+    TKind extends EventResolverKind = EventResolverKind,
     TPlatform extends AbstractPlatform = AbstractPlatform,
     TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize,
     TContext extends Record<string, any> = {},
     TInput extends JsonObject = {},
     TOutput extends EventRecord<string, any> = {},
-> = (data: TInput, context: EventResolverContext<TPlatform, TAuthorize, TContext>) => MaybePromise<TOutput | void>;
+> = (
+    data: TInput,
+    context: EventResolverContext<TKind, TPlatform, TAuthorize, TContext>,
+) => MaybePromise<TOutput | void>;
 
 export interface EventResolverContext<
+    TKind extends EventResolverKind = EventResolverKind,
     TPlatform extends AbstractPlatform = AbstractPlatform,
     TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize,
     TContext extends Record<string, any> = {},
@@ -52,19 +63,7 @@ export interface EventResolverContext<
     context: TContext;
     doc: AbstractCrdtDoc<any>;
     room: string;
-    /**
-     * !HACK
-     * @description Session should only not exist when invoking the event as a
-     * "sync" event on another machine where the session doesn't exist. There must
-     * be a better way to handle this, but going to make this nullable for ease
-     * for now.
-     *
-     * `session` should not be referenced most of the time anyhow (outside of
-     * internal to this library).
-     * @author leedavidcs
-     * @date December 25, 2022
-     */
-    session: WebSocketSession<TAuthorize> | null;
+    session: TKind extends "sync" ? WebSocketSession<TAuthorize> | null : WebSocketSession<TAuthorize>;
     sessions: readonly WebSocketSession<TAuthorize>[];
 }
 
@@ -115,18 +114,81 @@ export type GetInitialStorageFn<TContext extends Record<string, any>> = (
     event: GetInitialStorageEvent<TContext>,
 ) => MaybePromise<Maybe<string>>;
 
-export interface PluvIOListeners<
-    TPlatform extends AbstractPlatform<any>,
-    TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>>,
+export type HandleMode = "io" | "fetch";
+export type WebSocketRegistrationMode = "attached" | "detached";
+
+export interface PlatformConfig {
+    authorize: {
+        required?: boolean;
+        secret?: boolean;
+    };
+    requireAuth?: boolean;
+    handleMode: HandleMode;
+    registrationMode: WebSocketRegistrationMode;
+    listeners: {
+        onRoomDeleted?: boolean;
+        onRoomMessage?: boolean;
+        onStorageUpdated?: boolean;
+        onUserConnected?: boolean;
+        onUserDisconnected?: boolean;
+    };
+}
+
+export type ResolvedPluvIOAuthorize<
+    TPlatform extends AbstractPlatform<any, any, any, any>,
+    TUser extends BaseUser = any,
+    TRequired extends boolean = false,
+> = { user: InputZodLike<TUser>; required?: TRequired } & UndefinedProps<
+    { secret?: string },
+    Exclude<"secret", InferPlatformAuthorizeProperties<TPlatform>>
+>;
+
+export type PluvIOAuthorize<
+    TPlatform extends AbstractPlatform<any, any, any, any>,
+    TUser extends BaseUser = any,
+    TRequired extends boolean = false,
+    TContext extends Record<string, unknown> = {},
+> =
+    | ResolvedPluvIOAuthorize<TPlatform, TUser, TRequired>
+    | ((context: TContext) => ResolvedPluvIOAuthorize<TPlatform, TUser, TRequired>);
+
+export type BasePluvIOListeners<
+    TPlatform extends AbstractPlatform<any, any, any, any>,
+    TAuthorize extends PluvIOAuthorize<TPlatform, any, any, InferInitContextType<TPlatform>>,
     TContext extends Record<string, any>,
     TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>,
-> {
+> = {
     onRoomDeleted: (event: IORoomListenerEvent<TContext>) => void;
     onRoomMessage: (event: IORoomMessageEvent<TPlatform, TAuthorize, TContext, TEvents>) => void;
     onStorageUpdated: (event: IOStorageUpdatedEvent<TPlatform, TAuthorize, TContext>) => void;
     onUserConnected: (event: IOUserConnectedEvent<TPlatform, TAuthorize, TContext>) => void;
     onUserDisconnected: (event: IOUserDisconnectedEvent<TPlatform, TAuthorize, TContext>) => void;
-}
+};
+
+export type PluvIOListeners<
+    TPlatform extends AbstractPlatform<any, any, any, any>,
+    TAuthorize extends PluvIOAuthorize<TPlatform, any, any, InferInitContextType<TPlatform>>,
+    TContext extends Record<string, any>,
+    TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>,
+> = UndefinedProps<
+    BasePluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>,
+    Exclude<keyof BasePluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>, InferPlatformListeners<TPlatform>>
+>;
+
+export type InferPlatformConfig<TPlatform extends AbstractPlatform<any, any, any, any>> =
+    TPlatform extends AbstractPlatform<any, any, any, infer IConfig> ? IConfig : never;
+
+export type InferPlatformAuthorizeProperties<TPlatform extends AbstractPlatform<any, any, any, any>> = keyof {
+    [P in keyof PlatformConfig["authorize"] as InferPlatformConfig<TPlatform>["authorize"][P] extends true | undefined
+        ? P
+        : never]: true;
+};
+
+export type InferPlatformListeners<TPlatform extends AbstractPlatform<any, any, any, any>> = keyof {
+    [P in keyof PlatformConfig["listeners"] as InferPlatformConfig<TPlatform>["listeners"][P] extends true | undefined
+        ? P
+        : never]: true;
+};
 
 export type IORoomListenerEvent<TContext extends Record<string, any>> = {
     context: TContext;
@@ -136,7 +198,7 @@ export type IORoomListenerEvent<TContext extends Record<string, any>> = {
 
 export type IORoomMessageEvent<
     TPlatform extends AbstractPlatform<any>,
-    TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>>,
+    TAuthorize extends PluvIOAuthorize<TPlatform, any, any, InferInitContextType<TPlatform>>,
     TContext extends Record<string, any>,
     TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>,
 > = IORoomListenerEvent<TContext> & {

package/src/version.generated.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '0.33.0'
+export const version = '0.34.1'