@supernova-studio/client 0.36.2 → 0.38.0

package/package.json

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

package/src/api/conversion/design-systems/elements/properties/property-value.ts

@@ -1,4 +1,4 @@
-import { ElementPropertyValue, SupernovaException } from "@supernova-studio/model";
+import { ElementPropertyValue } from "@supernova-studio/model";
 import { DTOElementPropertyValue } from "packages/client/src/api/dto/elements/properties/property-values";
 
 export function elementPropertyValueToDto(elementPropertyValue: ElementPropertyValue): DTOElementPropertyValue {
@@ -15,7 +15,7 @@ export function elementPropertyValueToDto(elementPropertyValue: ElementPropertyV
     value = elementPropertyValue.referenceValue;
     valuePreview = elementPropertyValue.referenceValuePreview;
   } else {
-    throw SupernovaException.shouldNotHappen(`Invalid element property value, id: ${elementPropertyValue.id}`);
+    value = undefined;
   }
   return {
     id: elementPropertyValue.id,

package/src/api/conversion/design-systems/index.ts

@@ -1,3 +1,3 @@
-export * from "./brand";
 export * from "./elements";
+export * from "./brand";
 export * from "./view";

package/src/api/conversion/documentation/documentation-elements-to-hierarchy-v2-dto.ts

@@ -1,7 +1,7 @@
-import { documentationPagesToStructureDTOV2 } from "./documentation-page-v2-to-dto";
-import { elementGroupsToDocumentationGroupStructureDTO } from "./documentation-group-to-dto";
 import { 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";
 
 // The fact that DTO conversion is located here instead of main backend code is due to the fact
 // that we store page and group data in YJS documents in the same way as they are stored in the database.
@@ -11,10 +11,11 @@ import { DTODocumentationHierarchyV2 } from "../../dto";
 
 export function documentationElementsToHierarchyDto(
   docPages: DocumentationPageV2[],
-  docGroups: ElementGroup[]
+  docGroups: ElementGroup[],
+  routingVersion: string
 ): DTODocumentationHierarchyV2 {
   return {
-    pages: documentationPagesToStructureDTOV2(docPages, docGroups),
-    groups: elementGroupsToDocumentationGroupStructureDTO(docGroups, docPages),
+    pages: documentationPagesToStructureDTOV2(docPages, docGroups, routingVersion),
+    groups: elementGroupsToDocumentationGroupStructureDTOV2(docGroups, docPages),
   };
 }

package/src/api/conversion/documentation/documentation-group-v1-to-dto.ts

@@ -0,0 +1,85 @@
+import { DocumentationGroupV1, DocumentationPageV1, DocumentationPageV2, groupBy } from "@supernova-studio/model";
+import { DTODocumentationGroupStructureV1, DTODocumentationGroupV1 } from "../../dto/elements/documentation/group-v1";
+import {
+  documentationItemConfigurationToDTOV1,
+  dtoDefaultItemConfigurationV1,
+} from "./documentation-item-configuration-v1-to-dto";
+
+// The fact that DTO conversion is located here instead of main backend code is due to the fact
+// that we store page and group data in YJS documents in the same way as they are stored in the database.
+// Therefore, we need to expose this conversion to the client so that it can consume data from YJS documents.
+//
+// Please do not put more DTO conversion here unless you know what you're doing.
+
+export function elementGroupsToDocumentationGroupStructureDTOV1(
+  groups: DocumentationGroupV1[],
+  pages: (DocumentationPageV1 | DocumentationPageV2)[]
+): DTODocumentationGroupStructureV1[] {
+  const childrenIdsMap = calculateChildrenIdsMapV1(pages, groups);
+
+  return groups.map(group => elementGroupToDocumentationGroupStructureDTOV1(group, childrenIdsMap));
+}
+
+export function elementGroupsToDocumentationGroupDTOV1(
+  groups: DocumentationGroupV1[],
+  pages: (DocumentationPageV1 | DocumentationPageV2)[]
+): DTODocumentationGroupV1[] {
+  const childrenIdsMap = calculateChildrenIdsMapV1(pages, groups);
+
+  return groups.map(group => {
+    return {
+      ...elementGroupToDocumentationGroupStructureDTOV1(group, childrenIdsMap),
+      configuration: group.data?.configuration
+        ? documentationItemConfigurationToDTOV1(group.data.configuration)
+        : dtoDefaultItemConfigurationV1,
+    };
+  });
+}
+
+function elementGroupToDocumentationGroupStructureDTOV1(
+  group: DocumentationGroupV1,
+  childrenIdsMap: Map<string, string[]>
+): DTODocumentationGroupStructureV1 {
+  const childrenIds = childrenIdsMap.get(group.persistentId) ?? [];
+
+  if (!group.shortPersistentId) {
+    throw new Error(`Short persistent id is required for docs groups, group id: ${group.id}`);
+  }
+
+  return {
+    id: group.id,
+    designSystemVersionId: group.designSystemVersionId,
+    persistentId: group.persistentId,
+    slug: group.slug,
+    userSlug: group.userSlug,
+    createdAt: group.createdAt,
+    updatedAt: group.updatedAt,
+    title: group.meta.name,
+    childrenIds: childrenIds,
+    isRoot: !group.parentPersistentId,
+    groupBehavior: group.data?.behavior ?? "Group",
+    shortPersistentId: group.shortPersistentId,
+    type: "Group",
+  };
+}
+
+function calculateChildrenIdsMapV1(
+  elements: { persistentId: string; parentPersistentId: string; sortOrder: number }[],
+  groups: DocumentationGroupV1[]
+): Map<string, string[]> {
+  const byParentId = groupBy([...elements, ...groups], e => e.parentPersistentId);
+
+  const childrenIdsMap = new Map<string, string[]>();
+
+  for (const [parentPersistentId, children] of byParentId) {
+    if (!parentPersistentId) continue;
+    children.sort((lhs, rhs) => lhs.sortOrder - rhs.sortOrder);
+
+    childrenIdsMap.set(
+      parentPersistentId,
+      children.map(c => c.persistentId)
+    );
+  }
+
+  return childrenIdsMap;
+}

package/src/api/conversion/documentation/{documentation-group-to-dto.ts → documentation-group-v2-to-dto.ts}

@@ -1,7 +1,11 @@
-import { defaultDocumentationItemHeaderV2, DocumentationPageV1, groupBy } from "@supernova-studio/model";
-import { DocumentationPageV2 } from "@supernova-studio/model";
-import { ElementGroup } from "@supernova-studio/model";
-import { DTODocumentationGroupV2, DTODocumentationGroupStructureV2 } from "../../dto";
+import {
+  defaultDocumentationItemHeaderV2,
+  DocumentationPageV1,
+  DocumentationPageV2,
+  ElementGroup,
+  groupBy,
+} from "@supernova-studio/model";
+import { DTODocumentationGroupStructureV2, DTODocumentationGroupV2 } from "../../dto";
 
 // The fact that DTO conversion is located here instead of main backend code is due to the fact
 // that we store page and group data in YJS documents in the same way as they are stored in the database.
@@ -9,24 +13,24 @@ import { DTODocumentationGroupV2, DTODocumentationGroupStructureV2 } from "../..
 //
 // Please do not put more DTO conversion here unless you know what you're doing.
 
-export function elementGroupsToDocumentationGroupStructureDTO(
+export function elementGroupsToDocumentationGroupStructureDTOV2(
   groups: ElementGroup[],
   pages: (DocumentationPageV1 | DocumentationPageV2)[]
 ): DTODocumentationGroupStructureV2[] {
-  const childrenIdsMap = calculateChildrenIdsMap(pages, groups);
+  const childrenIdsMap = calculateChildrenIdsMapV2(pages, groups);
 
-  return groups.map(group => elementGroupToDocumentationGroupStructureDTO(group, childrenIdsMap));
+  return groups.map(group => elementGroupToDocumentationGroupStructureDTOV2(group, childrenIdsMap));
 }
 
-export function elementGroupsToDocumentationGroupDTO(
+export function elementGroupsToDocumentationGroupDTOV2(
   groups: ElementGroup[],
   pages: (DocumentationPageV1 | DocumentationPageV2)[]
 ): DTODocumentationGroupV2[] {
-  const childrenIdsMap = calculateChildrenIdsMap(pages, groups);
+  const childrenIdsMap = calculateChildrenIdsMapV2(pages, groups);
 
   return groups.map(group => {
     return {
-      ...elementGroupToDocumentationGroupStructureDTO(group, childrenIdsMap),
+      ...elementGroupToDocumentationGroupStructureDTOV2(group, childrenIdsMap),
       configuration: group.data?.configuration ?? {
         showSidebar: true,
         header: defaultDocumentationItemHeaderV2,
@@ -35,7 +39,7 @@ export function elementGroupsToDocumentationGroupDTO(
   });
 }
 
-function elementGroupToDocumentationGroupStructureDTO(
+function elementGroupToDocumentationGroupStructureDTOV2(
   group: ElementGroup,
   childrenIdsMap: Map<string, string[]>
 ): DTODocumentationGroupStructureV2 {
@@ -62,7 +66,7 @@ function elementGroupToDocumentationGroupStructureDTO(
   };
 }
 
-function calculateChildrenIdsMap(
+function calculateChildrenIdsMapV2(
   elements: { persistentId: string; parentPersistentId: string; sortOrder: number }[],
   groups: ElementGroup[]
 ): Map<string, string[]> {

package/src/api/conversion/documentation/documentation-item-configuration-v1-to-dto.ts

@@ -0,0 +1,46 @@
+import {
+  ColorTokenData,
+  DocumentationItemConfigurationV1,
+  DocumentationItemHeaderAlignment,
+  DocumentationItemHeaderImageScaleType,
+} from "@supernova-studio/model";
+import { DTODocumentationItemConfigurationV1 } from "../../dto";
+
+export const dtoDefaultItemConfigurationV1: DTODocumentationItemConfigurationV1 = {
+  showSidebar: true,
+  header: {
+    alignment: DocumentationItemHeaderAlignment.Left,
+    backgroundImageScaleType: DocumentationItemHeaderImageScaleType.AspectFill,
+    description: "",
+    showBackgroundOverlay: false,
+    showCoverText: true,
+  },
+};
+
+export function documentationItemConfigurationToDTOV1(
+  config: DocumentationItemConfigurationV1
+): DTODocumentationItemConfigurationV1 {
+  const { header, showSidebar } = config;
+
+  const { backgroundColor, foregroundColor, ...headerRest } = header;
+
+  return {
+    showSidebar,
+    header: {
+      ...headerRest,
+      backgroundColor: colorToDTOV1(backgroundColor ?? undefined),
+      foregroundColor: colorToDTOV1(foregroundColor ?? undefined),
+    },
+  };
+}
+
+function colorToDTOV1(color: ColorTokenData | undefined) {
+  if (!color) return undefined;
+  if (color.aliasTo) return { aliasTo: color.aliasTo };
+  if (!color.value) return undefined;
+
+  if (typeof color.value === "string") return { value: color.value };
+  if (typeof color.value.color === "string") return { value: color.value.color };
+
+  return undefined;
+}

package/src/api/conversion/documentation/documentation-page-to-dto-utils.ts

@@ -1,5 +1,11 @@
-import { DocumentationPageV1, DocumentationPageV2, ElementGroup, slugify } from "@supernova-studio/model";
-import { mapByUnique } from "@supernova-studio/model";
+import {
+  DocumentationGroupV1,
+  DocumentationPageV1,
+  DocumentationPageV2,
+  ElementGroup,
+  mapByUnique,
+  slugify,
+} from "@supernova-studio/model";
 
 type GroupLike = {
   persistentId: string;
@@ -13,8 +19,9 @@ type GroupLike = {
 // Please do not put more DTO conversion here unless you know what you're doing.
 
 export function buildDocPagePublishPaths(
-  groups: ElementGroup[],
-  pages: (DocumentationPageV1 | DocumentationPageV2)[]
+  groups: (ElementGroup | DocumentationGroupV1)[],
+  pages: (DocumentationPageV1 | DocumentationPageV2)[],
+  routingVersion: string
 ): Map<string, string> {
   const groupPersistentIdToGroupMap = mapByUnique(groups, group => group.persistentId);
   const result = new Map<string, string>();
@@ -35,7 +42,11 @@ export function buildDocPagePublishPaths(
     pathV1 = `/${pathV1}`;
     pathV2 = `/${pathV2}`;
 
-    result.set(page.persistentId, pathV2);
+    if (routingVersion === "2") {
+      result.set(page.persistentId, pathV2);
+    } else {
+      result.set(page.persistentId, pathV1);
+    }
   }
 
   return result;

package/src/api/conversion/documentation/documentation-page-v1-to-dto.ts

@@ -1,8 +1,10 @@
-import { SupernovaException } from "@supernova-studio/model";
-import { defaultDocumentationItemHeaderV1, DocumentationPageV1 } from "@supernova-studio/model";
-import { ElementGroup } from "@supernova-studio/model";
-import { buildDocPagePublishPaths } from "./documentation-page-to-dto-utils";
+import { DocumentationGroupV1, DocumentationPageV1, SupernovaException } from "@supernova-studio/model";
 import { DocumentationPageV1DTO } from "../../dto";
+import {
+  documentationItemConfigurationToDTOV1,
+  dtoDefaultItemConfigurationV1,
+} from "./documentation-item-configuration-v1-to-dto";
+import { buildDocPagePublishPaths } from "./documentation-page-to-dto-utils";
 
 // The fact that DTO conversion is located here instead of main backend code is due to the fact
 // that we store page and group data in YJS documents in the same way as they are stored in the database.
@@ -12,9 +14,10 @@ import { DocumentationPageV1DTO } from "../../dto";
 
 export function documentationPagesToDTOV1(
   pages: DocumentationPageV1[],
-  groups: ElementGroup[]
+  groups: DocumentationGroupV1[],
+  routingVersion: string
 ): DocumentationPageV1DTO[] {
-  const pathsMap = buildDocPagePublishPaths(groups, pages);
+  const pathsMap = buildDocPagePublishPaths(groups, pages, routingVersion);
 
   return pages.map(page => {
     let path = pathsMap.get(page.persistentId);
@@ -31,10 +34,9 @@ export function documentationPagesToDTOV1(
       blocks: page.data.blocks,
       slug: page.slug,
       userSlug: page.userSlug,
-      configuration: page.data.configuration ?? {
-        showSidebar: true,
-        header: defaultDocumentationItemHeaderV1,
-      },
+      configuration: page.data.configuration
+        ? documentationItemConfigurationToDTOV1(page.data.configuration)
+        : dtoDefaultItemConfigurationV1,
       createdAt: page.createdAt,
       updatedAt: page.updatedAt,
       path: path,

package/src/api/conversion/documentation/documentation-page-v2-to-dto.ts

@@ -1,7 +1,6 @@
-import { DocumentationPageV2, defaultDocumentationItemHeaderV2 } from "@supernova-studio/model";
-import { ElementGroup } from "@supernova-studio/model";
-import { buildDocPagePublishPaths } from "./documentation-page-to-dto-utils";
+import { DocumentationPageV2, ElementGroup, defaultDocumentationItemHeaderV2 } from "@supernova-studio/model";
 import { DTODocumentationPageStructureV2, DTODocumentationPageV2 } from "../../dto";
+import { buildDocPagePublishPaths } from "./documentation-page-to-dto-utils";
 
 // The fact that DTO conversion is located here instead of main backend code is due to the fact
 // that we store page and group data in YJS documents in the same way as they are stored in the database.
@@ -11,17 +10,20 @@ import { DTODocumentationPageStructureV2, DTODocumentationPageV2 } from "../../d
 
 export function documentationPagesToStructureDTOV2(
   pages: DocumentationPageV2[],
-  groups: ElementGroup[]
+  groups: ElementGroup[],
+  routingVersion: string
 ): DTODocumentationPageStructureV2[] {
-  const pathsMap = buildDocPagePublishPaths(groups, pages);
+  const pathsMap = buildDocPagePublishPaths(groups, pages, routingVersion);
   return pages.map(page => documentationPageToStructureDTOV2(page, pathsMap));
 }
 
 export function documentationPagesToDTOV2(
   pages: DocumentationPageV2[],
-  groups: ElementGroup[]
+  groups: ElementGroup[],
+  routingVersion: string
 ): DTODocumentationPageV2[] {
-  const pathsMap = buildDocPagePublishPaths(groups, pages);
+  const pathsMap = buildDocPagePublishPaths(groups, pages, routingVersion);
+
   return pages.map(page => {
     return {
       ...documentationPageToStructureDTOV2(page, pathsMap),

package/src/api/conversion/documentation/index.ts

@@ -1,5 +1,7 @@
 export * from "./documentation-elements-to-hierarchy-v2-dto";
-export * from "./documentation-group-to-dto";
+export * from "./documentation-group-v1-to-dto";
+export * from "./documentation-group-v2-to-dto";
+export * from "./documentation-item-configuration-v1-to-dto";
 export * from "./documentation-page-to-dto-utils";
 export * from "./documentation-page-v1-to-dto";
 export * from "./documentation-page-v2-to-dto";

package/src/api/conversion/index.ts

@@ -1,3 +1,3 @@
+export * from "./design-system";
 export * from "./design-systems";
 export * from "./documentation";
-export * from "./design-system";

package/src/api/dto/design-systems/index.ts

@@ -1,4 +1,4 @@
-export * from "./design-system";
 export * from "./brand";
-export * from "./view";
+export * from "./design-system";
 export * from "./version";
+export * from "./view";

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

@@ -7,7 +7,7 @@ import {
   DTODuplicateDocumentationGroupInput,
   DTOMoveDocumentationGroupInput,
   DTOUpdateDocumentationGroupInput,
-} from "./group";
+} from "./group-v2";
 
 //
 // Read

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

@@ -0,0 +1,35 @@
+import { DocumentationGroupBehavior, ElementGroup } from "@supernova-studio/model";
+import { z } from "zod";
+import { DTODocumentationItemConfigurationV1 } from "./item-configuration-v1";
+
+//
+// Read
+//
+
+/**
+ * Structure DTO is element properties minus element data (in other words data required
+ * to display the element in the left panel)
+ */
+export const DTODocumentationGroupStructureV1 = ElementGroup.omit({
+  sortOrder: true,
+  parentPersistentId: true,
+  brandPersistentId: true,
+  meta: true,
+  childType: true,
+  data: true,
+  shortPersistentId: true,
+}).extend({
+  title: z.string(),
+  isRoot: z.boolean(),
+  childrenIds: z.array(z.string()),
+  groupBehavior: DocumentationGroupBehavior,
+  shortPersistentId: z.string(),
+  type: z.literal("Group"),
+});
+
+export const DTODocumentationGroupV1 = DTODocumentationGroupStructureV1.extend({
+  configuration: DTODocumentationItemConfigurationV1,
+});
+
+export type DTODocumentationGroupStructureV1 = z.infer<typeof DTODocumentationGroupStructureV1>;
+export type DTODocumentationGroupV1 = z.infer<typeof DTODocumentationGroupV1>;

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

@@ -1,5 +1,7 @@
 export * from "./group-action";
-export * from "./group";
+export * from "./group-v1";
+export * from "./group-v2";
+export * from "./item-configuration-v1";
 export * from "./page-actions-v2";
 export * from "./page-v1";
 export * from "./page-v2";

package/src/api/dto/elements/documentation/item-configuration-v1.ts

@@ -0,0 +1,22 @@
+import { DocumentationItemHeaderV1 } from "@supernova-studio/model";
+import { z } from "zod";
+
+const DocumentationColorV1 = z.object({
+  aliasTo: z.string().optional(),
+  value: z.string().optional(),
+});
+
+const DTODocumentationItemHeaderV1 = DocumentationItemHeaderV1.omit({
+  foregroundColor: true,
+  backgroundColor: true,
+}).extend({
+  foregroundColor: DocumentationColorV1.optional(),
+  backgroundColor: DocumentationColorV1.optional(),
+});
+
+export const DTODocumentationItemConfigurationV1 = z.object({
+  showSidebar: z.boolean(),
+  header: DTODocumentationItemHeaderV1,
+});
+
+export type DTODocumentationItemConfigurationV1 = z.infer<typeof DTODocumentationItemConfigurationV1>;

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

@@ -1,5 +1,6 @@
+import { DocumentationPageV1, PageBlockV1 } from "@supernova-studio/model";
 import { z } from "zod";
-import { DocumentationPageV1 } from "@supernova-studio/model";
+import { DTODocumentationItemConfigurationV1 } from "./item-configuration-v1";
 
 //
 // Read
@@ -10,11 +11,11 @@ export const DocumentationPageV1DTO = DocumentationPageV1.omit({
   meta: true,
   parentPersistentId: true,
   sortOrder: true,
-})
-  .extend(DocumentationPageV1.shape.data.shape)
-  .extend({
-    title: z.string(),
-    path: z.string(),
-  });
+}).extend({
+  configuration: DTODocumentationItemConfigurationV1,
+  blocks: z.array(PageBlockV1),
+  title: z.string(),
+  path: z.string(),
+});
 
 export type DocumentationPageV1DTO = z.infer<typeof DocumentationPageV1DTO>;

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

@@ -1,7 +1,6 @@
+import { DocumentationItemConfigurationV2, DocumentationPageV2 } from "@supernova-studio/model";
 import { z } from "zod";
-import { DocumentationItemConfigurationV2 } from "@supernova-studio/model";
-import { DocumentationPageV2 } from "@supernova-studio/model";
-import { DTODocumentationGroupStructureV2 } from "./group";
+import { DTODocumentationGroupStructureV2 } from "./group-v2";
 
 //
 // Read

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

@@ -1,6 +1,7 @@
+import { DocumentationPageV2, ElementGroup } from "@supernova-studio/model";
 import * as Y from "yjs";
+import { z } from "zod";
 import { DTODocumentationHierarchyV2, documentationElementsToHierarchyDto } from "../../api";
-import { DocumentationPageV2, ElementGroup } from "@supernova-studio/model";
 
 // We store pages and groups in the same way they are stored in the database.
 // This means that instead of groups having childrenIds array, all items have
@@ -22,8 +23,16 @@ type DocumentationHierarchyTransaction = {
   groups: ElementGroup[];
   pageIdsToDelete: string[];
   groupIdsToDelete: string[];
+
+  internalSettings: DocumentationHierarchySettings | undefined;
 };
 
+export const DocumentationHierarchySettings = z.object({
+  routingVersion: z.string(),
+});
+
+export type DocumentationHierarchySettings = z.infer<typeof DocumentationHierarchySettings>;
+
 //
 // Init
 //
@@ -65,30 +74,62 @@ export function documentationHierarchyToYjs(doc: Y.Doc, transaction: Documentati
 
       groupsMap.set(group.id, JSON.parse(JSON.stringify(sanitizedGroup)));
     });
+
+    // Internal settings
+    if (transaction.internalSettings) {
+      serializeDocumentationInternalSettings(trx.doc, transaction.internalSettings);
+    }
   });
 
   return doc;
 }
 
+function serializeDocumentationInternalSettings(doc: Y.Doc, settings: DocumentationHierarchySettings) {
+  const map = getInternalSettingsYMap(doc);
+
+  map.set("routingVersion", settings.routingVersion);
+}
+
 export function yjsToDocumentationHierarchy(doc: Y.Doc): DTODocumentationHierarchyV2 {
   const pagesMap = getPagesYMap(doc);
   const groupsMap = getGroupsYMap(doc);
 
+  // Read pages
   const pages: DocumentationPageV2[] = [];
   pagesMap.forEach(page => {
     pages.push(DocumentationPageV2.parse(page));
   });
 
+  // Read groups
   const groups: ElementGroup[] = [];
   groupsMap.forEach(group => {
     groups.push(ElementGroup.parse(group));
   });
 
-  const hierarchy = documentationElementsToHierarchyDto(pages, groups);
+  // Parse internalSettings
+  const internalSettings = parseDocumentationInternalSettings(doc);
+
+  // Map model onto client DTO
+  const hierarchy = documentationElementsToHierarchyDto(pages, groups, internalSettings.routingVersion ?? "2");
 
   return hierarchy;
 }
 
+function parseDocumentationInternalSettings(doc: Y.Doc): DocumentationHierarchySettings {
+  const map = getInternalSettingsYMap(doc);
+
+  const rawSettings: Record<keyof DocumentationHierarchySettings, any> = {
+    routingVersion: map.get("routingVersion"),
+  };
+
+  const settingsParseResult = DocumentationHierarchySettings.safeParse(rawSettings);
+  if (!settingsParseResult.success) {
+    return { routingVersion: "2" };
+  }
+
+  return settingsParseResult.data;
+}
+
 //
 // Internals
 //
@@ -100,3 +141,7 @@ function getPagesYMap(doc: Y.Doc) {
 function getGroupsYMap(doc: Y.Doc) {
   return doc.getMap<ElementGroup>("documentationGroups");
 }
+
+function getInternalSettingsYMap(doc: Y.Doc) {
+  return doc.getMap<unknown>("documentationInternalSettings");
+}