@supernova-studio/supernova-sdk-beta 1.6.30 → 1.6.32

package/build/sdk-typescript/src/model/tokens/SDKTextDecorationToken.d.ts

@@ -14,7 +14,7 @@ export declare class TextDecorationToken extends Token {
     static create(versionId: string, brandId: string, name: string, description: string, value: string, alias: TextDecorationToken | null, properties: Array<ElementProperty>, propertyValues: Array<ElementPropertyValue>): TextDecorationToken;
     static textDecorationFromDefinition(textDecoration: string): {
         value: TextDecoration;
-        referencedTokenId: any;
+        referencedTokenId: null;
     };
     static optionValueFromDefinitionOrReference(definition: any, referenceResolver: DTTokenReferenceResolver, tokenType: OptionTokenType): AnyOptionTokenValue;
     static optionValueFromDefinition(definition: string, type: OptionTokenType): AnyOptionTokenValue;

package/build/sdk-typescript/src/model/tokens/SDKTokenValue.d.ts

@@ -192,9 +192,9 @@ export type AnyPlainTokenValue = Exclude<AnyTokenValue, ShadowTokenValue[] | Gra
 export type RawValue<T extends {
     referencedTokenId: string;
 }> = Omit<T, "referencedTokenId">;
-export declare const getReferencedTokens: (token: AnyToken, allTokens: Map<string, Token>) => Token[];
+export declare const getReferencedTokens: (token: AnyToken, allTokens: Map<string, Token>) => (Token | undefined)[];
 export declare const getSingleReferencedTokenId: (token: AnyToken, allTokens: Map<string, Token>) => string | undefined;
-export declare const checkSingleReferencedTokenById: (token: AnyToken, candidateId: string, allTokens: Map<string, Token>) => boolean;
+export declare const checkSingleReferencedTokenById: (token: AnyToken, candidateId: string, allTokens: Map<string, Token>) => boolean | "";
 export declare const replaceReferencedTokenIds: (token: AnyToken, currentId: string, newId: string, allTokens: Map<string, Token>) => void;
 export declare const replaceReferencedToken: (token: Token, existingToken: AnyToken, newToken: AnyToken) => void;
 export declare const replaceReferencedTokenByIds: (token: Token, existingTokenId: string, newTokenId: string) => void;

package/build/sdk-typescript/src/model/users/SDKUserProfile.d.ts

@@ -1,23 +1,27 @@
+export type UserOnboardingDepartmentType = "Design" | "Engineering" | "Brand" | "Other";
+export type UserOnboardingJobLevelType = "Executive" | "Manager" | "IndividualContributor" | "Other";
 export type UserProfileRemoteModel = {
     name?: string;
     nickname?: string;
     avatar?: string;
     onboarding?: UserProfileOnboardingRemoteModel;
+    isOnboardingFinished?: boolean;
 };
 export type UserProfileOnboardingRemoteModel = {
     companyName?: string;
     numberOfPeopleInOrg?: string;
     numberOfPeopleInDesignTeam?: string;
-    department?: string;
+    department?: UserOnboardingDepartmentType;
     jobTitle?: string;
     phase?: string;
-    jobLevel?: string;
+    jobLevel?: UserOnboardingJobLevelType;
 };
 export type UserProfileTransportModel = UserProfileRemoteModel;
 export type UserProfileOnboardingUpdateModel = UserProfileOnboardingRemoteModel;
 export type UserProfileUpdateModel = {
     name?: string;
     nickname?: string;
+    onboarding?: UserProfileOnboardingRemoteModel;
 };
 export declare class UserProfile {
     /** User name */
@@ -26,15 +30,17 @@ export declare class UserProfile {
     nickname: string | null;
     /** Avatar */
     avatar: string | null;
+    /** Is profile onboarding finished */
+    isOnboardingFinished: boolean;
     /** Onboarding object */
     onboarding: {
         companyName: string | null;
         numberOfPeopleInOrg: string | null;
         numberOfPeopleInDesignTeam: string | null;
-        department: string | null;
+        department: UserOnboardingDepartmentType | null;
         jobTitle: string | null;
         phase: string | null;
-        jobLevel: string | null;
+        jobLevel: UserOnboardingJobLevelType | null;
     } | null;
     constructor(model: UserProfileRemoteModel);
     /** Constructs directly manipulable update object for user profile */

package/build/sdk-typescript/src/tests/FigmaTokensDataLoader.d.ts

@@ -10,9 +10,9 @@ export declare class FigmaTokensDataLoader {
         settings: DTPluginToSupernovaSettings;
         mapping: {
             supernovaBrand: string;
-            supernovaTheme: string;
-            tokensTheme: string | string[];
-            tokenSets: string[];
+            supernovaTheme: string | null;
+            tokensTheme: string | string[] | null;
+            tokenSets: string[] | null;
         }[];
         payload: object;
     }>;

package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts

@@ -1,6 +1,7 @@
 import { Supernova } from "../../core/SDKSupernova";
 import { Brand } from "../../model/base/SDKBrand";
 import { TokenGroup } from "../../model/groups/SDKTokenGroup";
+import { Logger } from "../../model/support/SDKLogger";
 import { TokenTheme } from "../../model/themes/SDKTokenTheme";
 import { Token } from "../../model/tokens/SDKToken";
 import { AnyToken } from "../../model/tokens/SDKTokenValue";
@@ -25,7 +26,7 @@ export declare class SupernovaToolsDesignTokensPlugin {
     private versionId;
     private sortMultiplier;
     private logger;
-    constructor(designSystemId: string, versionId: string, instance: Supernova);
+    constructor(designSystemId: string, versionId: string, instance: Supernova, logger?: Logger);
     synchronizeTokensFromData(data: object, mapping: DTPluginToSupernovaMapPack, settings: DTPluginToSupernovaSettings): Promise<object>;
     synchronizeTokensFromDataWithResults(data: object, mapping: DTPluginToSupernovaMapPack, settings: DTPluginToSupernovaSettings): Promise<{
         results: SupernovaToolsDesignTokensResult[];

package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONParser.d.ts

@@ -1,5 +1,5 @@
-import { Logger } from "../../../model/support/SDKLogger";
 import { DTOriginalTokenType } from "../../../model/enums/SDKTokenType";
+import { Logger } from "../../../model/support/SDKLogger";
 export type DTParsedNode = {
     rootKey: string;
     name: string;

package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTGroupTree.d.ts

@@ -7,6 +7,6 @@ export type TokenTreeElement = Token | TokenGroup;
 export declare class GroupTree extends GroupTreeNode {
     childType: TokenType;
     constructor(backingElement: TokenTreeElement);
-    static populate(root: TokenTreeElement, elements: Array<TokenTreeElement>, parentChildrenMap: Map<string, Array<TokenTreeElement>>): GroupTree;
+    static populate(root: TokenTreeElement, elements: Array<TokenTreeElement>, parentChildrenMap: Map<string, Array<TokenTreeElement>>): GroupTree | null;
 }
 export declare function buildBrandedElementRoots(elements: TokenTreeElement[]): Map<string, Map<TokenType, GroupTree>>;

package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts

@@ -1,5 +1,6 @@
+import { DocsBlockMultiRichTextPropertyOptions } from "../../exports";
 import { DocsBlockDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockDefinition";
-import { DocsBlockItem } from "../../model/docs/blocks/definition/SDKDocsBlockItem";
+import { DocsBlockItemDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockItemDefinition";
 import { DocsBlockLayout } from "../../model/docs/blocks/definition/SDKDocsBlockLayout";
 import { DocsBlockOnboarding } from "../../model/docs/blocks/definition/SDKDocsBlockOnboarding";
 import { DocsBlockVariant } from "../../model/docs/blocks/definition/SDKDocsBlockVariant";
@@ -25,6 +26,7 @@ import { DocsBlockTextPropertyDefinition, DocsBlockTextPropertyOptions } from ".
 import { DocsBlockTokenPropertyDefinition, DocsBlockTokenPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockTokenProperty";
 import { DocsBlockTokenPropertyPropertyDefinition, DocsBlockTokenPropertyPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockTokenPropertyProperty";
 import { DocsBlockTokenTypePropertyDefinition, DocsBlockTokenTypePropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty";
+import { DocsBlockUrlPropertyDefinition, DocsBlockUrlPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockUrlProperty";
 import { DocsBlockBehaviorDataType } from "../../model/enums/SDKDocsBlockBehaviorDataType";
 import { DocsBlockBehaviorSelectionType } from "../../model/enums/SDKDocsBlockBehaviorSelectionType";
 import { DocsBlockCategory } from "../../model/enums/SDKDocsBlockCategory";
@@ -48,6 +50,7 @@ export declare class DocsBlockBuilder {
         name: string;
         image: string;
         layout: DocsBlockLayout;
+        description?: string;
         maxColumns?: number;
     }): DocsBlockVariant;
     /** Create and item variant to render the item with default layout (all properties will be stacked into a single column) */
@@ -56,12 +59,23 @@ export declare class DocsBlockBuilder {
         name: string;
         image: string;
         properties: Array<DocsBlockItemPropertyAnyDefinition>;
+        description?: string;
         maxColumns?: number;
+        appearance?: {
+            isBordered?: boolean;
+            hasBackground?: boolean;
+            isEditorPresentationDifferent?: boolean;
+        };
     }): DocsBlockVariant;
     /** Create and item variant to render the item with default layout (all properties will be stacked into a single column) */
     defaultVariantUsingDefaultLayout(options: {
         properties: Array<DocsBlockItemPropertyAnyDefinition>;
         maxColumns?: number;
+        appearance?: {
+            isBordered?: boolean;
+            hasBackground?: boolean;
+            isEditorPresentationDifferent?: boolean;
+        };
     }): DocsBlockVariant;
     /** Create block item with a single variant of rendering */
     singleVariantItem(configuration: {
@@ -71,7 +85,7 @@ export declare class DocsBlockBuilder {
             isBordered?: boolean;
             hasBackground?: boolean;
         };
-    }): DocsBlockItem;
+    }): DocsBlockItemDefinition;
     /** Create block item with multiple variants of rendering. The first variant becomes the default one */
     multiVariantItem(configuration: {
         properties: Array<DocsBlockItemPropertyAnyDefinition>;
@@ -80,7 +94,7 @@ export declare class DocsBlockBuilder {
             isBordered?: boolean;
             hasBackground?: boolean;
         };
-    }): DocsBlockItem;
+    }): DocsBlockItemDefinition;
     /** Creates a core block definition which can't select from Supernova data, and its item can only be created once (Examples: Rich Text, Callout, Heading blocks) */
     singleItemBlock(configuration: {
         id: string;
@@ -88,7 +102,7 @@ export declare class DocsBlockBuilder {
         category: DocsBlockCategory;
         icon: string;
         description?: string;
-        item: DocsBlockItem;
+        item: DocsBlockItemDefinition;
         linkable?: boolean;
         isBordered?: boolean;
         hasBackground?: boolean;
@@ -101,7 +115,7 @@ export declare class DocsBlockBuilder {
         name: string;
         category: DocsBlockCategory;
         icon: string;
-        item: DocsBlockItem;
+        item: DocsBlockItemDefinition;
         maxItems?: number;
         description?: string;
         linkable?: boolean;
@@ -116,7 +130,7 @@ export declare class DocsBlockBuilder {
         name: string;
         icon: string;
         category: DocsBlockCategory;
-        item: DocsBlockItem;
+        item: DocsBlockItemDefinition;
         dataType: Exclude<DocsBlockBehaviorDataType, DocsBlockBehaviorDataType.item>;
         selectionType: DocsBlockBehaviorSelectionType;
         maxSelection?: number;
@@ -152,6 +166,16 @@ export declare class DocsBlockBuilder {
             [key: string]: DocsBlockRichTextPropertyOptions;
         };
     }): DocsBlockRichTextPropertyDefinition;
+    /** Create a block property with type .richText and its specific options */
+    multiRichTextProperty(configuration: {
+        id: string;
+        name: string;
+        description?: string;
+        options: DocsBlockMultiRichTextPropertyOptions;
+        variants?: {
+            [key: string]: DocsBlockMultiRichTextPropertyOptions;
+        };
+    }): DocsBlockRichTextPropertyDefinition;
     /** Create a block property with type .boolean and its specific options */
     booleanProperty(configuration: {
         id: string;
@@ -292,6 +316,16 @@ export declare class DocsBlockBuilder {
             [key: string]: DocsBlockMarkdownPropertyOptions;
         };
     }): DocsBlockMarkdownPropertyDefinition;
+    /** Create a block property with type .url and its specific options */
+    urlProperty(configuration: {
+        id: string;
+        name: string;
+        description?: string;
+        options: DocsBlockUrlPropertyOptions;
+        variants?: {
+            [key: string]: DocsBlockUrlPropertyOptions;
+        };
+    }): DocsBlockUrlPropertyDefinition;
     /** Create a block property with type .storybook and its specific options */
     storybookProperty(configuration: {
         id: string;

package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementFigmaTokensTransformer.d.ts

@@ -23,7 +23,7 @@ export declare class TokenJSONElementFigmaTokensTransformer extends TokenJSONEle
     /** Retrieve token wrapper containing its metadata and value information (used as container for each defined token) */
     tokenWrapper(token: Token, value: any, options: TokenJSONBuilderOptionsInternal, groups: Array<TokenGroup>): object;
     /** Retrieve human-readable token type in unified fashion, used both as token type and as token master group */
-    typeLabelConsideringAbstractGroups(token: Token, groups: Array<TokenGroup>): string;
+    typeLabelConsideringAbstractGroups(token: Token, groups: Array<TokenGroup>): string | undefined;
     /** Retrieve wrapper to certain token (referenced by name) pointing to token value */
     referenceWrapper(reference: string): string;
     /** Retrieve safe group name made out of normal group name

package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementTransformer.d.ts

@@ -62,7 +62,7 @@ export declare class TokenJSONElementTransformer {
     safeGroupName(group: TokenGroup): string;
     processedName(name: string, naming: JSONBuilderNamingOption): string;
     /** Retrieve human-readable token type in unified fashion, used both as token type and as token master group */
-    typeLabel(type: TokenType): "color" | "gradient" | "typography" | "border" | "textCase" | "textDecoration" | "visibility" | "shadow" | "measure" | "text";
+    typeLabel(type: TokenType): "color" | "gradient" | "typography" | "border" | "textCase" | "textDecoration" | "visibility" | "shadow" | "text" | "measure" | undefined;
     /** Retrieve chain of groups up to a specified group, ordered from parent to children */
     referenceGroupChain(containingGroup: TokenGroup, allGroups: Array<TokenGroup>): Array<TokenGroup>;
 }

package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewGenerator.d.ts

@@ -7,7 +7,10 @@ export declare class TokenUtilPreviewGenerator {
     /** Generates metadata required for rendering of the preview. Only usable with Supernova preview */
     static tokenPreviewMetadata(token: Token, allTokens: Map<string, Token>): TokenUtilPreviewMetadata;
     /** Generates style required for rendering of the preview. Only usable with Supernova preview */
-    static tokenPreviewStyle(token: Token): TokenUtilPreviewResolvedStyle;
+    static tokenPreviewStyle(token: Token, overridenStyles?: {
+        fontFamily?: string;
+        fontWeight?: string;
+    }): TokenUtilPreviewResolvedStyle;
     /** Generates adjusted preview type required for rendering of the preview. Only usable with Supernova preview */
     static tokenPreviewType(token: Token): TokenUtilPreviewTokenType;
     /** Generates per-value description of passed token. Only usable with Supernova preview */

package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewStyleGenerator.d.ts

@@ -1,5 +1,8 @@
 import { Token } from "../../model/tokens/SDKToken";
 import { TokenUtilPreviewResolvedStyle } from "./TokenUtilPreviewTypes";
 export declare class TokenUtilPreviewStyleGenerator {
-    resolvedStyleForToken(token: Token): TokenUtilPreviewResolvedStyle | undefined;
+    resolvedStyleForToken(token: Token, overridenStyles?: {
+        fontFamily?: string;
+        fontWeight?: string;
+    }): TokenUtilPreviewResolvedStyle | undefined;
 }

package/build/sdk-typescript/src/utils/CommonUtils.d.ts

@@ -0,0 +1,5 @@
+export declare function castEnum<O extends string>(value: `${O}`): O;
+export declare function castOptionalEnum<O extends string>(value: `${O}` | undefined): O | undefined;
+export type NonEmptyArray<T> = [T, ...T[]];
+export declare function sureOf<T>(entity: T | null | undefined): NonNullable<T>;
+export declare function sortUsingMap<T, K>(items: Array<T>, indexes: Map<K, number>, keyFn: (item: T) => K): Array<T>;

package/build/sdk-typescript/src/utils/TokenUtils.d.ts

@@ -81,7 +81,7 @@ export declare class TokenUtils {
     static tokensToReferenceMap(tokens: Array<Token>): Map<string, Token>;
     /** Map token groups for lookup */
     static tokenGroupsToReferenceMap(groups: Array<TokenGroup>): Map<string, TokenGroup>;
-    static lookupReference<T extends Token>(id: string, tokens: Map<string, Token>): T | undefined;
+    static lookupReference<T extends Token>(id: string | undefined | null, tokens: Map<string, Token>): T | undefined;
     /** Creates a new token group for a given token type. Default values will be used for all properties */
     static createDefaultTokenGroup(type: TokenType, versionId: string, brandId: string, name?: string): TokenGroup;
     /** Creates a new token theme. Default values will be used for all properties */
@@ -275,9 +275,9 @@ export declare class TokenUtils {
     private static checkNotReference;
     private static rawOrReferencedDimensionValue;
     private static rawOrReferencedStringValue;
-    private static validateLayerAccess;
+    static validateLayerAccess(token: AnyMultiLayerToken, index: number): void;
     static inlineValueIntoComplexTokens(token: AnyToken, candidateId: string, candidateValueToInline: AnyTokenValue): void;
-    static getRefIdsFromComplexTokens(token: AnyToken): string[];
+    static getRefIdsFromComplexTokens(token: AnyToken): (string | null | undefined)[];
     static buildKey(path: Array<string>, name: string): string;
     static buildPath(token: Token, groups: Array<TokenGroup>): Array<string>;
     static mapTypeToPrefix: (type: TokenType) => string;

package/build/sdk-typescript/src/utils/deepPartial.d.ts

@@ -0,0 +1,3 @@
+export type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;