@pluv/platform-pluv 3.2.2 → 4.0.1

package/.turbo/turbo-build.log

@@ -1,18 +1,18 @@
 
-> @pluv/platform-pluv@3.2.2 build /home/runner/work/pluv/pluv/packages/platform-pluv
-> tsup src/index.ts --format esm,cjs --dts
+> @pluv/platform-pluv@4.0.1 build /home/runner/work/pluv/pluv/packages/platform-pluv
+> tsdown
 
-CLI Building entry: src/index.ts
-CLI Using tsconfig: tsconfig.json
-CLI tsup v8.5.0
-CLI Target: es6
-ESM Build start
-CJS Build start
-ESM dist/index.mjs 15.14 KB
-ESM ⚡️ Build success in 105ms
-CJS dist/index.js 16.97 KB
-CJS ⚡️ Build success in 108ms
-DTS Build start
-DTS ⚡️ Build success in 6581ms
-DTS dist/index.d.mts 4.07 KB
-DTS dist/index.d.ts  4.07 KB
+ℹ tsdown v0.20.0-beta.4 powered by rolldown v1.0.0-beta.60
+ℹ config file: /home/runner/work/pluv/pluv/packages/platform-pluv/tsdown.config.ts 
+ℹ entry: src/index.ts
+ℹ target: esnext
+ℹ tsconfig: tsconfig.json
+ℹ Build start
+[PLUGIN_TIMINGS] Warning: Your build spent significant time in plugin `rolldown-plugin-dts:generate`. See https://rolldown.rs/options/checks#plugintimings for more details.
+ℹ dist/index.mjs        13.74 kB │ gzip: 3.46 kB
+ℹ dist/index.mjs.map    33.93 kB │ gzip: 7.44 kB
+ℹ dist/index.d.mts.map   1.86 kB │ gzip: 0.69 kB
+ℹ dist/index.d.mts       4.21 kB │ gzip: 1.29 kB
+ℹ 4 files, total: 53.74 kB
+
+✔ Build complete in 3774ms

package/CHANGELOG.md

@@ -1,5 +1,105 @@
 # @pluv/platform-pluv
 
+## 4.0.1
+
+### Patch Changes
+
+- 982e068: Added http header for webhook events (`x-pluv-event`).
+    - @pluv/crdt@4.0.1
+    - @pluv/io@4.0.1
+    - @pluv/types@4.0.1
+
+## 4.0.0
+
+### Major Changes
+
+- df5c39c: Update all packages to be ESM only.
+- 07e2a1e: ### Breaking Changes
+
+    This release includes the following breaking changes:
+    1. **Removed `onDestroy` handler** (room-level only) - replaced with `onRoomDestroyed` and `onStorageDestroyed`
+    2. **Removed `onRoomDeleted` handler** (server-level) - replaced with `onRoomDestroyed` and `onStorageDestroyed`
+    3. **Listeners can no longer be configured at room-level** - all listeners must be configured at server-level via `io.server()`
+    4. **Event type changes** - `IORoomDestroyedEvent` no longer includes `encodedState`
+
+    #### Remove `onDestroy` and `onRoomDeleted` in favor of `onRoomDestroyed` and `onStorageDestroyed`
+
+    **BREAKING**: Two event handlers have been **removed** in favor of two separate handlers that provide better control over when storage is saved. This is a breaking change that requires code updates.
+
+    **New Handlers:**
+    - **`onRoomDestroyed`**: Fires whenever a room is destroyed. This event does NOT include `encodedState` to prevent accidentally saving empty or uninitialized storage data. **Available only at server-level** via `io.server()`.
+    - **`onStorageDestroyed`**: Only fires when the storage document is about to be destroyed after it has been initialized via `initializeSession`. This event includes `encodedState` and should be used for saving storage to your database. **Available only at server-level** via `io.server()`.
+
+    **Removed Handlers:**
+    - **`onDestroy`** (room-level only, via `createRoom`): **REMOVED**. Use `onRoomDestroyed` and `onStorageDestroyed` instead.
+    - **`onRoomDeleted`** (server-level): **REMOVED**. Use `onRoomDestroyed` and `onStorageDestroyed` instead.
+
+    **Migration Guide:**
+
+    **Old (no longer works):**
+
+    ```typescript
+    // Room-level onDestroy (removed)
+    const room = io.createRoom("room-id", {
+        onDestroy: async ({ encodedState, room }) => {
+            // This no longer works
+            await saveToDatabase(room, encodedState);
+        },
+    });
+
+    // Server-level onRoomDeleted (removed)
+    io.server({
+        onRoomDeleted: async ({ encodedState, room }) => {
+            // This no longer works
+            await saveToDatabase(room, encodedState);
+        },
+    });
+    ```
+
+    **New (recommended approach):**
+
+    ```typescript
+    // Server-level handlers (recommended - all listeners are now server-level)
+    io.server({
+        onRoomDestroyed: async ({ room }) => {
+            // Room destroyed - use for cleanup if needed
+            await cleanupRoom(room);
+        },
+        onStorageDestroyed: async ({ encodedState, room }) => {
+            // Only fires when storage was initialized via initializeSession
+            // Safe to save to database
+            await saveToDatabase(room, encodedState);
+        },
+    });
+
+    // Rooms are created without listener options
+    const room = io.createRoom("room-id");
+    ```
+
+    #### Type Changes
+
+    **BREAKING**: The following type changes may require TypeScript code updates:
+    - **`IORoomDestroyedEvent`** no longer includes `encodedState` (breaking change if you were accessing `encodedState` from this event)
+    - **`IORoomListenerEvent`** includes `encodedState: string | null` (used by `onStorageDestroyed`)
+    - **All listeners must be configured at the server level** via `io.server()`, not at the room level via `createRoom()` (breaking change - room-level listener configuration is no longer supported)
+    - **`CreateRoomOptions`** now correctly requires platform-specific room context properties (e.g., `env` and `state` for Cloudflare) when they are required by the platform, while properly handling optional properties like `meta` (breaking change - TypeScript will now correctly enforce required properties)
+
+### Minor Changes
+
+- 037074e: Migrated build process from tsup to tsdown.
+
+### Patch Changes
+
+- 2eb5def: Bumped dependencies.
+- Updated dependencies [2eb5def]
+- Updated dependencies [df5c39c]
+- Updated dependencies [c142910]
+- Updated dependencies [037074e]
+- Updated dependencies [07e2a1e]
+    - @pluv/types@4.0.0
+    - @pluv/crdt@4.0.0
+    - @pluv/io@4.0.0
+
 ## 3.2.2
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,96 +1,103 @@
-import { CrdtLibraryType, NoopCrdtDocFactory } from '@pluv/crdt';
-import { PluvContext, BaseUser, AbstractPlatform, JWTEncodeParams, AbstractWebSocket, ConvertWebSocketConfig, WebSocketSerializedState, AbstractPlatformConfig, CreateIOParams, PluvIOAuthorize, InferInitContextType } from '@pluv/io';
-import { MaybePromise, BaseUser as BaseUser$1, Id } from '@pluv/types';
+import { AbstractPlatform, AbstractPlatformConfig, AbstractWebSocket, BaseUser, ConvertWebSocketConfig, CreateIOParams, InferInitContextType, JWTEncodeParams, PluvContext, PluvIOAuthorize, WebSocketSerializedState } from "@pluv/io";
+import { z } from "zod";
+import { CrdtLibraryType, NoopCrdtDocFactory } from "@pluv/crdt";
+import { BaseUser as BaseUser$1, Id, MaybePromise } from "@pluv/types";
 
+//#region src/types.d.ts
 interface PluvIOEndpoints {
-    createToken: string;
+  createToken: string;
 }
-
+//#endregion
+//#region src/PluvPlatform.d.ts
 type PublicKey = string | (() => MaybePromise<string>);
 type SecretKey = string | (() => MaybePromise<string>);
 type WebhookSecret = string | (() => MaybePromise<string>);
 interface PluvPlatformConfig<TContext extends Record<string, any> = {}> {
-    /**
-     * @ignore
-     * @readonly
-     * @deprecated Internal use only. Changes to this will never be marked as breaking.
-     */
-    _defs?: {
-        debug?: boolean;
-        endpoints?: PluvIOEndpoints | (() => MaybePromise<PluvIOEndpoints>);
-    };
-    basePath: string;
-    context?: PluvContext<any, TContext>;
-    publicKey: PublicKey;
-    secretKey: SecretKey;
-    webhookSecret?: WebhookSecret;
+  /**
+   * @ignore
+   * @readonly
+   * @deprecated Internal use only. Changes to this will never be marked as breaking.
+   */
+  _defs?: {
+    debug?: boolean;
+    endpoints?: PluvIOEndpoints | (() => MaybePromise<PluvIOEndpoints>);
+  };
+  basePath: string;
+  context?: PluvContext<any, TContext>;
+  publicKey: PublicKey;
+  secretKey: SecretKey;
+  webhookSecret?: WebhookSecret;
 }
 declare class PluvPlatform<TContext extends Record<string, any> = {}, TUser extends BaseUser = BaseUser> extends AbstractPlatform<any, {}, {}, {
+  authorize: {
+    secret: false;
+  };
+  handleMode: "fetch";
+  registrationMode: "attached";
+  requireAuth: true;
+  listeners: {
+    onRoomDestroyed: true;
+    onRoomMessage: false;
+    onStorageDestroyed: true;
+    onStorageUpdated: false;
+    onUserConnected: true;
+    onUserDisconnected: true;
+  };
+  router: false;
+}> {
+  readonly id: string;
+  readonly _config: {
     authorize: {
-        secret: false;
+      secret: false;
     };
     handleMode: "fetch";
     registrationMode: "attached";
     requireAuth: true;
     listeners: {
-        onRoomDeleted: true;
-        onRoomMessage: false;
-        onStorageUpdated: false;
-        onUserConnected: true;
-        onUserDisconnected: true;
+      onRoomDestroyed: true;
+      onRoomMessage: false;
+      onStorageDestroyed: true;
+      onStorageUpdated: false;
+      onUserConnected: true;
+      onUserDisconnected: true;
     };
     router: false;
-}> {
-    readonly id: string;
-    readonly _config: {
-        authorize: {
-            secret: false;
-        };
-        handleMode: "fetch";
-        registrationMode: "attached";
-        requireAuth: true;
-        listeners: {
-            onRoomDeleted: true;
-            onRoomMessage: false;
-            onStorageUpdated: false;
-            onUserConnected: true;
-            onUserDisconnected: true;
-        };
-        router: false;
-    };
-    readonly _name = "platformPluv";
-    private readonly _app;
-    private readonly _basePath;
-    private readonly _context;
-    private readonly _debug;
-    private readonly _endpoints;
-    private _getInitialStorage?;
-    private _listeners?;
-    private readonly _publicKey;
-    private readonly _secretKey;
-    private readonly _webhookSecret?;
-    _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): WebSocketSerializedState;
-    validateConfig(config: any): void;
-    private _webhooksRouter;
-    private _getContext;
-    private _logDebug;
+  };
+  readonly _name = "platformPluv";
+  private readonly _app;
+  private readonly _basePath;
+  private readonly _context;
+  private readonly _debug;
+  private readonly _endpoints;
+  private _getInitialStorage?;
+  private _listeners?;
+  private readonly _publicKey;
+  private readonly _secretKey;
+  private readonly _webhookSecret?;
+  _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): WebSocketSerializedState;
+  validateConfig(config: any): void;
+  private _webhooksRouter;
+  private _getContext;
+  private _logDebug;
 }
-
+//#endregion
+//#region src/platformPluv.d.ts
 type PlatformPluvCreateIOParams<TContext extends Record<string, any> = {}, TUser extends BaseUser$1 = BaseUser$1, TCrdt extends CrdtLibraryType<any> = CrdtLibraryType<NoopCrdtDocFactory>> = Id<PluvPlatformConfig & Omit<CreateIOParams<PluvPlatform, TContext, TUser, TCrdt>, "authorize" | "context" | "limits" | "platform"> & {
-    authorize: PluvIOAuthorize<PluvPlatform, TUser, InferInitContextType<PluvPlatform>>;
-    context?: PluvContext<PluvPlatform, TContext>;
+  authorize: PluvIOAuthorize<PluvPlatform, TUser, InferInitContextType<PluvPlatform>>;
+  context?: PluvContext<PluvPlatform, TContext>;
 }>;
 declare const platformPluv: <TContext extends Record<string, any> = {}, TUser extends BaseUser$1 = BaseUser$1, TCrdt extends CrdtLibraryType<any> = CrdtLibraryType<NoopCrdtDocFactory>>(config: PlatformPluvCreateIOParams<TContext, TUser, TCrdt>) => CreateIOParams<PluvPlatform<TContext, TUser>, TContext, TUser, TCrdt>;
-
+//#endregion
 export { type PlatformPluvCreateIOParams, type PluvIOEndpoints, PluvPlatform, type PublicKey, type SecretKey, type WebhookSecret, platformPluv };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/PluvPlatform.ts","../src/platformPluv.ts"],"mappings":";;;;;;UAqBiB,eAAA;EACb,WAAA;AAAA;;;KCDQ,SAAA,mBAA4B,YAAA;AAAA,KAC5B,SAAA,mBAA4B,YAAA;AAAA,KAC5B,aAAA,mBAAgC,YAAA;AAAA,UAE3B,kBAAA,kBAAoC,MAAA;;;;;;EAMjD,KAAA;IACI,KAAA;IACA,SAAA,GAAY,eAAA,UAAyB,YAAA,CAAa,eAAA;EAAA;EAEtD,QAAA;EACA,OAAA,GAAU,WAAA,MAAiB,QAAA;EAC3B,SAAA,EAAW,SAAA;EACX,SAAA,EAAW,SAAA;EACX,aAAA,GAAgB,aAAA;AAAA;AAAA,cAGP,YAAA,kBACQ,MAAA,kCACH,QAAA,GAAW,QAAA,UACnB,gBAAA;EAKF,SAAA;IACI,MAAA;EAAA;EAEJ,UAAA;EACA,gBAAA;EACA,WAAA;EACA,SAAA;IACI,eAAA;IACA,aAAA;IACA,kBAAA;IACA,gBAAA;IACA,eAAA;IACA,kBAAA;EAAA;EAEJ,MAAA;AAAA;EAAA,SAGY,EAAA;EAAA,SACA,OAAA;;;;;;;;;;;;;;;;;WAiBA,KAAA;EAAA,iBAEC,IAAA;EAAA,iBACA,SAAA;EAAA,iBACA,QAAA;EAAA,iBACA,MAAA;EAAA,iBACA,UAAA;EAAA,QACT,kBAAA;EAAA,QACA,UAAA;EAAA,iBACS,UAAA;EAAA,iBACA,UAAA;EAAA,iBACA,cAAA;EAEV,YAAA,GAAsB,MAAA,EAAQ,eAAA,eAA4B,OAAA;cA0CrD,MAAA,EAAQ,kBAAA;EAmBb,eAAA,CAAgB,SAAA,EAAW,iBAAA,GAAoB,OAAA;EAI/C,gBAAA,CAAiB,SAAA,OAAgB,MAAA,EAAQ,sBAAA,GAAyB,iBAAA;EAIlE,WAAA,CAAY,SAAA,EAAW,iBAAA;EAIvB,kBAAA,CAAmB,SAAA,QAAiB,wBAAA;EAIpC,YAAA,CAAa,SAAA;EAIb,aAAA,CAAA;EAIA,UAAA,CAAW,MAAA,EAAQ,sBAAA;EAInB,SAAA,CAAU,IAAA,WAAe,WAAA,GAAc,MAAA;EAIvC,UAAA,CAAA;EAIA,kBAAA,CACH,SAAA,EAAW,iBAAA,EACX,KAAA,EAAO,wBAAA,GACR,wBAAA;EAII,cAAA,CAAe,MAAA;EAAA,QAyBd,eAAA;EAAA,QAiLM,WAAA;EAAA,QAMN,SAAA;AAAA;;;KCpZA,0BAAA,kBACS,MAAA,kCACH,UAAA,GAAW,UAAA,gBACX,eAAA,QAAuB,eAAA,CAAgB,kBAAA,KACrD,EAAA,CACA,kBAAA,GACI,IAAA,CACI,cAAA,CAAe,YAAA,EAAc,QAAA,EAAU,KAAA,EAAO,KAAA;EAG9C,SAAA,EAAW,eAAA,CAAgB,YAAA,EAAc,KAAA,EAAO,oBAAA,CAAqB,YAAA;EACrE,OAAA,GAAU,WAAA,CAAY,YAAA,EAAc,QAAA;AAAA;AAAA,cAInC,YAAA,oBACQ,MAAA,kCACH,UAAA,GAAW,UAAA,gBACX,eAAA,QAAuB,eAAA,CAAgB,kBAAA,GAErD,MAAA,EAAQ,0BAAA,CAA2B,QAAA,EAAU,KAAA,EAAO,KAAA,MACrD,cAAA,CAAe,YAAA,CAAa,QAAA,EAAU,KAAA,GAAQ,QAAA,EAAU,KAAA,EAAO,KAAA"}