@supernova-studio/client 0.48.7 → 1.0.1

package/src/yjs/docs-editor/utils.ts

@@ -1,115 +0,0 @@
-import { PageBlockEditorModel } from "./model/block";
-import {
-  PageBlockDefinition,
-  PageBlockDefinitionPropertyType,
-  PageBlockItemEmbedValue,
-  PageBlockItemMultiRichTextValue,
-  PageBlockItemRichTextValue,
-  PageBlockItemTableValue,
-  PageBlockItemUntypedValue,
-  PageBlockItemV2,
-  PageBlockText,
-} from "@supernova-studio/model";
-
-export const BlockParsingUtils = {
-  singleBlockItem(block: PageBlockEditorModel) {
-    if (!block.data.items.length) throw new Error(`Block ${block.id} has no items`);
-    if (block.data.items.length > 1) throw new Error(`Block ${block.id} has more than 1 item`);
-
-    return block.data.items[0]!;
-  },
-
-  richTextPropertyValue(item: PageBlockItemV2, propertyKey: string): PageBlockItemRichTextValue {
-    const objectValue = this.objectPropertyValue(item, propertyKey);
-    const richText = PageBlockItemRichTextValue.parse(objectValue);
-
-    return richText;
-  },
-
-  multiRichTextPropertyValue(item: PageBlockItemV2, propertyKey: string): PageBlockItemMultiRichTextValue {
-    const objectValue = this.objectPropertyValue(item, propertyKey);
-    const richText = PageBlockItemMultiRichTextValue.parse(objectValue);
-
-    return richText;
-  },
-
-  tablePropertyValue(item: PageBlockItemV2, propertyKey: string): PageBlockItemTableValue {
-    const objectValue = this.objectPropertyValue(item, propertyKey);
-    const table = PageBlockItemTableValue.parse(objectValue);
-
-    return table;
-  },
-
-  embedPropertyValue(item: PageBlockItemV2, propertyKey: string): PageBlockItemEmbedValue {
-    const objectValue = this.objectPropertyValue(item, propertyKey);
-    const embed = PageBlockItemEmbedValue.parse(objectValue);
-
-    return embed;
-  },
-
-  objectPropertyValue(item: PageBlockItemV2, propertyKey: string) {
-    const value = this.propertyValueOrThrow(item, propertyKey);
-
-    if (typeof value !== "object") {
-      throw new Error(`Value for property ${propertyKey} is expected to be an object, but instead is ${typeof value}`);
-    }
-
-    return value;
-  },
-
-  propertyValueOrThrow(item: PageBlockItemV2, propertyKey: string): PageBlockItemUntypedValue {
-    const value = item.props[propertyKey];
-    if (!value) throw new Error(`Property ${propertyKey} is not defined on block item`);
-
-    return value;
-  },
-};
-
-export const BlockDefinitionUtils = {
-  firstRichTextProperty(definition: PageBlockDefinition) {
-    const property = definition.item.properties.find(p => p.type === "RichText");
-    if (property) return property;
-    return undefined;
-  },
-
-  firstMultiRichTextProperty(definition: PageBlockDefinition) {
-    const property = definition.item.properties.find(p => p.type === "MultiRichText");
-    if (property) return property;
-    return undefined;
-  },
-
-  firstTableProperty(definition: PageBlockDefinition) {
-    const property = definition.item.properties.find(p => p.type === "Table");
-    if (property) return property;
-    return undefined;
-  },
-
-  firstEmbedProperty(definition: PageBlockDefinition) {
-    const property = definition.item.properties.find(p => p.type === "EmbedURL");
-    if (property) return property;
-    return undefined;
-  },
-
-  richTextProperty(definition: PageBlockDefinition, propertyKey: string) {
-    return this.property(definition, propertyKey, "RichText");
-  },
-
-  property(
-    definition: PageBlockDefinition,
-    propertyKey: string,
-    expectedPropertyType?: PageBlockDefinitionPropertyType
-  ) {
-    const property = definition.item.properties.find(p => p.id === propertyKey);
-    if (!property) {
-      throw new Error(`Definition ${definition.id} doesn't contain property ${propertyKey}`);
-    }
-
-    if (expectedPropertyType && property.type !== expectedPropertyType) {
-      throw new Error(
-        `Property ${propertyKey} of definition ${definition.id} expected to be ${expectedPropertyType} but was ${property.type}`
-      );
-    }
-
-    return property;
-  },
-};

package/src/yjs/index.ts

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

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

@@ -1,60 +0,0 @@
-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[];
-
-  pageSnapshots?: DocumentationPageSnapshot[];
-  pageSnapshotIdsToDelete?: string[];
-
-  groupSnapshots?: ElementGroupSnapshot[];
-  groupSnapshotIdsToDelete?: string[];
-
-  internalSettings?: DocumentationHierarchySettings;
-  pageHashesToUpdate?: Record<string, string>;
-};
-
-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);
-
-      // Page snapshots
-      transaction.pageSnapshotIdsToDelete && yDoc.deletePageSnapshots(transaction.pageSnapshotIdsToDelete);
-      transaction.pageSnapshots && yDoc.updatePageSnapshots(transaction.pageSnapshots);
-
-      // Snapshots - published groups
-      transaction.groupSnapshotIdsToDelete && yDoc.deleteGroupSnapshots(transaction.groupSnapshotIdsToDelete);
-      transaction.groupSnapshots && yDoc.updateGroupSnapshots(transaction.groupSnapshots);
-
-      // Settings
-      transaction.internalSettings && yDoc.updateDocumentationInternalSettings(transaction.internalSettings);
-      transaction.pageHashesToUpdate && yDoc.updateDocumentationPageContentHashes(transaction.pageHashesToUpdate);
-    });
-  }
-}

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

@@ -1,185 +0,0 @@
-import {
-  DocumentationPageSnapshot,
-  DocumentationPageV2,
-  ElementGroup,
-  ElementGroupSnapshot,
-} from "@supernova-studio/model";
-import * as Y from "yjs";
-import { ZodSchema, ZodTypeDef } from "zod";
-import { DocumentationHierarchySettings } from "../design-system-content";
-
-type YJSSerializable = { id: string };
-
-export class VersionRoomBaseYDoc {
-  private readonly yDoc: Y.Doc;
-
-  constructor(yDoc: Y.Doc) {
-    this.yDoc = yDoc;
-  }
-
-  //
-  // Pages
-  //
-
-  getPages(): DocumentationPageV2[] {
-    return this.getObjects(this.pagesYMap, DocumentationPageV2);
-  }
-
-  updatePages(pages: DocumentationPageV2[]) {
-    pages = pages.map(page => {
-      // We remove blocks from the payload here because it will not get parsed anyway
-      return {
-        ...page,
-        data: {
-          configuration: page.data.configuration,
-        },
-      };
-    });
-
-    this.setObjects(this.pagesYMap, pages);
-  }
-
-  deletePages(ids: string[]) {
-    this.deleteObjects(this.pagesYMap, ids);
-  }
-
-  private get pagesYMap() {
-    return this.yDoc.getMap<object>("documentationPages");
-  }
-
-  //
-  // Groups
-  //
-
-  getGroups(): ElementGroup[] {
-    return this.getObjects(this.groupsYMap, ElementGroup);
-  }
-
-  updateGroups(groups: ElementGroup[]) {
-    this.setObjects(this.groupsYMap, groups);
-  }
-
-  deleteGroups(ids: string[]) {
-    this.deleteObjects(this.groupsYMap, ids);
-  }
-
-  private get groupsYMap() {
-    return this.yDoc.getMap<object>("documentationGroups");
-  }
-
-  //
-  // Documentation internal settings
-  //
-
-  getDocumentationInternalSettings(): DocumentationHierarchySettings {
-    const map = this.internalSettingsYMap;
-
-    const rawSettings: Record<keyof DocumentationHierarchySettings, any> = {
-      routingVersion: map.get("routingVersion"),
-      isDraftFeatureAdopted: map.get("isDraftFeatureAdopted") ?? 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);
-    map.set("isDraftFeatureAdopted", settings.isDraftFeatureAdopted);
-  }
-
-  private get internalSettingsYMap() {
-    return this.yDoc.getMap<unknown>("documentationInternalSettings");
-  }
-
-  //
-  // Documentation page snapshot
-  //
-
-  getPageSnapshots(): DocumentationPageSnapshot[] {
-    return this.getObjects(this.documentationPagePublishedStatesYMap, DocumentationPageSnapshot);
-  }
-
-  updatePageSnapshots(snapshots: DocumentationPageSnapshot[]) {
-    this.setObjects(this.documentationPagePublishedStatesYMap, snapshots);
-  }
-
-  deletePageSnapshots(ids: string[]) {
-    this.deleteObjects(this.documentationPagePublishedStatesYMap, ids);
-  }
-
-  private get documentationPagePublishedStatesYMap() {
-    return this.yDoc.getMap<object>("documentationPageSnapshots");
-  }
-
-  //
-  // Documentation group snapshots
-  //
-
-  getGroupSnapshots(): ElementGroupSnapshot[] {
-    return this.getObjects(this.documentationGroupPublishedStatesYMap, ElementGroupSnapshot);
-  }
-
-  updateGroupSnapshots(snapshots: ElementGroupSnapshot[]) {
-    this.setObjects(this.documentationGroupPublishedStatesYMap, snapshots);
-  }
-
-  deleteGroupSnapshots(ids: string[]) {
-    this.deleteObjects(this.documentationGroupPublishedStatesYMap, ids);
-  }
-
-  private get documentationGroupPublishedStatesYMap() {
-    return this.yDoc.getMap<object>("documentationGroupSnapshots");
-  }
-
-  //
-  // Utils
-  //
-
-  private getObjects<T extends YJSSerializable, I>(map: Y.Map<object>, schema: ZodSchema<T, ZodTypeDef, I>): T[] {
-    const results: T[] = [];
-    map.forEach(object => results.push(schema.parse(object)));
-    return results;
-  }
-
-  private setObjects<T extends YJSSerializable>(map: Y.Map<object>, objects: T[]) {
-    objects.forEach(o => map.set(o.id, JSON.parse(JSON.stringify(o))));
-  }
-
-  private deleteObjects(map: Y.Map<object>, ids: string[]) {
-    ids.forEach(id => map.delete(id));
-  }
-
-  //
-  // 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

@@ -1,298 +0,0 @@
-import {
-  DocumentationItemConfigurationV2,
-  DocumentationPageSnapshot,
-  DocumentationPageV2,
-  ElementGroup,
-  ElementGroupSnapshot,
-  defaultDocumentationItemConfigurationV2,
-  mapByUnique,
-} from "@supernova-studio/model";
-import * as Y from "yjs";
-import {
-  DTODocumentationDraftState,
-  DTODocumentationDraftStateUpdated,
-  DTODocumentationHierarchyV2,
-  documentationItemConfigurationToDTOV2,
-  documentationPagesToDTOV2,
-  elementGroupsToDocumentationGroupDTOV2,
-} from "../../api";
-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(): DTODocumentationHierarchyV2 {
-    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 settings = doc.getDocumentationInternalSettings();
-
-    // Convert pages to DTOs
-    const pageDTOs = documentationPagesToDTOV2(pages, groups, settings.routingVersion);
-    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,
-        deletedGroups: [],
-        deletedPages: [],
-      };
-    }
-
-    const pageDraftStates = this.buildPageDraftStates(pages, pageSnapshots);
-    pageDTOs.forEach(p => {
-      const draftState = 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);
-    });
-
-    // 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());
-
-    // 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;
-    });
-
-    // Convert deleted groups to DTOs with draft states
-    const deletedGroupDTOs = elementGroupsToDocumentationGroupDTOV2(deletedGroups, deletedPages).map(g => {
-      return { ...g, draftState: { changeType: "Deleted" } } as const;
-    });
-
-    return {
-      pages: pageDTOs,
-      groups: groupDTOs,
-
-      deletedPages: deletedPageDTOs,
-      deletedGroups: deletedGroupDTOs,
-    };
-  }
-
-  //
-  // Drafts - Pages
-  //
-
-  private buildPageDraftStates(
-    pages: DocumentationPageV2[],
-    pageSnapshots: DocumentationPageSnapshot[]
-  ): Map<string, DTODocumentationDraftState> {
-    const doc = new VersionRoomBaseYDoc(this.yDoc);
-
-    // Read room data
-    const pageHashes = doc.getDocumentationPageContentHashes();
-    const publishedSnapshots = 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>();
-
-    pages.forEach(page => {
-      // Published state
-      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);
-      }
-
-      // 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,
-    };
-  }
-
-  //
-  // Drafts - Groups
-  //
-
-  private buildGroupDraftStates(
-    groups: ElementGroup[],
-    groupSnapshots: ElementGroupSnapshot[]
-  ): Map<string, DTODocumentationDraftState> {
-    const doc = new VersionRoomBaseYDoc(this.yDoc);
-
-    // Read room data
-    const publishedSnapshots = 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 => {
-      // Current state
-      const currentState: ItemState = this.itemStateFromGroup(group);
-
-      // Published state
-      const snapshot = publishedSnapshotsByGroupId.get(group.id);
-      let publishedState: ItemState | undefined;
-      if (snapshot) {
-        const publishedGroup = publishedGroupsById.get(snapshot.group.id)!;
-        publishedState = this.itemStateFromGroup(publishedGroup);
-      }
-
-      // 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: "-",
-    };
-  }
-
-  //
-  // 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;
-  }
-
-  //
-  // Update page content hash
-  //
-
-  notifyDocumentationPageContentUpdated(pageId: string, content: DocumentationPageEditorModel) {
-    const pageContentHash = generatePageContentHash(content, 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;
-  }
-}

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,6 +0,0 @@
-import { generateHash } from "../../utils";
-import { DocumentationPageEditorModel } from "../docs-editor";
-
-export function generatePageContentHash(content: DocumentationPageEditorModel, debug = false) {
-  return generateHash(content, debug);
-}