@supernova-studio/model 0.25.0 → 0.26.0

package/package.json

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

package/src/dsm/data-sources/data-source.ts

@@ -65,9 +65,14 @@ export const DataSourceFigmaRemote = z.object({
   ownerName: z.string(),
   scope: DataSourceFigmaScope,
   state: DataSourceFigmaState,
+  requiresSync: z
+    .boolean()
+    .optional()
+    .transform(v => v ?? false),
   lastImportMetadata: DataSourceFigmaImportMetadata.optional(),
   downloadChunkSize: z.number().optional(),
   figmaRenderChunkSize: z.number().optional(),
+  maxFileDepth: z.number().optional(),
 });
 
 export type DataSourceFigmaFileData = z.infer<typeof DataSourceFigmaFileData>;

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

@@ -0,0 +1,47 @@
+import { z } from "zod";
+import { PageBlockEditorModelV2 } from "../page-block-v2";
+import { PageBlockColorV2 } from "./documentation-block-v2";
+
+export const PageSectionTypeV2 = z.enum(["Tabs"]);
+
+export const PageSectionColumnV2 = z.object({
+  id: z.string(),
+  blocks: z.array(PageBlockEditorModelV2),
+});
+
+export const PageSectionItemV2 = z.object({
+  id: z.string(),
+  title: z.string(),
+  columns: z.array(PageSectionColumnV2),
+});
+
+export const PageSectionPaddingV2 = z.object({
+  top: z.number().optional(),
+  bottom: z.number().optional(),
+  left: z.number().optional(),
+  right: z.number().optional(),
+});
+
+export const PageSectionAppearanceV2 = z.object({
+  expandToEdges: z.boolean(),
+  contentExpandToEdges: z.boolean(),
+  backgroundColor: PageBlockColorV2.optional(),
+  foregroundColor: PageBlockColorV2.optional(),
+  padding: PageSectionPaddingV2.optional(),
+});
+
+export const PageSectionEditorModelV2 = z.object({
+  id: z.string(),
+  type: z.literal("Section"),
+  variantId: z.string().optional(),
+  sectionType: PageSectionTypeV2,
+  appearance: PageSectionAppearanceV2,
+  items: z.array(PageSectionItemV2),
+});
+
+export type PageSectionTypeV2 = z.infer<typeof PageSectionTypeV2>;
+export type PageSectionColumnV2 = z.infer<typeof PageSectionColumnV2>;
+export type PageSectionItemV2 = z.infer<typeof PageSectionItemV2>;
+export type PageSectionPaddingV2 = z.infer<typeof PageSectionPaddingV2>;
+export type PageSectionAppearanceV2 = z.infer<typeof PageSectionAppearanceV2>;
+export type PageSectionEditorModelV2 = z.infer<typeof PageSectionEditorModelV2>;

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

@@ -10,6 +10,7 @@ export * from "./documentation-block-v1";
 export * from "./documentation-block-v2";
 export * from "./documentation-page-v1";
 export * from "./documentation-page-v2";
+export * from "./documentation-section-v2";
 export * from "./documentation-v1";
 export * from "./documentation-v2";
 export * from "./duration";

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

@@ -18,6 +18,7 @@ export type PageBlockV2 = z.infer<typeof PageBlockV2>;
 
 export const PageBlockEditorModelV2 = z.object({
   id: z.string(),
+  type: z.literal("Block"),
   data: PageBlockDataV2,
 });
 

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

@@ -6,6 +6,7 @@ export const FigmaFileDownloadScope = z.object({
   currentVersion: z.literal("__latest__").nullable(),
   publishedVersion: z.string().nullable(),
   downloadChunkSize: z.number().optional(),
+  maxFileDepth: z.number().optional(),
 });
 
 export const FigmaFileAccessData = z.object({

package/src/dsm/import/support/import-context.ts

@@ -45,6 +45,16 @@ export const FigmaImportBaseContext = z.object({
 export type ImportedFigmaSourceData = z.infer<typeof ImportedFigmaSourceData>;
 export type FigmaImportBaseContext = z.infer<typeof FigmaImportBaseContext>;
 
+//
+// Context with source state updates
+//
+
+export const FigmaImportContextWithSourcesState = FigmaImportBaseContext.extend({
+  sourcesWithMissingAccess: z.array(z.string()).default([]),
+});
+
+export type FigmaImportContextWithSourcesState = z.infer<typeof FigmaImportContextWithSourcesState>;
+
 //
 // Context with file download scope
 //
@@ -53,7 +63,7 @@ export const ChangedImportedFigmaSourceData = ImportedFigmaSourceData.extend({
   importMetadata: DataSourceFigmaImportMetadata,
 });
 
-export const FigmaImportContextWithDownloadScopes = FigmaImportBaseContext.extend({
+export const FigmaImportContextWithDownloadScopes = FigmaImportContextWithSourcesState.extend({
   /**
    * Describes what to download from each file, this should contain all file id mentioned in
    * importMetadataBySourceId.

package/src/multiplayer/documentation-page-room.ts

@@ -1,9 +1,13 @@
 import { z } from "zod";
 import { Entity } from "../common/entity";
 import { DbCreateInputOmit, DbUpdate } from "../helpers";
-import { DocumentationPageV2, ElementGroup, PageBlockDataV2, PageBlockDefinition } from "../dsm";
-
-export type PageBlockEditorModel = z.infer<typeof PageBlockEditorModel>;
+import {
+  DocumentationPageV2,
+  ElementGroup,
+  PageBlockDefinition,
+  PageBlockEditorModelV2,
+  PageSectionEditorModelV2,
+} from "../dsm";
 
 export const DocumentationPageRoom = Entity.extend({
   designSystemVersionId: z.string(),
@@ -20,18 +24,13 @@ export type UpdateDocumentationPageRoom = DbUpdate<DocumentationPageRoom>;
 // Room content
 //
 
-export const PageBlockEditorModel = z.object({
-  id: z.string(),
-  data: PageBlockDataV2,
-});
-
 export const DocumentationPageRoomRoomUpdate = z.object({
   page: DocumentationPageV2,
   pageParent: ElementGroup,
 });
 
 export const DocumentationPageRoomInitialState = DocumentationPageRoomRoomUpdate.extend({
-  pageBlocks: z.array(PageBlockEditorModel),
+  pageBlocks: z.array(PageBlockEditorModelV2.or(PageSectionEditorModelV2)),
   blockDefinitions: z.array(PageBlockDefinition),
 });
 

package/src/workspace/npm-registry-settings.ts

@@ -1,30 +1,24 @@
 import { z } from "zod";
 
 export const NpmRegistryAuthType = z.enum(["Basic", "Bearer", "None", "Custom"]);
-const registryTypesWithoutAzure = ["NPMJS", "GitHub", "Artifactory", "Custom"] as const;
-export const NpmRegistryType = z.enum([...registryTypesWithoutAzure, "AzureDevOps"]);
-export const NpmRegistryTypeWithoutAzure = z.enum(registryTypesWithoutAzure);
+export const NpmRegistryType = z.enum(["NPMJS", "GitHub", "AzureDevOps", "Artifactory", "Custom"]);
 
 export const NpmRegistryBasicAuthConfig = z.object({
-  registryType: NpmRegistryType,
   authType: z.literal(NpmRegistryAuthType.Enum.Basic),
   username: z.string(),
   password: z.string(),
 });
 
 export const NpmRegistryBearerAuthConfig = z.object({
-  registryType: NpmRegistryTypeWithoutAzure,
   authType: z.literal(NpmRegistryAuthType.Enum.Bearer),
   accessToken: z.string(),
 });
 
 export const NpmRegistryNoAuthConfig = z.object({
-  registryType: NpmRegistryTypeWithoutAzure,
   authType: z.literal(NpmRegistryAuthType.Enum.None),
 });
 
 export const NpmRegistrCustomAuthConfig = z.object({
-  registryType: NpmRegistryTypeWithoutAzure,
   authType: z.literal(NpmRegistryAuthType.Enum.Custom),
   authHeaderName: z.string(),
   authHeaderValue: z.string(),
@@ -38,6 +32,7 @@ export const NpmRegistryAuthConfig = z.discriminatedUnion("authType", [
 ]);
 
 const NpmRegistryConfigBase = z.object({
+  registryType: NpmRegistryType,
   enabledScopes: z.array(z.string()),
   customRegistryUrl: z.string().optional(),
   bypassProxy: z.boolean().default(false),