@supernova-studio/supernova-sdk-beta 1.6.30 → 1.6.32
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.
- package/build/sdk-typescript/.eslintrc.d.cts +41 -0
- package/build/sdk-typescript/src/core/SDKSupernova.d.ts +7 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +1 -14
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +34 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaMultiplayer.d.ts +10 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaResources.d.ts +28 -0
- package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +4 -1
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +27 -16
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +13 -7
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +16 -7
- package/build/sdk-typescript/src/core/resolvers/SDKAssetGroupResolver.d.ts +4 -0
- package/build/sdk-typescript/src/core/resolvers/SDKTokenResolver.d.ts +1 -1
- package/build/sdk-typescript/src/exports-pulsar.d.ts +1 -1
- package/build/sdk-typescript/src/exports.d.ts +21 -2
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockBehavior.d.ts +2 -11
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockDefinition.d.ts +7 -23
- package/build/sdk-typescript/src/model/docs/blocks/definition/{SDKDocsBlockItem.d.ts → SDKDocsBlockItemDefinition.d.ts} +5 -12
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockLayout.d.ts +2 -7
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockVariant.d.ts +4 -14
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/assets/SDKDocsBlockActualAssets.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/code/SDKDocsBlockActualCode.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/code-react/SDKDocsBlockActualCodeReact.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/component-checklist/SDKDocsBlockActualComponentChecklist.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/component-checklist-all/SDKDocsBlockActualComponentChecklistAll.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/component-health/SDKDocsBlockActualComponentHealth.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/figma-frames/SDKDocsBlockActualFigmaFrames.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/link/SDKDocsBlockActualLink.d.ts +8 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/omni-multi-item/SDKDocsBlockActualOmniMultiItem.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/omni-single-item/SDKDocsBlockActualOmniSingleItem.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/release-notes/SDKDocsBlockActualReleaseNotes.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts +8 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts +5 -2
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockColorProperty.d.ts +13 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts +7 -2
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty.d.ts +19 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty.d.ts +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockNumberProperty.d.ts +2 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockProperty.d.ts +2 -10
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts +7 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +10 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTableProperty.d.ts +23 -2
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +2 -2
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +2 -2
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockUrlProperty.d.ts +14 -0
- package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsImageRef.d.ts +5 -2
- package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsLinkRef.d.ts +10 -7
- package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlock.d.ts +11 -30
- package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlockItem.d.ts +16 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityHeader.d.ts +3 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageAsset.d.ts +1 -1
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockRenderCode.d.ts +1 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockAssetPropertyPreviewContainerSize.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockBehaviorDataType.d.ts +3 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockImagePropertyAspectRatio.d.ts +4 -2
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockImagePropertyWidth.d.ts +2 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +7 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutAlign.d.ts +3 -3
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutColumnResizing.d.ts +2 -2
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutGap.d.ts +4 -4
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockMultiRichTextPropertyStyle.d.ts +8 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockRichTextPropertyStyle.d.ts +0 -4
- package/build/sdk-typescript/src/model/enums/SDKDocsPublishStatus.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKSourceType.d.ts +2 -1
- package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts +19 -19
- package/build/sdk-typescript/src/model/enums/SDKUserRole.d.ts +2 -2
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuild.d.ts +6 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuildResults.d.ts +12 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportDestinations.d.ts +16 -1
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteConnectionsModel.d.ts +1 -1
- package/build/sdk-typescript/src/model/groups/SDKAssetGroup.d.ts +4 -0
- package/build/sdk-typescript/src/model/resources/SDKResource.d.ts +26 -0
- package/build/sdk-typescript/src/model/resources/SDKResourceAsset.d.ts +6 -0
- package/build/sdk-typescript/src/model/resources/SDKResourceFont.d.ts +15 -0
- package/build/sdk-typescript/src/model/support/SDKFigmaFrame.d.ts +2 -0
- package/build/sdk-typescript/src/model/support/SDKSource.d.ts +20 -4
- package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +1 -1
- package/build/sdk-typescript/src/model/themes/SDKTokenTheme.d.ts +6 -6
- package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +6 -6
- package/build/sdk-typescript/src/model/tokens/SDKColorToken.d.ts +1 -0
- package/build/sdk-typescript/src/model/tokens/SDKDimensionToken.d.ts +1 -1
- package/build/sdk-typescript/src/model/tokens/SDKStringToken.d.ts +1 -1
- package/build/sdk-typescript/src/model/tokens/SDKTextCaseToken.d.ts +1 -1
- package/build/sdk-typescript/src/model/tokens/SDKTextDecorationToken.d.ts +1 -1
- package/build/sdk-typescript/src/model/tokens/SDKTokenValue.d.ts +2 -2
- package/build/sdk-typescript/src/model/users/SDKUserProfile.d.ts +10 -4
- package/build/sdk-typescript/src/tests/FigmaTokensDataLoader.d.ts +3 -3
- package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +2 -1
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONParser.d.ts +1 -1
- package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTGroupTree.d.ts +1 -1
- package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +40 -6
- package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementFigmaTokensTransformer.d.ts +1 -1
- package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementTransformer.d.ts +1 -1
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewGenerator.d.ts +4 -1
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewStyleGenerator.d.ts +4 -1
- package/build/sdk-typescript/src/utils/CommonUtils.d.ts +5 -0
- package/build/sdk-typescript/src/utils/TokenUtils.d.ts +3 -3
- package/build/sdk-typescript/src/utils/deepPartial.d.ts +3 -0
- package/build/supernova-sdk-typescript.js +1 -1
- package/build/supernova-sdk-typescript.js.LICENSE.txt +0 -14
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +118 -118
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
import { Alignment } from "../../enums/SDKAlignment";
|
|
2
2
|
import { AssetScaleType } from "../../enums/SDKAssetScaleType";
|
|
3
3
|
import { DocsColorRef } from "../blocks/support/SDKDocsColorRef";
|
|
4
|
+
import { DocsImageRef } from "../blocks/support/SDKDocsImageRef";
|
|
4
5
|
export type DocsEntityHeaderModel = {
|
|
5
6
|
description: string;
|
|
6
7
|
alignment: Alignment;
|
|
7
8
|
foregroundColor?: DocsColorRef;
|
|
8
9
|
backgroundColor?: DocsColorRef;
|
|
10
|
+
backgroundImageAsset?: DocsImageRef;
|
|
9
11
|
backgroundImageScaleType: AssetScaleType;
|
|
10
12
|
showBackgroundOverlay: boolean;
|
|
11
13
|
showCoverText: boolean;
|
|
@@ -16,6 +18,7 @@ export declare class DocsEntityHeader {
|
|
|
16
18
|
alignment: Alignment;
|
|
17
19
|
foregroundColor: DocsColorRef | null;
|
|
18
20
|
backgroundColor: DocsColorRef | null;
|
|
21
|
+
backgroundImage: DocsImageRef | null;
|
|
19
22
|
showBackgroundOverlay: boolean;
|
|
20
23
|
showCoverText: boolean;
|
|
21
24
|
minHeight: number | null;
|
|
@@ -10,7 +10,7 @@ export type DocumentationLegacyPageAssetModel = {
|
|
|
10
10
|
figmaFrame?: DocumentationLegacyPageBlockFrameModel;
|
|
11
11
|
};
|
|
12
12
|
export declare class DocumentationLegacyPageAsset {
|
|
13
|
-
id
|
|
13
|
+
id?: string;
|
|
14
14
|
persistentId: string | null;
|
|
15
15
|
sourceId: string | null;
|
|
16
16
|
sourceFrameId: string | null;
|
|
@@ -27,7 +27,7 @@ export declare class DocumentationLegacyPageBlockRenderCode extends Documentatio
|
|
|
27
27
|
sandboxType: DocumentationLegacyPageBlockRenderCodeEnvironmentType;
|
|
28
28
|
constructor(model: DocumentationLegacyPageBlockRenderCodeModel, children: Array<DocumentationLegacyPageBlock>, configuration: DocumentationLegacyConfiguration);
|
|
29
29
|
private encodeSandboxData;
|
|
30
|
-
btoaUnicode(str: any): string;
|
|
30
|
+
btoaUnicode(str: any): string | null;
|
|
31
31
|
atobUnicode(str: any): string;
|
|
32
32
|
}
|
|
33
33
|
export {};
|
|
@@ -6,5 +6,7 @@ export declare enum DocsBlockBehaviorDataType {
|
|
|
6
6
|
/** Asset type allows selection of asset entity and associated groups * */
|
|
7
7
|
asset = "Asset",
|
|
8
8
|
/** Component type allows selection of asset entity and associated groups * */
|
|
9
|
-
component = "Component"
|
|
9
|
+
component = "Component",
|
|
10
|
+
/** Figma frame type allows selection of any frame coming from Figma * */
|
|
11
|
+
figmaFrame = "FigmaFrame"
|
|
10
12
|
}
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
export declare enum DocsBlockImagePropertyAspectRatio {
|
|
2
|
+
/** Default. Automatic aspect ratio */
|
|
3
|
+
auto = "Auto",
|
|
2
4
|
/** 1:1 aspect ratio */
|
|
3
5
|
square = "Square",
|
|
4
|
-
/**
|
|
6
|
+
/** 3:2 aspect ratio */
|
|
5
7
|
landscape = "Landscape",
|
|
6
|
-
/** 3
|
|
8
|
+
/** 2:3 aspect ratio */
|
|
7
9
|
portrait = "Portrait",
|
|
8
10
|
/** 16:9 aspect ratio */
|
|
9
11
|
wide = "Wide"
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
export declare enum DocsBlockItemPropertyType {
|
|
2
2
|
/** Rich text property allows user to input rich text (with additional attributes like bold, links etc.) */
|
|
3
3
|
richText = "RichText",
|
|
4
|
+
/** Rich text property allows user to input multiple paragraphs of rich text (with additional attributes like bold, links etc.) */
|
|
5
|
+
multiRichText = "MultiRichText",
|
|
4
6
|
/** Text property allows user to input plain text */
|
|
5
7
|
text = "Text",
|
|
6
8
|
/** Boolean property allows user to input true/false value */
|
|
@@ -31,6 +33,8 @@ export declare enum DocsBlockItemPropertyType {
|
|
|
31
33
|
/** Page property allows selection of custom page properties (columns) */
|
|
32
34
|
/** Embed property allows user to input page to be embedded via URL */
|
|
33
35
|
embedURL = "EmbedURL",
|
|
36
|
+
/** URL property allows user to input a valid URL */
|
|
37
|
+
url = "URL",
|
|
34
38
|
/** Embed property allows user to input page to be embedded via iframe */
|
|
35
39
|
/** Markdown property allows user to add markdown to render */
|
|
36
40
|
markdown = "Markdown",
|
|
@@ -43,5 +47,7 @@ export declare enum DocsBlockItemPropertyType {
|
|
|
43
47
|
/** Divider property that puts visual divider into the block. It has no user input */
|
|
44
48
|
divider = "Divider",
|
|
45
49
|
/** Storybook property allows user to add Storybook story to render */
|
|
46
|
-
storybook = "Storybook"
|
|
50
|
+
storybook = "Storybook",
|
|
51
|
+
/** Color property allows users to select color for further use */
|
|
52
|
+
color = "Color"
|
|
47
53
|
}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
export declare enum DocsBlockItemVariantLayoutGap {
|
|
2
2
|
/** small gap between columns/row */
|
|
3
|
-
small = "
|
|
3
|
+
small = "Small",
|
|
4
4
|
/** medium gap between columns/row */
|
|
5
|
-
medium = "
|
|
5
|
+
medium = "Medium",
|
|
6
6
|
/** large gap between columns/row */
|
|
7
|
-
large = "
|
|
7
|
+
large = "Large",
|
|
8
8
|
/** no gap between columns/row */
|
|
9
|
-
none = "
|
|
9
|
+
none = "None"
|
|
10
10
|
}
|
|
@@ -1,29 +1,29 @@
|
|
|
1
1
|
export declare enum TokenType {
|
|
2
2
|
color = "Color",
|
|
3
3
|
typography = "Typography",
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
4
|
+
shadow = "Shadow",
|
|
5
|
+
border = "Border",
|
|
6
|
+
gradient = "Gradient",
|
|
7
|
+
blur = "Blur",
|
|
8
|
+
radius = "BorderRadius",
|
|
9
|
+
borderWidth = "BorderWidth",
|
|
10
|
+
duration = "Duration",
|
|
8
11
|
fontSize = "FontSize",
|
|
9
|
-
|
|
12
|
+
dimension = "Dimension",
|
|
10
13
|
letterSpacing = "LetterSpacing",
|
|
14
|
+
lineHeight = "LineHeight",
|
|
15
|
+
opacity = "Opacity",
|
|
11
16
|
paragraphSpacing = "ParagraphSpacing",
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
duration = "Duration",
|
|
17
|
+
size = "Size",
|
|
18
|
+
space = "Space",
|
|
15
19
|
zIndex = "ZIndex",
|
|
16
|
-
shadow = "Shadow",
|
|
17
|
-
border = "Border",
|
|
18
|
-
gradient = "Gradient",
|
|
19
|
-
string = "String",
|
|
20
|
-
productCopy = "ProductCopy",
|
|
21
|
-
fontFamily = "FontFamily",
|
|
22
|
-
fontWeight = "FontWeight",
|
|
23
|
-
textCase = "TextCase",
|
|
24
20
|
textDecoration = "TextDecoration",
|
|
21
|
+
textCase = "TextCase",
|
|
25
22
|
visibility = "Visibility",
|
|
26
|
-
|
|
23
|
+
fontFamily = "FontFamily",
|
|
24
|
+
fontWeight = "FontWeight",
|
|
25
|
+
string = "String",
|
|
26
|
+
productCopy = "ProductCopy"
|
|
27
27
|
}
|
|
28
28
|
export declare const STRING_TOKEN_TYPES: readonly [TokenType.string, TokenType.productCopy, TokenType.fontFamily, TokenType.fontWeight];
|
|
29
29
|
export type StringTokenType = (typeof STRING_TOKEN_TYPES)[number];
|
|
@@ -37,13 +37,13 @@ export declare const ALL_TOKEN_TYPES: readonly [TokenType.dimension, TokenType.s
|
|
|
37
37
|
export declare const PURE_TOKEN_TYPES: readonly [TokenType.dimension, TokenType.size, TokenType.space, TokenType.opacity, TokenType.fontSize, TokenType.lineHeight, TokenType.letterSpacing, TokenType.paragraphSpacing, TokenType.borderWidth, TokenType.radius, TokenType.duration, TokenType.zIndex, TokenType.string, TokenType.productCopy, TokenType.fontFamily, TokenType.fontWeight, TokenType.textCase, TokenType.textDecoration, TokenType.visibility];
|
|
38
38
|
export type PureTokenType = (typeof PURE_TOKEN_TYPES)[number];
|
|
39
39
|
export type NonPureTokenType = Exclude<TokenType, PureTokenType>;
|
|
40
|
-
export declare const tokenTypeIsPure: (tokenType: TokenType) => tokenType is TokenType.
|
|
40
|
+
export declare const tokenTypeIsPure: (tokenType: TokenType) => tokenType is TokenType.radius | TokenType.borderWidth | TokenType.duration | TokenType.fontSize | TokenType.dimension | TokenType.letterSpacing | TokenType.lineHeight | TokenType.opacity | TokenType.paragraphSpacing | TokenType.size | TokenType.space | TokenType.zIndex | TokenType.textDecoration | TokenType.textCase | TokenType.visibility | TokenType.fontFamily | TokenType.fontWeight | TokenType.string | TokenType.productCopy;
|
|
41
41
|
export declare const tokenTypeIsNonPure: (tokenType: TokenType) => tokenType is NonPureTokenType;
|
|
42
42
|
export declare const REPLACABLE_TOKEN_TYPES: readonly [TokenType.color, TokenType.dimension, TokenType.size, TokenType.space, TokenType.opacity, TokenType.fontSize, TokenType.lineHeight, TokenType.letterSpacing, TokenType.paragraphSpacing, TokenType.borderWidth, TokenType.radius, TokenType.duration, TokenType.zIndex, TokenType.string, TokenType.productCopy, TokenType.fontFamily, TokenType.fontWeight, TokenType.textCase, TokenType.textDecoration, TokenType.visibility];
|
|
43
43
|
export type ReplacableTokenType = (typeof REPLACABLE_TOKEN_TYPES)[number];
|
|
44
44
|
export declare const REFERENCABLE_TOKEN_TYPES: readonly [TokenType.color, TokenType.dimension, TokenType.size, TokenType.space, TokenType.opacity, TokenType.fontSize, TokenType.lineHeight, TokenType.letterSpacing, TokenType.paragraphSpacing, TokenType.borderWidth, TokenType.radius, TokenType.duration, TokenType.zIndex, TokenType.fontFamily, TokenType.fontWeight, TokenType.textCase, TokenType.textDecoration];
|
|
45
45
|
export type ReferencableTokenType = (typeof REFERENCABLE_TOKEN_TYPES)[number];
|
|
46
|
-
export declare const tokenTypeIsReferencable: (tokenType: TokenType) => tokenType is TokenType.color | TokenType.
|
|
46
|
+
export declare const tokenTypeIsReferencable: (tokenType: TokenType) => tokenType is TokenType.color | TokenType.radius | TokenType.borderWidth | TokenType.duration | TokenType.fontSize | TokenType.dimension | TokenType.letterSpacing | TokenType.lineHeight | TokenType.opacity | TokenType.paragraphSpacing | TokenType.size | TokenType.space | TokenType.zIndex | TokenType.textDecoration | TokenType.textCase | TokenType.fontFamily | TokenType.fontWeight;
|
|
47
47
|
export declare const DT_TOKEN_TYPES: readonly [TokenType.color, TokenType.shadow, TokenType.gradient, TokenType.typography, TokenType.border, TokenType.dimension, TokenType.size, TokenType.space, TokenType.opacity, TokenType.fontSize, TokenType.lineHeight, TokenType.letterSpacing, TokenType.paragraphSpacing, TokenType.borderWidth, TokenType.radius, TokenType.duration, TokenType.zIndex, TokenType.fontFamily, TokenType.fontWeight, TokenType.textCase, TokenType.textDecoration, TokenType.visibility];
|
|
48
48
|
export type DTTokenType = (typeof DT_TOKEN_TYPES)[number];
|
|
49
49
|
export type DTOriginalTokenType = "color" | "borderRadius" | "boxShadow" | "gradient" | "typography" | "border" | "borderWidth" | "sizing" | "opacity" | "spacing" | "fontSizes" | "paragraphSpacing" | "letterSpacing" | "lineHeights" | "other" | "dimension" | "fontFamilies" | "fontWeights" | "textCase" | "textDecoration";
|
|
@@ -47,6 +47,8 @@ export type ExportBuildModel = {
|
|
|
47
47
|
destinations: ExportDestinations;
|
|
48
48
|
scheduleId: string | null;
|
|
49
49
|
exporterId: string;
|
|
50
|
+
brandId: string | null;
|
|
51
|
+
themeId: string | null;
|
|
50
52
|
};
|
|
51
53
|
/** Build run entry */
|
|
52
54
|
export declare class ExportBuild {
|
|
@@ -90,6 +92,10 @@ export declare class ExportBuild {
|
|
|
90
92
|
scheduleId: string | null;
|
|
91
93
|
/** The identifier of the exporter associated with the export build */
|
|
92
94
|
exporterId: string;
|
|
95
|
+
/** The identifier of the brand used for this build */
|
|
96
|
+
brandId: string | null;
|
|
97
|
+
/** The identifier of the theme used for this build */
|
|
98
|
+
themeId: string | null;
|
|
93
99
|
constructor(data: ExportBuildModel);
|
|
94
100
|
/**
|
|
95
101
|
* Gets the URL for downloading the code generated by the export build.
|
|
@@ -19,6 +19,15 @@ export declare class ExportBuildPullRequestResult {
|
|
|
19
19
|
pullRequestUrl: string;
|
|
20
20
|
constructor(data: ExportBuildPullRequestResultModel);
|
|
21
21
|
}
|
|
22
|
+
export type ExportBuildDocumentationResultModel = {
|
|
23
|
+
url: string;
|
|
24
|
+
};
|
|
25
|
+
/** The type definition for documentation build's result. */
|
|
26
|
+
export declare class ExportBuildDocumentationResult {
|
|
27
|
+
/** The URL of documentation's website associated with the export build result. */
|
|
28
|
+
url: string;
|
|
29
|
+
constructor(data: ExportBuildDocumentationResultModel);
|
|
30
|
+
}
|
|
22
31
|
/**
|
|
23
32
|
* The enum representing possible types of export build result logs.
|
|
24
33
|
* @enum {string}
|
|
@@ -51,6 +60,7 @@ export type ExportBuildResultModel = {
|
|
|
51
60
|
bitbucket: ExportBuildPullRequestResult | null;
|
|
52
61
|
github: ExportBuildPullRequestResult | null;
|
|
53
62
|
gitlab: ExportBuildPullRequestResult | null;
|
|
63
|
+
documentation: ExportBuildDocumentationResult | null;
|
|
54
64
|
error: string | null;
|
|
55
65
|
};
|
|
56
66
|
export declare class ExportBuildResult {
|
|
@@ -66,6 +76,8 @@ export declare class ExportBuildResult {
|
|
|
66
76
|
github: ExportBuildPullRequestResult | null;
|
|
67
77
|
/** The GitLab export build pull request result, or null if not available */
|
|
68
78
|
gitlab: ExportBuildPullRequestResult | null;
|
|
79
|
+
/** The documentation build result, or null if not available */
|
|
80
|
+
documentation: ExportBuildDocumentationResult | null;
|
|
69
81
|
/** The error message, or null if not available */
|
|
70
82
|
error: string | null;
|
|
71
83
|
constructor(data: ExportBuildResultModel);
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { DocumentationEnvironment } from "../../enums/SDKDocumentationEnvironment";
|
|
1
2
|
export type S3ExportDestinationModel = {
|
|
2
3
|
url: string | null;
|
|
3
4
|
};
|
|
@@ -76,12 +77,25 @@ export declare class GitlabExportDestination {
|
|
|
76
77
|
url: string | null;
|
|
77
78
|
constructor(data: GitlabExportDestinationModel);
|
|
78
79
|
}
|
|
80
|
+
export type DocsExportDestinationModel = {
|
|
81
|
+
environment: DocumentationEnvironment;
|
|
82
|
+
};
|
|
83
|
+
/**
|
|
84
|
+
* Type definition for the data model of a documentation export destination.
|
|
85
|
+
* @typedef {Object} DocsExportDestinationModel
|
|
86
|
+
* @property {DocumentationEnvironment|null} environment - The environment of the docs export build.
|
|
87
|
+
*/
|
|
88
|
+
export declare class DocsExportDestination {
|
|
89
|
+
environment: DocumentationEnvironment;
|
|
90
|
+
constructor(data: DocsExportDestinationModel);
|
|
91
|
+
}
|
|
79
92
|
export type ExportDestinationsModel = {
|
|
80
93
|
s3: S3ExportDestination | null;
|
|
81
94
|
azure: AzureExportDestination | null;
|
|
82
95
|
bitbucket: BitbucketExportDestination | null;
|
|
83
96
|
github: GithubExportDestination | null;
|
|
84
97
|
gitlab: GitlabExportDestination | null;
|
|
98
|
+
documentation: DocsExportDestination | null;
|
|
85
99
|
webhookUrl: string | null;
|
|
86
100
|
};
|
|
87
101
|
/**
|
|
@@ -92,7 +106,7 @@ export type ExportDestinationsModel = {
|
|
|
92
106
|
* @property {BitbucketExportDestination|null} bitbucket - The Bitbucket export destination, or null if not available.
|
|
93
107
|
* @property {GithubExportDestination|null} github - The Github export destination, or null if not available.
|
|
94
108
|
* @property {GitlabExportDestination|null} gitlab - The Gitlab export destination, or null if not available.
|
|
95
|
-
*
|
|
109
|
+
* @property {DocsExportDestination|null} documentation - The documentation associated with the export destinations, or null if not available.
|
|
96
110
|
* @property {string|null} webhookUrl - The webhook URL associated with the export destinations, or null if not available.
|
|
97
111
|
*/
|
|
98
112
|
export declare class ExportDestinations {
|
|
@@ -101,6 +115,7 @@ export declare class ExportDestinations {
|
|
|
101
115
|
bitbucket: BitbucketExportDestination | null;
|
|
102
116
|
github: GithubExportDestination | null;
|
|
103
117
|
gitlab: GitlabExportDestination | null;
|
|
118
|
+
documentation: DocsExportDestination | null;
|
|
104
119
|
webhookUrl: string | null;
|
|
105
120
|
constructor(data: ExportDestinationsModel);
|
|
106
121
|
/**
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { DesignComponentGroupRemoteModel } from "./SDKDesignComponentGroup";
|
|
2
2
|
export declare class AssetGroup {
|
|
3
3
|
id: string;
|
|
4
|
+
persistentId: string;
|
|
4
5
|
brandId: string;
|
|
5
6
|
name: string;
|
|
6
7
|
description: string;
|
|
@@ -12,6 +13,9 @@ export declare class AssetGroup {
|
|
|
12
13
|
parentGroupId: string | null;
|
|
13
14
|
createdAt: Date | null;
|
|
14
15
|
updatedAt: Date | null;
|
|
16
|
+
isAssetGroup: boolean;
|
|
17
|
+
sourceId: string | null;
|
|
18
|
+
sourceName: string | null;
|
|
15
19
|
constructor(model: DesignComponentGroupRemoteModel);
|
|
16
20
|
addChild(groupId: string): void;
|
|
17
21
|
addChildren(groupsIds: Array<string>): void;
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
export declare enum ResourceType {
|
|
2
|
+
asset = "Asset",
|
|
3
|
+
font = "Font"
|
|
4
|
+
}
|
|
5
|
+
export type ResourceModel = {
|
|
6
|
+
id: string;
|
|
7
|
+
persistentId: string;
|
|
8
|
+
url: string;
|
|
9
|
+
originalName?: string;
|
|
10
|
+
scope: "DesignSystem" | "Documentation";
|
|
11
|
+
};
|
|
12
|
+
export declare class Resource {
|
|
13
|
+
/** Unique identifier of the resource */
|
|
14
|
+
id: string;
|
|
15
|
+
/** Unique identifier of the resource in the version */
|
|
16
|
+
idInVersion: string;
|
|
17
|
+
/** URL of the resource */
|
|
18
|
+
url: string;
|
|
19
|
+
/** Original filename of the resource */
|
|
20
|
+
originalName: string | null;
|
|
21
|
+
/** Scope of the resource */
|
|
22
|
+
scope: "DesignSystem" | "Documentation";
|
|
23
|
+
/** Type of the resource */
|
|
24
|
+
type: ResourceType;
|
|
25
|
+
constructor(model: ResourceModel);
|
|
26
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { Resource, ResourceModel, ResourceType } from "./SDKResource";
|
|
2
|
+
export type ResourceFontModel = ResourceModel & {
|
|
3
|
+
fontProperties?: Array<{
|
|
4
|
+
family?: string;
|
|
5
|
+
subfamily?: string;
|
|
6
|
+
}>;
|
|
7
|
+
};
|
|
8
|
+
export declare class ResourceFont extends Resource {
|
|
9
|
+
type: ResourceType;
|
|
10
|
+
fontProperties: {
|
|
11
|
+
family: string | null;
|
|
12
|
+
subfamily: string | null;
|
|
13
|
+
} | null;
|
|
14
|
+
constructor(model: ResourceFontModel);
|
|
15
|
+
}
|
|
@@ -1,10 +1,15 @@
|
|
|
1
1
|
import { ImportWarningType } from "../enums/SDKCloudWarningType";
|
|
2
2
|
import { SourceType } from "../enums/SDKSourceType";
|
|
3
|
+
declare enum SourceRemoteType {
|
|
4
|
+
figma = "Figma",
|
|
5
|
+
tokenStudio = "TokenStudio",
|
|
6
|
+
figmaVariablesPlugin = "FigmaVariablesPlugin",
|
|
7
|
+
upload = "Upload"
|
|
8
|
+
}
|
|
3
9
|
export type SourceRemoteModel = {
|
|
4
|
-
type:
|
|
10
|
+
type: SourceRemoteType;
|
|
5
11
|
id: string;
|
|
6
12
|
fileName?: string;
|
|
7
|
-
linkType: "Design" | "Frames";
|
|
8
13
|
brandId?: string;
|
|
9
14
|
plugin?: {
|
|
10
15
|
fileId: string;
|
|
@@ -12,6 +17,7 @@ export type SourceRemoteModel = {
|
|
|
12
17
|
};
|
|
13
18
|
cloud?: SourceRemoteModelCloud;
|
|
14
19
|
tokenStudio?: SourceRemoteModelTokensStudio;
|
|
20
|
+
figmaVariablesPlugin?: SourceRemoteModelFigmaVariablesPlugin;
|
|
15
21
|
scope: SourceScope;
|
|
16
22
|
};
|
|
17
23
|
export type SourceScope = {
|
|
@@ -96,6 +102,11 @@ export type SourceRemoteModelTokensStudio = {
|
|
|
96
102
|
themeId?: string;
|
|
97
103
|
}>;
|
|
98
104
|
};
|
|
105
|
+
export type SourceRemoteModelFigmaVariablesPlugin = {
|
|
106
|
+
fileId: string;
|
|
107
|
+
lastImportedAt?: string;
|
|
108
|
+
lastImportMetadata?: Record<string, any>;
|
|
109
|
+
};
|
|
99
110
|
export type SourceModelTokenStudio = Omit<SourceRemoteModelTokensStudio, "lastUpdatesCheckedAt" | "lastImportedAt"> & {
|
|
100
111
|
lastUpdatesCheckedAt?: Date;
|
|
101
112
|
lastImportedAt?: Date;
|
|
@@ -104,18 +115,22 @@ export type SourceModelCloud = Omit<SourceRemoteModelCloud, "lastUpdatesCheckedA
|
|
|
104
115
|
lastUpdatesCheckedAt?: Date;
|
|
105
116
|
lastImportedAt?: Date;
|
|
106
117
|
};
|
|
107
|
-
export type
|
|
118
|
+
export type SourceModelFigmaVariablesPlugin = Omit<SourceRemoteModelFigmaVariablesPlugin, "lastImportedAt"> & {
|
|
119
|
+
lastImportedAt?: Date;
|
|
120
|
+
};
|
|
121
|
+
export type SourceTransportModel = Pick<Source, "type" | "id" | "fileName" | "brandId" | "scope"> & {
|
|
108
122
|
cloud?: SourceRemoteModelCloud | null;
|
|
109
123
|
};
|
|
110
124
|
export declare class Source {
|
|
111
125
|
type: SourceType;
|
|
112
126
|
id: string;
|
|
113
127
|
fileName: string | null;
|
|
114
|
-
linkType: "Design" | "Frames";
|
|
115
128
|
brandId: string | null;
|
|
116
129
|
cloud: SourceModelCloud | null;
|
|
117
130
|
tokenStudio?: SourceModelTokenStudio | null;
|
|
131
|
+
figmaVariablesPlugin?: SourceModelFigmaVariablesPlugin | null;
|
|
118
132
|
scope: SourceScope;
|
|
133
|
+
get lastImportedAt(): Date | null;
|
|
119
134
|
get hasError(): boolean;
|
|
120
135
|
get hasWarning(): boolean;
|
|
121
136
|
get isCloudAvailable(): boolean;
|
|
@@ -129,3 +144,4 @@ export declare class Source {
|
|
|
129
144
|
/** Reconstructs class from the transport model */
|
|
130
145
|
static fromTransport(model: SourceTransportModel): SourceRemoteModel;
|
|
131
146
|
}
|
|
147
|
+
export {};
|
|
@@ -34,22 +34,22 @@ export declare class TokenTheme {
|
|
|
34
34
|
private tokensToOverrides;
|
|
35
35
|
toWriteOverrideObject(token: Token): TokenThemeOverrideRemoteModel;
|
|
36
36
|
valueToWriteObject(value: AnyTokenValue, type: TokenType, token: AnyToken): import("../tokens/remote/SDKRemoteTokenData").ShadowTokenRemoteData | import("../tokens/remote/SDKRemoteTokenData").GradientTokenRemoteData | {
|
|
37
|
-
aliasTo: string;
|
|
37
|
+
aliasTo: string | undefined;
|
|
38
38
|
value: import("../tokens/remote/SDKRemoteTokenValue").BlurTokenRemoteValue;
|
|
39
39
|
} | {
|
|
40
|
-
aliasTo: string;
|
|
40
|
+
aliasTo: string | undefined;
|
|
41
41
|
value: import("../tokens/remote/SDKRemoteTokenValue").BorderTokenRemoteValue;
|
|
42
42
|
} | {
|
|
43
|
-
aliasTo: string;
|
|
43
|
+
aliasTo: string | undefined;
|
|
44
44
|
value: import("../tokens/remote/SDKRemoteTokenValue").ColorTokenRemoteValue;
|
|
45
45
|
} | {
|
|
46
|
-
aliasTo: string;
|
|
46
|
+
aliasTo: string | undefined;
|
|
47
47
|
value: import("../tokens/remote/SDKRemoteTokenValue").AnyDimensionTokenRemoteValue;
|
|
48
48
|
} | {
|
|
49
|
-
aliasTo: string;
|
|
49
|
+
aliasTo: string | undefined;
|
|
50
50
|
value: string;
|
|
51
51
|
} | {
|
|
52
|
-
aliasTo: string;
|
|
52
|
+
aliasTo: string | undefined;
|
|
53
53
|
value: import("../tokens/remote/SDKRemoteTokenValue").TypographyTokenRemoteValue;
|
|
54
54
|
};
|
|
55
55
|
}
|
|
@@ -20,22 +20,22 @@ export declare class TokenThemeOverride {
|
|
|
20
20
|
constructor(model: TokenThemeOverrideRemoteModel, value: AnyTokenValue);
|
|
21
21
|
toWriteObject(): TokenThemeOverrideRemoteModel;
|
|
22
22
|
valueToWriteObject(value: AnyTokenValue, type: TokenType): ShadowTokenRemoteData | GradientTokenRemoteData | {
|
|
23
|
-
aliasTo: string;
|
|
23
|
+
aliasTo: string | undefined;
|
|
24
24
|
value: import("../tokens/remote/SDKRemoteTokenValue").BlurTokenRemoteValue;
|
|
25
25
|
} | {
|
|
26
|
-
aliasTo: string;
|
|
26
|
+
aliasTo: string | undefined;
|
|
27
27
|
value: import("../tokens/remote/SDKRemoteTokenValue").BorderTokenRemoteValue;
|
|
28
28
|
} | {
|
|
29
|
-
aliasTo: string;
|
|
29
|
+
aliasTo: string | undefined;
|
|
30
30
|
value: import("../tokens/remote/SDKRemoteTokenValue").ColorTokenRemoteValue;
|
|
31
31
|
} | {
|
|
32
|
-
aliasTo: string;
|
|
32
|
+
aliasTo: string | undefined;
|
|
33
33
|
value: import("../tokens/remote/SDKRemoteTokenValue").AnyDimensionTokenRemoteValue;
|
|
34
34
|
} | {
|
|
35
|
-
aliasTo: string;
|
|
35
|
+
aliasTo: string | undefined;
|
|
36
36
|
value: string;
|
|
37
37
|
} | {
|
|
38
|
-
aliasTo: string;
|
|
38
|
+
aliasTo: string | undefined;
|
|
39
39
|
value: import("../tokens/remote/SDKRemoteTokenValue").TypographyTokenRemoteValue;
|
|
40
40
|
};
|
|
41
41
|
}
|
|
@@ -18,6 +18,7 @@ export declare class ColorToken extends Token {
|
|
|
18
18
|
static colorValueFromDefinitionOrReference(definition: string | object, referenceResolver: DTTokenReferenceResolver): ColorTokenValue | undefined;
|
|
19
19
|
toHex6(): string;
|
|
20
20
|
toHex8(): string;
|
|
21
|
+
static hexToColorValue(hex: string): ColorTokenValue;
|
|
21
22
|
static colorValueToHex6(value: ColorTokenValue): string;
|
|
22
23
|
static colorValueToHex8(value: ColorTokenValue): string;
|
|
23
24
|
/** Normalizes any color value to server readable value, and ignores alpha value optionally */
|
|
@@ -75,7 +75,7 @@ export declare class ZIndexToken extends DimensionCategoryToken<ZIndexTokenValue
|
|
|
75
75
|
tokenType: TokenType.zIndex;
|
|
76
76
|
}
|
|
77
77
|
export type AnyDimensionToken = DimensionToken | SizeToken | SpaceToken | OpacityToken | FontSizeToken | LineHeightToken | LetterSpacingToken | ParagraphSpacingToken | BorderWidthToken | RadiusToken | DurationToken | ZIndexToken;
|
|
78
|
-
export declare const resolveDimension: <TK extends TokenType.
|
|
78
|
+
export declare const resolveDimension: <TK extends TokenType.radius | TokenType.borderWidth | TokenType.duration | TokenType.fontSize | TokenType.dimension | TokenType.letterSpacing | TokenType.lineHeight | TokenType.opacity | TokenType.paragraphSpacing | TokenType.size | TokenType.space | TokenType.zIndex>(type: TK) => {
|
|
79
79
|
Color: typeof import("./SDKColorToken").ColorToken;
|
|
80
80
|
Typography: typeof import("./SDKTypographyToken").TypographyToken;
|
|
81
81
|
Blur: typeof import("./SDKBlurToken").BlurToken;
|
|
@@ -32,7 +32,7 @@ export declare class FontWeightToken extends StringCategoryToken<FontWeightToken
|
|
|
32
32
|
tokenType: TokenType.fontWeight;
|
|
33
33
|
}
|
|
34
34
|
export type AnyStringToken = StringToken | ProductCopyToken | FontFamilyToken | FontWeightToken;
|
|
35
|
-
export declare const resolveString: <TK extends TokenType.
|
|
35
|
+
export declare const resolveString: <TK extends TokenType.fontFamily | TokenType.fontWeight | TokenType.string | TokenType.productCopy>(type: TK) => {
|
|
36
36
|
Color: typeof import("./SDKColorToken").ColorToken;
|
|
37
37
|
Typography: typeof import("./SDKTypographyToken").TypographyToken;
|
|
38
38
|
Blur: typeof import("./SDKBlurToken").BlurToken;
|
|
@@ -13,7 +13,7 @@ export declare class TextCaseToken extends Token {
|
|
|
13
13
|
static create(versionId: string, brandId: string, name: string, description: string, value: string, alias: TextCaseToken | null, properties: Array<ElementProperty>, propertyValues: Array<ElementPropertyValue>): TextCaseToken;
|
|
14
14
|
static textCaseFromDefinition(textCase: string): {
|
|
15
15
|
value: TextCase;
|
|
16
|
-
referencedTokenId:
|
|
16
|
+
referencedTokenId: null;
|
|
17
17
|
};
|
|
18
18
|
toWriteObject(): TextCaseTokenRemoteModel;
|
|
19
19
|
static valueToWriteObject(value: TextCaseTokenValue): {
|