@supernova-studio/supernova-sdk-beta 1.6.10
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/LICENSE +21 -0
- package/README.md +144 -0
- package/build/sdk-typescript/src/browser-bundle.d.ts +1 -0
- package/build/sdk-typescript/src/core/SDKBrand.d.ts +80 -0
- package/build/sdk-typescript/src/core/SDKBrandWriter.d.ts +29 -0
- package/build/sdk-typescript/src/core/SDKDesignSystem.d.ts +62 -0
- package/build/sdk-typescript/src/core/SDKDesignSystemVersion.d.ts +99 -0
- package/build/sdk-typescript/src/core/SDKDocumentation.d.ts +55 -0
- package/build/sdk-typescript/src/core/SDKSupernova.d.ts +46 -0
- package/build/sdk-typescript/src/core/SDKWorkspace.d.ts +26 -0
- package/build/sdk-typescript/src/core/data/SDKConfiguration.d.ts +6 -0
- package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +50 -0
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +141 -0
- package/build/sdk-typescript/src/core/errors/SDKSupernovaError.d.ts +24 -0
- package/build/sdk-typescript/src/core/resolvers/SDKAssetGroupResolver.d.ts +14 -0
- package/build/sdk-typescript/src/core/resolvers/SDKComponentResolver.d.ts +8 -0
- package/build/sdk-typescript/src/core/resolvers/SDKDesignComponentGroupResolver.d.ts +13 -0
- package/build/sdk-typescript/src/core/resolvers/SDKDocumentationItemResolver.d.ts +32 -0
- package/build/sdk-typescript/src/core/resolvers/SDKTokenGroupResolver.d.ts +11 -0
- package/build/sdk-typescript/src/core/resolvers/SDKTokenResolver.d.ts +76 -0
- package/build/sdk-typescript/src/exports.d.ts +117 -0
- package/build/sdk-typescript/src/index.d.ts +1 -0
- package/build/sdk-typescript/src/model/assets/SDKAsset.d.ts +16 -0
- package/build/sdk-typescript/src/model/assets/SDKRenderedAsset.d.ts +28 -0
- package/build/sdk-typescript/src/model/components/SDKComponent.d.ts +27 -0
- package/build/sdk-typescript/src/model/components/SDKDesignComponent.d.ts +32 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationConfiguration.d.ts +13 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationGroup.d.ts +38 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationItem.d.ts +26 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationPage.d.ts +31 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationPageAsset.d.ts +15 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationPageBlock.d.ts +32 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationRichText.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationRichTextSpan.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationRichTextSpanAttribute.d.ts +14 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockAsset.d.ts +15 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockAssets.d.ts +24 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockCallout.d.ts +11 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockCode.d.ts +12 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockColumn.d.ts +8 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockColumnItem.d.ts +11 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockCustom.d.ts +16 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockDivider.d.ts +8 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedFigma.d.ts +8 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedGeneric.d.ts +15 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedLink.d.ts +16 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedStorybook.d.ts +8 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedYoutube.d.ts +8 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockFrame.d.ts +18 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockFrames.d.ts +26 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockHeading.d.ts +11 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockImage.d.ts +18 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockOrderedList.d.ts +8 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockQuote.d.ts +8 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockRenderCode.d.ts +34 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockShortcut.d.ts +35 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockShortcuts.d.ts +11 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTab.d.ts +8 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTabItem.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTable.d.ts +23 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTableCell.d.ts +13 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTableColumn.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTableRow.d.ts +8 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockText.d.ts +13 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockToken.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTokenGroup.d.ts +12 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTokenList.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockUnorderedList.d.ts +8 -0
- package/build/sdk-typescript/src/model/documentation/builder/SDKDocumentationBlockBuilder.d.ts +6 -0
- package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationItemConfiguration.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationItemHeader.d.ts +30 -0
- package/build/sdk-typescript/src/model/elements/SDKElementDataView.d.ts +30 -0
- package/build/sdk-typescript/src/model/elements/SDKElementDataViewColumn.d.ts +37 -0
- package/build/sdk-typescript/src/model/elements/SDKElementProperty.d.ts +56 -0
- package/build/sdk-typescript/src/model/elements/SDKElementPropertyOption.d.ts +13 -0
- package/build/sdk-typescript/src/model/elements/values/SDKElementPropertyValue.d.ts +15 -0
- package/build/sdk-typescript/src/model/enums/SDKAlignment.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKAssetFormat.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKAssetScale.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKAssetScaleType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKBlurType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKBorderPosition.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationCalloutType.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationGroupBehavior.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationHeadingType.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationItemType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationPageAssetType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationPageBlockThemeType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationPageBlockType.d.ts +31 -0
- package/build/sdk-typescript/src/model/enums/SDKFrameAlignment.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKFrameLayout.d.ts +11 -0
- package/build/sdk-typescript/src/model/enums/SDKGradientType.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKRichTextSpanAttributeType.d.ts +7 -0
- package/build/sdk-typescript/src/model/enums/SDKShadowType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKSourceType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKTextCase.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKTextDecoration.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts +13 -0
- package/build/sdk-typescript/src/model/enums/SDKUnit.d.ts +6 -0
- package/build/sdk-typescript/src/model/exporters/SDKExporter.d.ts +74 -0
- package/build/sdk-typescript/src/model/exporters/custom_blocks/SDKExporterCustomBlock.d.ts +23 -0
- package/build/sdk-typescript/src/model/exporters/custom_blocks/SDKExporterCustomBlockProperty.d.ts +32 -0
- package/build/sdk-typescript/src/model/exporters/custom_blocks/SDKExporterCustomBlockVariant.d.ts +12 -0
- package/build/sdk-typescript/src/model/exporters/custom_properties/SDKExporterConfigurationProperty.d.ts +38 -0
- package/build/sdk-typescript/src/model/groups/SDKAssetGroup.d.ts +20 -0
- package/build/sdk-typescript/src/model/groups/SDKDesignComponentGroup.d.ts +33 -0
- package/build/sdk-typescript/src/model/groups/SDKTokenGroup.d.ts +42 -0
- package/build/sdk-typescript/src/model/support/SDKDesignComponentOrigin.d.ts +23 -0
- package/build/sdk-typescript/src/model/support/SDKFrameOrigin.d.ts +25 -0
- package/build/sdk-typescript/src/model/support/SDKSize.d.ts +9 -0
- package/build/sdk-typescript/src/model/support/SDKSource.d.ts +102 -0
- package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +11 -0
- package/build/sdk-typescript/src/model/support/SDKWorkspaceNPMRegistry.d.ts +13 -0
- package/build/sdk-typescript/src/model/themes/SDKThemeUtilities.d.ts +6 -0
- package/build/sdk-typescript/src/model/themes/SDKTokenTheme.d.ts +63 -0
- package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +49 -0
- package/build/sdk-typescript/src/model/tokens/SDKBlurToken.d.ts +18 -0
- package/build/sdk-typescript/src/model/tokens/SDKBorderToken.d.ts +19 -0
- package/build/sdk-typescript/src/model/tokens/SDKColorToken.d.ts +22 -0
- package/build/sdk-typescript/src/model/tokens/SDKFontToken.d.ts +16 -0
- package/build/sdk-typescript/src/model/tokens/SDKGenericToken.d.ts +18 -0
- package/build/sdk-typescript/src/model/tokens/SDKGradientToken.d.ts +18 -0
- package/build/sdk-typescript/src/model/tokens/SDKMeasureToken.d.ts +26 -0
- package/build/sdk-typescript/src/model/tokens/SDKRadiusToken.d.ts +18 -0
- package/build/sdk-typescript/src/model/tokens/SDKShadowToken.d.ts +21 -0
- package/build/sdk-typescript/src/model/tokens/SDKTextToken.d.ts +16 -0
- package/build/sdk-typescript/src/model/tokens/SDKToken.d.ts +30 -0
- package/build/sdk-typescript/src/model/tokens/SDKTokenCompator.d.ts +20 -0
- package/build/sdk-typescript/src/model/tokens/SDKTokenValue.d.ts +113 -0
- package/build/sdk-typescript/src/model/tokens/SDKTypographyToken.d.ts +19 -0
- package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenData.d.ts +45 -0
- package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenModel.d.ts +60 -0
- package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenValue.d.ts +72 -0
- package/build/sdk-typescript/src/model/users/SDKUser.d.ts +22 -0
- package/build/sdk-typescript/src/tests/Accessors/Brand.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Accessors/Components.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Accessors/DesignSystem.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Accessors/DesignSystemVersion.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Accessors/Documentation.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Accessors/Supernova.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Accessors/Theme.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Accessors/Workspace.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Tooling/PluginFigmaTokens.spec.d.ts +17 -0
- package/build/sdk-typescript/src/tests/Tooling/PluginJSONBuilder.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Tooling/ToolDocSearch.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Tooling/ToolMarkdownTransform.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/helpers.d.ts +2 -0
- package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +48 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONConverter.d.ts +34 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONGroupBuilder.d.ts +21 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONLoader.d.ts +27 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONParser.d.ts +40 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTMapLoader.d.ts +39 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTMapResolver.d.ts +10 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTThemeMerger.d.ts +17 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenGroupTreeMerger.d.ts +23 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenMerger.d.ts +17 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenReferenceResolver.d.ts +37 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenSetResolver.d.ts +12 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/collection/SDKDTTokenCollection.d.ts +13 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/expression/SDKDTExpressionParser.d.ts +5 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTGroupTree.d.ts +10 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTGroupTreeNode.d.ts +20 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTParentChildMapping.d.ts +5 -0
- package/build/sdk-typescript/src/tools/json-builder/SDKToolsJSONBuilder.d.ts +57 -0
- package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementFigmaTokensTransformer.d.ts +40 -0
- package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementStyleDictionaryTransformer.d.ts +29 -0
- package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementTransformer.d.ts +77 -0
- package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransform.d.ts +23 -0
- package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformBlock.d.ts +75 -0
- package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformUtil.d.ts +26 -0
- package/build/sdk-typescript/src/tools/search-index/SDKToolsDocSearch.d.ts +47 -0
- package/build/sdk-typescript/src/tools/token-transform/SDKToolsTokenTransform.d.ts +44 -0
- package/build/sdk-typescript/src/utils/FlowUtils.d.ts +5 -0
- package/build/sdk-typescript/src/utils/StringUtils.d.ts +72 -0
- package/build/supernova-sdk-typescript.js +3 -0
- package/build/supernova-sdk-typescript.js.LICENSE.txt +8 -0
- package/build/supernova-sdk-typescript.js.map +1 -0
- package/package.json +114 -0
package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTokenGroup.d.ts
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
|
|
2
|
+
import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
|
|
3
|
+
import { DocumentationPageBlockModel, DocumentationPageBlock } from "../SDKDocumentationPageBlock";
|
|
4
|
+
export interface DocumentationPageBlockTokenGroupModel extends DocumentationPageBlockModel {
|
|
5
|
+
designObjectId: string;
|
|
6
|
+
showNestedGroups: boolean;
|
|
7
|
+
}
|
|
8
|
+
export declare class DocumentationPageBlockTokenGroup extends DocumentationPageBlock {
|
|
9
|
+
groupId: string;
|
|
10
|
+
showNestedGroups: boolean;
|
|
11
|
+
constructor(model: DocumentationPageBlockTokenGroupModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
|
|
12
|
+
}
|
package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTokenList.d.ts
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
|
|
2
|
+
import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
|
|
3
|
+
import { DocumentationPageBlockModel, DocumentationPageBlock } from "../SDKDocumentationPageBlock";
|
|
4
|
+
export interface DocumentationPageBlockTokenListModel extends DocumentationPageBlockModel {
|
|
5
|
+
designObjectIds: Array<string>;
|
|
6
|
+
}
|
|
7
|
+
export declare class DocumentationPageBlockTokenList extends DocumentationPageBlock {
|
|
8
|
+
tokenIds: Array<string>;
|
|
9
|
+
constructor(model: DocumentationPageBlockTokenListModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
|
|
10
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
|
|
2
|
+
import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
|
|
3
|
+
import { DocumentationPageBlockTextModel, DocumentationPageBlockText } from "./SDKDocumentationPageBlockText";
|
|
4
|
+
export interface DocumentationPageUnorderedListModel extends DocumentationPageBlockTextModel {
|
|
5
|
+
}
|
|
6
|
+
export declare class DocumentationPageUnorderedList extends DocumentationPageBlockText {
|
|
7
|
+
constructor(model: DocumentationPageUnorderedListModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
|
|
8
|
+
}
|
package/build/sdk-typescript/src/model/documentation/builder/SDKDocumentationBlockBuilder.d.ts
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
|
|
2
|
+
import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
|
|
3
|
+
import { DocumentationPageBlockModel, DocumentationPageBlock } from "../SDKDocumentationPageBlock";
|
|
4
|
+
export declare class DocumentationBlockBuilder {
|
|
5
|
+
static fromGenericModel(model: DocumentationPageBlockModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration): DocumentationPageBlock;
|
|
6
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { DocumentationItemHeader, DocumentationItemHeaderModel } from "./SDKDocumentationItemHeader";
|
|
2
|
+
export interface DocumentationItemConfigurationModel {
|
|
3
|
+
header: DocumentationItemHeaderModel;
|
|
4
|
+
showSidebar: boolean;
|
|
5
|
+
}
|
|
6
|
+
export declare class DocumentationItemConfiguration {
|
|
7
|
+
header: DocumentationItemHeader;
|
|
8
|
+
showSidebar: boolean;
|
|
9
|
+
constructor(model: DocumentationItemConfigurationModel);
|
|
10
|
+
}
|
package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationItemHeader.d.ts
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { ColorTokenRemoteData } from '../../../model/tokens/remote/SDKRemoteTokenData';
|
|
2
|
+
import { Alignment } from '../../../model/enums/SDKAlignment';
|
|
3
|
+
import { AssetScaleType } from '../../../model/enums/SDKAssetScaleType';
|
|
4
|
+
import { DocumentationPageAssetModel } from '../SDKDocumentationPageAsset';
|
|
5
|
+
export interface DocumentationItemHeaderModel {
|
|
6
|
+
description: string;
|
|
7
|
+
alignment: Alignment;
|
|
8
|
+
foregroundColor?: ColorTokenRemoteData;
|
|
9
|
+
backgroundColor?: ColorTokenRemoteData;
|
|
10
|
+
backgroundImageAsset?: DocumentationPageAssetModel;
|
|
11
|
+
backgroundImageAssetUrl?: string;
|
|
12
|
+
backgroundImageAssetId?: string;
|
|
13
|
+
backgroundImageScaleType: AssetScaleType;
|
|
14
|
+
showBackgroundOverlay: boolean;
|
|
15
|
+
showCoverText: boolean;
|
|
16
|
+
minHeight: number;
|
|
17
|
+
}
|
|
18
|
+
export declare class DocumentationItemHeader {
|
|
19
|
+
backgroundImageAssetUrl: string | null;
|
|
20
|
+
backgroundImageAssetId: string | null;
|
|
21
|
+
backgroundImageScaleType: AssetScaleType;
|
|
22
|
+
description: string;
|
|
23
|
+
alignment: Alignment;
|
|
24
|
+
foregroundColor: ColorTokenRemoteData | null;
|
|
25
|
+
backgroundColor: ColorTokenRemoteData | null;
|
|
26
|
+
showBackgroundOverlay: boolean;
|
|
27
|
+
showCoverText: boolean;
|
|
28
|
+
minHeight: number;
|
|
29
|
+
constructor(model: DocumentationItemHeaderModel);
|
|
30
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { ElementPropertyTargetElementType } from '../..';
|
|
2
|
+
import { ElementDataViewColumn, ElementDataViewColumnRemoteModel } from './SDKElementDataViewColumn';
|
|
3
|
+
export interface ElementDataViewRemoteModel {
|
|
4
|
+
id: string;
|
|
5
|
+
persistentId: string;
|
|
6
|
+
isDefault: boolean;
|
|
7
|
+
targetElementType: ElementPropertyTargetElementType;
|
|
8
|
+
columns: Array<ElementDataViewColumnRemoteModel>;
|
|
9
|
+
meta: {
|
|
10
|
+
name: string;
|
|
11
|
+
description: string;
|
|
12
|
+
};
|
|
13
|
+
}
|
|
14
|
+
export declare class ElementDataView {
|
|
15
|
+
/** Unique id of data view, different across versions */
|
|
16
|
+
id: string;
|
|
17
|
+
/** Unique persistent id of the data view */
|
|
18
|
+
persistentId: string;
|
|
19
|
+
/** Default data view */
|
|
20
|
+
isDefault: boolean;
|
|
21
|
+
/** Signifies which objects use this element data view */
|
|
22
|
+
targetElementType: ElementPropertyTargetElementType;
|
|
23
|
+
/** Data view columns */
|
|
24
|
+
columns: Array<ElementDataViewColumn>;
|
|
25
|
+
/** Data view name */
|
|
26
|
+
name: string;
|
|
27
|
+
/** Data view description */
|
|
28
|
+
description: string | null;
|
|
29
|
+
constructor(model: ElementDataViewRemoteModel);
|
|
30
|
+
}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
export declare enum ElementDataViewColumnType {
|
|
2
|
+
baseProperty = "BaseProperty",
|
|
3
|
+
propertyDefinition = "PropertyDefinition",
|
|
4
|
+
theme = "Theme"
|
|
5
|
+
}
|
|
6
|
+
export declare enum ElementDataViewColumnBasePropertyType {
|
|
7
|
+
name = "Name",
|
|
8
|
+
description = "Description",
|
|
9
|
+
value = "Value",
|
|
10
|
+
updatedAt = "UpdatedAt"
|
|
11
|
+
}
|
|
12
|
+
export interface ElementDataViewColumnRemoteModel {
|
|
13
|
+
id: string;
|
|
14
|
+
persistentId: string;
|
|
15
|
+
type: ElementDataViewColumnType;
|
|
16
|
+
basePropertyType?: ElementDataViewColumnBasePropertyType;
|
|
17
|
+
propertyDefinitionId?: string;
|
|
18
|
+
themeId?: string;
|
|
19
|
+
width: number;
|
|
20
|
+
}
|
|
21
|
+
export declare class ElementDataViewColumn {
|
|
22
|
+
/** Unique id of data view column, different across versions */
|
|
23
|
+
id: string;
|
|
24
|
+
/** Unique persistent id of the data view column */
|
|
25
|
+
persistentId: string;
|
|
26
|
+
/** Type of the contained property */
|
|
27
|
+
type: ElementDataViewColumnType;
|
|
28
|
+
/** Type of the base property, if element column type === BaseProperty */
|
|
29
|
+
basePropertyType: ElementDataViewColumnBasePropertyType | null;
|
|
30
|
+
/** Data view columns */
|
|
31
|
+
propertyDefinitionId: string | null;
|
|
32
|
+
/** Theme id column points to */
|
|
33
|
+
themeId: string | null;
|
|
34
|
+
/** Column width */
|
|
35
|
+
width: number;
|
|
36
|
+
constructor(model: ElementDataViewColumnRemoteModel);
|
|
37
|
+
}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { ElementPropertyOption, ElementPropertyOptionRemoteModel } from './SDKElementPropertyOption';
|
|
2
|
+
export declare enum ElementPropertyType {
|
|
3
|
+
text = "Text",
|
|
4
|
+
number = "Number",
|
|
5
|
+
boolean = "Boolean",
|
|
6
|
+
select = "Select",
|
|
7
|
+
generic = "Generic",
|
|
8
|
+
link = "Link",
|
|
9
|
+
url = "URL"
|
|
10
|
+
}
|
|
11
|
+
export declare enum ElementPropertyTargetElementType {
|
|
12
|
+
token = "Token",
|
|
13
|
+
component = "Component",
|
|
14
|
+
documentationPage = "DocumentationPage"
|
|
15
|
+
}
|
|
16
|
+
export declare enum ElementPropertyLinkElementType {
|
|
17
|
+
documentationItem = "DocumentationItem",
|
|
18
|
+
figmaComponent = "FigmaComponent"
|
|
19
|
+
}
|
|
20
|
+
export interface ElementPropertyRemoteModel {
|
|
21
|
+
id: string;
|
|
22
|
+
persistentId: string;
|
|
23
|
+
designSystemVersionId: string;
|
|
24
|
+
meta: {
|
|
25
|
+
name: string;
|
|
26
|
+
description: string;
|
|
27
|
+
};
|
|
28
|
+
codeName: string;
|
|
29
|
+
type: ElementPropertyType;
|
|
30
|
+
targetElementType: ElementPropertyTargetElementType;
|
|
31
|
+
linkElementType?: ElementPropertyLinkElementType;
|
|
32
|
+
options?: Array<ElementPropertyOptionRemoteModel>;
|
|
33
|
+
}
|
|
34
|
+
export declare class ElementProperty {
|
|
35
|
+
/** Unique id of the component property (data column) */
|
|
36
|
+
id: string;
|
|
37
|
+
/** Unique persistent id of the component property (data column) */
|
|
38
|
+
persistentId: string;
|
|
39
|
+
/** Specific design system version this property is contained in */
|
|
40
|
+
designSystemVersionId: string;
|
|
41
|
+
/** Property name */
|
|
42
|
+
name: string;
|
|
43
|
+
/** Code property name - guaranteed to be present, unique and code-safe */
|
|
44
|
+
codeName: string;
|
|
45
|
+
/** Property description */
|
|
46
|
+
description: string | null;
|
|
47
|
+
/** Base type */
|
|
48
|
+
propertyType: ElementPropertyType;
|
|
49
|
+
/** Type of design system object this property is contained in - for example, if this property was configured for DS components, this will be of type `component` */
|
|
50
|
+
targetElementType: ElementPropertyTargetElementType;
|
|
51
|
+
/** Type of design system object this property can be configured with */
|
|
52
|
+
linkElementType: ElementPropertyLinkElementType | null;
|
|
53
|
+
/** Property options, only available for `select` type */
|
|
54
|
+
options: Array<ElementPropertyOption> | null;
|
|
55
|
+
constructor(model: ElementPropertyRemoteModel);
|
|
56
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export interface ElementPropertyOptionRemoteModel {
|
|
2
|
+
id: string;
|
|
3
|
+
name: string;
|
|
4
|
+
backgroundColor: {
|
|
5
|
+
value: string;
|
|
6
|
+
};
|
|
7
|
+
}
|
|
8
|
+
export declare class ElementPropertyOption {
|
|
9
|
+
id: string;
|
|
10
|
+
name: string;
|
|
11
|
+
backgroundColor: string | null;
|
|
12
|
+
constructor(model: ElementPropertyOptionRemoteModel);
|
|
13
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
export interface ElementPropertyValueRemoteModel {
|
|
2
|
+
value: string | boolean | number;
|
|
3
|
+
id: string;
|
|
4
|
+
designSystemVersionId: string;
|
|
5
|
+
definitionId: string;
|
|
6
|
+
targetElementId: string;
|
|
7
|
+
}
|
|
8
|
+
export declare class ElementPropertyValue {
|
|
9
|
+
value: string | boolean | number;
|
|
10
|
+
id: string;
|
|
11
|
+
designSystemVersionId: string;
|
|
12
|
+
definitionId: string;
|
|
13
|
+
targetElementId: string;
|
|
14
|
+
constructor(model: ElementPropertyValueRemoteModel);
|
|
15
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
export declare enum DocumentationPageBlockType {
|
|
2
|
+
text = "Text",
|
|
3
|
+
heading = "Heading",
|
|
4
|
+
code = "Code",
|
|
5
|
+
unorderedList = "UnorderedList",
|
|
6
|
+
orderedList = "OrderedList",
|
|
7
|
+
quote = "Quote",
|
|
8
|
+
callout = "Callout",
|
|
9
|
+
divider = "Divider",
|
|
10
|
+
image = "Image",
|
|
11
|
+
token = "Token",
|
|
12
|
+
tokenList = "TokenList",
|
|
13
|
+
tokenGroup = "TokenGroup",
|
|
14
|
+
shortcuts = "Shortcuts",
|
|
15
|
+
link = "Link",
|
|
16
|
+
figmaEmbed = "FigmaEmbed",
|
|
17
|
+
youtubeEmbed = "YoutubeEmbed",
|
|
18
|
+
storybookEmbed = "StorybookEmbed",
|
|
19
|
+
genericEmbed = "Embed",
|
|
20
|
+
figmaFrames = "FigmaFrames",
|
|
21
|
+
custom = "Custom",
|
|
22
|
+
renderCode = "RenderCode",
|
|
23
|
+
componentAssets = "ComponentAssets",
|
|
24
|
+
column = "Column",
|
|
25
|
+
columnItem = "ColumnItem",
|
|
26
|
+
tabs = "Tabs",
|
|
27
|
+
tabItem = "TabItem",
|
|
28
|
+
table = "Table",
|
|
29
|
+
tableCell = "TableCell",
|
|
30
|
+
tableRow = "TableRow"
|
|
31
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export declare enum TokenType {
|
|
2
|
+
color = "Color",
|
|
3
|
+
typography = "Typography",
|
|
4
|
+
radius = "Radius",
|
|
5
|
+
font = "Font",
|
|
6
|
+
measure = "Measure",
|
|
7
|
+
shadow = "Shadow",
|
|
8
|
+
border = "Border",
|
|
9
|
+
gradient = "Gradient",
|
|
10
|
+
text = "Text",
|
|
11
|
+
blur = "Blur",
|
|
12
|
+
generic = "GenericToken"
|
|
13
|
+
}
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
import { ExporterCustomBlock, ExporterCustomBlockModel } from "./custom_blocks/SDKExporterCustomBlock";
|
|
2
|
+
import { ExporterCustomBlockVariant } from "./custom_blocks/SDKExporterCustomBlockVariant";
|
|
3
|
+
import { ExporterConfigurationProperty, ExporterConfigurationPropertyModel } from "./custom_properties/SDKExporterConfigurationProperty";
|
|
4
|
+
export interface ExporterModel {
|
|
5
|
+
id: string;
|
|
6
|
+
packageId: string;
|
|
7
|
+
isPrivate: boolean;
|
|
8
|
+
isDefaultDocumentationExporter: boolean;
|
|
9
|
+
usesBrands: boolean;
|
|
10
|
+
name: string;
|
|
11
|
+
description: string;
|
|
12
|
+
version: string;
|
|
13
|
+
author: string;
|
|
14
|
+
organization: string;
|
|
15
|
+
homepage: string;
|
|
16
|
+
readme: string;
|
|
17
|
+
iconURL?: string;
|
|
18
|
+
tags: Array<string>;
|
|
19
|
+
githubUrl: string;
|
|
20
|
+
githubBranch?: string;
|
|
21
|
+
githubDirectory?: string;
|
|
22
|
+
blockVariants?: Object;
|
|
23
|
+
configurationProperties?: Array<ExporterConfigurationPropertyModel>;
|
|
24
|
+
customBlocks?: Array<ExporterCustomBlockModel>;
|
|
25
|
+
}
|
|
26
|
+
export declare class Exporter {
|
|
27
|
+
/** Unique exporter installation id. This id is used to referenced exporter within Supernova system (for example, in ds.documentationExporterId) */
|
|
28
|
+
id: string;
|
|
29
|
+
/** Original exporter package id, as defined in exporter.json */
|
|
30
|
+
packageId: string;
|
|
31
|
+
/** Store status of the exporter - private exporters are only visible to your workspace, while public are visible to everyone and can be installed by anyone */
|
|
32
|
+
isPrivate: boolean;
|
|
33
|
+
/** If true, this exporter is currently being used for documentation purposes */
|
|
34
|
+
isDefaultDocumentationExporter: boolean;
|
|
35
|
+
/** If true, this exporter uses branding functionality */
|
|
36
|
+
usesBrands: boolean;
|
|
37
|
+
/** Exporter human-readable name */
|
|
38
|
+
name: string;
|
|
39
|
+
/** Exporter human-readable description */
|
|
40
|
+
description: string | null;
|
|
41
|
+
/** Exporter semantic version */
|
|
42
|
+
version: string;
|
|
43
|
+
/** Name of the package author */
|
|
44
|
+
author: string | null;
|
|
45
|
+
/** Name of the package author's organization */
|
|
46
|
+
organization: string | null;
|
|
47
|
+
/** Package marketing link */
|
|
48
|
+
homepage: string | null;
|
|
49
|
+
/** Package ReadMe definition, defined as GitHub-style markdown */
|
|
50
|
+
readme: string | null;
|
|
51
|
+
/** Exporter package icon */
|
|
52
|
+
iconURL: string | null;
|
|
53
|
+
/** Exporter feature tags, such as iOS, React, token, styles, components etc. */
|
|
54
|
+
tags: Array<string>;
|
|
55
|
+
/** Original location of the package, usually a github repository */
|
|
56
|
+
origin: {
|
|
57
|
+
/** URL of the repository containing the exporter package */
|
|
58
|
+
repositoryUrl: string;
|
|
59
|
+
/** Branch of the repository containing the exporter package. If not provided, exporter is located at the default branch */
|
|
60
|
+
repositoryBranch: string | null;
|
|
61
|
+
/** Root directory in the repository containing the exporter package. If not provided, exporter is located at the root directory */
|
|
62
|
+
repositoryDirectory: string | null;
|
|
63
|
+
};
|
|
64
|
+
/** Contribution of this exporter to the Supernova system */
|
|
65
|
+
contributes: {
|
|
66
|
+
/** Documentation block variants */
|
|
67
|
+
blockVariants: Array<ExporterCustomBlockVariant>;
|
|
68
|
+
/** Documentation blocks */
|
|
69
|
+
blocks: Array<ExporterCustomBlock>;
|
|
70
|
+
/** Exporter configuration */
|
|
71
|
+
configuration: Array<ExporterConfigurationProperty>;
|
|
72
|
+
};
|
|
73
|
+
constructor(data: ExporterModel);
|
|
74
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { ExporterCustomBlockProperty, ExporterCustomBlockPropertyModel } from "./SDKExporterCustomBlockProperty";
|
|
2
|
+
export interface ExporterCustomBlockModel {
|
|
3
|
+
key: string;
|
|
4
|
+
title: string;
|
|
5
|
+
description: string;
|
|
6
|
+
category: string;
|
|
7
|
+
iconURL: string;
|
|
8
|
+
mode: ExporterCustomBlockMode;
|
|
9
|
+
properties: Array<ExporterCustomBlockPropertyModel>;
|
|
10
|
+
}
|
|
11
|
+
export declare enum ExporterCustomBlockMode {
|
|
12
|
+
block = "block"
|
|
13
|
+
}
|
|
14
|
+
export declare class ExporterCustomBlock {
|
|
15
|
+
key: string;
|
|
16
|
+
title: string;
|
|
17
|
+
description: string;
|
|
18
|
+
category: string;
|
|
19
|
+
iconUrl: string | null;
|
|
20
|
+
mode: ExporterCustomBlockMode;
|
|
21
|
+
properties: Array<ExporterCustomBlockProperty>;
|
|
22
|
+
constructor(model: ExporterCustomBlockModel);
|
|
23
|
+
}
|
package/build/sdk-typescript/src/model/exporters/custom_blocks/SDKExporterCustomBlockProperty.d.ts
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
export interface ExporterCustomBlockPropertyModel {
|
|
2
|
+
label: string;
|
|
3
|
+
key: string;
|
|
4
|
+
type: ExporterCustomBlockPropertyType;
|
|
5
|
+
inputType: ExporterCustomBlockPropertyInputType;
|
|
6
|
+
isMultiline: boolean;
|
|
7
|
+
default?: string | number | boolean;
|
|
8
|
+
values: Array<string>;
|
|
9
|
+
}
|
|
10
|
+
export declare enum ExporterCustomBlockPropertyType {
|
|
11
|
+
string = "string",
|
|
12
|
+
number = "number",
|
|
13
|
+
boolean = "boolean",
|
|
14
|
+
enum = "enum",
|
|
15
|
+
image = "image",
|
|
16
|
+
color = "color",
|
|
17
|
+
typography = "typography"
|
|
18
|
+
}
|
|
19
|
+
export declare enum ExporterCustomBlockPropertyInputType {
|
|
20
|
+
plain = "plain",
|
|
21
|
+
code = "code"
|
|
22
|
+
}
|
|
23
|
+
export declare class ExporterCustomBlockProperty {
|
|
24
|
+
label: string;
|
|
25
|
+
key: string;
|
|
26
|
+
type: ExporterCustomBlockPropertyType;
|
|
27
|
+
inputType: ExporterCustomBlockPropertyInputType;
|
|
28
|
+
isMultiline: boolean;
|
|
29
|
+
default: string | number | boolean | null;
|
|
30
|
+
values: Array<string>;
|
|
31
|
+
constructor(data: ExporterCustomBlockPropertyModel);
|
|
32
|
+
}
|
package/build/sdk-typescript/src/model/exporters/custom_blocks/SDKExporterCustomBlockVariant.d.ts
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export interface ExporterCustomBlockVariantModel {
|
|
2
|
+
key: string;
|
|
3
|
+
name: string;
|
|
4
|
+
isDefault: boolean;
|
|
5
|
+
}
|
|
6
|
+
export declare class ExporterCustomBlockVariant {
|
|
7
|
+
blockKey: string;
|
|
8
|
+
variantKey: string;
|
|
9
|
+
name: string;
|
|
10
|
+
isDefault: boolean;
|
|
11
|
+
constructor(model: ExporterCustomBlockVariantModel, blockKey: string);
|
|
12
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
export interface ExporterConfigurationPropertyModel {
|
|
2
|
+
label: string;
|
|
3
|
+
description: string;
|
|
4
|
+
category: string;
|
|
5
|
+
key: string;
|
|
6
|
+
type: ExporterConfigurationPropertyType;
|
|
7
|
+
inputType: ExporterConfigurationPropertyInputType;
|
|
8
|
+
isMultiline: boolean;
|
|
9
|
+
default?: string | number | boolean;
|
|
10
|
+
values: Array<string>;
|
|
11
|
+
}
|
|
12
|
+
export declare enum ExporterConfigurationPropertyType {
|
|
13
|
+
string = "string",
|
|
14
|
+
number = "number",
|
|
15
|
+
boolean = "boolean",
|
|
16
|
+
enum = "enum",
|
|
17
|
+
image = "image",
|
|
18
|
+
color = "color",
|
|
19
|
+
typography = "typography"
|
|
20
|
+
}
|
|
21
|
+
export declare enum ExporterConfigurationPropertyInputType {
|
|
22
|
+
plain = "plain",
|
|
23
|
+
code = "code"
|
|
24
|
+
}
|
|
25
|
+
export declare class ExporterConfigurationProperty {
|
|
26
|
+
label: string;
|
|
27
|
+
category: string;
|
|
28
|
+
description: string;
|
|
29
|
+
key: string;
|
|
30
|
+
type: ExporterConfigurationPropertyType;
|
|
31
|
+
inputType: ExporterConfigurationPropertyInputType;
|
|
32
|
+
isMultiline: boolean;
|
|
33
|
+
default: string | number | boolean | null;
|
|
34
|
+
value: string | number | boolean | Object | null;
|
|
35
|
+
values: Array<string>;
|
|
36
|
+
constructor(data: ExporterConfigurationPropertyModel, value: string | number | boolean | Object | null);
|
|
37
|
+
updateValue(value: string | number | boolean | Object | null): void;
|
|
38
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { DesignComponentGroupRemoteModel } from "./SDKDesignComponentGroup";
|
|
2
|
+
export declare class AssetGroup {
|
|
3
|
+
id: string;
|
|
4
|
+
brandId: string;
|
|
5
|
+
name: string;
|
|
6
|
+
description: string;
|
|
7
|
+
path: Array<string>;
|
|
8
|
+
subgroups: Array<AssetGroup>;
|
|
9
|
+
isRoot: boolean;
|
|
10
|
+
childrenIds: Array<string>;
|
|
11
|
+
assetIds: Array<string>;
|
|
12
|
+
parent: AssetGroup | null;
|
|
13
|
+
createdAt: Date | null;
|
|
14
|
+
updatedAt: Date | null;
|
|
15
|
+
constructor(model: DesignComponentGroupRemoteModel);
|
|
16
|
+
addChild(group: AssetGroup): void;
|
|
17
|
+
addChildren(groups: Array<AssetGroup>): void;
|
|
18
|
+
setPath(segments: Array<string>): void;
|
|
19
|
+
setParent(parent: AssetGroup | null): void;
|
|
20
|
+
}
|