@pluv/io 0.28.0 → 0.30.0

package/.turbo/turbo-build.log

@@ -1,9 +1,9 @@
 
-> @pluv/io@0.28.0 build /home/runner/work/pluv/pluv/packages/io
+> @pluv/io@0.30.0 build /home/runner/work/pluv/pluv/packages/io
 > pnpm run version && tsup src/index.ts --format esm,cjs --dts
 
 
-> @pluv/io@0.28.0 version /home/runner/work/pluv/pluv/packages/io
+> @pluv/io@0.30.0 version /home/runner/work/pluv/pluv/packages/io
 > genversion ./src/version.generated.ts --esm
 
 CLI Building entry: src/index.ts
@@ -12,11 +12,11 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 39.84 KB
-ESM ⚡️ Build success in 129ms
 CJS dist/index.js 41.98 KB
-CJS ⚡️ Build success in 130ms
+CJS ⚡️ Build success in 126ms
+ESM dist/index.mjs 39.84 KB
+ESM ⚡️ Build success in 137ms
 DTS Build start
-DTS ⚡️ Build success in 2275ms
-DTS dist/index.d.mts 25.32 KB
-DTS dist/index.d.ts  25.32 KB
+DTS ⚡️ Build success in 2298ms
+DTS dist/index.d.mts 25.37 KB
+DTS dist/index.d.ts  25.37 KB

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @pluv/io
 
+## 0.30.0
+
+### Patch Changes
+
+- 7246a9e: Added `CrdtLibraryType` so that `@pluv/crdt-yjs` and `@pluv/crdt-loro` export a new property `kind` containing an identifier for the crdt.
+  - @pluv/crdt@0.30.0
+  - @pluv/types@0.30.0
+
+## 0.29.0
+
+### Patch Changes
+
+- @pluv/crdt@0.29.0
+- @pluv/types@0.29.0
+
 ## 0.28.0
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,6 +1,6 @@
-import { JsonObject, MaybePromise, IOAuthorize, IOEventMessage, EventRecord, InputZodLike, ProcedureLike, BaseIOAuthorize, IORouterLike, InferIOAuthorizeUser, Id, InferEventMessage, InferEventsOutput, Maybe, IOLike, InferIOOutput, BaseUser, InferIOInput, InferIOAuthorize } from '@pluv/types';
+import { JsonObject, MaybePromise, IOAuthorize, IOEventMessage, EventRecord, InputZodLike, ProcedureLike, BaseIOAuthorize, IORouterLike, InferIOAuthorizeUser, Id, Maybe, InferEventMessage, InferEventsOutput, IOLike, InferIOOutput, BaseUser, InferIOInput, InferIOAuthorize } from '@pluv/types';
 export { BaseUser, EventMessage, EventRecord, IOEventMessage } from '@pluv/types';
-import { AbstractCrdtDoc, AbstractCrdtDocFactory } from '@pluv/crdt';
+import { AbstractCrdtDocFactory, AbstractCrdtDoc } from '@pluv/crdt';
 
 declare abstract class AbstractPersistence {
     abstract addUser(room: string, connectionId: string, user: JsonObject | null): Promise<void>;
@@ -122,6 +122,10 @@ declare global {
         log: (...data: any[]) => void;
     };
 }
+interface CrdtLibraryType {
+    doc: (value: any) => AbstractCrdtDocFactory<any>;
+    kind: "loro" | "yjs";
+}
 type EventResolver<TPlatform extends AbstractPlatform = AbstractPlatform, TAuthorize extends IOAuthorize<any, any, InferRoomContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}, TInput extends JsonObject = {}, TOutput extends EventRecord<string, any> = {}> = (data: TInput, context: EventResolverContext<TPlatform, TAuthorize, TContext>) => MaybePromise<TOutput | void>;
 interface EventResolverContext<TPlatform extends AbstractPlatform = AbstractPlatform, TAuthorize extends IOAuthorize<any, any, InferRoomContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}> {
     context: TContext;
@@ -374,9 +378,7 @@ declare class PluvServer<TPlatform extends AbstractPlatform<any> = AbstractPlatf
 type PluvIOConfig<TPlatform extends AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferPlatformContextType<TPlatform>>, TContext extends JsonObject> = {
     authorize?: TAuthorize;
     context?: TContext;
-    crdt?: {
-        doc: (value: any) => AbstractCrdtDocFactory<any>;
-    };
+    crdt?: CrdtLibraryType;
     debug?: boolean;
     platform: TPlatform;
 };
@@ -402,12 +404,10 @@ declare class PluvIO<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
 type CreateIOParams<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TContext extends JsonObject = {}, TAuthorizeUser extends BaseUser = BaseUser, TAuthorizeRequired extends boolean = false> = {
     authorize?: IOAuthorize<TAuthorizeUser, TAuthorizeRequired, InferPlatformContextType<TPlatform>>;
     context?: TContext;
-    crdt?: {
-        doc: (value: any) => AbstractCrdtDocFactory<any>;
-    };
+    crdt?: CrdtLibraryType;
     debug?: boolean;
     platform: TPlatform;
 };
 declare const createIO: <TPlatform extends AbstractPlatform<any> = AbstractPlatform<any, {}, {}>, TContext extends JsonObject = {}, TAuthorizeUser extends BaseUser = BaseUser, TAuthorizeRequired extends boolean = false>(params: CreateIOParams<TPlatform, TContext, TAuthorizeUser, TAuthorizeRequired>) => PluvIO<TPlatform, IOAuthorize<TAuthorizeUser, TAuthorizeRequired, InferPlatformContextType<TPlatform>>, TContext>;
 
-export { type AbstractCloseEvent, type AbstractErrorEvent, type AbstractEvent, type AbstractEventMap, type AbstractListener, type AbstractMessageEvent, AbstractPersistence, AbstractPlatform, type AbstractPlatformConfig, AbstractPubSub, AbstractWebSocket, type AbstractWebSocketConfig, type AbstractWebSocketHandleErrorParams, type AuthorizeModule, type AuthorizeParams, type ConvertWebSocketConfig, type CreateIOParams, type CreateRoomOptions, type IOPubSubEventMessage, IORoom, type IORoomListenerEvent, type IORoomMessageEvent, type InferIORoom, type InferPlatformContextType, type InferPlatformWebSocketType, type InferRoomContextType, type JWT, type JWTEncodeParams, type MergedRouter, PluvIO, type PluvIOConfig, type PluvIOListeners, PluvProcedure, type PluvProcedureConfig, PluvRouter, type PluvRouterEventConfig, PluvServer, type PluvServerConfig, type ServerConfig, type WebSocketRegistrationMode, type WebSocketSerializedState, type WebSocketSession, createIO };
+export { type AbstractCloseEvent, type AbstractErrorEvent, type AbstractEvent, type AbstractEventMap, type AbstractListener, type AbstractMessageEvent, AbstractPersistence, AbstractPlatform, type AbstractPlatformConfig, AbstractPubSub, AbstractWebSocket, type AbstractWebSocketConfig, type AbstractWebSocketHandleErrorParams, type AuthorizeModule, type AuthorizeParams, type ConvertWebSocketConfig, type CrdtLibraryType, type CreateIOParams, type CreateRoomOptions, type GetInitialStorageFn, type IOPubSubEventMessage, IORoom, type IORoomListenerEvent, type IORoomMessageEvent, type InferIORoom, type InferPlatformContextType, type InferPlatformWebSocketType, type InferRoomContextType, type JWT, type JWTEncodeParams, type MergedRouter, PluvIO, type PluvIOConfig, type PluvIOListeners, PluvProcedure, type PluvProcedureConfig, PluvRouter, type PluvRouterEventConfig, PluvServer, type PluvServerConfig, type ServerConfig, type WebSocketRegistrationMode, type WebSocketSerializedState, type WebSocketSession, createIO };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import { JsonObject, MaybePromise, IOAuthorize, IOEventMessage, EventRecord, InputZodLike, ProcedureLike, BaseIOAuthorize, IORouterLike, InferIOAuthorizeUser, Id, InferEventMessage, InferEventsOutput, Maybe, IOLike, InferIOOutput, BaseUser, InferIOInput, InferIOAuthorize } from '@pluv/types';
+import { JsonObject, MaybePromise, IOAuthorize, IOEventMessage, EventRecord, InputZodLike, ProcedureLike, BaseIOAuthorize, IORouterLike, InferIOAuthorizeUser, Id, Maybe, InferEventMessage, InferEventsOutput, IOLike, InferIOOutput, BaseUser, InferIOInput, InferIOAuthorize } from '@pluv/types';
 export { BaseUser, EventMessage, EventRecord, IOEventMessage } from '@pluv/types';
-import { AbstractCrdtDoc, AbstractCrdtDocFactory } from '@pluv/crdt';
+import { AbstractCrdtDocFactory, AbstractCrdtDoc } from '@pluv/crdt';
 
 declare abstract class AbstractPersistence {
     abstract addUser(room: string, connectionId: string, user: JsonObject | null): Promise<void>;
@@ -122,6 +122,10 @@ declare global {
         log: (...data: any[]) => void;
     };
 }
+interface CrdtLibraryType {
+    doc: (value: any) => AbstractCrdtDocFactory<any>;
+    kind: "loro" | "yjs";
+}
 type EventResolver<TPlatform extends AbstractPlatform = AbstractPlatform, TAuthorize extends IOAuthorize<any, any, InferRoomContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}, TInput extends JsonObject = {}, TOutput extends EventRecord<string, any> = {}> = (data: TInput, context: EventResolverContext<TPlatform, TAuthorize, TContext>) => MaybePromise<TOutput | void>;
 interface EventResolverContext<TPlatform extends AbstractPlatform = AbstractPlatform, TAuthorize extends IOAuthorize<any, any, InferRoomContextType<TPlatform>> = BaseIOAuthorize, TContext extends Record<string, any> = {}> {
     context: TContext;
@@ -374,9 +378,7 @@ declare class PluvServer<TPlatform extends AbstractPlatform<any> = AbstractPlatf
 type PluvIOConfig<TPlatform extends AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferPlatformContextType<TPlatform>>, TContext extends JsonObject> = {
     authorize?: TAuthorize;
     context?: TContext;
-    crdt?: {
-        doc: (value: any) => AbstractCrdtDocFactory<any>;
-    };
+    crdt?: CrdtLibraryType;
     debug?: boolean;
     platform: TPlatform;
 };
@@ -402,12 +404,10 @@ declare class PluvIO<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
 type CreateIOParams<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TContext extends JsonObject = {}, TAuthorizeUser extends BaseUser = BaseUser, TAuthorizeRequired extends boolean = false> = {
     authorize?: IOAuthorize<TAuthorizeUser, TAuthorizeRequired, InferPlatformContextType<TPlatform>>;
     context?: TContext;
-    crdt?: {
-        doc: (value: any) => AbstractCrdtDocFactory<any>;
-    };
+    crdt?: CrdtLibraryType;
     debug?: boolean;
     platform: TPlatform;
 };
 declare const createIO: <TPlatform extends AbstractPlatform<any> = AbstractPlatform<any, {}, {}>, TContext extends JsonObject = {}, TAuthorizeUser extends BaseUser = BaseUser, TAuthorizeRequired extends boolean = false>(params: CreateIOParams<TPlatform, TContext, TAuthorizeUser, TAuthorizeRequired>) => PluvIO<TPlatform, IOAuthorize<TAuthorizeUser, TAuthorizeRequired, InferPlatformContextType<TPlatform>>, TContext>;
 
-export { type AbstractCloseEvent, type AbstractErrorEvent, type AbstractEvent, type AbstractEventMap, type AbstractListener, type AbstractMessageEvent, AbstractPersistence, AbstractPlatform, type AbstractPlatformConfig, AbstractPubSub, AbstractWebSocket, type AbstractWebSocketConfig, type AbstractWebSocketHandleErrorParams, type AuthorizeModule, type AuthorizeParams, type ConvertWebSocketConfig, type CreateIOParams, type CreateRoomOptions, type IOPubSubEventMessage, IORoom, type IORoomListenerEvent, type IORoomMessageEvent, type InferIORoom, type InferPlatformContextType, type InferPlatformWebSocketType, type InferRoomContextType, type JWT, type JWTEncodeParams, type MergedRouter, PluvIO, type PluvIOConfig, type PluvIOListeners, PluvProcedure, type PluvProcedureConfig, PluvRouter, type PluvRouterEventConfig, PluvServer, type PluvServerConfig, type ServerConfig, type WebSocketRegistrationMode, type WebSocketSerializedState, type WebSocketSession, createIO };
+export { type AbstractCloseEvent, type AbstractErrorEvent, type AbstractEvent, type AbstractEventMap, type AbstractListener, type AbstractMessageEvent, AbstractPersistence, AbstractPlatform, type AbstractPlatformConfig, AbstractPubSub, AbstractWebSocket, type AbstractWebSocketConfig, type AbstractWebSocketHandleErrorParams, type AuthorizeModule, type AuthorizeParams, type ConvertWebSocketConfig, type CrdtLibraryType, type CreateIOParams, type CreateRoomOptions, type GetInitialStorageFn, type IOPubSubEventMessage, IORoom, type IORoomListenerEvent, type IORoomMessageEvent, type InferIORoom, type InferPlatformContextType, type InferPlatformWebSocketType, type InferRoomContextType, type JWT, type JWTEncodeParams, type MergedRouter, PluvIO, type PluvIOConfig, type PluvIOListeners, PluvProcedure, type PluvProcedureConfig, PluvRouter, type PluvRouterEventConfig, PluvServer, type PluvServerConfig, type ServerConfig, type WebSocketRegistrationMode, type WebSocketSerializedState, type WebSocketSession, createIO };

package/dist/index.js

@@ -930,7 +930,7 @@ var IORoom = class {
 };
 
 // src/version.generated.ts
-var version = "0.28.0";
+var version = "0.30.0";
 
 // src/PluvServer.ts
 var PluvServer = class {

package/dist/index.mjs

@@ -889,7 +889,7 @@ var IORoom = class {
 };
 
 // src/version.generated.ts
-var version = "0.28.0";
+var version = "0.30.0";
 
 // src/PluvServer.ts
 var PluvServer = class {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/io",
-  "version": "0.28.0",
+  "version": "0.30.0",
   "description": "@pluv/io server-side websocket manager",
   "author": "leedavidcs",
   "license": "MIT",
@@ -21,16 +21,16 @@
     "jose": "^5.9.2",
     "kleur": "^4.1.5",
     "wonka": "^6.3.4",
-    "@pluv/crdt": "^0.28.0",
-    "@pluv/types": "^0.28.0"
+    "@pluv/crdt": "^0.30.0",
+    "@pluv/types": "^0.30.0"
   },
   "devDependencies": {
     "eslint": "^8.57.0",
     "genversion": "^3.2.0",
     "tsup": "^8.3.0",
     "typescript": "^5.6.2",
-    "@pluv/tsconfig": "^0.28.0",
-    "eslint-config-pluv": "^0.28.0"
+    "@pluv/tsconfig": "^0.30.0",
+    "eslint-config-pluv": "^0.30.0"
   },
   "scripts": {
     "build": "pnpm run version && tsup src/index.ts --format esm,cjs --dts",

package/src/PluvIO.ts

@@ -1,14 +1,14 @@
 import type { AbstractCrdtDocFactory } from "@pluv/crdt";
 import { noop } from "@pluv/crdt";
 import type { BaseIOAuthorize, IOAuthorize, InferIOAuthorizeUser, JsonObject } from "@pluv/types";
-import type { AbstractPlatform, InferPlatformContextType, WebSocketRegistrationMode } from "./AbstractPlatform";
+import type { AbstractPlatform, InferPlatformContextType } from "./AbstractPlatform";
 import { PluvProcedure } from "./PluvProcedure";
 import type { MergedRouter, PluvRouterEventConfig } from "./PluvRouter";
 import { PluvRouter } from "./PluvRouter";
 import { PluvServer } from "./PluvServer";
 import type { JWTEncodeParams } from "./authorize";
 import { authorize } from "./authorize";
-import type { GetInitialStorageFn, PluvIOListeners } from "./types";
+import type { CrdtLibraryType, GetInitialStorageFn, PluvIOListeners } from "./types";
 import { __PLUV_VERSION } from "./version";
 
 export type PluvIOConfig<
@@ -18,7 +18,7 @@ export type PluvIOConfig<
 > = {
     authorize?: TAuthorize;
     context?: TContext;
-    crdt?: { doc: (value: any) => AbstractCrdtDocFactory<any> };
+    crdt?: CrdtLibraryType;
     debug?: boolean;
     platform: TPlatform;
 };

package/src/PluvServer.ts

@@ -11,12 +11,7 @@ import type {
     Maybe,
 } from "@pluv/types";
 import colors from "kleur";
-import type {
-    AbstractPlatform,
-    InferPlatformContextType,
-    InferRoomContextType,
-    WebSocketRegistrationMode,
-} from "./AbstractPlatform";
+import type { AbstractPlatform, InferPlatformContextType, InferRoomContextType } from "./AbstractPlatform";
 import type { IORoomListeners } from "./IORoom";
 import { IORoom } from "./IORoom";
 import { PluvProcedure } from "./PluvProcedure";

package/src/createIO.ts

@@ -1,8 +1,7 @@
-import type { AbstractCrdtDocFactory } from "@pluv/crdt";
 import type { BaseUser, IOAuthorize, JsonObject } from "@pluv/types";
 import type { AbstractPlatform, InferPlatformContextType } from "./AbstractPlatform";
 import { PluvIO } from "./PluvIO";
-import type { GetInitialStorageFn } from "./types";
+import { CrdtLibraryType } from "./types";
 
 export type CreateIOParams<
     TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>,
@@ -12,7 +11,7 @@ export type CreateIOParams<
 > = {
     authorize?: IOAuthorize<TAuthorizeUser, TAuthorizeRequired, InferPlatformContextType<TPlatform>>;
     context?: TContext;
-    crdt?: { doc: (value: any) => AbstractCrdtDocFactory<any> };
+    crdt?: CrdtLibraryType;
     debug?: boolean;
     platform: TPlatform;
 };

package/src/index.ts

@@ -35,6 +35,8 @@ export type { MergedRouter, PluvRouterEventConfig } from "./PluvRouter";
 export { PluvServer } from "./PluvServer";
 export type { CreateRoomOptions, InferIORoom, PluvServerConfig } from "./PluvServer";
 export type {
+    CrdtLibraryType,
+    GetInitialStorageFn,
     IORoomListenerEvent,
     IORoomMessageEvent,
     PluvIOListeners,

package/src/types.ts

@@ -1,4 +1,4 @@
-import type { AbstractCrdtDoc } from "@pluv/crdt";
+import type { AbstractCrdtDoc, AbstractCrdtDocFactory } from "@pluv/crdt";
 import type {
     BaseIOAuthorize,
     EventRecord,
@@ -26,6 +26,11 @@ declare global {
     };
 }
 
+export interface CrdtLibraryType {
+    doc: (value: any) => AbstractCrdtDocFactory<any>;
+    kind: "loro" | "yjs";
+}
+
 export type EventResolver<
     TPlatform extends AbstractPlatform = AbstractPlatform,
     TAuthorize extends IOAuthorize<any, any, InferRoomContextType<TPlatform>> = BaseIOAuthorize,

package/src/version.generated.ts

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