@pluv/client 0.35.3 → 0.36.0

package/.turbo/turbo-build.log

@@ -1,18 +1,18 @@
 
-> @pluv/client@0.35.3 build /home/runner/work/pluv/pluv/packages/client
+> @pluv/client@0.36.0 build /home/runner/work/pluv/pluv/packages/client
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
-CLI tsup v8.3.6
+CLI tsup v8.4.0
 CLI Target: es6
 ESM Build start
 CJS Build start
-CJS dist/index.js 48.48 KB
-CJS ⚡️ Build success in 120ms
-ESM dist/index.mjs 47.18 KB
-ESM ⚡️ Build success in 121ms
+ESM dist/index.mjs 47.24 KB
+ESM ⚡️ Build success in 135ms
+CJS dist/index.js 48.56 KB
+CJS ⚡️ Build success in 138ms
 DTS Build start
-DTS ⚡️ Build success in 3832ms
-DTS dist/index.d.mts 22.65 KB
-DTS dist/index.d.ts  22.65 KB
+DTS ⚡️ Build success in 3381ms
+DTS dist/index.d.mts 22.82 KB
+DTS dist/index.d.ts  22.82 KB

package/CHANGELOG.md

@@ -1,5 +1,54 @@
 # @pluv/client
 
+## 0.36.0
+
+### Minor Changes
+
+- 4518b6d: **BREAKING**
+  Updated how `createClient` infers the `PluvServer` type (again 🙁). The property to specify the type-inferred `PluvServer` type has been renamed to `types` from `infer`. `@pluv/client` now exports a function called `infer` that must now be used to construct the inferred `types` property. `infer` must be called before, and outside of `createClient` due to TypeScript inferrence limitations. See examples below:
+
+  ```ts
+  // Before
+
+  import { createClient } from "@pluv/client";
+  import type { ioServer } from "../server/pluv";
+
+  const client = createClient({
+    // ...
+    infer: (i) => ({ io: i<typeof ioServer> }),
+    // ...
+  });
+
+  // After
+
+  import { createClient, infer } from "@pluv/client";
+  import type { ioServer } from "../server/pluv";
+
+  // Observe that `types` is initialized outside of `createClient`, instead of
+  // inline within the `createClient` function.`
+  const types = infer((i) => ({ io: i<typeof ioServer> }));
+  const client = createClient({
+    // ...
+    // Avoid calling `infer` inline within this function like in the commented
+    // example below:
+    // types: infer((i) => ({ io: i<typeof ioServer> })),
+    types,
+    // ...
+  });
+  ```
+
+### Patch Changes
+
+- @pluv/crdt@0.36.0
+- @pluv/types@0.36.0
+
+## 0.35.4
+
+### Patch Changes
+
+- @pluv/crdt@0.35.4
+- @pluv/types@0.35.4
+
 ## 0.35.3
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { CrdtType, AbstractCrdtDoc, InferCrdtJson, AbstractCrdtDocFactory } from '@pluv/crdt';
 export { CrdtType, InferCrdtJson } from '@pluv/crdt';
-import { IOLike, InferIOOutput, Id, IOEventMessage, JsonObject, InferIOAuthorizeUser, InferIOAuthorize, EventRecord, MaybePromise, InputZodLike, ProcedureLike, IORouterLike, InferIOInput, BaseUser } from '@pluv/types';
+import { IOLike, InferIOOutput, Id, IOEventMessage, JsonObject, EventRecord, InferIOAuthorizeUser, InferIOAuthorize, MaybePromise, ProcedureLike, InputZodLike, IORouterLike, InferIOInput, BaseUser } from '@pluv/types';
 export { BaseUser, EventMessage, EventRecord, IOEventMessage } from '@pluv/types';
 import { Subject } from 'wonka';
 
@@ -134,6 +134,13 @@ declare abstract class AbstractStorageStore {
     abstract initialize(): Promise<void>;
 }
 
+declare const identity: <T extends unknown>(x: T) => T;
+
+type InferCallback<TIO extends IOLike<any, any>> = (i: typeof identity) => {
+    io: (io: TIO) => TIO;
+};
+declare const infer: <TIO extends IOLike<any, any>>(callback: InferCallback<TIO>) => InferCallback<TIO>;
+
 type CrdtManagerOptions<TStorage extends Record<string, CrdtType<any, any>> = {}> = {
     encodedState?: string | Uint8Array | null;
     initialStorage?: AbstractCrdtDocFactory<TStorage>;
@@ -161,7 +168,7 @@ type FetchOptions = {
     url: string;
     options?: RequestInit;
 };
-type RoomEndpoints<TIO extends IOLike, TMetadata extends JsonObject> = {
+type RoomEndpoints<TIO extends IOLike<any, any>, TMetadata extends JsonObject> = {
     wsEndpoint?: WsEndpoint<TMetadata>;
 } & (InferIOAuthorizeUser<InferIOAuthorize<TIO>> extends BaseUser ? {
     authEndpoint: AuthEndpoint<TMetadata>;
@@ -287,20 +294,15 @@ declare class PluvRoom<TIO extends IOLike<any, any>, TMetadata extends JsonObjec
     private _updateState;
 }
 
-declare const identity: <T extends unknown>(x: T) => T;
-
-type InferCallback<TIO extends IOLike<any, any>> = (i: typeof identity) => {
-    io: (io: TIO) => TIO;
-};
 type PluvClientOptions<TIO extends IOLike<any, any>, TPresence extends JsonObject, TStorage extends Record<string, CrdtType<any, any>>, TMetadata extends JsonObject> = RoomEndpoints<TIO, TMetadata> & {
     debug?: boolean;
-    infer: InferCallback<TIO>;
     initialStorage?: AbstractCrdtDocFactory<TStorage>;
     metadata?: InputZodLike<TMetadata>;
     presence?: InputZodLike<TPresence>;
     publicKey?: string;
+    types: InferCallback<TIO>;
 };
-type CreateRoomOptions<TIO extends IOLike, TPresence extends JsonObject, TStorage extends Record<string, CrdtType<any, any>>, TMetadata extends JsonObject, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> = {
+type CreateRoomOptions<TIO extends IOLike<any, any>, TPresence extends JsonObject, TStorage extends Record<string, CrdtType<any, any>>, TMetadata extends JsonObject, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> = {
     addons?: readonly PluvRoomAddon<TIO, TMetadata, TPresence, TStorage>[];
     debug?: boolean | PluvRoomDebug<TIO>;
     initialPresence?: TPresence;
@@ -312,7 +314,7 @@ type CreateRoomOptions<TIO extends IOLike, TPresence extends JsonObject, TStorag
 } : {
     metadata: TMetadata;
 });
-declare class PluvClient<TIO extends IOLike = IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TMetadata extends JsonObject = {}> {
+declare class PluvClient<TIO extends IOLike<any, any>, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TMetadata extends JsonObject = {}> {
     private readonly _authEndpoint;
     private readonly _debug;
     private readonly _initialStorage?;
@@ -391,4 +393,4 @@ declare const register: <TMetadata extends JsonObject>(params: RegisterParams<TM
     wsEndpoint: (params: EndpointParams<TMetadata>) => string;
 };
 
-export { AbstractRoom, AbstractStorageStore, ConnectionState, type CreateRoomOptions, type MergeEvents, MockedRoom, type MockedRoomConfig, type MockedRoomEvents, PluvClient, type PluvClientOptions, type PluvProcedureConfig, PluvRoom, type PluvRoomAddon, type PluvRoomAddonInput, type PluvRoomAddonResult, type PluvRoomDebug, PluvRouter, type PluvRouterEventConfig, type RegisterParams, type UserInfo, type WebSocketConnection, type WebSocketState, createClient, register };
+export { AbstractRoom, AbstractStorageStore, ConnectionState, type CreateRoomOptions, type InferCallback, type MergeEvents, MockedRoom, type MockedRoomConfig, type MockedRoomEvents, PluvClient, type PluvClientOptions, type PluvProcedureConfig, PluvRoom, type PluvRoomAddon, type PluvRoomAddonInput, type PluvRoomAddonResult, type PluvRoomDebug, PluvRouter, type PluvRouterEventConfig, type RegisterParams, type RoomEndpoints, type UserInfo, type WebSocketConnection, type WebSocketState, createClient, infer, register };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { CrdtType, AbstractCrdtDoc, InferCrdtJson, AbstractCrdtDocFactory } from '@pluv/crdt';
 export { CrdtType, InferCrdtJson } from '@pluv/crdt';
-import { IOLike, InferIOOutput, Id, IOEventMessage, JsonObject, InferIOAuthorizeUser, InferIOAuthorize, EventRecord, MaybePromise, InputZodLike, ProcedureLike, IORouterLike, InferIOInput, BaseUser } from '@pluv/types';
+import { IOLike, InferIOOutput, Id, IOEventMessage, JsonObject, EventRecord, InferIOAuthorizeUser, InferIOAuthorize, MaybePromise, ProcedureLike, InputZodLike, IORouterLike, InferIOInput, BaseUser } from '@pluv/types';
 export { BaseUser, EventMessage, EventRecord, IOEventMessage } from '@pluv/types';
 import { Subject } from 'wonka';
 
@@ -134,6 +134,13 @@ declare abstract class AbstractStorageStore {
     abstract initialize(): Promise<void>;
 }
 
+declare const identity: <T extends unknown>(x: T) => T;
+
+type InferCallback<TIO extends IOLike<any, any>> = (i: typeof identity) => {
+    io: (io: TIO) => TIO;
+};
+declare const infer: <TIO extends IOLike<any, any>>(callback: InferCallback<TIO>) => InferCallback<TIO>;
+
 type CrdtManagerOptions<TStorage extends Record<string, CrdtType<any, any>> = {}> = {
     encodedState?: string | Uint8Array | null;
     initialStorage?: AbstractCrdtDocFactory<TStorage>;
@@ -161,7 +168,7 @@ type FetchOptions = {
     url: string;
     options?: RequestInit;
 };
-type RoomEndpoints<TIO extends IOLike, TMetadata extends JsonObject> = {
+type RoomEndpoints<TIO extends IOLike<any, any>, TMetadata extends JsonObject> = {
     wsEndpoint?: WsEndpoint<TMetadata>;
 } & (InferIOAuthorizeUser<InferIOAuthorize<TIO>> extends BaseUser ? {
     authEndpoint: AuthEndpoint<TMetadata>;
@@ -287,20 +294,15 @@ declare class PluvRoom<TIO extends IOLike<any, any>, TMetadata extends JsonObjec
     private _updateState;
 }
 
-declare const identity: <T extends unknown>(x: T) => T;
-
-type InferCallback<TIO extends IOLike<any, any>> = (i: typeof identity) => {
-    io: (io: TIO) => TIO;
-};
 type PluvClientOptions<TIO extends IOLike<any, any>, TPresence extends JsonObject, TStorage extends Record<string, CrdtType<any, any>>, TMetadata extends JsonObject> = RoomEndpoints<TIO, TMetadata> & {
     debug?: boolean;
-    infer: InferCallback<TIO>;
     initialStorage?: AbstractCrdtDocFactory<TStorage>;
     metadata?: InputZodLike<TMetadata>;
     presence?: InputZodLike<TPresence>;
     publicKey?: string;
+    types: InferCallback<TIO>;
 };
-type CreateRoomOptions<TIO extends IOLike, TPresence extends JsonObject, TStorage extends Record<string, CrdtType<any, any>>, TMetadata extends JsonObject, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> = {
+type CreateRoomOptions<TIO extends IOLike<any, any>, TPresence extends JsonObject, TStorage extends Record<string, CrdtType<any, any>>, TMetadata extends JsonObject, TEvents extends PluvRouterEventConfig<TIO, TPresence, TStorage> = {}> = {
     addons?: readonly PluvRoomAddon<TIO, TMetadata, TPresence, TStorage>[];
     debug?: boolean | PluvRoomDebug<TIO>;
     initialPresence?: TPresence;
@@ -312,7 +314,7 @@ type CreateRoomOptions<TIO extends IOLike, TPresence extends JsonObject, TStorag
 } : {
     metadata: TMetadata;
 });
-declare class PluvClient<TIO extends IOLike = IOLike, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TMetadata extends JsonObject = {}> {
+declare class PluvClient<TIO extends IOLike<any, any>, TPresence extends JsonObject = {}, TStorage extends Record<string, CrdtType<any, any>> = {}, TMetadata extends JsonObject = {}> {
     private readonly _authEndpoint;
     private readonly _debug;
     private readonly _initialStorage?;
@@ -391,4 +393,4 @@ declare const register: <TMetadata extends JsonObject>(params: RegisterParams<TM
     wsEndpoint: (params: EndpointParams<TMetadata>) => string;
 };
 
-export { AbstractRoom, AbstractStorageStore, ConnectionState, type CreateRoomOptions, type MergeEvents, MockedRoom, type MockedRoomConfig, type MockedRoomEvents, PluvClient, type PluvClientOptions, type PluvProcedureConfig, PluvRoom, type PluvRoomAddon, type PluvRoomAddonInput, type PluvRoomAddonResult, type PluvRoomDebug, PluvRouter, type PluvRouterEventConfig, type RegisterParams, type UserInfo, type WebSocketConnection, type WebSocketState, createClient, register };
+export { AbstractRoom, AbstractStorageStore, ConnectionState, type CreateRoomOptions, type InferCallback, type MergeEvents, MockedRoom, type MockedRoomConfig, type MockedRoomEvents, PluvClient, type PluvClientOptions, type PluvProcedureConfig, PluvRoom, type PluvRoomAddon, type PluvRoomAddonInput, type PluvRoomAddonResult, type PluvRoomDebug, PluvRouter, type PluvRouterEventConfig, type RegisterParams, type RoomEndpoints, type UserInfo, type WebSocketConnection, type WebSocketState, createClient, infer, register };

package/dist/index.js

@@ -64,6 +64,7 @@ __export(index_exports, {
   PluvClient: () => PluvClient,
   PluvRoom: () => PluvRoom,
   createClient: () => createClient,
+  infer: () => infer,
   register: () => register
 });
 module.exports = __toCommonJS(index_exports);
@@ -1261,6 +1262,9 @@ var createClient = (options) => {
   return new PluvClient(options);
 };
 
+// src/infer.ts
+var infer = (callback) => callback;
+
 // src/MockedRoom.ts
 var MockedRoom = class extends AbstractRoom {
   constructor(room, options) {
@@ -1470,5 +1474,6 @@ var register = (params) => {
   PluvClient,
   PluvRoom,
   createClient,
+  infer,
   register
 });

package/dist/index.mjs

@@ -1231,6 +1231,9 @@ var createClient = (options) => {
   return new PluvClient(options);
 };
 
+// src/infer.ts
+var infer = (callback) => callback;
+
 // src/MockedRoom.ts
 var MockedRoom = class extends AbstractRoom {
   constructor(room, options) {
@@ -1439,5 +1442,6 @@ export {
   PluvClient,
   PluvRoom,
   createClient,
+  infer,
   register
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/client",
-  "version": "0.35.3",
+  "version": "0.36.0",
   "description": "@pluv/io frontend client",
   "author": "leedavidcs",
   "license": "MIT",
@@ -18,15 +18,15 @@
   },
   "dependencies": {
     "wonka": "^6.3.4",
-    "@pluv/crdt": "^0.35.3",
-    "@pluv/types": "^0.35.3"
+    "@pluv/crdt": "^0.36.0",
+    "@pluv/types": "^0.36.0"
   },
   "devDependencies": {
     "eslint": "^8.57.1",
-    "tsup": "^8.3.6",
+    "tsup": "^8.4.0",
     "typescript": "^5.7.3",
-    "@pluv/tsconfig": "^0.35.3",
-    "eslint-config-pluv": "^0.35.3"
+    "@pluv/tsconfig": "^0.36.0",
+    "eslint-config-pluv": "^0.36.0"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/PluvClient.ts

@@ -1,15 +1,11 @@
 import type { AbstractCrdtDocFactory, CrdtType } from "@pluv/crdt";
 import type { InputZodLike, IOLike, JsonObject } from "@pluv/types";
+import type { InferCallback } from "./infer";
 import { PluvProcedure } from "./PluvProcedure";
 import type { AuthEndpoint, PluvRoomAddon, PluvRoomDebug, RoomConfig, RoomEndpoints, WsEndpoint } from "./PluvRoom";
 import { PluvRoom } from "./PluvRoom";
 import type { PluvRouterEventConfig } from "./PluvRouter";
 import { PluvRouter } from "./PluvRouter";
-import type { identity } from "./utils";
-
-export type InferCallback<TIO extends IOLike<any, any>> = (i: typeof identity) => {
-    io: (io: TIO) => TIO;
-};
 
 export type PluvClientOptions<
     TIO extends IOLike<any, any>,
@@ -18,15 +14,15 @@ export type PluvClientOptions<
     TMetadata extends JsonObject,
 > = RoomEndpoints<TIO, TMetadata> & {
     debug?: boolean;
-    infer: InferCallback<TIO>;
     initialStorage?: AbstractCrdtDocFactory<TStorage>;
     metadata?: InputZodLike<TMetadata>;
     presence?: InputZodLike<TPresence>;
     publicKey?: string;
+    types: InferCallback<TIO>;
 };
 
 export type CreateRoomOptions<
-    TIO extends IOLike,
+    TIO extends IOLike<any, any>,
     TPresence extends JsonObject,
     TStorage extends Record<string, CrdtType<any, any>>,
     TMetadata extends JsonObject,
@@ -41,7 +37,7 @@ export type CreateRoomOptions<
 } & (keyof TMetadata extends never ? { metadata?: undefined } : { metadata: TMetadata });
 
 export class PluvClient<
-    TIO extends IOLike = IOLike,
+    TIO extends IOLike<any, any>,
     TPresence extends JsonObject = {},
     TStorage extends Record<string, CrdtType<any, any>> = {},
     TMetadata extends JsonObject = {},

package/src/PluvRoom.ts

@@ -101,7 +101,7 @@ export type WsEndpoint<TMetadata extends JsonObject> = string | ((params: Endpoi
 
 type FetchOptions = { url: string; options?: RequestInit };
 
-export type RoomEndpoints<TIO extends IOLike, TMetadata extends JsonObject> = {
+export type RoomEndpoints<TIO extends IOLike<any, any>, TMetadata extends JsonObject> = {
     wsEndpoint?: WsEndpoint<TMetadata>;
 } & (InferIOAuthorizeUser<InferIOAuthorize<TIO>> extends BaseUser
     ? { authEndpoint: AuthEndpoint<TMetadata> }

package/src/index.ts

@@ -4,13 +4,15 @@ export { AbstractRoom } from "./AbstractRoom";
 export { AbstractStorageStore } from "./AbstractStorageStore";
 export { createClient } from "./createClient";
 export { ConnectionState } from "./enums";
+export { infer } from "./infer";
+export type { InferCallback } from "./infer";
 export { MockedRoom } from "./MockedRoom";
 export type { MockedRoomConfig, MockedRoomEvents } from "./MockedRoom";
 export { PluvClient } from "./PluvClient";
 export type { CreateRoomOptions, PluvClientOptions } from "./PluvClient";
 export type { PluvProcedureConfig } from "./PluvProcedure";
 export { PluvRoom } from "./PluvRoom";
-export type { PluvRoomAddon, PluvRoomAddonInput, PluvRoomAddonResult, PluvRoomDebug } from "./PluvRoom";
+export type { PluvRoomAddon, PluvRoomAddonInput, PluvRoomAddonResult, PluvRoomDebug, RoomEndpoints } from "./PluvRoom";
 export type { MergeEvents, PluvRouter, PluvRouterEventConfig } from "./PluvRouter";
 export { register } from "./register";
 export type { RegisterParams } from "./register";

package/src/infer.ts

@@ -0,0 +1,8 @@
+import type { IOLike } from "@pluv/types";
+import type { identity } from "./utils";
+
+export type InferCallback<TIO extends IOLike<any, any>> = (i: typeof identity) => {
+    io: (io: TIO) => TIO;
+};
+
+export const infer = <TIO extends IOLike<any, any>>(callback: InferCallback<TIO>): InferCallback<TIO> => callback;