@pluv/client 0.12.2 → 0.13.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/client@0.12.2 build /home/runner/work/pluv/pluv/packages/client
+> @pluv/client@0.13.0 build /home/runner/work/pluv/pluv/packages/client
 > 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
-ESM dist/index.mjs 42.81 KB
-ESM ⚡️ Build success in 96ms
-CJS dist/index.js 44.05 KB
-CJS ⚡️ Build success in 96ms
+ESM dist/index.mjs 42.92 KB
+ESM ⚡️ Build success in 84ms
+CJS dist/index.js 44.17 KB
+CJS ⚡️ Build success in 85ms
 DTS Build start
-DTS ⚡️ Build success in 2895ms
-DTS dist/index.d.mts 14.24 KB
-DTS dist/index.d.ts  14.24 KB
+DTS ⚡️ Build success in 2881ms
+DTS dist/index.d.mts 14.31 KB
+DTS dist/index.d.ts  14.31 KB

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @pluv/client
 
+## 0.13.0
+
+### Minor Changes
+
+- 1126215: Added `getDoc` on `PluvRoom` to access the root Yjs doc.
+
+  ```ts
+  import { createClient } from "@pluv/client";
+  import type { Doc } from "yjs";
+
+  const client = createClient(/* ... */);
+  const room = client.createRoom(/* ... */);
+
+  const doc: Doc = room.getDoc();
+  ```
+
+### Patch Changes
+
+- @pluv/crdt-yjs@0.13.0
+- @pluv/types@0.13.0
+
+## 0.12.3
+
+### Patch Changes
+
+- da9f600: Upgraded dependencies
+- Updated dependencies [da9f600]
+  - @pluv/crdt-yjs@0.12.3
+  - @pluv/types@0.12.3
+
 ## 0.12.2
 
 ### Patch Changes

package/dist/index.d.mts

@@ -3,7 +3,7 @@ export { InferYjsSharedTypeJson, TrackOriginOptions } from '@pluv/crdt-yjs';
 import * as _pluv_types from '@pluv/types';
 import { IOLike, InferIOOutput, Id, IOEventMessage, JsonObject, InferIOAuthorizeUser, InferIOAuthorize, InferIOInput, InputZodLike, InferIOAuthorizeRequired } from '@pluv/types';
 export { BaseUser, EventMessage, EventRecord, IOEventMessage } from '@pluv/types';
-import { AbstractType } from 'yjs';
+import { AbstractType, Doc } from 'yjs';
 export { AbstractType } from 'yjs';
 import { Subject } from 'wonka';
 
@@ -53,6 +53,7 @@ declare abstract class AbstractRoom<TIO extends IOLike, TPresence extends JsonOb
     abstract broadcast<TEvent extends keyof InferIOInput<TIO>>(event: TEvent, data: Id<InferIOInput<TIO>[TEvent]>): void;
     abstract canRedo(): boolean;
     abstract canUndo(): boolean;
+    abstract getDoc(): Doc;
     abstract event<TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>): () => void;
     abstract getConnection(): WebSocketConnection;
     abstract getMyPresence(): TPresence;
@@ -158,6 +159,7 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     disconnect(): Promise<void>;
     event: <TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => (() => void);
     getConnection(): WebSocketConnection;
+    getDoc(): Doc;
     getMyPresence: () => TPresence;
     getMyself: () => Id<UserInfo<TIO, TPresence>> | null;
     getOther: (connectionId: string) => Id<UserInfo<TIO, TPresence>> | null;
@@ -264,6 +266,7 @@ declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject = {},
     canUndo: () => boolean;
     event: <TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => (() => void);
     getConnection(): WebSocketConnection;
+    getDoc(): Doc;
     getMyPresence: () => TPresence;
     getMyself: () => Id<UserInfo<TIO, TPresence>> | null;
     getOther: (connectionId: string) => Id<UserInfo<TIO, TPresence>> | null;

package/dist/index.d.ts

@@ -3,7 +3,7 @@ export { InferYjsSharedTypeJson, TrackOriginOptions } from '@pluv/crdt-yjs';
 import * as _pluv_types from '@pluv/types';
 import { IOLike, InferIOOutput, Id, IOEventMessage, JsonObject, InferIOAuthorizeUser, InferIOAuthorize, InferIOInput, InputZodLike, InferIOAuthorizeRequired } from '@pluv/types';
 export { BaseUser, EventMessage, EventRecord, IOEventMessage } from '@pluv/types';
-import { AbstractType } from 'yjs';
+import { AbstractType, Doc } from 'yjs';
 export { AbstractType } from 'yjs';
 import { Subject } from 'wonka';
 
@@ -53,6 +53,7 @@ declare abstract class AbstractRoom<TIO extends IOLike, TPresence extends JsonOb
     abstract broadcast<TEvent extends keyof InferIOInput<TIO>>(event: TEvent, data: Id<InferIOInput<TIO>[TEvent]>): void;
     abstract canRedo(): boolean;
     abstract canUndo(): boolean;
+    abstract getDoc(): Doc;
     abstract event<TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>): () => void;
     abstract getConnection(): WebSocketConnection;
     abstract getMyPresence(): TPresence;
@@ -158,6 +159,7 @@ declare class PluvRoom<TIO extends IOLike, TPresence extends JsonObject = {}, TS
     disconnect(): Promise<void>;
     event: <TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => (() => void);
     getConnection(): WebSocketConnection;
+    getDoc(): Doc;
     getMyPresence: () => TPresence;
     getMyself: () => Id<UserInfo<TIO, TPresence>> | null;
     getOther: (connectionId: string) => Id<UserInfo<TIO, TPresence>> | null;
@@ -264,6 +266,7 @@ declare class MockedRoom<TIO extends IOLike, TPresence extends JsonObject = {},
     canUndo: () => boolean;
     event: <TEvent extends keyof InferIOOutput<TIO>>(event: TEvent, callback: EventNotifierSubscriptionCallback<TIO, TEvent>) => (() => void);
     getConnection(): WebSocketConnection;
+    getDoc(): Doc;
     getMyPresence: () => TPresence;
     getMyself: () => Id<UserInfo<TIO, TPresence>> | null;
     getOther: (connectionId: string) => Id<UserInfo<TIO, TPresence>> | null;

package/dist/index.js

@@ -638,6 +638,9 @@ var PluvRoom = class extends AbstractRoom {
       JSON.parse(JSON.stringify(this._state.connection))
     );
   }
+  getDoc() {
+    return this._crdtManager.doc.value;
+  }
   _addToStorageStore(update) {
     return __async(this, null, function* () {
       yield this._storageStore.addUpdate(update);
@@ -1411,6 +1414,9 @@ var MockedRoom = class extends AbstractRoom {
       JSON.parse(JSON.stringify(this._state.connection))
     );
   }
+  getDoc() {
+    return this._crdtManager.doc.value;
+  }
   _observeCrdt() {
     var _a, _b;
     (_b = (_a = this._subscriptions).observeCrdt) == null ? void 0 : _b.call(_a);

package/dist/index.mjs

@@ -612,6 +612,9 @@ var PluvRoom = class extends AbstractRoom {
       JSON.parse(JSON.stringify(this._state.connection))
     );
   }
+  getDoc() {
+    return this._crdtManager.doc.value;
+  }
   _addToStorageStore(update) {
     return __async(this, null, function* () {
       yield this._storageStore.addUpdate(update);
@@ -1385,6 +1388,9 @@ var MockedRoom = class extends AbstractRoom {
       JSON.parse(JSON.stringify(this._state.connection))
     );
   }
+  getDoc() {
+    return this._crdtManager.doc.value;
+  }
   _observeCrdt() {
     var _a, _b;
     (_b = (_a = this._subscriptions).observeCrdt) == null ? void 0 : _b.call(_a);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/client",
-  "version": "0.12.2",
+  "version": "0.13.0",
   "description": "@pluv/io frontend client",
   "author": "leedavidcs",
   "license": "MIT",
@@ -18,19 +18,19 @@
   },
   "dependencies": {
     "wonka": "^6.3.4",
-    "@pluv/crdt-yjs": "^0.12.2",
-    "@pluv/types": "^0.12.2"
+    "@pluv/crdt-yjs": "^0.13.0",
+    "@pluv/types": "^0.13.0"
   },
   "peerDependencies": {
     "yjs": "^13.0.0"
   },
   "devDependencies": {
-    "eslint": "^8.54.0",
+    "eslint": "^8.55.0",
     "tsup": "^8.0.1",
     "typescript": "^5.2.2",
     "yjs": "^13.6.10",
-    "@pluv/tsconfig": "^0.12.2",
-    "eslint-config-pluv": "^0.12.2"
+    "@pluv/tsconfig": "^0.13.0",
+    "eslint-config-pluv": "^0.13.0"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/AbstractRoom.ts

@@ -6,7 +6,7 @@ import type {
     IOLike,
     JsonObject,
 } from "@pluv/types";
-import type { AbstractType } from "yjs";
+import type { AbstractType, Doc } from "yjs";
 import type { EventNotifierSubscriptionCallback } from "./EventNotifier";
 import type { OtherNotifierSubscriptionCallback } from "./OtherNotifier";
 import type {
@@ -35,6 +35,8 @@ export abstract class AbstractRoom<
 
     public abstract canUndo(): boolean;
 
+    public abstract getDoc(): Doc;
+
     public abstract event<TEvent extends keyof InferIOOutput<TIO>>(
         event: TEvent,
         callback: EventNotifierSubscriptionCallback<TIO, TEvent>,

package/src/MockedRoom.ts

@@ -6,7 +6,7 @@ import type {
     IOLike,
     JsonObject,
 } from "@pluv/types";
-import type { AbstractType } from "yjs";
+import type { AbstractType, Doc } from "yjs";
 import { AbstractRoom } from "./AbstractRoom";
 import { CrdtManager, CrdtManagerOptions } from "./CrdtManager";
 import { CrdtNotifier } from "./CrdtNotifier";
@@ -139,6 +139,10 @@ export class MockedRoom<
         );
     }
 
+    public getDoc(): Doc {
+        return this._crdtManager.doc.value;
+    }
+
     public getMyPresence = (): TPresence => {
         return this._usersManager.myPresence;
     };

package/src/PluvRoom.ts

@@ -12,7 +12,7 @@ import type {
     IOLike,
     JsonObject,
 } from "@pluv/types";
-import type { AbstractType } from "yjs";
+import type { AbstractType, Doc } from "yjs";
 import { AbstractRoom } from "./AbstractRoom";
 import { AbstractStorageStore } from "./AbstractStorageStore";
 import type { CrdtManagerOptions } from "./CrdtManager";
@@ -364,6 +364,10 @@ export class PluvRoom<
         );
     }
 
+    public getDoc(): Doc {
+        return this._crdtManager.doc.value;
+    }
+
     public getMyPresence = (): TPresence => {
         return this._usersManager.myPresence;
     };