@supernova-studio/supernova-sdk-beta 2.1.1 → 2.1.2

package/build/sdk-typescript/src/core/SDKSupernova.d.ts

@@ -25,6 +25,7 @@ import { DataBridgeRequestHook } from "./data/SDKDataBridge";
 export declare class Supernova {
     private apiKey;
     private apiUrl;
+    private aiApiUrl;
     private apiVersion;
     private requestHook;
     private dataCore;
@@ -78,12 +79,15 @@ export declare class Supernova {
      * @param options Options for SDK
      * @param options.url URL of the Supernova.io instance to connect to. Defaults to production environment
      * @param options.requestHook Hook for observing requests
-     * @param options.bypassEnvFetch When enabled, internal node-fetch lib will be used in environments when fetch is not available. Defaults to false
+     * @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?: {
         apiUrl?: string;
+        aiApiUrl?: string;
         requestHook?: DataBridgeRequestHook;
-        bypassEnvFetch?: boolean;
+        customFetchLib?: any;
+        customProxyLib?: any;
         proxyUrl?: string;
         isPreview?: boolean;
         jobId?: string;

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

@@ -1,34 +1,58 @@
 import { DataCore } from "../data/SDKDataCore";
-import { RemoteVersionIdentifier, RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
+import { RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
 export declare class AreaAI {
     /** Internal: Engine */
     private dataCore;
     constructor(dataCore: DataCore);
-    /** Generates code for the associated design system components for provided user prompt
-     * @param from - Design system to use
-     * @param prompt - Prompt to generate code for
-     * @param components - Components to generate code for
-     * @returns Forged component code
+    /** Summarizes a prompt into a title. Response is not streamed.
+     * @param from - Version identifier
+     * @param text - Text to summarize
+     * @param options - Summarization options
+     * @returns Summarized title
+     * @disclaimer This method will throw if the user is not authorized to use AI features (if you are reading this, you are not authorized).
      */
-    forgeCode(from: RemoteVersionIdentifier, prompt: string, components: Array<any>): Promise<string>;
-    /** Reforges code for the associated design system components for provided user prompt, taking into account existing code
-     * @param from - Design system to use
-     * @param prompt - Prompt to generate code for
-     * @param components - Components to generate code for
-     * @param existingCode - Existing code to reforge
-     * @returns Reforged component code
+    summarizeIntoTitle(from: RemoteWorkspaceVersionIdentifier, text: string, options?: {
+        maxWordCount: number;
+        strategy: "noun" | "verb";
+    }): Promise<string>;
+    /** Autocompletes a prompt into a full text. Response is not streamed.
+     * @param from - Version identifier
+     * @param text - Text to autocomplete
+     * @param options - Autocomplete options
+     * @returns Autocompleted text
+     * @disclaimer This method will throw if the user is not authorized to use AI features (if you are reading this, you are not authorized).
      */
-    reforgeCode(from: RemoteVersionIdentifier, prompt: string, components: Array<any>, existingCode: string): Promise<string>;
-    /** Reforges code for the associated design system components for provided user prompt, taking into account existing code
-     * @param from - Design system to use
-     * @param prompt - Prompt to generate code for
-     * @param components - Components to generate code for
-     * @param existingCode - Existing code to reforge
-     * @returns Reforged component code
+    autocompleteText(from: RemoteWorkspaceVersionIdentifier, text: string, options?: {
+        maximumLength: number;
+    }): Promise<string>;
+    /** Answers question based on the data of design system in natural language. This method is non-streaming.
+     * @param from - Version identifier
+     * @param prompt - Question to answer
+     * @param options - Answering options
+     * @returns Answer to the question
+     * @disclaimer This method will throw if the user is not authorized to use AI features (if you are reading this, you are not authorized).
      */
-    proposeTitle(from: RemoteVersionIdentifier, firstForgeQuery: string): Promise<string>;
-    /** Answers question based on the data of design system in natural language */
-    answerQuestion(from: RemoteWorkspaceVersionIdentifier, persona: "designer" | "developer" | "code", askQuery: string): Promise<string>;
-    /** Indexes a design system so it can be asked in natural language */
-    indexDS(from: RemoteWorkspaceVersionIdentifier): Promise<string>;
+    answer(from: RemoteWorkspaceVersionIdentifier, prompt: string, options?: {
+        persona: "designer" | "developer";
+        scope: "all" | "tokens" | "components" | "assets" | "docs";
+        density: "compact" | "full";
+    }): Promise<string>;
+    /** Answers question based on the data of design system in natural language. This method streams answer.
+     * @param from - Version identifier
+     * @param prompt - Question to answer
+     * @param options - Answering options
+     * @returns Answer to the question
+     * @disclaimer This method will throw if the user is not authorized to use AI features (if you are reading this, you are not authorized).
+     */
+    answerAsStream(from: RemoteWorkspaceVersionIdentifier, prompt: string, options?: {
+        persona: "designer" | "developer";
+        scope: "all" | "tokens" | "components" | "assets" | "docs";
+        density: "compact" | "full";
+    }): Promise<ReadableStream<Uint8Array>>;
+    /** Indexes or reindexes a design system to prepare it for QA engine
+     * @param from - Version identifier
+     * @returns Indexing status
+     * @disclaimer This method will throw if the user is not authorized to use AI features (if you are reading this, you are not authorized).
+     */
+    rebuildAnswerIndex(from: RemoteWorkspaceVersionIdentifier): Promise<string>;
 }

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

@@ -1,6 +1,8 @@
 export declare class Configuration {
     /** Retrieve API URL for default target */
     static apiUrlForDefaultEnvironment(): string;
+    /** Retrieve API URL for default AI target */
+    static aiApiUrlForDefaultEnvironment(): string;
     /** Retrieve API version for the specific environment accesse */
     static apiVersionForDefaultEnvironment(): string;
 }

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

@@ -15,26 +15,28 @@ export type DebugRequestObserver = (info: {
 }) => void;
 export type DataBridgeConfiguration = {
     apiUrl: string;
+    aiApiUrl: string;
     apiVersion: string;
     accessToken: string;
     target: string | null;
-    bypassEnvFetch: boolean;
+    customFetchLib: any | null;
+    customProxyLib: any | null;
     requestHook: DataBridgeRequestHook | null;
     debugRequestObserver?: DebugRequestObserver | null;
     debugResponseObserver?: DebugResponseObserver | null;
-    proxyUrl?: string | null;
     jobId?: string | null;
     isPreview?: boolean;
 };
 export declare class DataBridge {
     authToken: string;
     apiUrl: string;
+    aiApiUrl: string;
     apiVersion: string;
     target: string | null;
-    bypassEnvFetch: boolean;
+    customFetchLib: any | null;
+    customProxyLib: any | null;
     isPreview: boolean;
     jobId: string | null;
-    proxyUrl: string | undefined;
     requestHook: DataBridgeRequestHook | null;
     debugRequestObserver: DebugRequestObserver | null;
     debugResponseObserver: DebugResponseObserver | null;
@@ -50,6 +52,7 @@ export declare class DataBridge {
     private buildRequestConfig;
     private getProxyAgent;
     private getFetchInvoker;
+    getApiEndpoint(fragment: string | null): string;
     getBaseEndpoint(fragment: string | null): string;
     getPublicEndpoint(fragment: string): string;
     getAclEndpoint(resource?: string): string;

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

@@ -96,16 +96,29 @@ export declare class DataCore {
     multiplayerToken(room: string | undefined): Promise<{
         token: string;
     }>;
-    /** Remote: Forges code based on user prompt */
-    forgeCode(designSystemId: string, versionId: string, prompt: string, components: Array<any>): Promise<string>;
-    /** Remote: Reforges code based on user prompt */
-    reforgeCode(designSystemId: string, versionId: string, prompt: string, components: Array<any>, existingCode: string): Promise<string>;
-    /** Remote: Proposes title for generated code */
-    proposeTitle(designSystemId: string, versionId: string, firstForgeQuery: string): Promise<string>;
-    /** Remote: Answers question based on the data of design system in natural language */
-    answerQuestion(workspaceId: string, designSystemId: string, versionId: string, persona: "designer" | "developer" | "code", askQuery: string): Promise<string>;
-    /** Remote: Index a design system so it can be asked in natural language */
-    indexDS(workspaceId: string, designSystemId: string, versionId: string): Promise<string>;
+    /** Remote: Summarizes a prompt into a title. Response is not streamed */
+    aiSummarizeIntoTitle(workspaceId: string, designSystemId: string, versionId: string, text: string, options: {
+        maxWordCount: number;
+        strategy: "noun" | "verb";
+    }): Promise<string>;
+    /** Remote: Autocompletes a prompt into a full text. Response is not streamed. */
+    aiAutocompleteText(workspaceId: string, designSystemId: string, versionId: string, text: string, options: {
+        maximumLength: number;
+    }): Promise<string>;
+    /** Remote: Answers question based on the data of design system in natural language. This method is non-streaming. */
+    aiAnswer(workspaceId: string, designSystemId: string, versionId: string, prompt: string, options: {
+        persona: "designer" | "developer";
+        scope: "all" | "tokens" | "components" | "assets" | "docs";
+        density: "compact" | "full";
+    }): Promise<string>;
+    /** Remote: Answers question based on the data of design system in natural language. This method streams answer. */
+    aiAnswerAsStream(workspaceId: string, designSystemId: string, versionId: string, prompt: string, options: {
+        persona: "designer" | "developer";
+        scope: "all" | "tokens" | "components" | "assets" | "docs";
+        density: "compact" | "full";
+    }): Promise<ReadableStream<Uint8Array>>;
+    /** Indexes or reindexes a design system to prepare it for QA engine */
+    aiRebuildAnswerIndex(workspaceId: string, designSystemId: string, versionId: string): Promise<string>;
     /** Remote: Get information about currently logged in user */
     currentUser(): Promise<User>;
     /** Remote: Get information about a specific user */

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

@@ -2,14 +2,27 @@ import { DataBridge } from "../SDKDataBridge";
 export declare class DataCoreAIRequests {
     private bridge;
     constructor(bridge: DataBridge);
-    /** Remote: Forges code based on user prompt */
-    forgeCode(designSystemId: string, versionId: string, prompt: string, components: Array<any>): Promise<string>;
-    /** Remote: Reforges code based on user prompt */
-    reforgeCode(designSystemId: string, versionId: string, prompt: string, components: Array<any>, existingCode: string): Promise<string>;
-    /** Remote: Proposes title for the forged code */
-    proposeTitle(designSystemId: string, versionId: string, firstForgeQuery: string): Promise<string>;
-    /** Remote: Answers question based on the data of design system in natural language */
-    answerQuestion(workspaceId: string, designSystemId: string, versionId: string, persona: "designer" | "developer" | "code", askQuery: string): Promise<string>;
-    /** Remote: Index a design system so it can be asked in natural language */
-    indexDS(workspaceId: string, designSystemId: string, versionId: string): Promise<string>;
+    /** Remote: Summarizes a prompt into a title. Response is not streamed */
+    summarizeIntoTitle(workspaceId: string, designSystemId: string, versionId: string, text: string, options: {
+        maxWordCount: number;
+        strategy: "noun" | "verb";
+    }): Promise<string>;
+    /** Remote: Autocompletes a prompt into a full text. Response is not streamed. */
+    autocompleteText(workspaceId: string, designSystemId: string, versionId: string, text: string, options: {
+        maximumLength: number;
+    }): Promise<string>;
+    /** Remote: Answers question based on the data of design system in natural language. This method is non-streaming. */
+    answer(workspaceId: string, designSystemId: string, versionId: string, question: string, options: {
+        persona: "designer" | "developer";
+        scope: "all" | "tokens" | "components" | "assets" | "docs";
+        density: "compact" | "full";
+    }): Promise<string>;
+    /** Remote: Answers question based on the data of design system in natural language. This method streams answer. */
+    answerAsStream(workspaceId: string, designSystemId: string, versionId: string, question: string, options: {
+        persona: "designer" | "developer";
+        scope: "all" | "tokens" | "components" | "assets" | "docs";
+        density: "compact" | "full";
+    }): Promise<ReadableStream<Uint8Array>>;
+    /** Indexes or reindexes a design system to prepare it for QA engine */
+    rebuildAnswerIndex(workspaceId: string, designSystemId: string, versionId: string): Promise<string>;
 }

package/build/sdk-typescript/src/tests/Areas/AreaAI.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/sdk-typescript/src/tests/Areas/AreaResources.spec.d.ts

@@ -0,0 +1 @@
+export {};