@supernova-studio/client 1.3.5 → 1.3.6

package/dist/index.d.mts

@@ -97559,6 +97559,82 @@ declare class DocumentationEndpoint {
             id: string;
         };
     }>;
+    getBlockDefinitions(dsId: string, vId: string): Promise<{
+        definitions: {
+            item: {
+                properties: {
+                    type: "Boolean" | "Number" | "Image" | "Text" | "URL" | "Token" | "Component" | "FigmaComponent" | "Color" | "Code" | "Divider" | "Table" | "Markdown" | "RichText" | "MultiRichText" | "RichTextEditor" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "Asset" | "AssetProperty" | "FigmaNode" | "EmbedURL" | "CodeSandbox" | "Storybook";
+                    id: string;
+                    name: string;
+                    options?: Record<string, any> | undefined;
+                    description?: string | undefined;
+                    variantOptions?: Record<string, Record<string, any>> | undefined;
+                }[];
+                variants: {
+                    id: string;
+                    name: string;
+                    layout: {
+                        type: "Column" | "Row";
+                        gap?: "Small" | "Medium" | "Large" | "None" | undefined;
+                        columnAlign?: "Center" | "Start" | "End" | undefined;
+                        columnResizing?: "Fill" | "Hug" | undefined;
+                    } & {
+                        children: (PageBlockDefinitionLayout | string)[];
+                    };
+                    image?: string | undefined;
+                    description?: string | undefined;
+                    documentationLink?: string | undefined;
+                    maxColumns?: number | undefined;
+                    defaultColumns?: number | undefined;
+                    appearance?: {
+                        isBordered?: boolean | undefined;
+                        hasBackground?: boolean | undefined;
+                        isEditorPresentationDifferent?: boolean | undefined;
+                        showBlockHeaderInEditor?: boolean | undefined;
+                    } | undefined;
+                }[];
+                defaultVariantKey: string;
+                appearance?: {
+                    isBordered?: boolean | undefined;
+                    hasBackground?: boolean | undefined;
+                    isEditorPresentationDifferent?: boolean | undefined;
+                    showBlockHeaderInEditor?: boolean | undefined;
+                } | undefined;
+            };
+            category: "Text" | "Code" | "Embed" | "Guidelines" | "Layout" | "Media" | "Figma" | "Tokens" | "Components" | "Assets" | "Data" | "Other";
+            id: string;
+            name: string;
+            description: string;
+            behavior: {
+                dataType: "Token" | "Component" | "FigmaComponent" | "Asset" | "FigmaNode" | "Item";
+                items?: {
+                    numberOfItems: number;
+                    allowLinks: boolean;
+                    newItemLabel?: string | undefined;
+                } | undefined;
+                entities?: {
+                    selectionType: "Group" | "Entity" | "EntityAndGroup";
+                    maxSelected: number;
+                } | undefined;
+            };
+            editorOptions: {
+                newItemLabel?: string | undefined;
+                onboarding?: {
+                    helpText: string;
+                    documentationLink?: string | undefined;
+                } | undefined;
+            };
+            icon?: string | undefined;
+            documentationLink?: string | undefined;
+            appearance?: {
+                isBordered?: boolean | undefined;
+                hasBackground?: boolean | undefined;
+                isEditorPresentationDifferent?: boolean | undefined;
+                showBlockHeaderInEditor?: boolean | undefined;
+            } | undefined;
+            searchKeywords?: string[] | undefined;
+        }[];
+    }>;
 }
 
 declare class DesignSystemComponentEndpoint {
@@ -98181,6 +98257,152 @@ declare class ElementsActionEndpoint {
             };
         }[];
     }>;
+    updateDocPageDocument(dsId: string, vId: string, input: DTOUpdateDocumentationPageDocumentInputV2): Promise<{
+        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: "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: "DocumentationPageRestore";
+        output: {
+            success: true;
+        };
+    } | {
+        type: "DocumentationGroupRestore";
+        output: {
+            success: true;
+        };
+    } | {
+        type: "DocumentationPageApprovalStateChange";
+        output: {
+            success: true;
+        };
+    } | {
+        type: "FigmaNodeRender";
+        figmaNodes: {
+            id: string;
+            persistentId: string;
+            meta: {
+                name: string;
+                description?: string | undefined;
+            };
+            designSystemVersionId: string;
+            createdAt: Date;
+            updatedAt: Date;
+            data: {
+                figmaNodeId: string;
+                isValid: boolean;
+                assetId: string;
+                assetUrl: string;
+                assetFormat: "Png" | "Svg";
+                assetScale: number;
+                assetWidth?: number | undefined;
+                assetHeight?: number | undefined;
+            };
+            origin: {
+                sourceId: string;
+                fileId?: string | undefined;
+                parentName?: string | undefined;
+            };
+        }[];
+    } | {
+        type: "FigmaNodeRenderAsync";
+        figmaNodes: {
+            id: string;
+            persistentId: string;
+            meta: {
+                name: string;
+                description?: string | undefined;
+            };
+            designSystemVersionId: string;
+            createdAt: Date;
+            updatedAt: Date;
+            data: {
+                format: "Png" | "Svg";
+                sceneNodeId: string;
+                renderState: "InProgress" | "Failed" | "Success";
+                hasSource: boolean;
+                scale?: number | undefined;
+                renderedImage?: {
+                    resourceId: string;
+                    format: "Png" | "Svg";
+                    url?: string | undefined;
+                    width?: number | undefined;
+                    height?: number | undefined;
+                    originKey?: string | undefined;
+                    scale?: number | undefined;
+                } | undefined;
+                renderError?: {
+                    type: "MissingIntegration" | "NodeNotFound" | "RenderError";
+                } | undefined;
+            };
+            origin: {
+                sourceId: string;
+                fileId?: string | undefined;
+                parentName?: string | undefined;
+            };
+        }[];
+    }>;
     updateDocGroup(dsId: string, vId: string, input: DTOUpdateDocumentationGroupInput): Promise<{
         type: "DocumentationGroupCreate";
         output: {

package/dist/index.d.ts

@@ -97559,6 +97559,82 @@ declare class DocumentationEndpoint {
             id: string;
         };
     }>;
+    getBlockDefinitions(dsId: string, vId: string): Promise<{
+        definitions: {
+            item: {
+                properties: {
+                    type: "Boolean" | "Number" | "Image" | "Text" | "URL" | "Token" | "Component" | "FigmaComponent" | "Color" | "Code" | "Divider" | "Table" | "Markdown" | "RichText" | "MultiRichText" | "RichTextEditor" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "Asset" | "AssetProperty" | "FigmaNode" | "EmbedURL" | "CodeSandbox" | "Storybook";
+                    id: string;
+                    name: string;
+                    options?: Record<string, any> | undefined;
+                    description?: string | undefined;
+                    variantOptions?: Record<string, Record<string, any>> | undefined;
+                }[];
+                variants: {
+                    id: string;
+                    name: string;
+                    layout: {
+                        type: "Column" | "Row";
+                        gap?: "Small" | "Medium" | "Large" | "None" | undefined;
+                        columnAlign?: "Center" | "Start" | "End" | undefined;
+                        columnResizing?: "Fill" | "Hug" | undefined;
+                    } & {
+                        children: (PageBlockDefinitionLayout | string)[];
+                    };
+                    image?: string | undefined;
+                    description?: string | undefined;
+                    documentationLink?: string | undefined;
+                    maxColumns?: number | undefined;
+                    defaultColumns?: number | undefined;
+                    appearance?: {
+                        isBordered?: boolean | undefined;
+                        hasBackground?: boolean | undefined;
+                        isEditorPresentationDifferent?: boolean | undefined;
+                        showBlockHeaderInEditor?: boolean | undefined;
+                    } | undefined;
+                }[];
+                defaultVariantKey: string;
+                appearance?: {
+                    isBordered?: boolean | undefined;
+                    hasBackground?: boolean | undefined;
+                    isEditorPresentationDifferent?: boolean | undefined;
+                    showBlockHeaderInEditor?: boolean | undefined;
+                } | undefined;
+            };
+            category: "Text" | "Code" | "Embed" | "Guidelines" | "Layout" | "Media" | "Figma" | "Tokens" | "Components" | "Assets" | "Data" | "Other";
+            id: string;
+            name: string;
+            description: string;
+            behavior: {
+                dataType: "Token" | "Component" | "FigmaComponent" | "Asset" | "FigmaNode" | "Item";
+                items?: {
+                    numberOfItems: number;
+                    allowLinks: boolean;
+                    newItemLabel?: string | undefined;
+                } | undefined;
+                entities?: {
+                    selectionType: "Group" | "Entity" | "EntityAndGroup";
+                    maxSelected: number;
+                } | undefined;
+            };
+            editorOptions: {
+                newItemLabel?: string | undefined;
+                onboarding?: {
+                    helpText: string;
+                    documentationLink?: string | undefined;
+                } | undefined;
+            };
+            icon?: string | undefined;
+            documentationLink?: string | undefined;
+            appearance?: {
+                isBordered?: boolean | undefined;
+                hasBackground?: boolean | undefined;
+                isEditorPresentationDifferent?: boolean | undefined;
+                showBlockHeaderInEditor?: boolean | undefined;
+            } | undefined;
+            searchKeywords?: string[] | undefined;
+        }[];
+    }>;
 }
 
 declare class DesignSystemComponentEndpoint {
@@ -98181,6 +98257,152 @@ declare class ElementsActionEndpoint {
             };
         }[];
     }>;
+    updateDocPageDocument(dsId: string, vId: string, input: DTOUpdateDocumentationPageDocumentInputV2): Promise<{
+        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: "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: "DocumentationPageRestore";
+        output: {
+            success: true;
+        };
+    } | {
+        type: "DocumentationGroupRestore";
+        output: {
+            success: true;
+        };
+    } | {
+        type: "DocumentationPageApprovalStateChange";
+        output: {
+            success: true;
+        };
+    } | {
+        type: "FigmaNodeRender";
+        figmaNodes: {
+            id: string;
+            persistentId: string;
+            meta: {
+                name: string;
+                description?: string | undefined;
+            };
+            designSystemVersionId: string;
+            createdAt: Date;
+            updatedAt: Date;
+            data: {
+                figmaNodeId: string;
+                isValid: boolean;
+                assetId: string;
+                assetUrl: string;
+                assetFormat: "Png" | "Svg";
+                assetScale: number;
+                assetWidth?: number | undefined;
+                assetHeight?: number | undefined;
+            };
+            origin: {
+                sourceId: string;
+                fileId?: string | undefined;
+                parentName?: string | undefined;
+            };
+        }[];
+    } | {
+        type: "FigmaNodeRenderAsync";
+        figmaNodes: {
+            id: string;
+            persistentId: string;
+            meta: {
+                name: string;
+                description?: string | undefined;
+            };
+            designSystemVersionId: string;
+            createdAt: Date;
+            updatedAt: Date;
+            data: {
+                format: "Png" | "Svg";
+                sceneNodeId: string;
+                renderState: "InProgress" | "Failed" | "Success";
+                hasSource: boolean;
+                scale?: number | undefined;
+                renderedImage?: {
+                    resourceId: string;
+                    format: "Png" | "Svg";
+                    url?: string | undefined;
+                    width?: number | undefined;
+                    height?: number | undefined;
+                    originKey?: string | undefined;
+                    scale?: number | undefined;
+                } | undefined;
+                renderError?: {
+                    type: "MissingIntegration" | "NodeNotFound" | "RenderError";
+                } | undefined;
+            };
+            origin: {
+                sourceId: string;
+                fileId?: string | undefined;
+                parentName?: string | undefined;
+            };
+        }[];
+    }>;
     updateDocGroup(dsId: string, vId: string, input: DTOUpdateDocumentationGroupInput): Promise<{
         type: "DocumentationGroupCreate";
         output: {

package/dist/index.js

@@ -7829,6 +7829,12 @@ var DocumentationEndpoint = class {
       DTODocumentationPageRoomResponse
     );
   }
+  async getBlockDefinitions(dsId, vId) {
+    return await this.requestExecutor.json(
+      `/design-systems/${dsId}/versions/${vId}/documentation/block-definitions`,
+      DTOGetBlockDefinitionsOutput
+    );
+  }
 };
 
 // src/api/endpoints/design-system/versions/ds-components.ts
@@ -7871,6 +7877,9 @@ var ElementsActionEndpoint = class {
   async updateDocPage(dsId, vId, input) {
     return this.action(dsId, vId, { type: "DocumentationPageUpdate", input });
   }
+  async updateDocPageDocument(dsId, vId, input) {
+    return this.action(dsId, vId, { type: "DocumentationPageUpdateDocument", input });
+  }
   async updateDocGroup(dsId, vId, input) {
     return this.action(dsId, vId, { type: "DocumentationGroupUpdate", input });
   }