@supernova-studio/client 0.59.12 → 1.0.0-alpha.11

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

@@ -1,463 +0,0 @@
-import {
-  DocumentationItemConfigurationV2,
-  DocumentationPageSnapshot,
-  DocumentationPageV2,
-  ElementGroup,
-  ElementGroupSnapshot,
-  PageBlockDefinition,
-  defaultDocumentationItemConfigurationV2,
-  mapByUnique,
-  pickLatestGroupSnapshots,
-  pickLatestPageSnapshots,
-  recordToMap,
-} from "@supernova-studio/model";
-import * as Y from "yjs";
-import {
-  DTODocumentationDraftState,
-  DTODocumentationDraftStateUpdated,
-  DTODocumentationGroupApprovalState,
-  DTODocumentationHierarchyV2,
-  DTODocumentationPageApprovalState,
-  documentationItemConfigurationToDTOV2,
-  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";
-import { generatePageContentHash } from "./utils";
-
-type ItemState = {
-  title: string;
-  configuration: DocumentationItemConfigurationV2;
-  contentHash: string;
-};
-
-export class FrontendVersionRoomYDoc {
-  private readonly yDoc: Y.Doc;
-
-  constructor(yDoc: Y.Doc, private readonly debug = false) {
-    this.yDoc = yDoc;
-  }
-
-  //
-  // Hierarchy
-  //
-
-  getDocumentationHierarchy(options: { includeDeletedContent?: boolean } = {}): DTODocumentationHierarchyV2 {
-    const includeDeletedContent = options.includeDeletedContent ?? false;
-
-    const doc = new VersionRoomBaseYDoc(this.yDoc);
-
-    // Read current room data
-    const pages = doc.getPages();
-    const groups = doc.getGroups();
-    const pageSnapshots = doc.getPageSnapshots();
-    const groupSnapshots = doc.getGroupSnapshots();
-    const liveblocksRoomIds = recordToMap(doc.getDocumentationPageLiveblocksRoomIds());
-
-    if (includeDeletedContent) {
-      pages.push(...this.getDeletedPages(pages, pageSnapshots));
-      groups.push(...this.getDeletedGroups(groups, groupSnapshots));
-    }
-
-    const settings = doc.getDocumentationInternalSettings();
-
-    // Convert pages to DTOs
-    const pageDTOs = documentationPagesToDTOV2(pages, groups, settings.routingVersion, liveblocksRoomIds);
-    const groupDTOs = elementGroupsToDocumentationGroupDTOV2(groups, pages);
-
-    // If draft feature is not yet adopted, no snapshot-based features should not be provided
-    if (!settings.isDraftFeatureAdopted) {
-      return {
-        pages: pageDTOs,
-        groups: groupDTOs,
-      };
-    }
-
-    const pageDraftStates = this.buildPageDraftCreatedAndUpdatedStates(pages, pageSnapshots);
-    const pageDraftDeletedStates = this.buildPageDraftDeletedStates(pages, pageSnapshots);
-    const pagePublishedMetadata = this.buildPagePublishedMetadata(pages, pageSnapshots);
-    const pageApprovalStates = this.buildPageApprovalStates(pages);
-
-    pageDTOs.forEach(p => {
-      // Assign draft state
-      const draftState = pageDraftDeletedStates.get(p.id) ?? pageDraftStates.get(p.id);
-      draftState && (p.draftState = draftState);
-
-      // Assign publish metadata
-      const publishMetadata = pagePublishedMetadata.get(p.id);
-      publishMetadata && (p.publishMetadata = publishMetadata);
-
-      // Assign approval state
-      const approvalState = pageApprovalStates.get(p.id);
-      approvalState && (p.approvalState = approvalState);
-    });
-
-    const groupDraftStates = this.buildGroupDraftCreatedAndUpdatedStates(groups, groupSnapshots);
-    const groupDraftDeletedStates = this.buildGroupDraftDeletedStates(groups, groupSnapshots);
-    const groupPublishedMetadata = this.buildGroupPublishedMetadata(groups, groupSnapshots);
-    const groupApprovalStates = this.buildGroupApprovalStates(groups, groupSnapshots);
-    groupDTOs.forEach(g => {
-      // Assign draft state
-      const draftState = groupDraftDeletedStates.get(g.id) ?? groupDraftStates.get(g.id);
-      draftState && (g.draftState = draftState);
-
-      // Assign publish metadata
-      const publishMetadata = groupPublishedMetadata.get(g.id);
-      publishMetadata && (g.publishMetadata = publishMetadata);
-
-      const approvalState = groupApprovalStates.get(g.id);
-      approvalState && (g.approvalState = approvalState);
-    });
-
-    return {
-      pages: pageDTOs,
-      groups: groupDTOs,
-    };
-  }
-
-  //
-  // Drafts - Pages
-  //
-
-  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> {
-    const doc = new VersionRoomBaseYDoc(this.yDoc);
-
-    // Read room data
-    const pageHashes = doc.getDocumentationPageContentHashes();
-    const publishedSnapshots = pickLatestPageSnapshots(pageSnapshots.filter(s => s.reason === "Publish"));
-
-    const publishedSnapshotsByPageId = mapByUnique(publishedSnapshots, s => s.page.id);
-
-    const result = new Map<string, DTODocumentationDraftState>();
-
-    pages.forEach(page => {
-      // Published state
-      const snapshot = publishedSnapshotsByPageId.get(page.id);
-      let publishedState: ItemState | undefined;
-      if (snapshot) {
-        publishedState = this.itemStateFromPage(snapshot.page, snapshot.pageContentHash);
-      }
-
-      // Current state - if content hash is undefined, it means that the page hasn't changed
-      const currentPageContentHash = pageHashes[page.persistentId] ?? snapshot?.pageContentHash ?? "";
-      const currentState: ItemState = this.itemStateFromPage(page, currentPageContentHash);
-
-      // Calculate draft
-      const draftState = this.createDraftState(page.persistentId, currentState, publishedState);
-      if (draftState) result.set(page.id, draftState);
-    });
-
-    return result;
-  }
-
-  private itemStateFromPage(page: DocumentationPageV2, pageContentHash: string): ItemState {
-    return {
-      title: page.meta.name,
-      configuration: page.data.configuration ?? defaultDocumentationItemConfigurationV2,
-      contentHash: pageContentHash,
-    };
-  }
-
-  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 buildGroupDraftDeletedStates(
-    groups: ElementGroup[],
-    groupSnapshots: ElementGroupSnapshot[]
-  ): Map<string, DTODocumentationDraftState> {
-    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 = pickLatestGroupSnapshots(groupSnapshots.filter(s => s.reason === "Publish"));
-
-    const publishedSnapshotsByGroupId = mapByUnique(publishedSnapshots, s => s.group.id);
-
-    const result = new Map<string, DTODocumentationDraftState>();
-
-    groups.forEach(group => {
-      if (!group.parentPersistentId) return;
-
-      // Current state
-      const currentState: ItemState = this.itemStateFromGroup(group);
-
-      // Published state
-      const snapshot = publishedSnapshotsByGroupId.get(group.id);
-      let publishedState: ItemState | undefined;
-      if (snapshot) {
-        publishedState = this.itemStateFromGroup(snapshot.group);
-      }
-
-      // Calculate draft
-      const draftState = this.createDraftState(group.persistentId, currentState, publishedState);
-      if (draftState) result.set(group.id, draftState);
-    });
-
-    return result;
-  }
-
-  private itemStateFromGroup(group: ElementGroup): ItemState {
-    return {
-      title: group.meta.name,
-      configuration: group.data?.configuration ?? defaultDocumentationItemConfigurationV2,
-      contentHash: "-",
-    };
-  }
-
-  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
-  //
-
-  private createDraftState(
-    itemPersistentId: string,
-    currentState: ItemState,
-    publishedState: ItemState | undefined
-  ): DTODocumentationDraftState | undefined {
-    if (!publishedState) {
-      // New item (hasn't been published yet)
-      return { changeType: "Created" };
-    }
-
-    // Compare current item state to the published state
-    const updatedDraftState: DTODocumentationDraftStateUpdated = {
-      changeType: "Updated",
-      changes: {},
-    };
-
-    if (currentState.title !== publishedState.title) {
-      if (this.debug) {
-        console.log(`Item ${itemPersistentId} (${currentState.title}): updated title`);
-      }
-
-      updatedDraftState.changes.previousTitle = publishedState.title;
-    }
-
-    const currentConfigHash = generateHash(currentState.configuration, this.debug);
-    const publishedConfigHash = generateHash(publishedState.configuration, this.debug);
-
-    if (currentConfigHash !== publishedConfigHash) {
-      if (this.debug) {
-        console.log(`Item ${itemPersistentId} (${currentState.title}): updated configuration`);
-      }
-
-      const configurationDto = documentationItemConfigurationToDTOV2(publishedState.configuration);
-      updatedDraftState.changes.previousConfiguration = configurationDto;
-    }
-
-    if (currentState.contentHash !== publishedState.contentHash) {
-      if (this.debug) {
-        console.log(`Item ${itemPersistentId} (${currentState.title}): updated content hash`);
-      }
-
-      updatedDraftState.changes.previousContentHash = publishedState.contentHash;
-    }
-
-    if (Object.keys(updatedDraftState.changes).length) {
-      // Item has at least one of the draft changes
-      return updatedDraftState;
-    }
-
-    // Item has no draft changes compared to the published item
-    return undefined;
-  }
-
-  private buildGroupApprovalStates(groups: ElementGroup[], groupSnapshots: ElementGroupSnapshot[]) {
-    const result = new Map<string, DTODocumentationGroupApprovalState>();
-    const allGroups = [...groups, ...groupSnapshots];
-    for (const g of allGroups) {
-      const approvalState: DTODocumentationGroupApprovalState = {
-        approvalState: "Approved",
-        designSystemVersionId: g.designSystemVersionId,
-        persistentId: g.persistentId,
-        groupId: g.id,
-      };
-      result.set(g.id, approvalState);
-    }
-    return result;
-  }
-
-  //
-  // Update page content hash
-  //
-
-  notifyDocumentationPageContentUpdated(
-    pageId: string,
-    content: DocumentationPageEditorModel,
-    definitions: PageBlockDefinition[]
-  ) {
-    const pageContentHash = generatePageContentHash(content, definitions, this.debug);
-    if (this.debug) {
-      console.log(`Will set page content hash: '${pageId}' : '${pageContentHash}'`);
-    }
-
-    new VersionRoomBaseYDoc(this.yDoc).updateDocumentationPageContentHashes({
-      [pageId]: pageContentHash,
-    });
-  }
-
-  //
-  // Misc
-  //
-
-  isDraftFeatureAdopted() {
-    const doc = new VersionRoomBaseYDoc(this.yDoc);
-    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
-    );
-  }
-
-  isApprovalsFeatureEnabled() {
-    const doc = new VersionRoomBaseYDoc(this.yDoc);
-    const settings = doc.getDocumentationInternalSettings();
-    return settings.isApprovalFeatureEnabled;
-  }
-
-  isApprovalRequiredForPublishing() {
-    const doc = new VersionRoomBaseYDoc(this.yDoc);
-    const settings = doc.getDocumentationInternalSettings();
-    return settings.approvalRequiredForPublishing;
-  }
-
-  private buildPageApprovalStates(pages: DocumentationPageV2[]) {
-    const doc = new VersionRoomBaseYDoc(this.yDoc);
-    const pageIds = pages.map(p => p.id);
-    const result = new Map<string, DTODocumentationPageApprovalState>();
-    const approvals = doc.getApprovals();
-    for (const pId of pageIds) {
-      const approval = approvals.find(approval => approval.pageId === pId);
-      if (approval) {
-        result.set(pId, approval);
-      }
-    }
-    return result;
-  }
-}

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

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

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

@@ -1,109 +0,0 @@
-import {
-  PageBlockDefinition,
-  PageBlockDefinitionsMap,
-  PageBlockItemMultiRichTextValue,
-  PageBlockItemRichTextValue,
-  PageBlockItemTableValue,
-  PageBlockText,
-  mapPageBlockItemValuesV2,
-  removeCommentSpans,
-} from "@supernova-studio/model";
-import { generateHash } from "../../utils";
-import { DocumentationPageEditorModel } from "../docs-editor";
-
-export function generatePageContentHash(
-  content: DocumentationPageEditorModel,
-  definitions: PageBlockDefinition[],
-  debug = false
-) {
-  let sanitizedContent = structuredClone(content);
-
-  // Remove comment spans
-  sanitizedContent = sanitizePageContents(sanitizedContent, definitions);
-
-  // Make sure hashes of empty pages always match
-  if (isPageContentEmpty(sanitizedContent)) {
-    sanitizedContent = { blocks: [] };
-  }
-
-  return generateHash(sanitizedContent, debug);
-}
-
-/**
- * Empty page content can be one of the following:
- *   - page without any blocks
- *   - page with a single block, the block is a paragraph whithout any text
- */
-function isPageContentEmpty(content: DocumentationPageEditorModel): boolean {
-  if (content.blocks.length > 1) return false;
-  if (content.blocks.length < 1) return true;
-
-  const singleBlock = content.blocks[0];
-  if (singleBlock.type !== "Block" || singleBlock.data.packageId !== "io.supernova.block.rich-text") {
-    return false;
-  }
-
-  const singleItem = singleBlock.data.items[0];
-
-  // Block has no value, effectively the same as empty value
-  if (!singleItem || !singleItem.props["text"]) return true;
-
-  const textValue = singleItem.props["text"] as PageBlockItemRichTextValue;
-  return !textValue.value.spans.length;
-}
-
-function sanitizePageContents(
-  content: DocumentationPageEditorModel,
-  definitions: PageBlockDefinition[]
-): DocumentationPageEditorModel {
-  const defMap = new PageBlockDefinitionsMap(definitions);
-
-  mapPageBlockItemValuesV2(content.blocks, defMap, (block, item, prop, value) => {
-    if (prop.type === "RichText") {
-      const richTextValue = value as PageBlockItemRichTextValue;
-      return {
-        ...richTextValue,
-        value: sanitizeRichText(richTextValue.value),
-      };
-    }
-
-    if (prop.type === "MultiRichText") {
-      const multiRichTextValue = value as PageBlockItemMultiRichTextValue;
-      return {
-        ...multiRichTextValue,
-        value: multiRichTextValue.value.map(sanitizeRichText),
-      };
-    }
-
-    if (prop.type === "Table") {
-      const tableValue = value as PageBlockItemTableValue;
-      tableValue.value.forEach(r => {
-        r.cells.forEach(c => {
-          c.nodes.forEach(n => {
-            if (n.type === "RichText") {
-              n.value = sanitizeRichText(n.value);
-            }
-          });
-        });
-      });
-
-      return tableValue;
-    }
-
-    return value;
-  });
-
-  return content;
-}
-
-function sanitizeRichText(richText: PageBlockText): PageBlockText {
-  return sortSpanAttributes(removeCommentSpans(richText));
-}
-
-function sortSpanAttributes(richText: PageBlockText) {
-  richText.spans.forEach(s => {
-    s.attributes.sort((lhs, rhs) => lhs.type.localeCompare(rhs.type));
-  });
-
-  return richText;
-}