@supernova-studio/model 0.2.2 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supernova-studio/model",
-  "version": "0.2.2",
+  "version": "0.4.0",
   "description": "Supernova Data Models",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/dsm/elements/data/documentation-block-v2.ts

@@ -1,7 +1,8 @@
 import { z } from "zod";
 import { ColorValue } from "./color";
-import { PageBlockCalloutType, PageBlockText } from "./documentation-block-v1";
+import { PageBlockCalloutType, PageBlockCodeLanguage, PageBlockText } from "./documentation-block-v1";
 import { Size } from "../primitives";
+import { DesignTokenType } from "../raw-element";
 
 //
 // Enums
@@ -10,44 +11,58 @@ import { Size } from "../primitives";
 export const PageBlockLinkType = z.enum(["DocumentationItem", "PageHeading", "Url"]);
 export const PageBlockImageType = z.enum(["Upload", "Asset", "FigmaFrame"]);
 export const PageBlockImageAlignment = z.enum(["Left", "Center", "Stretch"]);
+export const PageBlockTableCellAlignment = z.enum(["Left", "Center", "Right"]);
 
 export type PageBlockLinkType = z.infer<typeof PageBlockLinkType>;
 export type PageBlockImageType = z.infer<typeof PageBlockImageType>;
 export type PageBlockImageAlignment = z.infer<typeof PageBlockImageAlignment>;
+export type PageBlockTableCellAlignment = z.infer<typeof PageBlockTableCellAlignment>;
 
 //
-// Definitions
+// Definitions - Block
 //
 
 export const PageBlockAppearanceV2 = z.object({
   itemBackgroundColor: ColorValue,
 });
 
-export const PageBlockItemUntypedPropertyValue = z
+export const PageBlockItemUntypedValue = z
   .object({
     value: z.any(),
   })
   .and(z.record(z.any()));
 
-export const PageBlockItemRichTextPropertyValue = z.object({
-  value: PageBlockText,
-  calloutType: PageBlockCalloutType.optional(),
+export const PageBlockLinkV2 = z.object({
+  type: PageBlockLinkType,
+  documentationItemId: z.string().optional(),
+  pageHeadingId: z.string().optional(),
+  url: z.string().optional(),
+  openInNewTab: z.boolean().optional(),
 });
 
-export const PageBlockItemEmbedPropertyValue = z.object({
-  value: z.string().optional(),
-  caption: z.string().optional(),
-  height: z.number().optional(),
+export const PageBlockItemV2 = z.object({
+  id: z.string(),
+  linksTo: PageBlockLinkV2.optional(),
+  props: z.record(PageBlockItemUntypedValue),
 });
 
-export const PageBlockItemMultiRichTextPropertyValue = z.object({
-  value: PageBlockText.array(),
+export const PageBlockDataV2 = z.object({
+  packageId: z.string(),
+  variantId: z.string().optional(),
+  indentLevel: z.number(),
+  appearance: PageBlockAppearanceV2.optional(),
+  items: z.array(PageBlockItemV2),
 });
 
-export const PageBlockItemTextPropertyValue = z.object({
-  value: z.string(),
-  calloutType: PageBlockCalloutType.optional(),
-});
+export type PageBlockAppearanceV2 = z.infer<typeof PageBlockAppearanceV2>;
+export type PageBlockItemUntypedValue = z.infer<typeof PageBlockItemUntypedValue>;
+export type PageBlockLinkV2 = z.infer<typeof PageBlockLinkV2>;
+export type PageBlockItemV2 = z.infer<typeof PageBlockItemV2>;
+export type PageBlockDataV2 = z.infer<typeof PageBlockDataV2>;
+
+//
+// Definitions - Typed Values
+//
 
 export const PageBlockItemImageReference = z.object({
   type: PageBlockImageType,
@@ -62,6 +77,64 @@ export const PageBlockItemImageReference = z.object({
     .optional(),
 });
 
+export const PageBlockItemAssetValue = z.object({
+  selectedPropertyIds: z.array(z.string()).optional(),
+  showSearch: z.boolean().optional(),
+  previewContainerSize: z.enum(["Centered", "NaturalHeight"]).optional(),
+  backgroundColor: z.string().optional(),
+  value: z.array(
+    z.object({
+      entityId: z.string(),
+      entityType: z.enum(["Asset", "AssetGroup"]),
+    })
+  ),
+});
+
+export const PageBlockItemAssetPropertyValue = z.object({
+  value: z.array(z.string()),
+});
+
+export const PageBlockItemBooleanValue = z.object({
+  value: z.boolean(),
+});
+
+export const PageBlockItemCodeValue = z.object({
+  format: PageBlockCodeLanguage.optional(),
+  caption: z.string().optional(),
+  value: z.string(),
+});
+
+export const PageBlockItemSandboxValue = z.object({
+  showCode: z.boolean().optional(),
+  backgroundColor: z.string().optional(),
+  alignPreview: z.enum(["Left", "Center"]).optional(),
+  value: z.string(),
+});
+
+export const PageBlockItemColorValue = z.record(z.any());
+
+export const PageBlockItemComponentValue = z.object({
+  selectedPropertyIds: z.array(z.string()).optional(),
+  value: z.array(
+    z.object({
+      entityId: z.string(),
+      entityType: z.enum(["Component", "ComponentGroup"]),
+    })
+  ),
+});
+
+export const PageBlockItemComponentPropertyValue = z.object({
+  value: z.string(),
+});
+
+export const PageBlockItemDividerValue = z.object({});
+
+export const PageBlockItemEmbedValue = z.object({
+  value: z.string().optional(),
+  caption: z.string().optional(),
+  height: z.number().optional(),
+});
+
 export const PageBlockItemImageValue = z.object({
   alt: z.string().optional(),
   caption: z.string().optional(),
@@ -69,37 +142,141 @@ export const PageBlockItemImageValue = z.object({
   value: PageBlockItemImageReference.optional(),
 });
 
-export const PageBlockLinkV2 = z.object({
-  type: PageBlockLinkType,
-  documentationItemId: z.string().optional(),
-  pageHeadingId: z.string().optional(),
-  url: z.string().optional(),
-  openInNewTab: z.boolean().optional(),
+export const PageBlockItemMarkdownValue = z.object({
+  value: z.string(),
 });
 
-export const PageBlockItemV2 = z.object({
-  id: z.string(),
-  linksTo: PageBlockLinkV2.optional(),
-  props: z.record(PageBlockItemUntypedPropertyValue),
+export const PageBlockItemMultiRichTextValue = z.object({
+  value: PageBlockText.array(),
 });
 
-export const PageBlockDataV2 = z.object({
-  packageId: z.string(),
-  variantId: z.string().optional(),
-  indentLevel: z.number(),
-  appearance: PageBlockAppearanceV2.optional(),
-  items: z.array(PageBlockItemV2),
+export const PageBlockItemMultiSelectValue = z.object({
+  value: z.array(z.string()),
+});
+
+export const PageBlockItemNumberValue = z.object({
+  value: z.number(),
+});
+
+export const PageBlockItemRichTextValue = z.object({
+  value: PageBlockText,
+  calloutType: PageBlockCalloutType.optional(),
+});
+
+export const PageBlockItemSingleSelectValue = z.object({
+  value: z.string(),
+});
+
+export const PageBlockItemStorybookValue = z.object({
+  caption: z.string().optional(),
+  height: z.number().optional(),
+  showAddons: z.boolean().optional(),
+  value: z.string(),
+});
+
+export const PageBlockItemTextValue = z.object({
+  value: z.string(),
+});
+
+export const PageBlockItemTokenValue = z.object({
+  selectedPropertyIds: z.array(z.string()).optional(),
+  selectedThemeIds: z.array(z.string()).optional(),
+  value: z.array(
+    z.object({
+      entityId: z.string(),
+      entityType: z.enum(["Token", "TokenGroup"]),
+    })
+  ),
+});
+
+export const PageBlockItemTokenPropertyValue = z.object({
+  selectedPropertyIds: z.array(z.string()).optional(),
+  selectedThemeIds: z.array(z.string()).optional(),
+  value: z.array(z.string()),
+});
+
+export const PageBlockItemTokenTypeValue = z.object({
+  value: z.array(DesignTokenType),
+});
+
+export const PageBlockItemUrlValue = z.object({
+  value: z.string(),
 });
 
-export type PageBlockAppearanceV2 = z.infer<typeof PageBlockAppearanceV2>;
-export type PageBlockItemUntypedPropertyValue = z.infer<typeof PageBlockItemUntypedPropertyValue>;
-export type PageBlockItemRichTextPropertyValue = z.infer<typeof PageBlockItemRichTextPropertyValue>;
-export type PageBlockItemMultiRichTextPropertyValue = z.infer<typeof PageBlockItemMultiRichTextPropertyValue>;
-export type PageBlockItemTextPropertyValue = z.infer<typeof PageBlockItemTextPropertyValue>;
-export type PageBlockItemEmbedPropertyValue = z.infer<typeof PageBlockItemEmbedPropertyValue>;
-export type PageBlockItemImageValue = z.infer<typeof PageBlockItemImageValue>;
 export type PageBlockItemImageReference = z.infer<typeof PageBlockItemImageReference>;
 
-export type PageBlockLinkV2 = z.infer<typeof PageBlockLinkV2>;
-export type PageBlockItemV2 = z.infer<typeof PageBlockItemV2>;
-export type PageBlockDataV2 = z.infer<typeof PageBlockDataV2>;
+export type PageBlockItemAssetValue = z.infer<typeof PageBlockItemAssetValue>;
+export type PageBlockItemAssetPropertyValue = z.infer<typeof PageBlockItemAssetPropertyValue>;
+export type PageBlockItemBooleanValue = z.infer<typeof PageBlockItemBooleanValue>;
+export type PageBlockItemCodeValue = z.infer<typeof PageBlockItemCodeValue>;
+export type PageBlockItemSandboxValue = z.infer<typeof PageBlockItemSandboxValue>;
+export type PageBlockItemColorValue = z.infer<typeof PageBlockItemColorValue>;
+export type PageBlockItemComponentValue = z.infer<typeof PageBlockItemComponentValue>;
+export type PageBlockItemComponentPropertyValue = z.infer<typeof PageBlockItemComponentPropertyValue>;
+export type PageBlockItemDividerValue = z.infer<typeof PageBlockItemDividerValue>;
+export type PageBlockItemEmbedValue = z.infer<typeof PageBlockItemEmbedValue>;
+export type PageBlockItemImageValue = z.infer<typeof PageBlockItemImageValue>;
+export type PageBlockItemMarkdownValue = z.infer<typeof PageBlockItemMarkdownValue>;
+export type PageBlockItemMultiRichTextValue = z.infer<typeof PageBlockItemMultiRichTextValue>;
+export type PageBlockItemMultiSelectValue = z.infer<typeof PageBlockItemMultiSelectValue>;
+export type PageBlockItemNumberValue = z.infer<typeof PageBlockItemNumberValue>;
+export type PageBlockItemRichTextValue = z.infer<typeof PageBlockItemRichTextValue>;
+export type PageBlockItemSingleSelectValue = z.infer<typeof PageBlockItemSingleSelectValue>;
+export type PageBlockItemStorybookValue = z.infer<typeof PageBlockItemStorybookValue>;
+export type PageBlockItemTextValue = z.infer<typeof PageBlockItemTextValue>;
+export type PageBlockItemTokenValue = z.infer<typeof PageBlockItemTokenValue>;
+export type PageBlockItemTokenPropertyValue = z.infer<typeof PageBlockItemTokenPropertyValue>;
+export type PageBlockItemTokenTypeValue = z.infer<typeof PageBlockItemTokenTypeValue>;
+export type PageBlockItemUrlValue = z.infer<typeof PageBlockItemUrlValue>;
+
+//
+// Definitions - Table Value
+//
+
+export const PageBlockItemTableRichTextNode = z.object({
+  type: z.literal("RichText"),
+  value: PageBlockItemRichTextValue.shape.value,
+});
+
+export const PageBlockItemTableMultiRichTextNode = z.object({
+  type: z.literal("MultiRichText"),
+  value: PageBlockItemMultiRichTextValue.shape.value,
+});
+
+export const PageBlockItemTableImageNode = z.object({
+  type: z.literal("Image"),
+  value: PageBlockItemImageValue.shape.value,
+});
+
+export const PageBlockItemTableNode = z.discriminatedUnion("type", [
+  PageBlockItemTableRichTextNode,
+  PageBlockItemTableMultiRichTextNode,
+  PageBlockItemTableImageNode,
+]);
+
+export const PageBlockItemTableCell = z.object({
+  id: z.string(),
+  nodes: z.array(PageBlockItemTableNode),
+  columnWidth: z.number().optional(),
+  alignment: PageBlockTableCellAlignment,
+});
+
+export const PageBlockItemTableRow = z.object({
+  cells: z.array(PageBlockItemTableCell),
+});
+
+export const PageBlockItemTableValue = z.object({
+  highlightHeaderColumn: z.boolean().optional(),
+  highlightHeaderRow: z.boolean().optional(),
+  showBorder: z.boolean().optional(),
+  width: z.number().optional(),
+  value: z.array(PageBlockItemTableRow),
+});
+
+export type PageBlockItemTableRichTextNode = z.infer<typeof PageBlockItemTableRichTextNode>;
+export type PageBlockItemTableMultiRichTextNode = z.infer<typeof PageBlockItemTableMultiRichTextNode>;
+export type PageBlockItemTableImageNode = z.infer<typeof PageBlockItemTableImageNode>;
+export type PageBlockItemTableNode = z.infer<typeof PageBlockItemTableNode>;
+export type PageBlockItemTableCell = z.infer<typeof PageBlockItemTableCell>;
+export type PageBlockItemTableRow = z.infer<typeof PageBlockItemTableRow>;
+export type PageBlockItemTableValue = z.infer<typeof PageBlockItemTableValue>;