@supernova-studio/model 0.47.43 → 0.47.44

package/package.json

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

package/src/dsm/element-snapshots/base.ts

@@ -0,0 +1,13 @@
+import { z } from "zod";
+
+export const DesignElementSnapshotReason = z.enum(["Publish", "Deletion"]);
+
+export const DesignElementSnapshotBase = z.object({
+  id: z.string(),
+  designSystemVersionId: z.string(),
+  createdAt: z.coerce.date(),
+  updatedAt: z.coerce.date(),
+  reason: DesignElementSnapshotReason,
+});
+
+export type DesignElementSnapshotReason = z.infer<typeof DesignElementSnapshotReason>;

package/src/dsm/element-snapshots/documentation-page-snapshot.ts

@@ -0,0 +1,20 @@
+import { z } from "zod";
+import { DbCreateInputOmit, DbUpdate } from "../../helpers";
+import { OmitStrict } from "../../utils";
+import { DocumentationPageV2 } from "../elements";
+import { DesignElementSnapshotBase } from "./base";
+
+/**
+ * Snapshot of a documentation page.
+ *
+ * Please note that existence of snapshot's references (including parent persistent id) is not guaranteed.
+ */
+export const DocumentationPageSnapshot = DesignElementSnapshotBase.extend({
+  page: DocumentationPageV2,
+  pageContentHash: z.string(),
+});
+
+export type DocumentationPageSnapshot = z.infer<typeof DocumentationPageSnapshot>;
+
+export type CreateDocumentationPageSnapshot = DbCreateInputOmit<DocumentationPageSnapshot>;
+export type UpdateDocumentationPageSnapshot = OmitStrict<DbUpdate<DocumentationPageSnapshot>, "designSystemVersionId">;

package/src/dsm/element-snapshots/group-snapshot.ts

@@ -0,0 +1,19 @@
+import { z } from "zod";
+import { DbCreateInputOmit, DbUpdate } from "../../helpers";
+import { OmitStrict } from "../../utils";
+import { ElementGroup } from "../elements";
+import { DesignElementSnapshotBase } from "./base";
+
+/**
+ * Snapshot of an element group.
+ *
+ * Please note that existence of snapshot's references (including parent persistent id) is not guaranteed.
+ */
+export const ElementGroupSnapshot = DesignElementSnapshotBase.extend({
+  group: ElementGroup,
+});
+
+export type ElementGroupSnapshot = z.infer<typeof ElementGroupSnapshot>;
+
+export type CreateElementGroupSnapshot = DbCreateInputOmit<ElementGroupSnapshot>;
+export type UpdateElementGroupSnapshot = OmitStrict<DbUpdate<ElementGroupSnapshot>, "designSystemVersionId">;

package/src/dsm/element-snapshots/index.ts

@@ -0,0 +1,3 @@
+export * from "./base";
+export * from "./documentation-page-snapshot";
+export * from "./group-snapshot";

package/src/dsm/elements/index.ts

@@ -4,7 +4,6 @@ export * from "./base";
 export * from "./component";
 export * from "./documentation-page-v1";
 export * from "./documentation-page-v2";
-export * from "./element-snapshot";
 export * from "./figma-file-structures";
 export * from "./figma-node-reference";
 export * from "./group";

package/src/dsm/index.ts

@@ -1,6 +1,7 @@
 export * from "./assets";
 export * from "./data-sources";
 export * from "./documentation";
+export * from "./element-snapshots";
 export * from "./elements";
 export * from "./import";
 export * from "./properties";

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

@@ -1,7 +1,6 @@
 import { z } from "zod";
 import { Entity } from "../../common/entity";
 import { DocumentationPageV2 } from "../../dsm/elements/documentation-page-v2";
-import { DesignElementSnapshot } from "../../dsm/elements/element-snapshot";
 import { ElementGroup } from "../../dsm/elements/group";
 import { DbCreateInputOmit, DbUpdate } from "../../helpers";
 
@@ -31,14 +30,14 @@ export const DesignSystemVersionRoomInternalSettings = z.object({
 export const DesignSystemVersionRoomInitialState = z.object({
   pages: z.array(DocumentationPageV2),
   groups: z.array(ElementGroup),
-  documentationPublishedState: z.array(DesignElementSnapshot),
+
   internalSettings: DesignSystemVersionRoomInternalSettings,
 });
 
 export const DesignSystemVersionRoomUpdate = z.object({
   pages: z.array(DocumentationPageV2),
   groups: z.array(ElementGroup),
-  documentationPublishedState: z.array(DesignElementSnapshot),
+
   deletedPageIds: z.array(z.string()),
   deletedGroupIds: z.array(z.string()),
 });

package/src/dsm/elements/element-snapshot.ts

@@ -1,27 +0,0 @@
-import { z } from "zod";
-import { DesignElementType } from "./raw-element";
-
-export const DesignElementSnapshot = z.object({
-  id: z.string(),
-
-  // Scope
-  designSystemVersionId: z.string(),
-
-  // Metadata about the element that needs to be indexed in the db
-  elementId: z.string(),
-  elementType: DesignElementType,
-  elementPersistentId: z.string(),
-  elementParentPersistentId: z.string(),
-  elementName: z.string(),
-
-  // Computed hash to compare to current state of the element
-  hash: z.string(),
-
-  // Where is the element's full shapshot stored
-  storageKey: z.string(),
-
-  // When the element was snapshotted
-  createdAt: z.coerce.date(),
-});
-
-export type DesignElementSnapshot = z.infer<typeof DesignElementSnapshot>;