@supernova-studio/supernova-sdk-beta 1.6.37 → 1.6.39

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

@@ -1,3 +1,4 @@
+import { DocsBlockFigmaNodePropertyOptions, DocsBlockMultiRichTextPropertyOptions } from "../../exports";
 import { DocsBlockDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockDefinition";
 import { DocsBlockItemDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockItemDefinition";
 import { DocsBlockLayout } from "../../model/docs/blocks/definition/SDKDocsBlockLayout";
@@ -12,6 +13,7 @@ import { DocsBlockComponentPropertyDefinition, DocsBlockComponentPropertyOptions
 import { DocsBlockComponentPropertyPropertyDefinition, DocsBlockComponentPropertyPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockComponentPropertyProperty";
 import { DocsBlockDividerPropertyDefinition, DocsBlockDividerPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockDividerProperty";
 import { DocsBlockEmbedUrlPropertyDefinition, DocsBlockEmbedUrlPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty";
+import { DocsBlockFigmaNodePropertyDefinition } from "../../model/docs/blocks/properties/SDKDocsBlockFigmaNodeProperty";
 import { DocsBlockImagePropertyDefinition, DocsBlockImagePropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockImageProperty";
 import { DocsBlockMarkdownPropertyDefinition, DocsBlockMarkdownPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockMarkdownProperty";
 import { DocsBlockMultiSelectPropertyDefinition, DocsBlockMultiSelectPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty";
@@ -64,16 +66,23 @@ export declare class DocsBlockBuilder {
             isBordered?: boolean;
             hasBackground?: boolean;
             isEditorPresentationDifferent?: boolean;
+            showBlockHeaderInEditor?: 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>;
+        image?: string;
+        description?: string;
         maxColumns?: number;
         appearance?: {
             isBordered?: boolean;
             hasBackground?: boolean;
             isEditorPresentationDifferent?: boolean;
+            /** When enabled, the header with block name, description, and header will be displayed
+             * Use only for custom blocks that don't have a good content do be displayed in the editor (e.g. Release notes, Lottie, etc.)
+             * */
+            showBlockHeaderInEditor?: boolean;
         };
     }): DocsBlockVariant;
     /** Create block item with a single variant of rendering */
@@ -103,8 +112,12 @@ export declare class DocsBlockBuilder {
         description?: string;
         item: DocsBlockItemDefinition;
         linkable?: boolean;
-        isBordered?: boolean;
-        hasBackground?: boolean;
+        appearance?: {
+            isBordered?: boolean;
+            hasBackground?: boolean;
+            isEditorPresentationDifferent?: boolean;
+            showBlockHeaderInEditor?: boolean;
+        };
         searchKeywords?: Array<string>;
         onboarding?: DocsBlockOnboarding;
     }): DocsBlockDefinition;
@@ -118,8 +131,12 @@ export declare class DocsBlockBuilder {
         maxItems?: number;
         description?: string;
         linkable?: boolean;
-        isBordered?: boolean;
-        hasBackground?: boolean;
+        appearance?: {
+            isBordered?: boolean;
+            hasBackground?: boolean;
+            isEditorPresentationDifferent?: boolean;
+            showBlockHeaderInEditor?: boolean;
+        };
         searchKeywords?: Array<string>;
         onboarding?: DocsBlockOnboarding;
     }): DocsBlockDefinition;
@@ -135,8 +152,12 @@ export declare class DocsBlockBuilder {
         maxSelection?: number;
         description?: string;
         linkable?: boolean;
-        isBordered?: boolean;
-        hasBackground?: boolean;
+        appearance?: {
+            isBordered?: boolean;
+            hasBackground?: boolean;
+            isEditorPresentationDifferent?: boolean;
+            showBlockHeaderInEditor?: boolean;
+        };
         searchKeywords?: Array<string>;
         onboarding?: DocsBlockOnboarding;
     }): DocsBlockDefinition;
@@ -165,6 +186,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;
@@ -275,6 +306,16 @@ export declare class DocsBlockBuilder {
             [key: string]: DocsBlockAssetPropertyOptions;
         };
     }): DocsBlockAssetPropertyDefinition;
+    /** Create a block property with type .figmaNodeProperty and its specific options */
+    figmaNodeProperty(configuration: {
+        id: string;
+        name: string;
+        description?: string;
+        options: DocsBlockFigmaNodePropertyOptions;
+        variants?: {
+            [key: string]: DocsBlockFigmaNodePropertyOptions;
+        };
+    }): DocsBlockFigmaNodePropertyDefinition;
     /** Create a block property with type .assetProperty and its specific options */
     assetPropertyProperty(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" | "text" | "measure";
+    typeLabel(type: TokenType): "color" | "gradient" | "typography" | "border" | "textCase" | "textDecoration" | "visibility" | "shadow" | "measure" | "text" | 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/TokenUtilPreviewReferenceInfoGenerator.d.ts

@@ -5,6 +5,5 @@ export declare class TokenUtilPreviewReferenceInfoGenerator {
     resolvedInfoForSingleLayerToken(token: Token, allTokens: Map<string, Token>): TokenUtilPreviewReferenceInfo;
     resolvedInfoForMultiLayerToken(token: AnyMultiLayerToken, layerIndex: number, allTokens: Map<string, Token>): TokenUtilPreviewReferenceInfo;
     private label;
-    private textCaseToString;
     private textDecorationToString;
 }

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/tools/token-transform/SDKToolsTokenTransform.d.ts

@@ -8,9 +8,11 @@ export declare class TokenTransform {
     /** Converts token to appropriate css variable definition --(name): css_definition */
     tokenToCSSVariableDeclaration(token: Token, variableName: string): string;
     /** Converts color token value to css definition */
-    colorTokenToCSS(value: ColorTokenValue): string;
+    colorTokenToCSS(value: ColorTokenValue, dedicatedOpacity?: number): string;
     /** Converts border token value to css definition */
     borderTokenToCSS(value: BorderTokenValue): string;
+    /** Converts shadow token and opacity by merging two opacities and using color token opacity as fallback */
+    shadowTokenColorAndOpacityToCSS(value: ShadowTokenValue): string;
     /** Converts shadow token value to css definition */
     shadowsTokenToCSS(value: ShadowTokenValue[]): string;
     shadowTokenToCSS(value: ShadowTokenValue): string;

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

@@ -1,4 +1,4 @@
-import { AnyToken, BlurType, BorderPosition, BorderStyle, DTProcessedTokenNode, GradientType, ShadowType, TokenGroup, TokenTheme } from "../exports";
+import { AnyToken, BlurType, BorderPosition, BorderStyle, DTProcessedTokenNode, GradientType, ShadowType, TextCase, TokenGroup, TokenTheme } from "../exports";
 import { ElementProperty } from "../model/elements/SDKElementProperty";
 import { TokenType } from "../model/enums/SDKTokenType";
 import { BlurToken } from "../model/tokens/SDKBlurToken";
@@ -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;
@@ -289,5 +289,6 @@ export declare class TokenUtils {
     static getTokenByKeyOrFallbackKeys<T extends DTProcessedTokenNode | Token>(node: Pick<DTProcessedTokenNode, "path" | "token">, map: Map<string, T>): T | undefined;
     static getKeysByKeyOrFallbackKeys<T extends DTProcessedTokenNode | Token>(node: Pick<DTProcessedTokenNode, "path" | "token">): string[];
     static getTokenByKeyOrBackwardKey(node: Pick<DTProcessedTokenNode, "path" | "token">, map: Map<string, DTProcessedTokenNode>): DTProcessedTokenNode | undefined;
+    static getTextCaseTokenValue(value: TextCase): "Original" | "Uppercase" | "Lowercase" | "Capitalize" | "Small caps";
 }
 export {};

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;