Including schema in reader/editor

usewaypoint · Feb 15, 2024 · a046f43 · a046f43
1 parent 3a9e7c7
commit a046f43
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/src/builders/buildDocumentEditor.ts b/src/builders/buildDocumentEditor.ts
@@ -9,6 +9,7 @@ import buildBlockConfigurationByIdSchema from './buildBlockConfigurationByIdSche
 /**
  * @typedef {Object} DocumentEditor
  * @property DocumentEditorProvider - Entry point to the DocumentEditor
+ * @property DocumentConfigurationSchema - zod schema compatible with the value that DocumentReaderProvider expects
  * @property Block - Component to render a block given an id
  * @property useDocumentState - Hook that returns the current DocumentState and a setter
  * @property useBlockState - Hook that returns the Block value and setter given an id
@@ -50,6 +51,7 @@ export default function buildDocumentEditor<T extends BaseZodDictionary>(blocks:
   return {
     useDocumentState,
     useBlockState,
+    DocumentConfigurationSchema: schema,
     Block: ({ id }: { id: string }) => {
       const state = useBlockState(id);
       if (state === null || !state[0]) {

diff --git a/src/builders/buildDocumentReader.ts b/src/builders/buildDocumentReader.ts
@@ -9,6 +9,7 @@ import buildBlockConfigurationByIdSchema from './buildBlockConfigurationByIdSche
 /**
  * @typedef {Object} DocumentReader
  * @property DocumentReaderProvider - Entry point to the DocumentReader
+ * @property DocumentConfigurationSchema - zod schema compatible with the value that DocumentReaderProvider expects
  * @property Block - Component to render a block given an id
  * @property useDocument - Hook that returns the current Document
  * @property useBlock - Hook that returns the block given an id
@@ -38,6 +39,7 @@ export default function buildDocumentReader<T extends BaseZodDictionary>(blocks:
   return {
     useDocument,
     useBlock,
+    DocumentConfigurationSchema: schema,
     Block: ({ id }: { id: string }) => {
       const block = useBlock(id);
       if (!block) {