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

package/README.md

@@ -39,17 +39,14 @@ npm install @supernovaio/sdk
 
 Supernova SDK is made to run in both local (like Node.js) and remote environments (like browsers) so you can use it to develop your React sites or any kind of tool you would like to run as client-side app.
 
-
 ## Obtaining API Key
 
 Before you can use the SDK, you must obtain your personal access key from your [Supernova.io](https://supernova.io) profile. To do this, sign-in to [Supernova Cloud](https://cloud.supernova.io/), click on your profile picture > profile settings > authentication and generate a new key. [See more information](https://developers.supernova.io/getting-started#obtain-your-developer-key) if you need additional help.
 
-
 ## Access Rights
 
 Usage of the SDK adheres to the [general access rights](https://learn.supernova.io/workspace/team-management/roles.html) that the account which generated the access key has. For example, if you are a viewer in a specific workspace, then you will not be able to do any change to that workspace through the SDK and error will be thrown instead. For vast majority of use-cases, being editor-level is enough however.
 
-
 ## Quick-start
 
 It is time to put this SDK to good use! To start, import the main Supernova SDK object:
@@ -83,8 +80,8 @@ Workspace 1
 
 - `Workspace` is what you are a member of and is object that encapsulates everything, from your team to all design systems that were created under it. You can be a member of an unlimited number of workspaces, but in the majority of cases users are members of just a single one. You can have different roles and access rights under each of the workspaces you belong to.
 - Every `Design System` belongs to one `Workspace` and contains things like design system configuration, integration settings and admin-related tools.
-- Each `Design System` contains at minimum one active `Version` called `Shared Draft` - this version is where you write your data and is the only one which is allowed to be written to as well. 
-- `Version` is data container for all design system information - like `Tokens`, `Assets`, `DesignComponents` and `Documentation`. 
+- Each `Design System` contains at minimum one active `Version` called `Shared Draft` - this version is where you write your data and is the only one which is allowed to be written to as well.
+- `Version` is data container for all design system information - like `Tokens`, `Assets`, `DesignComponents` and `Documentation`.
 - `Version` object has all methods you need to access every piece of data you have in Supernova design system.
 - Each `Version` additionally contains `Brands`. As Supernova supports multi-branded design systems, `Brands` further separate data into data packs that only represent data belonging to one specific brand (for example, set of core tokens shared across all brands, but then subset of tokens specific only to that brand).
 - There is always at least one `Brand` in each `Version`, even if multi-branded functionality is disabled.
@@ -96,14 +93,12 @@ To access the data, you first need to select which `Workspace`, `Design System`
 
 You can find full list of [what is possible, and how, here](https://github.com/Supernova-Studio/sdk-typescript/tree/main/docs).
 
-
 ## Resolution Caching
 
-Supernova SDK works little bit differently than you would probably expect by default. Because of how complex the design system data is (as an example, a token can contain references to other tokens and can also be made of different types of tokens which can then be used in designComponents...) the SDK does all necessary resolution for you beforehand. 
+Supernova SDK works little bit differently than you would probably expect by default. Because of how complex the design system data is (as an example, a token can contain references to other tokens and can also be made of different types of tokens which can then be used in designComponents...) the SDK does all necessary resolution for you beforehand.
 
 To allow reuse of the data, the resolved results are cached and used in follow-up resolutions (for example, if you would first access your design tokens and then access documentation that uses the tokens, tokens would be reused). In many situations, this is what you want. However, there are some cases where this behavior is not what you want, like longer-running sessions:
 
-
 ### Longer-running sessions
 
 If you are building a client-side app, your users might stay there for a long time without refreshing their session (like reloading a browser). This means the data will always come from the time of the first request as you are always using the same Supernova instance. To prevent this, you can disable cache layer completely:
@@ -121,7 +116,9 @@ SDK should be released via CI by opening PR `develop -> publish-sdk` branch once
 Please, in this PR:
 
 - bump a version in `sdk-typescript/scripts/packages/**.json` files
-- check that versions of `@supernova-studio/client` and `@supernova-studio/model` are up-to-date with main `package.json` in root folder of whole repository
+- check that versions of `@supernova-studio/client` and `@supernova-studio/model` are:
+- - up-to-date with main `package.json` in root folder of whole repository
+- - the same version is present in `package.json` and `sdk-typescript/scripts/packages/**.json` files.
 
 Several packages are released:
 
@@ -144,11 +141,10 @@ As this is still beta, we are working hard on improving it before the first offi
 - [ ] Automation triggers
 - [ ] More examples
 
-
 ## Contributions
 
-If you have additional ideas about how to make this project better, let us know by opening an issue! You can also open pull requests if you've worked on improving something yourself and would like to contribute back to the community. 
+If you have additional ideas about how to make this project better, let us know by opening an issue! You can also open pull requests if you've worked on improving something yourself and would like to contribute back to the community.
 
 We will be reviewing feature-pull-requests on case-by-case basis, but in general, we are super open to your new ideas and we welcome them! And finally, thank you for your support! You are an amazing community.
 
-Supernova Engineering Team
+Supernova Engineering Team

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

@@ -1,4 +1,3 @@
-import { AreaAI } from "./areas/SDKAreaAI";
 import { AreaAssets } from "./areas/SDKAreaAssets";
 import { AreaAutomation } from "./areas/SDKAreaAutomation";
 import { AreaBrands } from "./areas/SDKAreaBrands";
@@ -11,11 +10,15 @@ import { AreaDocsAnalytics } from "./areas/SDKAreaDocsAnalytics";
 import { AreaDocumentation } from "./areas/SDKAreaDocumentation";
 import { AreaIntegrations } from "./areas/SDKAreaIntegrations";
 import { AreaMe } from "./areas/SDKAreaMe";
+import { AreaMessaging } from "./areas/SDKAreaMessaging";
 import { AreaMultiplayer } from "./areas/SDKAreaMultiplayer";
 import { AreaNetwork } from "./areas/SDKAreaNetwork";
+import { AreaProjects } from "./areas/SDKAreaProjects";
 import { AreaRawData } from "./areas/SDKAreaRawData";
+import { AreaRelay } from "./areas/SDKAreaRelay";
 import { AreaResources } from "./areas/SDKAreaResources";
 import { AreaStorage } from "./areas/SDKAreaStorage";
+import { AreaThreads } from "./areas/SDKAreaThreads";
 import { AreaTokens } from "./areas/SDKAreaTokens";
 import { AreaUsers } from "./areas/SDKAreaUsers";
 import { AreaVersions } from "./areas/SDKAreaVersions";
@@ -38,6 +41,10 @@ export declare class Supernova {
     versions: AreaVersions;
     /** Get, create, update, manipulate or delete brands */
     brands: AreaBrands;
+    /** Get, create, update, manipulate or delete projects */
+    projects: AreaProjects;
+    /** Get, create, update, manipulate or delete threads */
+    threads: AreaThreads;
     /** Get, create, update, manipulate or delete tokens */
     tokens: AreaTokens;
     /** Get, create, update, manipulate or delete components */
@@ -72,8 +79,10 @@ export declare class Supernova {
     network: AreaNetwork;
     /** Get access to multiplayer capabilities */
     multiplayer: AreaMultiplayer;
-    /** Get access to AI capabilities */
-    ai: AreaAI;
+    /** Get access to Supernova Relay capabilities */
+    relay: AreaRelay;
+    /** Get access to Supernova messaging capabilities */
+    messaging: AreaMessaging;
     /** Get access to raw data for local-only restoration of data */
     raw: AreaRawData;
     /**

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

@@ -1,4 +1,4 @@
-import { DTODataSourceStorybookCreatePayload, DTOStorybookImportPayload } from "@supernova-studio/client";
+import { DTODataSourceStorybookCreatePayload, DTOStorybookEntryReplaceAction, DTOStorybookImportPayload } from "@supernova-studio/client";
 import { StorybookEntry } from "../../model/storybook/SDKStorybookEntry";
 import { FigmaStructure } from "../../model/support/SDKFigmaStructure";
 import { FigmaStructureDetail } from "../../model/support/SDKFigmaStructureDetail";
@@ -15,10 +15,16 @@ export declare class AreaDataSources {
      */
     getDataSourceById(from: RemoteVersionIdentifier, sourceId: string): Promise<Source>;
     /** Retrieves all sources associated with specified design system
-     * @param from - Remote version to fetch from
-     * @returns All data sources in the specified version
+     * @param from - Remote version or design system identifier
+     * @returns All data sources for the specified design system
+     */
+    /**
+     * @deprecated versionId is not required; prefer using the `designSystemId` only.
      */
     getDataSources(from: RemoteVersionIdentifier): Promise<Array<Source>>;
+    getDataSources(from: {
+        designSystemId: string;
+    }): Promise<Array<Source>>;
     /** Retrieves all figma frames structures
      * @param from - Remote version to fetch from
      * @returns All data sources in the specified version
@@ -54,16 +60,8 @@ export declare class AreaDataSources {
         autoImport?: SourceRemoteModelCloud["autoImportMode"];
         themeId?: string | null;
     }): Promise<Source>;
-    linkStorybookSource(from: RemoteVersionIdentifier, payload: DTODataSourceStorybookCreatePayload & {
-        isUsingVpn: boolean;
-    }): Promise<Source>;
-    updateStorybookSource(from: RemoteVersionIdentifier, payload: DTOStorybookImportPayload): Promise<{
-        isFailed: boolean;
-        docsCount: number;
-        storiesCount: number;
-        created: string[];
-        updated: string[];
-        deleted: string[];
-    }>;
+    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>;
     deleteFigmaSource(from: RemoteVersionIdentifier, sourceId: string): Promise<void>;
 }

package/build/sdk-typescript/src/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 } from "@supernova-studio/client";
+import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTODeleteDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOMoveDocumentationGroupInput, DTOCreateDocumentationTabInput, DTODocumentationPageAnchor, DTODesignElementsDataDiffResponse, DTOPublishDocumentationRequest, DTOElementActionInput, DTOElementActionOutput, DTODocumentationPageDependenciesGetResponse } 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";
@@ -7,6 +7,7 @@ import { DocsEntityGroupModel } from "../../model/docs/entities/SDKDocsEntityGro
 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 { DocsPublishStatus } from "../../model/enums/SDKDocsPublishStatus";
 import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
 import { ExportBuild, ExportBuildStatus } from "../../model/exporters/exporter_builds/SDKExportBuild";
@@ -166,17 +167,15 @@ export declare class AreaDocumentation {
      * @returns nothing
      */
     ungroupDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTODeleteDocumentationGroupInput): Promise<void>;
-    /** Fetches object containing the structure of the docs - documentation pages and groups with metadata but without the page payloads
-     * Not implemented for now
-     * @param from - Remote version to fetch from
-     * @returnsDocumentationLegacy object
-     */
-    getDocumentationStructureFromRoot(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacyGroup>;
-    /** Fetches entire documentation documentation structure, including all pages and groups and their payloads
+    /** Fetches entire documentation including content in the legacy format
      * @param from - Remote version to fetch from
      * @returns All documentation items
      */
-    getDocumentationFromRoot(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacyGroup>;
+    getFullDocumentationLegacyRepresentation(from: RemoteWorkspaceVersionIdentifier): Promise<{
+        rootGroup: DocumentationLegacyGroup;
+        allPages: Array<DocumentationLegacyPage>;
+        allGroups: Array<DocumentationLegacyGroup>;
+    }>;
     /** Get ID of the multiplayer room for a given documentation page
      * @param from - Remote version to fetch from
      * @param pageId - ID of the documentation page
@@ -209,7 +208,9 @@ export declare class AreaDocumentation {
      * */
     publishDrafts(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment, changes: DTOPublishDocumentationRequest["changes"], isForcing?: boolean): Promise<ExportBuild>;
     getDocumentationPageAnchors(from: RemoteWorkspaceVersionIdentifier, pageId: string): Promise<Array<DTODocumentationPageAnchor>>;
+    getDocumentationDependencies(from: RemoteVersionIdentifier): Promise<DTODocumentationPageDependenciesGetResponse["dependencies"]>;
     getDocumentationMockedStructure(): Array<DocsEntity>;
     getDocumentationMockedPageContent(pageId: string): Array<DocsBlock | DocsSection>;
     getDocumentationMockedEditorBlockDefinitions(): Array<DocsBlockDefinition>;
+    getPortalMockedEditorBlockDefinitions(): Array<DocsBlockDefinition>;
 }

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

@@ -1,4 +1,4 @@
-import { User } from "../../model/users/SDKUser";
+import { User, UserUpdateModel } from "../../model/users/SDKUser";
 import { UserProfileUpdateModel } from "../../model/users/SDKUserProfile";
 import { DataCore } from "../data/SDKDataCore";
 export declare class AreaMe {
@@ -9,6 +9,8 @@ export declare class AreaMe {
     me(): Promise<User>;
     /** Invalidates all session keys for the current user, effectively logging out from all decises. */
     logout(): Promise<void>;
+    /** Updates the current user. */
+    updateMe(userId: string, payload: UserUpdateModel): Promise<void>;
     /** Updates the current user based on the API key provided to Supernova instance. */
     updateProfile(userId: string, profile: UserProfileUpdateModel): Promise<void>;
     /** Updates the avatar of the current user */

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

@@ -0,0 +1,60 @@
+import { DTOForgeChatMessageScoreInput, DTOForgeChatMessageTagInput } from "@supernova-studio/client";
+import { ChatThread } from "../../model/messaging/SDKChatThread";
+import { ChatThreadMessage, ChatThreadMessageInput } from "../../model/messaging/SDKChatThreadMessage";
+import { DataCore } from "../data/SDKDataCore";
+export declare class AreaMessaging {
+    private dataCore;
+    constructor(dataCore: DataCore);
+    /**
+     * Lists chat threads in the specified workspace for the current user based on the session.
+     * @param workspaceId - The ID of the workspace.
+     * @param limit - Optional limit on the number of threads to return.
+     * @param offset - Optional offset for pagination.
+     * @returns An array of ChatThread objects.
+     */
+    listChatThreads(workspaceId: string, limit?: number, offset?: number): Promise<Array<ChatThread>>;
+    /**
+     * Fetches a specific chat thread by its ID. This method retrieves the thread details including its messages and is the only way to get thread content.
+     * @param workspaceId - The ID of the workspace.
+     * @param thread - The thread object to update.
+     * @returns A new copy of the The ChatThread object with filled-in messages.
+     */
+    getChatThreadMessages(workspaceId: string, thread: ChatThread): Promise<ChatThread>;
+    /**
+     * Fetches a specific chat thread by its ID. This method retrieves the thread details including its messages and is the only way to get thread content.
+     * @param workspaceId - The ID of the workspace.
+     * @param threadId - The ID of the thread.
+     * @returns A new copy of the The ChatThread object with filled-in messages.
+     */
+    getChatThreadMessagesByThreadId(workspaceId: string, threadId: string): Promise<Array<ChatThreadMessage>>;
+    /**
+     * Creates a new chat thread in the specified workspace associated with the current user based on the session.
+     * @param workspaceId - The ID of the workspace.
+     * @param title - Optional title for the thread (defaults to "Untitled").
+     * @returns The created ChatThread.
+     */
+    createChatThread(workspaceId: string, title?: string): Promise<ChatThread>;
+    /**
+     * Updates the title of a specific chat thread.
+     * @param workspaceId - The ID of the workspace.
+     * @param threadId - The ID of the thread to update.
+     * @param newTitle - The new title for the thread.
+     * @returns The updated ChatThread.
+     */
+    updateChatThreadTitle(workspaceId: string, threadId: string, newTitle: string): Promise<ChatThread>;
+    /**
+     * Creates a new message in the specific chat thread.
+     * @param workspaceId - The ID of the workspace.
+     * @param threadId - The ID of the thread.
+     * @param messageInput - The message details including payload, senderType, and optional persona.
+     * @returns The created ChatThreadMessage.
+     */
+    createChatThreadMessage(workspaceId: string, threadId: string, messageInput: ChatThreadMessageInput): Promise<ChatThreadMessage>;
+    scoreChatThreadMessage(workspaceId: string, threadId: string, scores: Array<DTOForgeChatMessageScoreInput>, tags?: Array<DTOForgeChatMessageTagInput>): Promise<void>;
+    /**
+     * Deletes a specific chat thread and all its messages.
+     * @param workspaceId - The ID of the workspace.
+     * @param threadId - The ID of the thread to delete.
+     */
+    deleteChatThread(workspaceId: string, threadId: string): Promise<void>;
+}