@supernova-studio/client 0.48.37 → 0.49.1

package/package.json

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

package/src/api/dto/documentation/approvals.ts

@@ -0,0 +1,5 @@
+import { DocumentationPageApproval } from "@supernova-studio/model";
+
+export const DTODocumentationPageApprovalState = DocumentationPageApproval;
+
+export type DTODocumentationPageApprovalState = DocumentationPageApproval;

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

@@ -1,4 +1,5 @@
 export * from "./anchor";
+export * from "./approvals";
 export * from "./block-definition";
 export * from "./block";
 export * from "./documentation-page-snapshot";

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

@@ -2,7 +2,7 @@ import { z } from "zod";
 import {
   DTOCreateDocumentationPageInputV2,
   DTODeleteDocumentationPageInputV2,
-  DTODocumentationPageV2,
+  DTODocumentationPageApprovalStateChangeInput,
   DTODuplicateDocumentationPageInputV2,
   DTOMoveDocumentationPageInputV2,
   DTORestoreDocumentationGroupInput,
@@ -53,6 +53,11 @@ export const DTODocumentationGroupRestoreActionOutput = z.object({
   output: SuccessPayload,
 });
 
+export const DTODocumentationPageApprovalStateChangeActionOutput = z.object({
+  type: z.literal("DocumentationPageApprovalStateChange"),
+  output: SuccessPayload,
+});
+
 export type DTODocumentationPageCreateActionOutputV2 = z.infer<typeof DTODocumentationPageCreateActionOutputV2>;
 export type DTODocumentationPageUpdateActionOutputV2 = z.infer<typeof DTODocumentationPageUpdateActionOutputV2>;
 export type DTODocumentationPageMoveActionOutputV2 = z.infer<typeof DTODocumentationPageMoveActionOutputV2>;
@@ -60,6 +65,9 @@ export type DTODocumentationPageDuplicateActionOutputV2 = z.infer<typeof DTODocu
 export type DTODocumentationPageDeleteActionOutputV2 = z.infer<typeof DTODocumentationPageDeleteActionOutputV2>;
 export type DTODocumentationPageRestoreActionOutput = z.infer<typeof DTODocumentationPageRestoreActionOutput>;
 export type DTODocumentationGroupRestoreActionOutput = z.infer<typeof DTODocumentationGroupRestoreActionOutput>;
+export type DTODocumentationPageApprovalStateChangeActionOutput = z.infer<
+  typeof DTODocumentationPageApprovalStateChangeActionOutput
+>;
 
 // Write
 //
@@ -99,6 +107,11 @@ export const DTODocumentationGroupRestoreActionInput = z.object({
   input: DTORestoreDocumentationGroupInput,
 });
 
+export const DTODocumentationPageApprovalStateChangeActionInput = z.object({
+  type: z.literal("DocumentationPageApprovalStateChange"),
+  input: DTODocumentationPageApprovalStateChangeInput,
+});
+
 export type DTODocumentationPageCreateActionInputV2 = z.infer<typeof DTODocumentationPageCreateActionInputV2>;
 export type DTODocumentationPageUpdateActionInputV2 = z.infer<typeof DTODocumentationPageUpdateActionInputV2>;
 export type DTODocumentationPageMoveActionInputV2 = z.infer<typeof DTODocumentationPageMoveActionInputV2>;

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

@@ -1,4 +1,6 @@
+import { DocumentationPageApprovalState } from "@supernova-studio/model";
 import { z } from "zod";
+import { DTODocumentationPageApprovalState } from "../../documentation";
 import { DTODocumentationDraftState } from "./draft-state";
 import { DTODocumentationItemConfigurationV2 } from "./item-configuration-v2";
 import { DTODocumentationPublishMetadata } from "./metadata";
@@ -32,6 +34,9 @@ export const DTODocumentationPageV2 = z.object({
   /** Defined if a page was published at least once and contains metadata about last publish */
   publishMetadata: DTODocumentationPublishMetadata.optional(),
 
+  /** Defines the approval state of the documentation page */
+  approvalState: DTODocumentationPageApprovalState.optional(),
+
   // Backward compatibility
   type: z.literal("Page"),
 });
@@ -100,6 +105,11 @@ export const DTORestoreDocumentationGroupInput = z.object({
   snapshotId: z.string().optional(),
 });
 
+export const DTODocumentationPageApprovalStateChangeInput = z.object({
+  persistentId: z.string(),
+  approvalState: DocumentationPageApprovalState.optional(),
+});
+
 export type DTOCreateDocumentationPageInputV2 = z.infer<typeof DTOCreateDocumentationPageInputV2>;
 export type DTOUpdateDocumentationPageInputV2 = z.infer<typeof DTOUpdateDocumentationPageInputV2>;
 export type DTOMoveDocumentationPageInputV2 = z.infer<typeof DTOMoveDocumentationPageInputV2>;
@@ -107,3 +117,4 @@ export type DTODuplicateDocumentationPageInputV2 = z.infer<typeof DTODuplicateDo
 export type DTODeleteDocumentationPageInputV2 = z.infer<typeof DTODeleteDocumentationPageInputV2>;
 export type DTORestoreDocumentationPageInput = z.infer<typeof DTORestoreDocumentationPageInput>;
 export type DTORestoreDocumentationGroupInput = z.infer<typeof DTORestoreDocumentationGroupInput>;
+export type DTODocumentationPageApprovalStateChangeInput = z.infer<typeof DTODocumentationPageApprovalStateChangeInput>;

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

@@ -18,6 +18,8 @@ import {
 import {
   DTODocumentationGroupRestoreActionInput,
   DTODocumentationGroupRestoreActionOutput,
+  DTODocumentationPageApprovalStateChangeActionInput,
+  DTODocumentationPageApprovalStateChangeActionOutput,
   DTODocumentationPageCreateActionInputV2,
   DTODocumentationPageCreateActionOutputV2,
   DTODocumentationPageDeleteActionInputV2,
@@ -73,6 +75,9 @@ export const DTOElementActionOutput = z.discriminatedUnion("type", [
   // Restore
   DTODocumentationPageRestoreActionOutput,
   DTODocumentationGroupRestoreActionOutput,
+
+  // Approvals
+  DTODocumentationPageApprovalStateChangeActionOutput,
 ]);
 
 export type DTOElementActionOutput = z.infer<typeof DTOElementActionOutput>;
@@ -109,6 +114,9 @@ export const DTOElementActionInput = z.discriminatedUnion("type", [
   // Restore
   DTODocumentationPageRestoreActionInput,
   DTODocumentationGroupRestoreActionInput,
+
+  // Approval
+  DTODocumentationPageApprovalStateChangeActionInput,
 ]);
 
 export type DTOElementActionInput = z.infer<typeof DTOElementActionInput>;

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

@@ -21,6 +21,7 @@ import { FrontendVersionRoomYDoc } from "../version-room/frontend";
 export const DocumentationHierarchySettings = z.object({
   routingVersion: z.string(),
   isDraftFeatureAdopted: z.boolean(),
+  isApprovalFeatureEnabled: z.boolean(),
 });
 
 export type DocumentationHierarchySettings = z.infer<typeof DocumentationHierarchySettings>;

package/src/yjs/version-room/backend.ts

@@ -1,4 +1,5 @@
 import {
+  DocumentationPageApproval,
   DocumentationPageSnapshot,
   DocumentationPageV2,
   ElementGroup,
@@ -22,7 +23,11 @@ type DocumentationHierarchyTransaction = {
   groupSnapshotIdsToDelete?: string[];
 
   internalSettings?: DocumentationHierarchySettings;
+
   pageHashesToUpdate?: Record<string, string>;
+
+  pageApprovals?: DocumentationPageApproval[];
+  pageApprovalIdsToDelete?: string[];
 };
 
 export class BackendVersionRoomYDoc {
@@ -55,6 +60,8 @@ export class BackendVersionRoomYDoc {
       // Settings
       transaction.internalSettings && yDoc.updateDocumentationInternalSettings(transaction.internalSettings);
       transaction.pageHashesToUpdate && yDoc.updateDocumentationPageContentHashes(transaction.pageHashesToUpdate);
+      transaction.pageApprovals && yDoc.updateApprovalStates(transaction.pageApprovals);
+      transaction.pageApprovalIdsToDelete && yDoc.removeApprovalStates(transaction.pageApprovalIdsToDelete);
     });
   }
 }

package/src/yjs/version-room/base.ts

@@ -1,4 +1,5 @@
 import {
+  DocumentationPageApproval,
   DocumentationPageSnapshot,
   DocumentationPageV2,
   ElementGroup,
@@ -77,6 +78,7 @@ export class VersionRoomBaseYDoc {
     const rawSettings: Record<keyof DocumentationHierarchySettings, any> = {
       routingVersion: map.get("routingVersion"),
       isDraftFeatureAdopted: map.get("isDraftFeatureAdopted") ?? false,
+      isApprovalFeatureEnabled: map.get("isApprovalFeatureEnabled") ?? false,
     };
 
     const settingsParseResult = DocumentationHierarchySettings.safeParse(rawSettings);
@@ -84,6 +86,7 @@ export class VersionRoomBaseYDoc {
       return {
         routingVersion: "2",
         isDraftFeatureAdopted: false,
+        isApprovalFeatureEnabled: false,
       };
     }
 
@@ -95,6 +98,7 @@ export class VersionRoomBaseYDoc {
 
     map.set("routingVersion", settings.routingVersion);
     map.set("isDraftFeatureAdopted", settings.isDraftFeatureAdopted);
+    map.set("isApprovalFeatureEnabled", settings.isApprovalFeatureEnabled);
   }
 
   private get internalSettingsYMap() {
@@ -182,4 +186,21 @@ export class VersionRoomBaseYDoc {
   private get documentationPageContentHashesYMap() {
     return this.yDoc.getMap<string>("documentationPageHashes");
   }
+
+  // Approval states
+  updateApprovalStates(updates: DocumentationPageApproval[]) {
+    this.setObjects(this.documentationPageApprovalsMap, updates);
+  }
+
+  removeApprovalStates(ids: string[]) {
+    this.deleteObjects(this.documentationPageApprovalsMap, ids);
+  }
+
+  getApprovals() {
+    return this.getObjects(this.documentationPageApprovalsMap, DocumentationPageApproval);
+  }
+
+  private get documentationPageApprovalsMap() {
+    return this.yDoc.getMap<object>("documentationPageApprovals");
+  }
 }

package/src/yjs/version-room/frontend.ts

@@ -1,5 +1,6 @@
 import {
   DocumentationItemConfigurationV2,
+  DocumentationPageApproval,
   DocumentationPageSnapshot,
   DocumentationPageV2,
   ElementGroup,
@@ -15,6 +16,7 @@ import {
   DTODocumentationDraftState,
   DTODocumentationDraftStateUpdated,
   DTODocumentationHierarchyV2,
+  DTODocumentationPageApprovalState,
   documentationItemConfigurationToDTOV2,
   documentationPagesToDTOV2,
   elementGroupsToDocumentationGroupDTOV2,
@@ -75,6 +77,7 @@ export class FrontendVersionRoomYDoc {
     const pageDraftStates = this.buildPageDraftCreatedAndUpdatedStates(pages, pageSnapshots);
     const pageDraftDeletedStates = this.buildPageDraftDeletedStates(pages, pageSnapshots);
     const pagePublishedMetadata = this.buildPagePublishedMetadata(pages, pageSnapshots);
+    const pageApprovalStates = this.buildPageApprovalStates(pages);
 
     pageDTOs.forEach(p => {
       // Assign draft state
@@ -84,6 +87,10 @@ export class FrontendVersionRoomYDoc {
       // Assign publish metadata
       const publishMetadata = pagePublishedMetadata.get(p.id);
       publishMetadata && (p.publishMetadata = publishMetadata);
+
+      // Assign approval state
+      const approvalState = pageApprovalStates.get(p.id);
+      approvalState && (p.approvalState = approvalState);
     });
 
     const groupDraftStates = this.buildGroupDraftCreatedAndUpdatedStates(groups, groupSnapshots);
@@ -407,4 +414,24 @@ export class FrontendVersionRoomYDoc {
       doc.getGroupSnapshots().filter(s => s.reason === "Publish").length > 0
     );
   }
+
+  isApprovalsFeatureEnabled() {
+    const doc = new VersionRoomBaseYDoc(this.yDoc);
+    const settings = doc.getDocumentationInternalSettings();
+    return settings.isApprovalFeatureEnabled;
+  }
+
+  private buildPageApprovalStates(pages: DocumentationPageV2[]) {
+    const doc = new VersionRoomBaseYDoc(this.yDoc);
+    const pageIds = pages.map(p => p.id);
+    const result = new Map<string, DTODocumentationPageApprovalState>();
+    const approvals = doc.getApprovals();
+    for (const pId of pageIds) {
+      const approval = approvals.find(approval => approval.pageId === pId);
+      if (approval) {
+        result.set(pId, approval);
+      }
+    }
+    return result;
+  }
 }