blocknote schema and import/export validation (#40)

* add import/export tests

* fix tests and markdown handling

* add strong validation of blocknote schema

* update README

* switch to strict zod objects

Author: ntietje1

README.md

@@ -12,6 +12,7 @@
 ![Yjs](https://img.shields.io/badge/Yjs-6EDB8F?style=for-the-badge)
 ![Better Auth](https://img.shields.io/badge/Better_Auth-1A1A2E?style=for-the-badge)
 ![Cloudflare Workers](https://img.shields.io/badge/Cloudflare_Workers-F38020?style=for-the-badge&logo=cloudflare&logoColor=white)
+![Zod](https://img.shields.io/badge/Zod-3E67B1?style=for-the-badge&logo=zod&logoColor=white)
 ![Vite](https://img.shields.io/badge/Vite-646CFF?style=for-the-badge&logo=vite&logoColor=white)
 
 A campaign management platform built for Dungeon Masters and their players. Organize your world, share what your players need to see, and keep your secrets safe — all in real time.
@@ -86,17 +87,18 @@ A campaign management platform built for Dungeon Masters and their players. Orga
 | **Canvases**    | ReactFlow, Yjs                                                                                   |
 | **Maps**        | React Zoom Pan Pinch                                                                             |
 | **Drag & Drop** | Atlaskit Pragmatic Drag and Drop                                                                 |
+| **Validation**  | Zod, Convex Validators                                                                           |
 | **Backend**     | Convex (real-time database, serverless functions, file storage)                                  |
 | **Auth**        | Better Auth (email/password, OAuth, 2FA)                                                         |
 | **Deployment**  | Cloudflare Workers (serverless edge)                                                             |
 | **Tooling**     | Vite+, Vitest, Playwright, React Compiler                                                        |
 
 ## Testing
 
-| Suite        | Runner                | Scope                                                                                                       |
-| ------------ | --------------------- | ----------------------------------------------------------------------------------------------------------- |
-| **Backend**  | Vitest (edge-runtime) | 53 test files, 651 tests — mutations, queries, permissions, cascading deletes, sharing workflows, snapshots |
-| **Frontend** | Vitest (jsdom)        | 24 test files, 358 tests — components, hooks, stores, utilities                                             |
-| **E2E**      | Playwright (Chromium) | Full user flows — campaign creation, note editing, sharing, navigation                                      |
+| Suite        | Runner                | Scope                                                                                         |
+| ------------ | --------------------- | --------------------------------------------------------------------------------------------- |
+| **Backend**  | Vitest (edge-runtime) | 600+ tests — mutations, queries, permissions, cascading deletes, sharing workflows, snapshots |
+| **Frontend** | Vitest (jsdom)        | 300+ tests — components, hooks, stores, utilities                                             |
+| **E2E**      | Playwright (Chromium) | Full user flows — campaign creation, note editing, sharing, navigation                        |
 
 Backend and frontend suites run on every push via GitHub Actions. E2E tests run in CI and locally against a live app instance.

convex/_generated/api.d.ts

@@ -23,6 +23,7 @@ import type * as blockShares_functions_unshareBlocks from "../blockShares/functi
 import type * as blockShares_mutations from "../blockShares/mutations.js";
 import type * as blockShares_queries from "../blockShares/queries.js";
 import type * as blockShares_types from "../blockShares/types.js";
+import type * as blocks_blockNoteValidator from "../blocks/blockNoteValidator.js";
 import type * as blocks_functions_findBlockByBlockNoteId from "../blocks/functions/findBlockByBlockNoteId.js";
 import type * as blocks_functions_getBlockWithShares from "../blocks/functions/getBlockWithShares.js";
 import type * as blocks_functions_getBlocksWithShares from "../blocks/functions/getBlocksWithShares.js";
@@ -115,6 +116,7 @@ import type * as gameMaps_triggers from "../gameMaps/triggers.js";
 import type * as gameMaps_types from "../gameMaps/types.js";
 import type * as gameMaps_validation from "../gameMaps/validation.js";
 import type * as http from "../http.js";
+import type * as notes_blocknote from "../notes/blocknote.js";
 import type * as notes_editorSpecs from "../notes/editorSpecs.js";
 import type * as notes_functions_captureNoteSnapshot from "../notes/functions/captureNoteSnapshot.js";
 import type * as notes_functions_createNote from "../notes/functions/createNote.js";
@@ -234,6 +236,7 @@ declare const fullApi: ApiFromModules<{
   "blockShares/mutations": typeof blockShares_mutations;
   "blockShares/queries": typeof blockShares_queries;
   "blockShares/types": typeof blockShares_types;
+  "blocks/blockNoteValidator": typeof blocks_blockNoteValidator;
   "blocks/functions/findBlockByBlockNoteId": typeof blocks_functions_findBlockByBlockNoteId;
   "blocks/functions/getBlockWithShares": typeof blocks_functions_getBlockWithShares;
   "blocks/functions/getBlocksWithShares": typeof blocks_functions_getBlocksWithShares;
@@ -326,6 +329,7 @@ declare const fullApi: ApiFromModules<{
   "gameMaps/types": typeof gameMaps_types;
   "gameMaps/validation": typeof gameMaps_validation;
   http: typeof http;
+  "notes/blocknote": typeof notes_blocknote;
   "notes/editorSpecs": typeof notes_editorSpecs;
   "notes/functions/captureNoteSnapshot": typeof notes_functions_captureNoteSnapshot;
   "notes/functions/createNote": typeof notes_functions_createNote;

convex/_test/factories.helper.ts

@@ -8,9 +8,24 @@ import type schema from '../schema'
 import type { SidebarItemLocation, SidebarItemType } from '../sidebarItems/types/baseTypes'
 import type { PermissionLevel } from '../permissions/types'
 import type { ShareStatus } from '../blockShares/types'
+import type { CustomBlock } from '../notes/editorSpecs'
 
 type T = TestConvex<typeof schema>
 
+/** Create a test block content object typed as CustomBlock */
+export function testBlock(
+  id: string,
+  overrides?: Partial<{ type: string; props: Record<string, unknown>; content: Array<unknown> }>,
+): CustomBlock {
+  return {
+    id,
+    type: 'paragraph',
+    props: {},
+    content: [],
+    ...overrides,
+  } as CustomBlock
+}
+
 let counter = 0
 
 function nextId() {
@@ -341,7 +356,7 @@ export async function createBlock(
   overrides?: Partial<{
     blockId: string
     position: number | null
-    content: Record<string, unknown>
+    content: CustomBlock
     isTopLevel: boolean
     shareStatus: ShareStatus | null
     deletionTime: number | null
@@ -354,7 +369,7 @@ export async function createBlock(
     noteId: noteId,
     blockId: `block-${n}`,
     position: null,
-    content: { id: `block-${n}`, type: 'paragraph', content: [] },
+    content: testBlock(`block-${n}`),
     isTopLevel: true,
     campaignId,
     shareStatus,

convex/blockShares/__tests__/blockShares.test.ts

@@ -11,16 +11,13 @@ import {
   createBlockShare,
   createNote,
   createSidebarShare,
+  testBlock,
 } from '../../_test/factories.helper'
 import { expectPermissionDenied } from '../../_test/assertions.helper'
 import { api } from '../../_generated/api'
 import type { NoteWithContent } from '../../notes/types'
 
-const BLOCK_CONTENT = {
-  id: 'test-block-1',
-  type: 'paragraph' as const,
-  content: [],
-}
+const BLOCK_CONTENT = testBlock('test-block-1')
 
 describe('setBlocksShareStatus', () => {
   const t = createTestContext()

convex/blockShares/__tests__/blockSharingWorkflows.test.ts

@@ -1,7 +1,12 @@
 import { describe, expect, it } from 'vitest'
 import { createTestContext } from '../../_test/setup.helper'
 import { asDm, setupMultiPlayerContext } from '../../_test/identities.helper'
-import { createBlock, createNote, createSidebarShare } from '../../_test/factories.helper'
+import {
+  createBlock,
+  createNote,
+  createSidebarShare,
+  testBlock,
+} from '../../_test/factories.helper'
 import { api } from '../../_generated/api'
 
 describe('block sharing workflows', () => {
@@ -31,16 +36,8 @@ describe('block sharing workflows', () => {
         campaignMemberId: p2.memberId,
       })
 
-      const blockContent1 = {
-        id: block1.blockId,
-        type: 'paragraph' as const,
-        content: [],
-      }
-      const blockContent2 = {
-        id: block2.blockId,
-        type: 'paragraph' as const,
-        content: [],
-      }
+      const blockContent1 = testBlock(block1.blockId)
+      const blockContent2 = testBlock(block2.blockId)
 
       await dmAuth.mutation(api.blockShares.mutations.setBlocksShareStatus, {
         campaignId: ctx.campaignId,
@@ -131,11 +128,7 @@ describe('block sharing workflows', () => {
         campaignMemberId: p1.memberId,
       })
 
-      const blockContent = {
-        id: block.blockId,
-        type: 'paragraph' as const,
-        content: [],
-      }
+      const blockContent = testBlock(block.blockId)
 
       await dmAuth.mutation(api.blockShares.mutations.setBlocksShareStatus, {
         campaignId: ctx.campaignId,
@@ -248,11 +241,7 @@ describe('block sharing workflows', () => {
         campaignMemberId: p1.memberId,
       })
 
-      const blockContent = {
-        id: block.blockId,
-        type: 'paragraph' as const,
-        content: [],
-      }
+      const blockContent = testBlock(block.blockId)
 
       await dmAuth.mutation(api.blockShares.mutations.setBlocksShareStatus, {
         campaignId: ctx.campaignId,
@@ -308,11 +297,7 @@ describe('block sharing workflows', () => {
       const note = await createNote(t, ctx.campaignId, ctx.dm.profile._id)
       const block = await createBlock(t, note.noteId, ctx.campaignId, ctx.dm.profile._id)
 
-      const blockContent = {
-        id: block.blockId,
-        type: 'paragraph' as const,
-        content: [],
-      }
+      const blockContent = testBlock(block.blockId)
 
       await dmAuth.mutation(api.blockShares.mutations.setBlocksShareStatus, {
         campaignId: ctx.campaignId,

convex/blockShares/types.ts

@@ -1,5 +1,5 @@
-import type { CustomBlock } from '../notes/editorSpecs'
 import type { Id } from '../_generated/dataModel'
+import type { CustomBlock } from '../notes/editorSpecs'
 
 export type BlockShare = {
   _id: Id<'blockShares'>