jazz-tools 0.17.14 → 0.18.1

package/src/svelte/tests/media/image.svelte.test.ts

@@ -3,6 +3,7 @@ import { FileStream, ImageDefinition } from "jazz-tools";
 import { createJazzTestAccount } from "jazz-tools/testing";
 import { describe, expect, it, vi } from "vitest";
 import Image from "../../media/image.svelte";
+import type { ImageProps } from "../../media/image.types.js";
 import { render, screen, waitFor } from "../testUtils";
 
 describe("Image", async () => {
@@ -10,7 +11,8 @@ describe("Image", async () => {
     isCurrentActiveAccount: true,
   });
 
-  const renderWithAccount = (props: any) => render(Image, props, { account });
+  const renderWithAccount = (props: ImageProps) =>
+    render(Image, props, { account });
 
   describe("initial rendering", () => {
     it("should render nothing if coValue is not found", async () => {
@@ -28,7 +30,7 @@ describe("Image", async () => {
     });
 
     it("should render an empty image if the image is not loaded yet", async () => {
-      const original = FileStream.create({ owner: account._owner });
+      const original = FileStream.create({ owner: account.$jazz.owner });
       original.start({ mimeType: "image/jpeg" });
       // Don't end original, so it has no chunks
 
@@ -44,7 +46,7 @@ describe("Image", async () => {
       );
 
       const { container } = renderWithAccount({
-        imageId: im.id,
+        imageId: im.$jazz.id,
         alt: "test",
       });
 
@@ -60,7 +62,7 @@ describe("Image", async () => {
       const placeholderDataUrl =
         "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=";
 
-      const original = FileStream.create({ owner: account._owner });
+      const original = FileStream.create({ owner: account.$jazz.owner });
       original.start({ mimeType: "image/jpeg" });
       // Don't end original, so it has no chunks
 
@@ -77,7 +79,7 @@ describe("Image", async () => {
       );
 
       const { container } = renderWithAccount({
-        imageId: im.id,
+        imageId: im.$jazz.id,
         alt: "test",
       });
 
@@ -108,7 +110,7 @@ describe("Image", async () => {
       );
 
       renderWithAccount({
-        imageId: im.id,
+        imageId: im.$jazz.id,
         alt: "test-loading",
       });
 
@@ -136,7 +138,7 @@ describe("Image", async () => {
       );
 
       const { container } = renderWithAccount({
-        imageId: im.id,
+        imageId: im.$jazz.id,
         alt: "test",
       });
 
@@ -159,7 +161,7 @@ describe("Image", async () => {
       );
 
       const { container } = renderWithAccount({
-        imageId: im.id,
+        imageId: im.$jazz.id,
         alt: "test",
         width: "original",
         height: "original",
@@ -184,7 +186,7 @@ describe("Image", async () => {
       );
 
       const { container } = renderWithAccount({
-        imageId: im.id,
+        imageId: im.$jazz.id,
         alt: "test",
         width: "original",
         height: 300,
@@ -209,7 +211,7 @@ describe("Image", async () => {
       );
 
       const { container } = renderWithAccount({
-        imageId: im.id,
+        imageId: im.$jazz.id,
         alt: "test",
         width: 50,
       });
@@ -233,7 +235,7 @@ describe("Image", async () => {
       );
 
       const { container } = renderWithAccount({
-        imageId: im.id,
+        imageId: im.$jazz.id,
         alt: "test",
         height: 50,
       });
@@ -257,7 +259,7 @@ describe("Image", async () => {
       );
 
       const { container } = renderWithAccount({
-        imageId: im.id,
+        imageId: im.$jazz.id,
         alt: "test",
         class: "test-class",
       });
@@ -292,11 +294,11 @@ describe("Image", async () => {
         },
       );
 
-      im["500x500"] = original;
-      im["256x256"] = await createDummyFileStream(256, account);
+      im.$jazz.set("500x500", original);
+      im.$jazz.set("256x256", await createDummyFileStream(256, account));
 
       const { container } = renderWithAccount({
-        imageId: im.id,
+        imageId: im.$jazz.id,
         alt: "test-progressive",
         width: 300,
       });
@@ -333,11 +335,11 @@ describe("Image", async () => {
         },
       );
 
-      im["1920x1080"] = original;
-      im["256x256"] = await createDummyFileStream(256, account);
+      im.$jazz.set("1920x1080", original);
+      im.$jazz.set("256x256", await createDummyFileStream(256, account));
 
       const { container } = renderWithAccount({
-        imageId: im.id,
+        imageId: im.$jazz.id,
         alt: "test-progressive",
         width: 1024,
       });
@@ -351,7 +353,7 @@ describe("Image", async () => {
       expect(createObjectURLSpy).toHaveBeenCalledTimes(1);
 
       // Load higher resolution image
-      im["1024x1024"] = await createDummyFileStream(1024, account);
+      im.$jazz.set("1024x1024", await createDummyFileStream(1024, account));
 
       await waitFor(() => {
         expect((container.querySelector("img") as HTMLImageElement).src).toBe(
@@ -387,12 +389,12 @@ describe("Image", async () => {
         },
       );
 
-      im["100x100"] = original;
-      im["256x256"] = await createDummyFileStream(256, account);
-      im["1024x1024"] = await createDummyFileStream(1024, account);
+      im.$jazz.set("100x100", original);
+      im.$jazz.set("256x256", await createDummyFileStream(256, account));
+      im.$jazz.set("1024x1024", await createDummyFileStream(1024, account));
 
       const { container } = renderWithAccount({
-        imageId: im.id,
+        imageId: im.$jazz.id,
         alt: "test-progressive",
         width: 256,
       });
@@ -428,11 +430,11 @@ describe("Image", async () => {
         },
       );
 
-      im["100x100"] = original;
-      im["256x256"] = await createDummyFileStream(256, account);
+      im.$jazz.set("100x100", original);
+      im.$jazz.set("256x256", await createDummyFileStream(256, account));
 
       const { container } = renderWithAccount({
-        imageId: im.id,
+        imageId: im.$jazz.id,
         alt: "test-progressive",
         width: 100,
       });
@@ -467,11 +469,11 @@ describe("Image", async () => {
           owner: account,
         },
       );
-      im["256x256"] = original;
-      im["1024x1024"] = await createDummyFileStream(1024, account);
+      im.$jazz.set("256x256", original);
+      im.$jazz.set("1024x1024", await createDummyFileStream(1024, account));
 
       const { container, rerender } = renderWithAccount({
-        imageId: im.id,
+        imageId: im.$jazz.id,
         alt: "test-dynamic",
         width: 256,
         height: 256,
@@ -486,7 +488,7 @@ describe("Image", async () => {
       expect(createObjectURLSpy).toHaveBeenCalledTimes(1);
 
       rerender({
-        imageId: im.id,
+        imageId: im.$jazz.id,
         alt: "test-dynamic",
         width: 1024,
         height: 1024,
@@ -516,7 +518,7 @@ describe("Image", async () => {
       );
 
       const { container } = renderWithAccount({
-        imageId: im.id,
+        imageId: im.$jazz.id,
         alt: "test",
         loading: "lazy",
       });
@@ -548,7 +550,7 @@ describe("Image", async () => {
       );
 
       const { container } = renderWithAccount({
-        imageId: im.id,
+        imageId: im.$jazz.id,
         alt: "test",
         loading: "lazy",
       });

package/src/tools/auth/DemoAuth.ts

@@ -64,13 +64,13 @@ export class DemoAuth {
       throw new Error("No credentials found");
     }
 
-    const currentAccount = await Account.getMe().ensureLoaded({
+    const currentAccount = await Account.getMe().$jazz.ensureLoaded({
       resolve: {
         profile: true,
       },
     });
 
-    currentAccount.profile.name = username;
+    currentAccount.profile.$jazz.set("name", username);
 
     await this.authSecretStorage.set({
       accountID: credentials.accountID,

package/src/tools/auth/PassphraseAuth.ts

@@ -82,13 +82,13 @@ export class PassphraseAuth {
     });
 
     if (name?.trim()) {
-      const currentAccount = await Account.getMe().ensureLoaded({
+      const currentAccount = await Account.getMe().$jazz.ensureLoaded({
         resolve: {
           profile: true,
         },
       });
 
-      currentAccount.profile.name = name;
+      currentAccount.profile.$jazz.set("name", name);
     }
 
     return passphrase;

package/src/tools/auth/clerk/index.ts

@@ -145,7 +145,7 @@ export class JazzClerkAuth {
       } satisfies ClerkCredentials,
     });
 
-    const currentAccount = await Account.getMe().ensureLoaded({
+    const currentAccount = await Account.getMe().$jazz.ensureLoaded({
       resolve: {
         profile: true,
       },
@@ -154,7 +154,7 @@ export class JazzClerkAuth {
     const username = getClerkUsername(clerkClient);
 
     if (username) {
-      currentAccount.profile.name = username;
+      currentAccount.profile.$jazz.set("name", username);
     }
 
     await JazzClerkAuth.loadClerkAuthData(

package/src/tools/auth/clerk/tests/JazzClerkAuth.test.ts

@@ -81,7 +81,7 @@ describe("JazzClerkAuth", () => {
         provider: "clerk",
       });
 
-      const me = await Account.getMe().ensureLoaded({
+      const me = await Account.getMe().$jazz.ensureLoaded({
         resolve: {
           profile: true,
         },

package/src/tools/coValues/CoFieldInit.ts

@@ -0,0 +1,20 @@
+import { CoFeed } from "./coFeed";
+import { CoList } from "./coList";
+import { CoMap, CoMapInit } from "./coMap";
+import { CoPlainText } from "./coPlainText";
+import { CoRichText } from "./coRichText";
+
+/**
+ * Returns the type of values that can be used to initialize a field of the provided type.
+ *
+ * For CoValue references, either a CoValue of the same type, or a plain JSON value that can be
+ * converted to the CoValue type are allowed.
+ */
+// Note: we don't define this type as V | ... because it prevents TS from inlining the type
+export type CoFieldInit<V> = V extends CoMap
+  ? V | CoMapInit<V>
+  : V extends CoList<infer T> | CoFeed<infer T>
+    ? V | ReadonlyArray<CoFieldInit<T>>
+    : V extends CoPlainText | CoRichText
+      ? V | string
+      : V;

package/src/tools/coValues/CoValueBase.ts

@@ -1,4 +1,4 @@
-import { ControlledAccount, RawAccount, type RawCoValue } from "cojson";
+import { ControlledAccount, LocalNode, type RawCoValue } from "cojson";
 import { CoreCoValueSchema } from "../implementation/zodSchema/schemaTypes/CoValueSchema.js";
 import {
   AnonymousJazzAgent,
@@ -7,72 +7,33 @@ import {
   CoValueFromRaw,
   ID,
   RegisteredSchemas,
-  accessChildById,
   coValueClassFromCoValueClassOrSchema,
   coValuesCache,
   inspect,
-  isCoValueSchema,
 } from "../internal.js";
-import type {
-  Account,
+import {
   CoValueClassOrSchema,
   Group,
   InstanceOfSchemaCoValuesNullable,
+  TypeSym,
 } from "../internal.js";
 
 /** @internal */
+export abstract class CoValueBase implements CoValue {
+  declare [TypeSym]: string;
 
-export class CoValueBase implements CoValue {
-  declare id: ID<this>;
-  declare _type: string;
-  declare _raw: RawCoValue;
-  /** @category Internals */
-  declare _instanceID: string;
-
-  get _owner(): Account | Group {
-    const schema =
-      this._raw.group instanceof RawAccount
-        ? RegisteredSchemas["Account"]
-        : RegisteredSchemas["Group"];
-
-    return accessChildById(this, this._raw.group.id, {
-      ref: schema,
-      optional: false,
-    });
-  }
-
-  /** @private */
-  get _loadedAs() {
-    const agent = this._raw.core.node.getCurrentAgent();
-
-    if (agent instanceof ControlledAccount) {
-      return coValuesCache.get(agent.account, () =>
-        coValueClassFromCoValueClassOrSchema(
-          RegisteredSchemas["Account"],
-        ).fromRaw(agent.account),
-      );
-    }
-
-    return new AnonymousJazzAgent(this._raw.core.node);
-  }
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  constructor(..._args: any) {
-    Object.defineProperty(this, "_instanceID", {
-      value: `instance-${Math.random().toString(36).slice(2)}`,
-      enumerable: false,
-    });
-  }
+  declare abstract $jazz: CoValueJazzApi<this>;
 
   /** @category Internals */
   static fromRaw<V extends CoValue>(this: CoValueClass<V>, raw: RawCoValue): V {
     return new this({ fromRaw: raw });
   }
+
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   toJSON(): object | any[] | string {
     return {
-      id: this.id,
-      type: this._type,
+      id: this.$jazz.id,
+      type: this[TypeSym],
       error: "unknown CoValue class",
     };
   }
@@ -80,21 +41,40 @@ export class CoValueBase implements CoValue {
   [inspect]() {
     return this.toJSON();
   }
+}
+
+export abstract class CoValueJazzApi<V extends CoValue> {
+  /** @category Internals */
+  declare _instanceID: string;
 
-  /** @category Type Helpers */
-  castAs<S extends CoValueClassOrSchema>(
-    schema: S,
-  ): S extends CoValueClass
-    ? InstanceType<S>
-    : S extends CoreCoValueSchema
-      ? NonNullable<InstanceOfSchemaCoValuesNullable<S>>
-      : never {
-    const cl = isCoValueSchema(schema) ? schema.getCoValueClass() : schema;
+  constructor(private coValue: V) {
+    Object.defineProperty(this, "_instanceID", {
+      value: `instance-${Math.random().toString(36).slice(2)}`,
+      enumerable: false,
+    });
+  }
 
-    if (this.constructor === cl) {
-      return this as any;
+  abstract get id(): ID<V>;
+  abstract get raw(): RawCoValue;
+  abstract get owner(): Group | undefined;
+
+  /** @internal */
+  get localNode(): LocalNode {
+    return this.raw.core.node;
+  }
+
+  /** @private */
+  get loadedAs() {
+    const agent = this.localNode.getCurrentAgent();
+
+    if (agent instanceof ControlledAccount) {
+      return coValuesCache.get(agent.account, () =>
+        coValueClassFromCoValueClassOrSchema(
+          RegisteredSchemas["Account"],
+        ).fromRaw(agent.account),
+      );
     }
 
-    return (cl as unknown as CoValueFromRaw<CoValue>).fromRaw(this._raw) as any;
+    return new AnonymousJazzAgent(this.localNode);
   }
 }