@supernova-studio/supernova-sdk-beta 1.6.16 → 1.6.18

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

@@ -1,4 +1,4 @@
-import { Brand } from "../../model/base/SDKBrand";
+import { Component } from "../../model/components/SDKComponent";
 import { ElementProperty } from "../../model/elements/SDKElementProperty";
 import { TokenGroup } from "../../model/groups/SDKTokenGroup";
 import { TokenTheme } from "../../model/themes/SDKTokenTheme";
@@ -16,6 +16,15 @@ export type TokenUpdateTransactionData = {
     propertyValuesToDelete?: Array<string>;
     themesToUpdate?: Array<TokenTheme>;
 };
+export type ComponentUpdateTransactionData = {
+    component: Component;
+    componentMode: "create" | "update";
+    propertyValuesToCreateOrUpdate?: Array<{
+        property: ElementProperty;
+        value: string | boolean | number;
+    }>;
+    propertyValuesToDelete?: Array<string>;
+};
 export declare class AreaBulkOperations {
     /** Internal: Engine */
     private dataCore;
@@ -27,5 +36,13 @@ export declare class AreaBulkOperations {
      * @param data - Update information. All keys except token and its parent are optional and any combination of optional properties is allowed.
      * @returns Nothing
      */
-    updateTokenData(to: RemoteVersionIdentifier, data: TokenUpdateTransactionData): Promise<Array<Brand>>;
+    updateTokenData(to: RemoteVersionIdentifier, data: TokenUpdateTransactionData): Promise<void>;
+    /** 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.
+     * @param to - Remote version to write to
+     * @param data - Update information. All keys except component and its parent are optional and any combination of optional properties is allowed.
+     * @returns Nothing
+     */
+    updateComponentData(to: RemoteVersionIdentifier, data: ComponentUpdateTransactionData): Promise<void>;
 }

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

@@ -53,7 +53,7 @@ export declare class AreaComponents {
      * @param parentId - Id of the group to add the component to. This is id of the group, not the versioned id
      * @returns New remote component ids
      */
-    createComponent(to: RemoteVersionIdentifier, component: Component, parentId: string): Promise<{
+    createComponent(to: RemoteVersionIdentifier, component: Component): Promise<{
         id: string;
         idInVersion: string;
     }>;
@@ -67,7 +67,7 @@ export declare class AreaComponents {
      * @param parentId - Id of the group to add the group to. This is id of the group, not the versioned id
      * @returns New remote component group ids
      */
-    createComponentGroup(to: RemoteVersionIdentifier, group: ComponentGroup, parentId: string): Promise<{
+    createComponentGroup(to: RemoteVersionIdentifier, group: ComponentGroup): Promise<{
         id: string;
         idInVersion: string;
     }>;

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

@@ -35,7 +35,7 @@ import { WorkspaceOnboarding, WorkspaceOnboardingUpdateModel } from "../../model
 import { SubscriptionProductFeatures } from "../../model/workspaces/SDKWorkspaceProductFeatures";
 import { WorkspaceProfileUpdateModel } from "../../model/workspaces/SDKWorkspaceProfile";
 import { WorkspaceSSOSettings, WorkspaceSSOSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceSSOSettings";
-import { TokenUpdateTransactionData } from "../areas/SDKAreaBulkOperations";
+import { ComponentUpdateTransactionData, TokenUpdateTransactionData } from "../areas/SDKAreaBulkOperations";
 import { RenderedAssetRequestSettings } from "./requests/SDKDataCoreRenderRequests";
 import { DataBridge } from "./SDKDataBridge";
 export declare class DataCore {
@@ -147,21 +147,21 @@ export declare class DataCore {
     designComponents(designSystemId: string, versionId: string): Promise<Array<DesignComponent>>;
     designComponentGroups(designSystemId: string, versionId: string): Promise<Array<DesignComponentGroup>>;
     /** Write new component to remote */
-    createComponent(designSystemId: string, versionId: string, component: Component, parentId: string): Promise<{
+    createComponent(designSystemId: string, versionId: string, component: Component): Promise<{
         id: string;
         idInVersion: string;
     }>;
     /** Update existing component in remote */
     updateComponent(designSystemId: string, versionId: string, component: Component): Promise<void>;
     /** Write new component group to remote */
-    createComponentGroup(designSystemId: string, versionId: string, group: ComponentGroup, parentId: string): Promise<{
+    createComponentGroup(designSystemId: string, versionId: string, group: ComponentGroup): Promise<{
         id: string;
         idInVersion: string;
     }>;
     /** Update existing component group in remote */
     updateComponentGroup(designSystemId: string, versionId: string, group: ComponentGroup): Promise<void>;
     /** Update component property at remote */
-    updateComponentPropertyValue(designSystemId: string, versionId: string, newValue: string | boolean, component: Component, property: ElementProperty): Promise<void>;
+    updateComponentPropertyValue(designSystemId: string, versionId: string, newValue: string | boolean | number, component: Component, property: ElementProperty): Promise<void>;
     /** Delete component property in remote */
     deleteComponentPropertyValue(designSystemId: string, versionId: string, valueId: string): Promise<void>;
     /** Create a custom property in remote */
@@ -256,6 +256,7 @@ export declare class DataCore {
     getBrand(designSystemId: string, versionId: string, brandId: string): Promise<Brand>;
     getOAuthURL(service: "figma" | "bitbucket" | "github" | "gitlab" | "azure"): Promise<string>;
     bulkUpdateTokenData(designSystemId: string, versionId: string, data: TokenUpdateTransactionData): Promise<any>;
+    bulkUpdateComponentData(designSystemId: string, versionId: string, data: ComponentUpdateTransactionData): Promise<any>;
     getTokenStudioData(designSystemId: string, versionId: string): Promise<object>;
     writeTokenStudioData(designSystemId: string, versionId: string, data: object): Promise<boolean>;
 }

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

@@ -1,6 +1,6 @@
 import { DocumentationEnvironment } from "../../../model/enums/SDKDocumentationEnvironment";
 import { ElementDataViewColumnType } from "../../../exports";
-import { Component, ComponentRemoteModel } from "../../../model/components/SDKComponent";
+import { Component, ComponentRemoteModel, ComponentUpdateRemoteModel } from "../../../model/components/SDKComponent";
 import { ElementPropertyRemoteModel } from "../../../model/elements/SDKElementProperty";
 import { ComponentGroup, ComponentGroupRemoteModel } from "../../../model/groups/SDKComponentGroup";
 import { TokenGroup, TokenGroupRemoteModel } from "../../../model/groups/SDKTokenGroup";
@@ -74,13 +74,13 @@ export declare class DataCoreWriteRequests {
     updateReorderTokenColumn(designSystemId: string, versionId: string, viewId: string, columnId: string, newIndex: number): Promise<void>;
     updateResizeTokenColumn(designSystemId: string, versionId: string, viewId: string, columnType: ElementDataViewColumnType, columnId: string, columnThemeId: string | undefined, columnBasePropertyType: string | undefined, columnPropertyDefinitionId: string | undefined, newWidth: number): Promise<void>;
     createRemoteComponent(designSystemId: string, versionId: string, component: ComponentRemoteModel): Promise<ComponentRemoteModel>;
-    updateRemoteComponent(designSystemId: string, versionId: string, component: ComponentRemoteModel): Promise<ComponentRemoteModel>;
+    updateRemoteComponent(designSystemId: string, versionId: string, component: ComponentUpdateRemoteModel): Promise<ComponentRemoteModel>;
     createRemoteComponentGroup(designSystemId: string, versionId: string, group: ComponentGroupRemoteModel): Promise<ComponentGroupRemoteModel>;
     updateRemoteComponentGroup(designSystemId: string, versionId: string, group: ComponentGroupRemoteModel): Promise<void>;
     deleteRemoteComponent(designSystemId: string, versionId: string, componentId: string): Promise<void>;
     ungroupRemoteComponentGroup(designSystemId: string, versionId: string, componentGroupId: string): Promise<void>;
     writeComponentData(designSystemId: string, versionId: string, components: Array<ComponentRemoteModel>, groups: Array<ComponentGroupRemoteModel>, deleteComponents: Array<Component>, deleteComponentGroups: Array<ComponentGroup>): Promise<void>;
-    updateComponentPropertyValue(designSystemId: string, versionId: string, newValue: string | boolean, componentId: string, propertyId: string): Promise<void>;
+    updateComponentPropertyValue(designSystemId: string, versionId: string, newValue: string | boolean | number, componentId: string, propertyId: string): Promise<void>;
     deleteComponentPropertyValue(designSystemId: string, versionId: string, valueId: string): Promise<void>;
     createComponentProperty(designSystemId: string, versionId: string, model: object): Promise<ElementPropertyRemoteModel>;
     updateComponentProperty(designSystemId: string, versionId: string, propertyIdInVersion: string, model: object): Promise<void>;

package/build/sdk-typescript/src/model/components/SDKComponent.d.ts

@@ -3,7 +3,6 @@ import { ElementPropertyValue } from "../elements/values/SDKElementPropertyValue
 export type ComponentRemoteModel = {
     id: string;
     persistentId: string;
-    designSystemVersionId: string;
     brandId: string;
     meta: {
         name: string;
@@ -13,6 +12,7 @@ export type ComponentRemoteModel = {
     updatedAt?: string;
     groupPersistentId?: string;
 };
+export type ComponentUpdateRemoteModel = Omit<ComponentRemoteModel, "brandId">;
 export declare class Component {
     idInVersion: string;
     id: string;
@@ -21,9 +21,12 @@ export declare class Component {
     name: string;
     description: string;
     properties: Array<ElementProperty>;
-    propertyValues: object;
+    propertyValues: {
+        [key: string]: string | boolean | number;
+    };
     createdAt: Date | null;
     updatedAt: Date | null;
     constructor(model: ComponentRemoteModel, properties: Array<ElementProperty>, propertyValues: Array<ElementPropertyValue>);
     toWriteObject(): ComponentRemoteModel;
+    toWriteUpdateObject(): ComponentUpdateRemoteModel;
 }