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

package/README.md

@@ -111,26 +111,43 @@ With cache disabled, every request will download all necessary information for e
 
 ### Release
 
-SDK should be released via CI by opening PR `develop -> publish-sdk` branch once we need to release it.
+**Before releasing:**
 
-Please, in this PR:
+- Bump version in `sdk-typescript/scripts/packages/**.json` files
+- Ensure 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
 
-- 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
-- - the same version is present in `package.json` and `sdk-typescript/scripts/packages/**.json` files.
+SDK can be released via CI in two ways:
 
-Several packages are released:
+#### 1. Manual Release (via GitHub Actions)
 
-- `@supernovaio/sdk` - main SDK used by customers, Pulsar etc
+You can trigger the SDK publish workflow manually:
+
+1. Go to the [GitHub Actions page](https://github.com/Supernova-Studio/cloud-ji/actions)
+2. Select the "Publish SDK & SDK-Exporters to NPM" workflow
+3. Click "Run workflow"
+4. Select the branch (typically `develop`)
+5. Click "Run workflow" button
+
+**Note:** Manual release does not run tests automatically.
+
+#### 2. Standard Release (via Pull Request)
+
+Open a PR from `develop` → `publish-sdk` branch when you need to release. This will automatically trigger the publish workflow when the PR is merged.
+
+#### 3. **Emergency release (from CLI)**
+
+Can be done manually via scripts like `npm run publish-package-sdk`, but CI is preferred.
+
+**Packages released:**
+
+- `@supernovaio/sdk` - Main SDK used by customers, Pulsar etc
 - `@supernovaio/sdk-exporters` - SDK used by exporters helpers
 - `@supernova-studio/supernova-sdk-beta` - SDK used by old BE during Token Studio import only
 
 Having separate version for old BE makes it simpler to release BE without necessity to update & release Pulsar, when we only need changes/fixes in SDK for Token Studio (which happens more often than changes we need for Pulsar).
 
-Emergency release could be done manually via scripts, like `npm run publish-package-sdk`.
-Please, avoid this and try using CI instead, and it helps you with ensuring tests are passed.
-
 ## What's next
 
 As this is still beta, we are working hard on improving it before the first official release. The following are areas we'd like to solve before general release:

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

@@ -2117,9 +2117,11 @@ export declare class AreaProjects {
         }[] | undefined;
     }>;
     deleteProjectContext(id: string): Promise<void>;
-    updateProjectContextOverride(projectId: string, data: {
+    updateProjectContextOverride(wsId: string, projectId: string, data: {
         theme: Partial<ForgeProjectTheme> | null;
-    }): Promise<void>;
+    }, options?: {
+        updateSharedContext?: boolean;
+    }): Promise<import("../../model/projects/SDKForgeProjectContextOverride").ForgeProjectContextOverrideResponse>;
     getProjectTrailEvents(projectId: string): Promise<import("../..").TrailEvent[]>;
     constructor(dataCore: DataCore);
 }

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

@@ -2075,7 +2075,7 @@ export declare class AreaRawData {
             tokenThemeIds: string[];
         }[] | undefined;
     }[]>;
-    getRawForgeProjectContextOverride(projectId: string): Promise<import("../../model/projects/SDKForgeProjectContextOverride").ForgeProjectContextOverrideRemoteModel>;
+    getRawForgeProjectContextOverride(wsId: string, projectId: string): Promise<import("../../model/projects/SDKForgeProjectContextOverride").ForgeProjectContextOverrideResponse>;
     getRawForgeAgents(workspaceId: string, projectId: string): Promise<Array<DTOForgeAgent>>;
     getRawChatThreads(workspaceId: string, limit?: number, offset?: number): Promise<DTOForgeChatThreadListResponse>;
     getRawChatThreadMessages(workspaceId: string, threadId: string): Promise<DTOForgeChatMessageListResponse>;

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

@@ -2665,9 +2665,11 @@ export declare class DataCore {
         workspaceId: string;
     }): Promise<ForgeProjectContext[]>;
     getForgeProjectContext(contextId: string): Promise<ForgeProjectContext>;
-    updateForgeProjectContextOverride(projectId: string, data: {
+    updateForgeProjectContextOverride(wsId: string, projectId: string, data: {
         theme: Partial<ForgeProjectTheme> | null;
-    }): Promise<void>;
+    }, options?: {
+        updateSharedContext?: boolean;
+    }): Promise<import("../../model/projects/SDKForgeProjectContextOverride").ForgeProjectContextOverrideResponse>;
     createForgeProjectSection(workspaceId: string, projectId: string, input: DTOForgeSectionCreateInput, tId?: string): Promise<void>;
     updateForgeProjectSection(workspaceId: string, projectId: string, input: DTOForgeSectionUpdateInput, tId?: string): Promise<void>;
     deleteForgeProjectSection(workspaceId: string, projectId: string, input: DTOForgeSectionDeleteInput, tId?: string): Promise<void>;

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

@@ -29,7 +29,7 @@ import { ImportJobRemoteModel } from "../../../model/jobs/SDKImportJob";
 import { MembershipRemoteModel } from "../../../model/membership/SDKMembership";
 import { ForgeProjectRemoteModel } from "../../../model/projects/SDKForgeProject";
 import { ForgeProjectContextRemoteModel } from "../../../model/projects/SDKForgeProjectContext";
-import type { ForgeProjectContextOverrideRemoteModel } from "../../../model/projects/SDKForgeProjectContextOverride";
+import type { ForgeProjectContextOverrideResponse } from "../../../model/projects/SDKForgeProjectContextOverride";
 import { ResourceAssetModel } from "../../../model/resources/SDKResourceAsset";
 import { ResourceFontModel } from "../../../model/resources/SDKResourceFont";
 import { RemoteStorybookEntry } from "../../../model/storybook/SDKStorybookEntry";
@@ -1317,7 +1317,7 @@ export declare class DataCoreReadRequests {
     /**
      * Remote: Get Forge Project Context Override
      */
-    getRemoteForgeProjectContextOverride(projectId: string): Promise<ForgeProjectContextOverrideRemoteModel>;
+    getRemoteForgeProjectContextOverride(wsId: string, projectId: string): Promise<ForgeProjectContextOverrideResponse>;
     getRemoteForgeAgents(workspaceId: string, projectId: string): Promise<Array<DTOForgeAgent>>;
     getRemoteForgeProjectFeature(workspaceId: string, projectId: string, featureId: string): Promise<DTOForgeProjectFeature>;
     getRemoteForgeProjectFeatures(workspaceId: string, projectId: string): Promise<Array<DTOForgeProjectFeature>>;

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

@@ -19,6 +19,7 @@ import { TokenGroup, TokenGroupRemoteModel } from "../../../model/groups/SDKToke
 import { ImportJobRemoteModel } from "../../../model/jobs/SDKImportJob";
 import { ChatThreadMessageInput } from "../../../model/messaging/SDKChatThreadMessage";
 import { ForgeProjectRemoteModel } from "../../../model/projects/SDKForgeProject";
+import type { ForgeProjectContextOverrideResponse } from "../../../model/projects/SDKForgeProjectContextOverride";
 import { ResourceAssetModel } from "../../../model/resources/SDKResourceAsset";
 import { ResourceFontModel } from "../../../model/resources/SDKResourceFont";
 import { StorybookUpdate } from "../../../model/storybook/SDKStorybookUpdate";
@@ -2851,9 +2852,11 @@ export declare class DataCoreWriteRequests {
     }>;
     deleteForgeProjectContext(contextId: string): Promise<void>;
     /** Remote: Updates a Forge Project Context Override */
-    updateForgeProjectContextOverride(projectId: string, data: {
+    updateForgeProjectContextOverride(wsId: string, projectId: string, data: {
         theme: Partial<ForgeProjectTheme> | null;
-    }): Promise<void>;
+    }, options?: {
+        updateSharedContext?: boolean;
+    }): Promise<ForgeProjectContextOverrideResponse>;
     /** Remote: Create a new exporter build */
     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<ExportBuildModel>;
     createRemoteThreadMessage(threadId: string, input: DTOThreadMessageCreateInput): Promise<DTOThreadMessageResponse>;

package/build/sdk-typescript/src/model/base/SDKDesignSystem.d.ts

@@ -39,6 +39,8 @@ export declare class DesignSystem {
     /** Flag which determines if the design system is available to the user.
      * If `false` then the user doesn't have access to the design system, but knows about its existence (e.g. Owners). */
     isAvailableToUser: boolean;
+    /** Unique identifier of the shared draft version of the design system */
+    sharedDraftId: string;
     constructor(model: Omit<DTODesignSystem, "isPublic"> & {
         isPublic: boolean;
     });

package/build/sdk-typescript/src/model/projects/SDKForgeProjectContextOverride.d.ts

@@ -1,20 +1,17 @@
+import { DTOProjectContextOverrideInput, DTOProjectContextOverride, type DTOForgeProjectContextV2 } from "@supernova-studio/client";
 import type { ForgeProjectTheme } from "./SDKForgeProjectContext";
-export type ForgeProjectContextOverrideRemoteModel = {
-    projectContextId: string;
-    theme: Partial<ForgeProjectTheme>;
-};
-export type ForgeProjectContextOverrideUpdateInput = {
-    theme: Partial<ForgeProjectTheme>;
+export type ForgeProjectContextOverrideRemoteModel = DTOProjectContextOverride;
+export type ForgeProjectContextOverrideInput = DTOProjectContextOverrideInput;
+export type ForgeProjectContextOverrideResponse = {
+    override: DTOProjectContextOverride;
+    resolvedContext: DTOForgeProjectContextV2;
 };
 export declare class ForgeProjectContextOverride {
-    projectContextId: string;
+    projectId: string;
     theme: Partial<ForgeProjectTheme>;
     constructor(data: {
-        projectContextId: string;
+        projectId: string;
         theme: Partial<ForgeProjectTheme>;
     });
-    toRemote(): {
-        projectContextId: string;
-        theme: Partial<ForgeProjectTheme>;
-    };
+    toRemote(): ForgeProjectContextOverrideRemoteModel;
 }