@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.
Files changed (179) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +144 -0
  3. package/build/sdk-typescript/src/browser-bundle.d.ts +1 -0
  4. package/build/sdk-typescript/src/core/SDKBrand.d.ts +80 -0
  5. package/build/sdk-typescript/src/core/SDKBrandWriter.d.ts +29 -0
  6. package/build/sdk-typescript/src/core/SDKDesignSystem.d.ts +62 -0
  7. package/build/sdk-typescript/src/core/SDKDesignSystemVersion.d.ts +99 -0
  8. package/build/sdk-typescript/src/core/SDKDocumentation.d.ts +55 -0
  9. package/build/sdk-typescript/src/core/SDKSupernova.d.ts +46 -0
  10. package/build/sdk-typescript/src/core/SDKWorkspace.d.ts +26 -0
  11. package/build/sdk-typescript/src/core/data/SDKConfiguration.d.ts +6 -0
  12. package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +50 -0
  13. package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +141 -0
  14. package/build/sdk-typescript/src/core/errors/SDKSupernovaError.d.ts +24 -0
  15. package/build/sdk-typescript/src/core/resolvers/SDKAssetGroupResolver.d.ts +14 -0
  16. package/build/sdk-typescript/src/core/resolvers/SDKComponentResolver.d.ts +8 -0
  17. package/build/sdk-typescript/src/core/resolvers/SDKDesignComponentGroupResolver.d.ts +13 -0
  18. package/build/sdk-typescript/src/core/resolvers/SDKDocumentationItemResolver.d.ts +32 -0
  19. package/build/sdk-typescript/src/core/resolvers/SDKTokenGroupResolver.d.ts +11 -0
  20. package/build/sdk-typescript/src/core/resolvers/SDKTokenResolver.d.ts +76 -0
  21. package/build/sdk-typescript/src/exports.d.ts +117 -0
  22. package/build/sdk-typescript/src/index.d.ts +1 -0
  23. package/build/sdk-typescript/src/model/assets/SDKAsset.d.ts +16 -0
  24. package/build/sdk-typescript/src/model/assets/SDKRenderedAsset.d.ts +28 -0
  25. package/build/sdk-typescript/src/model/components/SDKComponent.d.ts +27 -0
  26. package/build/sdk-typescript/src/model/components/SDKDesignComponent.d.ts +32 -0
  27. package/build/sdk-typescript/src/model/documentation/SDKDocumentationConfiguration.d.ts +13 -0
  28. package/build/sdk-typescript/src/model/documentation/SDKDocumentationGroup.d.ts +38 -0
  29. package/build/sdk-typescript/src/model/documentation/SDKDocumentationItem.d.ts +26 -0
  30. package/build/sdk-typescript/src/model/documentation/SDKDocumentationPage.d.ts +31 -0
  31. package/build/sdk-typescript/src/model/documentation/SDKDocumentationPageAsset.d.ts +15 -0
  32. package/build/sdk-typescript/src/model/documentation/SDKDocumentationPageBlock.d.ts +32 -0
  33. package/build/sdk-typescript/src/model/documentation/SDKDocumentationRichText.d.ts +10 -0
  34. package/build/sdk-typescript/src/model/documentation/SDKDocumentationRichTextSpan.d.ts +10 -0
  35. package/build/sdk-typescript/src/model/documentation/SDKDocumentationRichTextSpanAttribute.d.ts +14 -0
  36. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockAsset.d.ts +15 -0
  37. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockAssets.d.ts +24 -0
  38. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockCallout.d.ts +11 -0
  39. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockCode.d.ts +12 -0
  40. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockColumn.d.ts +8 -0
  41. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockColumnItem.d.ts +11 -0
  42. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockCustom.d.ts +16 -0
  43. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockDivider.d.ts +8 -0
  44. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedFigma.d.ts +8 -0
  45. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedGeneric.d.ts +15 -0
  46. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedLink.d.ts +16 -0
  47. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedStorybook.d.ts +8 -0
  48. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedYoutube.d.ts +8 -0
  49. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockFrame.d.ts +18 -0
  50. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockFrames.d.ts +26 -0
  51. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockHeading.d.ts +11 -0
  52. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockImage.d.ts +18 -0
  53. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockOrderedList.d.ts +8 -0
  54. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockQuote.d.ts +8 -0
  55. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockRenderCode.d.ts +34 -0
  56. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockShortcut.d.ts +35 -0
  57. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockShortcuts.d.ts +11 -0
  58. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTab.d.ts +8 -0
  59. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTabItem.d.ts +10 -0
  60. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTable.d.ts +23 -0
  61. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTableCell.d.ts +13 -0
  62. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTableColumn.d.ts +10 -0
  63. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTableRow.d.ts +8 -0
  64. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockText.d.ts +13 -0
  65. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockToken.d.ts +10 -0
  66. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTokenGroup.d.ts +12 -0
  67. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTokenList.d.ts +10 -0
  68. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockUnorderedList.d.ts +8 -0
  69. package/build/sdk-typescript/src/model/documentation/builder/SDKDocumentationBlockBuilder.d.ts +6 -0
  70. package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationItemConfiguration.d.ts +10 -0
  71. package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationItemHeader.d.ts +30 -0
  72. package/build/sdk-typescript/src/model/elements/SDKElementDataView.d.ts +30 -0
  73. package/build/sdk-typescript/src/model/elements/SDKElementDataViewColumn.d.ts +37 -0
  74. package/build/sdk-typescript/src/model/elements/SDKElementProperty.d.ts +56 -0
  75. package/build/sdk-typescript/src/model/elements/SDKElementPropertyOption.d.ts +13 -0
  76. package/build/sdk-typescript/src/model/elements/values/SDKElementPropertyValue.d.ts +15 -0
  77. package/build/sdk-typescript/src/model/enums/SDKAlignment.d.ts +5 -0
  78. package/build/sdk-typescript/src/model/enums/SDKAssetFormat.d.ts +5 -0
  79. package/build/sdk-typescript/src/model/enums/SDKAssetScale.d.ts +6 -0
  80. package/build/sdk-typescript/src/model/enums/SDKAssetScaleType.d.ts +4 -0
  81. package/build/sdk-typescript/src/model/enums/SDKBlurType.d.ts +4 -0
  82. package/build/sdk-typescript/src/model/enums/SDKBorderPosition.d.ts +5 -0
  83. package/build/sdk-typescript/src/model/enums/SDKDocumentationCalloutType.d.ts +6 -0
  84. package/build/sdk-typescript/src/model/enums/SDKDocumentationGroupBehavior.d.ts +4 -0
  85. package/build/sdk-typescript/src/model/enums/SDKDocumentationHeadingType.d.ts +5 -0
  86. package/build/sdk-typescript/src/model/enums/SDKDocumentationItemType.d.ts +4 -0
  87. package/build/sdk-typescript/src/model/enums/SDKDocumentationPageAssetType.d.ts +4 -0
  88. package/build/sdk-typescript/src/model/enums/SDKDocumentationPageBlockThemeType.d.ts +4 -0
  89. package/build/sdk-typescript/src/model/enums/SDKDocumentationPageBlockType.d.ts +31 -0
  90. package/build/sdk-typescript/src/model/enums/SDKFrameAlignment.d.ts +4 -0
  91. package/build/sdk-typescript/src/model/enums/SDKFrameLayout.d.ts +11 -0
  92. package/build/sdk-typescript/src/model/enums/SDKGradientType.d.ts +5 -0
  93. package/build/sdk-typescript/src/model/enums/SDKRichTextSpanAttributeType.d.ts +7 -0
  94. package/build/sdk-typescript/src/model/enums/SDKShadowType.d.ts +4 -0
  95. package/build/sdk-typescript/src/model/enums/SDKSourceType.d.ts +4 -0
  96. package/build/sdk-typescript/src/model/enums/SDKTextCase.d.ts +6 -0
  97. package/build/sdk-typescript/src/model/enums/SDKTextDecoration.d.ts +5 -0
  98. package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts +13 -0
  99. package/build/sdk-typescript/src/model/enums/SDKUnit.d.ts +6 -0
  100. package/build/sdk-typescript/src/model/exporters/SDKExporter.d.ts +74 -0
  101. package/build/sdk-typescript/src/model/exporters/custom_blocks/SDKExporterCustomBlock.d.ts +23 -0
  102. package/build/sdk-typescript/src/model/exporters/custom_blocks/SDKExporterCustomBlockProperty.d.ts +32 -0
  103. package/build/sdk-typescript/src/model/exporters/custom_blocks/SDKExporterCustomBlockVariant.d.ts +12 -0
  104. package/build/sdk-typescript/src/model/exporters/custom_properties/SDKExporterConfigurationProperty.d.ts +38 -0
  105. package/build/sdk-typescript/src/model/groups/SDKAssetGroup.d.ts +20 -0
  106. package/build/sdk-typescript/src/model/groups/SDKDesignComponentGroup.d.ts +33 -0
  107. package/build/sdk-typescript/src/model/groups/SDKTokenGroup.d.ts +42 -0
  108. package/build/sdk-typescript/src/model/support/SDKDesignComponentOrigin.d.ts +23 -0
  109. package/build/sdk-typescript/src/model/support/SDKFrameOrigin.d.ts +25 -0
  110. package/build/sdk-typescript/src/model/support/SDKSize.d.ts +9 -0
  111. package/build/sdk-typescript/src/model/support/SDKSource.d.ts +102 -0
  112. package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +11 -0
  113. package/build/sdk-typescript/src/model/support/SDKWorkspaceNPMRegistry.d.ts +13 -0
  114. package/build/sdk-typescript/src/model/themes/SDKThemeUtilities.d.ts +6 -0
  115. package/build/sdk-typescript/src/model/themes/SDKTokenTheme.d.ts +63 -0
  116. package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +49 -0
  117. package/build/sdk-typescript/src/model/tokens/SDKBlurToken.d.ts +18 -0
  118. package/build/sdk-typescript/src/model/tokens/SDKBorderToken.d.ts +19 -0
  119. package/build/sdk-typescript/src/model/tokens/SDKColorToken.d.ts +22 -0
  120. package/build/sdk-typescript/src/model/tokens/SDKFontToken.d.ts +16 -0
  121. package/build/sdk-typescript/src/model/tokens/SDKGenericToken.d.ts +18 -0
  122. package/build/sdk-typescript/src/model/tokens/SDKGradientToken.d.ts +18 -0
  123. package/build/sdk-typescript/src/model/tokens/SDKMeasureToken.d.ts +26 -0
  124. package/build/sdk-typescript/src/model/tokens/SDKRadiusToken.d.ts +18 -0
  125. package/build/sdk-typescript/src/model/tokens/SDKShadowToken.d.ts +21 -0
  126. package/build/sdk-typescript/src/model/tokens/SDKTextToken.d.ts +16 -0
  127. package/build/sdk-typescript/src/model/tokens/SDKToken.d.ts +30 -0
  128. package/build/sdk-typescript/src/model/tokens/SDKTokenCompator.d.ts +20 -0
  129. package/build/sdk-typescript/src/model/tokens/SDKTokenValue.d.ts +113 -0
  130. package/build/sdk-typescript/src/model/tokens/SDKTypographyToken.d.ts +19 -0
  131. package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenData.d.ts +45 -0
  132. package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenModel.d.ts +60 -0
  133. package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenValue.d.ts +72 -0
  134. package/build/sdk-typescript/src/model/users/SDKUser.d.ts +22 -0
  135. package/build/sdk-typescript/src/tests/Accessors/Brand.spec.d.ts +1 -0
  136. package/build/sdk-typescript/src/tests/Accessors/Components.spec.d.ts +1 -0
  137. package/build/sdk-typescript/src/tests/Accessors/DesignSystem.spec.d.ts +1 -0
  138. package/build/sdk-typescript/src/tests/Accessors/DesignSystemVersion.spec.d.ts +1 -0
  139. package/build/sdk-typescript/src/tests/Accessors/Documentation.spec.d.ts +1 -0
  140. package/build/sdk-typescript/src/tests/Accessors/Supernova.spec.d.ts +1 -0
  141. package/build/sdk-typescript/src/tests/Accessors/Theme.spec.d.ts +1 -0
  142. package/build/sdk-typescript/src/tests/Accessors/Workspace.spec.d.ts +1 -0
  143. package/build/sdk-typescript/src/tests/Tooling/PluginFigmaTokens.spec.d.ts +17 -0
  144. package/build/sdk-typescript/src/tests/Tooling/PluginJSONBuilder.spec.d.ts +1 -0
  145. package/build/sdk-typescript/src/tests/Tooling/ToolDocSearch.spec.d.ts +1 -0
  146. package/build/sdk-typescript/src/tests/Tooling/ToolMarkdownTransform.spec.d.ts +1 -0
  147. package/build/sdk-typescript/src/tests/helpers.d.ts +2 -0
  148. package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +48 -0
  149. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONConverter.d.ts +34 -0
  150. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONGroupBuilder.d.ts +21 -0
  151. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONLoader.d.ts +27 -0
  152. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONParser.d.ts +40 -0
  153. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTMapLoader.d.ts +39 -0
  154. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTMapResolver.d.ts +10 -0
  155. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTThemeMerger.d.ts +17 -0
  156. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenGroupTreeMerger.d.ts +23 -0
  157. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenMerger.d.ts +17 -0
  158. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenReferenceResolver.d.ts +37 -0
  159. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenSetResolver.d.ts +12 -0
  160. package/build/sdk-typescript/src/tools/design-tokens/utilities/collection/SDKDTTokenCollection.d.ts +13 -0
  161. package/build/sdk-typescript/src/tools/design-tokens/utilities/expression/SDKDTExpressionParser.d.ts +5 -0
  162. package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTGroupTree.d.ts +10 -0
  163. package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTGroupTreeNode.d.ts +20 -0
  164. package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTParentChildMapping.d.ts +5 -0
  165. package/build/sdk-typescript/src/tools/json-builder/SDKToolsJSONBuilder.d.ts +57 -0
  166. package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementFigmaTokensTransformer.d.ts +40 -0
  167. package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementStyleDictionaryTransformer.d.ts +29 -0
  168. package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementTransformer.d.ts +77 -0
  169. package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransform.d.ts +23 -0
  170. package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformBlock.d.ts +75 -0
  171. package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformUtil.d.ts +26 -0
  172. package/build/sdk-typescript/src/tools/search-index/SDKToolsDocSearch.d.ts +47 -0
  173. package/build/sdk-typescript/src/tools/token-transform/SDKToolsTokenTransform.d.ts +44 -0
  174. package/build/sdk-typescript/src/utils/FlowUtils.d.ts +5 -0
  175. package/build/sdk-typescript/src/utils/StringUtils.d.ts +72 -0
  176. package/build/supernova-sdk-typescript.js +3 -0
  177. package/build/supernova-sdk-typescript.js.LICENSE.txt +8 -0
  178. package/build/supernova-sdk-typescript.js.map +1 -0
  179. package/package.json +114 -0
@@ -0,0 +1,26 @@
1
+ import { DocumentationItemType } from "../enums/SDKDocumentationItemType";
2
+ import { DocumentationItemConfiguration, DocumentationItemConfigurationModel } from "./configuration/SDKDocumentationItemConfiguration";
3
+ export interface DocumentationItemModel {
4
+ persistentId: string;
5
+ id: string;
6
+ designSystemVersionId: string;
7
+ title: string;
8
+ type: DocumentationItemType;
9
+ slug: string;
10
+ userSlug?: string;
11
+ configuration: DocumentationItemConfigurationModel;
12
+ createdAt?: string;
13
+ updatedAt?: string;
14
+ }
15
+ export declare class DocumentationItem {
16
+ id: string;
17
+ persistentId: string;
18
+ type: DocumentationItemType;
19
+ title: string;
20
+ configuration: DocumentationItemConfiguration;
21
+ slug: string;
22
+ userSlug: string | null;
23
+ createdAt: Date | null;
24
+ updatedAt: Date | null;
25
+ constructor(model: DocumentationItemModel);
26
+ }
@@ -0,0 +1,31 @@
1
+ import { ExporterCustomBlock } from "../exporters/custom_blocks/SDKExporterCustomBlock";
2
+ import { DocumentationConfiguration } from "./SDKDocumentationConfiguration";
3
+ import { DocumentationGroup } from "./SDKDocumentationGroup";
4
+ import { DocumentationItemModel, DocumentationItem } from "./SDKDocumentationItem";
5
+ import { DocumentationPageBlockModel, DocumentationPageBlock } from "./SDKDocumentationPageBlock";
6
+ export interface DocumentationPageModel extends DocumentationItemModel {
7
+ blocks?: Array<DocumentationPageBlockModel>;
8
+ }
9
+ export declare class DocumentationPage extends DocumentationItem {
10
+ /** All blocks that were defined on the top level of the page */
11
+ blocks: Array<DocumentationPageBlock>;
12
+ /** Containing group. Can either be true group (abstract), or tab group */
13
+ parent: DocumentationGroup;
14
+ /** Internal */
15
+ deployedUrl: string | null;
16
+ /** Internal */
17
+ relativeUrl: string | null;
18
+ /** Internal */
19
+ editorUrl: string | null;
20
+ constructor(model: DocumentationPageModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
21
+ /** Internal: Modifies object with new paths. Don't use outside SDK environment as it doesn't propagate the data back to source */
22
+ internalOverridePaths(deployed: string | null, editor: string | null, relative: string | null): void;
23
+ /** Internal: Sets new parent. Used when manipulating with object internally. Don't use outside SDK environment */
24
+ setParent(parent: DocumentationGroup): void;
25
+ /** Retrieve editor page URL that can be opened */
26
+ editorPageUrl(): string | null;
27
+ /** Retrieve documentation page URL, if the documentation was already deployed (either default or custom domain) */
28
+ deployedPageUrl(): string | null;
29
+ /** Retrieve relative page path without the associated domain. Will work even when documentation was not yet deployed */
30
+ relativePageUrl(): string | null;
31
+ }
@@ -0,0 +1,15 @@
1
+ import { DocumentationPageAssetType } from '../enums/SDKDocumentationPageAssetType';
2
+ import { DocumentationPageBlockFrame, DocumentationPageBlockFrameModel } from './blocks/SDKDocumentationPageBlockFrame';
3
+ export interface DocumentationPageAssetModel {
4
+ id: string;
5
+ url?: string;
6
+ type: DocumentationPageAssetType;
7
+ figmaFrame?: DocumentationPageBlockFrameModel;
8
+ }
9
+ export declare class DocumentationPageAsset {
10
+ id: string;
11
+ url: string | null;
12
+ type: DocumentationPageAssetType;
13
+ frame: DocumentationPageBlockFrame | null;
14
+ constructor(model: DocumentationPageAssetModel);
15
+ }
@@ -0,0 +1,32 @@
1
+ import { DocumentationPageBlockType } from "../enums/SDKDocumentationPageBlockType";
2
+ import { ExporterCustomBlock } from "../exporters/custom_blocks/SDKExporterCustomBlock";
3
+ import { DocumentationConfiguration } from "./SDKDocumentationConfiguration";
4
+ import { DocumentationPageBlockThemeType } from "../enums/SDKDocumentationPageBlockThemeType";
5
+ export interface DocumentationPageBlockModel {
6
+ persistentId: string;
7
+ designObjectId: string;
8
+ type: DocumentationPageBlockType;
9
+ children: Array<DocumentationPageBlockModel>;
10
+ variantKey?: string;
11
+ theme?: {
12
+ themeIds: Array<string>;
13
+ type: DocumentationPageBlockThemeType;
14
+ };
15
+ blacklistedElementProperties?: Array<string>;
16
+ userMetadata?: string;
17
+ }
18
+ export declare class DocumentationPageBlock {
19
+ id: string;
20
+ children: Array<DocumentationPageBlock>;
21
+ type: DocumentationPageBlockType;
22
+ beginsTypeChain: boolean;
23
+ endsTypeChain: boolean;
24
+ variantKey: string | null;
25
+ theme: {
26
+ themeIds: Array<string>;
27
+ type: DocumentationPageBlockThemeType;
28
+ } | null;
29
+ blacklistedElementProperties: Array<string> | null;
30
+ userMetadata: object | Array<any> | null;
31
+ constructor(model: DocumentationPageBlockModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
32
+ }
@@ -0,0 +1,10 @@
1
+ import { RichTextSpanModel, RichTextSpan } from "./SDKDocumentationRichTextSpan";
2
+ export interface DocumentationRichTextModel {
3
+ spans: Array<RichTextSpanModel>;
4
+ }
5
+ export declare class DocumentationRichText {
6
+ spans: Array<RichTextSpan>;
7
+ constructor(model: DocumentationRichTextModel);
8
+ /** Convert rich text into plain text, omitting any formatting */
9
+ asPlainText(): string;
10
+ }
@@ -0,0 +1,10 @@
1
+ import { RichTextSpanAttributeModel, RichTextSpanAttribute } from "./SDKDocumentationRichTextSpanAttribute";
2
+ export interface RichTextSpanModel {
3
+ text: string;
4
+ attributes: Array<RichTextSpanAttributeModel>;
5
+ }
6
+ export declare class RichTextSpan {
7
+ text: string;
8
+ attributes: Array<RichTextSpanAttribute>;
9
+ constructor(model: RichTextSpanModel);
10
+ }
@@ -0,0 +1,14 @@
1
+ import { RichTextSpanAttributeType } from "../enums/SDKRichTextSpanAttributeType";
2
+ export interface RichTextSpanAttributeModel {
3
+ type: RichTextSpanAttributeType;
4
+ link?: string;
5
+ documentationItemId?: string;
6
+ openInNewWindow: boolean;
7
+ }
8
+ export declare class RichTextSpanAttribute {
9
+ type: RichTextSpanAttributeType;
10
+ link: string | null;
11
+ openInNewWindow: boolean;
12
+ documentationItemId: string | null;
13
+ constructor(model: RichTextSpanAttributeModel);
14
+ }
@@ -0,0 +1,15 @@
1
+ import { ColorTokenRemoteData } from "../../../model/tokens/remote/SDKRemoteTokenData";
2
+ export interface DocumentationPageBlockAssetModel {
3
+ componentAssetId: string;
4
+ title?: string;
5
+ description?: string;
6
+ backgroundColor?: ColorTokenRemoteData;
7
+ }
8
+ export declare class DocumentationPageBlockAsset {
9
+ assetId: string;
10
+ title: string | null;
11
+ description: string | null;
12
+ previewUrl: string | null;
13
+ backgroundColor: ColorTokenRemoteData | null;
14
+ constructor(model: DocumentationPageBlockAssetModel, blockBackgroundColor: ColorTokenRemoteData | null);
15
+ }
@@ -0,0 +1,24 @@
1
+ import { ColorTokenRemoteData } from "../../../model/tokens/remote/SDKRemoteTokenData";
2
+ import { FrameAlignment } from "../../enums/SDKFrameAlignment";
3
+ import { FrameLayout } from "../../enums/SDKFrameLayout";
4
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
5
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
6
+ import { DocumentationPageBlockModel, DocumentationPageBlock } from "../SDKDocumentationPageBlock";
7
+ import { DocumentationPageBlockAssetModel, DocumentationPageBlockAsset } from "./SDKDocumentationPageBlockAsset";
8
+ export interface DocumentationPageBlockAssetsModel extends DocumentationPageBlockModel {
9
+ componentAssets: Array<DocumentationPageBlockAssetModel>;
10
+ figmaFrameProperties: {
11
+ alignment: FrameAlignment;
12
+ color?: ColorTokenRemoteData;
13
+ layout: FrameLayout;
14
+ };
15
+ }
16
+ export declare class DocumentationPageBlockAssets extends DocumentationPageBlock {
17
+ assets: Array<DocumentationPageBlockAsset>;
18
+ properties: {
19
+ backgroundColor: ColorTokenRemoteData | null;
20
+ alignment: FrameAlignment;
21
+ layout: FrameLayout;
22
+ };
23
+ constructor(model: DocumentationPageBlockAssetsModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
24
+ }
@@ -0,0 +1,11 @@
1
+ import { DocumentationCalloutType } from "../../enums/SDKDocumentationCalloutType";
2
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
3
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
4
+ import { DocumentationPageBlockTextModel, DocumentationPageBlockText } from "./SDKDocumentationPageBlockText";
5
+ export interface DocumentationPageBlockCalloutModel extends DocumentationPageBlockTextModel {
6
+ calloutType: DocumentationCalloutType;
7
+ }
8
+ export declare class DocumentationPageBlockCallout extends DocumentationPageBlockText {
9
+ calloutType: DocumentationCalloutType;
10
+ constructor(model: DocumentationPageBlockCalloutModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
11
+ }
@@ -0,0 +1,12 @@
1
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
2
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
3
+ import { DocumentationPageBlockTextModel, DocumentationPageBlockText } from "./SDKDocumentationPageBlockText";
4
+ export interface DocumentationPageBlockCodeModel extends DocumentationPageBlockTextModel {
5
+ codeLanguage?: string;
6
+ caption?: string;
7
+ }
8
+ export declare class DocumentationPageBlockCode extends DocumentationPageBlockText {
9
+ codeLanguage: string | null;
10
+ caption: string | null;
11
+ constructor(model: DocumentationPageBlockCodeModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
12
+ }
@@ -0,0 +1,8 @@
1
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
2
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
3
+ import { DocumentationPageBlockModel, DocumentationPageBlock } from "../SDKDocumentationPageBlock";
4
+ export interface DocumentationPageBlockColumnModel extends DocumentationPageBlockModel {
5
+ }
6
+ export declare class DocumentationPageBlockColumn extends DocumentationPageBlock {
7
+ constructor(model: DocumentationPageBlockColumnModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
8
+ }
@@ -0,0 +1,11 @@
1
+ import { MeasureTokenRemoteData } from "../../../model/tokens/remote/SDKRemoteTokenData";
2
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
3
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
4
+ import { DocumentationPageBlockModel, DocumentationPageBlock } from "../SDKDocumentationPageBlock";
5
+ export interface DocumentationPageBlockColumnItemModel extends DocumentationPageBlockModel {
6
+ width: MeasureTokenRemoteData;
7
+ }
8
+ export declare class DocumentationPageBlockColumnItem extends DocumentationPageBlock {
9
+ width: MeasureTokenRemoteData;
10
+ constructor(model: DocumentationPageBlockColumnItemModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
11
+ }
@@ -0,0 +1,16 @@
1
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
2
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
3
+ import { DocumentationPageBlockModel, DocumentationPageBlock } from "../SDKDocumentationPageBlock";
4
+ export interface DocumentationPageBlockCustomModel extends DocumentationPageBlockModel {
5
+ customBlockKey: string;
6
+ customBlockProperties?: Array<{
7
+ key: string;
8
+ value: any;
9
+ }>;
10
+ }
11
+ export declare class DocumentationPageBlockCustom extends DocumentationPageBlock {
12
+ key: string;
13
+ properties: Object;
14
+ block: ExporterCustomBlock | null;
15
+ constructor(model: DocumentationPageBlockCustomModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
16
+ }
@@ -0,0 +1,8 @@
1
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
2
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
3
+ import { DocumentationPageBlockModel, DocumentationPageBlock } from "../SDKDocumentationPageBlock";
4
+ export interface DocumentationPageBlockDividerModel extends DocumentationPageBlockModel {
5
+ }
6
+ export declare class DocumentationPageBlockDivider extends DocumentationPageBlock {
7
+ constructor(model: DocumentationPageBlockDividerModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
8
+ }
@@ -0,0 +1,8 @@
1
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
2
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
3
+ import { DocumentationPageBlockEmbedGenericModel, DocumentationPageBlockEmbedGeneric } from "./SDKDocumentationPageBlockEmbedGeneric";
4
+ export interface DocumentationPageBlockEmbedFigmaModel extends DocumentationPageBlockEmbedGenericModel {
5
+ }
6
+ export declare class DocumentationPageBlockEmbedFigma extends DocumentationPageBlockEmbedGeneric {
7
+ constructor(model: DocumentationPageBlockEmbedFigmaModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
8
+ }
@@ -0,0 +1,15 @@
1
+ import { SizeModel, Size } from "../../support/SDKSize";
2
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
3
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
4
+ import { DocumentationPageBlockModel, DocumentationPageBlock } from "../SDKDocumentationPageBlock";
5
+ export interface DocumentationPageBlockEmbedGenericModel extends DocumentationPageBlockModel {
6
+ url?: string;
7
+ size?: SizeModel;
8
+ caption?: string;
9
+ }
10
+ export declare class DocumentationPageBlockEmbedGeneric extends DocumentationPageBlock {
11
+ url: string | null;
12
+ size: Size | null;
13
+ caption: string | null;
14
+ constructor(model: DocumentationPageBlockEmbedGenericModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
15
+ }
@@ -0,0 +1,16 @@
1
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
2
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
3
+ import { DocumentationPageBlockEmbedGenericModel, DocumentationPageBlockEmbedGeneric } from "./SDKDocumentationPageBlockEmbedGeneric";
4
+ export interface DocumentationPageBlockEmbedLinkModel extends DocumentationPageBlockEmbedGenericModel {
5
+ urlPreview?: {
6
+ title?: string;
7
+ description?: string;
8
+ thumbnailUrl?: string;
9
+ };
10
+ }
11
+ export declare class DocumentationPageBlockEmbedLink extends DocumentationPageBlockEmbedGeneric {
12
+ title: string | null;
13
+ description: string | null;
14
+ thumbnailUrl: string | null;
15
+ constructor(model: DocumentationPageBlockEmbedLinkModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
16
+ }
@@ -0,0 +1,8 @@
1
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
2
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
3
+ import { DocumentationPageBlockEmbedGenericModel, DocumentationPageBlockEmbedGeneric } from "./SDKDocumentationPageBlockEmbedGeneric";
4
+ export interface DocumentationPageBlockEmbedStorybookModel extends DocumentationPageBlockEmbedGenericModel {
5
+ }
6
+ export declare class DocumentationPageBlockEmbedStorybook extends DocumentationPageBlockEmbedGeneric {
7
+ constructor(model: DocumentationPageBlockEmbedStorybookModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
8
+ }
@@ -0,0 +1,8 @@
1
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
2
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
3
+ import { DocumentationPageBlockEmbedGeneric, DocumentationPageBlockEmbedGenericModel } from "./SDKDocumentationPageBlockEmbedGeneric";
4
+ export interface DocumentationPageBlockEmbedYoutubeModel extends DocumentationPageBlockEmbedGenericModel {
5
+ }
6
+ export declare class DocumentationPageBlockEmbedYoutube extends DocumentationPageBlockEmbedGeneric {
7
+ constructor(model: DocumentationPageBlockEmbedYoutubeModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
8
+ }
@@ -0,0 +1,18 @@
1
+ import { ColorTokenRemoteData } from "../../../model/tokens/remote/SDKRemoteTokenData";
2
+ import { FrameOrigin, FrameOriginModel } from "../../support/SDKFrameOrigin";
3
+ export interface DocumentationPageBlockFrameModel {
4
+ sourceId: string;
5
+ sourceFrameId: string;
6
+ title?: string;
7
+ description?: string;
8
+ backgroundColor?: ColorTokenRemoteData;
9
+ origin: FrameOriginModel;
10
+ }
11
+ export declare class DocumentationPageBlockFrame {
12
+ title: string | null;
13
+ description: string | null;
14
+ previewUrl: string;
15
+ backgroundColor: ColorTokenRemoteData | null;
16
+ origin: FrameOrigin | null;
17
+ constructor(model: DocumentationPageBlockFrameModel, blockBackgroundColor: ColorTokenRemoteData | null);
18
+ }
@@ -0,0 +1,26 @@
1
+ import { ColorTokenRemoteData } from "../../../model/tokens/remote/SDKRemoteTokenData";
2
+ import { FrameAlignment } from "../../enums/SDKFrameAlignment";
3
+ import { FrameLayout } from "../../enums/SDKFrameLayout";
4
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
5
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
6
+ import { DocumentationPageBlockModel, DocumentationPageBlock } from "../SDKDocumentationPageBlock";
7
+ import { DocumentationPageBlockFrameModel, DocumentationPageBlockFrame } from "./SDKDocumentationPageBlockFrame";
8
+ export interface DocumentationPageBlockFramesModel extends DocumentationPageBlockModel {
9
+ figmaFrames: Array<DocumentationPageBlockFrameModel>;
10
+ figmaFrameProperties: {
11
+ alignment: FrameAlignment;
12
+ color?: ColorTokenRemoteData;
13
+ layout: FrameLayout;
14
+ showTitles: boolean;
15
+ };
16
+ }
17
+ export declare class DocumentationPageBlockFrames extends DocumentationPageBlock {
18
+ frames: Array<DocumentationPageBlockFrame>;
19
+ properties: {
20
+ backgroundColor: ColorTokenRemoteData | null;
21
+ alignment: FrameAlignment;
22
+ layout: FrameLayout;
23
+ showTitles: boolean;
24
+ };
25
+ constructor(model: DocumentationPageBlockFramesModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
26
+ }
@@ -0,0 +1,11 @@
1
+ import { DocumentationHeadingType } from "../../enums/SDKDocumentationHeadingType";
2
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
3
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
4
+ import { DocumentationPageBlockTextModel, DocumentationPageBlockText } from "./SDKDocumentationPageBlockText";
5
+ export interface DocumentationPageBlockHeadingModel extends DocumentationPageBlockTextModel {
6
+ headingType: DocumentationHeadingType;
7
+ }
8
+ export declare class DocumentationPageBlockHeading extends DocumentationPageBlockText {
9
+ headingType: DocumentationHeadingType;
10
+ constructor(model: DocumentationPageBlockHeadingModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
11
+ }
@@ -0,0 +1,18 @@
1
+ import { Alignment } from "../../enums/SDKAlignment";
2
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
3
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
4
+ import { DocumentationPageBlockModel, DocumentationPageBlock } from "../SDKDocumentationPageBlock";
5
+ import { DocumentationPageAssetModel, DocumentationPageAsset } from "../SDKDocumentationPageAsset";
6
+ export interface DocumentationPageBlockImageModel extends DocumentationPageBlockModel {
7
+ asset?: DocumentationPageAssetModel;
8
+ assetUrl?: string;
9
+ caption?: string;
10
+ alignment: Alignment;
11
+ }
12
+ export declare class DocumentationPageBlockImage extends DocumentationPageBlock {
13
+ url: string | null;
14
+ asset: DocumentationPageAsset;
15
+ caption: string | null;
16
+ alignment: Alignment;
17
+ constructor(model: DocumentationPageBlockImageModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
18
+ }
@@ -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 DocumentationPageOrderedListModel extends DocumentationPageBlockTextModel {
5
+ }
6
+ export declare class DocumentationPageOrderedList extends DocumentationPageBlockText {
7
+ constructor(model: DocumentationPageOrderedListModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
8
+ }
@@ -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 DocumentationPageBlockQuoteModel extends DocumentationPageBlockTextModel {
5
+ }
6
+ export declare class DocumentationPageBlockQuote extends DocumentationPageBlockText {
7
+ constructor(model: DocumentationPageBlockQuoteModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
8
+ }
@@ -0,0 +1,34 @@
1
+ import { Alignment } from "../../enums/SDKAlignment";
2
+ import { Size } from "../../support/SDKSize";
3
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
4
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
5
+ import { DocumentationPageBlock } from "../SDKDocumentationPageBlock";
6
+ import { DocumentationPageBlockTextModel } from "./SDKDocumentationPageBlockText";
7
+ export interface DocumentationPageBlockRenderCodeModel extends DocumentationPageBlockTextModel {
8
+ alignment: Alignment;
9
+ renderCodeProperties: {
10
+ showCode: boolean;
11
+ };
12
+ backgroundColor?: {
13
+ value?: string;
14
+ };
15
+ size?: Size;
16
+ }
17
+ declare enum DocumentationPageBlockRenderCodeEnvironmentType {
18
+ react = "react"
19
+ }
20
+ export declare class DocumentationPageBlockRenderCode extends DocumentationPageBlock {
21
+ alignment: Alignment;
22
+ backgroundColor: string | null;
23
+ showCode: boolean;
24
+ code: string;
25
+ packageJSON: string;
26
+ height: number | null;
27
+ sandboxData: string;
28
+ sandboxType: DocumentationPageBlockRenderCodeEnvironmentType;
29
+ constructor(model: DocumentationPageBlockRenderCodeModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
30
+ private encodeSandboxData;
31
+ btoaUnicode(str: any): string;
32
+ atobUnicode(str: any): string;
33
+ }
34
+ export {};
@@ -0,0 +1,35 @@
1
+ import { DocumentationPageAssetModel } from "../SDKDocumentationPageAsset";
2
+ export interface DocumentationPageBlockShortcutModel {
3
+ title?: string;
4
+ description?: string;
5
+ asset?: DocumentationPageAssetModel;
6
+ assetId?: string;
7
+ assetUrl?: string;
8
+ documentationItemId?: string;
9
+ url?: string;
10
+ urlPreview?: {
11
+ title?: string;
12
+ description?: string;
13
+ thumbnailUrl?: string;
14
+ };
15
+ documentationItemPreview?: {
16
+ title?: string;
17
+ valid?: boolean;
18
+ };
19
+ }
20
+ export declare enum DocumentationPageBlockShortcutType {
21
+ external = "External",
22
+ internal = "Internal"
23
+ }
24
+ export declare class DocumentationPageBlockShortcut {
25
+ title: string | null;
26
+ description: string | null;
27
+ previewUrl: string | null;
28
+ externalUrl: string | null;
29
+ internalId: string | null;
30
+ type: DocumentationPageBlockShortcutType;
31
+ constructor(model: DocumentationPageBlockShortcutModel);
32
+ shortcutTitleFromModel(model: DocumentationPageBlockShortcutModel, type: DocumentationPageBlockShortcutType): string | null;
33
+ shortcutDescriptionFromModel(model: DocumentationPageBlockShortcutModel, type: DocumentationPageBlockShortcutType): string | null;
34
+ shortcutPreviewUrlFromModel(model: DocumentationPageBlockShortcutModel, type: DocumentationPageBlockShortcutType): string | null;
35
+ }
@@ -0,0 +1,11 @@
1
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
2
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
3
+ import { DocumentationPageBlockModel, DocumentationPageBlock } from "../SDKDocumentationPageBlock";
4
+ import { DocumentationPageBlockShortcutModel, DocumentationPageBlockShortcut } from "./SDKDocumentationPageBlockShortcut";
5
+ export interface DocumentationPageBlockShortcutsModel extends DocumentationPageBlockModel {
6
+ shortcuts: Array<DocumentationPageBlockShortcutModel>;
7
+ }
8
+ export declare class DocumentationPageBlockShortcuts extends DocumentationPageBlock {
9
+ shortcuts: Array<DocumentationPageBlockShortcut>;
10
+ constructor(model: DocumentationPageBlockShortcutsModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
11
+ }
@@ -0,0 +1,8 @@
1
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
2
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
3
+ import { DocumentationPageBlockModel, DocumentationPageBlock } from "../SDKDocumentationPageBlock";
4
+ export interface DocumentationPageBlockTabModel extends DocumentationPageBlockModel {
5
+ }
6
+ export declare class DocumentationPageBlockTab extends DocumentationPageBlock {
7
+ constructor(model: DocumentationPageBlockTabModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
8
+ }
@@ -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 DocumentationPageBlockTabItemModel extends DocumentationPageBlockModel {
5
+ caption: string;
6
+ }
7
+ export declare class DocumentationPageBlockTabItem extends DocumentationPageBlock {
8
+ caption: string;
9
+ constructor(model: DocumentationPageBlockTabItemModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
10
+ }
@@ -0,0 +1,23 @@
1
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
2
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
3
+ import { DocumentationPageBlockModel, DocumentationPageBlock } from "../SDKDocumentationPageBlock";
4
+ import { DocumentationPageBlockTableColumn, DocumentationPageBlockTableColumnModel } from "./SDKDocumentationPageBlockTableColumn";
5
+ import { DocumentationPageBlockTableRowModel } from "./SDKDocumentationPageBlockTableRow";
6
+ export interface DocumentationPageBlockTableModel extends DocumentationPageBlockModel {
7
+ tableProperties: {
8
+ showBorders: boolean;
9
+ showHeaderRow: boolean;
10
+ showHeaderColumn: boolean;
11
+ columns: Array<DocumentationPageBlockTableColumnModel>;
12
+ };
13
+ rows: Array<DocumentationPageBlockTableRowModel>;
14
+ }
15
+ export declare class DocumentationPageBlockTable extends DocumentationPageBlock {
16
+ tableProperties: {
17
+ showBorders: boolean;
18
+ showHeaderRow: boolean;
19
+ showHeaderColumn: boolean;
20
+ columns: Array<DocumentationPageBlockTableColumn>;
21
+ };
22
+ constructor(model: DocumentationPageBlockTableModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
23
+ }
@@ -0,0 +1,13 @@
1
+ import { Alignment } from "../../enums/SDKAlignment";
2
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
3
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
4
+ import { DocumentationPageBlockModel, DocumentationPageBlock } from "../SDKDocumentationPageBlock";
5
+ export interface DocumentationPageBlockTableCellModel extends DocumentationPageBlockModel {
6
+ columnId: string;
7
+ alignment: Alignment;
8
+ }
9
+ export declare class DocumentationPageBlockTableCell extends DocumentationPageBlock {
10
+ columnId: string;
11
+ alignment: Alignment;
12
+ constructor(model: DocumentationPageBlockTableCellModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
13
+ }
@@ -0,0 +1,10 @@
1
+ import { MeasureTokenRemoteData } from "../../../model/tokens/remote/SDKRemoteTokenData";
2
+ export interface DocumentationPageBlockTableColumnModel {
3
+ id: string;
4
+ width: MeasureTokenRemoteData;
5
+ }
6
+ export declare class DocumentationPageBlockTableColumn {
7
+ id: string;
8
+ width: MeasureTokenRemoteData;
9
+ constructor(model: DocumentationPageBlockTableColumnModel);
10
+ }
@@ -0,0 +1,8 @@
1
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
2
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
3
+ import { DocumentationPageBlockModel, DocumentationPageBlock } from "../SDKDocumentationPageBlock";
4
+ export interface DocumentationPageBlockTableRowModel extends DocumentationPageBlockModel {
5
+ }
6
+ export declare class DocumentationPageBlockTableRow extends DocumentationPageBlock {
7
+ constructor(model: DocumentationPageBlockTableRowModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
8
+ }
@@ -0,0 +1,13 @@
1
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
2
+ import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
3
+ import { DocumentationPageBlockModel, DocumentationPageBlock } from "../SDKDocumentationPageBlock";
4
+ import { DocumentationRichTextModel, DocumentationRichText } from "../SDKDocumentationRichText";
5
+ export interface DocumentationPageBlockTextModel extends DocumentationPageBlockModel {
6
+ text: DocumentationRichTextModel;
7
+ }
8
+ export declare class DocumentationPageBlockText extends DocumentationPageBlock {
9
+ text: DocumentationRichText;
10
+ constructor(model: DocumentationPageBlockTextModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
11
+ /** Convert block into plain text, omitting any formatting */
12
+ asPlainText(): string;
13
+ }
@@ -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 DocumentationPageBlockTokenModel extends DocumentationPageBlockModel {
5
+ designObjectId: string;
6
+ }
7
+ export declare class DocumentationPageBlockToken extends DocumentationPageBlock {
8
+ tokenId: string;
9
+ constructor(model: DocumentationPageBlockTokenModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
10
+ }