@pluv/platform-pluv 0.33.0 → 0.34.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/platform-pluv@0.33.0 build /home/runner/work/pluv/pluv/packages/platform-pluv
+> @pluv/platform-pluv@0.34.0 build /home/runner/work/pluv/pluv/packages/platform-pluv
 > 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
-CJS dist/index.js 9.75 KB
-CJS ⚡️ Build success in 100ms
-ESM dist/index.mjs 8.85 KB
-ESM ⚡️ Build success in 101ms
+CJS dist/index.js 10.70 KB
+CJS ⚡️ Build success in 82ms
+ESM dist/index.mjs 9.82 KB
+ESM ⚡️ Build success in 90ms
 DTS Build start
-DTS ⚡️ Build success in 6378ms
-DTS dist/index.d.mts 6.99 KB
-DTS dist/index.d.ts  6.99 KB
+DTS ⚡️ Build success in 6566ms
+DTS dist/index.d.mts 2.91 KB
+DTS dist/index.d.ts  2.91 KB

package/CHANGELOG.md

@@ -1,5 +1,63 @@
 # @pluv/platform-pluv
 
+## 0.34.0
+
+### Minor Changes
+
+- 70af3b2: **BREAKING**: The API has been updated to now be called as function `platformPluv` into `createIO` from `@pluv/io`.
+
+  ```ts
+  // Before
+
+  import { createIO } from "@pluv/platform-pluv";
+
+  export const io = createIO({
+    authorize: {
+      user: z.object({
+        id: z.string(),
+      }),
+    },
+    basePath: "/api/pluv",
+    publicKey: "pk_...",
+    secretKey: "sk_...",
+    webhookSecret: "whsec_...",
+  });
+
+  export const GET = pluv.handler;
+
+  // After
+
+  import { createIO } from "@pluv/io";
+  import { platformPluv } from "@pluv/platform-pluv";
+
+  export const io = createIO({
+    authorize: {
+      user: z.object({
+        id: z.string(),
+      }),
+    },
+    platform: platformPluv({
+      basePath: "/api/pluv",
+      publicKey: "pk_...",
+      secretKey: "sk_...",
+      webhookSecret: "whsec_...",
+    }),
+  });
+
+  export const ioServer = io.server();
+
+  // Example: If you're on Next.js
+  export const GET = ioServer.fetch;
+  ```
+
+### Patch Changes
+
+- Updated dependencies [0c920ea]
+- Updated dependencies [70af3b2]
+  - @pluv/io@0.34.0
+  - @pluv/crdt@0.34.0
+  - @pluv/types@0.34.0
+
 ## 0.33.0
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,27 +1,5 @@
-import { AbstractPlatform, WebSocketRegistrationMode, AbstractWebSocket, ConvertWebSocketConfig, WebSocketSerializedState, AbstractPlatformConfig, JWTEncodeParams, GetInitialStorageFn, BaseUser as BaseUser$1 } from '@pluv/io';
-import * as hono from 'hono';
-import { BaseUser, InputZodLike, IOLike } from '@pluv/types';
-import { z } from 'zod';
+import { AbstractPlatform, JWTEncodeParams, AbstractWebSocket, ConvertWebSocketConfig, WebSocketSerializedState, AbstractPlatformConfig } from '@pluv/io';
 
-declare class PluvPlatform extends AbstractPlatform {
-    _registrationMode: WebSocketRegistrationMode;
-    acceptWebSocket(webSocket: AbstractWebSocket): Promise<void>;
-    convertWebSocket(webSocket: any, config: ConvertWebSocketConfig): AbstractWebSocket;
-    getLastPing(webSocket: AbstractWebSocket): number | null;
-    getSerializedState(webSocket: any): WebSocketSerializedState | null;
-    getSessionId(webSocket: any): string | null;
-    getWebSockets(): readonly any[];
-    initialize(config: AbstractPlatformConfig<{}>): this;
-    parseData(data: string | ArrayBuffer): Record<string, any>;
-    randomUUID(): string;
-    setSerializedState(webSocket: AbstractWebSocket, state: WebSocketSerializedState): void;
-}
-
-interface PluvAuthorize<TUser extends BaseUser> {
-    required: true;
-    secret: string;
-    user: InputZodLike<TUser>;
-}
 interface PluvIOEndpoints {
     createToken: string;
 }
@@ -29,30 +7,18 @@ type RoomDeletedMessageEventData = {
     encodedState: string | null;
     room: string;
 };
-type UserConnectedEventData<TUser extends BaseUser> = {
+type UserConnectedEventData = {
     encodedState: string | null;
     room: string;
-    user: TUser;
+    user: any;
 };
-type UserDisconnectedEventData<TUser extends BaseUser> = {
+type UserDisconnectedEventData = {
     encodedState: string | null;
     room: string;
-    user: TUser;
-};
-type PluvIOListeners<TUser extends BaseUser> = {
-    getInitialStorage?: GetInitialStorageFn<{}>;
-    onRoomDeleted: (event: RoomDeletedMessageEventData) => void;
-    onUserConnected: (event: UserConnectedEventData<TUser>) => void;
-    onUserDisconnected: (event: UserDisconnectedEventData<TUser>) => void;
+    user: any;
 };
-type WebhooksConfig<TUser extends BaseUser> = ({
-    webhookSecret?: undefined;
-} & {
-    [P in keyof PluvIOListeners<TUser>]?: undefined;
-}) | ({
-    webhookSecret: string;
-} & Partial<PluvIOListeners<TUser>>);
-type PluvIOConfig<TUser extends BaseUser> = WebhooksConfig<TUser> & {
+
+interface PluvPlatformConfig {
     /**
      * @ignore
      * @readonly
@@ -61,187 +27,68 @@ type PluvIOConfig<TUser extends BaseUser> = WebhooksConfig<TUser> & {
     _defs?: {
         endpoints?: PluvIOEndpoints;
     };
-    authorize: {
-        user: InputZodLike<TUser>;
-    };
     basePath: string;
     publicKey: string;
     secretKey: string;
-};
-declare class PluvIO<TUser extends BaseUser> implements IOLike<PluvAuthorize<TUser>, {}> {
-    private readonly _authorize;
+    webhookSecret?: string;
+}
+declare class PluvPlatform extends AbstractPlatform<any, {}, {}, {
+    authorize: {
+        required: false;
+        secret: false;
+    };
+    handleMode: "fetch";
+    registrationMode: "attached";
+    requireAuth: true;
+    listeners: {
+        onRoomDeleted: true;
+        onRoomMessage: false;
+        onStorageUpdated: false;
+        onUserConnected: true;
+        onUserDisconnected: true;
+    };
+}> {
+    readonly _config: {
+        authorize: {
+            required: false;
+            secret: false;
+        };
+        handleMode: "fetch";
+        registrationMode: "attached";
+        requireAuth: true;
+        listeners: {
+            onRoomDeleted: true;
+            onRoomMessage: false;
+            onStorageUpdated: false;
+            onUserConnected: true;
+            onUserDisconnected: true;
+        };
+    };
+    readonly _name = "platformPluv";
+    private _authorize;
     private readonly _basePath;
     private readonly _endpoints;
-    private readonly _getInitialStorage?;
-    private readonly _listeners;
+    private _getInitialStorage?;
+    private _listeners?;
     private readonly _publicKey;
     private readonly _secretKey;
     private readonly _webhookSecret?;
-    /**
-     * @ignore
-     * @readonly
-     * @deprecated Internal use only. Changes to this will never be marked as breaking.
-     */
-    get _defs(): {
-        authorize: PluvAuthorize<TUser>;
-        context: {};
-        events: {};
-        readonly platform: void;
-    };
-    get fetch(): (request: Request, Env?: unknown, executionCtx?: hono.ExecutionContext) => Response | Promise<Response>;
-    get handler(): (req: Request) => Response | Promise<Response>;
+    _createToken: (params: JWTEncodeParams<any, any>) => Promise<string>;
+    constructor(params: PluvPlatformConfig);
+    acceptWebSocket(webSocket: AbstractWebSocket): Promise<void>;
+    convertWebSocket(webSocket: any, config: ConvertWebSocketConfig): AbstractWebSocket;
+    getLastPing(webSocket: AbstractWebSocket): number | null;
+    getSerializedState(webSocket: any): WebSocketSerializedState | null;
+    getSessionId(webSocket: any): string | null;
+    getWebSockets(): readonly any[];
+    initialize(config: AbstractPlatformConfig<{}>): this;
+    parseData(data: string | ArrayBuffer): Record<string, any>;
+    randomUUID(): string;
+    setSerializedState(webSocket: AbstractWebSocket, state: WebSocketSerializedState): void;
+    validateConfig(config: any): void;
     private _webhooks;
-    constructor(options: PluvIOConfig<TUser>);
-    createToken(params: JWTEncodeParams<TUser, PluvPlatform>): Promise<string>;
 }
 
-declare const createIO: <TUser extends BaseUser$1>(config: PluvIOConfig<TUser>) => PluvIO<TUser>;
-
-declare const ZodEvent: z.ZodDiscriminatedUnion<"event", [z.ZodObject<{
-    event: z.ZodLiteral<"initial-storage">;
-    data: z.ZodObject<{
-        room: z.ZodNullable<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        room: string | null;
-    }, {
-        room: string | null;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    event: "initial-storage";
-    data: {
-        room: string | null;
-    };
-}, {
-    event: "initial-storage";
-    data: {
-        room: string | null;
-    };
-}>, z.ZodObject<{
-    event: z.ZodLiteral<"room-deleted">;
-    data: z.ZodObject<{
-        room: z.ZodString;
-        storage: z.ZodNullable<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        room: string;
-        storage: string | null;
-    }, {
-        room: string;
-        storage: string | null;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    event: "room-deleted";
-    data: {
-        room: string;
-        storage: string | null;
-    };
-}, {
-    event: "room-deleted";
-    data: {
-        room: string;
-        storage: string | null;
-    };
-}>, z.ZodObject<{
-    event: z.ZodLiteral<"user-connected">;
-    data: z.ZodObject<{
-        room: z.ZodString;
-        storage: z.ZodNullable<z.ZodString>;
-        user: z.ZodObject<{
-            id: z.ZodString;
-        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-            id: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-            id: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">>;
-    }, "strip", z.ZodTypeAny, {
-        room: string;
-        storage: string | null;
-        user: {
-            id: string;
-        } & {
-            [k: string]: unknown;
-        };
-    }, {
-        room: string;
-        storage: string | null;
-        user: {
-            id: string;
-        } & {
-            [k: string]: unknown;
-        };
-    }>;
-}, "strip", z.ZodTypeAny, {
-    event: "user-connected";
-    data: {
-        room: string;
-        storage: string | null;
-        user: {
-            id: string;
-        } & {
-            [k: string]: unknown;
-        };
-    };
-}, {
-    event: "user-connected";
-    data: {
-        room: string;
-        storage: string | null;
-        user: {
-            id: string;
-        } & {
-            [k: string]: unknown;
-        };
-    };
-}>, z.ZodObject<{
-    event: z.ZodLiteral<"user-disconnected">;
-    data: z.ZodObject<{
-        room: z.ZodString;
-        storage: z.ZodNullable<z.ZodString>;
-        user: z.ZodObject<{
-            id: z.ZodString;
-        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-            id: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-            id: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">>;
-    }, "strip", z.ZodTypeAny, {
-        room: string;
-        storage: string | null;
-        user: {
-            id: string;
-        } & {
-            [k: string]: unknown;
-        };
-    }, {
-        room: string;
-        storage: string | null;
-        user: {
-            id: string;
-        } & {
-            [k: string]: unknown;
-        };
-    }>;
-}, "strip", z.ZodTypeAny, {
-    event: "user-disconnected";
-    data: {
-        room: string;
-        storage: string | null;
-        user: {
-            id: string;
-        } & {
-            [k: string]: unknown;
-        };
-    };
-}, {
-    event: "user-disconnected";
-    data: {
-        room: string;
-        storage: string | null;
-        user: {
-            id: string;
-        } & {
-            [k: string]: unknown;
-        };
-    };
-}>]>;
+declare const platformPluv: (config: PluvPlatformConfig) => PluvPlatform;
 
-export { PluvIO, type PluvIOConfig, PluvPlatform, ZodEvent, createIO };
+export { type PluvIOEndpoints, PluvPlatform, type RoomDeletedMessageEventData, type UserConnectedEventData, type UserDisconnectedEventData, platformPluv };

package/dist/index.d.ts

@@ -1,27 +1,5 @@
-import { AbstractPlatform, WebSocketRegistrationMode, AbstractWebSocket, ConvertWebSocketConfig, WebSocketSerializedState, AbstractPlatformConfig, JWTEncodeParams, GetInitialStorageFn, BaseUser as BaseUser$1 } from '@pluv/io';
-import * as hono from 'hono';
-import { BaseUser, InputZodLike, IOLike } from '@pluv/types';
-import { z } from 'zod';
+import { AbstractPlatform, JWTEncodeParams, AbstractWebSocket, ConvertWebSocketConfig, WebSocketSerializedState, AbstractPlatformConfig } from '@pluv/io';
 
-declare class PluvPlatform extends AbstractPlatform {
-    _registrationMode: WebSocketRegistrationMode;
-    acceptWebSocket(webSocket: AbstractWebSocket): Promise<void>;
-    convertWebSocket(webSocket: any, config: ConvertWebSocketConfig): AbstractWebSocket;
-    getLastPing(webSocket: AbstractWebSocket): number | null;
-    getSerializedState(webSocket: any): WebSocketSerializedState | null;
-    getSessionId(webSocket: any): string | null;
-    getWebSockets(): readonly any[];
-    initialize(config: AbstractPlatformConfig<{}>): this;
-    parseData(data: string | ArrayBuffer): Record<string, any>;
-    randomUUID(): string;
-    setSerializedState(webSocket: AbstractWebSocket, state: WebSocketSerializedState): void;
-}
-
-interface PluvAuthorize<TUser extends BaseUser> {
-    required: true;
-    secret: string;
-    user: InputZodLike<TUser>;
-}
 interface PluvIOEndpoints {
     createToken: string;
 }
@@ -29,30 +7,18 @@ type RoomDeletedMessageEventData = {
     encodedState: string | null;
     room: string;
 };
-type UserConnectedEventData<TUser extends BaseUser> = {
+type UserConnectedEventData = {
     encodedState: string | null;
     room: string;
-    user: TUser;
+    user: any;
 };
-type UserDisconnectedEventData<TUser extends BaseUser> = {
+type UserDisconnectedEventData = {
     encodedState: string | null;
     room: string;
-    user: TUser;
-};
-type PluvIOListeners<TUser extends BaseUser> = {
-    getInitialStorage?: GetInitialStorageFn<{}>;
-    onRoomDeleted: (event: RoomDeletedMessageEventData) => void;
-    onUserConnected: (event: UserConnectedEventData<TUser>) => void;
-    onUserDisconnected: (event: UserDisconnectedEventData<TUser>) => void;
+    user: any;
 };
-type WebhooksConfig<TUser extends BaseUser> = ({
-    webhookSecret?: undefined;
-} & {
-    [P in keyof PluvIOListeners<TUser>]?: undefined;
-}) | ({
-    webhookSecret: string;
-} & Partial<PluvIOListeners<TUser>>);
-type PluvIOConfig<TUser extends BaseUser> = WebhooksConfig<TUser> & {
+
+interface PluvPlatformConfig {
     /**
      * @ignore
      * @readonly
@@ -61,187 +27,68 @@ type PluvIOConfig<TUser extends BaseUser> = WebhooksConfig<TUser> & {
     _defs?: {
         endpoints?: PluvIOEndpoints;
     };
-    authorize: {
-        user: InputZodLike<TUser>;
-    };
     basePath: string;
     publicKey: string;
     secretKey: string;
-};
-declare class PluvIO<TUser extends BaseUser> implements IOLike<PluvAuthorize<TUser>, {}> {
-    private readonly _authorize;
+    webhookSecret?: string;
+}
+declare class PluvPlatform extends AbstractPlatform<any, {}, {}, {
+    authorize: {
+        required: false;
+        secret: false;
+    };
+    handleMode: "fetch";
+    registrationMode: "attached";
+    requireAuth: true;
+    listeners: {
+        onRoomDeleted: true;
+        onRoomMessage: false;
+        onStorageUpdated: false;
+        onUserConnected: true;
+        onUserDisconnected: true;
+    };
+}> {
+    readonly _config: {
+        authorize: {
+            required: false;
+            secret: false;
+        };
+        handleMode: "fetch";
+        registrationMode: "attached";
+        requireAuth: true;
+        listeners: {
+            onRoomDeleted: true;
+            onRoomMessage: false;
+            onStorageUpdated: false;
+            onUserConnected: true;
+            onUserDisconnected: true;
+        };
+    };
+    readonly _name = "platformPluv";
+    private _authorize;
     private readonly _basePath;
     private readonly _endpoints;
-    private readonly _getInitialStorage?;
-    private readonly _listeners;
+    private _getInitialStorage?;
+    private _listeners?;
     private readonly _publicKey;
     private readonly _secretKey;
     private readonly _webhookSecret?;
-    /**
-     * @ignore
-     * @readonly
-     * @deprecated Internal use only. Changes to this will never be marked as breaking.
-     */
-    get _defs(): {
-        authorize: PluvAuthorize<TUser>;
-        context: {};
-        events: {};
-        readonly platform: void;
-    };
-    get fetch(): (request: Request, Env?: unknown, executionCtx?: hono.ExecutionContext) => Response | Promise<Response>;
-    get handler(): (req: Request) => Response | Promise<Response>;
+    _createToken: (params: JWTEncodeParams<any, any>) => Promise<string>;
+    constructor(params: PluvPlatformConfig);
+    acceptWebSocket(webSocket: AbstractWebSocket): Promise<void>;
+    convertWebSocket(webSocket: any, config: ConvertWebSocketConfig): AbstractWebSocket;
+    getLastPing(webSocket: AbstractWebSocket): number | null;
+    getSerializedState(webSocket: any): WebSocketSerializedState | null;
+    getSessionId(webSocket: any): string | null;
+    getWebSockets(): readonly any[];
+    initialize(config: AbstractPlatformConfig<{}>): this;
+    parseData(data: string | ArrayBuffer): Record<string, any>;
+    randomUUID(): string;
+    setSerializedState(webSocket: AbstractWebSocket, state: WebSocketSerializedState): void;
+    validateConfig(config: any): void;
     private _webhooks;
-    constructor(options: PluvIOConfig<TUser>);
-    createToken(params: JWTEncodeParams<TUser, PluvPlatform>): Promise<string>;
 }
 
-declare const createIO: <TUser extends BaseUser$1>(config: PluvIOConfig<TUser>) => PluvIO<TUser>;
-
-declare const ZodEvent: z.ZodDiscriminatedUnion<"event", [z.ZodObject<{
-    event: z.ZodLiteral<"initial-storage">;
-    data: z.ZodObject<{
-        room: z.ZodNullable<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        room: string | null;
-    }, {
-        room: string | null;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    event: "initial-storage";
-    data: {
-        room: string | null;
-    };
-}, {
-    event: "initial-storage";
-    data: {
-        room: string | null;
-    };
-}>, z.ZodObject<{
-    event: z.ZodLiteral<"room-deleted">;
-    data: z.ZodObject<{
-        room: z.ZodString;
-        storage: z.ZodNullable<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        room: string;
-        storage: string | null;
-    }, {
-        room: string;
-        storage: string | null;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    event: "room-deleted";
-    data: {
-        room: string;
-        storage: string | null;
-    };
-}, {
-    event: "room-deleted";
-    data: {
-        room: string;
-        storage: string | null;
-    };
-}>, z.ZodObject<{
-    event: z.ZodLiteral<"user-connected">;
-    data: z.ZodObject<{
-        room: z.ZodString;
-        storage: z.ZodNullable<z.ZodString>;
-        user: z.ZodObject<{
-            id: z.ZodString;
-        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-            id: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-            id: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">>;
-    }, "strip", z.ZodTypeAny, {
-        room: string;
-        storage: string | null;
-        user: {
-            id: string;
-        } & {
-            [k: string]: unknown;
-        };
-    }, {
-        room: string;
-        storage: string | null;
-        user: {
-            id: string;
-        } & {
-            [k: string]: unknown;
-        };
-    }>;
-}, "strip", z.ZodTypeAny, {
-    event: "user-connected";
-    data: {
-        room: string;
-        storage: string | null;
-        user: {
-            id: string;
-        } & {
-            [k: string]: unknown;
-        };
-    };
-}, {
-    event: "user-connected";
-    data: {
-        room: string;
-        storage: string | null;
-        user: {
-            id: string;
-        } & {
-            [k: string]: unknown;
-        };
-    };
-}>, z.ZodObject<{
-    event: z.ZodLiteral<"user-disconnected">;
-    data: z.ZodObject<{
-        room: z.ZodString;
-        storage: z.ZodNullable<z.ZodString>;
-        user: z.ZodObject<{
-            id: z.ZodString;
-        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-            id: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-            id: z.ZodString;
-        }, z.ZodTypeAny, "passthrough">>;
-    }, "strip", z.ZodTypeAny, {
-        room: string;
-        storage: string | null;
-        user: {
-            id: string;
-        } & {
-            [k: string]: unknown;
-        };
-    }, {
-        room: string;
-        storage: string | null;
-        user: {
-            id: string;
-        } & {
-            [k: string]: unknown;
-        };
-    }>;
-}, "strip", z.ZodTypeAny, {
-    event: "user-disconnected";
-    data: {
-        room: string;
-        storage: string | null;
-        user: {
-            id: string;
-        } & {
-            [k: string]: unknown;
-        };
-    };
-}, {
-    event: "user-disconnected";
-    data: {
-        room: string;
-        storage: string | null;
-        user: {
-            id: string;
-        } & {
-            [k: string]: unknown;
-        };
-    };
-}>]>;
+declare const platformPluv: (config: PluvPlatformConfig) => PluvPlatform;
 
-export { PluvIO, type PluvIOConfig, PluvPlatform, ZodEvent, createIO };
+export { type PluvIOEndpoints, PluvPlatform, type RoomDeletedMessageEventData, type UserConnectedEventData, type UserDisconnectedEventData, platformPluv };