@supernova-studio/client 0.47.41 → 0.47.43

package/package.json

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

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

@@ -1,4 +1,4 @@
-import { DesignElementSnapshot, DocumentationPageV2, ElementGroup } from "@supernova-studio/model";
+import { DocumentationPageV2, ElementGroup } from "@supernova-studio/model";
 import { DTODocumentationHierarchyV2 } from "../../dto";
 import { elementGroupsToDocumentationGroupStructureDTOV2 } from "./documentation-group-v2-to-dto";
 import { documentationPagesToStructureDTOV2 } from "./documentation-page-v2-to-dto";
@@ -12,12 +12,14 @@ import { documentationPagesToStructureDTOV2 } from "./documentation-page-v2-to-d
 export function documentationElementsToHierarchyDto(
   docPages: DocumentationPageV2[],
   docGroups: ElementGroup[],
-  publishedPagesSnapshots: DesignElementSnapshot[],
   routingVersion: string
 ): DTODocumentationHierarchyV2 {
   return {
     pages: documentationPagesToStructureDTOV2(docPages, docGroups, routingVersion),
     groups: elementGroupsToDocumentationGroupStructureDTOV2(docGroups, docPages),
-    publishedPagesSnapshots,
+
+    // TODO Artem
+    deletedGroups: [],
+    deletedPages: [],
   };
 }

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

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

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

@@ -1,5 +1,6 @@
 import { DocumentationGroupBehavior, ElementGroup } from "@supernova-studio/model";
 import { z } from "zod";
+import { DTODocumentationDraftState } from "./draft-state";
 import { DTODocumentationItemConfigurationV2 } from "./item-configuration-v2";
 
 //
@@ -26,10 +27,14 @@ 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 DTODocumentationGroupV2 = z.infer<typeof DTODocumentationGroupV2>;
 export type DTODocumentationGroupStructureV2 = DTODocumentationGroupV2;
 
 //

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

@@ -1,3 +1,4 @@
+export * from "./draft-state";
 export * from "./group-action";
 export * from "./group-v1";
 export * from "./group-v2";

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

@@ -1,7 +1,8 @@
-import { DesignElementSnapshot, DocumentationPageV2 } from "@supernova-studio/model";
+import { DocumentationPageV2 } from "@supernova-studio/model";
 import { z } from "zod";
 import { DTODocumentationGroupStructureV2 } from "./group-v2";
 import { DTODocumentationItemConfigurationV2 } from "./item-configuration-v2";
+import { DTODocumentationDraftState } from "./draft-state";
 //
 // Read
 //
@@ -20,18 +21,23 @@ export const DTODocumentationPageV2 = DocumentationPageV2.omit({
   path: z.string(),
   type: z.literal("Page"),
   configuration: DTODocumentationItemConfigurationV2,
+
+  /** Defined when a page has changed since last publish and can be included into a partial publish */
+  draftState: DTODocumentationDraftState.optional(),
 });
-export type DTODocumentationPageV2 = z.infer<typeof DTODocumentationPageV2>;
 
 export const DTODocumentationPageStructureV2 = DTODocumentationPageV2;
-export type DTODocumentationPageStructureV2 = DTODocumentationPageV2;
 
 export const DTODocumentationHierarchyV2 = z.object({
   pages: z.array(DTODocumentationPageStructureV2),
   groups: z.array(DTODocumentationGroupStructureV2),
-  publishedPagesSnapshots: DesignElementSnapshot.array(),
+
+  deletedPages: z.array(DTODocumentationPageStructureV2),
+  deletedGroups: z.array(DTODocumentationGroupStructureV2),
 });
 
+export type DTODocumentationPageV2 = z.infer<typeof DTODocumentationPageV2>;
+export type DTODocumentationPageStructureV2 = DTODocumentationPageV2;
 export type DTODocumentationHierarchyV2 = z.infer<typeof DTODocumentationHierarchyV2>;
 
 //

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/docs-editor/blocks-to-prosemirror.ts

@@ -497,6 +497,7 @@ function serializeTableNode(node: PageBlockItemTableNode): ProsemirrorNode {
               id: node.id,
               props: {
                 image: {
+                  caption: node.caption,
                   value: node.value,
                 } satisfies PageBlockItemImageValue,
               },

package/src/yjs/docs-editor/prosemirror-to-blocks.ts

@@ -585,6 +585,7 @@ function parseAsTableNode(prosemirrorNode: ProsemirrorNode): PageBlockItemTableN
         type: "Image",
         id: id,
         value: imagePropertyValueParseResult.data.value,
+        caption: imagePropertyValueParseResult.data.caption,
       };
 
     default:

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,42 @@
+import { DesignElementSnapshot, DocumentationPageV2, ElementGroup } from "@supernova-studio/model";
+import * as Y from "yjs";
+import { DocumentationHierarchySettings } from "../design-system-content";
+import { VersionRoomBaseYDoc } from "./base";
+
+type DocumentationHierarchyTransaction = {
+  pages: DocumentationPageV2[];
+  groups: ElementGroup[];
+  pageIdsToDelete: string[];
+  groupIdsToDelete: string[];
+  publishedPageSnapshots: DesignElementSnapshot[];
+
+  internalSettings: DocumentationHierarchySettings | undefined;
+};
+
+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.length && yDoc.deleteDocumentationPages(transaction.pageIdsToDelete);
+      transaction.pages.length && yDoc.updateDocumentationPages(transaction.pages);
+
+      // Groups
+      transaction.groupIdsToDelete.length && yDoc.deleteDocumentationGroups(transaction.groupIdsToDelete);
+      transaction.groups.length && yDoc.updateDocumentationGroups(transaction.groups);
+
+      // Snapshots
+      // TODO Artem
+
+      // Settings
+      transaction.internalSettings && yDoc.updateDocumentationInternalSettings(transaction.internalSettings);
+    });
+  }
+}

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

@@ -0,0 +1,238 @@
+import { DesignElementSnapshot, DocumentationPageV2, ElementGroup } from "@supernova-studio/model";
+import * as Y from "yjs";
+import { DocumentationHierarchySettings } from "../design-system-content";
+
+//
+// Types
+//
+
+type DocumentationHierarchyTransaction = {
+  pages: DocumentationPageV2[];
+  groups: ElementGroup[];
+  pageIdsToDelete: string[];
+  groupIdsToDelete: string[];
+
+  internalSettings: DocumentationHierarchySettings | undefined;
+};
+
+export class VersionRoomBaseYDoc {
+  private readonly yDoc: Y.Doc;
+
+  constructor(yDoc: Y.Doc) {
+    this.yDoc = yDoc;
+  }
+
+  //
+  // Pages
+  //
+
+  getDocumentationPages(): DocumentationPageV2[] {
+    const pagesMap = this.pagesYMap;
+
+    // Read pages
+    const pages: DocumentationPageV2[] = [];
+    pagesMap.forEach(page => {
+      pages.push(DocumentationPageV2.parse(page));
+    });
+
+    return pages;
+  }
+
+  updateDocumentationPages(pages: DocumentationPageV2[]) {
+    const pagesMap = this.pagesYMap;
+
+    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)));
+    });
+  }
+
+  deleteDocumentationPages(ids: string[]) {
+    const pagesMap = this.pagesYMap;
+    ids.forEach(id => pagesMap.delete(id));
+  }
+
+  private get pagesYMap() {
+    return this.yDoc.getMap<DocumentationPageV2>("documentationPages");
+  }
+
+  //
+  // Groups
+  //
+
+  getDocumentationGroups(): ElementGroup[] {
+    const groupsMap = this.groupsYMap;
+
+    // Read groups
+    const groups: ElementGroup[] = [];
+    groupsMap.forEach(group => {
+      groups.push(ElementGroup.parse(group));
+    });
+
+    return groups;
+  }
+
+  updateDocumentationGroups(groups: ElementGroup[]) {
+    const groupsMap = this.groupsYMap;
+
+    groups.forEach(group => {
+      groupsMap.set(group.id, JSON.parse(JSON.stringify(group)));
+    });
+  }
+
+  deleteDocumentationGroups(ids: string[]) {
+    const groupsMap = this.groupsYMap;
+    ids.forEach(id => groupsMap.delete(id));
+  }
+
+  private get groupsYMap() {
+    return this.yDoc.getMap<ElementGroup>("documentationGroups");
+  }
+
+  //
+  // Documentation internal settings
+  //
+
+  getDocumentationInternalSettings(): DocumentationHierarchySettings {
+    const map = this.internalSettingsYMap;
+
+    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;
+  }
+
+  updateDocumentationInternalSettings(settings: DocumentationHierarchySettings) {
+    const map = this.internalSettingsYMap;
+
+    map.set("routingVersion", settings.routingVersion);
+  }
+
+  private get internalSettingsYMap() {
+    return this.yDoc.getMap<unknown>("documentationInternalSettings");
+  }
+
+  //
+  // Documentation page published snapshot
+  //
+
+  getDocumentationPagePublishedSnapshots(): DesignElementSnapshot[] {
+    return this.getSnapshots(this.documentationPagePublishedStatesYMap);
+  }
+
+  updateDocumentationPagePublishedSnapshots(snapshots: DesignElementSnapshot[]) {
+    this.setSnapshots(this.documentationPagePublishedStatesYMap, snapshots);
+  }
+
+  private get documentationPagePublishedStatesYMap() {
+    return this.yDoc.getMap<object>("documentationPagePublishedSnapshots");
+  }
+
+  //
+  // Documentation page deleted snapshot
+  //
+
+  getDocumentationPageDeletedSnapshots(): DesignElementSnapshot[] {
+    return this.getSnapshots(this.documentationPageDeletedStatesYMap);
+  }
+
+  updateDocumentationPageDeletedSnapshots(snapshots: DesignElementSnapshot[]) {
+    this.setSnapshots(this.documentationPageDeletedStatesYMap, snapshots);
+  }
+
+  private get documentationPageDeletedStatesYMap() {
+    return this.yDoc.getMap<object>("documentationPageDeletedSnapshots");
+  }
+
+  //
+  // Documentation group published snapshots
+  //
+
+  getDocumentationGroupPublishedSnapshots(): DesignElementSnapshot[] {
+    return this.getSnapshots(this.documentationGroupPublishedStatesYMap);
+  }
+
+  updateDocumentationGroupPublishedSnapshots(snapshots: DesignElementSnapshot[]) {
+    this.setSnapshots(this.documentationGroupPublishedStatesYMap, snapshots);
+  }
+
+  private get documentationGroupPublishedStatesYMap() {
+    return this.yDoc.getMap<object>("documentationGroupPublishedSnapshots");
+  }
+
+  //
+  // Documentation group deleted snapshots
+  //
+
+  getDocumentationGroupDeletedSnapshots(): DesignElementSnapshot[] {
+    return this.getSnapshots(this.documentationGroupDeletedStatesYMap);
+  }
+
+  updateDocumentationGroupDeletedSnapshots(snapshots: DesignElementSnapshot[]) {
+    this.setSnapshots(this.documentationGroupDeletedStatesYMap, snapshots);
+  }
+
+  private get documentationGroupDeletedStatesYMap() {
+    return this.yDoc.getMap<object>("documentationGroupDeletedSnapshots");
+  }
+
+  //
+  // Snapshot utils
+  //
+
+  private getSnapshots(map: Y.Map<object>): DesignElementSnapshot[] {
+    const snapshots: DesignElementSnapshot[] = [];
+    map.forEach(snapshot => {
+      snapshots.push(DesignElementSnapshot.parse(snapshot));
+    });
+
+    return snapshots;
+  }
+
+  private setSnapshots(map: Y.Map<object>, snapshots: DesignElementSnapshot[]) {
+    snapshots.forEach(snapshot => {
+      map.set(snapshot.id, JSON.parse(JSON.stringify(snapshot)));
+    });
+  }
+
+  //
+  // Documentation page content hashes
+  //
+
+  getDocumentationPageContentHashes(): Record<string, string> {
+    const map = this.documentationPageContentHashesYMap;
+
+    const result: Record<string, string> = {};
+    map.forEach((hash, key) => {
+      result[key] = hash;
+    });
+
+    return result;
+  }
+
+  updateDocumentationPageContentHashes(hashes: Record<string, string>) {
+    const map = this.documentationPageContentHashesYMap;
+    Object.entries(hashes).forEach(([key, hash]) => map.set(key, hash));
+  }
+
+  private get documentationPageContentHashesYMap() {
+    return this.yDoc.getMap<string>("documentationPageHashes");
+  }
+}

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

@@ -0,0 +1,34 @@
+import * as Y from "yjs";
+import { DTODocumentationHierarchyV2, documentationElementsToHierarchyDto } from "../../api";
+import { generateHash } from "../../utils";
+import { DocumentationPageEditorModel } from "../docs-editor";
+import { VersionRoomBaseYDoc } from "./base";
+
+export class FrontendVersionRoomYDoc {
+  private readonly yDoc: Y.Doc;
+
+  constructor(yDoc: Y.Doc) {
+    this.yDoc = yDoc;
+  }
+
+  getDocumentationHierarchy(): DTODocumentationHierarchyV2 {
+    const doc = new VersionRoomBaseYDoc(this.yDoc);
+
+    const pages = doc.getDocumentationPages();
+    const groups = doc.getDocumentationGroups();
+    const settings = doc.getDocumentationInternalSettings();
+
+    // Map model onto client DTO
+    const hierarchy = documentationElementsToHierarchyDto(pages, groups, settings.routingVersion);
+
+    return hierarchy;
+  }
+
+  notifyDocumentationPageContentUpdated(pageId: string, content: DocumentationPageEditorModel) {
+    const pageContentHash = generateHash(content);
+
+    new VersionRoomBaseYDoc(this.yDoc).updateDocumentationPageContentHashes({
+      [pageId]: pageContentHash,
+    });
+  }
+}

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

@@ -0,0 +1,3 @@
+export * from "./backend";
+export * from "./base";
+export * from "./frontend";