@supernova-studio/client 0.48.13 → 0.48.15

package/package.json

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

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

@@ -18,6 +18,8 @@ export const DTODocumentationDraftStateUpdated = z.object({
 
 export const DTODocumentationDraftStateDeleted = z.object({
   changeType: z.literal(DTODocumentationDraftChangeType.enum.Deleted),
+  deletedAt: z.coerce.date(),
+  deletedByUserId: z.string(),
 });
 
 export const DTODocumentationDraftState = z.discriminatedUnion("changeType", [

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

@@ -2,6 +2,7 @@ import { DocumentationGroupBehavior, ElementGroup } from "@supernova-studio/mode
 import { z } from "zod";
 import { DTODocumentationDraftState } from "./draft-state";
 import { DTODocumentationItemConfigurationV2 } from "./item-configuration-v2";
+import { DTODocumentationPublishMetadata } from "./metadata";
 
 //
 // Read
@@ -26,6 +27,9 @@ export const DTODocumentationGroupV2 = ElementGroup.omit({
 
   /** Defined when a group has changed since last publish and can be included into a partial publish */
   draftState: DTODocumentationDraftState.optional(),
+
+  /** Defined if a group was published at least once and contains metadata about last publish */
+  publishMetadata: DTODocumentationPublishMetadata.optional(),
 });
 
 export type DTODocumentationGroupV2 = z.infer<typeof DTODocumentationGroupV2>;

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

@@ -17,20 +17,6 @@ export const DTODocumentationHierarchyV2 = z.object({
       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

@@ -5,6 +5,7 @@ export * from "./group-v2";
 export * from "./hierarchy";
 export * from "./item-configuration-v1";
 export * from "./item-configuration-v2";
+export * from "./metadata";
 export * from "./page-actions-v2";
 export * from "./page-content";
 export * from "./page-v1";

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

@@ -0,0 +1,8 @@
+import { z } from "zod";
+
+export const DTODocumentationPublishMetadata = z.object({
+  lastPublishedByUserId: z.string(),
+  lastPublishedAt: z.coerce.date(),
+});
+
+export type DTODocumentationPublishMetadata = z.infer<typeof DTODocumentationPublishMetadata>;

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

@@ -1,6 +1,7 @@
 import { z } from "zod";
 import { DTODocumentationDraftState } from "./draft-state";
 import { DTODocumentationItemConfigurationV2 } from "./item-configuration-v2";
+import { DTODocumentationPublishMetadata } from "./metadata";
 
 //
 // Read
@@ -28,6 +29,9 @@ export const DTODocumentationPageV2 = z.object({
   /** Defined when a page has changed since last publish and can be included into a partial publish */
   draftState: DTODocumentationDraftState.optional(),
 
+  /** Defined if a page was published at least once and contains metadata about last publish */
+  publishMetadata: DTODocumentationPublishMetadata.optional(),
+
   // Backward compatibility
   type: z.literal("Page"),
 });

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

@@ -6,6 +6,8 @@ import {
   ElementGroupSnapshot,
   defaultDocumentationItemConfigurationV2,
   mapByUnique,
+  pickLatestGroupSnapshots,
+  pickLatestPageSnapshots,
 } from "@supernova-studio/model";
 import * as Y from "yjs";
 import {
@@ -16,6 +18,7 @@ import {
   documentationPagesToDTOV2,
   elementGroupsToDocumentationGroupDTOV2,
 } from "../../api";
+import { DTODocumentationPublishMetadata } from "../../api/dto/elements/documentation/metadata";
 import { generateHash } from "../../utils";
 import { DocumentationPageEditorModel } from "../docs-editor";
 import { VersionRoomBaseYDoc } from "./base";
@@ -38,7 +41,9 @@ export class FrontendVersionRoomYDoc {
   // Hierarchy
   //
 
-  getDocumentationHierarchy(): DTODocumentationHierarchyV2 {
+  getDocumentationHierarchy(options: { includeDeletedContent?: boolean } = {}): DTODocumentationHierarchyV2 {
+    const includeDeletedContent = options.includeDeletedContent ?? false;
+
     const doc = new VersionRoomBaseYDoc(this.yDoc);
 
     // Read current room data
@@ -47,6 +52,11 @@ export class FrontendVersionRoomYDoc {
     const pageSnapshots = doc.getPageSnapshots();
     const groupSnapshots = doc.getGroupSnapshots();
 
+    if (includeDeletedContent) {
+      pages.push(...this.getDeletedPages(pages, pageSnapshots));
+      groups.push(...this.getDeletedGroups(groups, groupSnapshots));
+    }
+
     const settings = doc.getDocumentationInternalSettings();
 
     // Convert pages to DTOs
@@ -58,59 +68,40 @@ export class FrontendVersionRoomYDoc {
       return {
         pages: pageDTOs,
         groups: groupDTOs,
-        deletedGroups: [],
-        deletedPages: [],
       };
     }
 
-    const pageDraftStates = this.buildPageDraftStates(pages, pageSnapshots);
+    const pageDraftStates = this.buildPageDraftCreatedAndUpdatedStates(pages, pageSnapshots);
+    const pageDraftDeletedStates = this.buildPageDraftDeletedStates(pages, pageSnapshots);
+    const pagePublishedMetadata = this.buildPagePublishedMetadata(pages, pageSnapshots);
+
     pageDTOs.forEach(p => {
-      const draftState = pageDraftStates.get(p.id);
+      // Assign draft state
+      const draftState = pageDraftDeletedStates.get(p.id) ?? pageDraftStates.get(p.id);
       draftState && (p.draftState = draftState);
-    });
 
-    const groupDraftStates = this.buildGroupDraftStates(groups, groupSnapshots);
-    groupDTOs.forEach(g => {
-      const draftState = groupDraftStates.get(g.id);
-      draftState && (g.draftState = draftState);
+      // Assign publish metadata
+      const publishMetadata = pagePublishedMetadata.get(p.id);
+      publishMetadata && (p.publishMetadata = publishMetadata);
     });
 
-    // Read deleted pages
-    const pageIds = new Set(pages.map(p => p.id));
-    const deletedPagesMap = mapByUnique(
-      pageSnapshots.filter(s => !pageIds.has(s.page.id)).map(s => s.page),
-      p => p.id
-    );
-    const deletedPages = Array.from(deletedPagesMap.values());
+    const groupDraftStates = this.buildGroupDraftCreatedAndUpdatedStates(groups, groupSnapshots);
+    const groupDraftDeletedStates = this.buildGroupDraftDeletedStates(groups, groupSnapshots);
+    const groupPublishedMetadata = this.buildGroupPublishedMetadata(groups, groupSnapshots);
 
-    // Read deleted groups
-    const groupIds = new Set(groups.map(p => p.id));
-    const deletedGroupsMap = mapByUnique(
-      groupSnapshots.filter(s => !groupIds.has(s.group.id)).map(s => s.group),
-      g => g.id
-    );
-    const deletedGroups = Array.from(deletedGroupsMap.values());
-
-    // Convert deleted pages to DTOs with draft states
-    const deletedPageDTOs = documentationPagesToDTOV2(
-      deletedPages,
-      [...groups, ...deletedGroups],
-      settings.routingVersion
-    ).map(p => {
-      return { ...p, draftState: { changeType: "Deleted" } } as const;
-    });
+    groupDTOs.forEach(g => {
+      // Assign draft state
+      const draftState = groupDraftDeletedStates.get(g.id) ?? groupDraftStates.get(g.id);
+      draftState && (g.draftState = draftState);
 
-    // Convert deleted groups to DTOs with draft states
-    const deletedGroupDTOs = elementGroupsToDocumentationGroupDTOV2(deletedGroups, deletedPages).map(g => {
-      return { ...g, draftState: { changeType: "Deleted" } } as const;
+      // Assign publish metadata
+      const publishMetadata = groupPublishedMetadata.get(g.id);
+      publishMetadata && (g.publishMetadata = publishMetadata);
     });
 
     return {
       pages: pageDTOs,
       groups: groupDTOs,
-
-      deletedPages: deletedPageDTOs,
-      deletedGroups: deletedGroupDTOs,
     };
   }
 
@@ -118,7 +109,32 @@ export class FrontendVersionRoomYDoc {
   // Drafts - Pages
   //
 
-  private buildPageDraftStates(
+  private buildPageDraftDeletedStates(
+    pages: DocumentationPageV2[],
+    pageSnapshots: DocumentationPageSnapshot[]
+  ): Map<string, DTODocumentationDraftState> {
+    const deletedSnapshotsByPageId = mapByUnique(
+      pickLatestPageSnapshots(pageSnapshots.filter(s => s.reason === "Deletion")),
+      s => s.page.id
+    );
+
+    const result = new Map<string, DTODocumentationDraftState>();
+
+    pages.forEach(page => {
+      const deletedSnapshot = deletedSnapshotsByPageId.get(page.id);
+      if (!deletedSnapshot) return;
+
+      result.set(page.id, {
+        changeType: "Deleted",
+        deletedAt: deletedSnapshot.createdAt,
+        deletedByUserId: deletedSnapshot.createdByUserId,
+      });
+    });
+
+    return result;
+  }
+
+  private buildPageDraftCreatedAndUpdatedStates(
     pages: DocumentationPageV2[],
     pageSnapshots: DocumentationPageSnapshot[]
   ): Map<string, DTODocumentationDraftState> {
@@ -126,13 +142,9 @@ export class FrontendVersionRoomYDoc {
 
     // Read room data
     const pageHashes = doc.getDocumentationPageContentHashes();
-    const publishedSnapshots = pageSnapshots.filter(s => s.reason === "Publish");
+    const publishedSnapshots = pickLatestPageSnapshots(pageSnapshots.filter(s => s.reason === "Publish"));
 
     const publishedSnapshotsByPageId = mapByUnique(publishedSnapshots, s => s.page.id);
-    const publishedPagesById = mapByUnique(
-      publishedSnapshots.map(s => s.page),
-      p => p.id
-    );
 
     const result = new Map<string, DTODocumentationDraftState>();
 
@@ -141,8 +153,7 @@ export class FrontendVersionRoomYDoc {
       const snapshot = publishedSnapshotsByPageId.get(page.id);
       let publishedState: ItemState | undefined;
       if (snapshot) {
-        const publishedPage = publishedPagesById.get(snapshot.page.id)!;
-        publishedState = this.itemStateFromPage(publishedPage, snapshot.pageContentHash);
+        publishedState = this.itemStateFromPage(snapshot.page, snapshot.pageContentHash);
       }
 
       // Current state - if content hash is undefined, it means that the page hasn't changed
@@ -165,28 +176,84 @@ export class FrontendVersionRoomYDoc {
     };
   }
 
+  private getDeletedPages(
+    pages: DocumentationPageV2[],
+    pageSnapshots: DocumentationPageSnapshot[]
+  ): DocumentationPageV2[] {
+    const existingPageIds = new Set(pages.map(p => p.id));
+    const latestSnapshots = pickLatestPageSnapshots(pageSnapshots);
+    return latestSnapshots.filter(s => !existingPageIds.has(s.page.id)).map(s => s.page);
+  }
+
+  private buildPagePublishedMetadata(
+    pages: DocumentationPageV2[],
+    pageSnapshots: DocumentationPageSnapshot[]
+  ): Map<string, DTODocumentationPublishMetadata> {
+    const publishedPageSnapshotsById = mapByUnique(
+      pickLatestPageSnapshots(pageSnapshots.filter(s => s.reason === "Publish")),
+      s => s.page.id
+    );
+
+    const result = new Map<string, DTODocumentationPublishMetadata>();
+
+    pages.forEach(p => {
+      const publishedSnapshot = publishedPageSnapshotsById.get(p.id);
+      if (!publishedSnapshot) return;
+
+      result.set(p.id, {
+        lastPublishedAt: publishedSnapshot.createdAt,
+        lastPublishedByUserId: publishedSnapshot.createdByUserId,
+      });
+    });
+
+    return result;
+  }
+
   //
   // Drafts - Groups
   //
 
-  private buildGroupDraftStates(
+  private buildGroupDraftDeletedStates(
     groups: ElementGroup[],
     groupSnapshots: ElementGroupSnapshot[]
   ): Map<string, DTODocumentationDraftState> {
-    const doc = new VersionRoomBaseYDoc(this.yDoc);
+    const deletedSnapshotsByGroupId = mapByUnique(
+      pickLatestGroupSnapshots(groupSnapshots.filter(s => s.reason === "Deletion")),
+      s => s.group.id
+    );
+
+    const result = new Map<string, DTODocumentationDraftState>();
+
+    groups.forEach(group => {
+      if (!group.parentPersistentId) return;
+
+      const deletedSnapshot = deletedSnapshotsByGroupId.get(group.id);
+      if (!deletedSnapshot) return;
 
+      result.set(group.id, {
+        changeType: "Deleted",
+        deletedAt: deletedSnapshot.createdAt,
+        deletedByUserId: deletedSnapshot.createdByUserId,
+      });
+    });
+
+    return result;
+  }
+
+  private buildGroupDraftCreatedAndUpdatedStates(
+    groups: ElementGroup[],
+    groupSnapshots: ElementGroupSnapshot[]
+  ): Map<string, DTODocumentationDraftState> {
     // Read room data
-    const publishedSnapshots = groupSnapshots.filter(s => s.reason === "Publish");
+    const publishedSnapshots = pickLatestGroupSnapshots(groupSnapshots.filter(s => s.reason === "Publish"));
 
     const publishedSnapshotsByGroupId = mapByUnique(publishedSnapshots, s => s.group.id);
-    const publishedGroupsById = mapByUnique(
-      publishedSnapshots.map(s => s.group),
-      g => g.id
-    );
 
     const result = new Map<string, DTODocumentationDraftState>();
 
     groups.forEach(group => {
+      if (!group.parentPersistentId) return;
+
       // Current state
       const currentState: ItemState = this.itemStateFromGroup(group);
 
@@ -194,8 +261,7 @@ export class FrontendVersionRoomYDoc {
       const snapshot = publishedSnapshotsByGroupId.get(group.id);
       let publishedState: ItemState | undefined;
       if (snapshot) {
-        const publishedGroup = publishedGroupsById.get(snapshot.group.id)!;
-        publishedState = this.itemStateFromGroup(publishedGroup);
+        publishedState = this.itemStateFromGroup(snapshot.group);
       }
 
       // Calculate draft
@@ -214,6 +280,38 @@ export class FrontendVersionRoomYDoc {
     };
   }
 
+  private getDeletedGroups(groups: ElementGroup[], groupSnapshots: ElementGroupSnapshot[]): ElementGroup[] {
+    const existingGroupIds = new Set(groups.map(p => p.id));
+    const latestSnapshots = pickLatestGroupSnapshots(groupSnapshots);
+    return latestSnapshots.filter(s => !existingGroupIds.has(s.group.id)).map(s => s.group);
+  }
+
+  private buildGroupPublishedMetadata(
+    groups: ElementGroup[],
+    groupSnapshots: ElementGroupSnapshot[]
+  ): Map<string, DTODocumentationPublishMetadata> {
+    const publishedGroupSnapshotsById = mapByUnique(
+      pickLatestGroupSnapshots(groupSnapshots.filter(s => s.reason === "Publish")),
+      s => s.group.id
+    );
+
+    const result = new Map<string, DTODocumentationPublishMetadata>();
+
+    groups.forEach(g => {
+      if (!g.parentPersistentId) return;
+
+      const publishedSnapshot = publishedGroupSnapshotsById.get(g.id);
+      if (!publishedSnapshot) return;
+
+      result.set(g.id, {
+        lastPublishedAt: publishedSnapshot.createdAt,
+        lastPublishedByUserId: publishedSnapshot.createdByUserId,
+      });
+    });
+
+    return result;
+  }
+
   //
   // Drafts - Shared
   //
@@ -295,4 +393,13 @@ export class FrontendVersionRoomYDoc {
     const settings = doc.getDocumentationInternalSettings();
     return settings.isDraftFeatureAdopted;
   }
+
+  hasPublishedDocumentationContent() {
+    const doc = new VersionRoomBaseYDoc(this.yDoc);
+
+    return (
+      doc.getPageSnapshots().filter(s => s.reason === "Publish").length > 0 ||
+      doc.getGroupSnapshots().filter(s => s.reason === "Publish").length > 0
+    );
+  }
 }