Runtime validation

.changeset/runtime-validation-improvements.md

@@ -0,0 +1,5 @@
+---
+"jazz-tools": patch
+---
+
+Introduced runtime validation for schema-based CoValues. All mutations now accept a `validation` option of `strict` or `loose`. `setDefaultValidationMode()` can also be used to enable or disable validation across the entire app. Currently, the default validation mode is `warn`: updates and inserts of invalid data will still be allowed, but a console warning will be issued. The usage of `setDefaultValidationMode("strict")` is encouraged, as it will be the default mode in the future.

.changeset/smooth-lions-joke.md

@@ -0,0 +1,5 @@
+---
+"jazz-tools": patch
+---
+
+Removed the legacy `coField` and `Encoders` exports and completed the runtime schema migration to the new schema descriptors. Apps still using the old schema APIs should migrate to the current `co`/zod based schemas.

examples/chat-rn-expo/src/schema.ts

@@ -1,4 +1,6 @@
-import { co, z } from "jazz-tools";
+import { co, z, setDefaultValidationMode } from "jazz-tools";
+
+setDefaultValidationMode("strict");
 
 export const Message = co.map({
   text: co.plainText(),

examples/chat-rn/src/schema.ts

@@ -1,4 +1,6 @@
-import { co } from "jazz-tools";
+import { co, setDefaultValidationMode } from "jazz-tools";
+
+setDefaultValidationMode("strict");
 
 export const Message = co.map({
   text: co.plainText(),

examples/chat/src/schema.ts

@@ -1,4 +1,6 @@
-import { co } from "jazz-tools";
+import { co, setDefaultValidationMode } from "jazz-tools";
+
+setDefaultValidationMode("strict");
 
 export const Message = co
   .map({

examples/form/src/schema.ts

@@ -1,4 +1,6 @@
-import { co, z } from "jazz-tools";
+import { co, z, setDefaultValidationMode } from "jazz-tools";
+
+setDefaultValidationMode("strict");
 
 export const BubbleTeaAddOnTypes = [
   "Pearl",

examples/inspector/tests/lib/data.ts

@@ -1,4 +1,10 @@
-import { FileStream, ImageDefinition, co, z } from "jazz-tools";
+import {
+  FileStream,
+  ImageDefinition,
+  co,
+  z,
+  setDefaultValidationMode,
+} from "jazz-tools";
 import {
   Issue,
   Organization,
@@ -7,6 +13,8 @@ import {
   ReactionsList,
 } from "./schema";
 
+setDefaultValidationMode("strict");
+
 const projectsData: {
   name: string;
   description: string;
@@ -73,7 +81,9 @@ export const createFile = () => {
 
 export const createImage = () => {
   return ImageDefinition.create({
+    original: FileStream.create(),
     originalSize: [1920, 1080],
+    progressive: false,
     placeholderDataURL: "data:image/jpeg;base64,...",
   });
 };
@@ -82,6 +92,8 @@ export const createOrganization = () => {
   return Organization.create({
     name: "Garden Computing",
     image: ImageDefinition.create({
+      original: FileStream.create(),
+      progressive: false,
       originalSize: [1920, 1080],
       placeholderDataURL: "data:image/jpeg;base64,...",
     }),

examples/jazz-nextjs/src/schema.ts

@@ -1,4 +1,6 @@
-import { co, Group, Loaded, z } from "jazz-tools";
+import { co, Group, Loaded, z, setDefaultValidationMode } from "jazz-tools";
+
+setDefaultValidationMode("strict");
 
 export const TodoProfile = co
   .profile({

examples/multi-cursors/src/schema.ts

@@ -1,6 +1,8 @@
-import { co, z } from "jazz-tools";
+import { co, z, setDefaultValidationMode } from "jazz-tools";
 import { Camera, Cursor } from "./types";
 
+setDefaultValidationMode("strict");
+
 export const CursorFeed = co.feed(Cursor);
 export type CursorFeed = co.loaded<typeof CursorFeed>;
 

examples/music-player/src/1_schema.ts

@@ -1,4 +1,11 @@
-import { co, z, setDefaultSchemaPermissions } from "jazz-tools";
+import {
+  co,
+  z,
+  setDefaultSchemaPermissions,
+  setDefaultValidationMode,
+} from "jazz-tools";
+
+setDefaultValidationMode("strict");
 
 setDefaultSchemaPermissions({
   onInlineCreate: "sameAsContainer",

examples/organization/src/schema.ts

@@ -1,6 +1,8 @@
-import { co, z } from "jazz-tools";
+import { co, z, setDefaultValidationMode } from "jazz-tools";
 import { getRandomUsername } from "./util";
 
+setDefaultValidationMode("strict");
+
 export const Project = co
   .map({
     name: z.string(),

examples/passkey-rn/src/schema.ts

@@ -1,4 +1,6 @@
-import { co } from "jazz-tools";
+import { co, setDefaultValidationMode } from "jazz-tools";
+
+setDefaultValidationMode("strict");
 
 /**
  * Simple note schema to demonstrate Jazz functionality with passkey auth.

examples/todo/src/1_schema.ts

@@ -1,4 +1,6 @@
-import { co, z } from "jazz-tools";
+import { co, z, setDefaultValidationMode } from "jazz-tools";
+
+setDefaultValidationMode("strict");
 
 /** Walkthrough: Defining the data model with CoJSON
  *

examples/vector-search/src/schema.ts

@@ -1,4 +1,6 @@
-import { co, z } from "jazz-tools";
+import { co, z, setDefaultValidationMode } from "jazz-tools";
+
+setDefaultValidationMode("strict");
 
 export const JazzProfile = co.profile();
 

homepage/homepage/content/docs/core-concepts/covalues/overview.mdx

@@ -56,6 +56,10 @@ Jazz will automatically create the CoValues for you.
 ```
 </CodeGroup>
 
+<Alert variant="warning" className="flex gap-2 items-center my-4">
+Starting from Jazz 0.20.10, it is possible to opt in to run-time schema validation on writes. This will ensure that only data which conforms to the defined schema can be inserted into the CoValue. This helps to enforce data integrity and improve the type-safety of your application. The validation strategy is currently warn by default: updates and inserts of invalid data will still be allowed, but will give a console warning. This can be changed using the setDefaultValidationMode(), which accepts `strict` (throw if invalid),  `warn` (warn if invalid) and `loose` (allow invalid), as options.
+</Alert>
+
 <Alert variant="info" className="flex gap-2 items-center my-4">
 To learn more about how permissions work when creating nested CoValues with plain JSON objects,
 refer to [Ownership on inline CoValue creation](/docs/permissions-and-sharing/cascading-permissions#ownership-on-inline-covalue-creation).

packages/jazz-tools/src/better-auth/database-adapter/repository/generic.ts

@@ -70,9 +70,15 @@ export class JazzRepository {
 
     if (!uniqueId) {
       // Use the same owner of the table.
-      const node = schema.create(data, {
-        owner: list.$jazz.owner,
-      });
+      const node = schema.create(
+        {
+          ...data,
+          _deleted: false,
+        },
+        {
+          owner: list.$jazz.owner,
+        },
+      );
 
       list.$jazz.push(node);
 

packages/jazz-tools/src/better-auth/database-adapter/repository/session.ts

@@ -66,10 +66,16 @@ export class SessionRepository extends JazzRepository {
       },
     });
 
-    const session = this.getSchema("session").create(data, {
-      unique: data.token,
-      owner: this.owner,
-    });
+    const session = this.getSchema("session").create(
+      {
+        ...data,
+        _deleted: false,
+      },
+      {
+        unique: data.token,
+        owner: this.owner,
+      },
+    );
 
     sessions.$jazz.push(session);
 

packages/jazz-tools/src/better-auth/database-adapter/repository/user.ts

@@ -31,7 +31,14 @@ export class UserRepository extends JazzRepository {
       throw new Error("Email already exists");
     }
 
-    const user = await super.create(model, data, uniqueId);
+    const user = await super.create(
+      model,
+      {
+        sessions: [],
+        ...data,
+      },
+      uniqueId,
+    );
 
     await this.updateEmailIndex(userEmail, user.$jazz.id);
 

packages/jazz-tools/src/better-auth/database-adapter/tests/index.test.ts

@@ -286,7 +286,7 @@ describe("JazzBetterAuthDatabaseAdapter tests", async () => {
 
       expect(
         handleSyncMessageSpy.mock.calls.filter(([msg]) => msg.id === user.id),
-      ).toHaveLength(3);
+      ).toHaveLength(2);
     });
 
     it("should return the new entity with date objects", async () => {

packages/jazz-tools/src/better-auth/database-adapter/tests/repository/user.test.ts

@@ -348,47 +348,6 @@ describe("UserRepository", () => {
       expect(newEmailUsers[0]?.$jazz.id).toBe(user.$jazz.id);
     });
 
-    it("should update user email to null and remove from email index", async () => {
-      const userRepository = new UserRepository(
-        databaseSchema,
-        databaseRoot,
-        worker,
-      );
-
-      const user = await userRepository.create("user", {
-        email: "test@example.com",
-        name: "Test User",
-      });
-
-      // Update email to null
-      const updatedUsers = await userRepository.update(
-        "user",
-        [
-          {
-            field: "id",
-            operator: "eq",
-            value: user.$jazz.id,
-            connector: "AND",
-          },
-        ],
-        { email: null },
-      );
-
-      expect(updatedUsers.length).toBe(1);
-      expect(updatedUsers[0]?.email).toBe(null);
-
-      // Verify email is no longer findable
-      const emailUsers = await userRepository.findMany("user", [
-        {
-          field: "email",
-          operator: "eq",
-          value: "test@example.com",
-          connector: "AND",
-        },
-      ]);
-      expect(emailUsers.length).toBe(0);
-    });
-
     it("should handle update with no matching users", async () => {
       const userRepository = new UserRepository(
         databaseSchema,
@@ -565,20 +524,6 @@ describe("UserRepository", () => {
         name: "Test User",
       });
 
-      // First set email to null
-      await userRepository.update(
-        "user",
-        [
-          {
-            field: "id",
-            operator: "eq",
-            value: user.$jazz.id,
-            connector: "AND",
-          },
-        ],
-        { email: null },
-      );
-
       // Then delete the user
       const deletedCount = await userRepository.deleteValue("user", [
         { field: "id", operator: "eq", value: user.$jazz.id, connector: "AND" },

packages/jazz-tools/src/browser/tests/createInviteLink.test.ts

@@ -1,4 +1,4 @@
-import { CoMap, co, coField, z } from "jazz-tools";
+import { co, z } from "jazz-tools";
 import { expect, test } from "vitest";
 import { createInviteLink } from "../index.js";
 import { setupTwoNodes } from "./utils.js";

packages/jazz-tools/src/react-core/tests/useCoState.test.ts

@@ -593,7 +593,7 @@ describe("useCoState", () => {
 
   it("should immediately load deeploaded data when available locally", async () => {
     const Message = co.map({
-      content: CoRichText,
+      content: co.richText(),
     });
     const Messages = co.list(Message);
     const Thread = co.map({

packages/jazz-tools/src/react/tests/useAcceptInvite.test.ts

@@ -1,6 +1,6 @@
 // @vitest-environment happy-dom
 
-import { CoMap, Group, ID, co, coField, z } from "jazz-tools";
+import { Group, co, z } from "jazz-tools";
 import { assertLoaded } from "jazz-tools/testing";
 import { describe, expect, it } from "vitest";
 import { createInviteLink, useAcceptInvite } from "../index.js";