@supernova-studio/client 0.2.2 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supernova-studio/client",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "Supernova Data Models",
   "source": "src/index.ts",
   "main": "dist/index.js",

package/src/docs-editor/blocks-to-prosemirror.ts

@@ -5,9 +5,9 @@ import {
   PageBlockText,
   PageBlockTextSpan,
   PageBlockTextSpanAttribute,
-  PageBlockItemRichTextPropertyValue,
+  PageBlockItemRichTextValue,
   PageBlockCalloutType,
-  PageBlockItemMultiRichTextPropertyValue,
+  PageBlockItemMultiRichTextValue,
 } from "@supernova-studio/model";
 import { PageBlockEditorModel } from "./model/block";
 import { ProsemirrorNode, ProsemirrorMark } from "./prosemirror/types";
@@ -30,11 +30,11 @@ type InputWithProperty = BaseInput & {
 };
 
 type RichTextInputWithValue = InputWithProperty & {
-  richTextPropertyValue: PageBlockItemRichTextPropertyValue;
+  richTextPropertyValue: PageBlockItemRichTextValue;
 };
 
 type MultiRichTextInputWithValue = InputWithProperty & {
-  multiRichTextPropertyValue: PageBlockItemMultiRichTextPropertyValue;
+  multiRichTextPropertyValue: PageBlockItemMultiRichTextValue;
 };
 
 //

package/src/docs-editor/prosemirror/types.ts

@@ -1,4 +1,4 @@
-import { PageBlockItemUntypedPropertyValue } from "@supernova-studio/model";
+import { PageBlockItemUntypedValue } from "@supernova-studio/model";
 
 export type ProsemirrorNode = {
   type: string;
@@ -15,5 +15,5 @@ export type ProsemirrorMark = {
 
 export type ProsemirrorBlockItem = {
   id: string;
-  props: Record<string, PageBlockItemUntypedPropertyValue>;
+  props: Record<string, PageBlockItemUntypedValue>;
 };

package/src/docs-editor/prosemirror-to-blocks.ts

@@ -7,13 +7,33 @@ import {
   PageBlockTextSpanAttribute,
   PageBlockDefinitionProperty,
   PageBlockCalloutType,
-  PageBlockItemRichTextPropertyValue,
-  PageBlockItemMultiRichTextPropertyValue,
-  PageBlockItemEmbedPropertyValue,
+  PageBlockItemEmbedValue,
   PageBlockItemV2,
-  PageBlockItemTextPropertyValue,
-  PageBlockItemUntypedPropertyValue,
+  PageBlockItemTextValue,
   PageBlockItemImageValue,
+  PageBlockItemRichTextValue,
+  PageBlockDefinitionPropertyType,
+  PageBlockItemMultiRichTextValue,
+  PageBlockItemBooleanValue,
+  PageBlockItemNumberValue,
+  PageBlockItemSingleSelectValue,
+  PageBlockItemMultiSelectValue,
+  PageBlockItemTokenValue,
+  PageBlockItemTokenTypeValue,
+  PageBlockItemTokenPropertyValue,
+  PageBlockItemComponentValue,
+  PageBlockItemComponentPropertyValue,
+  PageBlockItemAssetValue,
+  PageBlockItemAssetPropertyValue,
+  PageBlockItemUrlValue,
+  PageBlockItemMarkdownValue,
+  PageBlockItemCodeValue,
+  PageBlockItemSandboxValue,
+  PageBlockItemTableValue,
+  PageBlockItemDividerValue,
+  PageBlockItemStorybookValue,
+  PageBlockItemColorValue,
+  PageBlockItemUntypedValue,
 } from "@supernova-studio/model";
 import { PageBlockEditorModel } from "./model/block";
 import { DocumentationPageEditorModel } from "./model/page";
@@ -109,7 +129,7 @@ function parseAsRichText(
 
               // Optional
               ...(calloutType && { calloutType: calloutType }),
-            } satisfies PageBlockItemRichTextPropertyValue,
+            } satisfies PageBlockItemRichTextValue,
           },
         },
       ],
@@ -170,7 +190,7 @@ function parseAsMultiRichText(
                   return parseRichText(paragraph.content ?? []);
                 })
                 .filter(nonNullFilter),
-            } satisfies PageBlockItemMultiRichTextPropertyValue,
+            } satisfies PageBlockItemMultiRichTextValue,
           },
         },
       ],
@@ -256,7 +276,7 @@ function parseAsEmbed(
               value: url,
               caption: caption,
               height: height,
-            } as PageBlockItemEmbedPropertyValue,
+            } as PageBlockItemEmbedValue,
           },
         },
       ],
@@ -303,7 +323,7 @@ function parseAsCustomBlock(
     return null;
   }
 
-  const parsedItems = itemsJson.map(i => parseItem(i, definition));
+  const parsedItems = itemsJson.map(i => parseItem(i, definition)).filter(nonNullFilter);
 
   return {
     id: id,
@@ -324,33 +344,20 @@ function parseItem(rawItem: unknown, definition: PageBlockDefinition): PageBlock
     return null;
   }
 
-  const sanitizedProps: Record<string, PageBlockItemUntypedPropertyValue> = {};
+  const sanitizedProps: Record<string, PageBlockItemUntypedValue> = {};
 
   for (const property of definition.item.properties) {
     const value = parsedItem.data.props[property.id];
     if (!value) {
-      return null;
+      continue;
     }
 
-    // Validate
-    switch (property.type) {
-      case "Text":
-        PageBlockItemTextPropertyValue.parse(value);
-        break;
+    const valueSchema = valueSchemaForPropertyType(property.type);
+    const validationResult = valueSchema.safeParse(value);
 
-      case "EmbedURL":
-        PageBlockItemEmbedPropertyValue.parse(value);
-        break;
-
-      case "Image":
-        PageBlockItemImageValue.parse(value);
-        break;
-
-      default:
-        return null;
+    if (validationResult.success) {
+      sanitizedProps[property.id] = validationResult.data;
     }
-
-    sanitizedProps[property.id] = value;
   }
 
   return {
@@ -360,6 +367,59 @@ function parseItem(rawItem: unknown, definition: PageBlockDefinition): PageBlock
   };
 }
 
+function valueSchemaForPropertyType(type: PageBlockDefinitionPropertyType) {
+  switch (type) {
+    case "RichText":
+      return PageBlockItemRichTextValue;
+    case "MultiRichText":
+      return PageBlockItemMultiRichTextValue;
+    case "Text":
+      return PageBlockItemTextValue;
+    case "Boolean":
+      return PageBlockItemBooleanValue;
+    case "Number":
+      return PageBlockItemNumberValue;
+    case "SingleSelect":
+      return PageBlockItemSingleSelectValue;
+    case "MultiSelect":
+      return PageBlockItemMultiSelectValue;
+    case "Image":
+      return PageBlockItemImageValue;
+    case "Token":
+      return PageBlockItemTokenValue;
+    case "TokenType":
+      return PageBlockItemTokenTypeValue;
+    case "TokenProperty":
+      return PageBlockItemTokenPropertyValue;
+    case "Component":
+      return PageBlockItemComponentValue;
+    case "ComponentProperty":
+      return PageBlockItemComponentPropertyValue;
+    case "Asset":
+      return PageBlockItemAssetValue;
+    case "AssetProperty":
+      return PageBlockItemAssetPropertyValue;
+    case "EmbedURL":
+      return PageBlockItemEmbedValue;
+    case "URL":
+      return PageBlockItemUrlValue;
+    case "Markdown":
+      return PageBlockItemMarkdownValue;
+    case "Code":
+      return PageBlockItemCodeValue;
+    case "CodeSandbox":
+      return PageBlockItemSandboxValue;
+    case "Table":
+      return PageBlockItemTableValue;
+    case "Divider":
+      return PageBlockItemDividerValue;
+    case "Storybook":
+      return PageBlockItemStorybookValue;
+    case "Color":
+      return PageBlockItemColorValue;
+  }
+}
+
 //
 // Attributes
 //

package/src/docs-editor/utils.ts

@@ -2,10 +2,10 @@ import { PageBlockEditorModel } from "./model/block";
 import {
   PageBlockDefinition,
   PageBlockDefinitionPropertyType,
-  PageBlockItemEmbedPropertyValue,
-  PageBlockItemMultiRichTextPropertyValue,
-  PageBlockItemRichTextPropertyValue,
-  PageBlockItemUntypedPropertyValue,
+  PageBlockItemEmbedValue,
+  PageBlockItemMultiRichTextValue,
+  PageBlockItemRichTextValue,
+  PageBlockItemUntypedValue,
   PageBlockItemV2,
   PageBlockText,
 } from "@supernova-studio/model";
@@ -18,23 +18,23 @@ export const BlockParsingUtils = {
     return block.data.items[0]!;
   },
 
-  richTextPropertyValue(item: PageBlockItemV2, propertyKey: string): PageBlockItemRichTextPropertyValue {
+  richTextPropertyValue(item: PageBlockItemV2, propertyKey: string): PageBlockItemRichTextValue {
     const objectValue = this.objectPropertyValue(item, propertyKey);
-    const richText = PageBlockItemRichTextPropertyValue.parse(objectValue);
+    const richText = PageBlockItemRichTextValue.parse(objectValue);
 
     return richText;
   },
 
-  multiRichTextPropertyValue(item: PageBlockItemV2, propertyKey: string): PageBlockItemMultiRichTextPropertyValue {
+  multiRichTextPropertyValue(item: PageBlockItemV2, propertyKey: string): PageBlockItemMultiRichTextValue {
     const objectValue = this.objectPropertyValue(item, propertyKey);
-    const richText = PageBlockItemMultiRichTextPropertyValue.parse(objectValue);
+    const richText = PageBlockItemMultiRichTextValue.parse(objectValue);
 
     return richText;
   },
 
-  embedPropertyValue(item: PageBlockItemV2, propertyKey: string): PageBlockItemEmbedPropertyValue {
+  embedPropertyValue(item: PageBlockItemV2, propertyKey: string): PageBlockItemEmbedValue {
     const objectValue = this.objectPropertyValue(item, propertyKey);
-    const embed = PageBlockItemEmbedPropertyValue.parse(objectValue);
+    const embed = PageBlockItemEmbedValue.parse(objectValue);
 
     return embed;
   },
@@ -49,7 +49,7 @@ export const BlockParsingUtils = {
     return value;
   },
 
-  propertyValueOrThrow(item: PageBlockItemV2, propertyKey: string): PageBlockItemUntypedPropertyValue {
+  propertyValueOrThrow(item: PageBlockItemV2, propertyKey: string): PageBlockItemUntypedValue {
     const value = item.props[propertyKey];
     if (!value) throw new Error(`Property ${propertyKey} is not defined on block item`);