@pluv/io 0.0.0-experimental-20250527040415

package/src/index.ts

@@ -0,0 +1,54 @@
+export type { BaseUser, EventMessage, EventRecord, IOEventMessage } from "@pluv/types";
+export { AbstractPersistence } from "./AbstractPersistence";
+export { AbstractPlatform } from "./AbstractPlatform";
+export type {
+    AbstractPlatformConfig,
+    ConvertWebSocketConfig,
+    InferInitContextType,
+    InferPlatformWebSocketType,
+    InferRoomContextType,
+} from "./AbstractPlatform";
+export { AbstractPubSub } from "./AbstractPubSub";
+export type { IOPubSubEventMessage } from "./AbstractPubSub";
+export { AbstractWebSocket } from "./AbstractWebSocket";
+export type {
+    AbstractCloseEvent,
+    AbstractErrorEvent,
+    AbstractEvent,
+    AbstractEventMap,
+    AbstractListener,
+    AbstractMessageEvent,
+    AbstractWebSocketConfig,
+    AbstractWebSocketHandleErrorParams,
+} from "./AbstractWebSocket";
+export { authorize } from "./authorize";
+export type { AuthorizeModule, AuthorizeParams, JWT, JWTEncodeParams } from "./authorize";
+export { createIO } from "./createIO";
+export type { CreateIOParams } from "./createIO";
+export type { IORoom } from "./IORoom";
+export { PluvIO } from "./PluvIO";
+export type { PluvIOConfig, ServerConfig } from "./PluvIO";
+export { PluvProcedure } from "./PluvProcedure";
+export type { PluvProcedureConfig } from "./PluvProcedure";
+export { PluvRouter } from "./PluvRouter";
+export type { MergedRouter, PluvRouterEventConfig } from "./PluvRouter";
+export { PluvServer } from "./PluvServer";
+export type { CreateRoomOptions, InferIORoom, PluvServerConfig } from "./PluvServer";
+export type {
+    CrdtLibraryType,
+    GetInitialStorageFn,
+    HandleMode,
+    IORoomListenerEvent,
+    IORoomMessageEvent,
+    IOStorageUpdatedEvent,
+    IOUserConnectedEvent,
+    IOUserDisconnectedEvent,
+    PlatformConfig,
+    PluvContext,
+    PluvIOAuthorize,
+    PluvIOLimits,
+    PluvIOListeners,
+    WebSocketRegistrationMode,
+    WebSocketSerializedState,
+    WebSocketSession,
+} from "./types";

package/src/types.ts

@@ -0,0 +1,283 @@
+import type { AbstractCrdtDocFactory } from "@pluv/crdt";
+import type {
+    BaseUser,
+    CrdtDocLike,
+    EventRecord,
+    IOAuthorize,
+    Id,
+    InferEventMessage,
+    InferEventsOutput,
+    InferIOAuthorizeUser,
+    InputZodLike,
+    JsonObject,
+    Maybe,
+    MaybePromise,
+    UndefinedProps,
+} from "@pluv/types";
+import type {
+    AbstractPlatform,
+    InferInitContextType,
+    InferPlatformWebSocketSource,
+    InferPlatformWebSocketType,
+    InferRoomContextType,
+} from "./AbstractPlatform";
+import type { AbstractWebSocket } from "./AbstractWebSocket";
+import type { PluvRouter, PluvRouterEventConfig } from "./PluvRouter";
+
+export type PluvContext<TPlatform extends AbstractPlatform, TContext extends Record<string, any>> =
+    | TContext
+    | ((params: InferRoomContextType<TPlatform>) => TContext);
+
+export interface CrdtLibraryType {
+    doc: (value: any) => AbstractCrdtDocFactory<any, any>;
+    kind: "loro" | "yjs";
+}
+
+export type EventResolverKind = "broadcast" | "self" | "sync";
+
+export type EventResolver<
+    TKind extends EventResolverKind = EventResolverKind,
+    TPlatform extends AbstractPlatform = AbstractPlatform,
+    TAuthorize extends IOAuthorize<any, InferInitContextType<TPlatform>> | null = null,
+    TContext extends Record<string, any> = {},
+    TInput extends JsonObject = {},
+    TOutput extends EventRecord<string, any> = {},
+> = (
+    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, InferInitContextType<TPlatform>> | null = null,
+    TContext extends Record<string, any> = {},
+> {
+    context: TContext;
+    doc: CrdtDocLike<any, any>;
+    garbageCollect: () => Promise<void>;
+    platform: TPlatform;
+    presence: JsonObject | null;
+    room: string;
+    session: TKind extends "sync"
+        ? WebSocketSession<TAuthorize> | null
+        : WebSocketSession<TAuthorize>;
+    sessions: readonly WebSocketSession<TAuthorize>[];
+    time: number;
+}
+
+export type SendMessageOptions =
+    | { type?: "broadcast"; sessionIds?: readonly string[] }
+    | { type: "self" }
+    | { type: "sync" };
+
+export interface WebSocketSessionTimers {
+    ping: number;
+    presence: number | null;
+}
+
+export interface WebSocketSerializedState {
+    presence: JsonObject | null;
+    quit: boolean;
+    room: string;
+    timers: WebSocketSessionTimers;
+}
+
+export type WebSocketSession<TAuthorize extends IOAuthorize<any, any> | null = null> =
+    WebSocketSerializedState & {
+        id: string;
+        user: InferIOAuthorizeUser<TAuthorize>;
+        webSocket: AbstractWebSocket;
+    };
+
+export type MergeEventRecords<
+    TEventRecords extends EventRecord<string, any>[],
+    TRoot extends EventRecord<string, any> = {},
+> = TEventRecords extends [
+    infer IHead extends EventRecord<string, any>,
+    ...infer ITail extends EventRecord<string, any>[],
+]
+    ? MergeEventRecords<
+          ITail,
+          Omit<TRoot, keyof IHead> & {
+              [P in keyof IHead]: TRoot extends Record<P, any> ? TRoot[P] | IHead[P] : IHead[P];
+          }
+      >
+    : Id<TRoot>;
+
+export type GetInitialStorageEvent<TContext extends Record<string, any>> = {
+    context: TContext;
+    room: string;
+};
+
+export type GetInitialStorageFn<TContext extends Record<string, any>> = (
+    event: GetInitialStorageEvent<TContext>,
+) => MaybePromise<Maybe<string>>;
+
+export type HandleMode = "io" | "fetch";
+export type WebSocketRegistrationMode = "attached" | "detached";
+
+export interface PlatformConfig {
+    authorize: {
+        secret?: boolean;
+    };
+    requireAuth?: boolean;
+    handleMode: HandleMode;
+    registrationMode: WebSocketRegistrationMode;
+    listeners: {
+        onRoomDeleted?: boolean;
+        onRoomMessage?: boolean;
+        onStorageUpdated?: boolean;
+        onUserConnected?: boolean;
+        onUserDisconnected?: boolean;
+    };
+    router?: boolean;
+}
+
+export type ResolvedPluvIOAuthorize<
+    TPlatform extends AbstractPlatform<any, any, any, any>,
+    TUser extends BaseUser = any,
+> = { user: InputZodLike<TUser> } & UndefinedProps<
+    { secret?: string },
+    Exclude<"secret", InferPlatformAuthorizeProperties<TPlatform>>
+>;
+
+export type PluvIOAuthorize<
+    TPlatform extends AbstractPlatform<any, any, any, any>,
+    TUser extends BaseUser | null = any,
+    TContext extends Record<string, unknown> = {},
+> =
+    | (TUser extends BaseUser ? ResolvedPluvIOAuthorize<TPlatform, TUser> : null)
+    | ((
+          context: TContext,
+      ) => TUser extends BaseUser ? ResolvedPluvIOAuthorize<TPlatform, TUser> : null);
+
+export interface PluvIOLimits {
+    /**
+     * @description Maximum size of presence object in bytes
+     */
+    presenceMaxSize?: number | null;
+    /**
+     * @description Maximum size of storage state in bytes
+     */
+    storageMaxSize?: number | null;
+    /**
+     * @description Maximum length of user id in characters
+     */
+    userIdMaxLength?: number | null;
+    /**
+     * @description Maximum size of user object in bytes
+     */
+    userMaxSize?: number | null;
+}
+
+export type BasePluvIOListeners<
+    TPlatform extends AbstractPlatform<any, any, any, any>,
+    TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null,
+    TContext extends Record<string, any>,
+    TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>,
+> = {
+    onRoomDeleted: (event: IORoomListenerEvent<TPlatform, 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, InferInitContextType<TPlatform>> | null,
+    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 PluvIORouter<
+    TPlatform extends AbstractPlatform<any, any, any, any>,
+    TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null,
+    TContext extends Record<string, any>,
+    TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>,
+> =
+    InferPlatformRouter<TPlatform> extends true
+        ? { router?: PluvRouter<TPlatform, TAuthorize, TContext, TEvents> }
+        : { router?: undefined };
+
+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 InferPlatformRouter<TPlatform extends AbstractPlatform<any, any, any, any>> =
+    InferPlatformConfig<TPlatform>["router"];
+
+export type IORoomListenerEvent<
+    TPlatform extends AbstractPlatform<any, any, any, any>,
+    TContext extends Record<string, any>,
+> = {
+    context: TContext;
+    encodedState: string | null;
+    platform: TPlatform;
+    room: string;
+};
+
+export type IORoomMessageEvent<
+    TPlatform extends AbstractPlatform<any>,
+    TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null,
+    TContext extends Record<string, any>,
+    TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>,
+> = IORoomListenerEvent<TPlatform, TContext> & {
+    message: InferEventMessage<InferEventsOutput<TEvents>, keyof InferEventsOutput<TEvents>>;
+    user?: InferIOAuthorizeUser<TAuthorize>;
+    webSocket?: InferPlatformWebSocketSource<TPlatform>;
+};
+
+export type IOStorageUpdatedEvent<
+    TPlatform extends AbstractPlatform<any>,
+    TAuthorize extends IOAuthorize<any, InferInitContextType<TPlatform>> | null,
+    TContext extends Record<string, any>,
+> = IORoomListenerEvent<TPlatform, TContext> & {
+    user?: InferIOAuthorizeUser<TAuthorize>;
+    webSocket?: InferPlatformWebSocketSource<TPlatform>;
+};
+
+export type IOUserConnectedEvent<
+    TPlatform extends AbstractPlatform<any>,
+    TAuthorize extends IOAuthorize<any, InferInitContextType<TPlatform>> | null,
+    TContext extends Record<string, any>,
+> = IORoomListenerEvent<TPlatform, TContext> & {
+    user?: InferIOAuthorizeUser<TAuthorize>;
+    webSocket?: InferPlatformWebSocketSource<TPlatform>;
+};
+
+export type IOUserDisconnectedEvent<
+    TPlatform extends AbstractPlatform<any>,
+    TAuthorize extends IOAuthorize<any, InferInitContextType<TPlatform>> | null,
+    TContext extends Record<string, any>,
+> = IORoomListenerEvent<TPlatform, TContext> & {
+    user?: InferIOAuthorizeUser<TAuthorize>;
+};
+
+export type WebSocketType<TPlatform extends AbstractPlatform> =
+    | InferPlatformWebSocketType<TPlatform>
+    | InferPlatformWebSocketSource<TPlatform>;

package/src/utils/index.ts

@@ -0,0 +1,2 @@
+export { oneLine } from "./oneLine";
+export { pickBy } from "./pickBy";

package/src/utils/oneLine.ts

@@ -0,0 +1,7 @@
+export const oneLine = (strings: TemplateStringsArray, ...values: unknown[]): string => {
+    return strings
+        .map((str) => str.replace(/\s+/g, " "))
+        .reduce((acc, str, i) => acc + str + (i < values.length ? values[i] : ""), "")
+        .replace(/\s+/g, " ")
+        .trim();
+};

package/src/utils/pickBy.ts

@@ -0,0 +1,16 @@
+export const pickBy = <T extends Record<string, any>>(
+    obj: T,
+    by: (value: T[keyof T]) => boolean,
+): Partial<T> => {
+    const result: Partial<T> = {};
+    const keys: (keyof T)[] = Object.keys(obj);
+
+    for (let i = 0; i < keys.length; ++i) {
+        const key = keys[i];
+        const value = obj[key];
+
+        if (by(value)) result[key] = value;
+    }
+
+    return result;
+};

package/src/version.generated.ts

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

package/src/version.ts

@@ -0,0 +1,3 @@
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+export { version as __PLUV_VERSION } from "./version.generated";

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+	"extends": "@pluv/tsconfig/library.json",
+	"include": ["next-env.d.ts", "src/*.ts"],
+	"exclude": ["node_modules"],
+	"compilerOptions": {
+		"lib": ["esnext", "dom"],
+		"types": [],
+	}
+}