@supernova-studio/model 0.52.11 → 0.52.13

package/package.json

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

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

@@ -49,7 +49,15 @@ export const PageBlockDefinitionRichTextPropertyStyle = z.enum([
 
 export const PageBlockDefinitionMultiRichTextPropertyStyle = z.enum(["OL", "UL", "Default"]);
 
-export const PageBlockDefinitionRichTextEditorPropertyStyle = z.enum(["OL", "UL", "Bold","Italic","Link","Strikethrough", "InlineCode"]);
+export const PageBlockDefinitionRichTextEditorPropertyStyle = z.enum([
+  "OL",
+  "UL",
+  "Bold",
+  "Italic",
+  "Link",
+  "Strikethrough",
+  "InlineCode",
+]);
 
 export const PageBlockDefinitionTextPropertyStyle = z.enum([
   "Title1",
@@ -91,11 +99,7 @@ export const PageBlockDefinitionSingleSelectPropertyColor = z.enum([
   "Fuchsia",
 ]);
 
-export const IconSet = z.enum([
-  "CheckCircle",
-  "CrossCircle",
-  "Alert",
-]);
+export const IconSet = z.enum(["CheckCircle", "CrossCircle", "Alert"]);
 
 export const PageBlockDefinitionMultiSelectPropertyStyle = z.enum(["SegmentedControl", "Select", "Checkbox"]);
 

package/src/dsm/elements/component-properties.ts

@@ -4,34 +4,38 @@ export const FigmaComponentPropertyType = z.enum(["Boolean", "InstanceSwap", "Va
 
 export const FigmaComponentBooleanProperty = z.object({
   type: z.literal(FigmaComponentPropertyType.enum.Boolean),
-  value: z.boolean(),
   defaultValue: z.boolean(),
 });
 
 export const FigmaComponentInstanceSwapProperty = z.object({
   type: z.literal(FigmaComponentPropertyType.enum.InstanceSwap),
-  value: z.string(), // Persistent ID of a Component to swap??
+  defaultValue: z.string(),
+  preferredValues: z
+    .object({
+      type: z.enum(["Component", "ComponentSet"]),
+      key: z.string(),
+    })
+    .array(),
 });
 
 export const FigmaComponentVariantProperty = z.object({
   type: z.literal(FigmaComponentPropertyType.enum.Variant),
-  value: z.string(),
+  defaultValue: z.string(),
   options: z.array(z.string()),
 });
 
 export const FigmaComponentTextProperty = z.object({
   type: z.literal(FigmaComponentPropertyType.enum.Text),
-  value: z.string(),
+  defaultValue: z.string(),
 });
 
-export const FigmaComponentProperties = z.record(
-  z.string(),
-  z.discriminatedUnion("type", [
-    FigmaComponentBooleanProperty,
-    FigmaComponentInstanceSwapProperty,
-    FigmaComponentTextProperty,
-  ])
-);
+export const FigmaComponentProperty = z.discriminatedUnion("type", [
+  FigmaComponentBooleanProperty,
+  FigmaComponentInstanceSwapProperty,
+  FigmaComponentTextProperty,
+]);
+
+export const FigmaComponentPropertyMap = z.record(z.string(), FigmaComponentProperty);
 
 export const FigmaComponentSetProperties = z.record(
   z.string(),
@@ -48,5 +52,6 @@ export type FigmaComponentBooleanProperty = z.infer<typeof FigmaComponentBoolean
 export type FigmaComponentInstanceSwapProperty = z.infer<typeof FigmaComponentInstanceSwapProperty>;
 export type FigmaComponentVariantProperty = z.infer<typeof FigmaComponentVariantProperty>;
 export type FigmaComponentTextProperty = z.infer<typeof FigmaComponentTextProperty>;
-export type FigmaComponentProperties = z.infer<typeof FigmaComponentProperties>;
+export type FigmaComponentProperty = z.infer<typeof FigmaComponentProperty>;
+export type FigmaComponentPropertyMap = z.infer<typeof FigmaComponentPropertyMap>;
 export type FigmaComponentSetProperties = z.infer<typeof FigmaComponentSetProperties>;

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

@@ -1,4 +1,6 @@
 import { z } from "zod";
+import { nullishToOptional } from "../../../helpers/nullish-to-optional";
+import { FigmaComponentPropertyMap } from "../component-properties";
 
 export const ComponentElementData = z.object({
   value: z.object({
@@ -17,6 +19,9 @@ export const ComponentElementData = z.object({
         }),
       })
       .optional(),
+
+    parentComponentPersistentId: nullishToOptional(z.string()),
+    componentPropertyDefinitions: nullishToOptional(FigmaComponentPropertyMap),
   }),
 });
 

package/src/dsm/elements/figma-component.ts

@@ -0,0 +1,53 @@
+import { z } from "zod";
+import { DbCreateInputOmit, DbUpdate, nullishToOptional } from "../../helpers";
+import { OmitStrict } from "../../utils";
+import {
+  DesignElementBase,
+  DesignElementBrandedPart,
+  DesignElementGroupableRequiredPart,
+  DesignElementOrigin,
+} from "./base";
+import { FigmaComponentPropertyMap } from "./component-properties";
+
+export const FigmaComponentOriginPart = z.object({
+  nodeId: z.string().optional(),
+  width: z.number().optional(),
+  height: z.number().optional(),
+});
+
+const FigmaComponentAsset = z.object({
+  assetId: z.string(),
+  assetPath: z.string(),
+});
+
+export const FigmaComponentOrigin = DesignElementOrigin.extend(FigmaComponentOriginPart.shape);
+
+export const FigmaComponent = DesignElementBase.extend(DesignElementGroupableRequiredPart.shape)
+  .extend(DesignElementBrandedPart.shape)
+  .extend({
+    origin: FigmaComponentOrigin.optional(),
+    thumbnail: FigmaComponentAsset,
+    componentPropertyDefinitions: FigmaComponentPropertyMap.optional(),
+
+    svg: FigmaComponentAsset.optional(),
+    isAsset: z.boolean(),
+    parentComponentPersistentId: nullishToOptional(z.string()),
+  });
+
+export type FigmaComponentAsset = z.infer<typeof FigmaComponentAsset>;
+export type FigmaComponent = z.infer<typeof FigmaComponent>;
+export type FigmaComponentOrigin = z.infer<typeof FigmaComponentOrigin>;
+export type ImportedFigmaComponent = OmitStrict<FigmaComponent, "origin"> & { origin: FigmaComponentOrigin };
+
+export function isImportedFigmaComponent(component: FigmaComponent): component is ImportedFigmaComponent {
+  return !!component.origin;
+}
+
+export type CreateFigmaComponent = DbCreateInputOmit<FigmaComponent>;
+export type UpdateFigmaComponent = OmitStrict<DbUpdate<FigmaComponent>, "brandPersistentId" | "designSystemVersionId">;
+
+export type FigmaComponentDiff = {
+  toCreate: CreateFigmaComponent[];
+  toUpdate: UpdateFigmaComponent[];
+  toDelete: FigmaComponent["id"][];
+};

package/src/dsm/elements/index.ts

@@ -2,10 +2,9 @@ export * from "./data";
 export * from "./primitives";
 export * from "./base";
 export * from "./component-properties";
-export * from "./component-set";
-export * from "./component";
 export * from "./documentation-page-v1";
 export * from "./documentation-page-v2";
+export * from "./figma-component";
 export * from "./figma-file-structures";
 export * from "./figma-node-reference";
 export * from "./group";

package/src/dsm/import/asset.ts

@@ -1,6 +1,6 @@
-import { ComponentImportModelInput } from "./component";
+import { FigmaComponentImportModelInput } from "./component";
 import { FigmaSvgRenderImportModel } from "./image";
 
-export type AssetImportModel = ComponentImportModelInput & {
+export type AssetImportModel = FigmaComponentImportModelInput & {
   svg: FigmaSvgRenderImportModel;
 };

package/src/dsm/import/component.ts

@@ -1,36 +1,38 @@
-import { FigmaSvgRenderImportModel, ImageImportModel } from "./image";
-import { ComponentOrigin, ComponentOriginPart } from "../elements";
 import { z } from "zod";
+import { FigmaComponentOrigin, FigmaComponentOriginPart, FigmaComponentPropertyMap } from "../elements";
 import { ImportModelBase, ImportModelInputBase } from "./base";
+import { FigmaSvgRenderImportModel, ImageImportModel } from "./image";
 
 //
 // Import model
 //
 
-const ComponentImportModelPart = z.object({
+const FigmaComponentImportModelPart = z.object({
   thumbnail: ImageImportModel,
+  parentComponentId: z.string().optional(),
+  componentPropertyDefinitions: FigmaComponentPropertyMap.optional(),
 });
 
-export const ComponentImportModel = ImportModelBase.extend(ComponentImportModelPart.shape).extend({
+export const FigmaComponentImportModel = ImportModelBase.extend(FigmaComponentImportModelPart.shape).extend({
   isAsset: z.boolean(),
   svg: FigmaSvgRenderImportModel.optional(),
-  origin: ComponentOrigin,
+  origin: FigmaComponentOrigin,
 });
 
-export type ComponentImportModel = z.infer<typeof ComponentImportModel>;
+export type FigmaComponentImportModel = z.infer<typeof FigmaComponentImportModel>;
 
 //
 // Import model input
 //
 
-export const ComponentImportModelInput = ImportModelInputBase.extend(ComponentImportModelPart.shape).extend({
-  originMetadata: ComponentOriginPart,
+export const FigmaComponentImportModelInput = ImportModelInputBase.extend(FigmaComponentImportModelPart.shape).extend({
+  originMetadata: FigmaComponentOriginPart,
 });
 
-export const AssetImportModelInput = ImportModelInputBase.extend(ComponentImportModelPart.shape).extend({
+export const AssetImportModelInput = ImportModelInputBase.extend(FigmaComponentImportModelPart.shape).extend({
   svg: FigmaSvgRenderImportModel,
-  originMetadata: ComponentOriginPart,
+  originMetadata: FigmaComponentOriginPart,
 });
 
-export type ComponentImportModelInput = z.infer<typeof ComponentImportModelInput>;
+export type FigmaComponentImportModelInput = z.infer<typeof FigmaComponentImportModelInput>;
 export type AssetImportModelInput = z.infer<typeof AssetImportModelInput>;

package/src/dsm/import/support/figma-files.ts

@@ -3,6 +3,7 @@ import { z } from "zod";
 export const FigmaFileDownloadScope = z.object({
   styles: z.boolean(),
   components: z.boolean(),
+  componentSets: z.boolean(),
   currentVersion: z.literal("__latest__").nullable(),
   publishedVersion: z.string().nullable(),
   downloadChunkSize: z.number().optional(),

package/src/dsm/import/support/import-model-collections.ts

@@ -1,9 +1,9 @@
 import { z } from "zod";
-import { AssetImportModelInput, ComponentImportModel, ComponentImportModelInput } from "../component";
+import { AssetImportModelInput, FigmaComponentImportModel, FigmaComponentImportModelInput } from "../component";
+import { DataSourceImportModel } from "../data-source";
+import { FigmaFileStructureImportModel, FigmaFileStructureImportModelInput } from "../figma-frames";
 import { ThemeImportModel, ThemeImportModelInput, ThemeUpdateImportModel, ThemeUpdateImportModelInput } from "../theme";
 import { DesignTokenImportModel, DesignTokenImportModelInput } from "../tokens";
-import { FigmaFileStructureImportModel, FigmaFileStructureImportModelInput } from "../figma-frames";
-import { DataSourceImportModel } from "../data-source";
 
 //
 // Collections
@@ -12,7 +12,7 @@ import { DataSourceImportModel } from "../data-source";
 export const ImportModelInputCollection = z.object({
   source: DataSourceImportModel,
   tokens: z.array(DesignTokenImportModelInput).default([]),
-  components: z.array(ComponentImportModelInput).default([]),
+  components: z.array(FigmaComponentImportModelInput).default([]),
   assets: z.array(AssetImportModelInput).default([]),
   themeUpdates: z.array(ThemeUpdateImportModelInput).default([]),
   themes: z.array(ThemeImportModelInput).default([]),
@@ -22,7 +22,7 @@ export const ImportModelInputCollection = z.object({
 export const ImportModelCollection = z.object({
   sources: z.array(DataSourceImportModel),
   tokens: z.array(DesignTokenImportModel).default([]),
-  components: z.array(ComponentImportModel).default([]),
+  components: z.array(FigmaComponentImportModel).default([]),
   themeUpdates: z.array(ThemeUpdateImportModel).default([]),
   themes: z.array(ThemeImportModel).default([]),
   figmaFileStructures: z.array(FigmaFileStructureImportModel),

package/src/dsm/version.ts

@@ -5,7 +5,7 @@ import { OmitStrict } from "../utils";
 export const DesignSystemVersion = z.object({
   id: z.string(),
   version: z.string(),
-  createdAt: z.date(),
+  createdAt: z.coerce.date(),
   designSystemId: z.string(),
   name: z.string(),
   comment: z.string(),

package/src/dsm/elements/component-set.ts

@@ -1,9 +0,0 @@
-import { BaseComponent } from "./component";
-import { FigmaComponentSetProperties } from "./component-properties";
-import { z } from "zod";
-
-export const ComponentSet = BaseComponent.extend({
-  properties: FigmaComponentSetProperties,
-});
-
-export type ComponentSet = z.infer<typeof ComponentSet>;

package/src/dsm/elements/component.ts

@@ -1,55 +0,0 @@
-import { DbCreateInputOmit, DbUpdate } from "../../helpers";
-import { OmitStrict } from "../../utils";
-import { z } from "zod";
-import {
-  DesignElementBase,
-  DesignElementBrandedPart,
-  DesignElementGroupableRequiredPart,
-  DesignElementOrigin,
-} from "./base";
-import { FigmaComponentProperties, FigmaComponentSetProperties } from "./component-properties";
-
-export const ComponentOriginPart = z.object({
-  nodeId: z.string().optional(),
-  width: z.number().optional(),
-  height: z.number().optional(),
-});
-
-const ComponentAsset = z.object({
-  assetId: z.string(),
-  assetPath: z.string(),
-});
-
-export const ComponentOrigin = DesignElementOrigin.extend(ComponentOriginPart.shape);
-
-export const BaseComponent = DesignElementBase.extend(DesignElementGroupableRequiredPart.shape)
-  .extend(DesignElementBrandedPart.shape)
-  .extend({
-    origin: ComponentOrigin.optional(),
-    thumbnail: ComponentAsset,
-  });
-
-export const Component = BaseComponent.extend({
-  svg: ComponentAsset.optional(),
-  isAsset: z.boolean(),
-  componentSetId: z.string().optional(),
-  properties: FigmaComponentProperties.optional(),
-});
-
-export type ComponentAsset = z.infer<typeof ComponentAsset>;
-export type Component = z.infer<typeof Component>;
-export type ComponentOrigin = z.infer<typeof ComponentOrigin>;
-export type ImportedComponent = OmitStrict<Component, "origin"> & { origin: ComponentOrigin };
-
-export function isImportedComponent(component: Component): component is ImportedComponent {
-  return !!component.origin;
-}
-
-export type CreateComponent = DbCreateInputOmit<Component>;
-export type UpdateComponent = OmitStrict<DbUpdate<Component>, "brandPersistentId" | "designSystemVersionId">;
-
-export type ComponentDiff = {
-  toCreate: CreateComponent[];
-  toUpdate: UpdateComponent[];
-  toDelete: Component["id"][];
-};