@supernova-studio/model 0.28.0 → 0.29.0

package/package.json

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

package/src/codegen/pulsar.ts

@@ -45,9 +45,9 @@ export const PulsarContributionConfigurationProperty = PulsarBaseProperty.extend
 export const PulsarContributionVariant = z.object({
   key: z.string(),
   name: z.string(),
-  isDefault: z.boolean().nullish(),
-  description: z.string().nullish(),
-  thumbnailURL: z.string().nullish(),
+  isDefault: nullishToOptional(z.boolean()),
+  description: nullishToOptional(z.string()),
+  thumbnailURL: nullishToOptional(z.string()),
 });
 
 export const PulsarCustomBlock = z.object({

package/src/dsm/assets/asset-dynamo-record.ts

@@ -0,0 +1,10 @@
+import { z } from "zod";
+
+export const AssetDynamoRecord = z.object({
+  path: z.string(),
+  id: z.string(),
+  designSystemId: z.string(),
+  expiresAt: z.number(),
+});
+
+export type AssetDynamoRecord = z.infer<typeof AssetDynamoRecord>;

package/src/dsm/assets/asset.ts

@@ -9,14 +9,22 @@ export const AssetFontProperties = z.object({
   subfamily: z.string(),
 });
 
-export const AssetProperties = z.object({
-  fontProperties: z.array(AssetFontProperties),
-});
+export const AssetProperties = z.union([
+  z.object({
+    fontProperties: z.array(AssetFontProperties),
+  }),
+  z.object({
+    width: z.number(),
+    height: z.number(),
+  }),
+]);
 
 export const AssetOrigin = z.object({
   originKey: z.string(),
 });
 
+export const AssetProcessStatus = z.enum(["Pending", "Uploaded", "Processed"]);
+
 export const Asset = z.object({
   id: z.string(),
   designSystemId: z.string().nullish(),
@@ -25,6 +33,7 @@ export const Asset = z.object({
   filePath: z.string(),
   scope: AssetScope,
   properties: AssetProperties.nullish(),
+  state: AssetProcessStatus.optional(),
   origin: AssetOrigin.optional(),
   originKey: z.string().optional(),
 });

package/src/dsm/assets/index.ts

@@ -1,3 +1,4 @@
+export * from "./asset-dynamo-record";
 export * from "./asset-reference";
 export * from "./asset-value";
 export * from "./asset";

package/src/dsm/documentation/index.ts

@@ -1,3 +1,6 @@
 export * from "./block-definitions";
 export * from "./group";
+export * from "./link-preview";
+export * from "./page-content-backup";
+export * from "./page-content";
 export * from "./page";

package/src/dsm/documentation/link-preview.ts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+
+export const DocumentationLinkPreview = z.object({
+  title: z.string().optional(),
+  description: z.string().optional(),
+  thumbnailUrl: z.string().optional(),
+});
+
+export type DocumentationLinkPreview = z.infer<typeof DocumentationLinkPreview>;

package/src/dsm/documentation/page-content-backup.ts

@@ -0,0 +1,13 @@
+import { z } from "zod";
+
+export const DocumentationPageContentBackup = z.object({
+  id: z.string(),
+  designSystemVersionId: z.string(),
+  createdAt: z.coerce.date(),
+  updatedAt: z.coerce.date(),
+  documentationPageId: z.string(),
+  documentationPageName: z.string(),
+  storagePath: z.string(),
+});
+
+export type DocumentationPageContentBackup = z.infer<typeof DocumentationPageContentBackup>;

package/src/dsm/documentation/page-content.ts

@@ -0,0 +1,33 @@
+import { z } from "zod";
+import { PageBlockEditorModelV2, PageSectionEditorModelV2 } from "../elements";
+import { DbCreateInputOmit, DbUpdate } from "../../helpers";
+import { OmitStrict } from "../../utils";
+
+export const DocumentationPageContentItem = z.discriminatedUnion("type", [
+  PageBlockEditorModelV2,
+  PageSectionEditorModelV2,
+]);
+
+export const DocumentationPageContentData = z.object({
+  items: z.array(DocumentationPageContentItem),
+});
+
+export const DocumentationPageContent = z.object({
+  id: z.string(),
+  designSystemVersionId: z.string(),
+  createdAt: z.coerce.date(),
+  updatedAt: z.coerce.date(),
+  documentationPageId: z.string(),
+  data: DocumentationPageContentData,
+  isDirty: z.boolean(),
+});
+
+export type DocumentationPageContentItem = z.infer<typeof DocumentationPageContentItem>;
+export type DocumentationPageContentData = z.infer<typeof DocumentationPageContentData>;
+export type DocumentationPageContent = z.infer<typeof DocumentationPageContent>;
+
+export type CreateDocumentationPageContent = DbCreateInputOmit<DocumentationPageContent>;
+export type UpdateDocumentationPageContent = OmitStrict<
+  DbUpdate<DocumentationPageContent>,
+  "designSystemVersionId" | "documentationPageId"
+>;

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

@@ -27,7 +27,6 @@ export * from "./item-header";
 export * from "./letter-spacing";
 export * from "./line-height";
 export * from "./opacity";
-export * from "./page-asset";
 export * from "./paragraph-indent";
 export * from "./paragraph-spacing";
 export * from "./product-copy";

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

@@ -1,5 +1,4 @@
 import { z } from "zod";
-import { DocumentationPageAsset } from "./page-asset";
 import { ColorTokenData } from "./color";
 import {
   DocumentationItemHeaderAlignment,
@@ -7,6 +6,7 @@ import {
   DocumentationItemHeaderImageScaleType,
   DocumentationItemHeaderImageScaleTypeSchema,
 } from "./item-header";
+import { PageBlockAsset } from "./documentation-block-v1";
 
 //
 // Definitions
@@ -17,7 +17,7 @@ export const DocumentationItemHeaderV1 = z.object({
   alignment: DocumentationItemHeaderAlignmentSchema,
   foregroundColor: ColorTokenData.nullish(),
   backgroundColor: ColorTokenData.nullish(),
-  backgroundImageAsset: DocumentationPageAsset.nullish(),
+  backgroundImageAsset: PageBlockAsset.nullish(),
   backgroundImageScaleType: DocumentationItemHeaderImageScaleTypeSchema,
   showBackgroundOverlay: z.boolean(),
   showCoverText: z.boolean(),

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

@@ -1,5 +1,4 @@
 import { z } from "zod";
-import { DocumentationPageAsset } from "./page-asset";
 import {
   DocumentationItemHeaderAlignment,
   DocumentationItemHeaderAlignmentSchema,

package/src/dsm/index.ts

@@ -4,6 +4,7 @@ export * from "./documentation";
 export * from "./elements";
 export * from "./import";
 export * from "./properties";
+export * from "./rooms";
 export * from "./views";
 export * from "./brand";
 export * from "./design-system";

package/src/{multiplayer → dsm/rooms}/design-system-version-room.ts

@@ -1,7 +1,7 @@
 import { z } from "zod";
-import { Entity } from "../common/entity";
-import { DbCreateInputOmit, DbUpdate } from "../helpers";
-import { DocumentationPageV2, ElementGroup } from "../dsm";
+import { Entity } from "../../common/entity";
+import { DbCreateInputOmit, DbUpdate } from "../../helpers";
+import { DocumentationPageV2, ElementGroup } from "..";
 
 export const DesignSystemVersionRoom = Entity.extend({
   designSystemVersionId: z.string(),

package/src/dsm/rooms/documentation-page-room.ts

@@ -0,0 +1,50 @@
+import { z } from "zod";
+import { Entity } from "../../common/entity";
+import { DbCreateInputOmit, DbUpdate } from "../../helpers";
+import {
+  DocumentationItemConfigurationV2,
+  DocumentationPageV2,
+  ElementGroup,
+  PageBlockDefinition,
+  PageBlockEditorModelV2,
+  PageSectionEditorModelV2,
+} from "..";
+import { OmitStrict } from "../../utils";
+
+export const DocumentationPageRoom = Entity.extend({
+  designSystemVersionId: z.string(),
+  documentationPageId: z.string(),
+  liveblocksId: z.string(),
+  isDirty: z.boolean(),
+});
+
+export type DocumentationPageRoom = z.infer<typeof DocumentationPageRoom>;
+
+export type CreateDocumentationPageRoom = DbCreateInputOmit<DocumentationPageRoom>;
+export type UpdateDocumentationPageRoom = OmitStrict<
+  DbUpdate<DocumentationPageRoom>,
+  "designSystemVersionId" | "documentationPageId" | "liveblocksId"
+>;
+
+//
+// Room content
+//
+
+export const DocumentationPageRoomState = z.object({
+  pageItems: z.array(PageBlockEditorModelV2.or(PageSectionEditorModelV2)),
+  itemConfiguration: DocumentationItemConfigurationV2,
+});
+
+export const DocumentationPageRoomRoomUpdate = z.object({
+  page: DocumentationPageV2,
+  pageParent: ElementGroup,
+});
+
+export const DocumentationPageRoomInitialStateUpdate = DocumentationPageRoomRoomUpdate.extend({
+  pageItems: z.array(PageBlockEditorModelV2.or(PageSectionEditorModelV2)),
+  blockDefinitions: z.array(PageBlockDefinition),
+});
+
+export type DocumentationPageRoomState = z.infer<typeof DocumentationPageRoomState>;
+export type DocumentationPageRoomRoomUpdate = z.infer<typeof DocumentationPageRoomRoomUpdate>;
+export type DocumentationPageRoomInitialStateUpdate = z.infer<typeof DocumentationPageRoomInitialStateUpdate>;

package/src/{multiplayer → dsm/rooms}/room-type.ts

@@ -4,6 +4,7 @@ export enum RoomTypeEnum {
   DocumentationPage = "documentation-page",
   DesignSystemVersion = "design-system-version",
 }
+
 export const RoomTypeSchema = z.nativeEnum(RoomTypeEnum);
 
 export type RoomType = z.infer<typeof RoomTypeSchema>;

package/src/index.ts

@@ -8,7 +8,6 @@ export * from "./dsm";
 export * from "./feature-flags";
 export * from "./helpers";
 export * from "./integrations";
-export * from "./multiplayer";
 export * from "./npm";
 export * from "./tokens";
 export * from "./users";

package/src/workspace/workspace-context.ts

@@ -1,11 +1,12 @@
 import { z } from "zod";
 import { ProductCodeSchema } from "../billing";
 import { WorkspaceIpSettings } from "./workspace";
+import { nullishToOptional } from "../helpers";
 
 export const WorkspaceContext = z.object({
   workspaceId: z.string(),
   product: ProductCodeSchema,
-  ipWhitelist: WorkspaceIpSettings,
+  ipWhitelist: nullishToOptional(WorkspaceIpSettings),
   publicDesignSystem: z.boolean().optional(),
 });
 

package/src/workspace/workspace-create.ts

@@ -2,6 +2,9 @@ import { z } from "zod";
 import { UserInvites } from "./user-invite";
 import { BillingIntervalSchema, CardSchema, InternalStatusSchema, ProductCodeSchema } from "../billing";
 import { slugRegex } from "../utils/validation";
+import { SsoProvider } from "./sso-provider";
+import { NpmRegistryConfig } from "./npm-registry-settings";
+import { WorkspaceIpSettings } from "./workspace";
 
 const WORKSPACE_NAME_MIN_LENGTH: number = 2;
 const WORKSPACE_NAME_MAX_LENGTH: number = 64;
@@ -27,6 +30,9 @@ export const CreateWorkspaceInput = z.object({
   seats: z.number().optional(),
   seatLimit: z.number().optional(),
   card: CardSchema.optional(),
+  sso: SsoProvider.optional(),
+  npmRegistrySettings: NpmRegistryConfig.optional(),
+  ipWhitelist: WorkspaceIpSettings.optional(),
 });
 
 export type CreateWorkspaceInput = z.infer<typeof CreateWorkspaceInput>;

package/src/workspace/workspace.ts

@@ -3,21 +3,27 @@ import { Subscription } from "../billing";
 import { SsoProvider } from "./sso-provider";
 import { DesignSystem } from "../dsm";
 import { BillingDetails } from "../billing";
+import IPCIDR from "ip-cidr";
+import { NpmRegistryConfig } from "./npm-registry-settings";
 import { nullishToOptional } from "../helpers";
 
+const isValidCIDR = (value: string) => {
+  return IPCIDR.isValidAddress(value);
+};
+
 export const WorkspaceIpWhitelistEntry = z.object({
   isEnabled: z.boolean(),
   name: z.string(),
-  range: z.string(),
+  range: z.string().refine(isValidCIDR, {
+    message: "Invalid IP CIDR",
+  }),
 });
 
-export const WorkspaceIpSettings = z
-  .object({
-    isEnabledForCloud: z.boolean(),
-    isEnabledForDocs: z.boolean(),
-    entries: z.array(WorkspaceIpWhitelistEntry),
-  })
-  .nullish();
+export const WorkspaceIpSettings = z.object({
+  isEnabledForCloud: z.boolean(),
+  isEnabledForDocs: z.boolean(),
+  entries: z.array(WorkspaceIpWhitelistEntry),
+});
 
 export const WorkspaceProfile = z.object({
   name: z.string(),
@@ -31,9 +37,9 @@ export const Workspace = z.object({
   id: z.string(),
   profile: WorkspaceProfile,
   subscription: Subscription,
-  ipWhitelist: WorkspaceIpSettings,
-  sso: SsoProvider.nullish(),
-  npmRegistrySettings: z.unknown().optional(),
+  ipWhitelist: nullishToOptional(WorkspaceIpSettings),
+  sso: nullishToOptional(SsoProvider),
+  npmRegistrySettings: nullishToOptional(NpmRegistryConfig),
   designSystems: z.array(DesignSystem).nullish(),
 });
 

package/src/dsm/elements/data/page-asset.ts

@@ -1,27 +0,0 @@
-import { z } from "zod";
-import { SafeIdSchema } from "./safe-id";
-import { PageBlockFrame } from "./documentation-block-v1";
-
-export const DocumentationPageAssetType = z.enum(["image", "figmaFrame"]);
-export type DocumentationPageAssetType = z.infer<typeof DocumentationPageAssetType>;
-
-export const DocumentationPageImageAsset = z.object({
-  type: z.literal(DocumentationPageAssetType.Enum.image),
-  url: z.string().optional(),
-  id: SafeIdSchema,
-});
-
-export const DocumentationPageFrameAsset = z.object({
-  type: z.literal(DocumentationPageAssetType.Enum.figmaFrame),
-  url: z.string().optional(),
-  figmaFrame: PageBlockFrame,
-});
-
-export const DocumentationPageAsset = z.discriminatedUnion("type", [
-  DocumentationPageImageAsset,
-  DocumentationPageFrameAsset,
-]);
-
-export type DocumentationPageImageAsset = z.infer<typeof DocumentationPageImageAsset>;
-export type DocumentationPageFrameAsset = z.infer<typeof DocumentationPageFrameAsset>;
-export type DocumentationPageAsset = z.infer<typeof DocumentationPageAsset>;

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

@@ -1,38 +0,0 @@
-import { z } from "zod";
-import { Entity } from "../common/entity";
-import { DbCreateInputOmit, DbUpdate } from "../helpers";
-import {
-  DocumentationPageV2,
-  ElementGroup,
-  PageBlockDefinition,
-  PageBlockEditorModelV2,
-  PageSectionEditorModelV2,
-} from "../dsm";
-
-export const DocumentationPageRoom = Entity.extend({
-  designSystemVersionId: z.string(),
-  documentationPageId: z.string(),
-  liveblocksId: z.string(),
-});
-
-export type DocumentationPageRoom = z.infer<typeof DocumentationPageRoom>;
-
-export type CreateDocumentationPageRoom = DbCreateInputOmit<DocumentationPageRoom>;
-export type UpdateDocumentationPageRoom = DbUpdate<DocumentationPageRoom>;
-
-//
-// Room content
-//
-
-export const DocumentationPageRoomRoomUpdate = z.object({
-  page: DocumentationPageV2,
-  pageParent: ElementGroup,
-});
-
-export const DocumentationPageRoomInitialState = DocumentationPageRoomRoomUpdate.extend({
-  pageBlocks: z.array(PageBlockEditorModelV2.or(PageSectionEditorModelV2)),
-  blockDefinitions: z.array(PageBlockDefinition),
-});
-
-export type DocumentationPageRoomRoomUpdate = z.infer<typeof DocumentationPageRoomRoomUpdate>;
-export type DocumentationPageRoomInitialState = z.infer<typeof DocumentationPageRoomInitialState>;