@pluv/crdt-yjs 0.3.8 → 0.4.0

package/.turbo/turbo-build.log

@@ -1,17 +1,17 @@
 
-> @pluv/crdt-yjs@0.3.8 build /home/runner/work/pluv/pluv/packages/crdt-yjs
+> @pluv/crdt-yjs@0.4.0 build /home/runner/work/pluv/pluv/packages/crdt-yjs
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
-CLI tsup v6.7.0
+CLI tsup v7.0.0
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 3.57 KB
-ESM ⚡️ Build success in 77ms
-CJS dist/index.js 4.77 KB
-CJS ⚡️ Build success in 79ms
+ESM dist/index.mjs 3.68 KB
+ESM ⚡️ Build success in 95ms
+CJS dist/index.js 4.87 KB
+CJS ⚡️ Build success in 96ms
 DTS Build start
-DTS ⚡️ Build success in 1561ms
-DTS dist/index.d.ts 3.10 KB
+DTS ⚡️ Build success in 2333ms
+DTS dist/index.d.ts 3.17 KB

package/CHANGELOG.md

@@ -1,5 +1,53 @@
 # @pluv/crdt-yjs
 
+## 0.4.0
+
+### Minor Changes
+
+- 829d31b: Added support for defining persistant frontend storage for rooms via a new `addons` option on rooms.
+
+  This also introduces the first new addon `@pluv/addon-indexeddb`, which is more-or-less the equivalent to `y-indexeddb` which you can install like so:
+
+  ```
+  npm install @pluv/addon-indexeddb
+  ```
+
+  To use this new addon, simply pass it to options when creating a room:
+
+  ```ts
+  import { addonIndexedDB } from "@pluv/addon-indexeddb";
+  import { createClient } from "@pluv/client";
+
+  const client = createClient({
+    // ...
+  });
+
+  const room = client.createRoom("my-new-room", {
+    addons: [
+      // Define your addons in an array like so
+      addonIndexedDB(),
+    ],
+  });
+  ```
+
+  Or when using `@pluv/react`:
+
+  ```ts
+  const PluvRoom = createRoomBundle({
+    // ...
+    addons: [
+      // Define your addons in an array like so
+      addonIndexedDB(),
+    ],
+  });
+  ```
+
+### Patch Changes
+
+- 8d11672: bumped dependencies to latest
+- Updated dependencies [8d11672]
+  - @pluv/types@0.2.1
+
 ## 0.3.8
 
 ### Patch Changes

package/dist/index.d.ts

@@ -29,8 +29,9 @@ declare class YjsDoc<T extends Record<string, AbstractType<any>> = {}> {
     encodeStateAsUpdate(): string;
     get<TKey extends keyof T>(key: TKey): T[TKey];
     getSharedTypes(): T;
-    subscribe(fn: (update: string, origin: string, doc: Doc, transaction: Transaction) => void): () => void;
+    subscribe(fn: (update: string, origin: any, doc: Doc, transaction: Transaction) => void): () => void;
     toJSON(): InferYjsDocJson<this>;
+    transact(fn: (transaction: Transaction) => void, origin?: any): void;
     static fromUint8Array(u8a: Uint8Array): string;
     static toUint8Array(str: string): Uint8Array;
 }

package/dist/index.js

@@ -60,7 +60,7 @@ var array = (value = []) => {
 // src/doc.ts
 var import_js_base64 = require("js-base64");
 var import_yjs2 = require("yjs");
-var YjsDoc = class {
+var YjsDoc = class _YjsDoc {
   constructor(value) {
     this.value = new import_yjs2.Doc();
     if (!value)
@@ -96,7 +96,7 @@ var YjsDoc = class {
     );
   }
   subscribe(fn) {
-    const _fn = (update, origin, doc2, transaction) => fn(YjsDoc.fromUint8Array(update), origin, doc2, transaction);
+    const _fn = (update, origin, doc2, transaction) => fn(_YjsDoc.fromUint8Array(update), origin, doc2, transaction);
     this.value.on("update", _fn);
     return () => {
       this.value.off("update", _fn);
@@ -105,6 +105,11 @@ var YjsDoc = class {
   toJSON() {
     return this._storage.toJSON();
   }
+  transact(fn, origin) {
+    this.value.transact((tx) => {
+      fn(tx);
+    }, origin);
+  }
   static fromUint8Array(u8a) {
     return (0, import_js_base64.fromUint8Array)(u8a);
   }

package/dist/index.mjs

@@ -28,8 +28,12 @@ var array = (value = []) => {
 
 // src/doc.ts
 import { fromUint8Array, toUint8Array } from "js-base64";
-import { applyUpdate, Doc as YDoc, encodeStateAsUpdate } from "yjs";
-var YjsDoc = class {
+import {
+  Doc as YDoc,
+  applyUpdate,
+  encodeStateAsUpdate
+} from "yjs";
+var YjsDoc = class _YjsDoc {
   constructor(value) {
     this.value = new YDoc();
     if (!value)
@@ -65,7 +69,7 @@ var YjsDoc = class {
     );
   }
   subscribe(fn) {
-    const _fn = (update, origin, doc2, transaction) => fn(YjsDoc.fromUint8Array(update), origin, doc2, transaction);
+    const _fn = (update, origin, doc2, transaction) => fn(_YjsDoc.fromUint8Array(update), origin, doc2, transaction);
     this.value.on("update", _fn);
     return () => {
       this.value.off("update", _fn);
@@ -74,6 +78,11 @@ var YjsDoc = class {
   toJSON() {
     return this._storage.toJSON();
   }
+  transact(fn, origin) {
+    this.value.transact((tx) => {
+      fn(tx);
+    }, origin);
+  }
   static fromUint8Array(u8a) {
     return fromUint8Array(u8a);
   }
@@ -86,15 +95,15 @@ var doc = (value) => {
 };
 
 // src/map.ts
-import { Map as YMap } from "yjs";
+import { Map as YMap2 } from "yjs";
 var map = (value = []) => {
-  return new YMap(value);
+  return new YMap2(value);
 };
 
 // src/object.ts
-import { Map as YMap2 } from "yjs";
+import { Map as YMap3 } from "yjs";
 var object = (value) => {
-  return new YMap2(Object.entries(value));
+  return new YMap3(Object.entries(value));
 };
 
 // src/text.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/crdt-yjs",
-  "version": "0.3.8",
+  "version": "0.4.0",
   "description": "yjs for @pluv/io",
   "author": "leedavidcs",
   "license": "MIT",
@@ -17,18 +17,20 @@
     "access": "public"
   },
   "dependencies": {
+    "@playwright/test": "^1.35.1",
+    "@types/react": "^18.2.13",
     "js-base64": "^3.7.5",
-    "@pluv/types": "^0.2.0"
+    "@pluv/types": "^0.2.1"
   },
   "peerDependencies": {
     "yjs": "^13.0.0"
   },
   "devDependencies": {
-    "tsup": "^6.7.0",
-    "typescript": "^5.0.4",
-    "yjs": "^13.6.1",
-    "@pluv/tsconfig": "^0.1.6",
-    "eslint-config-pluv": "^0.1.12"
+    "tsup": "^7.0.0",
+    "typescript": "^5.1.3",
+    "yjs": "^13.6.4",
+    "@pluv/tsconfig": "^0.1.7",
+    "eslint-config-pluv": "^0.1.13"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/doc.ts

@@ -1,6 +1,12 @@
 import { fromUint8Array, toUint8Array } from "js-base64";
-import type { AbstractType, Map as YMap, Transaction } from "yjs";
-import { applyUpdate, Doc as YDoc, encodeStateAsUpdate } from "yjs";
+import {
+    AbstractType,
+    Transaction,
+    Doc as YDoc,
+    Map as YMap,
+    applyUpdate,
+    encodeStateAsUpdate,
+} from "yjs";
 import type { InferYjsDocJson } from "./types";
 
 export class YjsDoc<T extends Record<string, AbstractType<any>> = {}> {
@@ -56,14 +62,14 @@ export class YjsDoc<T extends Record<string, AbstractType<any>> = {}> {
     public subscribe(
         fn: (
             update: string,
-            origin: string,
+            origin: any,
             doc: YDoc,
             transaction: Transaction
         ) => void
     ): () => void {
         const _fn = (
             update: Uint8Array,
-            origin: string,
+            origin: any,
             doc: YDoc,
             transaction: Transaction
         ) => fn(YjsDoc.fromUint8Array(update), origin, doc, transaction);
@@ -79,6 +85,15 @@ export class YjsDoc<T extends Record<string, AbstractType<any>> = {}> {
         return this._storage.toJSON() as InferYjsDocJson<this>;
     }
 
+    public transact(
+        fn: (transaction: Transaction) => void,
+        origin?: any
+    ): void {
+        this.value.transact((tx) => {
+            fn(tx);
+        }, origin);
+    }
+
     public static fromUint8Array(u8a: Uint8Array): string {
         return fromUint8Array(u8a);
     }