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

package/build/types/core/SDKSupernova.d.ts

@@ -1,3 +1,5 @@
+import { AreaActivityEvents } from "./areas/SDKAreaActivityEvents";
+import { AreaAgentChats } from "./areas/SDKAreaAgentChats";
 import { AreaAssets } from "./areas/SDKAreaAssets";
 import { AreaAutomation } from "./areas/SDKAreaAutomation";
 import { AreaBrands } from "./areas/SDKAreaBrands";
@@ -9,6 +11,7 @@ import { AreaDataSources } from "./areas/SDKAreaDataSources";
 import { AreaDesignSystems } from "./areas/SDKAreaDesignSystems";
 import { AreaDocsAnalytics } from "./areas/SDKAreaDocsAnalytics";
 import { AreaDocumentation } from "./areas/SDKAreaDocumentation";
+import { SDKAreaImport } from "./areas/SDKAreaImport";
 import { AreaIntegrations } from "./areas/SDKAreaIntegrations";
 import { AreaMCP } from "./areas/SDKAreaMCP";
 import { AreaMe } from "./areas/SDKAreaMe";
@@ -62,6 +65,8 @@ export declare class Supernova {
     resources: AreaResources;
     /** Get, create, update, manipulate or delete documentation items */
     documentation: AreaDocumentation;
+    /** Validate and import markdown into documentation pages */
+    import: SDKAreaImport;
     /** Get published documentation items */
     docsAnalytics: AreaDocsAnalytics;
     /** Get, create, update, manipulate or delete pipelines and automation jobs */
@@ -92,6 +97,10 @@ export declare class Supernova {
     messaging: AreaMessaging;
     /** Get, create, update, manipulate or delete sandboxes */
     sandboxes: AreaSandboxes;
+    /** Get activity events */
+    activityEvents: AreaActivityEvents;
+    /** Get, create, update, archive or delete agent chats */
+    agentChats: AreaAgentChats;
     /** Get access to raw data for local-only restoration of data */
     raw: AreaRawData;
     /**

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

@@ -0,0 +1,7 @@
+import { ActivityEventListFilter, ActivityEventListResult } from "../../model/activity-events/SDKActivityEvent";
+import { DataCore } from "../data/SDKDataCore";
+export declare class AreaActivityEvents {
+    private dataCore;
+    constructor(dataCore: DataCore);
+    list(filter: ActivityEventListFilter): Promise<ActivityEventListResult>;
+}

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

@@ -0,0 +1,12 @@
+import type { AgentChat, AgentChatChangedEntity, AgentChatCreateInput, AgentChatDeleteResponse, AgentChatListFilter, AgentChatUpdateInput } from "../../model/agent-chats/SDKAgentChat";
+import { DataCore } from "../data/SDKDataCore";
+export declare class AreaAgentChats {
+    private dataCore;
+    constructor(dataCore: DataCore);
+    list(filter: AgentChatListFilter): Promise<AgentChat[]>;
+    getByEveSession(eveSessionId: string): Promise<AgentChat>;
+    listChangedEntities(chatId: string): Promise<AgentChatChangedEntity[]>;
+    create(input: AgentChatCreateInput): Promise<AgentChat>;
+    update(chatId: string, input: AgentChatUpdateInput): Promise<AgentChat>;
+    delete(chatId: string): Promise<AgentChatDeleteResponse>;
+}

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

@@ -53,9 +53,11 @@ export declare class AreaBulkOperations {
      * @returns Nothing
      */
     importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", payload: unknown, isTokenTypeSplitEnabled?: boolean, version?: "1" | "2"): Promise<ImportJob>;
-    /** Batch updates, creates or deletes token data from Supernova at once. Use this method to perform multiple operations at once instead of chaining single update operations. Batch routine runs everything in a single transaction, so either all operations succeed or all fail.
+    /** Updates or creates token data in Supernova using the aggregated token endpoint. Token fields, its group, theme overrides and property values all travel in one request, which also records a single activity event for the change.
      *
-     * WARNING: This method is not yet complete and only supports limited set of operations. Also, doesn't work as transation just yet.
+     * WARNING: Not atomic. The server applies the parts of the payload in sequence, so a failure can leave earlier parts already written.
+     *
+     * In `create` mode, `data.token` has its `id` and `idInVersion` written back from the server response.
      * @param to - Remote version to write to
      * @param data - Update information. All keys except token and its parent are optional and any combination of optional properties is allowed.
      * @returns Nothing
@@ -146,13 +148,13 @@ export declare class AreaBulkOperations {
             };
             persistentId?: string;
             data?: {
-                sceneNodeId?: string;
                 format?: "Png" | "Svg";
                 scale?: number;
+                sceneNodeId?: string;
                 renderState?: "Success" | "InProgress" | "Failed";
                 renderedImage?: {
-                    url?: string;
                     width?: number;
+                    url?: string;
                     height?: number;
                     resourceId?: string;
                     format?: "Png" | "Svg";
@@ -160,7 +162,7 @@ export declare class AreaBulkOperations {
                     originKey?: string;
                 };
                 renderError?: {
-                    type?: "MissingIntegration" | "NodeNotFound" | "RenderError";
+                    type?: "MissingIntegration" | "NodeNotFound" | "RateLimitExceeded" | "RenderError";
                 };
                 hasSource?: boolean;
             };

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

@@ -47,7 +47,7 @@ export declare class AreaDataSources {
             isUnpublishedContentFallbackEnabled: boolean;
         };
         autoImport: SourceRemoteModelCloud["autoImportMode"];
-        themeId: string | null;
+        themeId?: string | null;
     }): Promise<Source>;
     updateFigmaSource(from: RemoteVersionIdentifier, sourceId: string, options: {
         scopes?: {

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
@@ -173,13 +184,13 @@ export declare class AreaDocumentation {
             };
             persistentId?: string;
             data?: {
-                sceneNodeId?: string;
                 format?: "Png" | "Svg";
                 scale?: number;
+                sceneNodeId?: string;
                 renderState?: "Success" | "InProgress" | "Failed";
                 renderedImage?: {
-                    url?: string;
                     width?: number;
+                    url?: string;
                     height?: number;
                     resourceId?: string;
                     format?: "Png" | "Svg";
@@ -187,7 +198,7 @@ export declare class AreaDocumentation {
                     originKey?: string;
                 };
                 renderError?: {
-                    type?: "MissingIntegration" | "NodeNotFound" | "RenderError";
+                    type?: "MissingIntegration" | "NodeNotFound" | "RateLimitExceeded" | "RenderError";
                 };
                 hasSource?: boolean;
             };
@@ -301,13 +312,13 @@ export declare class AreaDocumentation {
             };
             persistentId?: string;
             data?: {
-                sceneNodeId?: string;
                 format?: "Png" | "Svg";
                 scale?: number;
+                sceneNodeId?: string;
                 renderState?: "Success" | "InProgress" | "Failed";
                 renderedImage?: {
-                    url?: string;
                     width?: number;
+                    url?: string;
                     height?: number;
                     resourceId?: string;
                     format?: "Png" | "Svg";
@@ -315,7 +326,7 @@ export declare class AreaDocumentation {
                     originKey?: string;
                 };
                 renderError?: {
-                    type?: "MissingIntegration" | "NodeNotFound" | "RenderError";
+                    type?: "MissingIntegration" | "NodeNotFound" | "RateLimitExceeded" | "RenderError";
                 };
                 hasSource?: boolean;
             };
@@ -429,13 +440,13 @@ export declare class AreaDocumentation {
             };
             persistentId?: string;
             data?: {
-                sceneNodeId?: string;
                 format?: "Png" | "Svg";
                 scale?: number;
+                sceneNodeId?: string;
                 renderState?: "Success" | "InProgress" | "Failed";
                 renderedImage?: {
-                    url?: string;
                     width?: number;
+                    url?: string;
                     height?: number;
                     resourceId?: string;
                     format?: "Png" | "Svg";
@@ -443,7 +454,7 @@ export declare class AreaDocumentation {
                     originKey?: string;
                 };
                 renderError?: {
-                    type?: "MissingIntegration" | "NodeNotFound" | "RenderError";
+                    type?: "MissingIntegration" | "NodeNotFound" | "RateLimitExceeded" | "RenderError";
                 };
                 hasSource?: boolean;
             };
@@ -596,13 +607,13 @@ export declare class AreaDocumentation {
             };
             persistentId?: string;
             data?: {
-                sceneNodeId?: string;
                 format?: "Png" | "Svg";
                 scale?: number;
+                sceneNodeId?: string;
                 renderState?: "Success" | "InProgress" | "Failed";
                 renderedImage?: {
-                    url?: string;
                     width?: number;
+                    url?: string;
                     height?: number;
                     resourceId?: string;
                     format?: "Png" | "Svg";
@@ -610,7 +621,7 @@ export declare class AreaDocumentation {
                     originKey?: string;
                 };
                 renderError?: {
-                    type?: "MissingIntegration" | "NodeNotFound" | "RenderError";
+                    type?: "MissingIntegration" | "NodeNotFound" | "RateLimitExceeded" | "RenderError";
                 };
                 hasSource?: boolean;
             };
@@ -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

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

@@ -0,0 +1,35 @@
+import type { DTODocumentationMarkdownValidateResponse, DTODocumentationMarkdownWriteResponse } from "@supernova-studio/client";
+import { DataCore } from "../data/SDKDataCore";
+import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
+/** Result of validating markdown before writing it into a documentation page. */
+export type MarkdownValidationResult = DTODocumentationMarkdownValidateResponse;
+/** Result of writing markdown into a documentation page. */
+export type MarkdownWriteResult = DTODocumentationMarkdownWriteResponse;
+export declare class SDKAreaImport {
+    /** Internal: Engine */
+    private dataCore;
+    constructor(dataCore: DataCore);
+    /**
+     * Validate documentation MDX-lite without writing.
+     *
+     * This is an optional preflight for inspecting unsupported content.
+     * `writeMarkdownToPage` runs the same validation before updating the page.
+     * See `docs/markdown-import.md` for the supported syntax.
+     *
+     * @param from - Remote version to validate against
+     * @param markdown - Markdown / MDX-lite source
+     */
+    validateMarkdown(from: RemoteVersionIdentifier, markdown: string): Promise<MarkdownValidationResult>;
+    /**
+     * Validate documentation MDX-lite and replace the target page's content.
+     *
+     * Invalid input rejects without changing the page. Use `validateMarkdown` when
+     * validation needs to run separately from the write.
+     * See `docs/markdown-import.md` for the supported syntax.
+     *
+     * @param from - Remote version to write into
+     * @param pageId - Target documentation page id
+     * @param markdown - Markdown / MDX-lite source
+     */
+    writeMarkdownToPage(from: RemoteVersionIdentifier, pageId: string, markdown: string): Promise<MarkdownWriteResult>;
+}

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

@@ -1,4 +1,4 @@
-import { DTOMCPStreamUpdateInput } from "@supernova-studio/client";
+import { DTOMCPConsumer, DTOMCPStreamUpdateInput } from "@supernova-studio/client";
 import { MCPStream } from "../../model/mcp/SDKMCPStream";
 import { DataCore } from "../data/SDKDataCore";
 export declare class AreaMCP {
@@ -15,6 +15,24 @@ export declare class AreaMCP {
      * @returns The user's MCPStream object.
      */
     getUserMCPStream(): Promise<MCPStream>;
+    /**
+     * Lists the MCP consumers (users who have used MCP) of a workspace.
+     * Optionally narrows the results to a specific context or design system.
+     * @param workspaceId - The ID of the workspace.
+     * @param contextId - Optional context to filter by.
+     * @param designSystemId - Optional design system to filter by.
+     * @returns The list of MCP consumers.
+     */
+    listConsumers(workspaceId: string, contextId?: string, designSystemId?: string): Promise<DTOMCPConsumer[]>;
+    /**
+     * Returns the effective MCP consumer count for a workspace.
+     * Counts only billable viewers, unlike `listConsumers`, whose length includes paid seats.
+     * @param workspaceId - The ID of the workspace.
+     * @param contextId - Optional context to filter by.
+     * @param designSystemId - Optional design system to filter by.
+     * @returns The effective MCP consumer count.
+     */
+    getConsumerCount(workspaceId: string, contextId?: string, designSystemId?: string): Promise<number>;
     /**
      * Updates the user's MCP stream with the provided data.
      * @param data - The update input containing optional projectFeatureId and projectDocumentId.