@pluv/platform-node 0.36.0 → 0.37.1

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/platform-node@0.36.0 build /home/runner/work/pluv/pluv/packages/platform-node
+> @pluv/platform-node@0.37.1 build /home/runner/work/pluv/pluv/packages/platform-node
 > 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 10.26 KB
-CJS ⚡️ Build success in 104ms
-ESM dist/index.mjs 8.50 KB
-ESM ⚡️ Build success in 104ms
+CJS dist/index.js 10.50 KB
+CJS ⚡️ Build success in 88ms
+ESM dist/index.mjs 8.72 KB
+ESM ⚡️ Build success in 89ms
 DTS Build start
-DTS ⚡️ Build success in 5622ms
-DTS dist/index.d.mts 4.83 KB
-DTS dist/index.d.ts  4.83 KB
+DTS ⚡️ Build success in 5723ms
+DTS dist/index.d.mts 5.89 KB
+DTS dist/index.d.ts  5.89 KB

package/CHANGELOG.md

@@ -1,5 +1,71 @@
 # @pluv/platform-node
 
+## 0.37.1
+
+### Patch Changes
+
+- @pluv/io@0.37.1
+- @pluv/types@0.37.1
+
+## 0.37.0
+
+### Minor Changes
+
+- 5165be0: **BREAKING**
+
+  Updated the `platformNode` function to return an entire `createIO` input object. Now `createIO` must be called with `platformNode`'s return value as an input.
+
+  ```ts
+  // Before
+
+  import { createIO } from "@pluv/io";
+  import { platformNode } from "@pluv/platform-node";
+
+  export const io = createIO({
+    authorize: {
+      // ...
+    },
+    context: {
+      // ...
+    },
+    platform: platformNode<Meta>({
+      // ...
+    }),
+    // ...
+  });
+
+  // After
+
+  import { createIO } from "@pluv/io";
+  import { infer, platformNode } from "@pluv/platform-node";
+
+  // Types must now be inferred like so, due to TypeScript limitations around partial inferences
+  // Note that this types variable is defined outside of the `createIO` function
+  const types = infer((i) => ({
+    meta: i<Meta>,
+  }));
+  export const io = createIO(
+    platformNode({
+      authorize: {
+        // ...
+      },
+      context: {
+        // ...
+      },
+      // Optional: Pass inferred types here
+      types,
+      // ...
+    }),
+  );
+  ```
+
+### Patch Changes
+
+- 9b74abb: Improved type inference when calling `PluvIO.server` to not include options that are always undefined (i.e. are not allowed by the specified platform).
+- Updated dependencies [9b74abb]
+  - @pluv/io@0.37.0
+  - @pluv/types@0.37.0
+
 ## 0.36.0
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import { WebSocket, Server as Server$1 } from 'ws';
 export { WebSocket } from 'ws';
-import { AbstractWebSocket, WebSocketSerializedState, AbstractWebSocketConfig, AbstractEventMap, AbstractListener, AbstractPlatform, WebSocketRegistrationMode, AbstractPersistence, AbstractPubSub, ConvertWebSocketConfig, AbstractPlatformConfig, PluvServer, InferInitContextType } from '@pluv/io';
-import { JsonObject, Json, InferIOAuthorizeUser, InferIOAuthorize, BaseUser, MaybePromise, Maybe } from '@pluv/types';
+import { AbstractWebSocket, WebSocketSerializedState, AbstractWebSocketConfig, AbstractEventMap, AbstractListener, AbstractPlatform, WebSocketRegistrationMode, AbstractPersistence, AbstractPubSub, ConvertWebSocketConfig, AbstractPlatformConfig, PluvServer, InferInitContextType, CreateIOParams, PluvIOAuthorize, PluvContext } from '@pluv/io';
+import { JsonObject, Json, InferIOAuthorizeUser, InferIOAuthorize, BaseUser, MaybePromise, Maybe, Id } from '@pluv/types';
 import { IncomingMessage, Server, ServerResponse } from 'node:http';
 
 type NodeWebSocketConfig = AbstractWebSocketConfig;
@@ -34,7 +34,7 @@ type NodePlatformConfig<TMeta extends Record<string, Json>> = {
     persistence: AbstractPersistence;
     pubSub: AbstractPubSub;
 }) & {
-    context?: NodePlatformRoomContext<TMeta>;
+    roomContext?: NodePlatformRoomContext<TMeta>;
 };
 declare class NodePlatform<TMeta extends Record<string, Json> = {}> extends AbstractPlatform<NodeWebSocket, {
     req: IncomingMessage;
@@ -52,6 +52,7 @@ declare class NodePlatform<TMeta extends Record<string, Json> = {}> extends Abst
         onUserConnected: true;
         onUserDisconnected: true;
     };
+    router: true;
 }> {
     readonly _config: {
         authorize: {
@@ -67,6 +68,7 @@ declare class NodePlatform<TMeta extends Record<string, Json> = {}> extends Abst
             onUserConnected: true;
             onUserDisconnected: true;
         };
+        router: true;
     };
     readonly _name = "platformNode";
     constructor(config?: NodePlatformConfig<TMeta>);
@@ -107,6 +109,18 @@ interface CreatePluvHandlerResult {
 }
 declare const createPluvHandler: <TPluvServer extends PluvServer<NodePlatform, any, any, any>>(config: CreatePluvHandlerConfig<TPluvServer>) => CreatePluvHandlerResult;
 
-declare const platformNode: <TMeta extends Record<string, Json> = {}>(config?: NodePlatformConfig<TMeta>) => NodePlatform<TMeta>;
+declare const identity: <T extends unknown>(x: T) => T;
 
-export { type AuthorizeFunction, type AuthorizeFunctionContext, type CreatePluvHandlerConfig, NodePlatform, type NodePlatformConfig, createPluvHandler, platformNode };
+type InferCallback<TMeta extends Record<string, Json> = {}> = (i: typeof identity) => {
+    meta?: (io: TMeta) => TMeta;
+};
+declare const infer: <TMeta extends Record<string, Json> = {}>(callback: InferCallback<TMeta>) => InferCallback<TMeta>;
+
+type PlatformNodeCreateIOParams<TMeta extends Record<string, Json> = {}, TContext extends Record<string, any> = {}, TUser extends BaseUser | null = null> = Id<NodePlatformConfig<TMeta> & Omit<CreateIOParams<NodePlatform<TMeta>, TContext, TUser>, "authorize" | "context" | "platform"> & {
+    authorize?: PluvIOAuthorize<NodePlatform<TMeta>, TUser, InferInitContextType<NodePlatform<TMeta>>>;
+    context?: PluvContext<NodePlatform<TMeta>, TContext>;
+    types?: InferCallback<TMeta>;
+}>;
+declare const platformNode: <TMeta extends Record<string, Json> = {}, TContext extends Record<string, any> = {}, TUser extends BaseUser | null = null>(config?: PlatformNodeCreateIOParams<TMeta, TContext, TUser>) => CreateIOParams<NodePlatform<TMeta>, TContext, TUser>;
+
+export { type AuthorizeFunction, type AuthorizeFunctionContext, type CreatePluvHandlerConfig, type InferCallback, NodePlatform, type NodePlatformConfig, type PlatformNodeCreateIOParams, createPluvHandler, infer, platformNode };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { WebSocket, Server as Server$1 } from 'ws';
 export { WebSocket } from 'ws';
-import { AbstractWebSocket, WebSocketSerializedState, AbstractWebSocketConfig, AbstractEventMap, AbstractListener, AbstractPlatform, WebSocketRegistrationMode, AbstractPersistence, AbstractPubSub, ConvertWebSocketConfig, AbstractPlatformConfig, PluvServer, InferInitContextType } from '@pluv/io';
-import { JsonObject, Json, InferIOAuthorizeUser, InferIOAuthorize, BaseUser, MaybePromise, Maybe } from '@pluv/types';
+import { AbstractWebSocket, WebSocketSerializedState, AbstractWebSocketConfig, AbstractEventMap, AbstractListener, AbstractPlatform, WebSocketRegistrationMode, AbstractPersistence, AbstractPubSub, ConvertWebSocketConfig, AbstractPlatformConfig, PluvServer, InferInitContextType, CreateIOParams, PluvIOAuthorize, PluvContext } from '@pluv/io';
+import { JsonObject, Json, InferIOAuthorizeUser, InferIOAuthorize, BaseUser, MaybePromise, Maybe, Id } from '@pluv/types';
 import { IncomingMessage, Server, ServerResponse } from 'node:http';
 
 type NodeWebSocketConfig = AbstractWebSocketConfig;
@@ -34,7 +34,7 @@ type NodePlatformConfig<TMeta extends Record<string, Json>> = {
     persistence: AbstractPersistence;
     pubSub: AbstractPubSub;
 }) & {
-    context?: NodePlatformRoomContext<TMeta>;
+    roomContext?: NodePlatformRoomContext<TMeta>;
 };
 declare class NodePlatform<TMeta extends Record<string, Json> = {}> extends AbstractPlatform<NodeWebSocket, {
     req: IncomingMessage;
@@ -52,6 +52,7 @@ declare class NodePlatform<TMeta extends Record<string, Json> = {}> extends Abst
         onUserConnected: true;
         onUserDisconnected: true;
     };
+    router: true;
 }> {
     readonly _config: {
         authorize: {
@@ -67,6 +68,7 @@ declare class NodePlatform<TMeta extends Record<string, Json> = {}> extends Abst
             onUserConnected: true;
             onUserDisconnected: true;
         };
+        router: true;
     };
     readonly _name = "platformNode";
     constructor(config?: NodePlatformConfig<TMeta>);
@@ -107,6 +109,18 @@ interface CreatePluvHandlerResult {
 }
 declare const createPluvHandler: <TPluvServer extends PluvServer<NodePlatform, any, any, any>>(config: CreatePluvHandlerConfig<TPluvServer>) => CreatePluvHandlerResult;
 
-declare const platformNode: <TMeta extends Record<string, Json> = {}>(config?: NodePlatformConfig<TMeta>) => NodePlatform<TMeta>;
+declare const identity: <T extends unknown>(x: T) => T;
 
-export { type AuthorizeFunction, type AuthorizeFunctionContext, type CreatePluvHandlerConfig, NodePlatform, type NodePlatformConfig, createPluvHandler, platformNode };
+type InferCallback<TMeta extends Record<string, Json> = {}> = (i: typeof identity) => {
+    meta?: (io: TMeta) => TMeta;
+};
+declare const infer: <TMeta extends Record<string, Json> = {}>(callback: InferCallback<TMeta>) => InferCallback<TMeta>;
+
+type PlatformNodeCreateIOParams<TMeta extends Record<string, Json> = {}, TContext extends Record<string, any> = {}, TUser extends BaseUser | null = null> = Id<NodePlatformConfig<TMeta> & Omit<CreateIOParams<NodePlatform<TMeta>, TContext, TUser>, "authorize" | "context" | "platform"> & {
+    authorize?: PluvIOAuthorize<NodePlatform<TMeta>, TUser, InferInitContextType<NodePlatform<TMeta>>>;
+    context?: PluvContext<NodePlatform<TMeta>, TContext>;
+    types?: InferCallback<TMeta>;
+}>;
+declare const platformNode: <TMeta extends Record<string, Json> = {}, TContext extends Record<string, any> = {}, TUser extends BaseUser | null = null>(config?: PlatformNodeCreateIOParams<TMeta, TContext, TUser>) => CreateIOParams<NodePlatform<TMeta>, TContext, TUser>;
+
+export { type AuthorizeFunction, type AuthorizeFunctionContext, type CreatePluvHandlerConfig, type InferCallback, NodePlatform, type NodePlatformConfig, type PlatformNodeCreateIOParams, createPluvHandler, infer, platformNode };

package/dist/index.js

@@ -65,6 +65,7 @@ var __async = (__this, __arguments, generator) => {
 var index_exports = {};
 __export(index_exports, {
   createPluvHandler: () => createPluvHandler,
+  infer: () => infer,
   platformNode: () => platformNode
 });
 module.exports = __toCommonJS(index_exports);
@@ -174,6 +175,9 @@ var createPluvHandler = (config) => {
   };
 };
 
+// src/infer.ts
+var infer = (callback) => callback;
+
 // src/NodePlatform.ts
 var import_io2 = require("@pluv/io");
 var import_node_crypto2 = __toESM(require("crypto"));
@@ -250,9 +254,9 @@ var NodeWebSocket = class extends import_io.AbstractWebSocket {
 // src/NodePlatform.ts
 var NodePlatform = class _NodePlatform extends import_io2.AbstractPlatform {
   constructor(config = {}) {
-    const { context, mode = "attached", persistence, pubSub } = config;
+    const { roomContext, mode = "attached", persistence, pubSub } = config;
     super(__spreadValues({
-      context
+      roomContext
     }, persistence && pubSub ? { persistence, pubSub } : {}));
     this._name = "platformNode";
     this._config = {
@@ -268,7 +272,8 @@ var NodePlatform = class _NodePlatform extends import_io2.AbstractPlatform {
         onStorageUpdated: true,
         onUserConnected: true,
         onUserDisconnected: true
-      }
+      },
+      router: true
     };
   }
   acceptWebSocket(webSocket) {
@@ -292,7 +297,7 @@ var NodePlatform = class _NodePlatform extends import_io2.AbstractPlatform {
   }
   initialize(config) {
     return new _NodePlatform({
-      context: config.context,
+      roomContext: config.roomContext,
       mode: this._config.registrationMode,
       persistence: this.persistence,
       pubSub: this.pubSub
@@ -313,10 +318,18 @@ var NodePlatform = class _NodePlatform extends import_io2.AbstractPlatform {
 
 // src/platformNode.ts
 var platformNode = (config = {}) => {
-  return new NodePlatform(config);
+  const { authorize, context, crdt, debug } = config;
+  return {
+    authorize,
+    context,
+    crdt,
+    debug,
+    platform: new NodePlatform(config)
+  };
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   createPluvHandler,
+  infer,
   platformNode
 });

package/dist/index.mjs

@@ -140,6 +140,9 @@ var createPluvHandler = (config) => {
   };
 };
 
+// src/infer.ts
+var infer = (callback) => callback;
+
 // src/NodePlatform.ts
 import { AbstractPlatform } from "@pluv/io";
 import crypto2 from "node:crypto";
@@ -216,9 +219,9 @@ var NodeWebSocket = class extends AbstractWebSocket {
 // src/NodePlatform.ts
 var NodePlatform = class _NodePlatform extends AbstractPlatform {
   constructor(config = {}) {
-    const { context, mode = "attached", persistence, pubSub } = config;
+    const { roomContext, mode = "attached", persistence, pubSub } = config;
     super(__spreadValues({
-      context
+      roomContext
     }, persistence && pubSub ? { persistence, pubSub } : {}));
     this._name = "platformNode";
     this._config = {
@@ -234,7 +237,8 @@ var NodePlatform = class _NodePlatform extends AbstractPlatform {
         onStorageUpdated: true,
         onUserConnected: true,
         onUserDisconnected: true
-      }
+      },
+      router: true
     };
   }
   acceptWebSocket(webSocket) {
@@ -258,7 +262,7 @@ var NodePlatform = class _NodePlatform extends AbstractPlatform {
   }
   initialize(config) {
     return new _NodePlatform({
-      context: config.context,
+      roomContext: config.roomContext,
       mode: this._config.registrationMode,
       persistence: this.persistence,
       pubSub: this.pubSub
@@ -279,9 +283,17 @@ var NodePlatform = class _NodePlatform extends AbstractPlatform {
 
 // src/platformNode.ts
 var platformNode = (config = {}) => {
-  return new NodePlatform(config);
+  const { authorize, context, crdt, debug } = config;
+  return {
+    authorize,
+    context,
+    crdt,
+    debug,
+    platform: new NodePlatform(config)
+  };
 };
 export {
   createPluvHandler,
+  infer,
   platformNode
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/platform-node",
-  "version": "0.36.0",
+  "version": "0.37.1",
   "description": "@pluv/io adapter for node.js",
   "author": "leedavidcs",
   "license": "MIT",
@@ -17,19 +17,19 @@
     "access": "public"
   },
   "dependencies": {
-    "@types/node": "^22.13.5",
+    "@types/node": "^22.13.7",
     "@types/ws": "^8.5.14",
     "path-to-regexp": "^8.2.0",
-    "@pluv/io": "^0.36.0",
-    "@pluv/types": "^0.36.0"
+    "@pluv/io": "^0.37.1",
+    "@pluv/types": "^0.37.1"
   },
   "devDependencies": {
     "eslint": "^8.57.1",
     "tsup": "^8.4.0",
-    "typescript": "^5.7.3",
+    "typescript": "^5.8.2",
     "ws": "^8.18.1",
-    "@pluv/tsconfig": "^0.36.0",
-    "eslint-config-pluv": "^0.36.0"
+    "@pluv/tsconfig": "^0.37.1",
+    "eslint-config-pluv": "^0.37.1"
   },
   "peerDependencies": {
     "ws": "^8.0.0"

package/src/NodePlatform.ts

@@ -21,7 +21,7 @@ export type NodePlatformRoomContext<TMeta extends Record<string, Json>> = keyof
 export type NodePlatformConfig<TMeta extends Record<string, Json>> = { mode?: WebSocketRegistrationMode } & (
     | { persistence?: undefined; pubSub?: undefined }
     | { persistence: AbstractPersistence; pubSub: AbstractPubSub }
-) & { context?: NodePlatformRoomContext<TMeta> };
+) & { roomContext?: NodePlatformRoomContext<TMeta> };
 
 export class NodePlatform<TMeta extends Record<string, Json> = {}> extends AbstractPlatform<
     NodeWebSocket,
@@ -41,16 +41,17 @@ export class NodePlatform<TMeta extends Record<string, Json> = {}> extends Abstr
             onUserConnected: true;
             onUserDisconnected: true;
         };
+        router: true;
     }
 > {
     public readonly _config;
     public readonly _name = "platformNode";
 
     constructor(config: NodePlatformConfig<TMeta> = {}) {
-        const { context, mode = "attached", persistence, pubSub } = config;
+        const { roomContext, mode = "attached", persistence, pubSub } = config;
 
         super({
-            context,
+            roomContext,
             ...(persistence && pubSub ? { persistence, pubSub } : {}),
         });
 
@@ -68,6 +69,7 @@ export class NodePlatform<TMeta extends Record<string, Json> = {}> extends Abstr
                 onUserConnected: true as const,
                 onUserDisconnected: true as const,
             },
+            router: true as const,
         };
     }
 
@@ -99,7 +101,7 @@ export class NodePlatform<TMeta extends Record<string, Json> = {}> extends Abstr
 
     public initialize(config: AbstractPlatformConfig<NodePlatformRoomContext<TMeta>>): this {
         return new NodePlatform({
-            context: config.context,
+            roomContext: config.roomContext,
             mode: this._config.registrationMode,
             persistence: this.persistence,
             pubSub: this.pubSub,

package/src/index.ts

@@ -1,5 +1,8 @@
 export type { WebSocket } from "ws";
 export { createPluvHandler } from "./createPluvHandler";
 export type { AuthorizeFunction, AuthorizeFunctionContext, CreatePluvHandlerConfig } from "./createPluvHandler";
+export { infer } from "./infer";
+export type { InferCallback } from "./infer";
 export type { NodePlatform, NodePlatformConfig } from "./NodePlatform";
 export { platformNode } from "./platformNode";
+export type { PlatformNodeCreateIOParams } from "./platformNode";

package/src/infer.ts

@@ -0,0 +1,8 @@
+import type { Json } from "@pluv/types";
+import type { identity } from "./utils";
+
+export type InferCallback<TMeta extends Record<string, Json> = {}> = (i: typeof identity) => {
+    meta?: (io: TMeta) => TMeta;
+};
+
+export const infer = <TMeta extends Record<string, Json> = {}>(callback: InferCallback<TMeta>) => callback;

package/src/platformNode.ts

@@ -1,9 +1,36 @@
-import type { Json } from "@pluv/types";
+import type { CreateIOParams, InferInitContextType, PluvContext, PluvIOAuthorize } from "@pluv/io";
+import type { BaseUser, Id, Json } from "@pluv/types";
 import type { NodePlatformConfig } from "./NodePlatform";
 import { NodePlatform } from "./NodePlatform";
+import type { InferCallback } from "./infer";
 
-export const platformNode = <TMeta extends Record<string, Json> = {}>(
-    config: NodePlatformConfig<TMeta> = {},
-): NodePlatform<TMeta> => {
-    return new NodePlatform<TMeta>(config);
+export type PlatformNodeCreateIOParams<
+    TMeta extends Record<string, Json> = {},
+    TContext extends Record<string, any> = {},
+    TUser extends BaseUser | null = null,
+> = Id<
+    NodePlatformConfig<TMeta> &
+        Omit<CreateIOParams<NodePlatform<TMeta>, TContext, TUser>, "authorize" | "context" | "platform"> & {
+            authorize?: PluvIOAuthorize<NodePlatform<TMeta>, TUser, InferInitContextType<NodePlatform<TMeta>>>;
+            context?: PluvContext<NodePlatform<TMeta>, TContext>;
+            types?: InferCallback<TMeta>;
+        }
+>;
+
+export const platformNode = <
+    TMeta extends Record<string, Json> = {},
+    TContext extends Record<string, any> = {},
+    TUser extends BaseUser | null = null,
+>(
+    config: PlatformNodeCreateIOParams<TMeta, TContext, TUser> = {},
+): CreateIOParams<NodePlatform<TMeta>, TContext, TUser> => {
+    const { authorize, context, crdt, debug } = config;
+
+    return {
+        authorize,
+        context,
+        crdt,
+        debug,
+        platform: new NodePlatform<TMeta>(config),
+    };
 };

package/src/utils/identity.ts

@@ -0,0 +1 @@
+export const identity = <T extends unknown>(x: T): T => x;

package/src/utils/index.ts

@@ -0,0 +1 @@
+export { identity } from "./identity";