@supernova-studio/model 0.0.4 → 0.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supernova-studio/model",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "Supernova Data Models",
   "main": "index.ts",
   "source": "index.ts",

package/src/dsm/documentation/block-definitions/aux.ts

@@ -3,6 +3,7 @@ import { z } from "zod";
 export const PageBlockDefinitionAppearance = z.object({
   isBordered: z.boolean().optional(),
   hasBackground: z.boolean().optional(),
+  isEditorPresentationDifferent: z.boolean().optional(),
 });
 
 export type PageBlockDefinitionAppearance = z.infer<typeof PageBlockDefinitionAppearance>;

package/src/dsm/documentation/block-definitions/definition.ts

@@ -7,63 +7,34 @@ import { PageBlockDefinitionAppearance } from "./aux";
 // Enums
 //
 
-export enum PageBlockCategory {
-  /** Shows as a "Text Blocks" */
-  text = "Text",
-  /** Show as "Layout blocks" */
-  layout = "Layout",
-  /** Show as "Media blocks" */
-  media = "Media",
-  /** Show as "Embed blocks" */
-  embed = "Embed",
-  /** Show as "Figma blocks" */
-  figma = "Figma",
-  /** Show as "Code blocks" */
-  code = "Code",
-  /** Show as "Guidelines blocks" */
-  guidelines = "Guidelines",
-  /** Show as "Token blocks" */
-  token = "Tokens",
-  /** Show as "Component blocks" */
-  component = "Components",
-  /** Shows as "Asset blocks" */
-  asset = "Assets",
-  /** Show as "Data blocks" */
-  data = "Data",
-  /** Shows as "Other blocks" */
-  other = "Other",
-}
+export const PageBlockCategory = z.enum([
+  "Text",
+  "Layout",
+  "Media",
+  "Embed",
+  "Figma",
+  "Code",
+  "Guidelines",
+  "Tokens",
+  "Components",
+  "Assets",
+  "Data",
+  "Other",
+]);
 
-export enum PageBlockBehaviorDataType {
-  /** Item type uses item definition alone to construct items - examples of this are RichText, Shortcut, etc. In this mode, data panel will be hidden */
-  item = "Item",
-  /** Token type allows selection of token entity and associated groups * */
-  token = "Token",
-  /** Asset type allows selection of asset entity and associated groups * */
-  asset = "Asset",
-  /** Component type allows selection of asset entity and associated groups * */
-  component = "Component",
-}
+export const PageBlockBehaviorDataType = z.enum(["Item", "Token", "Asset", "Component"]);
+export const PageBlockBehaviorSelectionType = z.enum(["Entity", "Group", "EntityAndGroup"]);
 
-export enum PageBlockBehaviorSelectionType {
-  /** Allows selection of data entities only */
-  entity = "Entity",
-  /** Allows selection of groups only */
-  group = "Group",
-  /** Allows combined selection of data entities and groups */
-  entityAndGroup = "EntityAndGroup",
-}
-
-export const PageBlockCategorySchema = z.nativeEnum(PageBlockCategory);
-export const PageBlockBehaviorDataTypeSchema = z.nativeEnum(PageBlockBehaviorDataType);
-export const PageBlockBehaviorSelectionTypeSchema = z.nativeEnum(PageBlockBehaviorSelectionType);
+export type PageBlockCategory = z.infer<typeof PageBlockCategory>;
+export type PageBlockBehaviorDataType = z.infer<typeof PageBlockBehaviorDataType>;
+export type PageBlockBehaviorSelectionType = z.infer<typeof PageBlockBehaviorSelectionType>;
 
 //
 // Definitions
 //
 
 export const PageBlockDefinitionBehavior = z.object({
-  dataType: PageBlockBehaviorDataTypeSchema,
+  dataType: PageBlockBehaviorDataType,
   items: z
     .object({
       numberOfItems: z.number(),
@@ -72,7 +43,7 @@ export const PageBlockDefinitionBehavior = z.object({
     .optional(),
   entities: z
     .object({
-      selectionType: PageBlockBehaviorSelectionTypeSchema,
+      selectionType: PageBlockBehaviorSelectionType,
       maxSelected: z.number(),
     })
     .optional(),
@@ -87,7 +58,7 @@ export const PageBlockDefinition = z.object({
   id: z.string(),
   name: z.string(),
   description: z.string(),
-  category: PageBlockCategorySchema,
+  category: PageBlockCategory,
   icon: AssetValue.optional(),
   documentationLink: z.string().optional(),
   searchKeywords: z.array(z.string()).optional(),

package/src/dsm/documentation/block-definitions/item.ts

@@ -6,79 +6,45 @@ import { PageBlockDefinitionVariant } from "./variant";
 // Enums
 //
 
-export enum PageBlockDefinitionPropertyType {
-  /** Rich text property allows user to input rich text (with additional attributes like bold, links etc.) */
-  richText = "RichText",
-  /** Text property allows user to input plain text */
-  text = "Text",
-  /** Boolean property allows user to input true/false value */
-  boolean = "Boolean",
-  /** Number property allows user to input number */
-  number = "Number",
-  /** Single-select property allows user to select one of the options */
-  singleSelect = "SingleSelect",
-  /** Multi-select property allows user to select multiple of the options */
-  multiSelect = "MultiSelect",
-  /** Image property allows user to select or upload image */
-  image = "Image",
-  /** Token type allows data access to the tokens defined in design system */
-  token = "Token",
-  /** Token type allows selection of type(s) such as color, typography etc., for further use such as filtering */
-  tokenType = "TokenType",
-  /** Token property allows selection of custom token properties (columns) */
-  tokenProperty = "TokenProperty",
-  /** Component type allows data access to the components defined in design system */
-  component = "Component",
-  /** Component property allows selection of custom component properties (columns) */
-  componentProperty = "ComponentProperty",
-  /** Asset type allows data access to the assets defined in design system */
-  asset = "Asset",
-  /** Asset property allows selection of custom asset properties (columns) */
-  assetProperty = "AssetProperty",
-  /** Page type allows data access to the pages defined in design system */
-  /** Page property allows selection of custom page properties (columns) */
-  /** Embed property allows user to input page to be embedded via URL */
-  embedURL = "EmbedURL",
-  /** Embed property allows user to input page to be embedded via iframe */
-  /** Markdown property allows user to add markdown to render */
-  markdown = "Markdown",
-  /** Code property allows user to add code to render */
-  code = "Code",
-  /** Sandbox property allows user to add code sandbox to render live component */
-  codeSandbox = "CodeSandbox",
-  /** Table property allows user to add table to render */
-  table = "Table",
-  /** Divider property that puts visual divider into the block. It has no user input */
-  divider = "Divider",
-  /** Storybook property allows user to add Storybook story to render */
-  storybook = "Storybook",
-}
+export const PageBlockDefinitionPropertyType = z.enum([
+  "RichText",
+  "Text",
+  "Boolean",
+  "Number",
+  "SingleSelect",
+  "MultiSelect",
+  "Image",
+  "Token",
+  "TokenType",
+  "TokenProperty",
+  "Component",
+  "ComponentProperty",
+  "Asset",
+  "AssetProperty",
+  "EmbedURL",
+  "Markdown",
+  "Code",
+  "CodeSandbox",
+  "Table",
+  "Divider",
+  "Storybook",
+]);
 
-export enum PageBlockDefinitionRichTextPropertyStyle {
-  /** Title type 1, roughly equivalent of h2 in size */
-  title1 = "Title1",
-  /** Title type 2, roughly equivalent of h3 in size */
-  title2 = "Title2",
-  /** Title type 3, roughly equivalent of h4 in size */
-  title3 = "Title3",
-  /** Title type 4, roughly equivalent of h5 in size */
-  title4 = "Title4",
-  /** Title type 5, roughly equivalent of h6 in size */
-  title5 = "Title5",
-  /** Quote */
-  quote = "Quote",
-  /** Callout */
-  callout = "Callout",
-  /** Ordered list */
-  ol = "OL",
-  /** Unordered list */
-  ul = "UL",
-  /** Default option */
-  default = "Default",
-}
+export const PageBlockDefinitionRichTextPropertyStyle = z.enum([
+  "Title1",
+  "Title2",
+  "Title3",
+  "Title4",
+  "Title5",
+  "Quote",
+  "Callout",
+  "OL",
+  "UL",
+  "Default",
+]);
 
-export const PageBlockDefinitionPropertyTypeSchema = z.nativeEnum(PageBlockDefinitionPropertyType);
-export const PageBlockDefinitionRichTextPropertyStyleSchema = z.nativeEnum(PageBlockDefinitionRichTextPropertyStyle);
+export type PageBlockDefinitionPropertyType = z.infer<typeof PageBlockDefinitionPropertyType>;
+export type PageBlockDefinitionRichTextPropertyStyle = z.infer<typeof PageBlockDefinitionRichTextPropertyStyle>;
 
 //
 // Definitions
@@ -86,7 +52,7 @@ export const PageBlockDefinitionRichTextPropertyStyleSchema = z.nativeEnum(PageB
 
 export const PageBlockDefinitionPropertyOptions = z
   .object({
-    style: PageBlockDefinitionRichTextPropertyStyleSchema.optional(),
+    style: PageBlockDefinitionRichTextPropertyStyle.optional(),
     placeholder: z.string().optional(),
   })
   .and(z.record(z.any()));
@@ -94,7 +60,7 @@ export const PageBlockDefinitionPropertyOptions = z
 export const PageBlockDefinitionProperty = z.object({
   id: z.string(),
   name: z.string(),
-  type: PageBlockDefinitionPropertyTypeSchema,
+  type: PageBlockDefinitionPropertyType,
   description: z.string().optional(),
   // TODO Docs
   options: PageBlockDefinitionPropertyOptions.optional(),

package/src/dsm/documentation/block-definitions/variant.ts

@@ -5,54 +5,25 @@ import { PageBlockDefinitionAppearance } from "./aux";
 // Enums
 //
 
-export enum PageBlockDefinitionLayoutType {
-  /** Layout will stack all its items in this group into column */
-  column = "Column",
-  /** Layout will stack all its items in this group into row */
-  row = "Row",
-}
+export const PageBlockDefinitionLayoutType = z.enum(["Column", "Row"]);
+export const PageBlockDefinitionLayoutGap = z.enum(["Small", "Medium", "Large", "None"]);
+export const PageBlockDefinitionLayoutAlign = z.enum(["Start", "Center", "End"]);
+export const PageBlockDefinitionLayoutResizing = z.enum(["Fill", "Hug"]);
 
-export enum PageBlockDefinitionLayoutGap {
-  /** small gap between columns/row */
-  small = "Small",
-  /** medium gap between columns/row */
-  medium = "Medium",
-  /** large gap between columns/row */
-  large = "Large",
-  /** no gap between columns/row */
-  none = "None",
-}
-
-export enum PageBlockDefinitionLayoutAlign {
-  /** Vertically on top */
-  start = "Start",
-  /** Vertically centered */
-  center = "Center",
-  /** Vertically on the bottom */
-  end = "End",
-}
-
-export enum PageBlockDefinitionLayoutResizing {
-  /** Will fill all available space for the column */
-  fill = "Fill",
-  /** Will hug content inside the column */
-  hug = "Hug",
-}
-
-export const PageBlockDefinitionLayoutTypeSchema = z.nativeEnum(PageBlockDefinitionLayoutType);
-export const PageBlockDefinitionLayoutGapSchema = z.nativeEnum(PageBlockDefinitionLayoutGap);
-export const PageBlockDefinitionLayoutAlignSchema = z.nativeEnum(PageBlockDefinitionLayoutAlign);
-export const PageBlockDefinitionLayoutResizingSchema = z.nativeEnum(PageBlockDefinitionLayoutResizing);
+export type PageBlockDefinitionLayoutType = z.infer<typeof PageBlockDefinitionLayoutType>;
+export type PageBlockDefinitionLayoutGap = z.infer<typeof PageBlockDefinitionLayoutGap>;
+export type PageBlockDefinitionLayoutAlign = z.infer<typeof PageBlockDefinitionLayoutAlign>;
+export type PageBlockDefinitionLayoutResizing = z.infer<typeof PageBlockDefinitionLayoutResizing>;
 
 //
 // Definitions
 //
 
 export const PageBlockDefinitionLayoutBase = z.object({
-  type: PageBlockDefinitionLayoutTypeSchema,
-  gap: PageBlockDefinitionLayoutGapSchema.optional(),
-  columnAlign: PageBlockDefinitionLayoutAlignSchema.optional(),
-  columnResizing: PageBlockDefinitionLayoutResizingSchema.optional(),
+  type: PageBlockDefinitionLayoutType,
+  gap: PageBlockDefinitionLayoutGap.optional(),
+  columnAlign: PageBlockDefinitionLayoutAlign.optional(),
+  columnResizing: PageBlockDefinitionLayoutResizing.optional(),
 });
 
 export const PageBlockDefinitionLayout: z.ZodType<PageBlockDefinitionLayout, ZodTypeDef, PageBlockDefinitionLayout> =

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

@@ -9,14 +9,7 @@ import { nullishToOptional } from "../../../helpers";
 // Enums
 //
 
-export enum PageBlockCalloutType {
-  info = "Info",
-  success = "Success",
-  warning = "Warning",
-  error = "Error",
-}
-
-export const PageBlockCalloutTypeSchema = z.nativeEnum(PageBlockCalloutType);
+export const PageBlockCalloutType = z.enum(["Info", "Success", "Warning", "Error"]);
 
 export const PageBlockTypeV1 = z.enum([
   "Text",
@@ -253,7 +246,7 @@ const PageBlockBaseV1 = z.object({
   caption: nullishToOptional(z.string()),
   headingType: nullishToOptional(z.number().min(1).max(3)),
   codeLanguage: nullishToOptional(PageBlockCodeLanguage),
-  calloutType: nullishToOptional(PageBlockCalloutTypeSchema),
+  calloutType: nullishToOptional(PageBlockCalloutType),
   urlInput: nullishToOptional(z.string()),
   url: nullishToOptional(z.string()),
   urlPreview: nullishToOptional(PageBlockUrlPreview),

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

@@ -1,19 +1,14 @@
 import { z } from "zod";
 import { ColorValue } from "./color";
-import { PageBlockCalloutTypeSchema } from "./documentation-block-v1";
+import { PageBlockCalloutType } from "./documentation-block-v1";
 
 //
 // Enums
 //
 
-export enum PageBlockLinkType {
-  page = "Page",
-  pageHeading = "pageHeading",
-  group = "Group",
-  url = "url",
-}
+export const PageBlockLinkType = z.enum(["Page", "PageHeading", "Group", "Url"]);
 
-export const PageBlockLinkTypeSchema = z.enum(["Page", "PageHeading", "Group", "Url"]);
+export type PageBlockLinkType = z.infer<typeof PageBlockLinkType>;
 
 //
 // Definitions
@@ -25,11 +20,11 @@ export const PageBlockAppearanceV2 = z.object({
 
 export const PageBlockItemPropertyValue = z.object({
   value: z.any(),
-  calloutType: PageBlockCalloutTypeSchema.optional(),
+  calloutType: PageBlockCalloutType.optional(),
 });
 
 export const PageBlockLinkV2 = z.object({
-  type: PageBlockLinkTypeSchema,
+  type: PageBlockCalloutType,
   pageId: z.string().optional(),
   pageHeadingId: z.string().optional(),
   groupId: z.string().optional(),