jazz-tools 0.13.19 → 0.13.21

package/dist/coValues/account.d.ts

@@ -96,7 +96,7 @@ export declare class Account extends CoValueBase implements CoValue {
      */
     waitForSync(options?: {
         timeout?: number;
-    }): Promise<unknown[]>;
+    }): Promise<void>;
     /**
      * Wait for all the available `CoValues` to be uploaded to the other peers.
      *
@@ -104,7 +104,7 @@ export declare class Account extends CoValueBase implements CoValue {
      */
     waitForAllCoValuesSync(options?: {
         timeout?: number;
-    }): Promise<unknown[][]>;
+    }): Promise<void[]>;
 }
 export declare const AccountAndGroupProxyHandler: ProxyHandler<Account | Group>;
 /** @category Identity & Permissions */

package/dist/coValues/coFeed.d.ts

@@ -211,7 +211,7 @@ export declare class CoFeed<Item = any> extends CoValueBase implements CoValue {
      */
     waitForSync(options?: {
         timeout?: number;
-    }): Promise<unknown[]>;
+    }): Promise<void>;
 }
 /**
  * The proxy handler for `CoFeed` instances
@@ -362,6 +362,6 @@ export declare class FileStream extends CoValueBase implements CoValue {
      */
     waitForSync(options?: {
         timeout?: number;
-    }): Promise<unknown[]>;
+    }): Promise<void>;
 }
 //# sourceMappingURL=coFeed.d.ts.map

package/dist/coValues/coList.d.ts

@@ -238,6 +238,6 @@ export declare class CoList<Item = any> extends Array<Item> implements CoValue {
      */
     waitForSync(options?: {
         timeout?: number;
-    }): Promise<unknown[]>;
+    }): Promise<void>;
 }
 //# sourceMappingURL=coList.d.ts.map

package/dist/coValues/coMap.d.ts

@@ -268,7 +268,7 @@ export declare class CoMap extends CoValueBase implements CoValue {
              */
             waitForSync(options?: {
                 timeout?: number;
-            }): Promise<unknown[]>;
+            }): Promise<void>;
             [inspect](): any;
             _instanceID: string;
             readonly _owner: Account | Group;
@@ -468,7 +468,7 @@ export declare class CoMap extends CoValueBase implements CoValue {
      */
     waitForSync(options?: {
         timeout?: number;
-    }): Promise<unknown[]>;
+    }): Promise<void>;
 }
 export type CoKeys<Map extends object> = Exclude<keyof Map & string, keyof CoMap>;
 /**

package/dist/coValues/coPlainText.d.ts

@@ -10,15 +10,30 @@ export declare class CoPlainText extends String implements CoValue {
     _raw: RawCoPlainText;
     get _owner(): Account | Group;
     get _loadedAs(): Account | AnonymousJazzAgent;
+    /** @internal */
     constructor(options: {
         fromRaw: RawCoPlainText;
     } | {
         text: string;
         owner: Account | Group;
-    });
-    static create<T extends CoPlainText>(this: CoValueClass<T>, text: string, options: {
+    } | undefined);
+    /**
+     * Create a new `CoPlainText` with the given text and owner.
+     *
+     * The owner (a Group or Account) determines access rights to the CoPlainText.
+     *
+     * The CoPlainText will immediately be persisted and synced to connected peers.
+     *
+     * @example
+     * ```ts
+     * const text = CoPlainText.create("Hello, world!", { owner: me });
+     * ```
+     *
+     * @category Creation
+     */
+    static create<T extends CoPlainText>(this: CoValueClass<T>, text: string, options?: {
         owner: Account | Group;
-    }): T;
+    } | Account | Group): T;
     get length(): number;
     toString(): string;
     valueOf(): string;
@@ -74,5 +89,16 @@ export declare class CoPlainText extends String implements CoValue {
      * @category Subscription & Loading
      **/
     subscribe<T extends CoPlainText>(this: T, listener: (value: Resolved<T, true>, unsubscribe: () => void) => void): () => void;
+    /**
+     * Allow CoPlainText to behave like a primitive string in most contexts (e.g.,
+     * string concatenation, template literals, React rendering, etc.) by implementing
+     * Symbol.toPrimitive. This eliminates the need to call .toString() explicitly.
+     *
+     * The 'hint' parameter indicates the preferred type of conversion:
+     * - 'string': prefer string conversion
+     * - 'number': prefer number conversion (not meaningful for text, so return NaN)
+     * - 'default': usually treat as string
+     */
+    [Symbol.toPrimitive](hint: string): string | number;
 }
 //# sourceMappingURL=coPlainText.d.ts.map

package/dist/coValues/coPlainText.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"coPlainText.d.ts","sourceRoot":"","sources":["../../src/coValues/coPlainText.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,IAAI,EAET,KAAK,cAAc,EAEpB,MAAM,QAAQ,CAAC;AAEhB,OAAO,EACL,kBAAkB,EAClB,OAAO,EACP,YAAY,EACZ,EAAE,EACF,QAAQ,EACR,wBAAwB,EAEzB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,OAAO,EAKR,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAGnC,MAAM,MAAM,OAAO,GAAG,IAAI,CAAC;AAE3B,qBAAa,WAAY,SAAQ,MAAO,YAAW,OAAO;IAChD,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IACb,KAAK,EAAE,aAAa,CAAC;IACrB,IAAI,EAAE,cAAc,CAAC;IAE7B,IAAI,MAAM,IAAI,OAAO,GAAG,KAAK,CAI5B;IAED,IAAI,SAAS,iCAUZ;gBAGC,OAAO,EACH;QAAE,OAAO,EAAE,cAAc,CAAA;KAAE,GAC3B;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,OAAO,GAAG,KAAK,CAAA;KAAE;IAmB9C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,WAAW,EACjC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE;QAAE,KAAK,EAAE,OAAO,GAAG,KAAK,CAAA;KAAE;IAKrC,IAAI,MAAM,WAET;IAED,QAAQ;IAIR,OAAO;IAIP,MAAM,IAAI,MAAM;IAIhB,CAAC,OAAO,CAAC;IAIT,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAItC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAIrC,WAAW,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE;IAI/C,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAI3C,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAI1C,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAI3C,QAAQ,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAI1C,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,WAAW,EAClC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,WAAW,EAC1C,GAAG,EAAE,cAAc;IAKrB;;;;OAIG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM;IAYvB;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,WAAW,EAC/B,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EACT,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAA;KAAE,GAClD,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAkBpB;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,WAAW,EACpC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EACT,QAAQ,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,WAAW,EAAE,MAAM,IAAI,KAAK,IAAI,GACpE,MAAM,IAAI;IACb,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,WAAW,EACpC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EACT,OAAO,EAAE,IAAI,CAAC,wBAAwB,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,SAAS,CAAC,EAC3D,QAAQ,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,WAAW,EAAE,MAAM,IAAI,KAAK,IAAI,GACpE,MAAM,IAAI;IAUb;;;;;;;;QAQI;IACJ,SAAS,CAAC,CAAC,SAAS,WAAW,EAC7B,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,WAAW,EAAE,MAAM,IAAI,KAAK,IAAI,GACpE,MAAM,IAAI;CAGd"}
+{"version":3,"file":"coPlainText.d.ts","sourceRoot":"","sources":["../../src/coValues/coPlainText.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,IAAI,EAET,KAAK,cAAc,EAEpB,MAAM,QAAQ,CAAC;AAEhB,OAAO,EACL,kBAAkB,EAClB,OAAO,EACP,YAAY,EACZ,EAAE,EACF,QAAQ,EACR,wBAAwB,EAGzB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,OAAO,EAKR,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAGnC,MAAM,MAAM,OAAO,GAAG,IAAI,CAAC;AAE3B,qBAAa,WAAY,SAAQ,MAAO,YAAW,OAAO;IAChD,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IACb,KAAK,EAAE,aAAa,CAAC;IACrB,IAAI,EAAE,cAAc,CAAC;IAE7B,IAAI,MAAM,IAAI,OAAO,GAAG,KAAK,CAI5B;IAED,IAAI,SAAS,iCAUZ;IAED,gBAAgB;gBAEd,OAAO,EACH;QAAE,OAAO,EAAE,cAAc,CAAA;KAAE,GAC3B;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,OAAO,GAAG,KAAK,CAAA;KAAE,GACxC,SAAS;IAgCf;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,WAAW,EACjC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QAAE,KAAK,EAAE,OAAO,GAAG,KAAK,CAAA;KAAE,GAAG,OAAO,GAAG,KAAK;IAMxD,IAAI,MAAM,WAET;IAED,QAAQ;IAIR,OAAO;IAIP,MAAM,IAAI,MAAM;IAIhB,CAAC,OAAO,CAAC;IAIT,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAItC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAIrC,WAAW,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE;IAI/C,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAI3C,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAI1C,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAI3C,QAAQ,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAI1C,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,WAAW,EAClC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,WAAW,EAC1C,GAAG,EAAE,cAAc;IAKrB;;;;OAIG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM;IAYvB;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,WAAW,EAC/B,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EACT,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAA;KAAE,GAClD,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAkBpB;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,WAAW,EACpC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EACT,QAAQ,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,WAAW,EAAE,MAAM,IAAI,KAAK,IAAI,GACpE,MAAM,IAAI;IACb,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,WAAW,EACpC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EACT,OAAO,EAAE,IAAI,CAAC,wBAAwB,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,SAAS,CAAC,EAC3D,QAAQ,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,WAAW,EAAE,MAAM,IAAI,KAAK,IAAI,GACpE,MAAM,IAAI;IAUb;;;;;;;;QAQI;IACJ,SAAS,CAAC,CAAC,SAAS,WAAW,EAC7B,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,WAAW,EAAE,MAAM,IAAI,KAAK,IAAI,GACpE,MAAM,IAAI;IAIb;;;;;;;;;OASG;IACH,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,MAAM;CAQlC"}

package/dist/coValues/group.d.ts

@@ -68,7 +68,7 @@ export declare class Group extends CoValueBase implements CoValue {
      */
     waitForSync(options?: {
         timeout?: number;
-    }): Promise<unknown[]>;
+    }): Promise<void>;
 }
 export declare function isAccountID(id: RawAccountID | AgentID): id is RawAccountID;
 //# sourceMappingURL=group.d.ts.map

package/dist/index.js

@@ -34,7 +34,7 @@ import {
   parseInviteLink,
   randomSessionProvider,
   subscribeToCoValue
-} from "./chunk-4HBHY4I7.js";
+} from "./chunk-S4BCSDTJ.js";
 
 // src/index.ts
 import { MAX_RECOMMENDED_TX_SIZE, cojsonInternals } from "cojson";

package/dist/testing.js

@@ -5,7 +5,7 @@ import {
   createAnonymousJazzContext,
   createJazzContext,
   randomSessionProvider
-} from "./chunk-4HBHY4I7.js";
+} from "./chunk-S4BCSDTJ.js";
 
 // src/testing.ts
 import { LocalNode } from "cojson";

package/package.json

@@ -17,11 +17,11 @@
   },
   "type": "module",
   "license": "MIT",
-  "version": "0.13.19",
+  "version": "0.13.21",
   "dependencies": {
     "@scure/bip39": "^1.3.0",
     "fast-myers-diff": "^3.2.0",
-    "cojson": "0.13.18"
+    "cojson": "0.13.21"
   },
   "devDependencies": {
     "tsup": "8.3.5",

package/src/coValues/coPlainText.ts

@@ -14,6 +14,7 @@ import {
   Resolved,
   SubscribeListenerOptions,
   SubscribeRestArgs,
+  parseCoValueCreateOptions,
 } from "../internal.js";
 import {
   inspect,
@@ -52,34 +53,64 @@ export class CoPlainText extends String implements CoValue {
     return new AnonymousJazzAgent(this._raw.core.node);
   }
 
+  /** @internal */
   constructor(
     options:
       | { fromRaw: RawCoPlainText }
-      | { text: string; owner: Account | Group },
+      | { text: string; owner: Account | Group }
+      | undefined,
   ) {
-    super("fromRaw" in options ? options.fromRaw.toString() : options.text);
-
-    let raw;
+    if (!options) {
+      super(""); // Intialise as empty string
+      return;
+    }
 
     if ("fromRaw" in options) {
-      raw = options.fromRaw;
-    } else {
-      raw = options.owner._raw.createPlainText(options.text);
+      super(options.fromRaw.toString());
+      const raw = options.fromRaw;
+      Object.defineProperties(this, {
+        id: { value: raw.id, enumerable: false },
+        _type: { value: "CoPlainText", enumerable: false },
+        _raw: { value: raw, enumerable: false },
+      });
+      return;
     }
 
-    Object.defineProperties(this, {
-      id: { value: raw.id, enumerable: false },
-      _type: { value: "CoPlainText", enumerable: false },
-      _raw: { value: raw, enumerable: false },
-    });
+    if ("text" in options && "owner" in options) {
+      super(options.text);
+      const raw = options.owner._raw.createPlainText(options.text);
+      Object.defineProperties(this, {
+        id: { value: raw.id, enumerable: false },
+        _type: { value: "CoPlainText", enumerable: false },
+        _raw: { value: raw, enumerable: false },
+      });
+      return;
+    }
+
+    throw new Error("Invalid constructor arguments");
   }
 
+  /**
+   * Create a new `CoPlainText` with the given text and owner.
+   *
+   * The owner (a Group or Account) determines access rights to the CoPlainText.
+   *
+   * The CoPlainText will immediately be persisted and synced to connected peers.
+   *
+   * @example
+   * ```ts
+   * const text = CoPlainText.create("Hello, world!", { owner: me });
+   * ```
+   *
+   * @category Creation
+   */
   static create<T extends CoPlainText>(
     this: CoValueClass<T>,
     text: string,
-    options: { owner: Account | Group },
+    options?: { owner: Account | Group } | Account | Group,
   ) {
-    return new this({ text, owner: options.owner });
+    const { owner } = parseCoValueCreateOptions(options);
+    return new this({ text, owner });
   }
 
   get length() {
@@ -229,4 +260,23 @@ export class CoPlainText extends String implements CoValue {
   ): () => void {
     return subscribeToExistingCoValue(this, {}, listener);
   }
+
+  /**
+   * Allow CoPlainText to behave like a primitive string in most contexts (e.g.,
+   * string concatenation, template literals, React rendering, etc.) by implementing
+   * Symbol.toPrimitive. This eliminates the need to call .toString() explicitly.
+   *
+   * The 'hint' parameter indicates the preferred type of conversion:
+   * - 'string': prefer string conversion
+   * - 'number': prefer number conversion (not meaningful for text, so return NaN)
+   * - 'default': usually treat as string
+   */
+  [Symbol.toPrimitive](hint: string) {
+    if (hint === "number") {
+      // Not meaningful for text, but required for completeness
+      return Number(this._raw.toString());
+    }
+    // For 'string' and 'default', return the string representation
+    return this._raw.toString();
+  }
 }

package/src/tests/coPlainText.test.ts

@@ -25,6 +25,56 @@ describe("CoPlainText", () => {
     return { me, text };
   };
 
+  describe("Creation", () => {
+    test("should allow `create`", async () => {
+      const me = await Account.create({
+        creationProps: { name: "Hermes Puggington" },
+        crypto: Crypto,
+      });
+      const text = CoPlainText.create("hello world", me);
+      expect(text._owner.id).toBe(me.id);
+    });
+
+    test("should allow `new CoPlainText`", async () => {
+      const me = await Account.create({
+        creationProps: { name: "Hermes Puggington" },
+        crypto: Crypto,
+      });
+      const text = new CoPlainText({ text: "hello world", owner: me });
+      expect(text._owner.id).toBe(me.id);
+    });
+
+    test("should allow `create` from raw", async () => {
+      const me = await Account.create({
+        creationProps: { name: "Hermes Puggington" },
+        crypto: Crypto,
+      });
+      const text = CoPlainText.create("hello world", me);
+      const raw = text._raw;
+      const text2 = CoPlainText.fromRaw(raw);
+      expect(text2._owner.id).toBe(me.id);
+    });
+
+    test("should allow creation of new instance from raw", async () => {
+      const me = await Account.create({
+        creationProps: { name: "Hermes Puggington" },
+        crypto: Crypto,
+      });
+      const raw = me._raw.createPlainText("hello world");
+      const text = new CoPlainText({ fromRaw: raw });
+      expect(text._owner.id).toBe(me.id);
+    });
+
+    test("should allow owner shorthand", async () => {
+      const me = await Account.create({
+        creationProps: { name: "Hermes Puggington" },
+        crypto: Crypto,
+      });
+      const text = CoPlainText.create("hello world", me);
+      expect(text._owner.id).toBe(me.id);
+    });
+  });
+
   describe("Simple CoPlainText operations", async () => {
     const { me, text } = await initNodeAndText();
 
@@ -63,6 +113,26 @@ describe("CoPlainText", () => {
         expect(text.length).toBe(11);
       });
 
+      test("as string", () => {
+        const text = CoPlainText.create("hello world", { owner: me });
+        expect(`${text}`).toBe("hello world");
+      });
+
+      test("as number", () => {
+        const text = CoPlainText.create("hello world", { owner: me });
+        expect(Number(text)).toBe(NaN);
+      });
+
+      test("as number", () => {
+        const text = CoPlainText.create("123", { owner: me });
+        expect(Number(text)).toBe(123);
+      });
+
+      test("toJSON", () => {
+        const text = CoPlainText.create("hello world", { owner: me });
+        expect(text.toJSON()).toBe("hello world");
+      });
+
       test("toString", () => {
         const text = CoPlainText.create("hello world", { owner: me });
         expect(text.toString()).toBe("hello world");