@supernova-studio/client 0.15.0 → 0.17.0

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

@@ -0,0 +1,87 @@
+import { z } from "zod";
+import { DocumentationItemConfiguration as DocumentationItemConfigurationV2 } from "@supernova-studio/model";
+import { DocumentationPageV2 } from "@supernova-studio/model";
+import { DTODocumentationGroupStructure } from "./group";
+
+//
+// Read
+//
+
+/**
+ * Structure DTO is element properties minus element data (in other words data required
+ * to display the element in the left panel)
+ */
+export const DTODocumentationPageStructureV2 = DocumentationPageV2.omit({
+  data: true,
+  meta: true,
+  parentPersistentId: true,
+  sortOrder: true,
+}).extend({
+  title: z.string(),
+  path: z.string(),
+});
+
+export const DTODocumentationPageV2 = DTODocumentationPageStructureV2.extend({
+  configuration: DocumentationItemConfigurationV2,
+});
+
+export const DTODocumentationHierarchyV2 = z.object({
+  pages: z.array(DTODocumentationPageStructureV2),
+  groups: z.array(DTODocumentationGroupStructure),
+});
+
+export type DTODocumentationPageV2 = z.infer<typeof DTODocumentationPageV2>;
+export type DTODocumentationPageStructureV2 = z.infer<typeof DTODocumentationPageStructureV2>;
+export type DTODocumentationHierarchyV2 = z.infer<typeof DTODocumentationHierarchyV2>;
+
+//
+// Write
+//
+
+export const DTOCreateDocumentationPageInputV2 = z.object({
+  // Identifier
+  persistentId: z.string().uuid(),
+
+  // Page properties
+  title: z.string(),
+  configuration: DocumentationItemConfigurationV2.optional(),
+
+  // Page placement properties
+  parentPersistentId: z.string().uuid(),
+  afterPersistentId: z.string().uuid().optional(),
+});
+
+export const DTOUpdateDocumentationPageInputV2 = z.object({
+  // Identifier of the group to update
+  id: z.string(),
+
+  // Page properties
+  title: z.string().optional(),
+  configuration: DocumentationItemConfigurationV2.optional(),
+
+  // Page placement properties
+  parentPersistentId: z.string().optional(),
+  afterPersistentId: z.string().optional(),
+});
+
+export const DTODuplicateDocumentationPageInputV2 = z.object({
+  // Identifier of the page to duplicate from
+  id: z.string(),
+
+  // New page persistent id
+  persistentId: z.string().uuid(),
+
+  // Page placement properties
+  parentPersistentId: z.string().uuid(),
+  afterPersistentId: z.string().uuid().optional(),
+});
+
+export const DTODeleteDocumentationPageInputV2 = z.object({
+  // Identifier
+  id: z.string(),
+});
+
+export type DTOCreateDocumentationPageInputV2 = z.infer<typeof DTOCreateDocumentationPageInputV2>;
+export type DTOUpdateDocumentationPageInputV2 = z.infer<typeof DTOUpdateDocumentationPageInputV2>;
+export type DTODuplicateDocumentationPageInputV2 = z.infer<typeof DTODuplicateDocumentationPageInputV2>;
+export type DTODeleteDocumentationPageInputV2 = z.infer<typeof DTODeleteDocumentationPageInputV2>;

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

@@ -0,0 +1,61 @@
+import { z } from "zod";
+import {
+  DTODocumentationPageCreateActionInputV2,
+  DTODocumentationPageCreateActionOutputV2,
+  DTODocumentationPageDeleteActionInputV2,
+  DTODocumentationPageDeleteActionOutputV2,
+  DTODocumentationPageDuplicateActionInputV2,
+  DTODocumentationPageDuplicateActionOutputV2,
+  DTODocumentationPageUpdateActionInputV2,
+  DTODocumentationPageUpdateActionOutputV2,
+} from "./documentation/page-actions-v2";
+import {
+  DTODocumentationGroupCreateActionInputV2,
+  DTODocumentationGroupCreateActionOutputV2,
+  DTODocumentationGroupDeleteActionInputV2,
+  DTODocumentationGroupDeleteActionOutputV2,
+  DTODocumentationGroupDuplicateActionInputV2,
+  DTODocumentationGroupDuplicateActionOutputV2,
+  DTODocumentationGroupUpdateActionInputV2,
+  DTODocumentationGroupUpdateActionOutputV2,
+} from "./documentation/group-action";
+
+//
+// Read
+//
+
+export const DTOElementActionOutput = z.discriminatedUnion("type", [
+  // Documentation pages
+  DTODocumentationPageCreateActionOutputV2,
+  DTODocumentationPageUpdateActionOutputV2,
+  DTODocumentationPageDuplicateActionOutputV2,
+  DTODocumentationPageDeleteActionOutputV2,
+
+  // Documentation groups
+  DTODocumentationGroupCreateActionOutputV2,
+  DTODocumentationGroupUpdateActionOutputV2,
+  DTODocumentationGroupDuplicateActionOutputV2,
+  DTODocumentationGroupDeleteActionOutputV2,
+]);
+
+export type DTOElementActionOutput = z.infer<typeof DTOElementActionOutput>;
+
+//
+// Write
+//
+
+export const DTOElementActionInput = z.discriminatedUnion("type", [
+  // Documentation pages
+  DTODocumentationPageCreateActionInputV2,
+  DTODocumentationPageUpdateActionInputV2,
+  DTODocumentationPageDuplicateActionInputV2,
+  DTODocumentationPageDeleteActionInputV2,
+
+  // Documentation groups
+  DTODocumentationGroupCreateActionInputV2,
+  DTODocumentationGroupUpdateActionInputV2,
+  DTODocumentationGroupDuplicateActionInputV2,
+  DTODocumentationGroupDeleteActionInputV2,
+]);
+
+export type DTOElementActionInput = z.infer<typeof DTOElementActionInput>;

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

@@ -0,0 +1,25 @@
+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>;

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

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

package/src/api/dto/index.ts

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

package/src/api/index.ts

@@ -1,3 +1,3 @@
+export * from "./conversion";
 export * from "./dto";
-export * from "./requests";
-export * from "./responses";
+export * from "./payloads";

package/src/api/payloads/documentation/block-definitions.ts

@@ -0,0 +1,12 @@
+import { PageBlockDefinition } from "@supernova-studio/model";
+import { z } from "zod";
+
+//
+// Read
+//
+
+export const DTOGetBlockDefinitionsOutput = z.object({
+  definitions: z.array(PageBlockDefinition),
+});
+
+export type DTOGetBlockDefinitionsOutput = z.infer<typeof DTOGetBlockDefinitionsOutput>;

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

@@ -0,0 +1 @@
+export * from "./block-definitions";

package/src/api/payloads/index.ts

@@ -0,0 +1,2 @@
+export * from "./documentation";
+export * from "./liveblocks";

package/src/api/payloads/liveblocks/auth.ts

@@ -0,0 +1,7 @@
+import { z } from "zod";
+
+export const DTOLiveblocksAuthRequest = z.object({
+  room: z.string(),
+});
+
+export type DTOLiveblocksAuthRequest = z.infer<typeof DTOLiveblocksAuthRequest>;

package/src/api/payloads/liveblocks/index.ts

@@ -0,0 +1 @@
+export * from "./auth";

package/src/index.ts

@@ -1,3 +1,2 @@
 export * from "./api";
-export * from "./design-system-content";
-export * from "./docs-editor";
+export * from "./yjs";

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

@@ -0,0 +1,100 @@
+import * as Y from "yjs";
+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
+// parentPersistentId property that points to the parent item in the tree.
+// Upon read this gets converted to the format that client expects, which is
+// ordered childrenIds array on all groups.
+//
+// The decision behind it is that we potentially want to get rid of childrenIds
+// array entirely because it makes group updates more complicated. For now
+// resolving it on fly is a tradeoff for not rewriting client to stop relying
+// on children ids array.
+
+//
+// Types
+//
+
+type DocumentationHierarchyTransaction = {
+  pages: DocumentationPageV2[];
+  groups: ElementGroup[];
+  pageIdsToDelete: string[];
+  groupIdsToDelete: string[];
+};
+
+//
+// Init
+//
+
+export function documentationHierarchyToYjs(doc: Y.Doc, transaction: DocumentationHierarchyTransaction) {
+  doc.transact(trx => {
+    // Pages
+    const pagesMap = getPagesYMap(trx.doc);
+
+    transaction.pageIdsToDelete.forEach(pageId => {
+      pagesMap.delete(pageId);
+    });
+
+    transaction.pages.forEach(page => {
+      // We remove header from the payload here because it will not get parsed anyway
+      const sanitizedPage: DocumentationPageV2 = {
+        ...page,
+        data: {},
+      };
+
+      pagesMap.set(page.id, sanitizedPage);
+    });
+
+    // Groups
+    const groupsMap = getGroupsYMap(trx.doc);
+
+    transaction.groupIdsToDelete.forEach(id => {
+      groupsMap.delete(id);
+    });
+
+    transaction.groups.forEach(group => {
+      // We remove header from the payload here because it will not get parsed anyway
+      const sanitizedGroup: ElementGroup = {
+        ...group,
+        data: {},
+      };
+
+      groupsMap.set(group.id, group);
+    });
+  });
+
+  return doc;
+}
+
+export function yjsToDocumentationHierarchy(doc: Y.Doc): DTODocumentationHierarchyV2 {
+  const pagesMap = getPagesYMap(doc);
+  const groupsMap = getGroupsYMap(doc);
+
+  const pages: DocumentationPageV2[] = [];
+  pagesMap.forEach(page => {
+    pages.push(DocumentationPageV2.parse(page));
+  });
+
+  const groups: ElementGroup[] = [];
+  groupsMap.forEach(group => {
+    groups.push(ElementGroup.parse(group));
+  });
+
+  const hierarchy = documentationElementsToHierarchyDto(pages, groups);
+
+  return hierarchy;
+}
+
+//
+// Internals
+//
+
+function getPagesYMap(doc: Y.Doc) {
+  return doc.getMap<DocumentationPageV2>("documentationPages");
+}
+
+function getGroupsYMap(doc: Y.Doc) {
+  return doc.getMap<ElementGroup>("documentationGroups");
+}

package/src/yjs/index.ts

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

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

@@ -1,28 +0,0 @@
-import { z } from "zod";
-import { DocumentationPageV2 } from "@supernova-studio/model";
-import { DocumentationGroupStructureDTO } from "./documentation";
-
-/**
- * Structure DTO is element properties minus element data (in other words data required
- * to display the element in the left panel)
- */
-export const DTODocumentationPageStructureV2 = DocumentationPageV2.omit({
-  data: true,
-  meta: true,
-  parentPersistentId: true,
-  sortOrder: true,
-}).extend({
-  title: z.string(),
-  path: z.string(),
-});
-
-export const DTODocumentationPageV2 = DTODocumentationPageStructureV2.extend(DocumentationPageV2.shape.data.shape);
-
-export const DTODocumentationHierarchyV2 = z.object({
-  pages: z.array(DTODocumentationPageStructureV2),
-  groups: z.array(DocumentationGroupStructureDTO),
-});
-
-export type DTODocumentationPageV2 = z.infer<typeof DTODocumentationPageV2>;
-export type DTODocumentationPageStructureV2 = z.infer<typeof DTODocumentationPageStructureV2>;
-export type DTODocumentationHierarchyV2 = z.infer<typeof DTODocumentationHierarchyV2>;

package/src/api/dto/documentation.ts

@@ -1,29 +0,0 @@
-import { z } from "zod";
-import { DocumentationGroupBehavior, DocumentationItemConfiguration, ElementGroup } from "@supernova-studio/model";
-
-/**
- * Structure DTO is element properties minus element data (in other words data required
- * to display the element in the left panel)
- */
-export const DocumentationGroupStructureDTO = 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(),
-});
-
-export const DocumentationGroupDTO = DocumentationGroupStructureDTO.extend({
-  configuration: DocumentationItemConfiguration,
-});
-
-export type DocumentationGroupStructureDTO = z.infer<typeof DocumentationGroupStructureDTO>;
-export type DocumentationGroupDTO = z.infer<typeof DocumentationGroupDTO>;

package/src/api/requests/elements/elements-transaction-v2.ts

@@ -1,53 +0,0 @@
-import { z } from "zod";
-
-import { DocumentationItemConfiguration } from "@supernova-studio/model";
-
-//
-// Documentation Pages
-//
-
-export const DTOCreateDocumentationPageInput = z.object({
-  parentPersistentId: z.string().uuid(),
-  persistentId: z.string().uuid(),
-  title: z.string(),
-  configuration: DocumentationItemConfiguration.optional(),
-  afterPersistentId: z.string().uuid().optional(),
-});
-
-export const DTOUpdateDocumentationPageInput = z.object({
-  id: z.string(),
-  title: z.string().optional(),
-  configuration: DocumentationItemConfiguration.optional(),
-  parentPersistentId: z.string().optional(),
-  afterPersistentId: z.string().optional(),
-});
-
-export const DTODuplicateDocumentationPageInput = z.object({
-  id: z.string(),
-  persistentId: z.string().uuid(),
-  parentPersistentId: z.string().uuid(),
-  afterPersistentId: z.string().uuid().optional(),
-});
-
-export const DTODocumentationTransactionInput = z.object({
-  create: z.array(DTOCreateDocumentationPageInput).optional(),
-  update: z.array(DTOUpdateDocumentationPageInput).optional(),
-  duplicate: z.array(DTODuplicateDocumentationPageInput).optional(),
-  delete: z.array(z.string()).optional(),
-});
-
-export type DTOCreateDocumentationPageInput = z.infer<typeof DTOCreateDocumentationPageInput>;
-export type DTOUpdateDocumentationPageInput = z.infer<typeof DTOUpdateDocumentationPageInput>;
-export type DTODuplicateDocumentationPageInput = z.infer<typeof DTODuplicateDocumentationPageInput>;
-
-export type DTODocumentationTransactionInput = z.infer<typeof DTODocumentationTransactionInput>;
-
-//
-// Transaction
-//
-
-export const DTOElementsTransactionInput = z.object({
-  documentationPages: DTODocumentationTransactionInput,
-});
-
-export type DTOElementsTransactionInput = z.infer<typeof DTOElementsTransactionInput>;

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

@@ -1 +0,0 @@
-export * from "./elements-transaction-v2";

package/src/api/requests/index.ts

@@ -1,2 +0,0 @@
-export * from "./elements";
-export * from "./post-liveblocks-auth";

package/src/api/requests/post-liveblocks-auth.ts

@@ -1,4 +0,0 @@
-import { z } from "zod";
-export const PostLiveblocksAuth = z.object({
-  room: z.string(),
-});

package/src/api/responses/elements/elements-transaction-v2.ts

@@ -1,11 +0,0 @@
-import { DTODocumentationPageV2 } from "../../dto";
-
-export type DTODocumentationElementsTransactionOutput = {
-  created: DTODocumentationPageV2[];
-  updated: DTODocumentationPageV2[];
-  deleted: string[];
-};
-
-export type DTOElementsTransactionOutput = {
-  documentationPages: DTODocumentationElementsTransactionOutput;
-};

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

@@ -1 +0,0 @@
-export * from "./elements-transaction-v2";

package/src/api/responses/get-block-definitions.ts

@@ -1,8 +0,0 @@
-import { PageBlockDefinition } from "@supernova-studio/model";
-import { z } from "zod";
-
-export const GetBlockDefinitionsResponse = z.object({
-  definitions: z.array(PageBlockDefinition),
-});
-
-export type GetBlockDefinitionsResponse = z.infer<typeof GetBlockDefinitionsResponse>;

package/src/api/responses/index.ts

@@ -1,2 +0,0 @@
-export * from "./elements";
-export * from "./get-block-definitions";

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

@@ -1,74 +0,0 @@
-import * as Y from "yjs";
-import { DTODocumentationHierarchyV2, DTODocumentationPageStructureV2 } from "../api/dto/documentation-v2";
-import { DocumentationGroupStructureDTO } from "../api";
-
-//
-// Types
-//
-
-type ItemsToDelete = {
-  pagePersistentIdsToDelete: string[];
-  groupPersistentIdsToDelete: string[];
-};
-
-//
-// Init
-//
-
-export function documentationHierarchyToYjs(
-  doc: Y.Doc,
-  documentationHierarchy: DTODocumentationHierarchyV2,
-  itemsToDelete: ItemsToDelete
-) {
-  doc.transact(trx => {
-    const pagesMap = getPagesYMap(trx.doc);
-    itemsToDelete.pagePersistentIdsToDelete.forEach(persistentId => {
-      pagesMap.delete(persistentId);
-    });
-    documentationHierarchy.pages.forEach(page => {
-      pagesMap.set(page.persistentId, page);
-    });
-
-    const groupsMap = getGroupsYMap(trx.doc);
-    itemsToDelete.groupPersistentIdsToDelete.forEach(persistentId => {
-      groupsMap.delete(persistentId);
-    });
-    documentationHierarchy.groups.forEach(group => {
-      groupsMap.set(group.persistentId, group);
-    });
-  });
-
-  return doc;
-}
-
-export function yjsToDocumentationHierarchy(doc: Y.Doc): DTODocumentationHierarchyV2 {
-  const pagesMap = getPagesYMap(doc);
-  const groupsMap = getGroupsYMap(doc);
-
-  const pages: DTODocumentationPageStructureV2[] = [];
-  pagesMap.forEach(page => {
-    pages.push(DTODocumentationPageStructureV2.parse(page));
-  });
-
-  const groups: DocumentationGroupStructureDTO[] = [];
-  groupsMap.forEach(group => {
-    groups.push(DocumentationGroupStructureDTO.parse(group));
-  });
-
-  return {
-    pages,
-    groups,
-  };
-}
-
-//
-// Internals
-//
-
-function getPagesYMap(doc: Y.Doc) {
-  return doc.getMap<DTODocumentationPageStructureV2>("documentationPages");
-}
-
-function getGroupsYMap(doc: Y.Doc) {
-  return doc.getMap<DocumentationGroupStructureDTO>("documentationGroups");
-}