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

package/build/{sdk-typescript/src → 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 } from "@supernova-studio/client";
+import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTODeleteDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOMoveDocumentationGroupInput, DTOCreateDocumentationTabInput, DTODocumentationPageAnchor, DTODesignElementsDataDiffResponse, DTOPublishDocumentationRequest, DTOElementActionInput, DTOElementActionOutput, DTODocumentationPageDependenciesGetResponse, type DTODocumentationPageContent } 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";
@@ -23,6 +23,12 @@ export declare class AreaDocumentation {
      */
     getDocumentation(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacy>;
     getDocumentationStructure(from: RemoteWorkspaceVersionIdentifier): Promise<(DocsEntityPageModel | DocsEntityGroupModel)[]>;
+    /** Fetches raw V2 block content for a specific documentation page.
+     * @param from - Remote version to fetch from
+     * @param pageId - ID or persistent ID of the documentation page
+     * @returns Raw page content DTO, including the page block/section item tree
+     */
+    getDocumentationContentRaw(from: RemoteVersionIdentifier, pageId: string): Promise<DTODocumentationPageContent>;
     /**
      * 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
@@ -33,7 +39,7 @@ export declare class AreaDocumentation {
      * @param from - Remote version to fetch from
      * @returns documentation url string
      */
-    getDocumentationUrl(from: RemoteVersionIdentifier): Promise<string>;
+    getDocumentationUrl(from: RemoteVersionIdentifier): Promise<string | null>;
     /** Retrieve information for an ongoing publishing build if any exists. */
     isPublishing(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment): Promise<{
         status: DocsPublishStatus.inProgress;
@@ -89,19 +95,385 @@ export declare class AreaDocumentation {
      * @param updateModel - Group update model with optional fields
      * @returns Newly created documentation group
      */
-    updateDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTOUpdateDocumentationGroupInput): Promise<any>;
+    updateDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTOUpdateDocumentationGroupInput): Promise<{
+        type?: "DocumentationPageCreate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageUpdate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageUpdateDocument";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageMove";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageDuplicate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageDelete";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupCreate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationTabCreate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupUpdate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupMove";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupDuplicate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupDelete";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationTabGroupDelete";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "FigmaNodeRenderAsync";
+        figmaNodes?: {
+            id?: string;
+            designSystemVersionId?: string;
+            createdAt?: Date;
+            updatedAt?: Date;
+            meta?: {
+                name?: string;
+                description?: string;
+            };
+            persistentId?: string;
+            data?: {
+                sceneNodeId?: string;
+                format?: "Png" | "Svg";
+                scale?: number;
+                renderState?: "Success" | "InProgress" | "Failed";
+                renderedImage?: {
+                    url?: string;
+                    width?: number;
+                    height?: number;
+                    resourceId?: string;
+                    format?: "Png" | "Svg";
+                    scale?: number;
+                    originKey?: string;
+                };
+                renderError?: {
+                    type?: "MissingIntegration" | "NodeNotFound" | "RenderError";
+                };
+                hasSource?: boolean;
+            };
+            origin?: {
+                sourceId?: string;
+                fileId?: string;
+                parentName?: string;
+            };
+        }[];
+    } | {
+        type?: "DocumentationPageRestore";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupRestore";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageApprovalStateChange";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "ElementPropertyValuesEdit";
+        output?: {
+            success?: true;
+        };
+    }>;
     /** Moves a documentation page
      * @param from - Remote version to fetch from
      * @param payload - The update model
      * @returns nothing
      */
-    moveDocumentationPage(from: RemoteWorkspaceVersionIdentifier, payload: DTOMoveDocumentationPageInputV2): Promise<any>;
+    moveDocumentationPage(from: RemoteWorkspaceVersionIdentifier, payload: DTOMoveDocumentationPageInputV2): Promise<{
+        type?: "DocumentationPageCreate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageUpdate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageUpdateDocument";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageMove";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageDuplicate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageDelete";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupCreate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationTabCreate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupUpdate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupMove";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupDuplicate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupDelete";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationTabGroupDelete";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "FigmaNodeRenderAsync";
+        figmaNodes?: {
+            id?: string;
+            designSystemVersionId?: string;
+            createdAt?: Date;
+            updatedAt?: Date;
+            meta?: {
+                name?: string;
+                description?: string;
+            };
+            persistentId?: string;
+            data?: {
+                sceneNodeId?: string;
+                format?: "Png" | "Svg";
+                scale?: number;
+                renderState?: "Success" | "InProgress" | "Failed";
+                renderedImage?: {
+                    url?: string;
+                    width?: number;
+                    height?: number;
+                    resourceId?: string;
+                    format?: "Png" | "Svg";
+                    scale?: number;
+                    originKey?: string;
+                };
+                renderError?: {
+                    type?: "MissingIntegration" | "NodeNotFound" | "RenderError";
+                };
+                hasSource?: boolean;
+            };
+            origin?: {
+                sourceId?: string;
+                fileId?: string;
+                parentName?: string;
+            };
+        }[];
+    } | {
+        type?: "DocumentationPageRestore";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupRestore";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageApprovalStateChange";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "ElementPropertyValuesEdit";
+        output?: {
+            success?: true;
+        };
+    }>;
     /** Moves a documentation group
      * @param from - Remote version to fetch from
      * @param payload - The update model
      * @returns nothing
      */
-    moveDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTOMoveDocumentationGroupInput): Promise<any>;
+    moveDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTOMoveDocumentationGroupInput): Promise<{
+        type?: "DocumentationPageCreate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageUpdate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageUpdateDocument";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageMove";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageDuplicate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageDelete";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupCreate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationTabCreate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupUpdate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupMove";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupDuplicate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupDelete";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationTabGroupDelete";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "FigmaNodeRenderAsync";
+        figmaNodes?: {
+            id?: string;
+            designSystemVersionId?: string;
+            createdAt?: Date;
+            updatedAt?: Date;
+            meta?: {
+                name?: string;
+                description?: string;
+            };
+            persistentId?: string;
+            data?: {
+                sceneNodeId?: string;
+                format?: "Png" | "Svg";
+                scale?: number;
+                renderState?: "Success" | "InProgress" | "Failed";
+                renderedImage?: {
+                    url?: string;
+                    width?: number;
+                    height?: number;
+                    resourceId?: string;
+                    format?: "Png" | "Svg";
+                    scale?: number;
+                    originKey?: string;
+                };
+                renderError?: {
+                    type?: "MissingIntegration" | "NodeNotFound" | "RenderError";
+                };
+                hasSource?: boolean;
+            };
+            origin?: {
+                sourceId?: string;
+                fileId?: string;
+                parentName?: string;
+            };
+        }[];
+    } | {
+        type?: "DocumentationPageRestore";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupRestore";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageApprovalStateChange";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "ElementPropertyValuesEdit";
+        output?: {
+            success?: true;
+        };
+    }>;
     /** Deletes a documentation group
      * @param from - Remote version to fetch from
      * @param group - Group to delete
@@ -146,7 +518,129 @@ export declare class AreaDocumentation {
      * @param updateModel - data to update page with
      * @returns page
      */
-    updateDocumentationPageOrTab(from: RemoteWorkspaceVersionIdentifier, payload: DTOUpdateDocumentationPageInputV2): Promise<any>;
+    updateDocumentationPageOrTab(from: RemoteWorkspaceVersionIdentifier, payload: DTOUpdateDocumentationPageInputV2): Promise<{
+        type?: "DocumentationPageCreate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageUpdate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageUpdateDocument";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageMove";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageDuplicate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageDelete";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupCreate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationTabCreate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupUpdate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupMove";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupDuplicate";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupDelete";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationTabGroupDelete";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "FigmaNodeRenderAsync";
+        figmaNodes?: {
+            id?: string;
+            designSystemVersionId?: string;
+            createdAt?: Date;
+            updatedAt?: Date;
+            meta?: {
+                name?: string;
+                description?: string;
+            };
+            persistentId?: string;
+            data?: {
+                sceneNodeId?: string;
+                format?: "Png" | "Svg";
+                scale?: number;
+                renderState?: "Success" | "InProgress" | "Failed";
+                renderedImage?: {
+                    url?: string;
+                    width?: number;
+                    height?: number;
+                    resourceId?: string;
+                    format?: "Png" | "Svg";
+                    scale?: number;
+                    originKey?: string;
+                };
+                renderError?: {
+                    type?: "MissingIntegration" | "NodeNotFound" | "RenderError";
+                };
+                hasSource?: boolean;
+            };
+            origin?: {
+                sourceId?: string;
+                fileId?: string;
+                parentName?: string;
+            };
+        }[];
+    } | {
+        type?: "DocumentationPageRestore";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationGroupRestore";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "DocumentationPageApprovalStateChange";
+        output?: {
+            success?: true;
+        };
+    } | {
+        type?: "ElementPropertyValuesEdit";
+        output?: {
+            success?: true;
+        };
+    }>;
     /** Duplicates a documentation tab or page
      * @param from - Remote version to fetch from
      * @param idInVersion - id of page or tab to be duplicated

package/build/{sdk-typescript/src → types}/core/areas/SDKAreaMe.d.ts

@@ -10,7 +10,7 @@ export declare class AreaMe {
     /** Invalidates all session keys for the current user, effectively logging out from all decises. */
     logout(): Promise<void>;
     /** Updates the current user. */
-    updateMe(userId: string, payload: UserUpdateModel): Promise<void>;
+    updateMe(userId: string, payload: UserUpdateModel): Promise<User>;
     /** Updates the current user based on the API key provided to Supernova instance. */
     updateProfile(userId: string, profile: UserProfileUpdateModel): Promise<void>;
     /** Updates the avatar of the current user */