@supernova-studio/client 0.58.19 → 1.0.0-alpha.3

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,78 +0,0 @@
-import {
-  DocumentationPageApproval,
-  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?: Partial<DocumentationHierarchySettings>;
-
-  pageHashesToUpdate?: Record<string, string>;
-
-  pageApprovals?: DocumentationPageApproval[];
-  pageApprovalIdsToDelete?: 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);
-      transaction.pageApprovals && yDoc.updateApprovalStates(transaction.pageApprovals);
-      transaction.pageApprovalIdsToDelete && yDoc.removeApprovalStates(transaction.pageApprovalIdsToDelete);
-    });
-  }
-
-  getDocumentationPageContentHashes() {
-    const versionDoc = new VersionRoomBaseYDoc(this.yDoc);
-
-    // Limit each hash string by 100 characters
-    const validHashes = Object.entries(versionDoc.getDocumentationPageContentHashes()).filter(e => {
-      return e[1].length < 100;
-    });
-
-    return Object.fromEntries(validHashes);
-  }
-}

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

@@ -1,211 +0,0 @@
-import {
-  DocumentationPageApproval,
-  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,
-      isApprovalFeatureEnabled: map.get("isApprovalFeatureEnabled") ?? false,
-      approvalRequiredForPublishing: map.get("approvalRequiredForPublishing") ?? false,
-    };
-
-    const settingsParseResult = DocumentationHierarchySettings.safeParse(rawSettings);
-    if (!settingsParseResult.success) {
-      return {
-        routingVersion: "2",
-        isDraftFeatureAdopted: false,
-        isApprovalFeatureEnabled: false,
-        approvalRequiredForPublishing: false,
-      };
-    }
-
-    return settingsParseResult.data;
-  }
-
-  updateDocumentationInternalSettings(settings: Partial<DocumentationHierarchySettings>) {
-    const map = this.internalSettingsYMap;
-    map.set("routingVersion", settings.routingVersion ?? map.get("routingVersion"));
-    map.set("isDraftFeatureAdopted", settings.isDraftFeatureAdopted ?? map.get("isDraftFeatureAdopted"));
-    map.set("isApprovalFeatureEnabled", settings.isApprovalFeatureEnabled ?? map.get("isApprovalFeatureEnabled"));
-    map.set(
-      "approvalRequiredForPublishing",
-      settings.approvalRequiredForPublishing ?? map.get("approvalRequiredForPublishing")
-    );
-  }
-
-  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) => {
-      if (typeof hash === "string") 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");
-  }
-
-  // Approval states
-  updateApprovalStates(updates: DocumentationPageApproval[]) {
-    this.setObjects(this.documentationPageApprovalsMap, updates);
-  }
-
-  removeApprovalStates(ids: string[]) {
-    this.deleteObjects(this.documentationPageApprovalsMap, ids);
-  }
-
-  getApprovals() {
-    return this.getObjects(this.documentationPageApprovalsMap, DocumentationPageApproval);
-  }
-
-  private get documentationPageApprovalsMap() {
-    return this.yDoc.getMap<object>("documentationPageApprovals");
-  }
-}