@supernova-studio/client 0.47.37 → 0.47.39

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supernova-studio/client",
-  "version": "0.47.37",
+  "version": "0.47.39",
   "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 { DocumentationPageV2, ElementGroup } from "@supernova-studio/model";
+import { DesignElementSnapshot, 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,10 +12,12 @@ 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,
   };
 }

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

@@ -1,7 +1,7 @@
-import { DocumentationPageV2 } from "@supernova-studio/model";
+import { DesignElementSnapshot, DocumentationPageV2 } from "@supernova-studio/model";
 import { z } from "zod";
-import { DTODocumentationItemConfigurationV2 } from "./item-configuration-v2";
 import { DTODocumentationGroupStructureV2 } from "./group-v2";
+import { DTODocumentationItemConfigurationV2 } from "./item-configuration-v2";
 //
 // Read
 //
@@ -29,6 +29,7 @@ export type DTODocumentationPageStructureV2 = DTODocumentationPageV2;
 export const DTODocumentationHierarchyV2 = z.object({
   pages: z.array(DTODocumentationPageStructureV2),
   groups: z.array(DTODocumentationGroupStructureV2),
+  publishedPagesSnapshots: DesignElementSnapshot.array(),
 });
 
 export type DTODocumentationHierarchyV2 = z.infer<typeof DTODocumentationHierarchyV2>;

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

@@ -1,4 +1,4 @@
-import { DocumentationPageV2, ElementGroup } from "@supernova-studio/model";
+import { DesignElementSnapshot, DocumentationPageV2, ElementGroup } from "@supernova-studio/model";
 import * as Y from "yjs";
 import { z } from "zod";
 import { DTODocumentationHierarchyV2, documentationElementsToHierarchyDto } from "../../api";
@@ -23,12 +23,14 @@ type DocumentationHierarchyTransaction = {
   groups: ElementGroup[];
   pageIdsToDelete: string[];
   groupIdsToDelete: string[];
+  publishedPageSnapshots: DesignElementSnapshot[];
 
   internalSettings: DocumentationHierarchySettings | undefined;
 };
 
 export const DocumentationHierarchySettings = z.object({
   routingVersion: z.string(),
+  isDraftFeatureAdopted: z.boolean(),
 });
 
 export type DocumentationHierarchySettings = z.infer<typeof DocumentationHierarchySettings>;
@@ -69,6 +71,13 @@ export function documentationHierarchyToYjs(doc: Y.Doc, transaction: Documentati
       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);
@@ -82,11 +91,13 @@ function serializeDocumentationInternalSettings(doc: Y.Doc, settings: Documentat
   const map = getInternalSettingsYMap(doc);
 
   map.set("routingVersion", settings.routingVersion);
+  settings.isDraftFeatureAdopted !== undefined && map.set("isDraftFeatureAdapted", settings.isDraftFeatureAdopted);
 }
 
 export function yjsToDocumentationHierarchy(doc: Y.Doc): DTODocumentationHierarchyV2 {
   const pagesMap = getPagesYMap(doc);
   const groupsMap = getGroupsYMap(doc);
+  const publishedSnapshotsMap = getPublishedSnapshotsYMap(doc);
 
   // Read pages
   const pages: DocumentationPageV2[] = [];
@@ -100,11 +111,22 @@ export function yjsToDocumentationHierarchy(doc: Y.Doc): DTODocumentationHierarc
     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, internalSettings.routingVersion ?? "2");
+  const hierarchy = documentationElementsToHierarchyDto(
+    pages,
+    groups,
+    publishedSnapshots,
+    internalSettings.routingVersion ?? "2"
+  );
 
   return hierarchy;
 }
@@ -114,11 +136,15 @@ function parseDocumentationInternalSettings(doc: Y.Doc): DocumentationHierarchyS
 
   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" };
+    return {
+      routingVersion: "2",
+      isDraftFeatureAdopted: false,
+    };
   }
 
   return settingsParseResult.data;
@@ -139,3 +165,7 @@ function getGroupsYMap(doc: Y.Doc) {
 function getInternalSettingsYMap(doc: Y.Doc) {
   return doc.getMap<unknown>("documentationInternalSettings");
 }
+
+function getPublishedSnapshotsYMap(doc: Y.Doc) {
+  return doc.getMap<DesignElementSnapshot>("documentationPagePublishedSnapshots");
+}

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

@@ -686,7 +686,10 @@ function parseAsCustomBlock(
   const appearance = parseAppearance(prosemirrorNode);
 
   const parsedItems = parseBlockItems(prosemirrorNode, definition) ?? [];
-  if (!parsedItems.length && definition.behavior.items?.numberOfItems === 1) {
+
+  // Some blocks can expect at least one item to be always present. In such case we fallback to an item
+  // without any properties defined which should be a valid item for any combination of block settings.
+  if (!parsedItems.length && definitionExpectsPlaceholderItem(definition)) {
     parsedItems.push({
       id: id,
       props: {},
@@ -708,6 +711,15 @@ function parseAsCustomBlock(
   };
 }
 
+function definitionExpectsPlaceholderItem(definition: PageBlockDefinition): boolean {
+  return (
+    // Block needs an item when it's a data block (tokens, components, etc)
+    !definition.behavior.items ||
+    // Block needs an item when number of items is expected to be 1
+    definition.behavior.items.numberOfItems === 1
+  );
+}
+
 function parseBlockItems(prosemirrorNode: ProsemirrorNode, definition: PageBlockDefinition): PageBlockItemV2[] | null {
   const itemsString = getProsemirrorAttribute(prosemirrorNode, "items", z.string());
   if (!itemsString) return null;