@supernova-studio/supernova-sdk-beta 1.6.13 → 1.6.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/build/sdk-typescript/src/core/areas/SDKAreaBulkOperations.d.ts +1 -1
  2. package/build/sdk-typescript/src/core/areas/SDKAreaPipelines.d.ts +3 -2
  3. package/build/sdk-typescript/src/core/areas/SDKAreaTokens.d.ts +11 -3
  4. package/build/sdk-typescript/src/core/areas/SDKAreaVersions.d.ts +2 -0
  5. package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +11 -5
  6. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +3 -1
  7. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +7 -5
  8. package/build/sdk-typescript/src/core/resolvers/SDKDocumentationItemResolver.d.ts +3 -2
  9. package/build/sdk-typescript/src/exports.d.ts +4 -0
  10. package/build/sdk-typescript/src/model/documentation/SDKDocumentationItem.d.ts +2 -0
  11. package/build/sdk-typescript/src/model/documentation/SDKDocumentationPage.d.ts +3 -2
  12. package/build/sdk-typescript/src/model/enums/SDKDocumentationEnvironment.d.ts +4 -0
  13. package/build/sdk-typescript/src/model/themes/SDKTokenTheme.d.ts +5 -5
  14. package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +5 -5
  15. package/build/sdk-typescript/src/model/tokens/SDKBlurToken.d.ts +1 -1
  16. package/build/sdk-typescript/src/model/tokens/SDKBorderToken.d.ts +1 -1
  17. package/build/sdk-typescript/src/model/tokens/SDKColorToken.d.ts +1 -1
  18. package/build/sdk-typescript/src/model/tokens/SDKDimensionToken.d.ts +43 -16
  19. package/build/sdk-typescript/src/model/tokens/SDKGradientToken.d.ts +1 -1
  20. package/build/sdk-typescript/src/model/tokens/SDKShadowToken.d.ts +1 -1
  21. package/build/sdk-typescript/src/model/tokens/SDKStringToken.d.ts +32 -7
  22. package/build/sdk-typescript/src/model/tokens/SDKTextCaseToken.d.ts +1 -1
  23. package/build/sdk-typescript/src/model/tokens/SDKTextDecorationToken.d.ts +1 -1
  24. package/build/sdk-typescript/src/model/tokens/SDKToken.d.ts +3 -1
  25. package/build/sdk-typescript/src/model/tokens/SDKTokenValue.d.ts +1 -0
  26. package/build/sdk-typescript/src/model/tokens/SDKTypographyToken.d.ts +1 -1
  27. package/build/sdk-typescript/src/model/tokens/SDKVisibilityToken.d.ts +1 -1
  28. package/build/sdk-typescript/src/tests/Areas/AreaDocumentation.spec.d.ts +1 -0
  29. package/build/sdk-typescript/src/tests/Enterprise/PluginFigmaTokens.spec.d.ts +1 -0
  30. package/build/sdk-typescript/src/tests/FigmaTokensDataLoader.d.ts +13 -0
  31. package/build/sdk-typescript/src/tests/validators.d.ts +1 -1
  32. package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +2 -1
  33. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONConverter.d.ts +3 -3
  34. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTThemeMerger.d.ts +0 -2
  35. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenMerger.d.ts +3 -4
  36. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenReferenceResolver.d.ts +13 -2
  37. package/build/sdk-typescript/src/tools/design-tokens/utilities/collection/SDKDTTokenCollection.d.ts +1 -1
  38. package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewSegmentGenerator.d.ts +3 -1
  39. package/build/sdk-typescript/src/utils/TokenUtils.d.ts +45 -0
  40. package/build/supernova-sdk-typescript.js +65269 -2
  41. package/build/supernova-sdk-typescript.js.map +1 -1
  42. package/package.json +4 -3
@@ -3,6 +3,19 @@ import { DTPluginToSupernovaMapPack, DTPluginToSupernovaSettings } from "../tool
3
3
  export declare class FigmaTokensDataLoader {
4
4
  static sync(instance: Supernova, designSystemId: string, versionId: string, basePath: string[], dataPath?: string[], mappingPath?: string[], root?: string): Promise<void>;
5
5
  static syncPath(instance: Supernova, designSystemId: string, versionId: string, basePath: string, dataPath?: string, mappingPath?: string, root?: string): Promise<void>;
6
+ static loadTokenStudioPayload(basePath: string[], dataPath?: string[], mappingPath?: string[], root?: string): Promise<{
7
+ connection: {
8
+ name: string;
9
+ };
10
+ settings: DTPluginToSupernovaSettings;
11
+ mapping: {
12
+ supernovaBrand: string;
13
+ supernovaTheme: string;
14
+ tokensTheme: string;
15
+ tokenSets: string[];
16
+ }[];
17
+ payload: object;
18
+ }>;
6
19
  /** Load token definitions from path */
7
20
  loadTokensFromPath(pathToFile: string): object;
8
21
  loadTokensFromDirectory(pathToDirectory: string, settingsPath: string): object;
@@ -75,7 +75,7 @@ export declare const validateTypographyToken: (t: any, tokens: Token[], name: st
75
75
  export declare const validateTypographyTokenRef: (t: any, tokens: Token[], description: string, refName: string, fontFamily: string, fontWeight: string, lineHeightMeasure: number, fontSizeMeasure: number, letterSpacingMeasure: number, paragraphSpacingMeasure: number, paragraphIndentMeasure: number, textDecoration: TextDecoration, textCase: TextCase) => void;
76
76
  export declare const validateTypographyTokenInnerRef: (t: any, tokens: Token[], name: string, fontFamily: string, fontWeight: string, lineHeightMeasure: number, fontSizeMeasure: number, letterSpacingMeasure: number, paragraphSpacingMeasure: number, paragraphIndentMeasure: number, textDecoration: TextDecoration, textCase: TextCase) => void;
77
77
  export declare const validateNoToken: (t: any, tokens: Token[], name: string) => void;
78
- export declare const validateTokenRef: (t: any, tokens: Token[], description: string, hex: string, name: string) => void;
78
+ export declare const validateTokenRef: (t: any, tokens: Token[], description: string, hex: string, name: string, refDescription?: string) => void;
79
79
  export declare const validateTokensJustColorRef: (t: any, token: ColorToken, colorRef: ColorToken, name: string, hex: string, opacity?: number, colorRefId?: string, colorRefName?: string, refHex?: string, refOpacity?: number) => void;
80
80
  export declare const validateTokenJustColorRef: (t: any, tokens: Token[], name: string, hex: string, opacity?: number, colorRefId?: string, colorRefName?: string, refHex?: string, refOpacity?: number) => void;
81
81
  export declare const validateDimensionTokenRef: (t: any, tokens: Token[], description: string, refName: string, measure: number, unit: Unit) => void;
@@ -6,6 +6,7 @@ import { Token } from "../../model/tokens/SDKToken";
6
6
  import { DTProcessedTokenNode } from "./utilities/SDKDTJSONConverter";
7
7
  import { DTPluginToSupernovaMap, DTPluginToSupernovaMapPack, DTPluginToSupernovaSettings } from "./utilities/SDKDTMapLoader";
8
8
  import { DTTokenMergeDiff } from "./utilities/SDKDTTokenMerger";
9
+ import { AnyToken } from "../../model/tokens/SDKTokenValue";
9
10
  export type SupernovaToolsDesignTokensLoadingResult = {
10
11
  processedNodes: Array<DTProcessedTokenNode>;
11
12
  tokens: Array<Token>;
@@ -30,7 +31,7 @@ export declare class SupernovaToolsDesignTokensPlugin {
30
31
  private setTokensOrigin;
31
32
  /** Creates pure tree for validation purposes, ignoring any existing token state in workspaces. This method works offline. */
32
33
  createPureTokenTree(processedNodes: Array<DTProcessedTokenNode>, verbose: boolean): {
33
- tokens: Array<Token>;
34
+ tokens: Array<AnyToken>;
34
35
  groups: Array<TokenGroup>;
35
36
  };
36
37
  /** Loads remote source connected to this tool, then merges tokens and groups with it, creating union. Can optionally write to the source as well */
@@ -1,11 +1,11 @@
1
1
  import { Brand } from "../../../model/base/SDKBrand";
2
2
  import { DTOriginalTokenType } from "../../../model/enums/SDKTokenType";
3
- import { Token } from "../../../model/tokens/SDKToken";
4
3
  import { DTParsedNode } from "./SDKDTJSONLoader";
5
4
  import { DTPluginToSupernovaMapPack } from "./SDKDTMapLoader";
6
5
  import { DTTokenReferenceResolver } from "./SDKDTTokenReferenceResolver";
7
- export type DTProcessedTokenNode = {
8
- token: Token;
6
+ import { AnyToken } from "../../../model/tokens/SDKTokenValue";
7
+ export type DTProcessedTokenNode<T extends AnyToken = AnyToken> = {
8
+ token: T;
9
9
  originalType: DTOriginalTokenType;
10
10
  path: Array<string>;
11
11
  key: string;
@@ -12,6 +12,4 @@ export declare class DTThemeMerger {
12
12
  constructor(versionId: string);
13
13
  makeTheme(upstreamTokens: Array<Token>, upstreamGroups: Array<TokenGroup>, upstreamTheme: TokenTheme, processedNodes: Array<DTProcessedTokenNode>, preciseCopy?: boolean): TokenTheme;
14
14
  inlineTokens(themeReplica: TokenTheme, tokensInThemeButNotInUpstream: Map<string, DTProcessedTokenNode>): void;
15
- buildKey(path: Array<string>, name: string): string;
16
- buildPath(token: Token, groups: Array<TokenGroup>): Array<string>;
17
15
  }
@@ -1,5 +1,5 @@
1
1
  import { TokenGroup } from "../../../model/groups/SDKTokenGroup";
2
- import { Token } from "../../../model/tokens/SDKToken";
2
+ import { AnyToken } from "../../../model/tokens/SDKTokenValue";
3
3
  import { DTProcessedTokenNode } from "./SDKDTJSONConverter";
4
4
  export type DTTokenMergeDiff = {
5
5
  toUpdate: Array<DTProcessedTokenNode>;
@@ -10,8 +10,7 @@ export type DTTokenMergeDiff = {
10
10
  /** Utility allowing merging of two pools of tokens */
11
11
  export declare class DTTokenMerger {
12
12
  static buildKey(path: Array<string>, name: string): string;
13
- buildPath(token: Token, groups: Array<TokenGroup>): Array<string>;
14
13
  buildNodeMap(nodes: Array<DTProcessedTokenNode>): Map<string, DTProcessedTokenNode>;
15
- convertBaseTokensToProcessedNode(tokens: Array<Token>, groups: Array<TokenGroup>): Array<DTProcessedTokenNode>;
16
- makeTokensDiff(existing: Array<Token>, extracted: Array<DTProcessedTokenNode>, groups: Array<TokenGroup>): DTTokenMergeDiff;
14
+ convertBaseTokensToProcessedNode(tokens: Array<AnyToken>, groups: Array<TokenGroup>): Array<DTProcessedTokenNode>;
15
+ makeTokensDiff(existing: Array<AnyToken>, extracted: Array<DTProcessedTokenNode>, groups: Array<TokenGroup>): DTTokenMergeDiff;
17
16
  }
@@ -1,3 +1,4 @@
1
+ import { TokenType } from "../../../model/enums/SDKTokenType";
1
2
  import { Token } from "../../../model/tokens/SDKToken";
2
3
  import { AnyToken } from "../../../model/tokens/SDKTokenValue";
3
4
  import { DTProcessedTokenNode } from "./SDKDTJSONConverter";
@@ -9,19 +10,22 @@ export declare class DTTokenReferenceResolver {
9
10
  addAtomicToken(token: DTProcessedTokenNode, indexOfNewNode: number): void;
10
11
  addAtomicTokens(tokens: Array<DTProcessedTokenNode>): void;
11
12
  unmappedValues(): Array<DTProcessedTokenNode>;
13
+ tokensOfType(type: TokenType): Array<Token>;
12
14
  lookupReferencedToken(reference: string): Token | undefined;
13
15
  lookupAllReferencedTokens(reference: string): Array<{
14
16
  token: Token;
15
17
  key: string;
16
18
  location: number;
19
+ dollarTypeReference: boolean;
17
20
  }> | undefined;
18
21
  replaceAllReferencedTokens(reference: string, replacements: Array<{
19
22
  token: Token;
20
23
  key: string;
21
24
  location: number;
25
+ dollarTypeReference: boolean;
22
26
  }>): string;
23
- replaceToken(base: string, token: Token, key: string, location: number): string;
24
- replaceAt(s: string, what: string, replacement: string, index: number): string;
27
+ replaceToken(base: string, token: Token, key: string, location: number, dollarTypeReference: boolean): string;
28
+ replaceAt(s: string, what: string, replacement: string, index: number, dollarTypeReference: boolean): string;
25
29
  replacableValue(token: Token): string;
26
30
  isBalancedReference(syntax: string): boolean;
27
31
  valueHasReference(value: string | object | number): boolean;
@@ -32,5 +36,12 @@ export declare class DTTokenReferenceResolver {
32
36
  findBracketStrings(str: string): {
33
37
  index: number;
34
38
  value: string;
39
+ dollarTypeReference: boolean;
35
40
  }[];
41
+ findDollarStrings(str: string): {
42
+ index: number;
43
+ value: string;
44
+ dollarTypeReference: boolean;
45
+ }[];
46
+ isDollarIdentifier(value: string): boolean;
36
47
  }
@@ -2,7 +2,7 @@ import { DTProcessedTokenNode } from "../SDKDTJSONConverter";
2
2
  export declare class DTProcessedTokenNodeCollection {
3
3
  readonly index: Map<string, DTProcessedTokenNode>;
4
4
  readonly added: Set<string>;
5
- readonly deleted: Map<string, DTProcessedTokenNode>;
5
+ readonly deleted: Map<string, DTProcessedTokenNode<import("../../../..").AnyToken>>;
6
6
  readonly dirty: Set<string>;
7
7
  readonly list: Array<DTProcessedTokenNode>;
8
8
  constructor(source: Array<DTProcessedTokenNode> | Map<string, DTProcessedTokenNode>);
@@ -1,5 +1,7 @@
1
1
  import { Token } from "../../model/tokens/SDKToken";
2
+ import { ShadowTokenValue } from "../../model/tokens/SDKTokenValue";
2
3
  import { TokenUtilPreviewTokenValueSegment } from "./TokenUtilPreviewTypes";
3
4
  export declare class TokenUtilPreviewSegmentGenerator {
4
- resolvedSegmentsForToken(token: Token, allTokens: Map<string, Token>): Array<TokenUtilPreviewTokenValueSegment | "separator">;
5
+ static resolvedSegmentsForToken(token: Token, allTokens: Map<string, Token>): Array<TokenUtilPreviewTokenValueSegment | "separator">;
6
+ static shadowValuesToSegments(layer: ShadowTokenValue | null, allTokens: Map<string, Token>): Array<TokenUtilPreviewTokenValueSegment | "separator">;
5
7
  }
@@ -11,6 +11,7 @@ import { FontFamilyToken, FontWeightToken, ProductCopyToken, StringToken } from
11
11
  import { TextCaseToken } from "../model/tokens/SDKTextCaseToken";
12
12
  import { TextDecorationToken } from "../model/tokens/SDKTextDecorationToken";
13
13
  import { Token } from "../model/tokens/SDKToken";
14
+ import { AnyTokenValue } from "../model/tokens/SDKTokenValue";
14
15
  import { TypographyToken } from "../model/tokens/SDKTypographyToken";
15
16
  import { VisibilityToken } from "../model/tokens/SDKVisibilityToken";
16
17
  type TokenMapCompletenessTypeCheck<T extends {
@@ -43,7 +44,38 @@ type ActualTypeToTokenMap = {
43
44
  [TokenType.duration]: DurationToken;
44
45
  [TokenType.zIndex]: ZIndexToken;
45
46
  };
47
+ type ActualTypeToTokenClassMap = {
48
+ [TokenType.color]: typeof ColorToken;
49
+ [TokenType.typography]: typeof TypographyToken;
50
+ [TokenType.blur]: typeof BlurToken;
51
+ [TokenType.border]: typeof BorderToken;
52
+ [TokenType.shadow]: typeof ShadowToken;
53
+ [TokenType.gradient]: typeof GradientToken;
54
+ [TokenType.string]: typeof StringToken;
55
+ [TokenType.productCopy]: typeof ProductCopyToken;
56
+ [TokenType.fontFamily]: typeof FontFamilyToken;
57
+ [TokenType.fontWeight]: typeof FontWeightToken;
58
+ [TokenType.textCase]: typeof TextCaseToken;
59
+ [TokenType.textDecoration]: typeof TextDecorationToken;
60
+ [TokenType.visibility]: typeof VisibilityToken;
61
+ [TokenType.borderWidth]: typeof BorderWidthToken;
62
+ [TokenType.dimension]: typeof DimensionToken;
63
+ [TokenType.size]: typeof SizeToken;
64
+ [TokenType.space]: typeof SpaceToken;
65
+ [TokenType.opacity]: typeof OpacityToken;
66
+ [TokenType.fontSize]: typeof FontSizeToken;
67
+ [TokenType.lineHeight]: typeof LineHeightToken;
68
+ [TokenType.letterSpacing]: typeof LetterSpacingToken;
69
+ [TokenType.paragraphSpacing]: typeof ParagraphSpacingToken;
70
+ [TokenType.radius]: typeof RadiusToken;
71
+ [TokenType.duration]: typeof DurationToken;
72
+ [TokenType.zIndex]: typeof ZIndexToken;
73
+ };
46
74
  export type TokenTypeMapToken = TokenMapCompletenessTypeCheck<ActualTypeToTokenMap>;
75
+ type TokenClassMapCompletenessTypeCheck<T extends {
76
+ [key in TokenType]: new (...args: any[]) => TokenTypeMapToken[key];
77
+ }> = T;
78
+ export type TokenClassTypeMapToken = TokenClassMapCompletenessTypeCheck<ActualTypeToTokenClassMap>;
47
79
  export declare class TokenUtils {
48
80
  /** Map tokens for lookup */
49
81
  static tokensToReferenceMap(tokens: Array<Token>): Map<string, Token>;
@@ -109,5 +141,18 @@ export declare class TokenUtils {
109
141
  static replaceIdAcrossAllPossibleReferences(override: DTProcessedTokenNode, newId: string, allTokens: Array<DTProcessedTokenNode>): void;
110
142
  static replaceIdAcrossAllPossibleReferencesWithTokens(currentId: string, newId: string, allTokens: Array<Token>): void;
111
143
  static replaceIdForComplexTokens(token: AnyToken, currentId: string, newId: string): void;
144
+ static inlineValueIntoComplexTokens(token: AnyToken, candidateId: string, candidateValueToInline: AnyTokenValue): void;
145
+ static getRefIdsFromComplexTokens(token: AnyToken): string[];
146
+ static buildKey(path: Array<string>, name: string): string;
147
+ static buildPath(token: Token, groups: Array<TokenGroup>): Array<string>;
148
+ static mapTypeToPrefix: (type: TokenType) => string;
149
+ static mapTypeToPrefixBack: (type: TokenType) => string;
150
+ static mapTypeToPrefix2: (type: TokenType) => string;
151
+ static buildFallbackKey(node: Pick<DTProcessedTokenNode, 'path' | 'token'>): string;
152
+ static buildFallbackKeyBack(node: Pick<DTProcessedTokenNode, 'path' | 'token'>): string;
153
+ static buildFallbackKey2(node: Pick<DTProcessedTokenNode, 'path' | 'token'>): string;
154
+ static getTokenByKeyOrFallbackKeys<T extends DTProcessedTokenNode | Token>(node: Pick<DTProcessedTokenNode, 'path' | 'token'>, map: Map<string, T>): T | undefined;
155
+ static getKeysByKeyOrFallbackKeys<T extends DTProcessedTokenNode | Token>(node: Pick<DTProcessedTokenNode, 'path' | 'token'>): string[];
156
+ static getTokenByKeyOrBackwardKey(node: Pick<DTProcessedTokenNode, 'path' | 'token'>, map: Map<string, DTProcessedTokenNode>): DTProcessedTokenNode | undefined;
112
157
  }
113
158
  export {};