@supernova-studio/client 0.13.0 → 0.15.0

package/package.json

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

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

@@ -6,7 +6,7 @@ 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 DocumentationPageStructureV2DTO = DocumentationPageV2.omit({
+export const DTODocumentationPageStructureV2 = DocumentationPageV2.omit({
   data: true,
   meta: true,
   parentPersistentId: true,
@@ -16,13 +16,13 @@ export const DocumentationPageStructureV2DTO = DocumentationPageV2.omit({
   path: z.string(),
 });
 
-export const DocumentationPageV2DTO = DocumentationPageStructureV2DTO.extend(DocumentationPageV2.shape.data.shape);
+export const DTODocumentationPageV2 = DTODocumentationPageStructureV2.extend(DocumentationPageV2.shape.data.shape);
 
-export const DocumentationHierarchyV2DTO = z.object({
-  pages: z.array(DocumentationPageStructureV2DTO),
+export const DTODocumentationHierarchyV2 = z.object({
+  pages: z.array(DTODocumentationPageStructureV2),
   groups: z.array(DocumentationGroupStructureDTO),
 });
 
-export type DocumentationPageV2DTO = z.infer<typeof DocumentationPageV2DTO>;
-export type DocumentationPageStructureV2DTO = z.infer<typeof DocumentationPageStructureV2DTO>;
-export type DocumentationHierarchyV2DTO = z.infer<typeof DocumentationHierarchyV2DTO>;
+export type DTODocumentationPageV2 = z.infer<typeof DTODocumentationPageV2>;
+export type DTODocumentationPageStructureV2 = z.infer<typeof DTODocumentationPageStructureV2>;
+export type DTODocumentationHierarchyV2 = z.infer<typeof DTODocumentationHierarchyV2>;

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

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

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

package/src/api/requests/index.ts

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

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

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

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

package/src/api/responses/index.ts

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

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

@@ -1,15 +1,38 @@
 import * as Y from "yjs";
-import { DocumentationHierarchyV2DTO, DocumentationPageStructureV2DTO } from "../api/dto/documentation-v2";
+import { DTODocumentationHierarchyV2, DTODocumentationPageStructureV2 } from "../api/dto/documentation-v2";
 import { DocumentationGroupStructureDTO } from "../api";
 
-export function documentationHierarchyToYjs(documentationHierarchy: DocumentationHierarchyV2DTO, doc: Y.Doc) {
+//
+// Types
+//
+
+type ItemsToDelete = {
+  pagePersistentIdsToDelete: string[];
+  groupPersistentIdsToDelete: string[];
+};
+
+//
+// Init
+//
+
+export function documentationHierarchyToYjs(
+  doc: Y.Doc,
+  documentationHierarchy: DTODocumentationHierarchyV2,
+  itemsToDelete: ItemsToDelete
+) {
   doc.transact(trx => {
-    const pagesMap = trx.doc.getMap("documentationPages");
+    const pagesMap = getPagesYMap(trx.doc);
+    itemsToDelete.pagePersistentIdsToDelete.forEach(persistentId => {
+      pagesMap.delete(persistentId);
+    });
     documentationHierarchy.pages.forEach(page => {
       pagesMap.set(page.persistentId, page);
     });
 
-    const groupsMap = trx.doc.getMap("documentationGroups");
+    const groupsMap = getGroupsYMap(trx.doc);
+    itemsToDelete.groupPersistentIdsToDelete.forEach(persistentId => {
+      groupsMap.delete(persistentId);
+    });
     documentationHierarchy.groups.forEach(group => {
       groupsMap.set(group.persistentId, group);
     });
@@ -18,13 +41,13 @@ export function documentationHierarchyToYjs(documentationHierarchy: Documentatio
   return doc;
 }
 
-export function yjsToDocumentationHierarchy(doc: Y.Doc): DocumentationHierarchyV2DTO {
-  const pagesMap = doc.getMap("documentationPages");
-  const groupsMap = doc.getMap("documentationGroups");
+export function yjsToDocumentationHierarchy(doc: Y.Doc): DTODocumentationHierarchyV2 {
+  const pagesMap = getPagesYMap(doc);
+  const groupsMap = getGroupsYMap(doc);
 
-  const pages: DocumentationPageStructureV2DTO[] = [];
+  const pages: DTODocumentationPageStructureV2[] = [];
   pagesMap.forEach(page => {
-    pages.push(DocumentationPageStructureV2DTO.parse(page));
+    pages.push(DTODocumentationPageStructureV2.parse(page));
   });
 
   const groups: DocumentationGroupStructureDTO[] = [];
@@ -38,4 +61,14 @@ export function yjsToDocumentationHierarchy(doc: Y.Doc): DocumentationHierarchyV
   };
 }
 
-// TODO Update page and update group
+//
+// Internals
+//
+
+function getPagesYMap(doc: Y.Doc) {
+  return doc.getMap<DTODocumentationPageStructureV2>("documentationPages");
+}
+
+function getGroupsYMap(doc: Y.Doc) {
+  return doc.getMap<DocumentationGroupStructureDTO>("documentationGroups");
+}

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

@@ -5,7 +5,7 @@ type UpdateDocumentationItemConfiguration = Partial<DocumentationItemConfigurati
   header?: Partial<DocumentationItemHeader>;
 };
 
-export function itemConfigurationToYjs(item: UpdateDocumentationItemConfiguration, yDoc: Y.Doc) {
+export function itemConfigurationToYjs(yDoc: Y.Doc, item: UpdateDocumentationItemConfiguration) {
   yDoc.transact(trx => {
     const header = item.header;
 

package/src/api/requests/post-bulk-doc-page-elements.ts

@@ -1,47 +0,0 @@
-import { z } from "zod";
-
-import { DocumentationItemConfiguration } from "@supernova-studio/model";
-
-export const CreateBulkElementsInput = z.object({
-  parentPersistentId: z.string().uuid(),
-  persistentId: z.string().uuid(),
-  title: z.string(),
-  configuration: DocumentationItemConfiguration.optional(),
-  afterPersistentId: z.string().uuid().optional(),
-});
-
-export type CreateBulkElementsInput = z.infer<typeof CreateBulkElementsInput>;
-
-export const UpdateBulkElementsInput = z.object({
-  id: z.string(),
-  title: z.string().optional(),
-  configuration: DocumentationItemConfiguration.optional(),
-  parentPersistentId: z.string().optional(),
-  afterPersistentId: z.string().optional(),
-});
-
-export type UpdateBulkElementsInput = z.infer<typeof UpdateBulkElementsInput>;
-
-export const DeleteBulkElementsInput = z.array(z.string());
-
-export type DeleteBulkElementsInput = z.infer<typeof DeleteBulkElementsInput>;
-
-export const DuplicateBulkElementsInput = z.object({
-  id: z.string(),
-  persistentId: z.string().uuid(),
-  parentPersistentId: z.string().uuid(),
-  afterPersistentId: z.string().uuid().optional(),
-});
-
-export type DuplicateBulkElementsInput = z.infer<typeof DuplicateBulkElementsInput>;
-
-export const BulkEditDocPageElementsInput = z.object({
-  documentationPages: z.object({
-    create: z.array(CreateBulkElementsInput).optional(),
-    update: z.array(UpdateBulkElementsInput).optional(),
-    delete: DeleteBulkElementsInput.optional(),
-    duplicate: z.array(DuplicateBulkElementsInput).optional(),
-  }),
-});
-
-export type BulkEditDocPageElementsInput = z.infer<typeof BulkEditDocPageElementsInput>;