@supernova-studio/client 0.47.42 → 0.47.44

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supernova-studio/client",
-  "version": "0.47.42",
+  "version": "0.47.44",
   "description": "Supernova Data Models",
   "source": "src/index.ts",
   "main": "dist/index.js",

package/src/api/conversion/documentation/documentation-group-v2-to-dto.ts

@@ -5,7 +5,7 @@ import {
   ElementGroup,
   groupBy,
 } from "@supernova-studio/model";
-import { DTODocumentationGroupStructureV2, DTODocumentationGroupV2 } from "../../dto";
+import { DTODocumentationGroupV2 } from "../../dto";
 import {
   documentationItemConfigurationToDTOV2,
   getDtoDefaultItemConfigurationV2,
@@ -18,15 +18,6 @@ import { applyPrivacyConfigurationToNestedItems } from "./documentation-page-to-
 //
 // Please do not put more DTO conversion here unless you know what you're doing.
 
-export function elementGroupsToDocumentationGroupStructureDTOV2(
-  groups: ElementGroup[],
-  pages: (DocumentationPageV1 | DocumentationPageV2)[]
-): DTODocumentationGroupStructureV2[] {
-  const childrenIdsMap = calculateChildrenIdsMapV2(pages, groups);
-
-  return groups.map(group => elementGroupToDocumentationGroupStructureDTOV2(group, childrenIdsMap));
-}
-
 export function elementGroupsToDocumentationGroupDTOV2(
   groups: ElementGroup[],
   pages: (DocumentationPageV1 | DocumentationPageV2)[]
@@ -54,7 +45,7 @@ export function elementGroupsToDocumentationGroupFixedConfigurationDTOV2(
 function elementGroupToDocumentationGroupStructureDTOV2(
   group: ElementGroup,
   childrenIdsMap: Map<string, string[]>
-): DTODocumentationGroupStructureV2 {
+): DTODocumentationGroupV2 {
   const childrenIds = childrenIdsMap.get(group.persistentId) ?? [];
 
   if (!group.shortPersistentId) {

package/src/api/conversion/documentation/documentation-page-v2-to-dto.ts

@@ -1,10 +1,10 @@
 import { DocumentationItemConfigurationV2, DocumentationPageV2, ElementGroup } from "@supernova-studio/model";
-import { DTODocumentationPageStructureV2, DTODocumentationPageV2 } from "../../dto";
+import { DTODocumentationPageV2 } from "../../dto";
 import {
   documentationItemConfigurationToDTOV2,
   getDtoDefaultItemConfigurationV2,
 } from "./documentation-item-configuration-v2-to-dto";
-import { buildDocPagePublishPaths, applyPrivacyConfigurationToNestedItems } from "./documentation-page-to-dto-utils";
+import { applyPrivacyConfigurationToNestedItems, buildDocPagePublishPaths } from "./documentation-page-to-dto-utils";
 
 // The fact that DTO conversion is located here instead of main backend code is due to the fact
 // that we store page and group data in YJS documents in the same way as they are stored in the database.
@@ -12,13 +12,13 @@ import { buildDocPagePublishPaths, applyPrivacyConfigurationToNestedItems } from
 //
 // Please do not put more DTO conversion here unless you know what you're doing.
 
-export function documentationPagesToStructureDTOV2(
-  pages: DocumentationPageV2[],
+export function documentationPageToDTOV2(
+  page: DocumentationPageV2,
   groups: ElementGroup[],
   routingVersion: string
-): DTODocumentationPageStructureV2[] {
-  const pathsMap = buildDocPagePublishPaths(groups, pages, routingVersion);
-  return pages.map(page => documentationPageToStructureDTOV2(page, pathsMap));
+): DTODocumentationPageV2 {
+  const pathsMap = buildDocPagePublishPaths(groups, [page], routingVersion);
+  return _documentationPageToDTOV2(page, pathsMap);
 }
 
 export function documentationPagesToDTOV2(
@@ -27,8 +27,7 @@ export function documentationPagesToDTOV2(
   routingVersion: string
 ): DTODocumentationPageV2[] {
   const pathsMap = buildDocPagePublishPaths(groups, pages, routingVersion);
-
-  return pages.map(page => documentationPageToStructureDTOV2(page, pathsMap));
+  return pages.map(page => _documentationPageToDTOV2(page, pathsMap));
 }
 
 export function documentationPagesFixedConfigurationToDTOV2(
@@ -44,13 +43,13 @@ export function documentationPagesFixedConfigurationToDTOV2(
     DocumentationItemConfigurationV2
   >(pages, groups, getDtoDefaultItemConfigurationV2);
 
-  return fixedPages.map(page => documentationPageToStructureDTOV2(page, pathsMap));
+  return fixedPages.map(page => _documentationPageToDTOV2(page, pathsMap));
 }
 
-function documentationPageToStructureDTOV2(
+function _documentationPageToDTOV2(
   page: DocumentationPageV2,
   pagePathMap: Map<string, string>
-): DTODocumentationPageStructureV2 {
+): DTODocumentationPageV2 {
   let path = pagePathMap.get(page.persistentId);
   if (!path) throw new Error(`Path for page ${page.id} was not calculated`);
 

package/src/api/conversion/documentation/index.ts

@@ -1,4 +1,3 @@
-export * from "./documentation-elements-to-hierarchy-v2-dto";
 export * from "./documentation-group-v1-to-dto";
 export * from "./documentation-group-v2-to-dto";
 export * from "./documentation-item-configuration-v1-to-dto";

package/src/api/dto/documentation/documentation-page-snapshot.ts

@@ -0,0 +1,18 @@
+import { DesignElementSnapshotReason } from "@supernova-studio/model";
+import { z } from "zod";
+import { DTODocumentationPageV2 } from "../elements/documentation/page-v2";
+
+export const DTODocumentationPageSnapshot = z.object({
+  id: z.string(),
+  designSystemVersionId: z.string(),
+
+  createdAt: z.string(),
+  updatedAt: z.string(),
+
+  documentationPage: DTODocumentationPageV2,
+  pageContentHash: z.string(),
+
+  reason: DesignElementSnapshotReason,
+});
+
+export type DTODocumentationPageSnapshot = z.infer<typeof DTODocumentationPageSnapshot>;

package/src/api/dto/documentation/index.ts

@@ -1,2 +1,3 @@
 export * from "./anchor";
+export * from "./documentation-page-snapshot";
 export * from "./link-preview";

package/src/api/dto/elements/documentation/draft-state.ts

@@ -0,0 +1,35 @@
+import { z } from "zod";
+import { DTODocumentationItemConfigurationV2 } from "./item-configuration-v2";
+
+export const DTODocumentationDraftChangeType = z.enum(["Created", "Updated", "Deleted"]);
+
+export const DTODocumentationDraftStateCreated = z.object({
+  changeType: z.literal(DTODocumentationDraftChangeType.enum.Created),
+});
+
+export const DTODocumentationDraftStateUpdated = z.object({
+  changeType: z.literal(DTODocumentationDraftChangeType.enum.Updated),
+  changes: z.object({
+    previousTitle: z.string().optional(),
+    previousConfiguration: DTODocumentationItemConfigurationV2.optional(),
+    previousContentHash: z.string().optional(),
+  }),
+});
+
+export const DTODocumentationDraftStateDeleted = z.object({
+  changeType: z.literal(DTODocumentationDraftChangeType.enum.Deleted),
+});
+
+export const DTODocumentationDraftState = z.discriminatedUnion("changeType", [
+  DTODocumentationDraftStateCreated,
+  DTODocumentationDraftStateUpdated,
+  DTODocumentationDraftStateDeleted,
+]);
+
+export type DTODocumentationDraftChangeType = z.infer<typeof DTODocumentationDraftChangeType>;
+
+export type DTODocumentationDraftStateCreated = z.infer<typeof DTODocumentationDraftStateCreated>;
+export type DTODocumentationDraftStateUpdated = z.infer<typeof DTODocumentationDraftStateUpdated>;
+export type DTODocumentationDraftStateDeleted = z.infer<typeof DTODocumentationDraftStateDeleted>;
+
+export type DTODocumentationDraftState = z.infer<typeof DTODocumentationDraftState>;

package/src/api/dto/elements/documentation/group-v2.ts

@@ -1,15 +1,12 @@
 import { DocumentationGroupBehavior, ElementGroup } from "@supernova-studio/model";
 import { z } from "zod";
+import { DTODocumentationDraftState } from "./draft-state";
 import { DTODocumentationItemConfigurationV2 } from "./item-configuration-v2";
 
 //
 // Read
 //
 
-/**
- * Structure DTO is element properties minus element data (in other words data required
- * to display the element in the left panel)
- */
 export const DTODocumentationGroupV2 = ElementGroup.omit({
   sortOrder: true,
   parentPersistentId: true,
@@ -26,11 +23,12 @@ export const DTODocumentationGroupV2 = ElementGroup.omit({
   shortPersistentId: z.string(),
   configuration: DTODocumentationItemConfigurationV2,
   type: z.literal("Group"),
+
+  /** Defined when a group has changed since last publish and can be included into a partial publish */
+  draftState: DTODocumentationDraftState.optional(),
 });
 
 export type DTODocumentationGroupV2 = z.infer<typeof DTODocumentationGroupV2>;
-export const DTODocumentationGroupStructureV2 = DTODocumentationGroupV2;
-export type DTODocumentationGroupStructureV2 = DTODocumentationGroupV2;
 
 //
 // Write

package/src/api/dto/elements/documentation/hierarchy.ts

@@ -0,0 +1,36 @@
+import { z } from "zod";
+import { DTODocumentationDraftState } from "./draft-state";
+import { DTODocumentationGroupV2 } from "./group-v2";
+import { DTODocumentationPageV2 } from "./page-v2";
+
+export const DTODocumentationHierarchyV2 = z.object({
+  pages: z.array(
+    DTODocumentationPageV2.extend({
+      /** Defined when a page has changed since last publish and can be included into a partial publish */
+      draftState: DTODocumentationDraftState.optional(),
+    })
+  ),
+
+  groups: z.array(
+    DTODocumentationGroupV2.extend({
+      /** Defined when a page has changed since last publish and can be included into a partial publish */
+      draftState: DTODocumentationDraftState.optional(),
+    })
+  ),
+
+  deletedPages: z.array(
+    DTODocumentationPageV2.extend({
+      /** Deleted page is always a draft change */
+      draftState: DTODocumentationDraftState,
+    })
+  ),
+
+  deletedGroups: z.array(
+    DTODocumentationGroupV2.extend({
+      /** Deleted page is always a draft change */
+      draftState: DTODocumentationDraftState,
+    })
+  ),
+});
+
+export type DTODocumentationHierarchyV2 = z.infer<typeof DTODocumentationHierarchyV2>;

package/src/api/dto/elements/documentation/index.ts

@@ -1,6 +1,8 @@
+export * from "./draft-state";
 export * from "./group-action";
 export * from "./group-v1";
 export * from "./group-v2";
+export * from "./hierarchy";
 export * from "./item-configuration-v1";
 export * from "./item-configuration-v2";
 export * from "./page-actions-v2";

package/src/api/dto/elements/documentation/page-v2.ts

@@ -1,38 +1,38 @@
-import { DesignElementSnapshot, DocumentationPageV2 } from "@supernova-studio/model";
 import { z } from "zod";
-import { DTODocumentationGroupStructureV2 } from "./group-v2";
+import { DTODocumentationDraftState } from "./draft-state";
 import { DTODocumentationItemConfigurationV2 } from "./item-configuration-v2";
+
 //
 // Read
 //
 
-/**
- * Structure DTO is element properties minus element data (in other words data required
- * to display the element in the left panel)
- */
-export const DTODocumentationPageV2 = DocumentationPageV2.omit({
-  data: true,
-  meta: true,
-  parentPersistentId: true,
-  sortOrder: true,
-}).extend({
+export const DTODocumentationPageV2 = z.object({
+  id: z.string(),
+  persistentId: z.string(),
+
+  designSystemVersionId: z.string(),
+
   title: z.string(),
-  path: z.string(),
-  type: z.literal("Page"),
   configuration: DTODocumentationItemConfigurationV2,
-});
-export type DTODocumentationPageV2 = z.infer<typeof DTODocumentationPageV2>;
 
-export const DTODocumentationPageStructureV2 = DTODocumentationPageV2;
-export type DTODocumentationPageStructureV2 = DTODocumentationPageV2;
+  shortPersistentId: z.string(),
 
-export const DTODocumentationHierarchyV2 = z.object({
-  pages: z.array(DTODocumentationPageStructureV2),
-  groups: z.array(DTODocumentationGroupStructureV2),
-  publishedPagesSnapshots: DesignElementSnapshot.array(),
+  slug: z.string().optional(),
+  userSlug: z.string().optional(),
+
+  createdAt: z.coerce.date(),
+  updatedAt: z.coerce.date(),
+
+  path: z.string(),
+
+  /** Defined when a page has changed since last publish and can be included into a partial publish */
+  draftState: DTODocumentationDraftState.optional(),
+
+  // Backward compatibility
+  type: z.literal("Page"),
 });
 
-export type DTODocumentationHierarchyV2 = z.infer<typeof DTODocumentationHierarchyV2>;
+export type DTODocumentationPageV2 = z.infer<typeof DTODocumentationPageV2>;
 
 //
 // Write

package/src/yjs/design-system-content/documentation-hierarchy.ts

@@ -1,7 +1,7 @@
-import { DesignElementSnapshot, DocumentationPageV2, ElementGroup } from "@supernova-studio/model";
 import * as Y from "yjs";
 import { z } from "zod";
-import { DTODocumentationHierarchyV2, documentationElementsToHierarchyDto } from "../../api";
+import { DTODocumentationHierarchyV2 } from "../../api";
+import { FrontendVersionRoomYDoc } from "../version-room/frontend";
 
 // We store pages and groups in the same way they are stored in the database.
 // This means that instead of groups having childrenIds array, all items have
@@ -18,16 +18,6 @@ import { DTODocumentationHierarchyV2, documentationElementsToHierarchyDto } from
 // Types
 //
 
-type DocumentationHierarchyTransaction = {
-  pages: DocumentationPageV2[];
-  groups: ElementGroup[];
-  pageIdsToDelete: string[];
-  groupIdsToDelete: string[];
-  publishedPageSnapshots: DesignElementSnapshot[];
-
-  internalSettings: DocumentationHierarchySettings | undefined;
-};
-
 export const DocumentationHierarchySettings = z.object({
   routingVersion: z.string(),
   isDraftFeatureAdopted: z.boolean(),
@@ -35,137 +25,9 @@ export const DocumentationHierarchySettings = z.object({
 
 export type DocumentationHierarchySettings = z.infer<typeof DocumentationHierarchySettings>;
 
-//
-// Init
-//
-
-export function documentationHierarchyToYjs(doc: Y.Doc, transaction: DocumentationHierarchyTransaction) {
-  doc.transact(trx => {
-    // Pages
-    const pagesMap = getPagesYMap(trx.doc);
-
-    transaction.pageIdsToDelete.forEach(pageId => {
-      pagesMap.delete(pageId);
-    });
-
-    transaction.pages.forEach(page => {
-      // We remove blocks from the payload here because it will not get parsed anyway
-      const sanitizedPage: DocumentationPageV2 = {
-        ...page,
-        data: {
-          configuration: page.data.configuration,
-        },
-      };
-
-      pagesMap.set(page.id, JSON.parse(JSON.stringify(sanitizedPage)));
-    });
-
-    // Groups
-    const groupsMap = getGroupsYMap(trx.doc);
-
-    transaction.groupIdsToDelete.forEach(id => {
-      groupsMap.delete(id);
-    });
-
-    transaction.groups.forEach(group => {
-      groupsMap.set(group.id, JSON.parse(JSON.stringify(group)));
-    });
-
-    // Published state
-    const publishedSnapshotsMap = getPublishedSnapshotsYMap(trx.doc);
-
-    transaction.publishedPageSnapshots.forEach(state => {
-      publishedSnapshotsMap.set(state.id, JSON.parse(JSON.stringify(state)));
-    });
-
-    // Internal settings
-    if (transaction.internalSettings) {
-      serializeDocumentationInternalSettings(trx.doc, transaction.internalSettings);
-    }
-  });
-
-  return doc;
-}
-
-function serializeDocumentationInternalSettings(doc: Y.Doc, settings: DocumentationHierarchySettings) {
-  const map = getInternalSettingsYMap(doc);
-
-  map.set("routingVersion", settings.routingVersion);
-  settings.isDraftFeatureAdopted !== undefined && map.set("isDraftFeatureAdapted", settings.isDraftFeatureAdopted);
-}
-
+/**
+ * @deprecated - Use FrontendVersionRoomYDoc.getDocumentationHierarchy
+ */
 export function yjsToDocumentationHierarchy(doc: Y.Doc): DTODocumentationHierarchyV2 {
-  const pagesMap = getPagesYMap(doc);
-  const groupsMap = getGroupsYMap(doc);
-  const publishedSnapshotsMap = getPublishedSnapshotsYMap(doc);
-
-  // Read pages
-  const pages: DocumentationPageV2[] = [];
-  pagesMap.forEach(page => {
-    pages.push(DocumentationPageV2.parse(page));
-  });
-
-  // Read groups
-  const groups: ElementGroup[] = [];
-  groupsMap.forEach(group => {
-    groups.push(ElementGroup.parse(group));
-  });
-
-  // Read states
-  const publishedSnapshots: DesignElementSnapshot[] = [];
-  publishedSnapshotsMap.forEach(state => {
-    publishedSnapshots.push(DesignElementSnapshot.parse(state));
-  });
-
-  // Parse internalSettings
-  const internalSettings = parseDocumentationInternalSettings(doc);
-
-  // Map model onto client DTO
-  const hierarchy = documentationElementsToHierarchyDto(
-    pages,
-    groups,
-    publishedSnapshots,
-    internalSettings.routingVersion ?? "2"
-  );
-
-  return hierarchy;
-}
-
-function parseDocumentationInternalSettings(doc: Y.Doc): DocumentationHierarchySettings {
-  const map = getInternalSettingsYMap(doc);
-
-  const rawSettings: Record<keyof DocumentationHierarchySettings, any> = {
-    routingVersion: map.get("routingVersion"),
-    isDraftFeatureAdopted: map.get("isDraftFeatureAdapted") ?? false,
-  };
-
-  const settingsParseResult = DocumentationHierarchySettings.safeParse(rawSettings);
-  if (!settingsParseResult.success) {
-    return {
-      routingVersion: "2",
-      isDraftFeatureAdopted: false,
-    };
-  }
-
-  return settingsParseResult.data;
-}
-
-//
-// Internals
-//
-
-function getPagesYMap(doc: Y.Doc) {
-  return doc.getMap<DocumentationPageV2>("documentationPages");
-}
-
-function getGroupsYMap(doc: Y.Doc) {
-  return doc.getMap<ElementGroup>("documentationGroups");
-}
-
-function getInternalSettingsYMap(doc: Y.Doc) {
-  return doc.getMap<unknown>("documentationInternalSettings");
-}
-
-function getPublishedSnapshotsYMap(doc: Y.Doc) {
-  return doc.getMap<DesignElementSnapshot>("documentationPagePublishedSnapshots");
+  return new FrontendVersionRoomYDoc(doc).getDocumentationHierarchy();
 }

package/src/yjs/index.ts

@@ -1,2 +1,3 @@
 export * from "./design-system-content";
 export * from "./docs-editor";
+export * from "./version-room";

package/src/yjs/version-room/backend.ts

@@ -0,0 +1,76 @@
+import {
+  DocumentationPageSnapshot,
+  DocumentationPageV2,
+  ElementGroup,
+  ElementGroupSnapshot,
+} from "@supernova-studio/model";
+import * as Y from "yjs";
+import { DocumentationHierarchySettings } from "../design-system-content";
+import { VersionRoomBaseYDoc } from "./base";
+
+type DocumentationHierarchyTransaction = {
+  pages?: DocumentationPageV2[];
+  pageIdsToDelete?: string[];
+
+  groups?: ElementGroup[];
+  groupIdsToDelete?: string[];
+
+  publishedPageSnapshots?: DocumentationPageSnapshot[];
+  publishedPageSnapshotIdsToDelete?: string[];
+
+  publishedGroupSnapshots?: ElementGroupSnapshot[];
+  publishedGroupSnapshotIdsToDelete?: string[];
+
+  deletedPageSnapshots?: DocumentationPageSnapshot[];
+  deletedPageSnapshotIdsToDelete?: string[];
+
+  deletedGroupSnapshots?: ElementGroupSnapshot[];
+  deletedGroupSnapshotIdsToDelete?: string[];
+
+  internalSettings?: DocumentationHierarchySettings;
+};
+
+export class BackendVersionRoomYDoc {
+  private readonly yDoc: Y.Doc;
+
+  constructor(yDoc: Y.Doc) {
+    this.yDoc = yDoc;
+  }
+
+  updateDocumentationHierarchy(transaction: DocumentationHierarchyTransaction) {
+    this.yDoc.transact(trx => {
+      const yDoc = new VersionRoomBaseYDoc(trx.doc);
+
+      // Pages
+      transaction.pageIdsToDelete && yDoc.deletePages(transaction.pageIdsToDelete);
+      transaction.pages && yDoc.updatePages(transaction.pages);
+
+      // Groups
+      transaction.groupIdsToDelete && yDoc.deleteGroups(transaction.groupIdsToDelete);
+      transaction.groups && yDoc.updateGroups(transaction.groups);
+
+      // Snapshots - published pages
+      transaction.publishedPageSnapshotIdsToDelete &&
+        yDoc.deletePagePublishedSnapshots(transaction.publishedPageSnapshotIdsToDelete);
+      transaction.publishedPageSnapshots && yDoc.updatePagePublishedSnapshots(transaction.publishedPageSnapshots);
+
+      // Snapshots - published groups
+      transaction.publishedGroupSnapshotIdsToDelete &&
+        yDoc.deleteGroupPublishedSnapshots(transaction.publishedGroupSnapshotIdsToDelete);
+      transaction.publishedGroupSnapshots && yDoc.updateGroupPublishedSnapshots(transaction.publishedGroupSnapshots);
+
+      // Snapshots - deleted pages
+      transaction.deletedPageSnapshotIdsToDelete &&
+        yDoc.deletePageDeletedSnapshots(transaction.deletedPageSnapshotIdsToDelete);
+      transaction.deletedPageSnapshots && yDoc.updatePageDeletedSnapshots(transaction.deletedPageSnapshots);
+
+      // Snapshots - deleted groups
+      transaction.deletedGroupSnapshotIdsToDelete &&
+        yDoc.deleteGroupDeletedSnapshots(transaction.deletedGroupSnapshotIdsToDelete);
+      transaction.deletedGroupSnapshots && yDoc.updateGroupDeletedSnapshots(transaction.deletedGroupSnapshots);
+
+      // Settings
+      transaction.internalSettings && yDoc.updateDocumentationInternalSettings(transaction.internalSettings);
+    });
+  }
+}