@supernova-studio/supernova-sdk-beta 2.4.6 → 2.4.9

package/build/types/core/areas/SDKAreaTokens.d.ts

@@ -4,6 +4,7 @@ import { ElementDataView } from "../../model/elements/SDKElementDataView";
 import { ElementDataViewColumn } from "../../model/elements/SDKElementDataViewColumn";
 import { ElementProperty, ElementPropertyCreationModel, ElementPropertyUpdateModel } from "../../model/elements/SDKElementProperty";
 import { ElementPropertyValue } from "../../model/elements/values/SDKElementPropertyValue";
+import { ActivityEventOptions } from "../data/requests/SDKDataCoreWriteRequests";
 import { TokenType } from "../../model/enums/SDKTokenType";
 import { TokenGroup } from "../../model/groups/SDKTokenGroup";
 import { TokenTheme } from "../../model/themes/SDKTokenTheme";
@@ -28,7 +29,7 @@ export declare class AreaTokens {
     getTokens(from: RemoteVersionIdentifier, filter?: {
         type?: TokenType;
         brandId?: string;
-    }): Promise<Array<Token>>;
+    }): Promise<Array<AnyToken>>;
     /** Retrieves all occurances of the specified token in the version - its usages in other tokens, components and documentation pages
      * @param from - Remote version to fetch from
      * @param idInVersion - Token to check for references
@@ -77,7 +78,11 @@ export declare class AreaTokens {
      * @returns All token collections in the specified version
      */
     getTokenCollections(from: RemoteVersionIdentifier): Promise<Array<DesignSystemCollection>>;
-    /** Creates remote token. This method can only be used once per token and will assign persistent id to the token. Calling this version on token that already has id assigned will result in error
+    /** Creates remote token. The token's own persistent id is sent to the server, so this method can only be used once per token. Calling it for a token that already exists remotely will result in error
+     *
+     * Both `id` and `idInVersion` are written back onto the passed token from the server response.
+     *
+     * Only the token itself is written. To create it together with theme overrides or property values, use `bulkOperations.updateTokenData` with `tokenMode: "create"`.
      * @param to - Remote version to write to
      * @param token - Token to create
      * @param parentId - Id of the group to add the token to. This is id of the group, not the versioned id
@@ -92,7 +97,7 @@ export declare class AreaTokens {
      * @returns New token of the specified type, filled with default values
      */
     createLocalToken<T extends TokenType>(tokenType: T, versionId: string, brandId: string, properties: Array<ElementProperty>): TokenTypeMapToken[T];
-    /** Creates local token override. This theme override doesn't have id associated with it on remote, and must be created once with `createThemeOverride` to be stored in design system
+    /** Creates local token override. This theme override doesn't have id associated with it on remote — convert it with `TokenTheme.toWriteOverrideObject` and pass the result to `bulkOperations.updateTokenData` as a theme value to store it in design system
      * @param tokenType - Type of token to create
      * @returns New token of the specified type, filled with default values
      */
@@ -217,20 +222,20 @@ export declare class AreaTokens {
      */
     deleteTokenTheme(to: RemoteVersionIdentifier, idInVersion: string): Promise<void>;
     /** Warning: INTERNAL, DO NOT USE YET, NOT STABLE INTERFACE. Write tokens in bulk */
-    writeTokens(to: RemoteVersionIdentifier, tokens: Array<Token>, groups: Array<TokenGroup>, deleteTokens: Array<Token>, deleteTokenGroups: Array<TokenGroup>): Promise<void>;
+    writeTokens(to: RemoteVersionIdentifier, tokens: Array<Token>, groups: Array<TokenGroup>, deleteTokens: Array<Token>, deleteTokenGroups: Array<TokenGroup>, activityEventOptions?: ActivityEventOptions): Promise<void>;
     /** Warning: INTERNAL, DO NOT USE YET, NOT STABLE INTERFACE. Write theme in bulk */
-    writeTheme(to: RemoteVersionIdentifier, theme: TokenTheme): Promise<void>;
+    writeTheme(to: RemoteVersionIdentifier, theme: TokenTheme, activityEventOptions?: ActivityEventOptions): Promise<void>;
     /** Resolves tokens by applying themes to them and retrieves new token set where values correctly correspond to that theme */
-    computeTokensByApplyingThemes(allTokens: Array<Token>, tokens: Array<Token>, themes: Array<TokenTheme>): Array<Token>;
-    computeInnerReferencesByApplyingThemesEfficient(tokensIndex: Map<string, Token>, themeOverridesIndex: Record<string, Map<string, Token>>, tokens: Array<Token>, themes: Array<TokenTheme>): Array<Token>;
+    computeTokensByApplyingThemes(allTokens: Array<Token>, tokens: Array<Token>, themes: Array<TokenTheme>): Array<AnyToken>;
+    computeInnerReferencesByApplyingThemesEfficient(tokensIndex: Map<string, Token>, themeOverridesIndex: Record<string, Map<string, Token>>, tokens: Array<Token>, themes: Array<TokenTheme>): Array<AnyToken>;
     private computeSingleTokenValueFromReferenceByApplyingThemes;
-    computeTokensByApplyingThemesEfficient(tokensIndex: Map<string, Token>, themeOverridesIndex: Record<string, Map<string, Token>>, tokens: Array<Token>, themes: Array<TokenTheme>): Array<Token>;
+    computeTokensByApplyingThemesEfficient(tokensIndex: Map<string, Token>, themeOverridesIndex: Record<string, Map<string, Token>>, tokens: Array<Token>, themes: Array<TokenTheme>): Array<AnyToken>;
     /** Separates groups by types */
-    computeGroupTrees(groups: Array<TokenGroup>): Promise<Map<TokenType, Array<TokenGroup>>>;
+    computeGroupTrees(groups: Array<TokenGroup>): Map<TokenType, Array<TokenGroup>>;
     /** Get determistic mocked token data. Must be used with mocked token groups */
-    getMockedTokens(from: RemoteBrandIdentifier): Promise<Array<Token>>;
+    getMockedTokens(from: RemoteBrandIdentifier): Array<AnyToken>;
     /** Get determistic mocked token group data. Must be used with mocked tokens */
-    getMockedTokenGroups(from: RemoteBrandIdentifier): Promise<Array<TokenGroup>>;
+    getMockedTokenGroups(from: RemoteBrandIdentifier): Array<TokenGroup>;
     /** Get determistic mocked token data views. Must be used with mocked tokens */
-    getMockedTokenDataViews(from: RemoteVersionIdentifier): Promise<Array<ElementDataView>>;
+    getMockedTokenDataViews(_from: RemoteVersionIdentifier): Array<ElementDataView>;
 }