@supernova-studio/supernova-sdk-beta 1.6.21 → 1.6.23
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/README.md +1 -10
- package/build/sdk-typescript/src/core/areas/SDKAreaDataSources.d.ts +3 -3
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +20 -28
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +9 -7
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +8 -7
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +1 -0
- package/build/sdk-typescript/src/core/resolvers/SDKDocumentationItemResolver.d.ts +10 -10
- package/build/sdk-typescript/src/exports.d.ts +103 -52
- package/build/sdk-typescript/src/model/base/SDKDesignSystem.d.ts +2 -2
- package/build/sdk-typescript/src/model/base/SDKDocumentationLegacy.d.ts +10 -0
- package/build/sdk-typescript/src/model/docs/SDKDocsConfiguration.d.ts +13 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockBehavior.d.ts +45 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockDefinition.d.ts +55 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockItem.d.ts +27 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockLayout.d.ts +16 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockOnboarding.d.ts +11 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockVariant.d.ts +41 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/blockquote/SDKDocsBlockActualBlockquote.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/callout/SDKDocsBlockActualCallout.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/color-accessibility-grid/SDKDocsBlockActualAccessibilityGrid.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/divider/SDKDocsBlockActualDivider.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/h1/SDKDocsBlockActualH1.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/h2/SDKDocsBlockActualH2.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/h3/SDKDocsBlockActualH3.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/h4/SDKDocsBlockActualH4.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/h5/SDKDocsBlockActualH5.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/image/SDKDocsBlockActualImage.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/links/SDKDocsBlockActualLinks.d.ts +8 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/ordered-list/SDKDocsBlockActualOrderedList.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/rich-text/SDKDocsBlockActualRichText.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/unordered-list/SDKDocsBlockActualUnorderedList.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetPropertyProperty.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts +12 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeProperty.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentPropertyProperty.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockDividerProperty.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedFrameProperty.d.ts +9 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts +9 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockImageProperty.d.ts +13 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMarkdownProperty.d.ts +11 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty.d.ts +20 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockNumberProperty.d.ts +15 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockProperty.d.ts +34 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts +18 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts +26 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTableProperty.d.ts +11 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +19 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +15 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenPropertyProperty.d.ts +11 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty.d.ts +11 -0
- package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsColorRef.d.ts +3 -0
- package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsImageRef.d.ts +21 -0
- package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsLinkRef.d.ts +21 -0
- package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsSizeRef.d.ts +8 -0
- package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlock.d.ts +57 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntity.d.ts +27 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityConfiguration.d.ts +10 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityGroup.d.ts +29 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityHeader.d.ts +23 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityPage.d.ts +25 -0
- package/build/sdk-typescript/src/model/docs/sections/SDKDocsSection.d.ts +47 -0
- package/build/sdk-typescript/src/model/docs/sections/SDKDocsSectionColumn.d.ts +15 -0
- package/build/sdk-typescript/src/model/docs/sections/SDKDocsSectionItem.d.ts +15 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyConfiguration.d.ts +13 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyGroup.d.ts +38 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyItem.d.ts +26 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPage.d.ts +32 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageAsset.d.ts +15 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageBlock.d.ts +30 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyRichText.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyRichTextSpan.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyRichTextSpanAttribute.d.ts +14 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockAsset.d.ts +15 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockAssets.d.ts +22 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockCallout.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockCode.d.ts +11 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockColumn.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockColumnItem.d.ts +9 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockCustom.d.ts +15 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockDivider.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedFigma.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedGeneric.d.ts +13 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedLink.d.ts +15 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedStorybook.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedYoutube.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockFrame.d.ts +18 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockFrames.d.ts +24 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockHeading.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockImage.d.ts +16 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockOrderedList.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockQuote.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockRenderCode.d.ts +33 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockShortcut.d.ts +35 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockShortcuts.d.ts +9 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTab.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTabItem.d.ts +8 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTable.d.ts +21 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTableCell.d.ts +11 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTableColumn.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTableRow.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockText.d.ts +11 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockToken.d.ts +8 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTokenGroup.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTokenList.d.ts +8 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockUnorderedList.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/builder/SDKDocumentationLegacyBlockBuilder.d.ts +6 -0
- package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationLegacyItemConfiguration.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationLegacyItemHeader.d.ts +30 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockBehaviorDataType.d.ts +10 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockBehaviorSelectionType.d.ts +8 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockCategory.d.ts +20 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockImagePropertyAspectRatio.d.ts +10 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemEntityType.d.ts +14 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyOptionRenderingStyle.d.ts +10 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyRichTextStyle.d.ts +20 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyTextStyle.d.ts +8 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +48 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutType.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutWidth.d.ts +26 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockOptionRenderStyle.d.ts +10 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockRichTextPropertyStyle.d.ts +22 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockTextPropertyStyle.d.ts +8 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsEntityGroupBehavior.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsEntityType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsSectionType.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyCalloutType.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyGroupBehavior.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyHeadingType.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyItemType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyPageAssetType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyPageBlockThemeType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyPageBlockType.d.ts +31 -0
- package/build/sdk-typescript/src/model/exporters/SDKExporter.d.ts +2 -2
- package/build/sdk-typescript/src/model/jobs/SDKImportJob.d.ts +5 -1
- package/build/sdk-typescript/src/model/support/SDKSource.d.ts +1 -0
- package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +2 -0
- package/build/sdk-typescript/src/tests/validators.d.ts +1 -0
- package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +335 -0
- package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransform.d.ts +4 -4
- package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformBlock.d.ts +56 -56
- package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformUtil.d.ts +4 -4
- package/build/sdk-typescript/src/tools/search-index/SDKToolsDocSearch.d.ts +2 -2
- package/build/sdk-typescript/src/utils/DocumentationUtils.d.ts +2 -0
- package/build/supernova-sdk-typescript.js +2 -67144
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +1 -1
- package/build/sdk-typescript/src/tests/Enterprise/PluginFigmaTokens.spec.d.ts +0 -1
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyAnyDefinition } from "../properties/SDKDocsBlockProperty";
|
|
2
|
+
import { DocsBlockVariant, DocsBlockVariantModel } from "./SDKDocsBlockVariant";
|
|
3
|
+
export type DocsBlockItemModel = {
|
|
4
|
+
properties: Array<DocsBlockItemPropertyAnyDefinition>;
|
|
5
|
+
appearance?: {
|
|
6
|
+
isBordered?: boolean;
|
|
7
|
+
hasBackground?: boolean;
|
|
8
|
+
};
|
|
9
|
+
variants: Array<DocsBlockVariantModel>;
|
|
10
|
+
defaultVariantKey: string;
|
|
11
|
+
};
|
|
12
|
+
export declare class DocsBlockItem {
|
|
13
|
+
/** All properties that user can potentially input via one block / item */
|
|
14
|
+
properties: Array<DocsBlockItemPropertyAnyDefinition>;
|
|
15
|
+
/** All appearance options for item wrapper */
|
|
16
|
+
appearance: {
|
|
17
|
+
/** With border enabled, a light border will be rendered in editor around the item. For example, shortcuts or assets have this enabled */
|
|
18
|
+
isBordered: boolean;
|
|
19
|
+
/** When background option is enabled, background color can be set for the item */
|
|
20
|
+
hasBackground: boolean;
|
|
21
|
+
};
|
|
22
|
+
/** All variants that editors can select from. Variant primarily declares layout of the block for the editor and what properties can be set for variant */
|
|
23
|
+
variants: Array<DocsBlockVariant>;
|
|
24
|
+
/** Key of the default variant. There must always be at least one variant to point to */
|
|
25
|
+
defaultVariantKey: string;
|
|
26
|
+
constructor(model: DocsBlockItemModel);
|
|
27
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { DocsBlockItemVariantLayoutType } from "../../../enums/SDKDocsBlockItemVariantLayoutType";
|
|
2
|
+
import { DocsBlockItemVariantLayoutWidth } from "../../../enums/SDKDocsBlockItemVariantLayoutWidth";
|
|
3
|
+
export type DocsBlockLayoutModel = {
|
|
4
|
+
type: DocsBlockItemVariantLayoutType;
|
|
5
|
+
children: Array<DocsBlockLayoutModel | string>;
|
|
6
|
+
columnWidth12?: DocsBlockItemVariantLayoutWidth;
|
|
7
|
+
};
|
|
8
|
+
export declare class DocsBlockLayout {
|
|
9
|
+
/** Type of a single node of the layout, either column for stacking vertially, or row for stacking horizontally */
|
|
10
|
+
type: DocsBlockItemVariantLayoutType;
|
|
11
|
+
/** Children of the layout for building nesting layouts or for declaring what all properties should show in a single node, or combination of both */
|
|
12
|
+
children: Array<DocsBlockLayout | string>;
|
|
13
|
+
/** Width of the column (rows ignore this property) */
|
|
14
|
+
columnWidth12?: DocsBlockItemVariantLayoutWidth | null;
|
|
15
|
+
constructor(model: DocsBlockLayoutModel);
|
|
16
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
export type DocsBlockOnboardingModel = {
|
|
2
|
+
helpText: string;
|
|
3
|
+
documentationLink?: string;
|
|
4
|
+
};
|
|
5
|
+
export declare class DocsBlockOnboarding {
|
|
6
|
+
/** Description of the onboarding layer */
|
|
7
|
+
helpText: string;
|
|
8
|
+
/** Link to documentation or resource explaining the behavior of the block and its options */
|
|
9
|
+
documentationLink: string | null;
|
|
10
|
+
constructor(model: DocsBlockOnboardingModel);
|
|
11
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
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
|
+
};
|
|
15
|
+
};
|
|
16
|
+
export declare class DocsBlockVariant {
|
|
17
|
+
/** Variant id, validated to be unique within a block, but not necessarily unique across all blocks */
|
|
18
|
+
id: string;
|
|
19
|
+
/** Variant name that will show in the interface */
|
|
20
|
+
name: string;
|
|
21
|
+
/** Variant image filename */
|
|
22
|
+
image: string;
|
|
23
|
+
/** Variant description that will show in the interface */
|
|
24
|
+
description: string | null;
|
|
25
|
+
/** Link to documentation or resource explaining the behavior of the block and its options */
|
|
26
|
+
documentationLink: string | null;
|
|
27
|
+
/** Variant layout that defines how the variant is presented in the editor */
|
|
28
|
+
layout: DocsBlockLayout;
|
|
29
|
+
/** Maximum of columns that items under this layout can form. Defaults to 1 */
|
|
30
|
+
maxColumns: number;
|
|
31
|
+
/** Default number of columns with which the block will be spawned */
|
|
32
|
+
defaultColumns: number;
|
|
33
|
+
/** 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 */
|
|
34
|
+
appearance: {
|
|
35
|
+
/** With border enabled, a light border will be rendered in editor around the item. For example, shortcuts or assets have this enabled */
|
|
36
|
+
isBordered: boolean;
|
|
37
|
+
/** When background option is enabled, background color can be set for the item */
|
|
38
|
+
hasBackground: boolean;
|
|
39
|
+
};
|
|
40
|
+
constructor(model: DocsBlockVariantModel);
|
|
41
|
+
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
2
|
+
export type DocsBlockAssetPropertyOptions = Record<string, never>;
|
|
3
|
+
export type DocsBlockAssetPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockAssetPropertyOptions;
|
|
4
|
+
/** Asset property */
|
|
5
|
+
export declare class DocsBlockAssetPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockAssetPropertyOptions> {
|
|
6
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetPropertyProperty.d.ts
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
2
|
+
export type DocsBlockAssetPropertyPropertyOptions = Record<string, never>;
|
|
3
|
+
export type DocsBlockAssetPropertyPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockAssetPropertyPropertyOptions;
|
|
4
|
+
/** Asset property */
|
|
5
|
+
export declare class DocsBlockAssetPropertyPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockAssetPropertyPropertyOptions> {
|
|
6
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyOptionRenderingStyle } from "../../../enums/SDKDocsBlockItemPropertyOptionRenderingStyle";
|
|
2
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
export type DocsBlockBooleanPropertyOptions = {
|
|
4
|
+
/** Default value to set when block is created */
|
|
5
|
+
defaultValue?: boolean;
|
|
6
|
+
/** Visual representation of the property */
|
|
7
|
+
style?: Exclude<DocsBlockItemPropertyOptionRenderingStyle, DocsBlockItemPropertyOptionRenderingStyle.select>;
|
|
8
|
+
};
|
|
9
|
+
export type DocsBlockBooleanPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockBooleanPropertyOptions;
|
|
10
|
+
/** Boolean property */
|
|
11
|
+
export declare class DocsBlockBooleanPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockBooleanPropertyOptions> {
|
|
12
|
+
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
2
|
+
export type DocsBlockCodePropertyOptions = Record<string, never>;
|
|
3
|
+
export type DocsBlockCodePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockCodePropertyOptions;
|
|
4
|
+
/** Code property */
|
|
5
|
+
export declare class DocsBlockCodePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockCodePropertyOptions> {
|
|
6
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
2
|
+
export type DocsBlockCodeSandboxPropertyOptions = Record<string, never>;
|
|
3
|
+
export type DocsBlockCodeSandboxPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockCodeSandboxPropertyOptions;
|
|
4
|
+
/** CodeSandbox property */
|
|
5
|
+
export declare class DocsBlockCodeSandboxPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockCodeSandboxPropertyOptions> {
|
|
6
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
2
|
+
export type DocsBlockComponentPropertyOptions = Record<string, never>;
|
|
3
|
+
export type DocsBlockComponentPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockComponentPropertyOptions;
|
|
4
|
+
/** Component property */
|
|
5
|
+
export declare class DocsBlockComponentPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockComponentPropertyOptions> {
|
|
6
|
+
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
2
|
+
export type DocsBlockComponentPropertyPropertyOptions = Record<string, never>;
|
|
3
|
+
export type DocsBlockComponentPropertyPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockComponentPropertyPropertyOptions;
|
|
4
|
+
/** ComponentProperty property */
|
|
5
|
+
export declare class DocsBlockComponentPropertyPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockComponentPropertyPropertyOptions> {
|
|
6
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockDividerProperty.d.ts
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
2
|
+
export type DocsBlockDividerPropertyOptions = Record<string, never>;
|
|
3
|
+
export type DocsBlockDividerPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockDividerPropertyOptions;
|
|
4
|
+
/** Divider property */
|
|
5
|
+
export declare class DocsBlockDividerPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockDividerPropertyOptions> {
|
|
6
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedFrameProperty.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
2
|
+
export type DocsBlockEmbedFramePropertyOptions = {
|
|
3
|
+
/** If enabled, additional text can be provided for the embed property */
|
|
4
|
+
allowCaption?: boolean;
|
|
5
|
+
};
|
|
6
|
+
export type DocsBlockEmbedFramePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockEmbedFramePropertyOptions;
|
|
7
|
+
/** EmbedFrame property */
|
|
8
|
+
export declare class DocsBlockEmbedFramePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockEmbedFramePropertyOptions> {
|
|
9
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
2
|
+
export type DocsBlockEmbedUrlPropertyOptions = {
|
|
3
|
+
/** If enabled, additional text can be provided for the embed property */
|
|
4
|
+
allowCaption?: boolean;
|
|
5
|
+
};
|
|
6
|
+
export type DocsBlockEmbedUrlPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockEmbedUrlPropertyOptions;
|
|
7
|
+
/** EmbedUrl property */
|
|
8
|
+
export declare class DocsBlockEmbedUrlPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockEmbedUrlPropertyOptions> {
|
|
9
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { DocsBlockImagePropertyAspectRatio } from "../../../enums/SDKDocsBlockImagePropertyAspectRatio";
|
|
2
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
export type DocsBlockImagePropertyOptions = {
|
|
4
|
+
aspectRatio?: DocsBlockImagePropertyAspectRatio;
|
|
5
|
+
allowCaption?: boolean;
|
|
6
|
+
recommendation?: string;
|
|
7
|
+
};
|
|
8
|
+
export type DocsBlockImagePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
|
|
9
|
+
options: DocsBlockImagePropertyOptions;
|
|
10
|
+
};
|
|
11
|
+
/** Image property */
|
|
12
|
+
export declare class DocsBlockImagePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockImagePropertyOptions> {
|
|
13
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMarkdownProperty.d.ts
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
2
|
+
export type DocsBlockMarkdownPropertyOptions = Record<string, never>;
|
|
3
|
+
export type DocsBlockMarkdownPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
|
|
4
|
+
options: DocsBlockMarkdownPropertyOptions;
|
|
5
|
+
variantOptions?: {
|
|
6
|
+
[key: string]: DocsBlockMarkdownPropertyOptions;
|
|
7
|
+
};
|
|
8
|
+
};
|
|
9
|
+
/** Markdown property */
|
|
10
|
+
export declare class DocsBlockMarkdownPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockMarkdownPropertyOptions> {
|
|
11
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty.d.ts
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { DocsBlockOptionRenderingStyle } from "../../../enums/SDKDocsBlockOptionRenderStyle";
|
|
2
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
export type DocsBlockMultiSelectPropertyOptions = {
|
|
4
|
+
defaultChoices: Array<string>;
|
|
5
|
+
choices: Array<{
|
|
6
|
+
value: string;
|
|
7
|
+
name: string;
|
|
8
|
+
icon?: string;
|
|
9
|
+
}>;
|
|
10
|
+
style?: Exclude<DocsBlockOptionRenderingStyle, DocsBlockOptionRenderingStyle.toggleButton>;
|
|
11
|
+
};
|
|
12
|
+
export type DocsBlockMultiSelectPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
|
|
13
|
+
options: DocsBlockMultiSelectPropertyOptions;
|
|
14
|
+
variantOptions?: {
|
|
15
|
+
[key: string]: DocsBlockMultiSelectPropertyOptions;
|
|
16
|
+
};
|
|
17
|
+
};
|
|
18
|
+
/** MultiSelect property */
|
|
19
|
+
export declare class DocsBlockMultiSelectPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockMultiSelectPropertyOptions> {
|
|
20
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
2
|
+
export type DocsBlockNumberPropertyOptions = {
|
|
3
|
+
/** Default value to set when block is created */
|
|
4
|
+
defaultValue: number;
|
|
5
|
+
/** Minimum value */
|
|
6
|
+
min: number;
|
|
7
|
+
/** Maximum value */
|
|
8
|
+
max: number;
|
|
9
|
+
/** Step value */
|
|
10
|
+
step: number;
|
|
11
|
+
};
|
|
12
|
+
export type DocsBlockNumberPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockNumberPropertyOptions;
|
|
13
|
+
/** Number property */
|
|
14
|
+
export declare class DocsBlockNumberPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockNumberPropertyOptions> {
|
|
15
|
+
}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
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
|
+
};
|
|
12
|
+
/** Generic property definition for when we don't care about specific types in options, just want to use the property high-level data */
|
|
13
|
+
export type DocsBlockItemPropertyAnyDefinition = DocsBlockPropertyDefinition<any>;
|
|
14
|
+
export declare class DocsBlockPropertyDefinition<T extends object> {
|
|
15
|
+
/** Property id, validated to be unique within a block, but not necessarily unique across all blocks */
|
|
16
|
+
id: string;
|
|
17
|
+
/** Human readable name that will show in the editor */
|
|
18
|
+
name: string;
|
|
19
|
+
/** Property type. There are many different types of properties, explained later */
|
|
20
|
+
type: DocsBlockItemPropertyType;
|
|
21
|
+
/** Human readable description that will show next to the property */
|
|
22
|
+
description: string | null;
|
|
23
|
+
/** Options specific to this property type */
|
|
24
|
+
options: T | null;
|
|
25
|
+
/**
|
|
26
|
+
* Overrides of options for different variants.
|
|
27
|
+
* Key/s must be set as id of the variant for override to go into effect.
|
|
28
|
+
* Options are resolved as variantOptions[key] > options > default for any variant.
|
|
29
|
+
* It is possible to override only a subset of options, in which case combination of default option settings and the override goes into effect */
|
|
30
|
+
variantOptions: {
|
|
31
|
+
[key: string]: T;
|
|
32
|
+
} | null;
|
|
33
|
+
constructor(model: DocsBlockPropertyDefinitionModel);
|
|
34
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { DocsBlockRichTextPropertyStyle } from "../../../enums/SDKDocsBlockRichTextPropertyStyle";
|
|
2
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** RichText property options */
|
|
4
|
+
export type DocsBlockRichTextPropertyOptions = {
|
|
5
|
+
/** Placeholder to show when rich text area is empty */
|
|
6
|
+
placeholder?: string;
|
|
7
|
+
/** Visual style of the rich text property */
|
|
8
|
+
style?: DocsBlockRichTextPropertyStyle;
|
|
9
|
+
};
|
|
10
|
+
export type DocsBlockRichTextPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
|
|
11
|
+
options: DocsBlockRichTextPropertyOptions;
|
|
12
|
+
variantOptions?: {
|
|
13
|
+
[key: string]: DocsBlockRichTextPropertyOptions;
|
|
14
|
+
};
|
|
15
|
+
};
|
|
16
|
+
/** RichText property */
|
|
17
|
+
export declare class DocsBlockRichTextPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockRichTextPropertyOptions> {
|
|
18
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { DocsBlockOptionRenderingStyle } from "../../../enums/SDKDocsBlockOptionRenderStyle";
|
|
2
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
export type DocsBlockSingleSelectPropertyOptions = {
|
|
4
|
+
/** Default choices to set when block is created */
|
|
5
|
+
defaultChoice: string;
|
|
6
|
+
/** List of choices to choose from */
|
|
7
|
+
choices: Array<{
|
|
8
|
+
/** Option value / id */
|
|
9
|
+
value: string;
|
|
10
|
+
/** Option name */
|
|
11
|
+
name: string;
|
|
12
|
+
/** Option icon filename */
|
|
13
|
+
icon?: string;
|
|
14
|
+
}>;
|
|
15
|
+
/** Visual representation of the property */
|
|
16
|
+
style?: DocsBlockOptionRenderingStyle;
|
|
17
|
+
};
|
|
18
|
+
export type DocsBlockSingleSelectPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
|
|
19
|
+
options: DocsBlockSingleSelectPropertyOptions;
|
|
20
|
+
variantOptions?: {
|
|
21
|
+
[key: string]: DocsBlockSingleSelectPropertyOptions;
|
|
22
|
+
};
|
|
23
|
+
};
|
|
24
|
+
/** SingleSelect property */
|
|
25
|
+
export declare class DocsBlockSingleSelectPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockSingleSelectPropertyOptions> {
|
|
26
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
2
|
+
export type DocsBlockTablePropertyOptions = Record<string, never>;
|
|
3
|
+
export type DocsBlockTablePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
|
|
4
|
+
options: DocsBlockTablePropertyOptions;
|
|
5
|
+
variantOptions?: {
|
|
6
|
+
[key: string]: DocsBlockTablePropertyOptions;
|
|
7
|
+
};
|
|
8
|
+
};
|
|
9
|
+
/** Table property */
|
|
10
|
+
export declare class DocsBlockTablePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTablePropertyOptions> {
|
|
11
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { DocsBlockTextPropertyStyle } from "../../../enums/SDKDocsBlockTextPropertyStyle";
|
|
2
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
export type DocsBlockTextPropertyOptions = {
|
|
4
|
+
/** Placeholder to show when textfield is empty */
|
|
5
|
+
placeholder?: string;
|
|
6
|
+
/** Default value to set when block is created */
|
|
7
|
+
defaultValue?: string;
|
|
8
|
+
/** Visual style of the text property */
|
|
9
|
+
style: DocsBlockTextPropertyStyle;
|
|
10
|
+
};
|
|
11
|
+
export type DocsBlockTextPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
|
|
12
|
+
options: DocsBlockTextPropertyOptions;
|
|
13
|
+
variantOptions?: {
|
|
14
|
+
[key: string]: DocsBlockTextPropertyOptions;
|
|
15
|
+
};
|
|
16
|
+
};
|
|
17
|
+
/** Text property */
|
|
18
|
+
export declare class DocsBlockTextPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTextPropertyOptions> {
|
|
19
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { TokenType } from "../../../enums/SDKTokenType";
|
|
2
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
export type DocsBlockTokenPropertyOptions = {
|
|
4
|
+
/** Token types that are allowed to be selected. All types allowed if nothing is provided */
|
|
5
|
+
allowedTypes?: Array<TokenType>;
|
|
6
|
+
};
|
|
7
|
+
export type DocsBlockTokenPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
|
|
8
|
+
options: DocsBlockTokenPropertyOptions;
|
|
9
|
+
variantOptions?: {
|
|
10
|
+
[key: string]: DocsBlockTokenPropertyOptions;
|
|
11
|
+
};
|
|
12
|
+
};
|
|
13
|
+
/** Token property */
|
|
14
|
+
export declare class DocsBlockTokenPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTokenPropertyOptions> {
|
|
15
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenPropertyProperty.d.ts
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
2
|
+
export type DocsBlockTokenPropertyPropertyOptions = Record<string, never>;
|
|
3
|
+
export type DocsBlockTokenPropertyPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
|
|
4
|
+
options: DocsBlockTokenPropertyPropertyOptions;
|
|
5
|
+
variantOptions?: {
|
|
6
|
+
[key: string]: DocsBlockTokenPropertyPropertyOptions;
|
|
7
|
+
};
|
|
8
|
+
};
|
|
9
|
+
/** TokenProperty property */
|
|
10
|
+
export declare class DocsBlockTokenPropertyPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTokenPropertyPropertyOptions> {
|
|
11
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty.d.ts
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
2
|
+
export type DocsBlockTokenTypePropertyOptions = Record<string, never>;
|
|
3
|
+
export type DocsBlockTokenTypePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
|
|
4
|
+
options: DocsBlockTokenTypePropertyOptions;
|
|
5
|
+
variantOptions?: {
|
|
6
|
+
[key: string]: DocsBlockTokenTypePropertyOptions;
|
|
7
|
+
};
|
|
8
|
+
};
|
|
9
|
+
/** Token type property */
|
|
10
|
+
export declare class DocsBlockTokenTypePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTokenTypePropertyOptions> {
|
|
11
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/** An image data container */
|
|
2
|
+
export type DocsImageRef = {
|
|
3
|
+
/** Ref type */
|
|
4
|
+
type: DocsImageRefType;
|
|
5
|
+
/** Absolute, directly consumable URL */
|
|
6
|
+
url: string;
|
|
7
|
+
/** Referenced asset, if any */
|
|
8
|
+
assetId?: string;
|
|
9
|
+
/** Referenced frame, if any */
|
|
10
|
+
frameId?: string;
|
|
11
|
+
/** Image size, if known */
|
|
12
|
+
size?: {
|
|
13
|
+
width?: number;
|
|
14
|
+
height?: number;
|
|
15
|
+
};
|
|
16
|
+
};
|
|
17
|
+
export declare enum DocsImageRefType {
|
|
18
|
+
upload = "Upload",
|
|
19
|
+
asset = "Asset",
|
|
20
|
+
figmaFrame = "FigmaFrame"
|
|
21
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/** A link data container */
|
|
2
|
+
export type DocsLinkRef = {
|
|
3
|
+
/** Ref type */
|
|
4
|
+
type: DocsLinkRefType;
|
|
5
|
+
/** Referenced page */
|
|
6
|
+
pageId?: string;
|
|
7
|
+
/** Referenced page block - heading */
|
|
8
|
+
pageHeadingId?: string;
|
|
9
|
+
/** Referenced page group */
|
|
10
|
+
groupId?: string;
|
|
11
|
+
/** Referenced URL */
|
|
12
|
+
url?: string;
|
|
13
|
+
/** Open in other tab */
|
|
14
|
+
openInNewTab?: boolean;
|
|
15
|
+
};
|
|
16
|
+
export declare enum DocsLinkRefType {
|
|
17
|
+
page = "Page",
|
|
18
|
+
pageHeading = "pageHeading",
|
|
19
|
+
group = "Group",
|
|
20
|
+
url = "url"
|
|
21
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { SizeTokenValue } from "../../../tokens/SDKTokenValue";
|
|
2
|
+
/** A size data container */
|
|
3
|
+
export type DocsSizeRef = {
|
|
4
|
+
/** Width value - either token reference or raw value */
|
|
5
|
+
width?: SizeTokenValue;
|
|
6
|
+
/** Height value - either token reference or raw value */
|
|
7
|
+
height?: SizeTokenValue;
|
|
8
|
+
};
|