@pluv/crdt-yjs 2.2.1 → 2.2.2

package/.turbo/turbo-build.log

@@ -1,18 +1,18 @@
 
-> @pluv/crdt-yjs@2.2.1 build /home/runner/work/pluv/pluv/packages/crdt-yjs
+> @pluv/crdt-yjs@2.2.2 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 v8.4.0
+CLI tsup v8.5.0
 CLI Target: es6
 ESM Build start
 CJS Build start
-CJS dist/index.js 23.15 KB
-CJS ⚡️ Build success in 110ms
-ESM dist/index.mjs 22.21 KB
-ESM ⚡️ Build success in 110ms
+CJS dist/index.js 23.19 KB
+CJS ⚡️ Build success in 123ms
+ESM dist/index.mjs 22.25 KB
+ESM ⚡️ Build success in 124ms
 DTS Build start
-DTS ⚡️ Build success in 4831ms
-DTS dist/index.d.mts 10.93 KB
-DTS dist/index.d.ts  10.93 KB
+DTS ⚡️ Build success in 4915ms
+DTS dist/index.d.mts 10.95 KB
+DTS dist/index.d.ts  10.95 KB

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @pluv/crdt-yjs
 
+## 2.2.2
+
+### Patch Changes
+
+- 289d71d: Updated `yjs.provider` field to `presenceField`.
+    - @pluv/crdt@2.2.2
+    - @pluv/types@2.2.2
+
 ## 2.2.1
 
 ### Patch Changes
@@ -13,71 +21,71 @@
 
 - 745f6df: Added a `provider` function that satisfies Yjs's provider interface.
 
-  ```ts
-  import { createClient } from "@pluv/client";
-  import { yjs } from "@pluv/crdt-yjs";
+    ```ts
+    import { createClient } from "@pluv/client";
+    import { yjs } from "@pluv/crdt-yjs";
 
-  const client = createClient({
-    /* ... */
-  });
-  const room = client.createRoom("example-room");
+    const client = createClient({
+        /* ... */
+    });
+    const room = client.createRoom("example-room");
 
-  // Yjs Provider
-  yjs.provider({ room });
-  ```
+    // Yjs Provider
+    yjs.provider({ room });
+    ```
 
 - df4ceed: Update `yjs.awareness` and `yjs.provider` to allow for a `field` parameter to use awareness on a nested presence field.
 
-  ```ts
-  createClient({
-    presence: z.object({
-      topField: z.number(),
-      forAwareness: z.object({
-        nestedField: z.number(),
-      }),
-    }),
-  });
-
-  yjs.provider({
-    // ...
-    // Optional field to use a nested field, instead of the presence root
-    field: "forAwareness",
-  });
-
-  yjs.awareness({
-    // ...
-    // Optional field to use a nested field, instead of the presence root
-    field: "forAwareness",
-  });
-  ```
-
-  This allows better integrations with [lexical](https://lexical.dev), since they have their own presence types.
-
-  ```tsx
-  createClient({
-    presence: z.object({
-      topField: z.number(),
-      lexical: z.any(),
-    }),
-  });
-
-  yjs.provider({ field: "lexical" /* ... */ });
-  ```
+    ```ts
+    createClient({
+        presence: z.object({
+            topField: z.number(),
+            forAwareness: z.object({
+                nestedField: z.number(),
+            }),
+        }),
+    });
+
+    yjs.provider({
+        // ...
+        // Optional field to use a nested field, instead of the presence root
+        field: "forAwareness",
+    });
+
+    yjs.awareness({
+        // ...
+        // Optional field to use a nested field, instead of the presence root
+        field: "forAwareness",
+    });
+    ```
+
+    This allows better integrations with [lexical](https://lexical.dev), since they have their own presence types.
+
+    ```tsx
+    createClient({
+        presence: z.object({
+            topField: z.number(),
+            lexical: z.any(),
+        }),
+    });
+
+    yjs.provider({ field: "lexical" /* ... */ });
+    ```
 
 - 6323979: Added an `awareness` function that satisfies Yjs's [awareness interface](https://github.com/yjs/y-protocols/blob/master/awareness.js).
 
-  ```ts
-  import { createClient } from "@pluv/client";
-  import { yjs } from "@pluv/crdt-yjs";
+    ```ts
+    import { createClient } from "@pluv/client";
+    import { yjs } from "@pluv/crdt-yjs";
 
-  const client = createClient({
-    /* ... */
-  });
-  const room = client.createRoom("example-room");
+    const client = createClient({
+        /* ... */
+    });
+    const room = client.createRoom("example-room");
 
-  // Yjs Awareness
-  yjs.awareness({ room /* ... */ });
-  ```
+    // Yjs Awareness
+    yjs.awareness({ room /* ... */ });
+    ```
 
 ### Patch Changes
 
@@ -97,10 +105,10 @@
 
 - 945c47d: Updated deprecation warnings to read that features will be removed in v3 instead of v2.
 
-  Due to an [extremely unfortunate bug in changesets](https://github.com/changesets/changesets/issues/1011), minor and patch changes will create major releases. This caused an unintended v2 release that had no breaking changes. To avoid backtracking and deleting deprecated functionalities right away, the deprecation warnings have been updated so that those APIs will be removed in v3 instead of v2.
+    Due to an [extremely unfortunate bug in changesets](https://github.com/changesets/changesets/issues/1011), minor and patch changes will create major releases. This caused an unintended v2 release that had no breaking changes. To avoid backtracking and deleting deprecated functionalities right away, the deprecation warnings have been updated so that those APIs will be removed in v3 instead of v2.
 
-  - @pluv/crdt@2.0.2
-  - @pluv/types@2.0.2
+    - @pluv/crdt@2.0.2
+    - @pluv/types@2.0.2
 
 ## 2.0.1
 
@@ -115,43 +123,43 @@
 
 - 0b234d1: **Deprecated** Declaring top-level types on your CRDT storage via the `yjs` utility (e.g. `yjs.array`) is now deprecated, to be removed in the next major release (v2). Continuing to use the `yjs` utility to declare top-level types will log a warning to your console while in development mode (i.e. when `process.env.NODE_ENV === "development"`). To declare top-level types, you should now use the builder type exposed in the storage factory function. See the example below:
 
-  ```ts
-  import { yjs } from "@pluv/crdt-yjs";
-
-  // Before
-  yjs.doc(() => ({
-    // Using the `yjs` utility (in this case `yjs.map`) when declaring
-    // top-level types is now deprecated
-    topType: yjs.map([
-      ["key1", yjs.text("")],
-      ["key2", yjs.text("")],
-    ]),
-  }));
-
-  // After
-  yjs.doc((t) => ({
-    // Top-level properties must now use the builder (in this case `t`).
-    // This effectively calls `yjs.getMap("topType")` to instantiate the type on
-    // the root document.
-    // This simply returns the native Yjs shared-types (e.g. Y.Map), which
-    // allows you operate on your yjs shared-typess in a more native way.
-    topType: t.map("topType", [
-      // Declaring nested types should continue to use the `yjs` utilities
-      // you've used before
-      ["key1", yjs.text("")],
-      ["key2", yjs.text("")],
-    ]),
-  }));
-  ```
-
-  The functions on the builder type calls the native yjs shared-type instantiating methods and returns the native types (e.g. `t.map("topType")` is simply just a `Y.Doc.getMap("topType")`) call under the hood. This allows you to declare your type in a more yjs-native and predictable way, and enables declaring more complex initial storage states if needed.
+    ```ts
+    import { yjs } from "@pluv/crdt-yjs";
+
+    // Before
+    yjs.doc(() => ({
+        // Using the `yjs` utility (in this case `yjs.map`) when declaring
+        // top-level types is now deprecated
+        topType: yjs.map([
+            ["key1", yjs.text("")],
+            ["key2", yjs.text("")],
+        ]),
+    }));
+
+    // After
+    yjs.doc((t) => ({
+        // Top-level properties must now use the builder (in this case `t`).
+        // This effectively calls `yjs.getMap("topType")` to instantiate the type on
+        // the root document.
+        // This simply returns the native Yjs shared-types (e.g. Y.Map), which
+        // allows you operate on your yjs shared-typess in a more native way.
+        topType: t.map("topType", [
+            // Declaring nested types should continue to use the `yjs` utilities
+            // you've used before
+            ["key1", yjs.text("")],
+            ["key2", yjs.text("")],
+        ]),
+    }));
+    ```
+
+    The functions on the builder type calls the native yjs shared-type instantiating methods and returns the native types (e.g. `t.map("topType")` is simply just a `Y.Doc.getMap("topType")`) call under the hood. This allows you to declare your type in a more yjs-native and predictable way, and enables declaring more complex initial storage states if needed.
 
 ### Patch Changes
 
 - 0b234d1: Fixed `Y.XmlText` types transforming into `Y.Text` types on the initial initializaion of storage states.
 - Updated dependencies [047a1d8]
-  - @pluv/types@2.0.0
-  - @pluv/crdt@2.0.0
+    - @pluv/types@2.0.0
+    - @pluv/crdt@2.0.0
 
 ## 1.0.2
 
@@ -173,15 +181,15 @@
 
 - af94706: pluv.io is now stable and production ready!
 
-  With this v1 release, pluv.io will now follow [semantic versioning](https://semver.org/) with more comprehensive release notes for future changes to the library.
+    With this v1 release, pluv.io will now follow [semantic versioning](https://semver.org/) with more comprehensive release notes for future changes to the library.
 
-  Checkout the [full documentation here](https://pluv.io/docs/introduction) to get started today!
+    Checkout the [full documentation here](https://pluv.io/docs/introduction) to get started today!
 
 ### Patch Changes
 
 - Updated dependencies [af94706]
-  - @pluv/crdt@1.0.0
-  - @pluv/types@1.0.0
+    - @pluv/crdt@1.0.0
+    - @pluv/types@1.0.0
 
 ## 0.44.2
 
@@ -202,8 +210,8 @@
 ### Patch Changes
 
 - 503c23b: Updated `batchApplyEncodedState` to use `Yjs.mergeUpdates` to more efficiently update the document under-the-hood, while also producing a smaller document.
-  - @pluv/crdt@0.44.0
-  - @pluv/types@0.44.0
+    - @pluv/crdt@0.44.0
+    - @pluv/types@0.44.0
 
 ## 0.43.0
 
@@ -413,8 +421,8 @@
 ### Patch Changes
 
 - Updated dependencies [f4ceca3]
-  - @pluv/types@0.38.0
-  - @pluv/crdt@0.38.0
+    - @pluv/types@0.38.0
+    - @pluv/crdt@0.38.0
 
 ## 0.37.7
 
@@ -498,16 +506,16 @@
 ### Patch Changes
 
 - Updated dependencies [81cb692]
-  - @pluv/types@0.35.2
-  - @pluv/crdt@0.35.2
+    - @pluv/types@0.35.2
+    - @pluv/crdt@0.35.2
 
 ## 0.35.1
 
 ### Patch Changes
 
 - 820898c: Increase undo/redo merge interval from 0s to 1s.
-  - @pluv/crdt@0.35.1
-  - @pluv/types@0.35.1
+    - @pluv/crdt@0.35.1
+    - @pluv/types@0.35.1
 
 ## 0.35.0
 
@@ -633,8 +641,8 @@
 ### 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
+    - @pluv/crdt@0.30.0
+    - @pluv/types@0.30.0
 
 ## 0.29.0
 
@@ -747,76 +755,76 @@
 
 - 9492085: **BREAKING**: `@pluv/crdt-yjs` and `@pluv/crdt-loro` have been updated so that the utilities to create shared-types/containers no-longer return a wrapper around the underlying shared-types and containers, but rather return the shared-types/containers directly.
 
-  This means that for methods such as `getStorage` from `@pluv/client` and `useStorage` from `@pluv/react`, the shared-types/containers are also returned instead of the wrapper types.
+    This means that for methods such as `getStorage` from `@pluv/client` and `useStorage` from `@pluv/react`, the shared-types/containers are also returned instead of the wrapper types.
 
-  The motivation for these changes are so that pluv.io is supplementary to `yjs` and `loro-crdt`, instead of having these libraries be an internal implementation of pluv.io.
+    The motivation for these changes are so that pluv.io is supplementary to `yjs` and `loro-crdt`, instead of having these libraries be an internal implementation of pluv.io.
 
-  ```ts
-  // Before
+    ```ts
+    // Before
+
+    import { yjs } from "@pluv/crdt-yjs";
 
-  import { yjs } from "@pluv/crdt-yjs";
+    yjs.array([]); // Returns CrdtYjsArray
+    yjs.object([]); // Returns CrdtYjsObject
 
-  yjs.array([]); // Returns CrdtYjsArray
-  yjs.object([]); // Returns CrdtYjsObject
+    const room: PluvRoom = /* ... */;
 
-  const room: PluvRoom = /* ... */;
+    room.getStorage("messages"); // Returns AbstractCrdtType
 
-  room.getStorage("messages"); // Returns AbstractCrdtType
+    const [, sharedType] = useStorage("messages"); // sharedType is an AbstractCrdtType
+    ```
 
-  const [, sharedType] = useStorage("messages"); // sharedType is an AbstractCrdtType
-  ```
+    ```ts
+    // Now
 
-  ```ts
-  // Now
+    import { yjs } from "@pluv/crdt-yjs";
 
-  import { yjs } from "@pluv/crdt-yjs";
+    yjs.array([]); // Returns yjs.Array
+    yjs.object([]); // Returns yjs.Map
 
-  yjs.array([]); // Returns yjs.Array
-  yjs.object([]); // Returns yjs.Map
+    const room: PluvRoom = /* ... */;
 
-  const room: PluvRoom = /* ... */;
+    room.getStorage("messages"); // Returns yjs.AbstractType
 
-  room.getStorage("messages"); // Returns yjs.AbstractType
+    const [, sharedType] = useStorage("messages"); // sharedType is a yjs.AbstractType
+    ```
 
-  const [, sharedType] = useStorage("messages"); // sharedType is a yjs.AbstractType
-  ```
+    For `@pluv/crdt-loro` specifically, `@pluv/client` relies on [loro events and subscriptions](https://www.loro.dev/docs/tutorial/get_started#event) to detect changes. The `AbstractLoroCrdt` types previously called `Loro.commit` after each change as an abstraction, but now this no-longer happens. To ensure that changes to loro containers are properly handled in `@pluv/react`, make sure to commit your changes whenever possible:
 
-  For `@pluv/crdt-loro` specifically, `@pluv/client` relies on [loro events and subscriptions](https://www.loro.dev/docs/tutorial/get_started#event) to detect changes. The `AbstractLoroCrdt` types previously called `Loro.commit` after each change as an abstraction, but now this no-longer happens. To ensure that changes to loro containers are properly handled in `@pluv/react`, make sure to commit your changes whenever possible:
+    ```ts
+    // Before
 
-  ```ts
-  // Before
+    const [data, container] = useStorage("messages");
 
-  const [data, container] = useStorage("messages");
+    // This automatically called Loro.commit under the hood and rerendered the page with updated data.
+    container.push(loro.object({ name: "John Doe", age: 35 }));
+    ```
 
-  // This automatically called Loro.commit under the hood and rerendered the page with updated data.
-  container.push(loro.object({ name: "John Doe", age: 35 }));
-  ```
+    ```ts
+    // Now
 
-  ```ts
-  // Now
+    const [data, container] = useStorage("messages");
 
-  const [data, container] = useStorage("messages");
+    const doc = useDoc();
+    const transact = useTransact();
 
-  const doc = useDoc();
-  const transact = useTransact();
+    // Updates need to be committed back to the doc whenever the changes need to be emitted to other users
+    // The returned data also will not update until the changes are commited
 
-  // Updates need to be committed back to the doc whenever the changes need to be emitted to other users
-  // The returned data also will not update until the changes are commited
+    // The two operations below are functionally equivalent
+    transact(() => {
+        container.push(loro.object({ name: "John Doe", age: 35 }));
+    });
 
-  // The two operations below are functionally equivalent
-  transact(() => {
     container.push(loro.object({ name: "John Doe", age: 35 }));
-  });
-
-  container.push(loro.object({ name: "John Doe", age: 35 }));
-  doc.value.commit();
-  ```
+    doc.value.commit();
+    ```
 
 ### Patch Changes
 
 - Updated dependencies [9492085]
-  - @pluv/crdt@0.20.0
-  - @pluv/types@0.20.0
+    - @pluv/crdt@0.20.0
+    - @pluv/types@0.20.0
 
 ## 0.19.0
 
@@ -830,8 +838,8 @@
 ### Patch Changes
 
 - Updated dependencies [99b5ca9]
-  - @pluv/types@0.18.0
-  - @pluv/crdt@0.18.0
+    - @pluv/types@0.18.0
+    - @pluv/crdt@0.18.0
 
 ## 0.17.3
 
@@ -859,8 +867,8 @@
 ### Patch Changes
 
 - Updated dependencies [507bc00]
-  - @pluv/types@0.17.0
-  - @pluv/crdt@0.17.0
+    - @pluv/types@0.17.0
+    - @pluv/crdt@0.17.0
 
 ## 0.16.3
 
@@ -919,7 +927,7 @@
 ### Patch Changes
 
 - da9f600: Upgraded dependencies
-  - @pluv/types@0.12.3
+    - @pluv/types@0.12.3
 
 ## 0.12.2
 
@@ -939,233 +947,232 @@
 
 - 436040b: Added ability to undo and redo changes to storage.
 
-  ## @pluv/crdt-yjs
+    ## @pluv/crdt-yjs
+
+    `@pluv/crdt-yjs` now exposes 5 new methods: `canRedo`, `canUndo`, `redo`, `undo` and `trackOrigins`.
+
+    Refer to the code-example below to better understand how to undo and redo with your doc.
+
+    ```ts
+    // Example
+    import { array, doc } from "@pluv/crdt-yjs";
+
+    // Create your doc with your shared-types
+    const myDoc = doc({
+        messages: array<string>([]),
+    });
+
+    /**
+     * @description Track origins to enable undos and redos for your document.
+     * trackOrigins must be called before any storage mutations, to enable those
+     * mutations to be undone/redone.
+     */
+    myDoc.trackOrigins({
+        /**
+         * @description This is the same `captureTimeout` option from yjs's UndoManager.
+         * This specifies a number in ms, during which edits are merged together to be
+         * undone together. Set this to 0, to track each transacted change individually.
+         * @see (@link https://docs.yjs.dev/api/undo-manager)
+         * @default 500
+         */
+        captureTimeout: 500,
+        /**
+         * @desription This is the same `trackedOrigins` option from yjs's UndoManager.
+         * This specifies transaction origins (strings only) to filter which transactions
+         * can be undone.
+         * @see (@link https://docs.yjs.dev/api/undo-manager)
+         * @default undefined
+         */
+        trackedOrigins: ["user-123"],
+    });
+
+    /**
+     * @description Check whether calling undo will mutate storage
+     * @returns boolean
+     */
+    myDoc.canUndo();
+    /**
+     * @description Check whether calling redo will mutate storage
+     * @returns boolean
+     */
+    myDoc.canRedo();
+
+    // Perform a storage mutation within a transaction so that it can be affected
+    // by undo/redo operations.
+    myDoc.transact(() => {
+        myDoc.get("messages").push(["hello world!"]);
+    }, "user-123");
 
-  `@pluv/crdt-yjs` now exposes 5 new methods: `canRedo`, `canUndo`, `redo`, `undo` and `trackOrigins`.
+    /**
+     * @description Undoes the last valid mutation to storage
+     */
+    myDoc.undo();
 
-  Refer to the code-example below to better understand how to undo and redo with your doc.
+    /**
+     * @description Re-applies the last undone mutation to storage
+     */
+    myDoc.redo();
+    ```
+
+    ## @pluv/client
 
-  ```ts
-  // Example
-  import { array, doc } from "@pluv/crdt-yjs";
+    `@pluv/client`'s `PluvRoom` and `MockedRoom` now exposes 5 new methods: `canRedo`, `canUndo`, `redo`, `undo` and `transact`.
+
+    Refer to the code-example below to better understand how to undo and redo with your `PluvRoom`.
+
+    ```ts
+    import { createClient, y } from "@pluv/client";
 
-  // Create your doc with your shared-types
-  const myDoc = doc({
-    messages: array<string>([]),
-  });
+    const client = createClient({});
 
-  /**
-   * @description Track origins to enable undos and redos for your document.
-   * trackOrigins must be called before any storage mutations, to enable those
-   * mutations to be undone/redone.
-   */
-  myDoc.trackOrigins({
     /**
-     * @description This is the same `captureTimeout` option from yjs's UndoManager.
-     * This specifies a number in ms, during which edits are merged together to be
-     * undone together. Set this to 0, to track each transacted change individually.
-     * @see (@link https://docs.yjs.dev/api/undo-manager)
-     * @default 500
+     * @description When a room is created, undo/redo will automatically
+     * be configured to filter for changes made by the connected user
+     * (so that users only undo/redo their changes).
      */
-    captureTimeout: 500,
+    const room = client.createRoom("my-room", {
+        initialStorage: () => ({
+            messages: y.array<string>([]),
+        }),
+        /**
+         * @description This is the same `captureTimeout` option from yjs's UndoManager.
+         * This specifies a number in ms, during which edits are merged together to be
+         * undone together. Set this to 0, to track each transacted change individually.
+         * @see (@link https://docs.yjs.dev/api/undo-manager)
+         * @default 500
+         */
+        captureTimeout: 500,
+        /**
+         * @desription This is the same `trackedOrigins` option from yjs's UndoManager.
+         * This specifies transaction origins (strings only) to filter which transactions
+         * can be undone.
+         * When omitted, the user's connection id will be tracked. When provided,
+         * specifies additional tracked origins besides the user's connection id.
+         * @see (@link https://docs.yjs.dev/api/undo-manager)
+         * @default undefined
+         */
+        trackedOrigins: ["user-123"],
+    });
+
     /**
-     * @desription This is the same `trackedOrigins` option from yjs's UndoManager.
-     * This specifies transaction origins (strings only) to filter which transactions
-     * can be undone.
-     * @see (@link https://docs.yjs.dev/api/undo-manager)
-     * @default undefined
+     * @description Check whether calling undo will mutate storage
+     * @returns boolean
      */
-    trackedOrigins: ["user-123"],
-  });
-
-  /**
-   * @description Check whether calling undo will mutate storage
-   * @returns boolean
-   */
-  myDoc.canUndo();
-  /**
-   * @description Check whether calling redo will mutate storage
-   * @returns boolean
-   */
-  myDoc.canRedo();
-
-  // Perform a storage mutation within a transaction so that it can be affected
-  // by undo/redo operations.
-  myDoc.transact(() => {
-    myDoc.get("messages").push(["hello world!"]);
-  }, "user-123");
-
-  /**
-   * @description Undoes the last valid mutation to storage
-   */
-  myDoc.undo();
-
-  /**
-   * @description Re-applies the last undone mutation to storage
-   */
-  myDoc.redo();
-  ```
-
-  ## @pluv/client
-
-  `@pluv/client`'s `PluvRoom` and `MockedRoom` now exposes 5 new methods: `canRedo`, `canUndo`, `redo`, `undo` and `transact`.
-
-  Refer to the code-example below to better understand how to undo and redo with your `PluvRoom`.
-
-  ```ts
-  import { createClient, y } from "@pluv/client";
-
-  const client = createClient({});
-
-  /**
-   * @description When a room is created, undo/redo will automatically
-   * be configured to filter for changes made by the connected user
-   * (so that users only undo/redo their changes).
-   */
-  const room = client.createRoom("my-room", {
-    initialStorage: () => ({
-      messages: y.array<string>([]),
-    }),
+    room.canUndo();
     /**
-     * @description This is the same `captureTimeout` option from yjs's UndoManager.
-     * This specifies a number in ms, during which edits are merged together to be
-     * undone together. Set this to 0, to track each transacted change individually.
-     * @see (@link https://docs.yjs.dev/api/undo-manager)
-     * @default 500
+     * @description Check whether calling redo will mutate storage
+     * @returns boolean
      */
-    captureTimeout: 500,
+    room.canRedo();
+
     /**
-     * @desription This is the same `trackedOrigins` option from yjs's UndoManager.
-     * This specifies transaction origins (strings only) to filter which transactions
-     * can be undone.
-     * When omitted, the user's connection id will be tracked. When provided,
-     * specifies additional tracked origins besides the user's connection id.
-     * @see (@link https://docs.yjs.dev/api/undo-manager)
-     * @default undefined
+     * @description Calling transact will enable a storage mutation to be undone/redone.
+     * When called without an origin, the origin will default to the user's connection
+     * id.
+     *
+     * You can specify a 2nd parameter to transact with a different transaction origin.
      */
-    trackedOrigins: ["user-123"],
-  });
-
-  /**
-   * @description Check whether calling undo will mutate storage
-   * @returns boolean
-   */
-  room.canUndo();
-  /**
-   * @description Check whether calling redo will mutate storage
-   * @returns boolean
-   */
-  room.canRedo();
-
-  /**
-   * @description Calling transact will enable a storage mutation to be undone/redone.
-   * When called without an origin, the origin will default to the user's connection
-   * id.
-   *
-   * You can specify a 2nd parameter to transact with a different transaction origin.
-   */
-  room.transact(() => {
-    room.get("messages").push(["hello world!"]);
-  });
-
-  // This will also be undoable because `"user-123"` is a tracked origin.
-  room.transact(() => {
-    room.get("messages").push(["hello world!"]);
-  }, "user-123");
-
-  /**
-   * @description Undoes the last valid mutation to storage
-   */
-  room.undo();
-
-  /**
-   * @description Re-applies the last undone mutation to storage
-   */
-  room.redo();
-  ```
-
-  ## @pluv/react
-
-  `@pluv/react`'s `createRoomBundle` now exposes 5 new react hooks: `useCanRedo`, `useCanUndo`, `useRedo`, `useUndo` and `useTransact`.
-
-  Refer to the code-example below to better understand how to undo and redo with your `createRoomBundle`.
-
-  ```tsx
-  import { createBundle, createClient, y } from "@pluv/react";
-  import { type io } from "./io";
-
-  const client = createClient<typeof io>();
-
-  const { createRoomBundle } = createBundle(client);
-
-  const { useCanRedo, useCanUndo, useRedo, useStorage, useTransact, useUndo } =
-    createRoomBundle({
-      initialStorage: () => ({
-        messages: y.array<string>([]),
-      }),
-      /**
-       * @description This is the same `captureTimeout` option from yjs's UndoManager.
-       * This specifies a number in ms, during which edits are merged together to be
-       * undone together. Set this to 0, to track each transacted change individually.
-       * @see (@link https://docs.yjs.dev/api/undo-manager)
-       * @default 500
-       */
-      captureTimeout: 500,
-      /**
-       * @desription This is the same `trackedOrigins` option from yjs's UndoManager.
-       * This specifies transaction origins (strings only) to filter which transactions
-       * can be undone.
-       * When omitted, the user's connection id will be tracked. When provided,
-       * specifies additional tracked origins besides the user's connection id.
-       * @see (@link https://docs.yjs.dev/api/undo-manager)
-       * @default undefined
-       */
-      trackedOrigins: ["user-123"],
+    room.transact(() => {
+        room.get("messages").push(["hello world!"]);
     });
 
-  /**
-   * @description Check whether calling undo will mutate storage
-   */
-  const canUndo: boolean = useCanUndo();
-  /**
-   * @description Check whether calling redo will mutate storage
-   */
-  const canRedo: boolean = useCanRedo();
+    // This will also be undoable because `"user-123"` is a tracked origin.
+    room.transact(() => {
+        room.get("messages").push(["hello world!"]);
+    }, "user-123");
 
-  const [messages, sharedType] = useStorage("messages");
+    /**
+     * @description Undoes the last valid mutation to storage
+     */
+    room.undo();
 
-  /**
-   * @description Calling transact will enable a storage mutation to be undone/redone.
-   * When called without an origin, the origin will default to the user's connection
-   * id.
-   *
-   * You can specify a 2nd parameter to transact with a different transaction origin.
-   */
-  const transact = useTransact();
+    /**
+     * @description Re-applies the last undone mutation to storage
+     */
+    room.redo();
+    ```
 
-  transact(() => {
-    sharedType.push(["hello world!"]);
-  });
+    ## @pluv/react
+
+    `@pluv/react`'s `createRoomBundle` now exposes 5 new react hooks: `useCanRedo`, `useCanUndo`, `useRedo`, `useUndo` and `useTransact`.
+
+    Refer to the code-example below to better understand how to undo and redo with your `createRoomBundle`.
+
+    ```tsx
+    import { createBundle, createClient, y } from "@pluv/react";
+    import { type io } from "./io";
+
+    const client = createClient<typeof io>();
+
+    const { createRoomBundle } = createBundle(client);
+
+    const { useCanRedo, useCanUndo, useRedo, useStorage, useTransact, useUndo } = createRoomBundle({
+        initialStorage: () => ({
+            messages: y.array<string>([]),
+        }),
+        /**
+         * @description This is the same `captureTimeout` option from yjs's UndoManager.
+         * This specifies a number in ms, during which edits are merged together to be
+         * undone together. Set this to 0, to track each transacted change individually.
+         * @see (@link https://docs.yjs.dev/api/undo-manager)
+         * @default 500
+         */
+        captureTimeout: 500,
+        /**
+         * @desription This is the same `trackedOrigins` option from yjs's UndoManager.
+         * This specifies transaction origins (strings only) to filter which transactions
+         * can be undone.
+         * When omitted, the user's connection id will be tracked. When provided,
+         * specifies additional tracked origins besides the user's connection id.
+         * @see (@link https://docs.yjs.dev/api/undo-manager)
+         * @default undefined
+         */
+        trackedOrigins: ["user-123"],
+    });
 
-  // This will also be undoable because `"user-123"` is a tracked origin.
-  transact(() => {
-    sharedType.push(["hello world!"]);
-  }, "user-123");
+    /**
+     * @description Check whether calling undo will mutate storage
+     */
+    const canUndo: boolean = useCanUndo();
+    /**
+     * @description Check whether calling redo will mutate storage
+     */
+    const canRedo: boolean = useCanRedo();
+
+    const [messages, sharedType] = useStorage("messages");
+
+    /**
+     * @description Calling transact will enable a storage mutation to be undone/redone.
+     * When called without an origin, the origin will default to the user's connection
+     * id.
+     *
+     * You can specify a 2nd parameter to transact with a different transaction origin.
+     */
+    const transact = useTransact();
+
+    transact(() => {
+        sharedType.push(["hello world!"]);
+    });
+
+    // This will also be undoable because `"user-123"` is a tracked origin.
+    transact(() => {
+        sharedType.push(["hello world!"]);
+    }, "user-123");
 
-  /**
-   * @description Undoes the last valid mutation to storage
-   */
-  const undo = useUndo();
+    /**
+     * @description Undoes the last valid mutation to storage
+     */
+    const undo = useUndo();
 
-  undo();
+    undo();
 
-  /**
-   * @description Re-applies the last undone mutation to storage
-   */
-  const redo = useRedo();
+    /**
+     * @description Re-applies the last undone mutation to storage
+     */
+    const redo = useRedo();
 
-  redo();
-  ```
+    redo();
+    ```
 
 ### Patch Changes
 
@@ -1176,7 +1183,7 @@
 ### Patch Changes
 
 - 74b3061: Bumped minor and patch dependencies.
-  - @pluv/types@0.11.1
+    - @pluv/types@0.11.1
 
 ## 0.11.0
 
@@ -1202,7 +1209,7 @@
 
 - 885835d: remove unnecessary dependency
 - Updated dependencies [885835d]
-  - @pluv/types@0.10.1
+    - @pluv/types@0.10.1
 
 ## 0.10.0
 
@@ -1213,7 +1220,7 @@
 ### Patch Changes
 
 - Updated dependencies [f43f1cc]
-  - @pluv/types@0.10.0
+    - @pluv/types@0.10.0
 
 ## 0.4.2
 
@@ -1221,18 +1228,18 @@
 
 - f4317ba: \* Renamed type `unstable_YObjectValue` to `YObjectValue`;
 
-  - Renamed type `unstable_YObject` to `YObject`.
-  - Re-exported `xmlElement`, `xmlFragment` and `xmlText` from `@pluv/client`.
+    - Renamed type `unstable_YObject` to `YObject`.
+    - Re-exported `xmlElement`, `xmlFragment` and `xmlText` from `@pluv/client`.
 
-    ```ts
-    import { y } from "@pluv/client";
-    // or
-    import { y } from "@pluv/react";
+        ```ts
+        import { y } from "@pluv/client";
+        // or
+        import { y } from "@pluv/react";
 
-    y.xmlElement("MyElement", {});
-    y.xmlFragment({});
-    y.xmlText("hello world");
-    ```
+        y.xmlElement("MyElement", {});
+        y.xmlFragment({});
+        y.xmlText("hello world");
+        ```
 
 ## 0.4.1
 
@@ -1242,7 +1249,7 @@
 - 8997c65: bumped dependencies
 - Updated dependencies [8fba48b]
 - Updated dependencies [8997c65]
-  - @pluv/types@0.2.2
+    - @pluv/types@0.2.2
 
 ## 0.4.0
 
@@ -1250,54 +1257,54 @@
 
 - 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:
+    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
-  ```
+    ```
+    npm install @pluv/addon-indexeddb
+    ```
 
-  To use this new addon, simply pass it to options when creating a room:
+    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";
+    ```ts
+    import { addonIndexedDB } from "@pluv/addon-indexeddb";
+    import { createClient } from "@pluv/client";
 
-  const client = createClient({
-    // ...
-  });
+    const client = createClient({
+        // ...
+    });
 
-  const room = client.createRoom("my-new-room", {
-    addons: [
-      // Define your addons in an array like so
-      addonIndexedDB(),
-    ],
-  });
-  ```
+    const room = client.createRoom("my-new-room", {
+        addons: [
+            // Define your addons in an array like so
+            addonIndexedDB(),
+        ],
+    });
+    ```
 
-  Or when using `@pluv/react`:
+    Or when using `@pluv/react`:
 
-  ```ts
-  const PluvRoom = createRoomBundle({
-    // ...
-    addons: [
-      // Define your addons in an array like so
-      addonIndexedDB(),
-    ],
-  });
-  ```
+    ```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
+    - @pluv/types@0.2.1
 
 ## 0.3.8
 
 ### Patch Changes
 
 - b85a232: bumped dependencies
-  - @pluv/types@0.2.0
+    - @pluv/types@0.2.0
 
 ## 0.3.7
 
@@ -1308,7 +1315,7 @@
 - Updated dependencies [0dd847e]
 - Updated dependencies [bb2886b]
 - Updated dependencies [ae679a8]
-  - @pluv/types@0.2.0
+    - @pluv/types@0.2.0
 
 ## 0.3.6
 
@@ -1322,7 +1329,7 @@
 
 - 850626e: bumped dependencies
 - Updated dependencies [850626e]
-  - @pluv/types@0.1.6
+    - @pluv/types@0.1.6
 
 ## 0.3.4
 
@@ -1336,7 +1343,7 @@
 
 - 74870ee: bumped dependencies
 - Updated dependencies [74870ee]
-  - @pluv/types@0.1.5
+    - @pluv/types@0.1.5
 
 ## 0.3.2
 
@@ -1349,7 +1356,7 @@
 - Updated dependencies [9516a4e]
 - Updated dependencies [7b6da1c]
 - Updated dependencies [e9c1514]
-  - @pluv/types@0.1.4
+    - @pluv/types@0.1.4
 
 ## 0.3.1
 
@@ -1357,7 +1364,7 @@
 
 - 161e00e: fixed links to other pluv packages in readmes
 - f6c0e65: bumped dependencies
-  - @pluv/types@0.1.3
+    - @pluv/types@0.1.3
 
 ## 0.3.0
 
@@ -1374,7 +1381,7 @@
 - Updated dependencies [8bf62cb]
 - Updated dependencies [7e52685]
 - Updated dependencies [8e97fb2]
-  - @pluv/types@0.1.3
+    - @pluv/types@0.1.3
 
 ## 0.2.0
 
@@ -1392,7 +1399,7 @@
 
 - fe80d7b: added preview disclaimer about breaking changes in the readme
 - Updated dependencies [fe80d7b]
-  - @pluv/types@0.1.2
+    - @pluv/types@0.1.2
 
 ## 0.1.2
 
@@ -1406,7 +1413,7 @@
 
 - 24016e6: Updated dependencies
 - Updated dependencies [24016e6]
-  - @pluv/types@0.1.1
+    - @pluv/types@0.1.1
 
 ## 0.1.0
 
@@ -1417,4 +1424,4 @@
 ### Patch Changes
 
 - Updated dependencies [a22f525]
-  - @pluv/types@0.1.0
+    - @pluv/types@0.1.0

package/dist/index.d.mts

@@ -30,7 +30,7 @@ type AwarenessPresence<TPresence extends Record<string, any>, TField extends key
 declare const array: <T extends unknown>(value?: T[] | readonly T[]) => YjsType<Array<T>, T[]>;
 
 interface PluvYjsAwarenessParams<TIO extends IOLike<any>, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<any, any>>, TEvents extends PluvRouterEventConfig, TField extends keyof TPresence | null = null> {
-    field?: TField;
+    presenceField?: TField;
     room: RoomLike<TIO, Doc, TPresence, TStorage, TEvents>;
 }
 declare class PluvYjsAwareness<TIO extends IOLike, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<any, any>>, TEvents extends PluvRouterEventConfig, TField extends keyof TPresence | null = null> extends ObservableV2<{
@@ -130,7 +130,7 @@ declare const map: <T extends unknown>(value?: readonly (readonly [key: string,
 declare const object: <T extends Record<string, any>>(value?: T) => YjsType<Map$1<T[keyof T]>, T>;
 
 interface PluvYjsProviderParams<TIO extends IOLike<any>, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<any, any>>, TEvents extends PluvRouterEventConfig, TField extends keyof TPresence | null = null> {
-    field?: TField;
+    presenceField?: TField;
     room: RoomLike<TIO, Doc, TPresence, TStorage, TEvents>;
 }
 /**

package/dist/index.d.ts

@@ -30,7 +30,7 @@ type AwarenessPresence<TPresence extends Record<string, any>, TField extends key
 declare const array: <T extends unknown>(value?: T[] | readonly T[]) => YjsType<Array<T>, T[]>;
 
 interface PluvYjsAwarenessParams<TIO extends IOLike<any>, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<any, any>>, TEvents extends PluvRouterEventConfig, TField extends keyof TPresence | null = null> {
-    field?: TField;
+    presenceField?: TField;
     room: RoomLike<TIO, Doc, TPresence, TStorage, TEvents>;
 }
 declare class PluvYjsAwareness<TIO extends IOLike, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<any, any>>, TEvents extends PluvRouterEventConfig, TField extends keyof TPresence | null = null> extends ObservableV2<{
@@ -130,7 +130,7 @@ declare const map: <T extends unknown>(value?: readonly (readonly [key: string,
 declare const object: <T extends Record<string, any>>(value?: T) => YjsType<Map$1<T[keyof T]>, T>;
 
 interface PluvYjsProviderParams<TIO extends IOLike<any>, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<any, any>>, TEvents extends PluvRouterEventConfig, TField extends keyof TPresence | null = null> {
-    field?: TField;
+    presenceField?: TField;
     room: RoomLike<TIO, Doc, TPresence, TStorage, TEvents>;
 }
 /**

package/dist/index.js

@@ -97,10 +97,10 @@ var PluvYjsAwareness = class extends import_observable.ObservableV2 {
      */
     this.meta = /* @__PURE__ */ new Map();
     this._checkInterval = 0;
-    const { field, room } = params;
+    const { presenceField, room } = params;
     this.doc = room.getDoc().value;
     this._room = room;
-    if (!!field) this._field = field;
+    if (!!presenceField) this._field = presenceField;
     const myPresence = this._room.getMyPresence();
     const myMeta = (myPresence == null ? void 0 : myPresence[PLUV_PRESENCE_META_KEY]) || {};
     this._room.updateMyPresence({
@@ -609,8 +609,8 @@ var PluvYjsProvider = class extends import_observable2.ObservableV2 {
   constructor(params) {
     super();
     this._synced = false;
-    const { field, room } = params;
-    this.awareness = awareness({ field, room });
+    const { presenceField, room } = params;
+    this.awareness = awareness({ presenceField, room });
     this.doc = room.getDoc().value;
     this._room = room;
     const subscriptions = [

package/dist/index.mjs

@@ -78,10 +78,10 @@ var PluvYjsAwareness = class extends ObservableV2 {
      */
     this.meta = /* @__PURE__ */ new Map();
     this._checkInterval = 0;
-    const { field, room } = params;
+    const { presenceField, room } = params;
     this.doc = room.getDoc().value;
     this._room = room;
-    if (!!field) this._field = field;
+    if (!!presenceField) this._field = presenceField;
     const myPresence = this._room.getMyPresence();
     const myMeta = (myPresence == null ? void 0 : myPresence[PLUV_PRESENCE_META_KEY]) || {};
     this._room.updateMyPresence({
@@ -604,8 +604,8 @@ var PluvYjsProvider = class extends ObservableV22 {
   constructor(params) {
     super();
     this._synced = false;
-    const { field, room } = params;
-    this.awareness = awareness({ field, room });
+    const { presenceField, room } = params;
+    this.awareness = awareness({ presenceField, room });
     this.doc = room.getDoc().value;
     this._room = room;
     const subscriptions = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/crdt-yjs",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "description": "yjs for @pluv/io",
   "author": "leedavidcs",
   "license": "MIT",
@@ -20,19 +20,19 @@
     "@types/node": "^22.15.18",
     "js-base64": "^3.7.7",
     "lib0": "^0.2.108",
-    "@pluv/crdt": "^2.2.1",
-    "@pluv/types": "^2.2.1"
+    "@pluv/crdt": "^2.2.2",
+    "@pluv/types": "^2.2.2"
   },
   "peerDependencies": {
     "yjs": "^13.0.0"
   },
   "devDependencies": {
-    "eslint": "^9.26.0",
-    "tsup": "^8.4.0",
+    "eslint": "^9.27.0",
+    "tsup": "^8.5.0",
     "typescript": "^5.8.3",
     "yjs": "^13.6.27",
-    "@pluv/tsconfig": "^2.2.1",
-    "eslint-config-pluv": "^2.2.1"
+    "@pluv/tsconfig": "^2.2.2",
+    "eslint-config-pluv": "^2.2.2"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/awareness/PluvYjsAwareness.ts

@@ -18,7 +18,7 @@ export interface PluvYjsAwarenessParams<
     TEvents extends PluvRouterEventConfig,
     TField extends keyof TPresence | null = null,
 > {
-    field?: TField;
+    presenceField?: TField;
     room: RoomLike<TIO, YDoc, TPresence, TStorage, TEvents>;
 }
 
@@ -51,12 +51,12 @@ export class PluvYjsAwareness<
     constructor(params: PluvYjsAwarenessParams<TIO, TPresence, TStorage, TEvents, TField>) {
         super();
 
-        const { field, room } = params;
+        const { presenceField, room } = params;
 
         this.doc = room.getDoc().value;
         this._room = room;
 
-        if (!!field) this._field = field;
+        if (!!presenceField) this._field = presenceField;
 
         const myPresence: any = this._room.getMyPresence();
         const myMeta = myPresence?.[PLUV_PRESENCE_META_KEY] || {};

package/src/provider/PluvYjsProvider.ts

@@ -13,7 +13,7 @@ export interface PluvYjsProviderParams<
     TEvents extends PluvRouterEventConfig,
     TField extends keyof TPresence | null = null,
 > {
-    field?: TField;
+    presenceField?: TField;
     room: RoomLike<TIO, YDoc, TPresence, TStorage, TEvents>;
 }
 
@@ -53,9 +53,9 @@ export class PluvYjsProvider<
     constructor(params: PluvYjsProviderParams<TIO, TPresence, TStorage, TEvents, TField>) {
         super();
 
-        const { field, room } = params;
+        const { presenceField, room } = params;
 
-        this.awareness = awareness({ field, room });
+        this.awareness = awareness({ presenceField, room });
         this.doc = room.getDoc().value;
 
         this._room = room;