@supernova-studio/client 0.17.0 → 0.19.0

package/package.json

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

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

@@ -11,24 +11,28 @@ import {
 // Read
 //
 
+const SuccessPayload = z.object({
+  success: z.literal(true),
+});
+
 export const DTODocumentationGroupCreateActionOutputV2 = z.object({
   type: z.literal("DocumentationGroupCreate"),
-  output: DTODocumentationGroup,
+  output: SuccessPayload,
 });
 
 export const DTODocumentationGroupUpdateActionOutputV2 = z.object({
   type: z.literal("DocumentationGroupUpdate"),
-  output: DTODocumentationGroup,
+  output: SuccessPayload,
 });
 
 export const DTODocumentationGroupDuplicateActionOutputV2 = z.object({
   type: z.literal("DocumentationGroupDuplicate"),
-  output: DTODocumentationGroup,
+  output: SuccessPayload,
 });
 
 export const DTODocumentationGroupDeleteActionOutputV2 = z.object({
   type: z.literal("DocumentationGroupDelete"),
-  output: z.string(),
+  output: SuccessPayload,
 });
 
 export type DTODocumentationGroupCreateActionOutputV2 = z.infer<typeof DTODocumentationGroupCreateActionOutputV2>;

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

@@ -57,6 +57,10 @@ export const DTOUpdateDocumentationGroupInput = z.object({
   // Group properties
   title: z.string().optional(),
   configuration: DocumentationItemConfiguration.optional(),
+
+  // Group placement properties
+  afterPersistentId: z.string().uuid().optional(),
+  parentPersistentId: z.string().uuid().optional(),
 });
 
 export const DTODuplicateDocumentationGroupInput = z.object({
@@ -71,6 +75,20 @@ export const DTODuplicateDocumentationGroupInput = z.object({
   parentPersistentId: z.string().uuid(),
 });
 
+export const DTOCreateDocumentationTabGroupInput = z.object({
+  // New group persistent id
+  persistentId: z.string().uuid(),
+
+  // Page that will become first tab of the tab group
+  fromPageId: z.string(),
+  tabName: z.string(),
+});
+
+export const DTODeleteDocumentationTabGroupInput = z.object({
+  // Deleted group id
+  id: z.string(),
+});
+
 export const DTODeleteDocumentationGroupInput = z.object({
   // Identifier
   id: z.string(),
@@ -82,4 +100,6 @@ export const DTODeleteDocumentationGroupInput = z.object({
 export type DTOCreateDocumentationGroupInput = z.infer<typeof DTOCreateDocumentationGroupInput>;
 export type DTOUpdateDocumentationGroupInput = z.infer<typeof DTOUpdateDocumentationGroupInput>;
 export type DTODuplicateDocumentationGroupInput = z.infer<typeof DTODuplicateDocumentationGroupInput>;
+export type DTOCreateDocumentationTabGroupInput = z.infer<typeof DTOCreateDocumentationTabGroupInput>;
+export type DTODeleteDocumentationTabGroupInput = z.infer<typeof DTODeleteDocumentationTabGroupInput>;
 export type DTODeleteDocumentationGroupInput = z.infer<typeof DTODeleteDocumentationGroupInput>;

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

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

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

@@ -11,24 +11,28 @@ import {
 // Read
 //
 
+const SuccessPayload = z.object({
+  success: z.literal(true),
+});
+
 export const DTODocumentationPageCreateActionOutputV2 = z.object({
   type: z.literal("DocumentationPageCreate"),
-  output: DTODocumentationPageV2,
+  output: SuccessPayload,
 });
 
 export const DTODocumentationPageUpdateActionOutputV2 = z.object({
   type: z.literal("DocumentationPageUpdate"),
-  output: DTODocumentationPageV2,
+  output: SuccessPayload,
 });
 
 export const DTODocumentationPageDuplicateActionOutputV2 = z.object({
   type: z.literal("DocumentationPageDuplicate"),
-  output: DTODocumentationPageV2,
+  output: SuccessPayload,
 });
 
 export const DTODocumentationPageDeleteActionOutputV2 = z.object({
   type: z.literal("DocumentationPageDelete"),
-  output: z.string(),
+  output: SuccessPayload,
 });
 
 export type DTODocumentationPageCreateActionOutputV2 = z.infer<typeof DTODocumentationPageCreateActionOutputV2>;

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

@@ -1,3 +1,2 @@
 export * from "./documentation";
 export * from "./elements-action-v2";
-export * from "./elements-bulk-action-v2";

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

@@ -1,13 +1,40 @@
 import { DocumentationItemConfiguration, DocumentationItemHeader } from "@supernova-studio/model";
 import * as Y from "yjs";
+import { z } from "zod";
 
-type UpdateDocumentationItemConfiguration = Partial<DocumentationItemConfiguration> & {
-  header?: Partial<DocumentationItemHeader>;
-};
+//
+// Types
+//
 
-export function itemConfigurationToYjs(yDoc: Y.Doc, item: UpdateDocumentationItemConfiguration) {
+export const DTODocumentationPageRoomHeaderData = z.object({
+  title: z.string(),
+  configuration: DocumentationItemConfiguration,
+});
+
+export const DTODocumentationPageRoomHeaderDataUpdate = z.object({
+  title: z.string().optional(),
+  configuration: DocumentationItemConfiguration.omit({ header: true })
+    .extend({ header: DocumentationItemHeader.partial() })
+    .optional(),
+});
+
+export type DTODocumentationPageRoomHeaderData = z.infer<typeof DTODocumentationPageRoomHeaderData>;
+export type DTODocumentationPageRoomHeaderDataUpdate = z.infer<typeof DTODocumentationPageRoomHeaderDataUpdate>;
+
+//
+// YJS Bindings
+//
+
+export function itemConfigurationToYjs(yDoc: Y.Doc, item: DTODocumentationPageRoomHeaderDataUpdate) {
   yDoc.transact(trx => {
-    const header = item.header;
+    const { title, configuration } = item;
+
+    const header = configuration?.header;
+
+    if (title !== undefined) {
+      const headerYMap = trx.doc.getMap("itemTitle");
+      headerYMap.set("title", title);
+    }
 
     if (header) {
       const headerYMap = trx.doc.getMap("itemHeader");
@@ -25,15 +52,16 @@ export function itemConfigurationToYjs(yDoc: Y.Doc, item: UpdateDocumentationIte
       header.minHeight !== undefined && headerYMap.set("minHeight", header.minHeight);
     }
 
-    if (item.showSidebar !== undefined) {
+    if (configuration?.showSidebar !== undefined) {
       const configYMap = trx.doc.getMap("itemConfiguration");
-
-      configYMap.set("showSidebar", item.showSidebar);
+      configYMap.set("showSidebar", configuration.showSidebar);
     }
   });
 }
 
-export function yjsToItemConfiguration(yDoc: Y.Doc): DocumentationItemConfiguration {
+export function yjsToItemConfiguration(yDoc: Y.Doc): DTODocumentationPageRoomHeaderData {
+  const title = yDoc.getMap("itemTitle").get("title");
+
   const headerYMap = yDoc.getMap("itemHeader");
   const rawHeader = {
     description: headerYMap.get("description"),
@@ -53,5 +81,8 @@ export function yjsToItemConfiguration(yDoc: Y.Doc): DocumentationItemConfigurat
     header: rawHeader,
   };
 
-  return DocumentationItemConfiguration.parse(rawConfig);
+  return {
+    title: z.string().parse(title),
+    configuration: DocumentationItemConfiguration.parse(rawConfig),
+  };
 }

package/src/yjs/docs-editor/model/block.ts

@@ -1,9 +1,5 @@
-import { PageBlockDataV2 } from "@supernova-studio/model";
+import { PageBlockEditorModel as ModelPageBlockEditorModel } from "@supernova-studio/model";
 import { z } from "zod";
 
-export const PageBlockEditorModel = z.object({
-  id: z.string(),
-  data: PageBlockDataV2,
-});
-
+export const PageBlockEditorModel = ModelPageBlockEditorModel;
 export type PageBlockEditorModel = z.infer<typeof PageBlockEditorModel>;

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

@@ -1,32 +0,0 @@
-import { z } from "zod";
-import {
-  DTOCreateDocumentationGroupInput,
-  DTODocumentationGroup,
-  DTODuplicateDocumentationGroupInput,
-  DTOUpdateDocumentationGroupInput,
-} from "./group";
-
-//
-// Read
-//
-
-export const DTODocumentationGroupBulkActionOutputV2 = z.object({
-  created: z.array(DTODocumentationGroup),
-  updated: z.array(DTODocumentationGroup),
-  deleted: z.array(z.string()),
-});
-
-export type DTODocumentationGroupBulkActionOutputV2 = z.infer<typeof DTODocumentationGroupBulkActionOutputV2>;
-
-//
-// Write
-//
-
-export const DTODocumentationGroupBulkActionInputV2 = z.object({
-  create: z.array(DTOCreateDocumentationGroupInput).optional(),
-  update: z.array(DTOUpdateDocumentationGroupInput).optional(),
-  duplicate: z.array(DTODuplicateDocumentationGroupInput).optional(),
-  delete: z.array(z.string()).optional(),
-});
-
-export type DTODocumentationGroupBulkActionInputV2 = z.infer<typeof DTODocumentationGroupBulkActionInputV2>;

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

@@ -1,33 +0,0 @@
-import { z } from "zod";
-import {
-  DTOCreateDocumentationPageInputV2,
-  DTODeleteDocumentationPageInputV2,
-  DTODocumentationPageV2,
-  DTODuplicateDocumentationPageInputV2,
-  DTOUpdateDocumentationPageInputV2,
-} from "./page-v2";
-
-//
-// Read
-//
-
-export const DTODocumentationPageBulkActionOutputV2 = z.object({
-  created: z.array(DTODocumentationPageV2),
-  updated: z.array(DTODocumentationPageV2),
-  deleted: z.array(z.string()),
-});
-
-export type DTODocumentationPageBulkActionOutputV2 = z.infer<typeof DTODocumentationPageBulkActionOutputV2>;
-
-//
-// Write
-//
-
-export const DTODocumentationPageBulkActionInputV2 = z.object({
-  create: z.array(DTOCreateDocumentationPageInputV2).optional(),
-  update: z.array(DTOUpdateDocumentationPageInputV2).optional(),
-  duplicate: z.array(DTODuplicateDocumentationPageInputV2).optional(),
-  delete: z.array(DTODeleteDocumentationPageInputV2).optional(),
-});
-
-export type DTODocumentationPageBulkActionInputV2 = z.infer<typeof DTODocumentationPageBulkActionInputV2>;

package/src/api/dto/elements/elements-bulk-action-v2.ts

@@ -1,25 +0,0 @@
-import { z } from "zod";
-import {
-  DTODocumentationPageBulkActionInputV2,
-  DTODocumentationPageBulkActionOutputV2,
-} from "./documentation/page-bulk-action-v2";
-
-//
-// Read
-//
-
-export const DTOElementsBulkActionOutputV2 = z.object({
-  documentationPages: DTODocumentationPageBulkActionOutputV2,
-});
-
-export type DTOElementsBulkActionOutputV2 = z.infer<typeof DTOElementsBulkActionOutputV2>;
-
-//
-// Write
-//
-
-export const DTOElementsBulkActionInputV2 = z.object({
-  documentationPages: DTODocumentationPageBulkActionInputV2,
-});
-
-export type DTOElementsBulkActionInputV2 = z.infer<typeof DTOElementsBulkActionInputV2>;