@supernova-studio/supernova-sdk-beta 2.4.6 → 2.4.11

package/build/types/core/areas/SDKAreaDocumentation.d.ts

@@ -1,4 +1,4 @@
-import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTODeleteDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOMoveDocumentationGroupInput, DTOCreateDocumentationTabInput, DTODocumentationPageAnchor, DTODesignElementsDataDiffResponse, DTOPublishDocumentationRequest, DTOElementActionInput, DTOElementActionOutput, DTODocumentationPageDependenciesGetResponse, type DTODocumentationPageContent } from "@supernova-studio/client";
+import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTODeleteDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOMoveDocumentationGroupInput, DTOCreateDocumentationTabInput, DTODocumentationPageAnchor, DTODesignElementsDataDiffResponse, DTOPublishDocumentationRequest, DTOPageHistoryVersionCreatePayload, DTOElementActionInput, DTOElementActionOutput, DTODocumentationPageDependenciesGetResponse, type DTODocumentationPageContent, type DTODocumentationMarkdownFetchErrorCode, type DTODocumentationMarkdownFromUrlMode } from "@supernova-studio/client";
 import { DocumentationLegacy, DocumentationLegacyModel } from "../../model/base/SDKDocumentationLegacy";
 import { DocsBlockDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockDefinition";
 import { DocsBlock } from "../../model/docs/blocks/usage/SDKDocsBlock";
@@ -8,6 +8,7 @@ import { DocsEntityPageModel } from "../../model/docs/entities/SDKDocsEntityPage
 import { DocsSection } from "../../model/docs/sections/SDKDocsSection";
 import { DocumentationLegacyGroup } from "../../model/documentation/SDKDocumentationLegacyGroup";
 import { DocumentationLegacyPage } from "../../model/documentation/SDKDocumentationLegacyPage";
+import { PageHistoryVersion, PageHistoryVersionContent } from "../../model/documentation/SDKPageHistoryVersion";
 import { DocsPublishStatus } from "../../model/enums/SDKDocsPublishStatus";
 import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
 import { ExportBuild, ExportBuildStatus } from "../../model/exporters/exporter_builds/SDKExportBuild";
@@ -29,6 +30,16 @@ export declare class AreaDocumentation {
      * @returns Raw page content DTO, including the page block/section item tree
      */
     getDocumentationContentRaw(from: RemoteVersionIdentifier, pageId: string): Promise<DTODocumentationPageContent>;
+    /** Fetches markdown content from a remote URL through the workspace git integration, storing it for the version.
+     * @param from - Remote version to fetch from
+     * @param url - URL of the markdown file
+     * @param mode - Cached returns stored content, Refresh re-downloads and stores, Preview fetches without storing
+     * @returns Markdown content, with `lastError` set when stored content is served and its last refresh failed
+     */
+    getMarkdownFromUrl(from: RemoteVersionIdentifier, url: string, mode?: DTODocumentationMarkdownFromUrlMode): Promise<{
+        content: string;
+        lastError: DTODocumentationMarkdownFetchErrorCode | null;
+    }>;
     /**
      * Fetches the differences in elements, such as design tokens and assets, that have occurred since the documentation was published.
      * @param from Remote version to fetch from
@@ -96,126 +107,126 @@ export declare class AreaDocumentation {
      * @returns Newly created documentation group
      */
     updateDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTOUpdateDocumentationGroupInput): Promise<{
-        type?: "DocumentationPageCreate";
-        output?: {
-            success?: true;
+        type: "DocumentationPageCreate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageUpdate";
-        output?: {
-            success?: true;
+        type: "DocumentationPageUpdate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageUpdateDocument";
-        output?: {
-            success?: true;
+        type: "DocumentationPageUpdateDocument";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageMove";
-        output?: {
-            success?: true;
+        type: "DocumentationPageMove";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageDuplicate";
-        output?: {
-            success?: true;
+        type: "DocumentationPageDuplicate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageDelete";
-        output?: {
-            success?: true;
+        type: "DocumentationPageDelete";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupCreate";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupCreate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationTabCreate";
-        output?: {
-            success?: true;
+        type: "DocumentationTabCreate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupUpdate";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupUpdate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupMove";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupMove";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupDuplicate";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupDuplicate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupDelete";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupDelete";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationTabGroupDelete";
-        output?: {
-            success?: true;
+        type: "DocumentationTabGroupDelete";
+        output: {
+            success: true;
         };
     } | {
-        type?: "FigmaNodeRenderAsync";
-        figmaNodes?: {
-            id?: string;
-            designSystemVersionId?: string;
-            createdAt?: Date;
-            updatedAt?: Date;
-            meta?: {
-                name?: string;
+        type: "FigmaNodeRenderAsync";
+        figmaNodes: {
+            id: string;
+            designSystemVersionId: string;
+            createdAt: Date;
+            updatedAt: Date;
+            meta: {
+                name: string;
                 description?: string;
             };
-            persistentId?: string;
-            data?: {
-                sceneNodeId?: string;
-                format?: "Png" | "Svg";
+            persistentId: string;
+            data: {
+                sceneNodeId: string;
+                format: "Png" | "Svg";
+                renderState: "Success" | "InProgress" | "Failed";
+                hasSource: boolean;
                 scale?: number;
-                renderState?: "Success" | "InProgress" | "Failed";
                 renderedImage?: {
-                    url?: string;
+                    resourceId: string;
+                    format: "Png" | "Svg";
+                    scale?: number;
                     width?: number;
                     height?: number;
-                    resourceId?: string;
-                    format?: "Png" | "Svg";
-                    scale?: number;
+                    url?: string;
                     originKey?: string;
                 };
                 renderError?: {
-                    type?: "MissingIntegration" | "NodeNotFound" | "RenderError";
+                    type: "MissingIntegration" | "NodeNotFound" | "RateLimitExceeded" | "RenderError";
                 };
-                hasSource?: boolean;
             };
-            origin?: {
-                sourceId?: string;
+            origin: {
+                sourceId: string;
                 fileId?: string;
                 parentName?: string;
             };
         }[];
     } | {
-        type?: "DocumentationPageRestore";
-        output?: {
-            success?: true;
+        type: "DocumentationPageRestore";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupRestore";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupRestore";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageApprovalStateChange";
-        output?: {
-            success?: true;
+        type: "DocumentationPageApprovalStateChange";
+        output: {
+            success: true;
         };
     } | {
-        type?: "ElementPropertyValuesEdit";
-        output?: {
-            success?: true;
+        type: "ElementPropertyValuesEdit";
+        output: {
+            success: true;
         };
     }>;
     /** Moves a documentation page
@@ -224,126 +235,126 @@ export declare class AreaDocumentation {
      * @returns nothing
      */
     moveDocumentationPage(from: RemoteWorkspaceVersionIdentifier, payload: DTOMoveDocumentationPageInputV2): Promise<{
-        type?: "DocumentationPageCreate";
-        output?: {
-            success?: true;
+        type: "DocumentationPageCreate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageUpdate";
-        output?: {
-            success?: true;
+        type: "DocumentationPageUpdate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageUpdateDocument";
-        output?: {
-            success?: true;
+        type: "DocumentationPageUpdateDocument";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageMove";
-        output?: {
-            success?: true;
+        type: "DocumentationPageMove";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageDuplicate";
-        output?: {
-            success?: true;
+        type: "DocumentationPageDuplicate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageDelete";
-        output?: {
-            success?: true;
+        type: "DocumentationPageDelete";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupCreate";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupCreate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationTabCreate";
-        output?: {
-            success?: true;
+        type: "DocumentationTabCreate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupUpdate";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupUpdate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupMove";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupMove";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupDuplicate";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupDuplicate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupDelete";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupDelete";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationTabGroupDelete";
-        output?: {
-            success?: true;
+        type: "DocumentationTabGroupDelete";
+        output: {
+            success: true;
         };
     } | {
-        type?: "FigmaNodeRenderAsync";
-        figmaNodes?: {
-            id?: string;
-            designSystemVersionId?: string;
-            createdAt?: Date;
-            updatedAt?: Date;
-            meta?: {
-                name?: string;
+        type: "FigmaNodeRenderAsync";
+        figmaNodes: {
+            id: string;
+            designSystemVersionId: string;
+            createdAt: Date;
+            updatedAt: Date;
+            meta: {
+                name: string;
                 description?: string;
             };
-            persistentId?: string;
-            data?: {
-                sceneNodeId?: string;
-                format?: "Png" | "Svg";
+            persistentId: string;
+            data: {
+                sceneNodeId: string;
+                format: "Png" | "Svg";
+                renderState: "Success" | "InProgress" | "Failed";
+                hasSource: boolean;
                 scale?: number;
-                renderState?: "Success" | "InProgress" | "Failed";
                 renderedImage?: {
-                    url?: string;
+                    resourceId: string;
+                    format: "Png" | "Svg";
+                    scale?: number;
                     width?: number;
                     height?: number;
-                    resourceId?: string;
-                    format?: "Png" | "Svg";
-                    scale?: number;
+                    url?: string;
                     originKey?: string;
                 };
                 renderError?: {
-                    type?: "MissingIntegration" | "NodeNotFound" | "RenderError";
+                    type: "MissingIntegration" | "NodeNotFound" | "RateLimitExceeded" | "RenderError";
                 };
-                hasSource?: boolean;
             };
-            origin?: {
-                sourceId?: string;
+            origin: {
+                sourceId: string;
                 fileId?: string;
                 parentName?: string;
             };
         }[];
     } | {
-        type?: "DocumentationPageRestore";
-        output?: {
-            success?: true;
+        type: "DocumentationPageRestore";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupRestore";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupRestore";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageApprovalStateChange";
-        output?: {
-            success?: true;
+        type: "DocumentationPageApprovalStateChange";
+        output: {
+            success: true;
         };
     } | {
-        type?: "ElementPropertyValuesEdit";
-        output?: {
-            success?: true;
+        type: "ElementPropertyValuesEdit";
+        output: {
+            success: true;
         };
     }>;
     /** Moves a documentation group
@@ -352,126 +363,126 @@ export declare class AreaDocumentation {
      * @returns nothing
      */
     moveDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTOMoveDocumentationGroupInput): Promise<{
-        type?: "DocumentationPageCreate";
-        output?: {
-            success?: true;
+        type: "DocumentationPageCreate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageUpdate";
-        output?: {
-            success?: true;
+        type: "DocumentationPageUpdate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageUpdateDocument";
-        output?: {
-            success?: true;
+        type: "DocumentationPageUpdateDocument";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageMove";
-        output?: {
-            success?: true;
+        type: "DocumentationPageMove";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageDuplicate";
-        output?: {
-            success?: true;
+        type: "DocumentationPageDuplicate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageDelete";
-        output?: {
-            success?: true;
+        type: "DocumentationPageDelete";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupCreate";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupCreate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationTabCreate";
-        output?: {
-            success?: true;
+        type: "DocumentationTabCreate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupUpdate";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupUpdate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupMove";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupMove";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupDuplicate";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupDuplicate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupDelete";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupDelete";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationTabGroupDelete";
-        output?: {
-            success?: true;
+        type: "DocumentationTabGroupDelete";
+        output: {
+            success: true;
         };
     } | {
-        type?: "FigmaNodeRenderAsync";
-        figmaNodes?: {
-            id?: string;
-            designSystemVersionId?: string;
-            createdAt?: Date;
-            updatedAt?: Date;
-            meta?: {
-                name?: string;
+        type: "FigmaNodeRenderAsync";
+        figmaNodes: {
+            id: string;
+            designSystemVersionId: string;
+            createdAt: Date;
+            updatedAt: Date;
+            meta: {
+                name: string;
                 description?: string;
             };
-            persistentId?: string;
-            data?: {
-                sceneNodeId?: string;
-                format?: "Png" | "Svg";
+            persistentId: string;
+            data: {
+                sceneNodeId: string;
+                format: "Png" | "Svg";
+                renderState: "Success" | "InProgress" | "Failed";
+                hasSource: boolean;
                 scale?: number;
-                renderState?: "Success" | "InProgress" | "Failed";
                 renderedImage?: {
-                    url?: string;
+                    resourceId: string;
+                    format: "Png" | "Svg";
+                    scale?: number;
                     width?: number;
                     height?: number;
-                    resourceId?: string;
-                    format?: "Png" | "Svg";
-                    scale?: number;
+                    url?: string;
                     originKey?: string;
                 };
                 renderError?: {
-                    type?: "MissingIntegration" | "NodeNotFound" | "RenderError";
+                    type: "MissingIntegration" | "NodeNotFound" | "RateLimitExceeded" | "RenderError";
                 };
-                hasSource?: boolean;
             };
-            origin?: {
-                sourceId?: string;
+            origin: {
+                sourceId: string;
                 fileId?: string;
                 parentName?: string;
             };
         }[];
     } | {
-        type?: "DocumentationPageRestore";
-        output?: {
-            success?: true;
+        type: "DocumentationPageRestore";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupRestore";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupRestore";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageApprovalStateChange";
-        output?: {
-            success?: true;
+        type: "DocumentationPageApprovalStateChange";
+        output: {
+            success: true;
         };
     } | {
-        type?: "ElementPropertyValuesEdit";
-        output?: {
-            success?: true;
+        type: "ElementPropertyValuesEdit";
+        output: {
+            success: true;
         };
     }>;
     /** Deletes a documentation group
@@ -519,126 +530,126 @@ export declare class AreaDocumentation {
      * @returns page
      */
     updateDocumentationPageOrTab(from: RemoteWorkspaceVersionIdentifier, payload: DTOUpdateDocumentationPageInputV2): Promise<{
-        type?: "DocumentationPageCreate";
-        output?: {
-            success?: true;
+        type: "DocumentationPageCreate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageUpdate";
-        output?: {
-            success?: true;
+        type: "DocumentationPageUpdate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageUpdateDocument";
-        output?: {
-            success?: true;
+        type: "DocumentationPageUpdateDocument";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageMove";
-        output?: {
-            success?: true;
+        type: "DocumentationPageMove";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageDuplicate";
-        output?: {
-            success?: true;
+        type: "DocumentationPageDuplicate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageDelete";
-        output?: {
-            success?: true;
+        type: "DocumentationPageDelete";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupCreate";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupCreate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationTabCreate";
-        output?: {
-            success?: true;
+        type: "DocumentationTabCreate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupUpdate";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupUpdate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupMove";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupMove";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupDuplicate";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupDuplicate";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupDelete";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupDelete";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationTabGroupDelete";
-        output?: {
-            success?: true;
+        type: "DocumentationTabGroupDelete";
+        output: {
+            success: true;
         };
     } | {
-        type?: "FigmaNodeRenderAsync";
-        figmaNodes?: {
-            id?: string;
-            designSystemVersionId?: string;
-            createdAt?: Date;
-            updatedAt?: Date;
-            meta?: {
-                name?: string;
+        type: "FigmaNodeRenderAsync";
+        figmaNodes: {
+            id: string;
+            designSystemVersionId: string;
+            createdAt: Date;
+            updatedAt: Date;
+            meta: {
+                name: string;
                 description?: string;
             };
-            persistentId?: string;
-            data?: {
-                sceneNodeId?: string;
-                format?: "Png" | "Svg";
+            persistentId: string;
+            data: {
+                sceneNodeId: string;
+                format: "Png" | "Svg";
+                renderState: "Success" | "InProgress" | "Failed";
+                hasSource: boolean;
                 scale?: number;
-                renderState?: "Success" | "InProgress" | "Failed";
                 renderedImage?: {
-                    url?: string;
+                    resourceId: string;
+                    format: "Png" | "Svg";
+                    scale?: number;
                     width?: number;
                     height?: number;
-                    resourceId?: string;
-                    format?: "Png" | "Svg";
-                    scale?: number;
+                    url?: string;
                     originKey?: string;
                 };
                 renderError?: {
-                    type?: "MissingIntegration" | "NodeNotFound" | "RenderError";
+                    type: "MissingIntegration" | "NodeNotFound" | "RateLimitExceeded" | "RenderError";
                 };
-                hasSource?: boolean;
             };
-            origin?: {
-                sourceId?: string;
+            origin: {
+                sourceId: string;
                 fileId?: string;
                 parentName?: string;
             };
         }[];
     } | {
-        type?: "DocumentationPageRestore";
-        output?: {
-            success?: true;
+        type: "DocumentationPageRestore";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationGroupRestore";
-        output?: {
-            success?: true;
+        type: "DocumentationGroupRestore";
+        output: {
+            success: true;
         };
     } | {
-        type?: "DocumentationPageApprovalStateChange";
-        output?: {
-            success?: true;
+        type: "DocumentationPageApprovalStateChange";
+        output: {
+            success: true;
         };
     } | {
-        type?: "ElementPropertyValuesEdit";
-        output?: {
-            success?: true;
+        type: "ElementPropertyValuesEdit";
+        output: {
+            success: true;
         };
     }>;
     /** Duplicates a documentation tab or page
@@ -676,6 +687,10 @@ export declare class AreaDocumentation {
      * @returns Room ID that can be immediately used to join the multiplayer room
      */
     getDocumentationPageRoomId(from: RemoteWorkspaceVersionIdentifier, pageId: string): Promise<string>;
+    listPageHistoryVersions(from: RemoteWorkspaceVersionIdentifier, pageId: string): Promise<PageHistoryVersion[]>;
+    getPageHistoryVersion(from: RemoteWorkspaceVersionIdentifier, pageId: string, pageHistoryVersionId: string): Promise<PageHistoryVersionContent>;
+    createPageHistoryVersion(from: RemoteWorkspaceVersionIdentifier, pageId: string, payload: DTOPageHistoryVersionCreatePayload): Promise<PageHistoryVersion>;
+    restorePageHistoryVersion(from: RemoteWorkspaceVersionIdentifier, pageId: string, pageHistoryVersionId: string): Promise<PageHistoryVersion>;
     /** Get id of the room for a specific design system and version. This room contains doc structure
      * @param from - Remote version to fetch from
      * @returns Room ID that can be immediately used to join the multiplayer room