@supernova-studio/model 0.48.37 → 0.49.0

package/package.json

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

package/src/dsm/design-system.ts

@@ -21,6 +21,7 @@ export const DesignSystem = z.object({
   docViewUrl: nullishToOptional(z.string()),
   basePrefixes: z.array(z.string()),
   designSystemSwitcher: nullishToOptional(DesignSystemSwitcher),
+  isApprovalFeatureEnabled: z.boolean(),
   createdAt: z.coerce.date(),
   updatedAt: z.coerce.date(),
 });

package/src/dsm/documentation/approvals/approval-state.ts

@@ -0,0 +1,4 @@
+import { z } from "zod";
+
+export const DocumentationPageApprovalState = z.enum(["ReadyForReview", "ChangesRequested", "Approved"]);
+export type DocumentationPageApprovalState = z.infer<typeof DocumentationPageApprovalState>;

package/src/dsm/documentation/approvals/approval.ts

@@ -0,0 +1,17 @@
+import { z } from "zod";
+import { DbCreateInputOmit, DocumentationPageApprovalState } from "../../../";
+
+export const DocumentationPageApproval = z.object({
+  id: z.string(),
+  approvalState: DocumentationPageApprovalState,
+  persistentId: z.string(),
+  pageId: z.string(),
+  pagePersistentId: z.string(),
+  updatedByUserId: z.string(),
+  designSystemVersionId: z.string(),
+  updatedAt: z.coerce.date(),
+  createdAt: z.coerce.date(),
+});
+
+export type CreateDocumentationPageApproval = DbCreateInputOmit<DocumentationPageApproval>;
+export type DocumentationPageApproval = z.infer<typeof DocumentationPageApproval>;

package/src/dsm/documentation/approvals/index.ts

@@ -0,0 +1,2 @@
+export * from "./approval-state";
+export * from "./approval";

package/src/dsm/documentation/index.ts

@@ -1,3 +1,4 @@
+export * from "./approvals";
 export * from "./block-definitions";
 export * from "./group";
 export * from "./link-preview";

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

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

package/src/dsm/elements/component.ts

@@ -30,10 +30,10 @@ export const BaseComponent = DesignElementBase.extend(DesignElementGroupableRequ
   });
 
 export const Component = BaseComponent.extend({
-    svg: ComponentAsset.optional(),
-    isAsset: z.boolean(),
-    componentSetId: z.string().optional(),
-    properties: FigmaComponentProperties.optional(),
+  svg: ComponentAsset.optional(),
+  isAsset: z.boolean(),
+  componentSetId: z.string().optional(),
+  properties: FigmaComponentProperties.optional(),
 });
 
 export type ComponentAsset = z.infer<typeof ComponentAsset>;

package/src/liveblocks/rooms/design-system-version-room.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
 import { Entity } from "../../common/entity";
-import { DocumentationPageSnapshot, ElementGroupSnapshot } from "../../dsm";
+import { DocumentationPageApproval, DocumentationPageSnapshot, ElementGroupSnapshot } from "../../dsm";
 import { DocumentationPageV2 } from "../../dsm/elements/documentation-page-v2";
 import { ElementGroup } from "../../dsm/elements/group";
 import { DbCreateInputOmit, DbUpdate } from "../../helpers";
@@ -26,6 +26,7 @@ export type UpdateDesignSystemVersionRoom = DbUpdate<DesignSystemVersionRoom>;
 export const DesignSystemVersionRoomInternalSettings = z.object({
   routingVersion: z.string(),
   isDraftFeatureAdopted: z.boolean(),
+  isApprovalFeatureEnabled: z.boolean(),
 });
 
 export const DesignSystemVersionRoomInitialState = z.object({
@@ -35,6 +36,7 @@ export const DesignSystemVersionRoomInitialState = z.object({
   pageSnapshots: z.array(DocumentationPageSnapshot),
   groupSnapshots: z.array(ElementGroupSnapshot),
 
+  pageApprovals: z.array(DocumentationPageApproval),
   internalSettings: DesignSystemVersionRoomInternalSettings,
 });
 
@@ -49,6 +51,9 @@ export const DesignSystemVersionRoomUpdate = z.object({
   pageSnapshotIdsToDelete: z.array(z.string()),
   groupSnapshotIdsToDelete: z.array(z.string()),
   pageHashesToUpdate: z.record(z.string(), z.string()),
+
+  pageApprovals: z.array(DocumentationPageApproval),
+  pageApprovalIdsToDelete: z.array(z.string()),
 });
 
 export type DesignSystemVersionRoomInternalSettings = z.infer<typeof DesignSystemVersionRoomInternalSettings>;