@pluv/io 0.33.0 → 0.34.1

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { JsonObject, MaybePromise, IOAuthorize, IOEventMessage, EventRecord, InputZodLike, ProcedureLike, BaseIOAuthorize, IORouterLike, InferIOAuthorizeUser, Id, Maybe, InferEventMessage, InferEventsOutput, IOLike, InferIOOutput, BaseUser, InferIOInput, InferIOAuthorize } from '@pluv/types';
+import { JsonObject, MaybePromise, IOAuthorize, IOEventMessage, EventRecord, InputZodLike, ProcedureLike, IORouterLike, BaseIOAuthorize, InferIOAuthorizeUser, Id, Maybe, BaseUser, UndefinedProps, InferEventMessage, InferEventsOutput, IOLike, InferIOOutput, InferIOInput, InferIOAuthorize } from '@pluv/types';
 export { BaseUser, EventMessage, EventRecord, IOEventMessage } from '@pluv/types';
 import { AbstractCrdtDocFactory, AbstractCrdtDoc } from '@pluv/crdt';
 
@@ -83,10 +83,10 @@ declare abstract class AbstractWebSocket<TWebSocket = any> {
 }
 
 interface PluvProcedureConfig<TPlatform extends AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>>, TContext extends Record<string, any>, TInput extends JsonObject = {}, TOutput extends EventRecord<string, any> = {}> {
-    broadcast?: EventResolver<TPlatform, TAuthorize, TContext, TInput, Partial<TOutput>> | null;
+    broadcast?: EventResolver<"broadcast", TPlatform, TAuthorize, TContext, TInput, Partial<TOutput>> | null;
     input?: InputZodLike<TInput>;
-    self?: EventResolver<TPlatform, TAuthorize, TContext, TInput, Partial<TOutput>> | null;
-    sync?: EventResolver<TPlatform, TAuthorize, TContext, TInput, Partial<TOutput>> | null;
+    self?: EventResolver<"self", TPlatform, TAuthorize, TContext, TInput, Partial<TOutput>> | null;
+    sync?: EventResolver<"sync", TPlatform, TAuthorize, TContext, TInput, Partial<TOutput>> | null;
 }
 declare class PluvProcedure<TPlatform extends AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>>, TContext extends Record<string, any>, TInput extends JsonObject = {}, TOutput extends EventRecord<string, any> = {}, TFilled extends "input" | "broadcast" | "self" | "sync" | "" = ""> {
     private _broadcast;
@@ -95,21 +95,21 @@ declare class PluvProcedure<TPlatform extends AbstractPlatform<any>, TAuthorize
     private _sync;
     get config(): ProcedureLike<TInput, TOutput>["config"];
     constructor(config?: PluvProcedureConfig<TPlatform, TAuthorize, TContext, TInput, TOutput>);
-    broadcast<TResult extends EventRecord<string, any> = {}>(resolver: EventResolver<TPlatform, TAuthorize, TContext, TInput, TResult>): Omit<PluvProcedure<TPlatform, TAuthorize, TContext, TInput, MergeEventRecords<[TOutput, TResult]>, TFilled | "input" | "broadcast">, TFilled | "input" | "broadcast">;
+    broadcast<TResult extends EventRecord<string, any> = {}>(resolver: EventResolver<"broadcast", TPlatform, TAuthorize, TContext, TInput, TResult>): Omit<PluvProcedure<TPlatform, TAuthorize, TContext, TInput, MergeEventRecords<[TOutput, TResult]>, TFilled | "input" | "broadcast">, TFilled | "input" | "broadcast">;
     input<TData extends JsonObject>(input: InputZodLike<TData>): Omit<PluvProcedure<TPlatform, TAuthorize, TContext, TData, {}, TFilled | "input">, TFilled | "input">;
-    self<TResult extends EventRecord<string, any> = {}>(resolver: EventResolver<TPlatform, TAuthorize, TContext, TInput, TResult>): Omit<PluvProcedure<TPlatform, TAuthorize, TContext, TInput, MergeEventRecords<[TOutput, TResult]>, TFilled | "input" | "self">, TFilled | "input" | "self">;
-    sync<TResult extends EventRecord<string, any> = {}>(resolver: EventResolver<TPlatform, TAuthorize, TContext, TInput, TResult>): Omit<PluvProcedure<TPlatform, TAuthorize, TContext, TInput, MergeEventRecords<[TOutput, TResult]>, TFilled | "input" | "sync">, TFilled | "input" | "sync">;
+    self<TResult extends EventRecord<string, any> = {}>(resolver: EventResolver<"self", TPlatform, TAuthorize, TContext, TInput, TResult>): Omit<PluvProcedure<TPlatform, TAuthorize, TContext, TInput, MergeEventRecords<[TOutput, TResult]>, TFilled | "input" | "self">, TFilled | "input" | "self">;
+    sync<TResult extends EventRecord<string, any> = {}>(resolver: EventResolver<"sync", TPlatform, TAuthorize, TContext, TInput, TResult>): Omit<PluvProcedure<TPlatform, TAuthorize, TContext, TInput, MergeEventRecords<[TOutput, TResult]>, TFilled | "input" | "sync">, TFilled | "input" | "sync">;
     private _resolver;
 }
 
-type PluvRouterEventConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}> = {
+type PluvRouterEventConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, any, InferInitContextType<TPlatform>> = any, TContext extends Record<string, any> = {}> = {
     [P: string]: Pick<PluvProcedure<TPlatform, TAuthorize, TContext, any, any>, "config">;
 };
-type MergedRouter<TRouters extends PluvRouter<TPlatform, TAuthorize, TContext, any>[] = [], TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}, TRoot extends TRouters[0]["_defs"]["events"] = {}> = TRouters extends [
+type MergedRouter<TRouters extends PluvRouter<TPlatform, TAuthorize, TContext, any>[] = [], TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, any, InferInitContextType<TPlatform>> = any, TContext extends Record<string, any> = {}, TRoot extends TRouters[0]["_defs"]["events"] = {}> = TRouters extends [
     infer IHead extends PluvRouter<TPlatform, TAuthorize, TContext, any>,
     ...infer ITail extends PluvRouter<TPlatform, TAuthorize, TContext, any>[]
 ] ? MergedRouter<ITail, TPlatform, TAuthorize, TContext, TRoot & IHead["_defs"]["events"]> : PluvRouter<TPlatform, TAuthorize, TContext, TRoot>;
-declare class PluvRouter<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> implements IORouterLike<TEvents> {
+declare class PluvRouter<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, any, InferInitContextType<TPlatform>> = any, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> implements IORouterLike<TEvents> {
     readonly _defs: {
         events: TEvents;
     };
@@ -127,24 +127,13 @@ interface CrdtLibraryType {
     doc: (value: any) => AbstractCrdtDocFactory<any>;
     kind: "loro" | "yjs";
 }
-type EventResolver<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>;
-interface EventResolverContext<TPlatform extends AbstractPlatform = AbstractPlatform, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}> {
+type EventResolverKind = "broadcast" | "self" | "sync";
+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<TKind, TPlatform, TAuthorize, TContext>) => MaybePromise<TOutput | void>;
+interface EventResolverContext<TKind extends EventResolverKind = EventResolverKind, TPlatform extends AbstractPlatform = AbstractPlatform, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}> {
     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>[];
 }
 type SendMessageOptions = {
@@ -180,19 +169,52 @@ type GetInitialStorageEvent<TContext extends Record<string, any>> = {
     room: string;
 };
 type GetInitialStorageFn<TContext extends Record<string, any>> = (event: GetInitialStorageEvent<TContext>) => MaybePromise<Maybe<string>>;
-interface PluvIOListeners<TPlatform extends AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>>, TContext extends Record<string, any>, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> {
+type HandleMode = "io" | "fetch";
+type WebSocketRegistrationMode = "attached" | "detached";
+interface PlatformConfig {
+    authorize: {
+        required?: boolean;
+        secret?: boolean;
+    };
+    requireAuth?: boolean;
+    handleMode: HandleMode;
+    registrationMode: WebSocketRegistrationMode;
+    listeners: {
+        onRoomDeleted?: boolean;
+        onRoomMessage?: boolean;
+        onStorageUpdated?: boolean;
+        onUserConnected?: boolean;
+        onUserDisconnected?: boolean;
+    };
+}
+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>>>;
+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>);
+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;
-}
+};
+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>>>;
+type InferPlatformConfig<TPlatform extends AbstractPlatform<any, any, any, any>> = TPlatform extends AbstractPlatform<any, any, any, infer IConfig> ? IConfig : never;
+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;
+};
+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;
+};
 type IORoomListenerEvent<TContext extends Record<string, any>> = {
     context: TContext;
     encodedState: string | null;
     room: string;
 };
-type IORoomMessageEvent<TPlatform extends AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>>, TContext extends Record<string, any>, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> = IORoomListenerEvent<TContext> & {
+type IORoomMessageEvent<TPlatform extends AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, any, InferInitContextType<TPlatform>>, TContext extends Record<string, any>, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> = IORoomListenerEvent<TContext> & {
     message: InferEventMessage<InferEventsOutput<TEvents>, keyof InferEventsOutput<TEvents>>;
     user?: InferIOAuthorizeUser<TAuthorize>;
     webSocket?: InferPlatformWebSocketSource<TPlatform>;
@@ -219,7 +241,29 @@ declare abstract class AbstractPubSub {
     abstract unsubscribe(subscriptionId: number): void;
 }
 
-type WebSocketRegistrationMode = "attached" | "detached";
+interface JWT<TUser extends BaseUser> {
+    room: string;
+    sub: string;
+    user: TUser;
+}
+type JWTEncodeParams<TUser extends BaseUser, TPlatform extends AbstractPlatform> = {
+    maxAge?: number;
+    room: string;
+    user: TUser;
+} & InferInitContextType<TPlatform>;
+interface AuthorizeParams {
+    platform: AbstractPlatform;
+    secret: string;
+}
+interface AuthorizeModule {
+    decode: <TUser extends BaseUser>(jwt: string) => Promise<TUser | null>;
+    encode: <TUser extends BaseUser, TPlatform extends AbstractPlatform>(params: JWTEncodeParams<TUser, TPlatform>) => Promise<string>;
+}
+declare const authorize: (params: AuthorizeParams) => {
+    decode: <TUser extends BaseUser>(jwt: string) => Promise<JWT<TUser> | null>;
+    encode: <TUser extends BaseUser, TPlatform extends AbstractPlatform>(encodeParams: JWTEncodeParams<TUser, TPlatform>) => Promise<string>;
+};
+
 type InferPlatformWebSocketType<TPlatform extends AbstractPlatform> = TPlatform extends AbstractPlatform<infer IAbstractWebSocket> ? IAbstractWebSocket : never;
 type InferPlatformWebSocketSource<TPlatform> = TPlatform extends AbstractPlatform<infer IAbstractWebSocket> ? InferWebSocketSource<IAbstractWebSocket> : never;
 type InferInitContextType<TPlatform extends AbstractPlatform> = TPlatform extends AbstractPlatform<any, infer IInitContext> ? IInitContext : never;
@@ -232,13 +276,16 @@ type AbstractPlatformConfig<TRoomContext extends Record<string, any> = {}> = {
 interface ConvertWebSocketConfig {
     room: string;
 }
-declare abstract class AbstractPlatform<TWebSocket extends AbstractWebSocket = AbstractWebSocket, TInitContext extends Record<string, any> = {}, TRoomContext extends Record<string, any> = {}> {
+declare abstract class AbstractPlatform<TWebSocket extends AbstractWebSocket = AbstractWebSocket, TInitContext extends Record<string, any> = {}, TRoomContext extends Record<string, any> = {}, TConfig extends PlatformConfig = PlatformConfig> {
     protected readonly _initContext: TInitContext | undefined;
     protected readonly _roomContext: TRoomContext | undefined;
     private _initialized;
     persistence: AbstractPersistence;
     pubSub: AbstractPubSub;
-    abstract readonly _registrationMode: WebSocketRegistrationMode;
+    readonly _createToken?: (params: JWTEncodeParams<any, any>) => Promise<string>;
+    _fetch?: (req: any) => Promise<any>;
+    abstract readonly _config: TConfig;
+    abstract readonly _name: string;
     constructor(config?: AbstractPlatformConfig<TRoomContext>);
     abstract acceptWebSocket(webSocket: AbstractWebSocket): Promise<void>;
     abstract convertWebSocket(webSocket: InferWebSocketSource<TWebSocket>, config: ConvertWebSocketConfig): AbstractWebSocket;
@@ -250,33 +297,11 @@ declare abstract class AbstractPlatform<TWebSocket extends AbstractWebSocket = A
     abstract parseData(data: string | ArrayBuffer): Record<string, any>;
     abstract randomUUID(): string;
     abstract setSerializedState(webSocket: AbstractWebSocket, state: WebSocketSerializedState): void;
+    validateConfig(config: any): void;
     protected _initialize(): this;
 }
 
-interface JWT<TUser extends BaseUser> {
-    room: string;
-    sub: string;
-    user: TUser;
-}
-type JWTEncodeParams<TUser extends BaseUser, TPlatform extends AbstractPlatform> = {
-    maxAge?: number;
-    room: string;
-    user: TUser;
-} & InferInitContextType<TPlatform>;
-interface AuthorizeParams {
-    platform: AbstractPlatform;
-    secret: string;
-}
-interface AuthorizeModule {
-    decode: <TUser extends BaseUser>(jwt: string) => Promise<TUser | null>;
-    encode: <TUser extends BaseUser, TPlatform extends AbstractPlatform>(params: JWTEncodeParams<TUser, TPlatform>) => Promise<string>;
-}
-declare const authorize: (params: AuthorizeParams) => {
-    decode: <TUser extends BaseUser>(jwt: string) => Promise<JWT<TUser> | null>;
-    encode: <TUser extends BaseUser, TPlatform extends AbstractPlatform>(encodeParams: JWTEncodeParams<TUser, TPlatform>) => Promise<string>;
-};
-
-interface IORoomListeners<TPlatform extends AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>>, TContext extends Record<string, any>, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> {
+interface IORoomListeners<TPlatform extends AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, any, InferInitContextType<TPlatform>>, TContext extends Record<string, any>, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> {
     onDestroy: (event: IORoomListenerEvent<TContext>) => void;
     onMessage: (event: IORoomMessageEvent<TPlatform, TAuthorize, TContext, TEvents>) => void;
     onUserConnected: (event: IOUserConnectedEvent<TPlatform, TAuthorize, TContext>) => void;
@@ -285,7 +310,7 @@ interface IORoomListeners<TPlatform extends AbstractPlatform<any>, TAuthorize ex
 type BroadcastProxy<TIO extends IORoom<any, any, any, any>> = (<TEvent extends keyof InferIOInput<TIO>>(event: TEvent, data: Id<InferIOInput<TIO>[TEvent]>) => Promise<void>) & {
     [event in keyof InferIOInput<TIO>]: (data: Id<InferIOInput<TIO>>[event]) => Promise<void>;
 };
-type IORoomConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> = Partial<IORoomListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
+type IORoomConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, any, InferInitContextType<TPlatform>> = any, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> = Partial<IORoomListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
     authorize?: TAuthorize;
     context: TContext;
     crdt?: {
@@ -299,7 +324,7 @@ type IORoomConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any
 type WebsocketRegisterConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>> = {
     token?: string | null;
 } & InferInitContextType<TPlatform>;
-declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> implements IOLike<TAuthorize, TEvents> {
+declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, any, InferInitContextType<TPlatform>> = any, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> implements IOLike<TAuthorize, TEvents> {
     readonly id: string;
     private _doc;
     private _uninitialize;
@@ -367,7 +392,7 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
 }
 
 type InferIORoom<TServer extends PluvServer<any, any, any, any>> = TServer extends PluvServer<infer IPlatform, infer IAuthorize, infer IContext, infer IEvents> ? IORoom<IPlatform, IAuthorize, IContext, IEvents> : never;
-type PluvServerConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> = Partial<PluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
+type PluvServerConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, 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>> & {
     authorize?: TAuthorize;
     context?: PluvContext<TPlatform, TContext>;
     crdt?: {
@@ -378,11 +403,11 @@ type PluvServerConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform
     platform: TPlatform;
     router?: PluvRouter<TPlatform, TAuthorize, TContext, TEvents>;
 };
-type BaseCreateRoomOptions<TPlatform extends AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>>, TContext extends Record<string, any>, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> = Partial<IORoomListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
+type BaseCreateRoomOptions<TPlatform extends AbstractPlatform<any>, 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>> & {
     debug?: boolean;
 };
-type CreateRoomOptions<TPlatform extends AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>>, TContext extends Record<string, any>, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> = keyof InferRoomContextType<TPlatform> extends never ? [BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents>] | [] : [Id<BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents> & InferRoomContextType<TPlatform>>];
-declare class PluvServer<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> implements IOLike<TAuthorize, TEvents> {
+type CreateRoomOptions<TPlatform extends AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, any, InferInitContextType<TPlatform>>, TContext extends Record<string, any>, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> = keyof InferRoomContextType<TPlatform> extends never ? [BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents>] | [] : [Id<BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents> & InferRoomContextType<TPlatform>>];
+declare class PluvServer<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, any, InferInitContextType<TPlatform>> = any, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> implements IOLike<TAuthorize, TEvents> {
     readonly version: string;
     private readonly _authorize;
     private readonly _baseRouter;
@@ -392,6 +417,7 @@ declare class PluvServer<TPlatform extends AbstractPlatform<any> = AbstractPlatf
     private readonly _getInitialStorage;
     private readonly _platform;
     private readonly _router;
+    get fetch(): (req: any) => Promise<any>;
     /**
      * @ignore
      * @readonly
@@ -407,22 +433,26 @@ declare class PluvServer<TPlatform extends AbstractPlatform<any> = AbstractPlatf
     constructor(options: PluvServerConfig<TPlatform, TAuthorize, TContext, TEvents>);
     createRoom(room: string, ...options: CreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents>): IORoom<TPlatform, TAuthorize, TContext, TEvents>;
     createToken(params: JWTEncodeParams<InferIOAuthorizeUser<InferIOAuthorize<this>>, TPlatform>): Promise<string>;
+    private _getIOAuthorize;
     private _getListeners;
     private _logDebug;
 }
 
 type PluvIOConfig<TPlatform extends AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>>, TContext extends Record<string, any>> = {
-    authorize?: TAuthorize;
     context?: PluvContext<TPlatform, TContext>;
     crdt?: CrdtLibraryType;
     debug?: boolean;
     platform: TPlatform;
-};
-type ServerConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> = Partial<PluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
+} & (InferPlatformConfig<TPlatform>["requireAuth"] extends true ? {
+    authorize: TAuthorize;
+} : {
+    authorize?: TAuthorize;
+});
+type ServerConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, 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>> & {
     getInitialStorage?: GetInitialStorageFn<TContext>;
     router?: PluvRouter<TPlatform, TAuthorize, TContext, TEvents>;
 };
-declare class PluvIO<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferInitContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}> {
+declare class PluvIO<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends PluvIOAuthorize<TPlatform, any, any, InferInitContextType<TPlatform>> = any, TContext extends Record<string, any> = {}> {
     readonly version: string;
     private readonly _authorize;
     private readonly _context;
@@ -435,15 +465,16 @@ declare class PluvIO<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
     mergeRouters<TRouters extends PluvRouter<TPlatform, TAuthorize, TContext, any>[]>(...routers: TRouters): MergedRouter<TRouters>;
     router<TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>>(events: TEvents): PluvRouter<TPlatform, TAuthorize, TContext, TEvents>;
     server<TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>>(config?: ServerConfig<TPlatform, TAuthorize, TContext, TEvents>): PluvServer<TPlatform, TAuthorize, TContext, TEvents>;
+    private _getIOAuthorize;
 }
 
 type CreateIOParams<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TContext extends Record<string, any> = {}, 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;
     platform: TPlatform;
 };
-declare const createIO: <TPlatform extends AbstractPlatform<any> = AbstractPlatform<any, {}, {}>, TContext extends Record<string, any> = {}, TAuthorizeUser extends BaseUser = BaseUser, TAuthorizeRequired extends boolean = false>(params: CreateIOParams<TPlatform, TContext, TAuthorizeUser, TAuthorizeRequired>) => PluvIO<TPlatform, IOAuthorize<TAuthorizeUser, TAuthorizeRequired, InferInitContextType<TPlatform>>, TContext>;
+declare const createIO: <TPlatform extends AbstractPlatform<any> = AbstractPlatform<any, {}, {}, PlatformConfig>, TContext extends Record<string, any> = {}, TAuthorizeUser extends BaseUser = BaseUser, TAuthorizeRequired extends boolean = false>(params: CreateIOParams<TPlatform, TContext, TAuthorizeUser, TAuthorizeRequired>) => PluvIO<TPlatform, PluvIOAuthorize<TPlatform, TAuthorizeUser, TAuthorizeRequired, InferInitContextType<TPlatform>>, TContext>;
 
-export { type AbstractCloseEvent, type AbstractErrorEvent, type AbstractEvent, type AbstractEventMap, type AbstractListener, type AbstractMessageEvent, AbstractPersistence, AbstractPlatform, type AbstractPlatformConfig, AbstractPubSub, AbstractWebSocket, type AbstractWebSocketConfig, type AbstractWebSocketHandleErrorParams, type AuthorizeModule, type AuthorizeParams, type ConvertWebSocketConfig, type CrdtLibraryType, type CreateIOParams, type CreateRoomOptions, type GetInitialStorageFn, type IOPubSubEventMessage, IORoom, type IORoomListenerEvent, type IORoomMessageEvent, type IOStorageUpdatedEvent, type IOUserConnectedEvent, type IOUserDisconnectedEvent, type InferIORoom, type InferInitContextType, type InferPlatformWebSocketType, type InferRoomContextType, type JWT, type JWTEncodeParams, type MergedRouter, PluvIO, type PluvIOConfig, type PluvIOListeners, PluvProcedure, type PluvProcedureConfig, PluvRouter, type PluvRouterEventConfig, PluvServer, type PluvServerConfig, type ServerConfig, type WebSocketRegistrationMode, type WebSocketSerializedState, type WebSocketSession, authorize, createIO };
+export { type AbstractCloseEvent, type AbstractErrorEvent, type AbstractEvent, type AbstractEventMap, type AbstractListener, type AbstractMessageEvent, AbstractPersistence, AbstractPlatform, type AbstractPlatformConfig, AbstractPubSub, AbstractWebSocket, type AbstractWebSocketConfig, type AbstractWebSocketHandleErrorParams, type AuthorizeModule, type AuthorizeParams, type ConvertWebSocketConfig, type CrdtLibraryType, type CreateIOParams, type CreateRoomOptions, type GetInitialStorageFn, type HandleMode, type IOPubSubEventMessage, IORoom, type IORoomListenerEvent, type IORoomMessageEvent, type IOStorageUpdatedEvent, type IOUserConnectedEvent, type IOUserDisconnectedEvent, type InferIORoom, type InferInitContextType, type InferPlatformWebSocketType, type InferRoomContextType, type JWT, type JWTEncodeParams, type MergedRouter, type PlatformConfig, PluvIO, type PluvIOConfig, type PluvIOListeners, PluvProcedure, type PluvProcedureConfig, PluvRouter, type PluvRouterEventConfig, PluvServer, type PluvServerConfig, type ServerConfig, type WebSocketRegistrationMode, type WebSocketSerializedState, type WebSocketSession, authorize, createIO };

package/dist/index.js

@@ -77,8 +77,8 @@ var __async = (__this, __arguments, generator) => {
 };
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   AbstractPersistence: () => AbstractPersistence,
   AbstractPlatform: () => AbstractPlatform,
   AbstractPubSub: () => AbstractPubSub,
@@ -90,7 +90,7 @@ __export(src_exports, {
   authorize: () => authorize,
   createIO: () => createIO
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/AbstractPersistence.ts
 var AbstractPersistence = class {
@@ -224,6 +224,8 @@ var AbstractPlatform = class {
     this.persistence = persistence != null ? persistence : new Persistence();
     this.pubSub = pubSub != null ? pubSub : new PubSub();
   }
+  validateConfig(config) {
+  }
   _initialize() {
     if (this._initialized) throw new Error("Platform is already initialized");
     this._initialized = true;
@@ -553,7 +555,7 @@ var IORoom = class {
       }
       this._sessions.set(pluvWs.sessionId, pluvWs);
       yield this._platform.persistence.addUser(this.id, pluvWs.sessionId, user != null ? user : {});
-      if (this._platform._registrationMode === "attached") {
+      if (this._platform._config.registrationMode === "attached") {
         const onClose = this._onClose(pluvWs).bind(this);
         const onMessage = this._onMessage(pluvWs).bind(this);
         pluvWs.addEventListener("close", onClose);
@@ -590,13 +592,7 @@ var IORoom = class {
         this._sessions.delete(pluvWs.sessionId);
       });
       const promises = quitters.map((quitter) => __async(this, null, function* () {
-        yield this._broadcast({
-          message: {
-            type: "$EXIT",
-            data: { sessionId: quitter.sessionId }
-          },
-          senderId: quitter.sessionId
-        });
+        yield this._exitWebsocket(quitter);
       }));
       yield Promise.all(promises);
     });
@@ -624,7 +620,7 @@ var IORoom = class {
     });
   }
   _ensureDetached() {
-    if (this._platform._registrationMode === "detached") return;
+    if (this._platform._config.registrationMode === "detached") return;
     throw new Error("Platform must use detached mode");
   }
   _exitWebsocket(webSocket) {
@@ -669,6 +665,7 @@ var IORoom = class {
       const ioAuthorize = this._getIOAuthorize(options);
       if (!ioAuthorize) return null;
       if (!token) return null;
+      if (!ioAuthorize.secret) throw new Error("`authorize` was specified without a valid secret");
       const payload = yield authorize({
         platform: this._platform,
         secret: ioAuthorize.secret
@@ -795,13 +792,7 @@ var IORoom = class {
       this._logDebug(`${import_kleur.default.blue(`Unregistering connection for room ${this.id}:`)} ${webSocket.sessionId}`);
       this._sessions.delete(webSocket.sessionId);
       this._platform.persistence.deleteUser(this.id, webSocket.sessionId).finally(() => __async(this, null, function* () {
-        yield this._broadcast({
-          message: {
-            type: "$EXIT",
-            data: { sessionId: webSocket.sessionId }
-          },
-          senderId: webSocket.sessionId
-        });
+        yield this._exitWebsocket(webSocket);
         const size = this.getSize();
         this._logDebug(`${import_kleur.default.blue(`Unregistered connection for room ${this.id}:`)} ${webSocket.sessionId}`);
         this._logDebug(`${import_kleur.default.blue(`Room ${this.id} size:`)} ${size}`);
@@ -1002,7 +993,7 @@ var IORoom = class {
 };
 
 // src/version.generated.ts
-var version = "0.33.0";
+var version = "0.34.1";
 
 // src/PluvServer.ts
 var PluvServer = class {
@@ -1106,14 +1097,11 @@ var PluvServer = class {
       crdt = import_crdt2.noop,
       debug = false,
       getInitialStorage,
-      onRoomDeleted,
-      onRoomMessage,
-      onStorageUpdated,
-      onUserConnected,
-      onUserDisconnected,
       platform,
       router = new PluvRouter({})
     } = options;
+    const { onRoomDeleted, onRoomMessage, onStorageUpdated, onUserConnected, onUserDisconnected } = options;
+    platform.validateConfig(options);
     this._crdt = crdt;
     this._debug = debug;
     this._platform = platform;
@@ -1129,6 +1117,10 @@ var PluvServer = class {
       onUserDisconnected: (event) => onUserDisconnected == null ? void 0 : onUserDisconnected(event)
     };
   }
+  get fetch() {
+    if (!this._platform._fetch) throw new Error(`\`${this._platform._name}\` does not support \`fetch\``);
+    return this._platform._fetch;
+  }
   /**
    * @ignore
    * @readonly
@@ -1148,6 +1140,9 @@ var PluvServer = class {
   createRoom(room, ...options) {
     var _a, _c;
     const _b = (_a = options[0]) != null ? _a : {}, { _meta, debug, onDestroy, onMessage } = _b, platformRoomContext = __objRest(_b, ["_meta", "debug", "onDestroy", "onMessage"]);
+    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;
     const context = typeof this._context === "function" ? this._context(roomContext) : this._context;
@@ -1182,17 +1177,23 @@ var PluvServer = class {
   }
   createToken(params) {
     return __async(this, null, function* () {
+      var _a;
       if (!this._authorize) {
         throw new Error("IO does not specify authorize during initialization.");
       }
-      const ioAuthorize = typeof this._authorize === "function" ? this._authorize(params) : this._authorize;
-      const secret = ioAuthorize.secret;
-      return yield authorize({
-        platform: this._platform,
-        secret
-      }).encode(params);
+      if (this._platform._createToken) return yield this._platform._createToken(params);
+      const ioAuthorize = this._getIOAuthorize(params);
+      const secret = (_a = ioAuthorize == null ? void 0 : ioAuthorize.secret) != null ? _a : null;
+      if (!secret) throw new Error("`authorize` was specified without a valid secret");
+      return yield authorize({ platform: this._platform, secret }).encode(params);
     });
   }
+  _getIOAuthorize(options) {
+    if (typeof this._authorize === "function") {
+      return this._authorize(options);
+    }
+    return this._authorize;
+  }
   _getListeners() {
     return this._listeners;
   }
@@ -1219,13 +1220,12 @@ var PluvIO = class {
   }
   createToken(params) {
     return __async(this, null, function* () {
+      var _a;
       if (!this._authorize) throw new Error("IO does not specify authorize during initialization.");
-      const ioAuthorize = typeof this._authorize === "function" ? this._authorize(params) : this._authorize;
-      const secret = ioAuthorize.secret;
-      return yield authorize({
-        platform: this._platform,
-        secret
-      }).encode(params);
+      const ioAuthorize = this._getIOAuthorize(params);
+      const secret = (_a = ioAuthorize == null ? void 0 : ioAuthorize.secret) != null ? _a : null;
+      if (!secret) throw new Error("`authorize` was specified without a valid secret");
+      return yield authorize({ platform: this._platform, secret }).encode(params);
     });
   }
   mergeRouters(...routers) {
@@ -1244,6 +1244,12 @@ var PluvIO = class {
       platform: this._platform
     }));
   }
+  _getIOAuthorize(options) {
+    if (typeof this._authorize === "function") {
+      return this._authorize(options);
+    }
+    return this._authorize;
+  }
 };
 
 // src/createIO.ts