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

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

@@ -4,6 +4,7 @@ import { AreaBrands } from "./areas/SDKAreaBrands";
 import { AreaBulkOperations } from "./areas/SDKAreaBulkOperations";
 import { AreaCodeComponents } from "./areas/SDKAreaCodeComponents";
 import { AreaComponents } from "./areas/SDKAreaComponents";
+import { AreaContext } from "./areas/SDKAreaContext";
 import { AreaDataSources } from "./areas/SDKAreaDataSources";
 import { AreaDesignSystems } from "./areas/SDKAreaDesignSystems";
 import { AreaDocsAnalytics } from "./areas/SDKAreaDocsAnalytics";
@@ -18,6 +19,7 @@ import { AreaProjects } from "./areas/SDKAreaProjects";
 import { AreaRawData } from "./areas/SDKAreaRawData";
 import { AreaRelay } from "./areas/SDKAreaRelay";
 import { AreaResources } from "./areas/SDKAreaResources";
+import { AreaSandboxes } from "./areas/SDKAreaSanboxes";
 import { AreaStorage } from "./areas/SDKAreaStorage";
 import { AreaThreads } from "./areas/SDKAreaThreads";
 import { AreaTokens } from "./areas/SDKAreaTokens";
@@ -25,7 +27,7 @@ import { AreaUsers } from "./areas/SDKAreaUsers";
 import { AreaVersions } from "./areas/SDKAreaVersions";
 import { AreaWorkspaceIntegrations } from "./areas/SDKAreaWorkspaceIntegrations";
 import { AreaWorkspaces } from "./areas/SDKAreaWorkspaces";
-import { DataBridgeRequestHook, DebugRequestObserver, DebugResponseObserver } from "./data/SDKDataBridge";
+import { DataBridgeRequestHook, DebugRequestObserver, DebugResponseObserver, FetchFunction } from "./data/SDKDataBridge";
 /** Main Supernova.io SDK object. Use this to connect to your data instance and retrieve workspace / design system / version from which you can access all neccessary data. */
 export declare class Supernova {
     private apiKey;
@@ -44,6 +46,8 @@ export declare class Supernova {
     brands: AreaBrands;
     /** Get, create, update, manipulate or delete projects */
     projects: AreaProjects;
+    /** Get access to project context-related capabilities */
+    context: AreaContext;
     /** Get, create, update, manipulate or delete threads */
     threads: AreaThreads;
     /** Get, create, update, manipulate or delete tokens */
@@ -86,6 +90,8 @@ export declare class Supernova {
     relay: AreaRelay;
     /** Get access to Supernova messaging capabilities */
     messaging: AreaMessaging;
+    /** Get, create, update, manipulate or delete sandboxes */
+    sandboxes: AreaSandboxes;
     /** Get access to raw data for local-only restoration of data */
     raw: AreaRawData;
     /**
@@ -97,14 +103,14 @@ export declare class Supernova {
      * @param options.customFetchLib When provided, network requests will run through custom provided, fetch-like. Use in environments where fetch is not available or you want to provide your own implementation.
      * @param options.customProxyLib When provided, proxy will be used to route network requests.
      */
-    constructor(apiKey: string, options?: {
+    constructor(apiKey: string | null, options?: {
         apiUrl?: string;
         aiApiUrl?: string;
         requestHook?: DataBridgeRequestHook;
         debugRequestObserver?: DebugRequestObserver | null;
         debugResponseObserver?: DebugResponseObserver | null;
-        customFetchLib?: any;
-        customProxyLib?: any;
+        customFetchLib?: FetchFunction;
+        customProxyLib?: unknown;
         isPreview?: boolean;
         jobId?: string;
         useDataCoreCached?: boolean;

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

@@ -1,4 +1,4 @@
-import { DTOFigmaNode, DTOFigmaNodeRenderIdInput, DTOFigmaNodeRenderInput, DTOFigmaNodeV2 } from "@supernova-studio/client";
+import { DTOFigmaNodeRenderInput, DTOFigmaNodeV2 } from "@supernova-studio/client";
 import { Asset } from "../../model/assets/SDKAsset";
 import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
 import { AssetFormat } from "../../model/enums/SDKAssetFormat";
@@ -38,9 +38,4 @@ export declare class AreaAssets {
      * @returns Rendered Figma frames
      */
     getRenderedFigmaFramesAsync(from: RemoteVersionIdentifier, nodesToRender: Array<DTOFigmaNodeRenderInput>): Promise<Array<DTOFigmaNodeV2>>;
-    /** Renders figma frames based on the source and node id. The result is a URL to the hosted image of the Figma frame that is stable across updates.
-     *
-     * @returns Rendered Figma frames
-     */
-    getRenderedFigmaFrames(from: RemoteVersionIdentifier, framesToRender: Array<DTOFigmaNodeRenderIdInput>): Promise<Array<DTOFigmaNode>>;
 }

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

@@ -46,7 +46,7 @@ export declare class AreaAutomation {
      * @param propertyKey
      * @param propertyValue
      */
-    updateExporterConfigurationPropertyValue(designSystemId: string, exporterId: string, propertyKey: string, propertyValue: any): Promise<void>;
+    updateExporterConfigurationPropertyValue(designSystemId: string, exporterId: string, propertyKey: string, propertyValue: unknown): Promise<void>;
     /** Deletes exporter configuration property value
      * @param designSystemId
      * @param exporterId
@@ -116,9 +116,10 @@ export declare class AreaAutomation {
      * @param destinations
      * @param brandId
      * @param themePersistentIds
+     * @param contextIds
      * @param exporterConfigurationProperties
      * @param previewMode
      */
-    createExporterBuild(workspaceId: string, designSystemId: string, versionId: string, exporterId: string, destinations: ExporterJobDestination, brandId: string | undefined, themePersistentIds: Array<string> | undefined, exporterConfigurationProperties: DTOExporterPropertyValueMap | undefined, previewMode: boolean | undefined): Promise<ExportBuild>;
+    createExporterBuild(workspaceId: string, designSystemId: string, versionId: string, exporterId: string, destinations: ExporterJobDestination, brandId: string | undefined, themePersistentIds: Array<string> | undefined, contextIds: Array<string> | undefined, exporterConfigurationProperties: DTOExporterPropertyValueMap | undefined, previewMode: boolean | undefined): Promise<ExportBuild>;
     deletePipeline(workspaceId: string, pipelineId: string): Promise<void>;
 }

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

@@ -48,9 +48,11 @@ export declare class AreaBulkOperations {
      * @param sourceId - Unique ID of the source, such as Figma file id
      * @param sourceType - Source from which import originates. Currently only "FigmaVariablesPlugin" is supported
      * @param payload - Payload to import. Types to come
+     * @param isTokenTypeSplitEnabled - should we split tokens by type into separate collections.
+     * @param version - should we use new import routine with extended collections support. Should be set to "2" in production.
      * @returns Nothing
      */
-    importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", payload: any, isTokenTypeSplitEnabled?: boolean): Promise<ImportJob>;
+    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.
      *
      * WARNING: This method is not yet complete and only supports limited set of operations. Also, doesn't work as transation just yet.
@@ -66,7 +68,129 @@ export declare class AreaBulkOperations {
      * @returns Nothing
      */
     /** Bulk update properties */
-    updateElementProperties(to: RemoteVersionIdentifier, data: DTOElementPropertyValuesEditActionInput["values"]): Promise<any>;
+    updateElementProperties(to: RemoteVersionIdentifier, data: DTOElementPropertyValuesEditActionInput["values"]): 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;
+        };
+    }>;
     /** Batch updates, creates or deletes component 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.
      *
      * WARNING: This method is not yet complete and only supports limited set of operations. Also, doesn't work as transation just yet.

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

@@ -0,0 +1,44 @@
+import { CodeComponent } from "../../model/code-components/SDKCodeComponent";
+import { CodeComponentMarkdownResult, CodeComponentReference } from "../../model/code-components/SDKCodeComponentMarkdown";
+import { CodeComponentUsage } from "../../model/code-components/SDKCodeComponentUsage";
+import { CodeHistorySnapshot } from "../../model/code-components/SDKCodeHistorySnapshot";
+import type { CodeHistoryQuery } from "../../model/code-components/SDKCodeHistorySnapshot";
+import { CodeScanListItem } from "../../model/code-components/SDKCodeScanListItem";
+import { DataCore } from "../data/SDKDataCore";
+export declare class AreaCodeComponents {
+    /** Internal: Engine */
+    private dataCore;
+    constructor(dataCore: DataCore);
+    /** Fetches all remote code components in the design system
+     * @param designSystemId - ID of the design system
+     * @returns All code components in the specified design system
+     */
+    getCodeComponents(designSystemId: string): Promise<Array<CodeComponent>>;
+    /** Fetches AI-generated markdown for a requested batch of code components
+     * @param designSystemId - ID of the design system
+     * @param components - Components to fetch markdown for, as { packageName, componentName } pairs
+     * @returns Resolved markdown for found components and a list of components without markdown
+     */
+    getCodeComponentMarkdown(designSystemId: string, components: Array<CodeComponentReference>): Promise<CodeComponentMarkdownResult>;
+    /** Fetches all remote code component usage in the design system
+     * @param designSystemId - ID of the design system
+     * @returns All code component usage in the specified design system
+     */
+    getCodeComponentUsage(designSystemId: string): Promise<Array<CodeComponentUsage>>;
+    /** Fetches code scan history with optional filters
+     * @param designSystemId - ID of the design system
+     * @param query - Optional filters (time range, packages, component names, repos)
+     * @returns Code history snapshots
+     */
+    getCodeHistory(designSystemId: string, query?: CodeHistoryQuery): Promise<Array<CodeHistorySnapshot>>;
+    /** Fetches all code scans for a design system
+     * @param designSystemId - ID of the design system
+     * @returns All code scans
+     */
+    getCodeScans(designSystemId: string): Promise<Array<CodeScanListItem>>;
+    /** Deletes a specific code scan
+     * @param designSystemId - ID of the design system
+     * @param scanId - ID of the scan to delete
+     */
+    deleteCodeScan(designSystemId: string, scanId: string): Promise<void>;
+}

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

@@ -0,0 +1,30 @@
+import type { KnowledgeFileCreateInput, KnowledgeFileDeleteInput, KnowledgeFileDeleteResponse, KnowledgeFileUpdateInput, KnowledgeSkillCreateInput, KnowledgeSkillDeleteInput, KnowledgeSkillDeleteResponse, KnowledgeSkillUpdateInput } from "../../model/context/SDKKnowledgeItem";
+import { KnowledgeFile, KnowledgeSkill } from "../../model/context/SDKKnowledgeItem";
+import { SDKDataset } from "../../model/datasets/SDKDataset";
+import { DataCore } from "../data/SDKDataCore";
+export declare class AreaContext {
+    /** Internal: Engine */
+    private dataCore;
+    constructor(dataCore: DataCore);
+    /**
+     * Resolves the effective dataset for a context within a workspace.
+     *
+     * The method loads all workspace contexts once, finds `contextId`, then treats
+     * contexts selected in that context's dataset as inherited parent contexts.
+     * Parent datasets are resolved recursively, unioned together, and refined by
+     * the target context dataset so child filters and exclusions apply to both
+     * inherited and local data.
+     *
+     * Returns a configured `SDKDataset`; it does not fetch the actual scoped
+     * tokens, skills, files, or other data entities.
+     */
+    getResolvedDatasetForContext(workspaceId: string, contextId: string): Promise<SDKDataset>;
+    listKnowledgeFiles(workspaceId: string): Promise<KnowledgeFile[]>;
+    createKnowledgeFile(workspaceId: string, input: KnowledgeFileCreateInput): Promise<KnowledgeFile>;
+    updateKnowledgeFile(workspaceId: string, fileId: string, input: KnowledgeFileUpdateInput): Promise<KnowledgeFile>;
+    deleteKnowledgeFile(workspaceId: string, input: KnowledgeFileDeleteInput): Promise<KnowledgeFileDeleteResponse>;
+    listKnowledgeSkills(workspaceId: string): Promise<KnowledgeSkill[]>;
+    createKnowledgeSkill(workspaceId: string, input: KnowledgeSkillCreateInput): Promise<KnowledgeSkill>;
+    updateKnowledgeSkill(workspaceId: string, skillId: string, input: KnowledgeSkillUpdateInput): Promise<KnowledgeSkill>;
+    deleteKnowledgeSkill(workspaceId: string, input: KnowledgeSkillDeleteInput): Promise<KnowledgeSkillDeleteResponse>;
+}

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

@@ -62,6 +62,6 @@ export declare class AreaDataSources {
     }): Promise<Source>;
     linkStorybookSource(from: RemoteVersionIdentifier, payload: DTODataSourceStorybookCreatePayload): Promise<Source>;
     updateStorybookSource(from: RemoteVersionIdentifier, payload: DTOStorybookImportPayload): Promise<import("../../model/storybook/SDKStorybookUpdate").StorybookUpdate>;
-    replaceStorybookStory(from: RemoteVersionIdentifier, storyId: string, payload: DTOStorybookEntryReplaceAction): Promise<any>;
+    replaceStorybookStory(from: RemoteVersionIdentifier, storyId: string, payload: DTOStorybookEntryReplaceAction): Promise<import("../../model/storybook/SDKStorybookUpdate").RemoteStorybookUpdate>;
     deleteFigmaSource(from: RemoteVersionIdentifier, sourceId: string): Promise<void>;
 }

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

@@ -2,6 +2,7 @@ import { DTODocumentationLinkPreviewRequest, DTODocumentationPageApprovalStateCh
 import { DesignSystemInvite, DesignSystemInviteUpdate, DesignSystemMemberUpdate, DesignSystemPendingMemberInvite, DesignSystemUserInvitation } from "@supernova-studio/model";
 import { DesignSystem, DesignSystemAccessMode, DesignSystemSwitcher } from "../../model/base/SDKDesignSystem";
 import { DesignSystemContactList } from "../../model/base/SDKDesignSystemContactList";
+import { DesignSystemListViewItem, DesignSystemListViewPayload } from "../../model/base/SDKDesignSystemListView";
 import { DesignSystemMemberList } from "../../model/base/SDKDesignSystemMemberList";
 import { CustomDomain } from "../../model/support/SDKCustomDomain";
 import { DataCore } from "../data/SDKDataCore";
@@ -14,6 +15,20 @@ export declare class AreaDesignSystems {
      * @returns All design systems in the specified version
      */
     designSystems(workspaceId: string): Promise<Array<DesignSystem>>;
+    /** Fetches all design systems in a workspace together with the user's saved list view
+     * @param workspaceId - Workspace to fetch from
+     * @returns Design systems and the user's saved order + visibility, from a single request
+     */
+    designSystemsWithListView(workspaceId: string): Promise<{
+        designSystems: Array<DesignSystem>;
+        designSystemListView: Array<DesignSystemListViewItem>;
+    }>;
+    /** Replaces the user's saved design system list view (order + visibility) for a workspace
+     * @param workspaceId - Workspace the list view belongs to
+     * @param listView - Full replacement list; sort order is implied by array index
+     * @returns The persisted list view
+     */
+    updateDesignSystemListView(workspaceId: string, listView: DesignSystemListViewPayload): Promise<Array<DesignSystemListViewItem>>;
     /** Fetches a specific design system by its id
      * @param designSystemId - Design system to fetch
      * @returns Design system with the specified id
@@ -54,20 +69,20 @@ export declare class AreaDesignSystems {
     createDesignSystem(workspaceId: string, name: string, description?: string, accessMode?: DesignSystemAccessMode, usersToInvite?: Array<DesignSystemUserInvitation>, invitesToInvite?: Array<DesignSystemPendingMemberInvite>, emailsToInvite?: Array<DesignSystemInvite>): Promise<DesignSystem>;
     getBlockDefinitions(designSystemId: string, versionId: string): Promise<import("../..").DocsBlockDefinition[]>;
     getUrlPreview(designSystemId: string, versionId: string, request: DTODocumentationLinkPreviewRequest): Promise<{
-        linkPreview: {
-            description?: string | undefined;
-            title?: string | undefined;
+        linkPreview?: {
+            description?: string;
+            title?: string;
             thumbnail?: {
-                type: "FigmaNode" | "Resource";
+                type?: "Resource" | "FigmaNode";
                 resource?: {
-                    url: string;
-                    resourceId: string;
-                } | undefined;
+                    url?: string;
+                    resourceId?: string;
+                };
                 figmaNode?: {
-                    sourceId: string;
-                    frameReferenceId: string;
-                } | undefined;
-            } | undefined;
+                    sourceId?: string;
+                    frameReferenceId?: string;
+                };
+            };
         };
     }>;
     /** Updates design system metadata for a specific design system
@@ -76,7 +91,7 @@ export declare class AreaDesignSystems {
      * @param description - New DS description
      * @returns Nothing
      */
-    updateDesignSystemMetadata(designSystemId: string, name: string, description?: string): Promise<void>;
+    updateDesignSystemMetadata(designSystemId: string, name: string, description?: string, iconFileId?: string | null): Promise<void>;
     /** Enabled or disables multibrand functionality for a specific design system
      * @param designSystem - design system to update
      * @param isMultibrand - Multibrand functionality enabled or disabled
@@ -98,7 +113,7 @@ export declare class AreaDesignSystems {
      * @param payload - approval state info
      * @returns Nothing
      */
-    updateApprovalState(designSystemId: string, versionId: string, payload: DTODocumentationPageApprovalStateChangeInput): Promise<string>;
+    updateApprovalState(designSystemId: string, versionId: string, payload: DTODocumentationPageApprovalStateChangeInput): Promise<void>;
     /** Enabled or disables multibrand functionality for a specific design system
      * @param designSystem - design system to update
      * @param designSystemSwitcher - Design system switcher options
@@ -159,12 +174,12 @@ export declare class AreaDesignSystems {
      */
     startSslGenerationForCustomDomain(designSystemId: string): Promise<void>;
     getPageRedirects(designSystemId: string): Promise<{
-        path: string;
-        id: string;
-        createdAt: Date;
-        updatedAt: Date;
-        designSystemId: string;
-        pagePersistentId: string;
+        id?: string;
+        path?: string;
+        createdAt?: Date;
+        updatedAt?: Date;
+        designSystemId?: string;
+        pagePersistentId?: string;
     }[]>;
     createPageRedirect(designSystemId: string, body: DTOPageRedirectCreateBody): Promise<void>;
     updatePageRedirect(designSystemId: string, redirectId: string, body: DTOPageRedirectUpdateBody): Promise<void>;