@supernova-studio/supernova-sdk-beta 1.6.37 → 1.6.39
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 +4 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaAssets.d.ts +11 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +14 -14
- package/build/sdk-typescript/src/core/areas/SDKAreaBrands.d.ts +1 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaBulkOperations.d.ts +10 -2
- package/build/sdk-typescript/src/core/areas/SDKAreaComponents.d.ts +10 -3
- package/build/sdk-typescript/src/core/areas/SDKAreaDesignSystems.d.ts +24 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +78 -37
- package/build/sdk-typescript/src/core/areas/SDKAreaIntegrations.d.ts +13 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaMultiplayer.d.ts +10 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaResources.d.ts +25 -3
- package/build/sdk-typescript/src/core/areas/SDKAreaTokens.d.ts +2 -2
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +6 -0
- package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +5 -1
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +95 -39
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +48 -16
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +44 -53
- package/build/sdk-typescript/src/core/errors/SDKSupernovaError.d.ts +4 -2
- package/build/sdk-typescript/src/core/resolvers/SDKAssetGroupResolver.d.ts +4 -0
- package/build/sdk-typescript/src/core/resolvers/SDKDocsEntityMultiplayerItemResolver.d.ts +7 -0
- package/build/sdk-typescript/src/core/resolvers/SDKTokenResolver.d.ts +4 -4
- package/build/sdk-typescript/src/exports.d.ts +22 -4
- package/build/sdk-typescript/src/model/base/SDKDesignSystem.d.ts +1 -7
- 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 +13 -23
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockItemDefinition.d.ts +3 -10
- 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 +9 -18
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{token-group/SDKDocsBlockActualTokenGroup.d.ts → color-ramps/SDKDocsBlockActualColorRamps.d.ts} +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/design-tokens/SDKDocsBlockActualDesignTokens.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts +9 -5
- 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 +4 -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 +2 -2
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts +2 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockFigmaNodeProperty.d.ts +30 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMarkdownProperty.d.ts +4 -1
- 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 +3 -3
- 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 +3 -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 +13 -3
- 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 +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +8 -2
- package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsColorRef.d.ts +2 -2
- package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsImageRef.d.ts +18 -13
- 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 -24
- package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlockItem.d.ts +2 -7
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntity.d.ts +5 -2
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityConfiguration.d.ts +6 -1
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityGroup.d.ts +24 -2
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityHeader.d.ts +8 -2
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityPage.d.ts +14 -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/elements/SDKElementProperty.d.ts +1 -1
- package/build/sdk-typescript/src/model/elements/SDKElementPropertyOption.d.ts +27 -5
- package/build/sdk-typescript/src/model/enums/SDKAlignment.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKCodeLanguage.d.ts +9 -8
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockBehaviorDataType.d.ts +1 -1
- package/build/sdk-typescript/src/model/enums/{SDKDocsBlockAssetPropertyPreviewContainerSize.d.ts → SDKDocsBlockContainerSize.d.ts} +1 -1
- 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/SDKDocsBlockTextPropertyStyle.d.ts +3 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsPublishStatus.d.ts +4 -0
- 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/SDKConnections.d.ts +9 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuild.d.ts +11 -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/SDKResourceFont.d.ts +2 -2
- package/build/sdk-typescript/src/model/support/SDKFigmaFrame.d.ts +2 -0
- package/build/sdk-typescript/src/model/support/SDKSource.d.ts +14 -5
- 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 +11 -6
- package/build/sdk-typescript/src/model/tokens/SDKColorToken.d.ts +2 -1
- package/build/sdk-typescript/src/model/tokens/SDKDimensionToken.d.ts +1 -1
- package/build/sdk-typescript/src/model/tokens/SDKShadowToken.d.ts +1 -0
- 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/SDKTokenCompator.d.ts +2 -2
- package/build/sdk-typescript/src/model/tokens/SDKTokenValue.d.ts +3 -3
- package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenValue.d.ts +1 -1
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceNPMRegistryAccessToken.d.ts +15 -0
- package/build/sdk-typescript/src/tests/Areas/AreaAssets.spec.d.ts +1 -0
- 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 +47 -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/TokenUtilPreviewReferenceInfoGenerator.d.ts +0 -1
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewStyleGenerator.d.ts +4 -1
- package/build/sdk-typescript/src/tools/token-transform/SDKToolsTokenTransform.d.ts +3 -1
- package/build/sdk-typescript/src/utils/CommonUtils.d.ts +5 -0
- package/build/sdk-typescript/src/utils/TokenUtils.d.ts +5 -4
- 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 +122 -118
|
@@ -4,8 +4,10 @@ export type SupernovaFieldValidationError = {
|
|
|
4
4
|
code: string | null;
|
|
5
5
|
};
|
|
6
6
|
export type SupernovaBackendError = {
|
|
7
|
-
reason: string;
|
|
8
7
|
message: string;
|
|
8
|
+
errorCode?: string;
|
|
9
|
+
label?: string;
|
|
10
|
+
reason?: string;
|
|
9
11
|
code: number;
|
|
10
12
|
requestId: string;
|
|
11
13
|
serverTime: string;
|
|
@@ -27,7 +29,7 @@ export declare class SupernovaError extends Error {
|
|
|
27
29
|
serverTime: string | null;
|
|
28
30
|
private constructor();
|
|
29
31
|
/** Creates Supernova error from received but failed network response */
|
|
30
|
-
static fromNetworkResponse(response: SupernovaBackendError, url: string): SupernovaError;
|
|
32
|
+
static fromNetworkResponse(response: SupernovaBackendError, status: number, url: string): SupernovaError;
|
|
31
33
|
/** Creates Supernova error with generic network failure message */
|
|
32
34
|
static fromNoNetworkResponse(url: string): SupernovaError;
|
|
33
35
|
/** Creates Supernova error from local validation failure code */
|
|
@@ -5,6 +5,10 @@ export declare class AssetGroupResolver {
|
|
|
5
5
|
assets: Array<Asset>;
|
|
6
6
|
constructor(assets: Array<Asset>);
|
|
7
7
|
resolveGroupData(data: Array<DesignComponentGroupRemoteModel>): Array<AssetGroup>;
|
|
8
|
+
private markAssetGroups;
|
|
9
|
+
private markAssetAncestors;
|
|
10
|
+
private assignSourceDataToGroups;
|
|
11
|
+
private propagateSourceDataToAncestors;
|
|
8
12
|
private recomputePaths;
|
|
9
13
|
private recomputePathsFromRoot;
|
|
10
14
|
private reorderGroupsByRoots;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { DocsEntityGroupModel, DocsEntityMultiplayerGroup, DocsEntityMultiplayerPage, DocsEntityPageModel } from "../../exports";
|
|
2
|
+
export declare class DocsEntityMultiplayerItemResolver {
|
|
3
|
+
hashedItems: Map<string, DocsEntityGroupModel | DocsEntityPageModel>;
|
|
4
|
+
resolvedItems: Map<string, DocsEntityMultiplayerGroup | DocsEntityMultiplayerPage>;
|
|
5
|
+
resolveMultiplayerItems(pageDetails: Array<DocsEntityPageModel>, groupDetails: Array<DocsEntityGroupModel>): Array<DocsEntityMultiplayerGroup | DocsEntityMultiplayerPage>;
|
|
6
|
+
private resolveItemsForGroup;
|
|
7
|
+
}
|
|
@@ -34,15 +34,15 @@ export declare class TokenResolver {
|
|
|
34
34
|
constructOptionValueForReplica(type: OptionTokenType, replica: Token, override: TokenThemeOverrideRemoteModel): void;
|
|
35
35
|
constructDimensionValueForReplica(type: DimensionTokenType, replica: Token, override: TokenThemeOverrideRemoteModel): void;
|
|
36
36
|
constructPureValueForReplica(type: PureTokenType, replica: Token, override: TokenThemeOverrideRemoteModel): void;
|
|
37
|
-
resolveThemeData(data: TokenThemeRemoteModel, tokens: Array<Token>, tokenGroups: Array<TokenGroup>): TokenTheme;
|
|
37
|
+
resolveThemeData(data: TokenThemeRemoteModel, tokens: Array<Token>, tokenGroups: Array<TokenGroup>, sources: Array<Source>): TokenTheme;
|
|
38
38
|
makeThemedValuelessTokenReplica(token: Token, themeId: string, origin: TokenOrigin | null): Token;
|
|
39
39
|
fixMultilayerShadowTokens(tokens: Array<ShadowToken>, groups: Array<TokenGroup>): void;
|
|
40
40
|
fixMultilayerGradientTokens(tokens: Array<GradientToken>, groups: Array<TokenGroup>): void;
|
|
41
41
|
fixMultilayerBlurTokens(tokens: Array<BlurToken>, groups: Array<TokenGroup>): void;
|
|
42
42
|
findAssociatedTokens<T extends Token>(token: T, tokens: Array<T>, groups: Array<TokenGroup>): Array<T>;
|
|
43
|
-
actualOriginTokenId(id: string | null): string;
|
|
44
|
-
constructReferencedToken(rawData: TokenRemoteModel, properties: Array<ElementProperty>, values: Array<ElementPropertyValue>): Token;
|
|
45
|
-
constructReferencedThemedToken(rawData: TokenThemeOverrideRemoteModel, themeId: string): Token;
|
|
43
|
+
actualOriginTokenId(id: string | null): string | null | undefined;
|
|
44
|
+
constructReferencedToken(rawData: TokenRemoteModel, properties: Array<ElementProperty>, values: Array<ElementPropertyValue>, path?: Set<unknown>): Token;
|
|
45
|
+
constructReferencedThemedToken(rawData: TokenThemeOverrideRemoteModel, themeId: string, path?: Set<unknown>): Token;
|
|
46
46
|
constructResolvedThemedToken(rawData: TokenThemeOverrideRemoteModel, referencedToken: Token, themeId: string): Token;
|
|
47
47
|
constructResolvedToken(rawData: TokenRemoteModel, referencedToken: Token, properties: Array<ElementProperty>, values: Array<ElementPropertyValue>): Token;
|
|
48
48
|
constructValueToken(rawData: TokenRemoteModel, properties: Array<ElementProperty>, values: Array<ElementPropertyValue>): Token;
|
|
@@ -32,8 +32,10 @@ export { SubscriptionProductFeatures } from "./model/workspaces/SDKWorkspaceProd
|
|
|
32
32
|
export type { ProductFeature } from "./model/workspaces/SDKWorkspaceProductFeatures";
|
|
33
33
|
export type { FeaturePermissionResolution } from "./model/workspaces/SDKWorkspaceProductFeatures";
|
|
34
34
|
export { Brand } from "./model/base/SDKBrand";
|
|
35
|
+
export type { BrandUpdateModel } from "./model/base/SDKBrand";
|
|
35
36
|
export { DesignSystem } from "./model/base/SDKDesignSystem";
|
|
36
37
|
export { DesignSystemVersion } from "./model/base/SDKDesignSystemVersion";
|
|
38
|
+
export type { DesignSystemVersionUpdateModel } from "./model/base/SDKDesignSystemVersion";
|
|
37
39
|
export { Membership } from "./model/membership/SDKMembership";
|
|
38
40
|
export { Exporter, type NewExporterPayload, type ExporterProvider, } from "./model/exporters/SDKExporter";
|
|
39
41
|
export { Pipeline } from "./model/exporters/SDKPipeline";
|
|
@@ -60,15 +62,21 @@ export { DocsBlockLayout } from "./model/docs/blocks/definition/SDKDocsBlockLayo
|
|
|
60
62
|
export { DocsBlockOnboarding } from "./model/docs/blocks/definition/SDKDocsBlockOnboarding";
|
|
61
63
|
export { DocsBlockVariant } from "./model/docs/blocks/definition/SDKDocsBlockVariant";
|
|
62
64
|
export { DocsBlockMode } from "./model/enums/SDKDocBlockMode";
|
|
65
|
+
export { DocsEntityMultiplayerItemResolver } from "./core/resolvers/SDKDocsEntityMultiplayerItemResolver";
|
|
63
66
|
export { DocsEntity } from "./model/docs/entities/SDKDocsEntity";
|
|
64
|
-
export {
|
|
65
|
-
export {
|
|
67
|
+
export { DocsEntityConfiguration } from "./model/docs/entities/SDKDocsEntityConfiguration";
|
|
68
|
+
export type { DocsEntityGroupModel } from "./model/docs/entities/SDKDocsEntityGroup";
|
|
69
|
+
export { DocsEntityGroup, DocsEntityMultiplayerGroup, } from "./model/docs/entities/SDKDocsEntityGroup";
|
|
70
|
+
export type { DocsEntityPageModel } from "./model/docs/entities/SDKDocsEntityPage";
|
|
71
|
+
export { DocsEntityPage, DocsEntityMultiplayerPage, } from "./model/docs/entities/SDKDocsEntityPage";
|
|
66
72
|
export { DocsBlockPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockProperty";
|
|
67
73
|
export type { DocsBlockItemPropertyAnyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockProperty";
|
|
68
74
|
export { DocsBlockAssetPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockAssetProperty";
|
|
69
75
|
export type { DocsBlockAssetPropertyData, DocsBlockAssetPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockAssetProperty";
|
|
70
76
|
export { DocsBlockAssetPropertyPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockAssetPropertyProperty";
|
|
71
77
|
export type { DocsBlockAssetPropertyPropertyData, DocsBlockAssetPropertyPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockAssetPropertyProperty";
|
|
78
|
+
export { DocsBlockFigmaNodePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockFigmaNodeProperty";
|
|
79
|
+
export type { DocsBlockFigmaNodePropertyData, DocsBlockFigmaNodePropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockFigmaNodeProperty";
|
|
72
80
|
export { DocsBlockBooleanPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockBooleanProperty";
|
|
73
81
|
export type { DocsBlockBooleanPropertyData, DocsBlockBooleanPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockBooleanProperty";
|
|
74
82
|
export { DocsBlockCodePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockCodeProperty";
|
|
@@ -91,6 +99,8 @@ export { DocsBlockNumberPropertyDefinition } from "./model/docs/blocks/propertie
|
|
|
91
99
|
export type { DocsBlockNumberPropertyData, DocsBlockNumberPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockNumberProperty";
|
|
92
100
|
export { DocsBlockRichTextPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockRichTextProperty";
|
|
93
101
|
export type { DocsBlockRichTextPropertyData, DocsBlockRichTextPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockRichTextProperty";
|
|
102
|
+
export { DocsBlockMultiRichTextPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty";
|
|
103
|
+
export type { DocsBlockMultiRichTextPropertyData, DocsBlockMultiRichTextPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty";
|
|
94
104
|
export { DocsBlockSingleSelectPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty";
|
|
95
105
|
export type { DocsBlockSingleSelectPropertyData, DocsBlockSingleSelectPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty";
|
|
96
106
|
export { DocsBlockTablePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTableProperty";
|
|
@@ -106,6 +116,8 @@ export type { DocsBlockTokenPropertyPropertyData, DocsBlockTokenPropertyProperty
|
|
|
106
116
|
export { DocsBlockTokenTypePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty";
|
|
107
117
|
export type { DocsBlockTokenTypePropertyData, DocsBlockTokenTypePropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty";
|
|
108
118
|
export { DocsBlockDividerPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockDividerProperty";
|
|
119
|
+
export type { DocsBlockColorPropertyData, DocsBlockColorPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockColorProperty";
|
|
120
|
+
export { DocsBlockColorPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockColorProperty";
|
|
109
121
|
export type { DocsBlockDividerPropertyData, DocsBlockDividerPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockDividerProperty";
|
|
110
122
|
export { DocsBlockStorybookPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockStorybookProperty";
|
|
111
123
|
export type { DocsBlockStorybookPropertyData, DocsBlockStorybookPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockStorybookProperty";
|
|
@@ -155,6 +167,8 @@ export { DocumentationLegacyItemHeader } from "./model/documentation/configurati
|
|
|
155
167
|
export { DocumentationLegacyItemConfiguration } from "./model/documentation/configuration/SDKDocumentationLegacyItemConfiguration";
|
|
156
168
|
export { DocumentationLegacyConfiguration } from "./model/documentation/SDKDocumentationLegacyConfiguration";
|
|
157
169
|
export { DocumentationLegacyGroup } from "./model/documentation/SDKDocumentationLegacyGroup";
|
|
170
|
+
export type { DocumentationLegacyGroupModel } from "./model/documentation/SDKDocumentationLegacyGroup";
|
|
171
|
+
export type { DocumentationLegacyPageModel } from "./model/documentation/SDKDocumentationLegacyPage";
|
|
158
172
|
export { DocumentationLegacyItem } from "./model/documentation/SDKDocumentationLegacyItem";
|
|
159
173
|
export { DocumentationLegacyPage } from "./model/documentation/SDKDocumentationLegacyPage";
|
|
160
174
|
export { DocumentationLegacyPageBlock } from "./model/documentation/SDKDocumentationLegacyPageBlock";
|
|
@@ -180,7 +194,7 @@ export { DocumentationLegacyPageAssetType } from "./model/enums/SDKDocumentation
|
|
|
180
194
|
export { DocumentationLegacyPageBlockType } from "./model/enums/SDKDocumentationLegacyPageBlockType";
|
|
181
195
|
export { DocumentationLegacyPageBlockThemeType } from "./model/enums/SDKDocumentationLegacyPageBlockThemeType";
|
|
182
196
|
export { DocsBlockBehaviorDataType } from "./model/enums/SDKDocsBlockBehaviorDataType";
|
|
183
|
-
export {
|
|
197
|
+
export { DocsBlockContainerSize } from "./model/enums/SDKDocsBlockContainerSize";
|
|
184
198
|
export { DocsBlockBehaviorSelectionType } from "./model/enums/SDKDocsBlockBehaviorSelectionType";
|
|
185
199
|
export { DocsBlockImagePropertyAspectRatio } from "./model/enums/SDKDocsBlockImagePropertyAspectRatio";
|
|
186
200
|
export { DocsBlockItemEntityType } from "./model/enums/SDKDocsBlockItemEntityType";
|
|
@@ -199,6 +213,8 @@ export { DocsEntityType } from "./model/enums/SDKDocsEntityType";
|
|
|
199
213
|
export { DocsSectionType } from "./model/enums/SDKDocsSectionType";
|
|
200
214
|
export { SourceType } from "./model/enums/SDKSourceType";
|
|
201
215
|
export { DocsBlockImagePropertyWidth } from "./model/enums/SDKDocsBlockImagePropertyWidth";
|
|
216
|
+
export { DocsPublishStatus } from "./model/enums/SDKDocsPublishStatus";
|
|
217
|
+
export { DocumentationEnvironment } from "./model/enums/SDKDocumentationEnvironment";
|
|
202
218
|
export { FrameAlignment } from "./model/enums/SDKFrameAlignment";
|
|
203
219
|
export { FrameLayout } from "./model/enums/SDKFrameLayout";
|
|
204
220
|
export { GradientType } from "./model/enums/SDKGradientType";
|
|
@@ -249,9 +265,10 @@ export { TextCaseToken } from "./model/tokens/SDKTextCaseToken";
|
|
|
249
265
|
export { TextDecorationToken } from "./model/tokens/SDKTextDecorationToken";
|
|
250
266
|
export { VisibilityToken } from "./model/tokens/SDKVisibilityToken";
|
|
251
267
|
export { Token } from "./model/tokens/SDKToken";
|
|
252
|
-
export type { AnyToken, AnyTokenValue, BlurTokenValue, BorderTokenValue, ColorTokenValue, GradientStopValue, GradientTokenValue, ShadowTokenValue, StringTokenValue, ProductCopyTokenValue, AnyStringTokenValue, TokenValue, TextCaseTokenValue, TextDecorationTokenValue, VisibilityTokenValue, TypographyTokenValue, DimensionTokenValue, SizeTokenValue, SpaceTokenValue, OpacityTokenValue, FontSizeTokenValue, LineHeightTokenValue, LetterSpacingTokenValue, ParagraphSpacingTokenValue, BorderWidthTokenValue, RadiusTokenValue, DurationTokenValue, ZIndexTokenValue, AnyDimensionTokenValue, } from "./model/tokens/SDKTokenValue";
|
|
268
|
+
export type { AnyToken, AnyTokenValue, BlurTokenValue, BorderTokenValue, ColorTokenValue, GradientStopValue, GradientTokenValue, ShadowTokenValue, StringTokenValue, ProductCopyTokenValue, AnyStringTokenValue, TokenValue, TextCaseTokenValue, TextDecorationTokenValue, VisibilityTokenValue, TypographyTokenValue, FontFamilyTokenValue, FontWeightTokenValue, DimensionTokenValue, SizeTokenValue, SpaceTokenValue, OpacityTokenValue, FontSizeTokenValue, LineHeightTokenValue, LetterSpacingTokenValue, ParagraphSpacingTokenValue, BorderWidthTokenValue, RadiusTokenValue, DurationTokenValue, ZIndexTokenValue, AnyDimensionTokenValue, } from "./model/tokens/SDKTokenValue";
|
|
253
269
|
export { TokenTheme } from "./model/themes/SDKTokenTheme";
|
|
254
270
|
export { TokenThemeOverride } from "./model/themes/SDKTokenThemeOverride";
|
|
271
|
+
export type { TokenThemeOverrideTranserObject } from "./model/themes/SDKTokenThemeOverride";
|
|
255
272
|
export { TokenUtilPreviewGenerator } from "./tools/token-preview/TokenUtilPreviewGenerator";
|
|
256
273
|
export { TokenJSONBuilder, JSONBuilderNamingOption, } from "./tools/json-builder/SDKToolsJSONBuilder";
|
|
257
274
|
export type { DTProcessedTokenNode } from "./tools/design-tokens/utilities/SDKDTJSONConverter";
|
|
@@ -271,3 +288,4 @@ export type { RemoteVersionIdentifier, RemoteBrandIdentifier, RemoteWorkspaceVer
|
|
|
271
288
|
export type { TokenUtilPreviewReferenceInfo, TokenUtilPreviewReferenceInfoPiece, } from "./tools/token-preview/TokenUtilPreviewTypes";
|
|
272
289
|
export type { OutputBinaryFile, OutputTextFile, OutputCopyRemoteURLFile, AnyOutputFile, PulsarContext, } from "./pulsar-interfaces";
|
|
273
290
|
export { OutputFileType, PulsarExecutor } from "./pulsar-interfaces";
|
|
291
|
+
export { docsImageRefToUrl } from "./model/docs/blocks/support/SDKDocsImageRef";
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { Source, SourceRemoteModel, SourceTransportModel } from "../support/SDKSource";
|
|
2
1
|
export type DesignSystemSwitcher = {
|
|
3
2
|
isEnabled: boolean;
|
|
4
3
|
designSystemIds: Array<string>;
|
|
@@ -10,7 +9,6 @@ export type DesignSystemRemoteModel = {
|
|
|
10
9
|
description: string;
|
|
11
10
|
};
|
|
12
11
|
workspaceId: string;
|
|
13
|
-
sources: Array<SourceRemoteModel>;
|
|
14
12
|
isPublic: boolean;
|
|
15
13
|
isMultibrand: boolean;
|
|
16
14
|
docSlug: string;
|
|
@@ -18,9 +16,7 @@ export type DesignSystemRemoteModel = {
|
|
|
18
16
|
docExporterId: string;
|
|
19
17
|
designSystemSwitcher: DesignSystemSwitcher;
|
|
20
18
|
};
|
|
21
|
-
export type DesignSystemTransportModel = Pick<DesignSystem, "id" | "name" | "description" | "isPublic" | "isMultiBrand" | "documentationSlug" | "documentationUserSlug" | "documentationExporterId" | "designSystemSwitcher" | "workspaceId"
|
|
22
|
-
sources: Array<SourceTransportModel>;
|
|
23
|
-
};
|
|
19
|
+
export type DesignSystemTransportModel = Pick<DesignSystem, "id" | "name" | "description" | "isPublic" | "isMultiBrand" | "documentationSlug" | "documentationUserSlug" | "documentationExporterId" | "designSystemSwitcher" | "workspaceId">;
|
|
24
20
|
export declare class DesignSystem {
|
|
25
21
|
/** Unique identifier of design system */
|
|
26
22
|
id: string;
|
|
@@ -42,8 +38,6 @@ export declare class DesignSystem {
|
|
|
42
38
|
documentationUserSlug: string | null;
|
|
43
39
|
/** Binding multiple design systems together */
|
|
44
40
|
designSystemSwitcher: DesignSystemSwitcher;
|
|
45
|
-
/** Data sources linked with this design system */
|
|
46
|
-
sources: Array<Source>;
|
|
47
41
|
constructor(model: DesignSystemRemoteModel);
|
|
48
42
|
/** Constructs representation that can be used to write full object to remote */
|
|
49
43
|
toRemote(): DesignSystemRemoteModel;
|
|
@@ -1,16 +1,7 @@
|
|
|
1
|
+
import { PageBlockDefinitionBehavior } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockBehaviorDataType } from "../../../enums/SDKDocsBlockBehaviorDataType";
|
|
2
3
|
import { DocsBlockBehaviorSelectionType } from "../../../enums/SDKDocsBlockBehaviorSelectionType";
|
|
3
|
-
export type DocsBlockBehaviorModel =
|
|
4
|
-
dataType: DocsBlockBehaviorDataType;
|
|
5
|
-
items?: {
|
|
6
|
-
numberOfItems?: number;
|
|
7
|
-
allowLinks?: boolean;
|
|
8
|
-
};
|
|
9
|
-
entities?: {
|
|
10
|
-
selectionType: DocsBlockBehaviorSelectionType;
|
|
11
|
-
maxSelected?: number;
|
|
12
|
-
};
|
|
13
|
-
};
|
|
4
|
+
export type DocsBlockBehaviorModel = PageBlockDefinitionBehavior;
|
|
14
5
|
export declare class DocsBlockBehavior {
|
|
15
6
|
/** Defines what data block uses, and generates */
|
|
16
7
|
dataType: DocsBlockBehaviorDataType;
|
|
@@ -1,27 +1,10 @@
|
|
|
1
|
+
import { PageBlockDefinition } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockMode } from "../../../enums/SDKDocBlockMode";
|
|
2
3
|
import { DocsBlockCategory } from "../../../enums/SDKDocsBlockCategory";
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
6
|
-
|
|
7
|
-
export type DocsBlockDefinitionModel = {
|
|
8
|
-
id: string;
|
|
9
|
-
name: string;
|
|
10
|
-
description: string;
|
|
11
|
-
category: DocsBlockCategory;
|
|
12
|
-
icon?: DocsImageRef;
|
|
13
|
-
documentationLink?: string;
|
|
14
|
-
searchKeywords?: Array<string>;
|
|
15
|
-
item: DocsBlockItemDefinitionModel;
|
|
16
|
-
behavior: DocsBlockBehaviorModel;
|
|
17
|
-
editorOptions?: {
|
|
18
|
-
onboarding?: DocsBlockOnboardingModel;
|
|
19
|
-
};
|
|
20
|
-
appearance?: {
|
|
21
|
-
isBordered?: boolean;
|
|
22
|
-
hasBackground?: boolean;
|
|
23
|
-
};
|
|
24
|
-
};
|
|
4
|
+
import { DocsBlockBehavior } from "./SDKDocsBlockBehavior";
|
|
5
|
+
import { DocsBlockItemDefinition } from "./SDKDocsBlockItemDefinition";
|
|
6
|
+
import { DocsBlockOnboarding } from "./SDKDocsBlockOnboarding";
|
|
7
|
+
export type DocsBlockDefinitionModel = PageBlockDefinition;
|
|
25
8
|
export declare class DocsBlockDefinition {
|
|
26
9
|
/** Unique id of the block. Block id must be unique across all blocks registered to Supernova in preparation for block store. Reserved ids will be created for all core blocks and they'll be installed by default to every exporter */
|
|
27
10
|
id: string;
|
|
@@ -32,7 +15,7 @@ export declare class DocsBlockDefinition {
|
|
|
32
15
|
/** Block category */
|
|
33
16
|
category: DocsBlockCategory;
|
|
34
17
|
/** Block icon filename */
|
|
35
|
-
icon:
|
|
18
|
+
icon: string | null;
|
|
36
19
|
/** Link to documentation or resource explaining the behavior of the block and its options */
|
|
37
20
|
documentationLink: string | null;
|
|
38
21
|
searchKeywords: Array<string>;
|
|
@@ -51,7 +34,14 @@ export declare class DocsBlockDefinition {
|
|
|
51
34
|
isBordered: boolean;
|
|
52
35
|
/** When background option is enabled, background color can be set for the block */
|
|
53
36
|
hasBackground: boolean;
|
|
37
|
+
/** When editor presentation is different, the block will render differently in editor than in the final output */
|
|
38
|
+
isEditorPresentationDifferent: boolean;
|
|
39
|
+
/** When enabled, the header with block name, description, and header will be displayed
|
|
40
|
+
* Use only for custom blocks that don't have a good content do be displayed in the editor (e.g. Release notes, Lottie, etc.)
|
|
41
|
+
* */
|
|
42
|
+
showBlockHeaderInEditor: boolean;
|
|
54
43
|
};
|
|
55
44
|
constructor(model: DocsBlockDefinitionModel);
|
|
56
45
|
get blockMode(): DocsBlockMode;
|
|
46
|
+
toRemote(): DocsBlockDefinitionModel;
|
|
57
47
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockItemDefinition.d.ts
CHANGED
|
@@ -1,14 +1,7 @@
|
|
|
1
|
+
import { PageBlockDefinitionItem } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockItemPropertyAnyDefinition } from "../properties/SDKDocsBlockProperty";
|
|
2
|
-
import { DocsBlockVariant
|
|
3
|
-
export type DocsBlockItemDefinitionModel =
|
|
4
|
-
properties: Array<DocsBlockItemPropertyAnyDefinition>;
|
|
5
|
-
appearance?: {
|
|
6
|
-
isBordered?: boolean;
|
|
7
|
-
hasBackground?: boolean;
|
|
8
|
-
};
|
|
9
|
-
variants: Array<DocsBlockVariantModel>;
|
|
10
|
-
defaultVariantKey: string;
|
|
11
|
-
};
|
|
3
|
+
import { DocsBlockVariant } from "./SDKDocsBlockVariant";
|
|
4
|
+
export type DocsBlockItemDefinitionModel = PageBlockDefinitionItem;
|
|
12
5
|
export declare class DocsBlockItemDefinition {
|
|
13
6
|
/** All properties that user can potentially input via one block / item */
|
|
14
7
|
properties: Array<DocsBlockItemPropertyAnyDefinition>;
|
|
@@ -1,14 +1,9 @@
|
|
|
1
|
+
import { PageBlockDefinitionLayout } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockItemVariantLayoutAlign } from "../../../enums/SDKDocsBlockItemVariantLayoutAlign";
|
|
2
3
|
import { DocsBlockItemVariantLayoutColumnResizing } from "../../../enums/SDKDocsBlockItemVariantLayoutColumnResizing";
|
|
3
4
|
import { DocsBlockItemVariantLayoutGap } from "../../../enums/SDKDocsBlockItemVariantLayoutGap";
|
|
4
5
|
import { DocsBlockItemVariantLayoutType } from "../../../enums/SDKDocsBlockItemVariantLayoutType";
|
|
5
|
-
export type DocsBlockLayoutModel =
|
|
6
|
-
type: DocsBlockItemVariantLayoutType;
|
|
7
|
-
children: Array<DocsBlockLayoutModel | string>;
|
|
8
|
-
gap?: DocsBlockItemVariantLayoutGap;
|
|
9
|
-
columnAlign?: DocsBlockItemVariantLayoutAlign;
|
|
10
|
-
columnResizing?: DocsBlockItemVariantLayoutColumnResizing;
|
|
11
|
-
};
|
|
6
|
+
export type DocsBlockLayoutModel = PageBlockDefinitionLayout;
|
|
12
7
|
export declare class DocsBlockLayout {
|
|
13
8
|
/** Type of a single node of the layout, either column for stacking vertically, or row for stacking horizontally */
|
|
14
9
|
type: DocsBlockItemVariantLayoutType;
|
|
@@ -1,19 +1,6 @@
|
|
|
1
|
+
import { PageBlockDefinitionVariant } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockLayout } from "./SDKDocsBlockLayout";
|
|
2
|
-
export type DocsBlockVariantModel =
|
|
3
|
-
id: string;
|
|
4
|
-
name: string;
|
|
5
|
-
image: string;
|
|
6
|
-
description?: string;
|
|
7
|
-
documentationLink?: string;
|
|
8
|
-
layout: DocsBlockLayout;
|
|
9
|
-
maxColumns?: number;
|
|
10
|
-
defaultColumns?: number;
|
|
11
|
-
appearance?: {
|
|
12
|
-
isBordered?: boolean;
|
|
13
|
-
hasBackground?: boolean;
|
|
14
|
-
isEditorPresentationDifferent?: boolean;
|
|
15
|
-
};
|
|
16
|
-
};
|
|
3
|
+
export type DocsBlockVariantModel = PageBlockDefinitionVariant;
|
|
17
4
|
export declare class DocsBlockVariant {
|
|
18
5
|
/** Variant id, validated to be unique within a block, but not necessarily unique across all blocks */
|
|
19
6
|
id: string;
|
|
@@ -34,11 +21,15 @@ export declare class DocsBlockVariant {
|
|
|
34
21
|
/** Same appearance options that item has. When any appearance option is set on the level of variant, appearance is overriden, otherwise base item appearance is taken */
|
|
35
22
|
appearance: {
|
|
36
23
|
/** With border enabled, a light border will be rendered in editor around the item. For example, shortcuts or assets have this enabled */
|
|
37
|
-
isBordered
|
|
24
|
+
isBordered?: boolean;
|
|
38
25
|
/** When background option is enabled, background color can be set for the item */
|
|
39
|
-
hasBackground
|
|
26
|
+
hasBackground?: boolean;
|
|
40
27
|
/** When enabled, signifies that variants renders differently in the editor and in the published version */
|
|
41
|
-
isEditorPresentationDifferent
|
|
28
|
+
isEditorPresentationDifferent?: boolean;
|
|
29
|
+
/** When enabled, the header with block name, description, and header will be displayed
|
|
30
|
+
* Use only for custom blocks that don't have a good content do be displayed in the editor (e.g. Release notes, Lottie, etc.)
|
|
31
|
+
* */
|
|
32
|
+
showBlockHeaderInEditor?: boolean;
|
|
42
33
|
};
|
|
43
34
|
constructor(model: DocsBlockVariantModel);
|
|
44
35
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts
CHANGED
|
@@ -1,21 +1,25 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DocsBlockContainerSize } from "../../../enums/SDKDocsBlockContainerSize";
|
|
2
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
|
+
import { DocsColorRef } from "../support/SDKDocsColorRef";
|
|
3
4
|
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
5
|
/** Asset property - Additional non-value options */
|
|
5
6
|
export type DocsBlockAssetPropertyOptions = Record<string, never>;
|
|
6
7
|
/** Asset property - Data */
|
|
7
8
|
export type DocsBlockAssetPropertyData = DocsBlockPropertyData<Array<{
|
|
8
9
|
entityId: string;
|
|
9
|
-
entityType: "
|
|
10
|
+
entityType: "Asset" | "AssetGroup";
|
|
11
|
+
entityMeta?: {
|
|
12
|
+
title?: string;
|
|
13
|
+
description?: string;
|
|
14
|
+
backgroundColor?: DocsColorRef | null;
|
|
15
|
+
};
|
|
10
16
|
}>> & {
|
|
11
17
|
/** Selected asset ids */
|
|
12
18
|
selectedPropertyIds?: Array<string>;
|
|
13
19
|
/** If enabled, search is visible */
|
|
14
20
|
showSearch?: boolean;
|
|
15
21
|
/** Preview container size */
|
|
16
|
-
previewContainerSize?:
|
|
17
|
-
/** If enabled, each assets uses this for background */
|
|
18
|
-
backgroundColor?: string;
|
|
22
|
+
previewContainerSize?: DocsBlockContainerSize.centered | DocsBlockContainerSize.naturalHeight;
|
|
19
23
|
};
|
|
20
24
|
/** Asset property - Definition model */
|
|
21
25
|
export type DocsBlockAssetPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockAssetPropertyOptions;
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ export type DocsBlockBooleanPropertyOptions = {
|
|
|
6
6
|
/** Default value to set when block is created */
|
|
7
7
|
defaultValue?: boolean;
|
|
8
8
|
/** Visual representation of the property */
|
|
9
|
-
|
|
9
|
+
booleanStyle?: Exclude<DocsBlockItemPropertyOptionRenderingStyle, DocsBlockItemPropertyOptionRenderingStyle.select>;
|
|
10
10
|
};
|
|
11
11
|
/** Boolean property - Data */
|
|
12
12
|
export type DocsBlockBooleanPropertyData = DocsBlockPropertyData<boolean> & Record<string, never>;
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts
CHANGED
|
@@ -3,13 +3,15 @@ import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBloc
|
|
|
3
3
|
/** Code Sandbox property - Additional non-value options */
|
|
4
4
|
export type DocsBlockCodeSandboxPropertyOptions = {
|
|
5
5
|
/** How should we render the code example in editor */
|
|
6
|
-
renderLayoutAs?: "
|
|
6
|
+
renderLayoutAs?: "PreviewOnTop" | "PreviewOnBottom" | "PreviewOnLeft" | "PreviewOnRight";
|
|
7
7
|
};
|
|
8
8
|
/** Code Sandbox property - Data */
|
|
9
9
|
export type DocsBlockCodeSandboxPropertyData = DocsBlockPropertyData<string> & {
|
|
10
10
|
showCode?: boolean;
|
|
11
|
+
showControls?: boolean;
|
|
11
12
|
backgroundColor?: string;
|
|
12
|
-
alignPreview?: "
|
|
13
|
+
alignPreview?: "Left" | "Center";
|
|
14
|
+
previewHeight?: number;
|
|
13
15
|
};
|
|
14
16
|
/** Code Sandbox property - Definition model */
|
|
15
17
|
export type DocsBlockCodeSandboxPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockCodeSandboxPropertyOptions;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { ColorTokenValue } from "../../../tokens/SDKTokenValue";
|
|
3
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
|
+
/** Color property - Additional non-value options */
|
|
5
|
+
export type DocsBlockColorPropertyOptions = Record<string, never>;
|
|
6
|
+
/** Color property - Data */
|
|
7
|
+
export type DocsBlockColorPropertyData = DocsBlockPropertyData<ColorTokenValue> & Record<string, never>;
|
|
8
|
+
/** Color property - Definition model */
|
|
9
|
+
export type DocsBlockColorPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockColorPropertyOptions;
|
|
10
|
+
/** Color property - Definition */
|
|
11
|
+
export declare class DocsBlockColorPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockColorPropertyOptions, DocsBlockColorPropertyData> {
|
|
12
|
+
type: DocsBlockItemPropertyType.color;
|
|
13
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts
CHANGED
|
@@ -3,14 +3,14 @@ import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDe
|
|
|
3
3
|
/** Component property - Additional non-value options */
|
|
4
4
|
export type DocsBlockComponentPropertyOptions = {
|
|
5
5
|
/** How should the tokens be rendered in editor */
|
|
6
|
-
renderLayoutAs?: "
|
|
6
|
+
renderLayoutAs?: "List" | "Table";
|
|
7
7
|
/** Whether to allow selecting component custom properties. True by default */
|
|
8
8
|
allowPropertySelection?: boolean;
|
|
9
9
|
};
|
|
10
10
|
/** Component property - Data */
|
|
11
11
|
export type DocsBlockComponentPropertyData = DocsBlockPropertyData<Array<{
|
|
12
12
|
entityId: string;
|
|
13
|
-
entityType: "
|
|
13
|
+
entityType: "Component" | "ComponentGroup";
|
|
14
14
|
}>> & {
|
|
15
15
|
/** Selected component ids */
|
|
16
16
|
selectedPropertyIds?: Array<string>;
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts
CHANGED
|
@@ -12,7 +12,8 @@ export type DocsBlockEmbedUrlPropertyOptions = {
|
|
|
12
12
|
urlValidationRegex?: string;
|
|
13
13
|
};
|
|
14
14
|
/** EmbedUrl property - Data */
|
|
15
|
-
export type DocsBlockEmbedUrlPropertyData = DocsBlockPropertyData<string> & {
|
|
15
|
+
export type DocsBlockEmbedUrlPropertyData = DocsBlockPropertyData<string | undefined> & {
|
|
16
|
+
alt?: string;
|
|
16
17
|
caption?: string;
|
|
17
18
|
height?: number;
|
|
18
19
|
};
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockFigmaNodeProperty.d.ts
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { DocsBlockContainerSize } from "../../../enums/SDKDocsBlockContainerSize";
|
|
2
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
|
+
import { DocsColorRef } from "../support/SDKDocsColorRef";
|
|
4
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
5
|
+
/** FigmaNode property - Additional non-value options */
|
|
6
|
+
export type DocsBlockFigmaNodePropertyOptions = Record<string, never>;
|
|
7
|
+
/** FigmaNode property - Data */
|
|
8
|
+
export type DocsBlockFigmaNodePropertyData = DocsBlockPropertyData<Array<{
|
|
9
|
+
entityId: string;
|
|
10
|
+
entityMeta?: {
|
|
11
|
+
title?: string;
|
|
12
|
+
description?: string;
|
|
13
|
+
backgroundColor?: DocsColorRef | null;
|
|
14
|
+
};
|
|
15
|
+
}>> & {
|
|
16
|
+
/** Behavior of container size */
|
|
17
|
+
previewContainerSize?: DocsBlockContainerSize.centered | DocsBlockContainerSize.naturalHeight;
|
|
18
|
+
/** If enabled, search is visible */
|
|
19
|
+
showSearch?: boolean;
|
|
20
|
+
/** Number of columns */
|
|
21
|
+
columns?: number;
|
|
22
|
+
/** Shows details of each frame, or hides them all */
|
|
23
|
+
showFrameDetails?: boolean;
|
|
24
|
+
};
|
|
25
|
+
/** FigmaNode property - Definition model */
|
|
26
|
+
export type DocsBlockFigmaNodePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockFigmaNodePropertyOptions;
|
|
27
|
+
/** FigmaNode property - Definition */
|
|
28
|
+
export declare class DocsBlockFigmaNodePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockFigmaNodePropertyOptions, DocsBlockFigmaNodePropertyData> {
|
|
29
|
+
type: DocsBlockItemPropertyType.figmaNode;
|
|
30
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMarkdownProperty.d.ts
CHANGED
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
2
|
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
3
|
/** Markdown property - Additional non-value options */
|
|
4
|
-
export type DocsBlockMarkdownPropertyOptions =
|
|
4
|
+
export type DocsBlockMarkdownPropertyOptions = {
|
|
5
|
+
/** Defines how to validate the markdown URL */
|
|
6
|
+
urlValidationRegex?: string;
|
|
7
|
+
};
|
|
5
8
|
/** Markdown property - Data */
|
|
6
9
|
export type DocsBlockMarkdownPropertyData = DocsBlockPropertyData<string> & Record<string, never>;
|
|
7
10
|
/** Markdown property - Definition model */
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty.d.ts
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { DocumentationLegacyRichTextModel } from "../../../documentation/SDKDocumentationLegacyRichText";
|
|
2
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
|
+
import { DocsBlockMultiRichTextPropertyStyle } from "../../../enums/SDKDocsBlockMultiRichTextPropertyStyle";
|
|
4
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
5
|
+
/** RichText property - Additional non-value options */
|
|
6
|
+
export type DocsBlockMultiRichTextPropertyOptions = {
|
|
7
|
+
/** Placeholder to show when rich text area is empty */
|
|
8
|
+
placeholder?: string;
|
|
9
|
+
/** Visual style of the rich text property */
|
|
10
|
+
multiRichTextStyle?: DocsBlockMultiRichTextPropertyStyle;
|
|
11
|
+
};
|
|
12
|
+
/** RichText property - Data */
|
|
13
|
+
export type DocsBlockMultiRichTextPropertyData = DocsBlockPropertyData<Array<DocumentationLegacyRichTextModel>>;
|
|
14
|
+
/** RichText property - Definition model */
|
|
15
|
+
export type DocsBlockRichTextPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockMultiRichTextPropertyOptions;
|
|
16
|
+
/** RichText property - Definition */
|
|
17
|
+
export declare class DocsBlockMultiRichTextPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockMultiRichTextPropertyOptions, DocsBlockMultiRichTextPropertyData> {
|
|
18
|
+
type: DocsBlockItemPropertyType.multiRichText;
|
|
19
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty.d.ts
CHANGED
|
@@ -9,7 +9,7 @@ export type DocsBlockMultiSelectPropertyOptions = {
|
|
|
9
9
|
name: string;
|
|
10
10
|
icon?: string;
|
|
11
11
|
}>;
|
|
12
|
-
|
|
12
|
+
multiSelectStyle?: Exclude<DocsBlockOptionRenderingStyle, DocsBlockOptionRenderingStyle.toggleButton>;
|
|
13
13
|
};
|
|
14
14
|
/** MultiSelect property - Data */
|
|
15
15
|
export type DocsBlockMultiSelectPropertyData = DocsBlockPropertyData<Array<string>> & Record<string, never>;
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockNumberProperty.d.ts
CHANGED
|
@@ -5,11 +5,11 @@ export type DocsBlockNumberPropertyOptions = {
|
|
|
5
5
|
/** Default value to set when block is created */
|
|
6
6
|
defaultValue: number;
|
|
7
7
|
/** Minimum value */
|
|
8
|
-
min
|
|
8
|
+
min?: number;
|
|
9
9
|
/** Maximum value */
|
|
10
|
-
max
|
|
10
|
+
max?: number;
|
|
11
11
|
/** Step value */
|
|
12
|
-
step
|
|
12
|
+
step?: number;
|
|
13
13
|
/** Field placeholder */
|
|
14
14
|
placeholder?: string;
|
|
15
15
|
};
|
|
@@ -1,14 +1,6 @@
|
|
|
1
|
+
import { PageBlockDefinitionProperty } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
-
export type DocsBlockPropertyDefinitionModel =
|
|
3
|
-
id: string;
|
|
4
|
-
name: string;
|
|
5
|
-
type: DocsBlockItemPropertyType;
|
|
6
|
-
description?: string;
|
|
7
|
-
options?: object | Record<string, never>;
|
|
8
|
-
variantOptions?: {
|
|
9
|
-
[key: string]: object | Record<string, never>;
|
|
10
|
-
};
|
|
11
|
-
};
|
|
3
|
+
export type DocsBlockPropertyDefinitionModel = PageBlockDefinitionProperty;
|
|
12
4
|
export type DocsBlockPropertyData<T> = {
|
|
13
5
|
value: T;
|
|
14
6
|
};
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DocumentationLegacyRichTextModel } from "../../../documentation/SDKDocumentationLegacyRichText";
|
|
2
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
3
|
import { DocsBlockRichTextPropertyStyle } from "../../../enums/SDKDocsBlockRichTextPropertyStyle";
|
|
4
4
|
import { DocumentationLegacyCalloutType } from "../../../enums/SDKDocumentationLegacyCalloutType";
|
|
@@ -8,10 +8,10 @@ export type DocsBlockRichTextPropertyOptions = {
|
|
|
8
8
|
/** Placeholder to show when rich text area is empty */
|
|
9
9
|
placeholder?: string;
|
|
10
10
|
/** Visual style of the rich text property */
|
|
11
|
-
|
|
11
|
+
richTextStyle?: DocsBlockRichTextPropertyStyle;
|
|
12
12
|
};
|
|
13
13
|
/** RichText property - Data */
|
|
14
|
-
export type DocsBlockRichTextPropertyData = DocsBlockPropertyData<
|
|
14
|
+
export type DocsBlockRichTextPropertyData = DocsBlockPropertyData<DocumentationLegacyRichTextModel> & {
|
|
15
15
|
/** Selected token ids */
|
|
16
16
|
calloutType?: DocumentationLegacyCalloutType;
|
|
17
17
|
};
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts
CHANGED
|
@@ -15,7 +15,7 @@ export type DocsBlockSingleSelectPropertyOptions = {
|
|
|
15
15
|
icon?: string;
|
|
16
16
|
}>;
|
|
17
17
|
/** Visual representation of the property */
|
|
18
|
-
|
|
18
|
+
singleSelectStyle?: DocsBlockOptionRenderingStyle;
|
|
19
19
|
};
|
|
20
20
|
/** SingleSelect property - Data */
|
|
21
21
|
export type DocsBlockSingleSelectPropertyData = DocsBlockPropertyData<string> & Record<string, never>;
|