@supernova-studio/model 0.19.2 → 0.20.0

package/package.json

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

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

@@ -25,6 +25,24 @@ export type PageBlockThemeDisplayMode = z.infer<typeof PageBlockThemeDisplayMode
 // Definitions - Block
 //
 
+export const PageBlockImageReference = z.object({
+  type: PageBlockImageType,
+  url: z.string(),
+  assetId: z.string().optional(),
+  size: Size.optional(),
+  figmaFile: z
+    .object({
+      sourceId: z.string(),
+      frameId: z.string(),
+      frameReferenceId: z.string(),
+      origin: z.object({
+        title: z.string().optional(),
+        sourceFileName: z.string().optional(),
+      }),
+    })
+    .optional(),
+});
+
 export const PageBlockColorV2 = z.object({
   value: z.string(),
   referencedTokenId: z.string().optional(),
@@ -63,6 +81,7 @@ export const PageBlockDataV2 = z.object({
   items: z.array(PageBlockItemV2),
 });
 
+export type PageBlockImageReference = z.infer<typeof PageBlockImageReference>;
 export type PageBlockColorV2 = z.infer<typeof PageBlockColorV2>;
 export type PageBlockAppearanceV2 = z.infer<typeof PageBlockAppearanceV2>;
 export type PageBlockItemUntypedValue = z.infer<typeof PageBlockItemUntypedValue>;
@@ -74,24 +93,6 @@ export type PageBlockDataV2 = z.infer<typeof PageBlockDataV2>;
 // Definitions - Typed Values
 //
 
-export const PageBlockItemImageReference = z.object({
-  type: PageBlockImageType,
-  url: z.string(),
-  assetId: z.string().optional(),
-  size: Size.optional(),
-  figmaFile: z
-    .object({
-      sourceId: z.string(),
-      frameId: z.string(),
-      frameReferenceId: z.string(),
-      origin: z.object({
-        title: z.string().optional(),
-        sourceFileName: z.string().optional(),
-      }),
-    })
-    .optional(),
-});
-
 export const PageBlockItemAssetValue = z.object({
   selectedPropertyIds: z.array(z.string()).optional(),
   showSearch: z.boolean().optional(),
@@ -186,7 +187,7 @@ export const PageBlockItemImageValue = z.object({
   alt: z.string().optional(),
   caption: z.string().optional(),
   alignment: PageBlockImageAlignment.optional(),
-  value: PageBlockItemImageReference.optional(),
+  value: PageBlockImageReference.optional(),
 });
 
 export const PageBlockItemMarkdownValue = z.object({
@@ -256,8 +257,6 @@ export const PageBlockItemUrlValue = z.object({
   value: z.string(),
 });
 
-export type PageBlockItemImageReference = z.infer<typeof PageBlockItemImageReference>;
-
 export type PageBlockItemAssetValue = z.infer<typeof PageBlockItemAssetValue>;
 export type PageBlockItemAssetPropertyValue = z.infer<typeof PageBlockItemAssetPropertyValue>;
 export type PageBlockItemBooleanValue = z.infer<typeof PageBlockItemBooleanValue>;

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

@@ -1,13 +1,14 @@
 import { z } from "zod";
-import { DocumentationItemConfiguration } from "./documentation";
+import { DocumentationItemConfigurationV1 } from "./documentation-v1";
 import { PageBlockV1 } from "./documentation-block-v1";
 import { nullishToOptional } from "../../../helpers";
 
 export const DocumentationPageDataV1 = z.object({
   blocks: z.array(PageBlockV1),
-  configuration: nullishToOptional(DocumentationItemConfiguration),
+  configuration: nullishToOptional(DocumentationItemConfigurationV1),
 });
 
 export const DocumentationPageElementDataV1 = z.object({
+  dataVersion: z.literal(1).optional().default(1),
   value: DocumentationPageDataV1,
 });

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

@@ -1,11 +1,13 @@
 import { z } from "zod";
-import { DocumentationItemConfiguration } from "./documentation";
+import { DocumentationItemConfigurationV2 } from "./documentation-v2";
 import { nullishToOptional } from "../../../helpers";
+import { DocumentationPageDataV1 } from "./documentation-page-v1";
 
 export const DocumentationPageDataV2 = z.object({
-  configuration: nullishToOptional(DocumentationItemConfiguration),
+  configuration: nullishToOptional(DocumentationItemConfigurationV2),
 });
 
 export const DocumentationPageElementDataV2 = z.object({
-  value: DocumentationPageDataV2,
+  value: DocumentationPageDataV1,
+  valueV2: DocumentationPageDataV2.optional(),
 });

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

@@ -0,0 +1,14 @@
+import { z } from "zod";
+import { DocumentationItemHeaderV1, defaultDocumentationItemHeaderV1 } from "./item-header-v1";
+
+export const DocumentationItemConfigurationV1 = z.object({
+  showSidebar: z.boolean(),
+  header: DocumentationItemHeaderV1,
+});
+
+export type DocumentationItemConfigurationV1 = z.infer<typeof DocumentationItemConfigurationV1>;
+
+export const defaultDocumentationItemConfigurationV1: DocumentationItemConfigurationV1 = {
+  header: defaultDocumentationItemHeaderV1,
+  showSidebar: true,
+};

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

@@ -0,0 +1,14 @@
+import { z } from "zod";
+import { DocumentationItemHeaderV2, defaultDocumentationItemHeaderV2 } from "./item-header-v2";
+
+export const DocumentationItemConfigurationV2 = z.object({
+  showSidebar: z.boolean(),
+  header: DocumentationItemHeaderV2,
+});
+
+export type DocumentationItemConfigurationV2 = z.infer<typeof DocumentationItemConfigurationV2>;
+
+export const defaultDocumentationItemConfigurationV2: DocumentationItemConfigurationV2 = {
+  header: defaultDocumentationItemHeaderV2,
+  showSidebar: true,
+};

package/src/dsm/elements/data/group.ts

@@ -1,17 +1,24 @@
 import { z } from "zod";
 import { nullishToOptional } from "../../../helpers";
-import { DocumentationItemConfiguration } from "./documentation";
+import { DocumentationItemConfigurationV1 } from "./documentation-v1";
+import { DocumentationItemConfigurationV2 } from "./documentation-v2";
 
 export const DocumentationGroupBehavior = z.enum(["Group", "Tabs"]);
 
-export const ElementGroupData = z.object({
+export const ElementGroupDataDeprecated = z.object({
   behavior: nullishToOptional(DocumentationGroupBehavior.optional()),
-  configuration: nullishToOptional(DocumentationItemConfiguration),
+  configuration: nullishToOptional(DocumentationItemConfigurationV1),
+});
+
+export const ElementGroupDataV2 = z.object({
+  behavior: nullishToOptional(DocumentationGroupBehavior.optional()),
+  configuration: nullishToOptional(DocumentationItemConfigurationV2),
 });
 
 export const ElementGroupElementData = z.object({
-  value: ElementGroupData.optional(),
+  value: ElementGroupDataDeprecated.optional(),
+  valueV2: ElementGroupDataV2.optional(),
 });
 
 export type DocumentationGroupBehavior = z.infer<typeof DocumentationGroupBehavior>;
-export type ElementGroupData = z.infer<typeof ElementGroupData>;
+export type ElementGroupDataV2 = z.infer<typeof ElementGroupDataV2>;

package/src/dsm/elements/data/index.ts

@@ -10,7 +10,8 @@ export * from "./documentation-block-v1";
 export * from "./documentation-block-v2";
 export * from "./documentation-page-v1";
 export * from "./documentation-page-v2";
-export * from "./documentation";
+export * from "./documentation-v1";
+export * from "./documentation-v2";
 export * from "./duration";
 export * from "./figma-file-structure";
 export * from "./figma-node-reference";
@@ -19,6 +20,8 @@ export * from "./font-size";
 export * from "./font-weight";
 export * from "./gradient";
 export * from "./group";
+export * from "./item-header-v1";
+export * from "./item-header-v2";
 export * from "./item-header";
 export * from "./letter-spacing";
 export * from "./line-height";

package/src/dsm/elements/data/item-header-v1.ts

@@ -0,0 +1,35 @@
+import { z } from "zod";
+import { DocumentationPageAsset } from "./page-asset";
+import { ColorTokenData } from "./color";
+import {
+  DocumentationItemHeaderAlignment,
+  DocumentationItemHeaderAlignmentSchema,
+  DocumentationItemHeaderImageScaleType,
+  DocumentationItemHeaderImageScaleTypeSchema,
+} from "./item-header";
+
+//
+// Definitions
+//
+
+export const DocumentationItemHeaderV1 = z.object({
+  description: z.string(),
+  alignment: DocumentationItemHeaderAlignmentSchema,
+  foregroundColor: ColorTokenData.nullish(),
+  backgroundColor: ColorTokenData.nullish(),
+  backgroundImageAsset: DocumentationPageAsset.nullish(),
+  backgroundImageScaleType: DocumentationItemHeaderImageScaleTypeSchema,
+  showBackgroundOverlay: z.boolean(),
+  showCoverText: z.boolean(),
+  minHeight: z.number().nullish(),
+});
+
+export type DocumentationItemHeaderV1 = z.infer<typeof DocumentationItemHeaderV1>;
+
+export const defaultDocumentationItemHeaderV1: DocumentationItemHeaderV1 = {
+  alignment: DocumentationItemHeaderAlignment.Left,
+  backgroundImageScaleType: DocumentationItemHeaderImageScaleType.AspectFill,
+  description: "",
+  showBackgroundOverlay: false,
+  showCoverText: true,
+};

package/src/dsm/elements/data/item-header-v2.ts

@@ -0,0 +1,35 @@
+import { z } from "zod";
+import { DocumentationPageAsset } from "./page-asset";
+import {
+  DocumentationItemHeaderAlignment,
+  DocumentationItemHeaderAlignmentSchema,
+  DocumentationItemHeaderImageScaleType,
+  DocumentationItemHeaderImageScaleTypeSchema,
+} from "./item-header";
+import { PageBlockColorV2 } from "./documentation-block-v2";
+
+//
+// Definitions
+//
+
+export const DocumentationItemHeaderV2 = z.object({
+  description: z.string(),
+  alignment: DocumentationItemHeaderAlignmentSchema,
+  foregroundColor: PageBlockColorV2.nullish(),
+  backgroundColor: PageBlockColorV2.nullish(),
+  backgroundImageAsset: DocumentationPageAsset.nullish(),
+  backgroundImageScaleType: DocumentationItemHeaderImageScaleTypeSchema,
+  showBackgroundOverlay: z.boolean(),
+  showCoverText: z.boolean(),
+  minHeight: z.number().nullish(),
+});
+
+export type DocumentationItemHeaderV2 = z.infer<typeof DocumentationItemHeaderV2>;
+
+export const defaultDocumentationItemHeaderV2: DocumentationItemHeaderV2 = {
+  alignment: DocumentationItemHeaderAlignment.Left,
+  backgroundImageScaleType: DocumentationItemHeaderImageScaleType.AspectFill,
+  description: "",
+  showBackgroundOverlay: false,
+  showCoverText: true,
+};

package/src/dsm/elements/data/item-header.ts

@@ -1,18 +1,9 @@
-import { z } from "zod";
-import { DocumentationPageAsset } from "./page-asset";
-import { ColorTokenData } from "./color";
-
-//
-// Consts
-//
-
-export const colorValueRegex = /^#[a-f0-9]{8}$/;
-export const colorValueFormatDescription = "Must match /^#[a-f0-9]{8}$/";
-
 //
 // Enums
 //
 
+import { z } from "zod";
+
 export const DocumentationItemHeaderAlignmentSchema = z.enum(["Left", "Center"]);
 export const DocumentationItemHeaderImageScaleTypeSchema = z.enum(["AspectFill", "AspectFit"]);
 
@@ -21,29 +12,3 @@ export const DocumentationItemHeaderImageScaleType = DocumentationItemHeaderImag
 
 export type DocumentationItemHeaderImageScaleType = z.infer<typeof DocumentationItemHeaderImageScaleTypeSchema>;
 export type DocumentationItemHeaderAlignment = z.infer<typeof DocumentationItemHeaderAlignmentSchema>;
-
-//
-// Definitions
-//
-
-export const DocumentationItemHeader = z.object({
-  description: z.string(),
-  alignment: DocumentationItemHeaderAlignmentSchema,
-  foregroundColor: ColorTokenData.nullish(),
-  backgroundColor: ColorTokenData.nullish(),
-  backgroundImageAsset: DocumentationPageAsset.nullish(),
-  backgroundImageScaleType: DocumentationItemHeaderImageScaleTypeSchema,
-  showBackgroundOverlay: z.boolean(),
-  showCoverText: z.boolean(),
-  minHeight: z.number().nullish(),
-});
-
-export type DocumentationItemHeader = z.infer<typeof DocumentationItemHeader>;
-
-export const defaultDocumentationItemHeader: DocumentationItemHeader = {
-  alignment: DocumentationItemHeaderAlignment.Left,
-  backgroundImageScaleType: DocumentationItemHeaderImageScaleType.AspectFill,
-  description: "",
-  showBackgroundOverlay: false,
-  showCoverText: true,
-};

package/src/dsm/elements/documentation-page-v2.ts

@@ -3,12 +3,15 @@ import { DesignElementBase, DesignElementGroupableRequiredPart, DesignElementSlu
 import { DbCreateInputOmit, DbUpdate } from "../../helpers";
 import { OmitStrict } from "../../utils";
 import { DocumentationPageDataV2 } from "./data/documentation-page-v2";
+import { PageBlockV1 } from "./data";
 
 export const DocumentationPageV2 = DesignElementBase.extend(DesignElementGroupableRequiredPart.shape)
   .extend(DesignElementSlugPart.shape)
   .extend({
     shortPersistentId: z.string(),
-    data: DocumentationPageDataV2,
+    data: DocumentationPageDataV2.extend({
+      oldBlocks: z.array(PageBlockV1).optional(),
+    }),
   });
 
 export type DocumentationPageV2 = z.infer<typeof DocumentationPageV2>;

package/src/dsm/elements/group.ts

@@ -3,7 +3,7 @@ import { DesignElementBase, DesignElementBrandedPart, DesignElementGroupablePart
 import { z } from "zod";
 import { DbCreateInputOmit, DbUpdate } from "../../helpers";
 import { OmitStrict } from "../../utils";
-import { ElementGroupData } from "./data";
+import { ElementGroupDataV2 } from "./data";
 
 export const ElementGroup = DesignElementBase.extend(DesignElementGroupablePart.shape)
   .extend(DesignElementSlugPart.shape)
@@ -11,7 +11,7 @@ export const ElementGroup = DesignElementBase.extend(DesignElementGroupablePart.
   .extend({
     shortPersistentId: z.string().optional(),
     childType: DesignElementType,
-    data: ElementGroupData.optional(),
+    data: ElementGroupDataV2.optional(),
   });
 
 export const BrandedElementGroup = ElementGroup.extend(DesignElementBrandedPart.shape);

package/src/dsm/elements/data/documentation.ts

@@ -1,14 +0,0 @@
-import { z } from "zod";
-import { DocumentationItemHeader, defaultDocumentationItemHeader } from "./item-header";
-
-export const DocumentationItemConfiguration = z.object({
-  showSidebar: z.boolean(),
-  header: DocumentationItemHeader,
-});
-
-export type DocumentationItemConfiguration = z.infer<typeof DocumentationItemConfiguration>;
-
-export const defaultDocumentationItemConfiguration: DocumentationItemConfiguration = {
-  header: defaultDocumentationItemHeader,
-  showSidebar: true,
-};