@supernova-studio/client 0.19.2 → 0.20.0

package/package.json

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

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

@@ -1,7 +1,7 @@
-import { defaultDocumentationItemHeader, DocumentationPageV1, groupBy } from "@supernova-studio/model";
+import { defaultDocumentationItemHeaderV2, DocumentationPageV1, groupBy } from "@supernova-studio/model";
 import { DocumentationPageV2 } from "@supernova-studio/model";
 import { ElementGroup } from "@supernova-studio/model";
-import { DTODocumentationGroup, DTODocumentationGroupStructure } from "../../dto";
+import { DTODocumentationGroupV2, DTODocumentationGroupStructureV2 } 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.
@@ -12,7 +12,7 @@ import { DTODocumentationGroup, DTODocumentationGroupStructure } from "../../dto
 export function elementGroupsToDocumentationGroupStructureDTO(
   groups: ElementGroup[],
   pages: (DocumentationPageV1 | DocumentationPageV2)[]
-): DTODocumentationGroupStructure[] {
+): DTODocumentationGroupStructureV2[] {
   const childrenIdsMap = calculateChildrenIdsMap(pages, groups);
 
   return groups.map(group => elementGroupToDocumentationGroupStructureDTO(group, childrenIdsMap));
@@ -21,7 +21,7 @@ export function elementGroupsToDocumentationGroupStructureDTO(
 export function elementGroupsToDocumentationGroupDTO(
   groups: ElementGroup[],
   pages: (DocumentationPageV1 | DocumentationPageV2)[]
-): DTODocumentationGroup[] {
+): DTODocumentationGroupV2[] {
   const childrenIdsMap = calculateChildrenIdsMap(pages, groups);
 
   return groups.map(group => {
@@ -29,7 +29,7 @@ export function elementGroupsToDocumentationGroupDTO(
       ...elementGroupToDocumentationGroupStructureDTO(group, childrenIdsMap),
       configuration: group.data?.configuration ?? {
         showSidebar: true,
-        header: defaultDocumentationItemHeader,
+        header: defaultDocumentationItemHeaderV2,
       },
     };
   });
@@ -38,7 +38,7 @@ export function elementGroupsToDocumentationGroupDTO(
 function elementGroupToDocumentationGroupStructureDTO(
   group: ElementGroup,
   childrenIdsMap: Map<string, string[]>
-): DTODocumentationGroupStructure {
+): DTODocumentationGroupStructureV2 {
   const childrenIds = childrenIdsMap.get(group.persistentId) ?? [];
 
   if (!group.shortPersistentId) {

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

@@ -1,5 +1,5 @@
 import { SupernovaException } from "@supernova-studio/model";
-import { defaultDocumentationItemHeader, DocumentationPageV1 } 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 { DocumentationPageV1DTO } from "../../dto";
@@ -33,7 +33,7 @@ export function documentationPagesToDTOV1(
       userSlug: page.userSlug,
       configuration: page.data.configuration ?? {
         showSidebar: true,
-        header: defaultDocumentationItemHeader,
+        header: defaultDocumentationItemHeaderV1,
       },
       createdAt: page.createdAt,
       updatedAt: page.updatedAt,

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

@@ -1,4 +1,4 @@
-import { defaultDocumentationItemHeader, DocumentationPageV2 } from "@supernova-studio/model";
+import { DocumentationPageV2, defaultDocumentationItemHeaderV2 } from "@supernova-studio/model";
 import { ElementGroup } from "@supernova-studio/model";
 import { buildDocPagePublishPaths } from "./documentation-page-to-dto-utils";
 import { DTODocumentationPageStructureV2, DTODocumentationPageV2 } from "../../dto";
@@ -27,7 +27,7 @@ export function documentationPagesToDTOV2(
       ...documentationPageToStructureDTOV2(page, pathsMap),
       configuration: page.data.configuration ?? {
         showSidebar: true,
-        header: defaultDocumentationItemHeader,
+        header: defaultDocumentationItemHeaderV2,
       },
     };
   });

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

@@ -2,7 +2,7 @@ import { z } from "zod";
 import {
   DTOCreateDocumentationGroupInput,
   DTODeleteDocumentationGroupInput,
-  DTODocumentationGroup,
+  DTODocumentationGroupV2,
   DTODuplicateDocumentationGroupInput,
   DTOMoveDocumentationGroupInput,
   DTOUpdateDocumentationGroupInput,

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

@@ -1,5 +1,5 @@
 import { z } from "zod";
-import { DocumentationGroupBehavior, DocumentationItemConfiguration, ElementGroup } from "@supernova-studio/model";
+import { DocumentationGroupBehavior, DocumentationItemConfigurationV2, ElementGroup } from "@supernova-studio/model";
 
 //
 // Read
@@ -9,7 +9,7 @@ import { DocumentationGroupBehavior, DocumentationItemConfiguration, ElementGrou
  * Structure DTO is element properties minus element data (in other words data required
  * to display the element in the left panel)
  */
-export const DTODocumentationGroupStructure = ElementGroup.omit({
+export const DTODocumentationGroupStructureV2 = ElementGroup.omit({
   sortOrder: true,
   parentPersistentId: true,
   brandPersistentId: true,
@@ -26,12 +26,12 @@ export const DTODocumentationGroupStructure = ElementGroup.omit({
   type: z.literal("Group"),
 });
 
-export const DTODocumentationGroup = DTODocumentationGroupStructure.extend({
-  configuration: DocumentationItemConfiguration,
+export const DTODocumentationGroupV2 = DTODocumentationGroupStructureV2.extend({
+  configuration: DocumentationItemConfigurationV2,
 });
 
-export type DTODocumentationGroupStructure = z.infer<typeof DTODocumentationGroupStructure>;
-export type DTODocumentationGroup = z.infer<typeof DTODocumentationGroup>;
+export type DTODocumentationGroupStructureV2 = z.infer<typeof DTODocumentationGroupStructureV2>;
+export type DTODocumentationGroupV2 = z.infer<typeof DTODocumentationGroupV2>;
 
 //
 // Write
@@ -43,7 +43,7 @@ export const DTOCreateDocumentationGroupInput = z.object({
 
   // Group properties
   title: z.string(),
-  configuration: DocumentationItemConfiguration.optional(),
+  configuration: DocumentationItemConfigurationV2.optional(),
   groupBehavior: DocumentationGroupBehavior,
 
   // Group placement properties
@@ -57,7 +57,7 @@ export const DTOUpdateDocumentationGroupInput = z.object({
 
   // Group properties
   title: z.string().optional(),
-  configuration: DocumentationItemConfiguration.optional(),
+  configuration: DocumentationItemConfigurationV2.optional(),
 });
 
 export const DTOMoveDocumentationGroupInput = z.object({

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

@@ -1,7 +1,7 @@
 import { z } from "zod";
-import { DocumentationItemConfiguration as DocumentationItemConfigurationV2 } from "@supernova-studio/model";
+import { DocumentationItemConfigurationV2 } from "@supernova-studio/model";
 import { DocumentationPageV2 } from "@supernova-studio/model";
-import { DTODocumentationGroupStructure } from "./group";
+import { DTODocumentationGroupStructureV2 } from "./group";
 
 //
 // Read
@@ -28,7 +28,7 @@ export const DTODocumentationPageV2 = DTODocumentationPageStructureV2.extend({
 
 export const DTODocumentationHierarchyV2 = z.object({
   pages: z.array(DTODocumentationPageStructureV2),
-  groups: z.array(DTODocumentationGroupStructure),
+  groups: z.array(DTODocumentationGroupStructureV2),
 });
 
 export type DTODocumentationPageV2 = z.infer<typeof DTODocumentationPageV2>;

package/src/yjs/design-system-content/index.ts

@@ -1,2 +1,3 @@
 export * from "./documentation-hierarchy";
 export * from "./item-configuration";
+export * from "./item-title";

package/src/yjs/design-system-content/item-configuration.ts

@@ -1,4 +1,4 @@
-import { DocumentationItemConfiguration, DocumentationItemHeader } from "@supernova-studio/model";
+import { DocumentationItemConfigurationV2, DocumentationItemHeaderV2 } from "@supernova-studio/model";
 import * as Y from "yjs";
 import { z } from "zod";
 
@@ -8,13 +8,13 @@ import { z } from "zod";
 
 export const DTODocumentationPageRoomHeaderData = z.object({
   title: z.string(),
-  configuration: DocumentationItemConfiguration,
+  configuration: DocumentationItemConfigurationV2,
 });
 
 export const DTODocumentationPageRoomHeaderDataUpdate = z.object({
   title: z.string().optional(),
-  configuration: DocumentationItemConfiguration.omit({ header: true })
-    .extend({ header: DocumentationItemHeader.partial() })
+  configuration: DocumentationItemConfigurationV2.omit({ header: true })
+    .extend({ header: DocumentationItemHeaderV2.partial() })
     .optional(),
 });
 
@@ -83,6 +83,6 @@ export function yjsToItemConfiguration(yDoc: Y.Doc): DTODocumentationPageRoomHea
 
   return {
     title: z.string().parse(title),
-    configuration: DocumentationItemConfiguration.parse(rawConfig),
+    configuration: DocumentationItemConfigurationV2.parse(rawConfig),
   };
 }