@supernova-studio/supernova-sdk-beta 2.2.7 → 2.2.12

package/build/sdk-typescript/src/core/areas/SDKAreaRelay.d.ts

@@ -0,0 +1,61 @@
+import { DataCore } from "../data/SDKDataCore";
+import { RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
+export declare enum AIGetRouteQueryTask {
+    amy = "amy",
+    agent = "agent"
+}
+export declare enum AIAgentPersona {
+    cody = "cody"
+}
+export declare enum RelaySummarizeStrategy {
+    noun = "noun",
+    verb = "verb"
+}
+export declare class AreaRelay {
+    /** Internal: Engine */
+    private dataCore;
+    constructor(dataCore: DataCore);
+    /** Answer questions and/or chat about product-development topics with full knowledge of your product development data.
+     * @param from - Version identifier
+     * @param prompt - Question to answer
+     * @param options - Answering options
+     * @returns Readable stream of amy's response
+     */
+    invokeAmy(prompt: string, chatId: string, context: RemoteWorkspaceVersionIdentifier & {
+        brandId?: string;
+    }, promptMetadata?: {
+        forceBehavior?: {
+            llm?: {
+                model: string;
+                provider: "Anthropic" | "OpenAI" | "xAI" | "Google";
+            };
+            prompt?: string;
+        };
+        [key: string]: any;
+    }): Promise<ReadableStreamDefaultReader<Uint8Array>>;
+    /** Execute specific agent on top of a already existing project.
+     * @param prompt - User instruction that tells agent what to do
+     * @param projectId - Project identifier (note the project must be already created)
+     * @param branchId - Optional branch identifier (if not provided, the default branch will be used)
+     * @returns Readable stream of the agent's response
+     */
+    invokeAgent(agent: AIAgentPersona, prompt: string, projectId: string, branchId?: string): Promise<ReadableStreamDefaultReader<Uint8Array>>;
+    /** Retrieves dynamic URL for all AI tasks. Use the URL to
+     * @param task - Which task to retrieve URL for
+     * @returns Url for the task
+     *
+     */
+    executableTaskUrl(task: AIGetRouteQueryTask): Promise<string>;
+    /** Summarize text into a heavily condensed form.
+     * @param text - Text to summarize
+     * @param options - Summarization options
+     * @returns Object containing the original and summarized text
+     */
+    summarizeText(text: string, options?: {
+        maxWords?: number;
+        strategy?: RelaySummarizeStrategy;
+    }): Promise<{
+        enteredText: string;
+        summarizedText: string;
+    }>;
+}

package/build/sdk-typescript/src/core/areas/SDKAreaResources.d.ts

@@ -1,4 +1,4 @@
-import { DTOFigmaNode, DTOFigmaNodeV2 } from "@supernova-studio/client";
+import { DTOFigmaNode, DTOFigmaNodeV2, DTOFileFinalizeBulkPayload, DTOFileUploadBulkPayload, DTOFileUploadPayload, DTOForgeProjectFileUploadPayload } from "@supernova-studio/client";
 import { DocsImageRef, ResourceAsset, ResourceFont } from "../../exports";
 import { DataCore } from "../data/SDKDataCore";
 import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
@@ -38,12 +38,94 @@ export declare class AreaResources {
      * @returns URL of the hosted image resource, either uploaded file or Figma frame
      */
     getImageRefHostedUrl(from: RemoteVersionIdentifier, imageRef: DocsImageRef | undefined): string | undefined;
+    /** Fetches all files in the version or a subset of them based on the persistentIds
+     * @param from - Remote version to fetch from
+     * @param persistentIds - Optional array of persistentIds to filter the files by
+     * @returns All files in the specified version or a subset of them based on the persistentIds
+     */
+    getFiles(from: RemoteVersionIdentifier): Promise<import("../../exports").RemoteFile[]>;
+    getProjectFiles(workspaceId: string, projectId: string): Promise<import("../../exports").RemoteFile[]>;
     /** Uploads new asset resource */
     uploadAssetResource(from: RemoteVersionIdentifier, asset: File): Promise<ResourceAsset>;
     /** Uploads new font resource */
     uploadFontResource(from: RemoteVersionIdentifier, font: File): Promise<ResourceFont | null>;
     /** Uploads new font resources */
     uploadFontResources(from: RemoteVersionIdentifier, fonts: FileList): Promise<ResourceFont[]>;
+    initializeFileUpload(from: RemoteVersionIdentifier, fileUploadItems: DTOFileUploadPayload["files"]): Promise<{
+        files: {
+            name: string;
+            url: string;
+            fileId: string;
+            size: number;
+            checksum: string;
+            referencePersistentId: string;
+            pendingUpload?: boolean | undefined;
+        }[];
+        uploadUrls: {
+            fileId: string;
+            uploadUrl: string;
+        }[];
+    }>;
+    initializeProjectFileUpload(workspaceId: string, projectId: string, fileUploadItems: DTOForgeProjectFileUploadPayload["files"]): Promise<{
+        files: {
+            id: string;
+            name: string;
+            url: string;
+            size: number;
+            checksum: string;
+            pendingUpload?: boolean | undefined;
+        }[];
+        uploadUrls: {
+            fileId: string;
+            uploadUrl: string;
+        }[];
+    }>;
+    initializeBulkFileUpload(input: DTOFileUploadBulkPayload): Promise<{
+        files: {
+            id: string;
+            name: string;
+            url: string;
+            storagePath: string;
+            size: number;
+            deduplicationKey: string;
+            source?: {
+                type: "UserUpload";
+                userId: string;
+            } | {
+                type: "Figma";
+                renderMode: "Image" | "HTML" | "JSON";
+            } | undefined;
+            pendingUpload?: boolean | undefined;
+        }[];
+        uploadUrls: {
+            fileId: string;
+            uploadUrl: string;
+        }[];
+    }>;
+    finalizeFileUpload(from: RemoteVersionIdentifier, fileIds: Array<string>): Promise<any>;
+    finalizeProjectFileUpload(workspaceId: string, projectId: string, fileIds: Array<string>): Promise<any>;
+    finalizeBulkFileUpload(input: DTOFileFinalizeBulkPayload): Promise<{
+        files: {
+            id: string;
+            name: string;
+            url: string;
+            storagePath: string;
+            size: number;
+            deduplicationKey: string;
+            source?: {
+                type: "UserUpload";
+                userId: string;
+            } | {
+                type: "Figma";
+                renderMode: "Image" | "HTML" | "JSON";
+            } | undefined;
+            pendingUpload?: boolean | undefined;
+        }[];
+        uploadUrls: {
+            fileId: string;
+            uploadUrl: string;
+        }[];
+    }>;
     /** Deletes single resource of any type */
     deleteResource(from: RemoteVersionIdentifier, resourceId: string): Promise<void>;
     /** Deletes multiple resource of any type */

package/build/sdk-typescript/src/core/areas/SDKAreaThreads.d.ts

@@ -0,0 +1,81 @@
+import { DTOThreadMessageCreateInput, DTOThreadMessageFinalizeInput, DTOThreadReactionCreateInput, DTOThreadReactionDeleteInput } from "@supernova-studio/client";
+import { DataCore } from "../data/SDKDataCore";
+export declare class AreaThreads {
+    /** Internal: Engine */
+    private dataCore;
+    constructor(dataCore: DataCore);
+    /**
+     * Gets the messages for a specific thread.
+     * @param threadId - The ID of the thread.
+     * @returns An array of ThreadMessage objects.
+     */
+    getMessages(threadId: string): Promise<import("../..").ThreadMessageList>;
+    /**
+     * Creates a new message in a specific thread.
+     * @param threadId - The ID of the thread.
+     * @param input - The input for the message.
+     * @returns A new ThreadMessage object.
+     */
+    createMessage(threadId: string, input: DTOThreadMessageCreateInput): Promise<import("../..").ThreadMessage>;
+    /**
+     * Creates a new message reaction in a specific thread.
+     * @param threadId - The ID of the thread.
+     * @param input - The input for the message reaction.
+     * @returns A new ThreadMessageReaction object.
+     */
+    createMessageReaction(threadId: string, input: DTOThreadReactionCreateInput): Promise<import("../..").ThreadMessageReaction>;
+    /**
+     * Removes a message reaction from a specific thread.
+     * @param threadId - The ID of the thread.
+     * @param input - The input for the message reaction.
+     * @returns A new ThreadMessageReaction object.
+     */
+    removeMessageReaction(threadId: string, input: DTOThreadReactionDeleteInput): Promise<void>;
+    /**
+     * Finalizes a message in a specific thread.
+     * @param threadId - The ID of the thread.
+     * @param input - The input for the thread.
+     * @returns Finalize input
+     */
+    finalizeMessage(threadId: string, input: DTOThreadMessageFinalizeInput): Promise<{
+        message: {
+            id: string;
+            createdAt: string;
+            sender: {
+                type: "User";
+                userId: string;
+            } | {
+                type: "Agent";
+                agentType: "Ask" | "Document" | "Prototype" | "ReleaseNotes";
+            } | {
+                type: "System";
+                onBehalfOfUserId: string;
+            };
+            body: string;
+            threadId: string;
+            updatedAt?: string | undefined;
+            isPrompt?: boolean | undefined;
+            startsNewThread?: boolean | undefined;
+            parentMessageId?: string | undefined;
+            agentResponseTrackerId?: string | null | undefined;
+            attachments?: {
+                files?: {
+                    id: string;
+                    url: string;
+                    name?: string | undefined;
+                    source?: {
+                        type: "UserUpload";
+                        userId: string;
+                    } | {
+                        type: "Figma";
+                        renderMode: "Image" | "HTML" | "JSON";
+                    } | undefined;
+                }[] | undefined;
+                iterationId?: string | undefined;
+            } | undefined;
+            replyToMessageId?: string | undefined;
+            isRetry?: boolean | undefined;
+            promptMetadata?: Record<string, any> | undefined;
+        };
+    }>;
+}

package/build/sdk-typescript/src/core/areas/SDKAreaTokens.d.ts

@@ -54,7 +54,9 @@ export declare class AreaTokens {
      * @param from - Remote version to fetch from
      * @returns All themes in the specified version
      */
-    getTokenThemes(from: RemoteVersionIdentifier): Promise<Array<TokenTheme>>;
+    getTokenThemes(from: RemoteVersionIdentifier, filter?: {
+        brandId?: string;
+    }): Promise<Array<TokenTheme>>;
     /** Retrieves all remote property definitions for tokens
      * @param from - Remote version to fetch from
      * @returns All property definitions in the specified version

package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts

@@ -1,6 +1,8 @@
-import { DTOWorkspaceUntypedDataListResponse, DTOWorkspaceUntypedDataResponse } from "@supernova-studio/client";
-import { Acl } from "../../model/acl/SDKAcl";
+import { DTOPortalSettingsUpdatePayload } from "@supernova-studio/client";
+import { WorkspaceSeatType } from "@supernova-studio/model";
 import { UserRole } from "../../model/enums/SDKUserRole";
+import { WorkspaceSubscriptionPlanInterval } from "../../model/enums/SDKWorkspaceSubscriptionPlanInterval";
+import { SubscriptionCheckoutProductCode } from "../../model/enums/SDKWorkspaceSubscriptionProduct";
 import { Membership } from "../../model/membership/SDKMembership";
 import { UserMembership } from "../../model/users/SDKUserMembership";
 import { UserWorkspaceNotificationSettings, UserWorkspaceNotificationSettingsUpdateModel } from "../../model/users/SDKUserWorkspaceNotificationSettings";
@@ -15,7 +17,7 @@ import { WorkspaceProduct } from "../../model/workspaces/SDKWorkspaceProduct";
 import { SubscriptionProductFeatures } from "../../model/workspaces/SDKWorkspaceProductFeatures";
 import { WorkspaceProfileUpdateModel } from "../../model/workspaces/SDKWorkspaceProfile";
 import { WorkspaceSSOSettings, WorkspaceSSOSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceSSOSettings";
-import { WorkspaceSubscription, WorkspaceSubscriptionUpdateModel } from "../../model/workspaces/SDKWorkspaceSubscription";
+import { WorkspaceSubscription, WorkspaceSubscriptionUpdateModel, WorkspaceSubscriptionUpdateModelLegacy, WorkspaceSubscriptionUpdatePreviewModel } from "../../model/workspaces/SDKWorkspaceSubscription";
 import { DataCore } from "../data/SDKDataCore";
 export declare class AreaWorkspaces {
     /** Internal: Engine */
@@ -52,7 +54,6 @@ export declare class AreaWorkspaces {
      * @returns Product features
      */
     workspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeatures>;
-    acls(): Promise<Acl>;
     /** Fetches workspace onboarding status
      * @param workspaceId - ID of the workspace
      * @returns Workspace onboarding status
@@ -98,6 +99,19 @@ export declare class AreaWorkspaces {
      * @returns All available products
      */
     workspaceAvailableProducts(workspaceId: string): Promise<Array<WorkspaceProduct>>;
+    /** Fetches workspace Portal settings
+     * @param workspaceId - ID of the workspace
+     * @returns Workspace portal settings
+     */
+    workspacePortalSettings(workspaceId: string): Promise<import("../..").PortalSettings>;
+    /**
+     * Checks whether the workspace has available credits
+     * @param workspaceId - ID of the workspace
+     * @returns boolean - true if the workspace has available credits, false otherwise
+     */
+    getWorkspaceCreditsAvailability(workspaceId: string): Promise<{
+        canSpendCredits: boolean;
+    }>;
     /** Creates new workspace and retrieves the newly created workspace object. The user who creates the workspace becomes its owner
      * @param name - Name of the workspace
      * @returns Newly created workspace object
@@ -109,6 +123,17 @@ export declare class AreaWorkspaces {
      * @returns Nothing
      */
     updateWorkspaceProfile(workspaceId: string, update: WorkspaceProfileUpdateModel): Promise<void>;
+    /** Updates workspace AI settings for a specific workspace
+     * @param workspaceId - ID of the workspace
+     * @param update - AI settings to update
+     * @returns Nothing
+     */
+    updateWorkspaceAiSettings(workspaceId: string, update: {
+        aiFeaturesEnabled?: boolean;
+        projectsEnabled?: boolean;
+        aiAskFeaturesEnabled?: boolean;
+        aiCustomInstruction?: string;
+    }): Promise<void>;
     /** tests accessibility of IP allowlist settings
      * @param workspaceId - ID of the workspace
      * @param ipWhitelistSettings - settings to test
@@ -164,31 +189,44 @@ export declare class AreaWorkspaces {
      * @param workspaceId - ID of the workspace
      * @param userId - ID of the user
      * @param newRole - New role of the user
+     * @param newSeatType - New seat type of the user
      * @returns Nothing
      */
-    updateWorkspaceMemberRole(workspaceId: string, userId: string, newRole: UserRole): Promise<void>;
+    updateWorkspaceMemberRole(workspaceId: string, userId: string, newRole: UserRole, newSeatType?: WorkspaceSeatType): Promise<void>;
     /** Updates a role of an invitation.
      * @param workspaceId - ID of the workspace
      * @param invitationId - ID of the invitation
      * @param newRole - New role
+     * @param newSeatType - New seat type
      * @returns Nothing
      */
-    updateWorkspaceInvitationRole(workspaceId: string, invitationId: string, newRole: UserRole): Promise<void>;
+    updateWorkspaceInvitationRole(workspaceId: string, invitationId: string, newRole: UserRole, newSeatType?: WorkspaceSeatType): Promise<void>;
     /** Invites new members to the workspace
      * @param workspaceId - ID of the workspace
      * @param invitations - array of invitations
      * @returns Nothing
      */
     addWorkspaceInvitations(workspaceId: string, invitations: Array<WorkspaceInvitationUpdateModel>, designSystemId: string | undefined): Promise<void>;
+    /** Creates a new Stripe checkout session to change current subscription.
+     * @param workspaceId - ID of the workspace
+     * @param successUrl - URL to redirect to after successful payment
+     * @param cancelUrl - URL to redirect to after failed payment
+     * @param plan - Plan to be selected in the checkout
+     * @param interval - Interval (monthly / yearly) of the plan
+     * @param fullSeats - Number of full seats the subscription will have
+     * @param builderSeats - Number of builder seats the subscription will have
+     * @param additionalCredits - Additional credits per month
+     * @returns string - URL to the Stripe checkout
+     */
+    createCheckoutSessionForSubscriptionChange(workspaceId: string, successUrl: string, cancelUrl: string, plan: SubscriptionCheckoutProductCode, interval: WorkspaceSubscriptionPlanInterval, fullSeats: number, builderSeats: number, additionalCredits: number): Promise<string>;
     /** Creates a new Stripe checkout session.
      * @param workspaceId - ID of the workspace
-     * @param priceId - ID of the Stripe price to be applied to the workspace
      * @param successUrl - URL to redirect to after successful payment
      * @param cancelUrl - URL to redirect to after failed payment
-     * @param quantity - number of seats to be pre-selected in the checkout
+     * @param centAmount - number of cents to be selected in the checkout
      * @returns string - URL to the Stripe checkout
      */
-    createCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity?: number | null): Promise<string>;
+    createCheckoutSessionForTopUpCredits(workspaceId: string, successUrl: string, cancelUrl: string, centAmount: number): Promise<string>;
     /** Creates a new Stripe customer portal session.
      * @param workspaceId - ID of the workspace
      * @param returnUrl - URL to redirect to from the portal
@@ -196,7 +234,17 @@ export declare class AreaWorkspaces {
      * @param cancel - describes if the subscription must be cancelled
      * @returns string - URL to the Stripe customer portal
      */
-    createPortalSession(workspaceId: string, returnUrl: string, update?: WorkspaceSubscriptionUpdateModel | null, cancel?: boolean | null): Promise<string>;
+    createPortalSession(workspaceId: string, returnUrl: string, update?: WorkspaceSubscriptionUpdateModelLegacy | null, cancel?: boolean | null): Promise<string>;
+    /** Update an existing subscription.
+     * @param workspaceId - ID of the workspace
+     * @param update - describes the subscription updates to be applied
+     */
+    updateSubscription(workspaceId: string, update: WorkspaceSubscriptionUpdateModel): Promise<void>;
+    /** Preview subscription changes.
+     * @param workspaceId - ID of the workspace
+     * @param update - describes the subscription updates to be applied
+     */
+    previewSubscriptionUpdate(workspaceId: string, update: WorkspaceSubscriptionUpdateModel): Promise<WorkspaceSubscriptionUpdatePreviewModel>;
     /** Resend an invitation to the workspace.
      * @param workspaceId - ID of the workspace
      * @param invitationId - ID of the invitation
@@ -208,6 +256,12 @@ export declare class AreaWorkspaces {
      * @returns Nothing
      */
     restoreWorkspaceSubscription(workspaceId: string): Promise<void>;
+    /** Updates portal settings
+     * @param workspaceId - ID of the workspace
+     * @param settings - updated settings
+     * @returns Nothing
+     */
+    updateWorkspacePortalSettings(workspaceId: string, settings: DTOPortalSettingsUpdatePayload): Promise<void>;
     /** Deletes a single workspace. This action is irreversible, all data will be lost, and can only be performed by the workspace owner
      * @param workspaceId - ID of the workspace
      * @returns Nothing
@@ -235,38 +289,4 @@ export declare class AreaWorkspaces {
      * @returns Nothing
      */
     deleteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
-    /**
-     * Lists all untyped data for a given workspace.
-     * @param workspaceId - The ID of the workspace.
-     * @returns A promise that resolves to the list of untyped data.
-     */
-    listUntypedData(workspaceId: string): Promise<DTOWorkspaceUntypedDataListResponse>;
-    /**
-     * Creates new untyped data in the specified workspace.
-     * @param workspaceId - The ID of the workspace.
-     * @param data - The data to create. Must be a valid JSON object.
-     * @returns A promise that resolves to the created untyped data.
-     */
-    createUntypedData(workspaceId: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
-    /**
-     * Deletes all untyped data in the specified workspace.
-     * @param workspaceId - The ID of the workspace.
-     * @returns A promise that resolves when the operation is complete.
-     */
-    deleteAllUntypedData(workspaceId: string): Promise<void>;
-    /**
-     * Updates specific untyped data in the specified workspace.
-     * @param workspaceId - The ID of the workspace.
-     * @param id - The ID of the untyped data to update.
-     * @param data - The updated data. Must be a valid JSON object.
-     * @returns A promise that resolves to the updated untyped data.
-     */
-    updateUntypedData(workspaceId: string, id: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
-    /**
-     * Deletes specific untyped data in the specified workspace.
-     * @param workspaceId - The ID of the workspace.
-     * @param id - The ID of the untyped data to delete.
-     * @returns A promise that resolves when the operation is complete.
-     */
-    deleteUntypedData(workspaceId: string, id: string): Promise<void>;
 }

package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts

@@ -41,7 +41,7 @@ export declare class DataBridge {
     debugRequestObserver: DebugRequestObserver | null;
     debugResponseObserver: DebugResponseObserver | null;
     constructor(conf: DataBridgeConfiguration);
-    delete(endpoint: string): Promise<any>;
+    delete(endpoint: string, payload?: any | null): Promise<any>;
     get(endpoint: string): Promise<any>;
     getStreamed(endpoint: string): Promise<ReadableStreamDefaultReader<Uint8Array>>;
     getAsData(endpoint: string): Promise<any>;