@supernova-studio/model 0.9.0 → 0.10.0

package/package.json

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

package/src/codegen/export-jobs.ts

@@ -1,26 +1,141 @@
 import { PublishedDocEnvironment } from "../dsm";
 import { z } from "zod";
-export const ExportJobStatus = z.union([
-  z.literal("Success"),
-  z.literal("InProgress"),
-  z.literal("Timeout"),
-  z.literal("Failed"),
-]);
-
-export type ExportJobStatus = z.infer<typeof ExportJobStatus>;
-
-export const ExportJob = z.object({
-  id: z.string(),
-  workspaceId: z.string(),
-  designSystemId: z.string(),
-  designSystemVersionId: z.string(),
-  status: ExportJobStatus,
-  docsUrl: z.string().nullish(),
-  scheduleId: z.string().nullish(),
-  exporterId: z.string().nullish(),
-  createdAt: z.date(),
+
+export const ExporterJobDestination = z.enum(["s3", "webhookUrl", "github", "documentation", "azure", "gitlab"]);
+
+export const ExporterJobStatus = z.enum(["InProgress", "Success", "Failed", "Timeout"]);
+
+export const ExporterJobLogEntryType = z.enum(["success", "info", "warning", "error", "user"]);
+
+export const ExporterJobLogEntry = z.object({
+  id: z.string().optional(),
+  time: z.coerce.date(),
+  type: ExporterJobLogEntryType,
+  message: z.string(),
+});
+
+export const ExporterJobResultPullRequestDestination = z.object({
+  pullRequestUrl: z.string(),
+});
+
+export const ExporterJobResultS3Destination = z.object({
+  bucket: z.string(),
+  urlPrefix: z.string().optional(),
+  path: z.string(),
+  files: z.array(z.string()),
+});
+
+export const ExporterJobResultDocsDestination = z.object({
+  url: z.string(),
+});
+
+export const ExporterJobResult = z.object({
+  error: z.string().optional(),
+  logs: z.array(ExporterJobLogEntry).optional(),
+  s3: ExporterJobResultS3Destination.optional(),
+  github: ExporterJobResultPullRequestDestination.optional(),
+  azure: ExporterJobResultPullRequestDestination.optional(),
+  gitlab: ExporterJobResultPullRequestDestination.optional(),
+  bitbucket: ExporterJobResultPullRequestDestination.optional(),
+  sndocs: ExporterJobResultDocsDestination.optional(),
+});
+
+export const ExporterDestinationSnDocs = z.object({
   environment: PublishedDocEnvironment,
-  finishedAt: z.date().nullish(),
 });
 
-export type ExportJob = z.infer<typeof ExportJob>;
+export const ExporterDestinationS3 = z.object({});
+
+export const ExporterDestinationGithub = z.object({
+  connectionId: z.string(),
+  url: z.string(),
+  branch: z.string(),
+  relativePath: z.string(),
+  // +
+  userId: z.coerce.string(),
+});
+
+export const ExporterDestinationAzure = z.object({
+  connectionId: z.string(),
+  organizationId: z.string(),
+  projectId: z.string(),
+  repositoryId: z.string(),
+  branch: z.string(),
+  relativePath: z.string(),
+  // +
+  userId: z.coerce.string(),
+  url: z.string(),
+});
+
+export const ExporterDestinationGitlab = z.object({
+  connectionId: z.string(),
+  projectId: z.string(),
+  branch: z.string(),
+  relativePath: z.string(),
+  // +
+  userId: z.coerce.string(),
+  url: z.string(),
+});
+
+const BITBUCKET_SLUG = /^[-a-zA-Z0-9~]*$/;
+const BITBUCKET_MAX_LENGTH = 64;
+
+export const ExporterDestinationBitbucket = z.object({
+  connectionId: z.string(),
+  workspaceSlug: z.string().max(BITBUCKET_MAX_LENGTH).regex(BITBUCKET_SLUG),
+  projectKey: z.string().max(BITBUCKET_MAX_LENGTH).regex(BITBUCKET_SLUG),
+  repoSlug: z.string().max(BITBUCKET_MAX_LENGTH).regex(BITBUCKET_SLUG),
+  branch: z.string(),
+  relativePath: z.string(),
+  // +
+  userId: z.coerce.string(),
+  url: z.string(),
+});
+
+export const ExporterJob = z.object({
+  id: z.coerce.string(),
+  createdAt: z.coerce.date(),
+  finishedAt: z.coerce.date().optional(),
+  designSystemId: z.coerce.string(),
+  designSystemVersionId: z.coerce.string(),
+  workspaceId: z.coerce.string(),
+  scheduleId: z.coerce.string().nullish(),
+  exporterId: z.coerce.string(),
+  brandId: z.coerce.string().optional(),
+  themeId: z.coerce.string().optional(),
+  estimatedExecutionTime: z.number().optional(),
+  status: ExporterJobStatus,
+  result: ExporterJobResult.optional(),
+  createdByUserId: z.string().optional(),
+
+  // CodegenDestinationsModel
+  webhookUrl: z.string().optional(),
+  destinationSnDocs: ExporterDestinationSnDocs.optional(),
+  destinationS3: ExporterDestinationS3.optional(),
+  destinationGithub: ExporterDestinationGithub.optional(),
+  destinationAzure: ExporterDestinationAzure.optional(),
+  destinationGitlab: ExporterDestinationGitlab.optional(),
+  destinationBitbucket: ExporterDestinationBitbucket.optional(),
+});
+
+export const ExporterJobFindByFilter = ExporterJob.pick({
+  exporterId: true,
+  designSystemVersionId: true,
+  destinations: true,
+  createdByUserId: true,
+  status: true,
+  scheduleId: true,
+  designSystemId: true,
+  themeId: true,
+  brandId: true,
+})
+  .extend({
+    destinations: z.array(ExporterJobDestination),
+    docsEnvironment: PublishedDocEnvironment,
+  })
+  .partial();
+
+export type ExporterJobDestination = z.infer<typeof ExporterJobDestination>;
+export type ExporterJobStatus = z.infer<typeof ExporterJobStatus>;
+export type ExporterJob = z.infer<typeof ExporterJob>;
+export type ExporterJobFindByFilter = z.infer<typeof ExporterJobFindByFilter>;

package/src/codegen/exporter.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
 import { GitProvider } from "./git-providers";
-import { PulsarContributionBlock, PulsarContributionConfigurationProperty, PulsarContributionVariant } from "./pulsar";
+import { PulsarCustomBlock, PulsarContributionConfigurationProperty, PulsarContributionVariant } from "./pulsar";
 import { nullishToOptional } from "../helpers";
 
 export const ExporterType = z.enum(["code", "documentation"]);
@@ -8,24 +8,23 @@ export const ExporterSource = z.enum(["git", "upload"]);
 export const ExporterTag = z.string().regex(/^[0-9a-zA-Z]+(\s[0-9a-zA-Z]+)*$/);
 
 export const ExporterDetails = z.object({
-  packageId: z.string().max(255),
-  version: z.string(),
   description: z.string(),
+  version: z.string(),
+  routingVersion: nullishToOptional(z.string()),
   author: nullishToOptional(z.string()),
   organization: nullishToOptional(z.string()),
   homepage: nullishToOptional(z.string()),
   readme: nullishToOptional(z.string()),
-  tags: z.array(ExporterTag).default([]),
-
-  routingVersion: nullishToOptional(z.string()),
+  tags: nullishToOptional(z.array(ExporterTag)).default([]),
+  packageId: nullishToOptional(z.string().max(255)),
 
   iconURL: nullishToOptional(z.string()),
-  configurationProperties: z.array(PulsarContributionConfigurationProperty).default([]),
-  customBlocks: z.array(PulsarContributionBlock).default([]),
-  blockVariants: z.record(z.string(), z.array(PulsarContributionVariant)).default({}),
+  configurationProperties: nullishToOptional(z.array(PulsarContributionConfigurationProperty)).default([]),
+  customBlocks: nullishToOptional(z.array(PulsarCustomBlock)).default([]),
+  blockVariants: nullishToOptional(z.record(z.string(), z.array(PulsarContributionVariant))).default({}),
 
-  usesBrands: z.boolean().default(false),
-  usesThemes: z.boolean().default(false),
+  usesBrands: nullishToOptional(z.boolean()).default(false),
+  usesThemes: nullishToOptional(z.boolean()).default(false),
 
   source: ExporterSource,
 
@@ -41,8 +40,8 @@ export const Exporter = z.object({
   name: z.string(),
   isPrivate: z.boolean(),
   details: ExporterDetails,
-  exporterType: ExporterType.default("code"),
-  storagePath: z.string().default(""),
+  exporterType: nullishToOptional(ExporterType).default("code"),
+  storagePath: nullishToOptional(z.string()).default(""),
 });
 
 export type ExporterType = z.infer<typeof ExporterType>;

package/src/codegen/pulsar.ts

@@ -1,13 +1,9 @@
 import { z } from "zod";
+import { nullishToOptional } from "../helpers";
 
-export const PulsarContributionVariant = z.object({
-  key: z.string(),
-  name: z.string(),
-  isDefault: z.boolean().optional(),
-  description: z.string().optional(),
-  thumbnailURL: z.string().optional(),
-});
-export type PulsarContributionVariant = z.infer<typeof PulsarContributionVariant>;
+//
+// Base
+//
 
 export const PulsarPropertyType = z.enum([
   "string",
@@ -22,38 +18,54 @@ export const PulsarPropertyType = z.enum([
   "tokenProperties",
   "tokenType",
 ]);
-export type PulsarPropertyType = z.infer<typeof PulsarPropertyType>;
-
-// export type PulsarPropertyValueType =
-//   | string
-//   | number
-//   | boolean
-//   | PulsarPropertyImageValue
-//   | ColorTokenData // TODO: Should we do smth here? Update Pulsar to get value?!
-//   | TypographyTokenData;
 
-export const BasePulsarProperty = z.object({
+export const PulsarBaseProperty = z.object({
   label: z.string(),
   key: z.string(),
-  description: z.string().optional(),
+  description: z.string().nullish(),
   type: PulsarPropertyType,
-  values: z.array(z.string()).optional(),
+  values: z.array(z.string()).nullish(),
   default: z.union([z.string(), z.boolean(), z.number()]).nullish(), // PulsarPropertyValueType //is optional?
   inputType: z.enum(["code", "plain"]).optional(), //is optional?
-  isMultiline: z.boolean().optional(),
+  isMultiline: z.boolean().nullish(),
+});
+
+//
+// Exporter custom properties
+//
+
+export const PulsarContributionConfigurationProperty = PulsarBaseProperty.extend({
+  category: z.string(),
+});
+
+//
+// Exporter custom blocks
+//
+
+export const PulsarContributionVariant = z.object({
+  key: z.string(),
+  name: z.string(),
+  isDefault: z.boolean().nullish(),
+  description: z.string().nullish(),
+  thumbnailURL: z.string().nullish(),
 });
-export type BasePulsarProperty = z.infer<typeof BasePulsarProperty>;
 
-export const PulsarContributionBlock = z.object({
+export const PulsarCustomBlock = z.object({
   title: z.string(),
   key: z.string(),
   category: z.string(),
-  description: z.string().optional(),
+  description: nullishToOptional(z.string()),
   iconURL: z.string(),
   mode: z.enum(["array", "block"]),
-  properties: z.array(BasePulsarProperty),
+  properties: z.array(PulsarBaseProperty),
 });
-export type PulsarContributionBlock = z.infer<typeof PulsarContributionBlock>;
 
-export const PulsarContributionConfigurationProperty = BasePulsarProperty.extend({ category: z.string() });
+//
+// Types
+//
+
+export type PulsarContributionVariant = z.infer<typeof PulsarContributionVariant>;
+export type PulsarPropertyType = z.infer<typeof PulsarPropertyType>;
+export type PulsarBaseProperty = z.infer<typeof PulsarBaseProperty>;
+export type PulsarCustomBlock = z.infer<typeof PulsarCustomBlock>;
 export type PulsarContributionConfigurationProperty = z.infer<typeof PulsarContributionConfigurationProperty>;

package/src/dsm/design-system.ts

@@ -1,8 +1,10 @@
 import { z } from "zod";
 import { Workspace } from "../workspace";
+import { nullishToOptional } from "../helpers";
+
 export const DesignSystemSwitcher = z.object({
   isEnabled: z.boolean(),
-  designSystemIds: z.string(),
+  designSystemIds: z.array(z.string()),
 });
 
 export const DesignSystem = z.object({
@@ -10,15 +12,15 @@ export const DesignSystem = z.object({
   workspaceId: z.string(),
   name: z.string(),
   description: z.string(),
-  docExporterId: z.string().nullish(),
+  docExporterId: nullishToOptional(z.string()),
   docSlug: z.string(),
-  docUserSlug: z.string().nullish(),
+  docUserSlug: nullishToOptional(z.string()),
   docSlugDeprecated: z.string(),
   isPublic: z.boolean(),
   isMultibrand: z.boolean(),
-  docViewUrl: z.string().nullish(),
+  docViewUrl: nullishToOptional(z.string()),
   basePrefixes: z.array(z.string()),
-  designSystemSwitcher: DesignSystemSwitcher.nullish(),
+  designSystemSwitcher: nullishToOptional(DesignSystemSwitcher),
   createdAt: z.date(),
   updatedAt: z.date(),
 });

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

@@ -22,7 +22,7 @@ export const PageBlockCategory = z.enum([
   "Other",
 ]);
 
-export const PageBlockBehaviorDataType = z.enum(["Item", "Token", "Asset", "Component", "FigmaFrame"]);
+export const PageBlockBehaviorDataType = z.enum(["Item", "Token", "Asset", "Component", "FigmaNode"]);
 export const PageBlockBehaviorSelectionType = z.enum(["Entity", "Group", "EntityAndGroup"]);
 
 export type PageBlockCategory = z.infer<typeof PageBlockCategory>;

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

@@ -60,6 +60,8 @@ export const PageBlockDefinitionTextPropertyStyle = z.enum([
   "SmallSemibold",
 ]);
 
+export const PageBlockDefinitionTextPropertyColor = z.enum(["Neutral", "NeutralFaded"]);
+
 export const PageBlockDefinitionBooleanPropertyStyle = z.enum(["SegmentedControl", "ToggleButton", "Checkbox"]);
 export const PageBlockDefinitionSingleSelectPropertyStyle = z.enum([
   "SegmentedControl",
@@ -69,28 +71,100 @@ export const PageBlockDefinitionSingleSelectPropertyStyle = z.enum([
 ]);
 export const PageBlockDefinitionMultiSelectPropertyStyle = z.enum(["SegmentedControl", "Select", "Checkbox"]);
 
+export const PageBlockDefinitionImageAspectRatio = z.enum(["Auto", "Square", "Landscape", "Portrait", "Wide"]);
+
+export const PageBlockDefinitionImageWidth = z.enum(["Full", "Icon", "Small", "Medium", "Large", "Poster"]);
+
 export type PageBlockDefinitionPropertyType = z.infer<typeof PageBlockDefinitionPropertyType>;
 export type PageBlockDefinitionRichTextPropertyStyle = z.infer<typeof PageBlockDefinitionRichTextPropertyStyle>;
 export type PageBlockDefinitionMultiRichTextPropertyStyle = z.infer<
   typeof PageBlockDefinitionMultiRichTextPropertyStyle
 >;
 export type PageBlockDefinitionTextPropertyStyle = z.infer<typeof PageBlockDefinitionTextPropertyStyle>;
+export type PageBlockDefinitionTextPropertyColor = z.infer<typeof PageBlockDefinitionTextPropertyColor>;
 export type PageBlockDefinitionBooleanPropertyStyle = z.infer<typeof PageBlockDefinitionBooleanPropertyStyle>;
 export type PageBlockDefinitionSingleSelectPropertyStyle = z.infer<typeof PageBlockDefinitionSingleSelectPropertyStyle>;
 export type PageBlockDefinitionMultiSelectPropertyStyle = z.infer<typeof PageBlockDefinitionMultiSelectPropertyStyle>;
+export type PageBlockDefinitionImageAspectRatio = z.infer<typeof PageBlockDefinitionImageAspectRatio>;
+export type PageBlockDefinitionImageWidth = z.infer<typeof PageBlockDefinitionImageWidth>;
 
 //
-// Definitions
+// Aux
+//
+
+export const PageBlockDefinitionSelectChoice = z.object({
+  value: z.string(),
+  name: z.string(),
+  icon: z.string().optional(),
+});
+
+export type PageBlockDefinitionSelectChoice = z.infer<typeof PageBlockDefinitionSelectChoice>;
+
 //
+// Property options
+//
+
+export const PageBlockDefinitionUntypedPropertyOptions = z.record(z.any());
+
+export const PageBlockDefinitionRichTextOptions = z.object({
+  richTextStyle: PageBlockDefinitionRichTextPropertyStyle.optional(),
+});
+
+export const PageBlockDefinitionMutiRichTextOptions = z.object({
+  multiRichTextStyle: PageBlockDefinitionMultiRichTextPropertyStyle.optional(),
+});
 
-export const PageBlockDefinitionPropertyOptions = z
-  .object({
-    richTextStyle: PageBlockDefinitionRichTextPropertyStyle.optional(),
-    multiRichTextStyle: PageBlockDefinitionMultiRichTextPropertyStyle.optional(),
-    textStyle: PageBlockDefinitionTextPropertyStyle.optional(),
-    placeholder: z.string().optional(),
-  })
-  .and(z.record(z.any()));
+export const PageBlockDefinitionTextOptions = z.object({
+  placeholder: z.string().optional(),
+  defaultValue: z.string().optional(),
+  textStyle: PageBlockDefinitionTextPropertyStyle.optional(),
+  color: PageBlockDefinitionTextPropertyColor.optional(),
+});
+
+export const PageBlockDefinitionSelectOptions = z.object({
+  singleSelectStyle: PageBlockDefinitionSingleSelectPropertyStyle.optional(),
+  defaultChoice: z.string(),
+  choices: z.array(PageBlockDefinitionSelectChoice),
+});
+
+export const PageBlockDefinitionImageOptions = z.object({
+  width: PageBlockDefinitionImageWidth.optional(),
+  aspectRatio: PageBlockDefinitionImageAspectRatio.optional(),
+  allowCaption: z.boolean().optional(),
+  recommendation: z.string().optional(),
+});
+
+export const PageBlockDefinitionBooleanOptions = z.object({
+  defaultvalue: z.boolean().optional(),
+  booleanStyle: PageBlockDefinitionBooleanPropertyStyle.optional(),
+});
+
+export const PageBlockDefinitionNumberOptions = z.object({
+  defaultValue: z.number(),
+  min: z.number().optional(),
+  max: z.number().optional(),
+  step: z.number().optional(),
+  placeholder: z.string().optional(),
+});
+
+export const PageBlockDefinitionComponentOptions = z.object({
+  renderLayoutAs: z.enum(["List", "Table"]).optional(),
+  allowPropertySelection: z.boolean().optional(),
+});
+
+export type PageBlockDefinitionUntypedPropertyOptions = z.infer<typeof PageBlockDefinitionUntypedPropertyOptions>;
+export type PageBlockDefinitionRichTextOptions = z.infer<typeof PageBlockDefinitionRichTextOptions>;
+export type PageBlockDefinitionMutiRichTextOptions = z.infer<typeof PageBlockDefinitionMutiRichTextOptions>;
+export type PageBlockDefinitionTextOptions = z.infer<typeof PageBlockDefinitionTextOptions>;
+export type PageBlockDefinitionSelectOptions = z.infer<typeof PageBlockDefinitionSelectOptions>;
+export type PageBlockDefinitionImageOptions = z.infer<typeof PageBlockDefinitionImageOptions>;
+export type PageBlockDefinitionBooleanOptions = z.infer<typeof PageBlockDefinitionBooleanOptions>;
+export type PageBlockDefinitionNumberOptions = z.infer<typeof PageBlockDefinitionNumberOptions>;
+export type PageBlockDefinitionComponentOptions = z.infer<typeof PageBlockDefinitionComponentOptions>;
+
+//
+// Definitions
+//
 
 export const PageBlockDefinitionProperty = z.object({
   id: z.string(),
@@ -98,8 +172,8 @@ export const PageBlockDefinitionProperty = z.object({
   type: PageBlockDefinitionPropertyType,
   description: z.string().optional(),
   // TODO Docs
-  options: PageBlockDefinitionPropertyOptions.optional(),
-  variantOptions: z.record(PageBlockDefinitionPropertyOptions).optional(),
+  options: PageBlockDefinitionUntypedPropertyOptions.optional(),
+  variantOptions: z.record(PageBlockDefinitionUntypedPropertyOptions).optional(),
 });
 
 export const PageBlockDefinitionItem = z.object({
@@ -109,6 +183,5 @@ export const PageBlockDefinitionItem = z.object({
   defaultVariantKey: z.string(),
 });
 
-export type PageBlockDefinitionPropertyOptions = z.infer<typeof PageBlockDefinitionPropertyOptions>;
 export type PageBlockDefinitionProperty = z.infer<typeof PageBlockDefinitionProperty>;
 export type PageBlockDefinitionItem = z.infer<typeof PageBlockDefinitionItem>;

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

@@ -242,6 +242,8 @@ export type PageBlockFrameOrigin = z.infer<typeof PageBlockFrameOrigin>;
 export type PageBlockAsset = z.infer<typeof PageBlockAsset>;
 export type PageBlockTableColumn = z.infer<typeof PageBlockTableColumn>;
 export type PageBlockTheme = z.infer<typeof PageBlockTheme>;
+export type PageBlockShortcut = z.infer<typeof PageBlockShortcut>;
+export type PageBlockCustomBlockPropertyValue = z.infer<typeof PageBlockCustomBlockPropertyValue>;
 
 //
 // Block

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

@@ -9,7 +9,7 @@ import { DesignTokenType } from "../raw-element";
 //
 
 export const PageBlockLinkType = z.enum(["DocumentationItem", "PageHeading", "Url"]);
-export const PageBlockImageType = z.enum(["Upload", "Asset", "FigmaFrame"]);
+export const PageBlockImageType = z.enum(["Upload", "Asset", "FigmaNode"]);
 export const PageBlockImageAlignment = z.enum(["Left", "Center", "Stretch"]);
 export const PageBlockTableCellAlignment = z.enum(["Left", "Center", "Right"]);
 export const PageBlockPreviewContainerSize = z.enum(["Centered", "NaturalHeight"]);
@@ -152,6 +152,24 @@ export const PageBlockItemEmbedValue = z.object({
   height: z.number().optional(),
 });
 
+export const PageBlockItemFigmaNodeValue = z.object({
+  selectedPropertyIds: z.array(z.string()).optional(),
+  showSearch: z.boolean().optional(),
+  previewContainerSize: PageBlockPreviewContainerSize.optional(),
+  backgroundColor: z.string().optional(),
+  value: z.array(
+    z.object({
+      entityId: z.string(),
+      entityMeta: z
+        .object({
+          title: z.string().optional(),
+          description: z.string().optional(),
+        })
+        .optional(),
+    })
+  ),
+});
+
 export const PageBlockItemImageValue = z.object({
   alt: z.string().optional(),
   caption: z.string().optional(),
@@ -238,6 +256,7 @@ export type PageBlockItemComponentValue = z.infer<typeof PageBlockItemComponentV
 export type PageBlockItemComponentPropertyValue = z.infer<typeof PageBlockItemComponentPropertyValue>;
 export type PageBlockItemDividerValue = z.infer<typeof PageBlockItemDividerValue>;
 export type PageBlockItemEmbedValue = z.infer<typeof PageBlockItemEmbedValue>;
+export type PageBlockItemFigmaNodeValue = z.infer<typeof PageBlockItemFigmaNodeValue>;
 export type PageBlockItemImageValue = z.infer<typeof PageBlockItemImageValue>;
 export type PageBlockItemMarkdownValue = z.infer<typeof PageBlockItemMarkdownValue>;
 export type PageBlockItemMultiRichTextValue = z.infer<typeof PageBlockItemMultiRichTextValue>;