@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.
Files changed (150) hide show
  1. package/README.md +1 -10
  2. package/build/sdk-typescript/src/core/areas/SDKAreaDataSources.d.ts +3 -3
  3. package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +20 -28
  4. package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +9 -7
  5. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +8 -7
  6. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +1 -0
  7. package/build/sdk-typescript/src/core/resolvers/SDKDocumentationItemResolver.d.ts +10 -10
  8. package/build/sdk-typescript/src/exports.d.ts +103 -52
  9. package/build/sdk-typescript/src/model/base/SDKDesignSystem.d.ts +2 -2
  10. package/build/sdk-typescript/src/model/base/SDKDocumentationLegacy.d.ts +10 -0
  11. package/build/sdk-typescript/src/model/docs/SDKDocsConfiguration.d.ts +13 -0
  12. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockBehavior.d.ts +45 -0
  13. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockDefinition.d.ts +55 -0
  14. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockItem.d.ts +27 -0
  15. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockLayout.d.ts +16 -0
  16. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockOnboarding.d.ts +11 -0
  17. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockVariant.d.ts +41 -0
  18. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/blockquote/SDKDocsBlockActualBlockquote.d.ts +6 -0
  19. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/callout/SDKDocsBlockActualCallout.d.ts +6 -0
  20. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/color-accessibility-grid/SDKDocsBlockActualAccessibilityGrid.d.ts +6 -0
  21. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/divider/SDKDocsBlockActualDivider.d.ts +6 -0
  22. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/h1/SDKDocsBlockActualH1.d.ts +6 -0
  23. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/h2/SDKDocsBlockActualH2.d.ts +6 -0
  24. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/h3/SDKDocsBlockActualH3.d.ts +6 -0
  25. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/h4/SDKDocsBlockActualH4.d.ts +6 -0
  26. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/h5/SDKDocsBlockActualH5.d.ts +6 -0
  27. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/image/SDKDocsBlockActualImage.d.ts +6 -0
  28. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/links/SDKDocsBlockActualLinks.d.ts +8 -0
  29. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/ordered-list/SDKDocsBlockActualOrderedList.d.ts +6 -0
  30. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/rich-text/SDKDocsBlockActualRichText.d.ts +6 -0
  31. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/unordered-list/SDKDocsBlockActualUnorderedList.d.ts +6 -0
  32. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts +6 -0
  33. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetPropertyProperty.d.ts +6 -0
  34. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts +12 -0
  35. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeProperty.d.ts +6 -0
  36. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts +6 -0
  37. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts +6 -0
  38. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentPropertyProperty.d.ts +6 -0
  39. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockDividerProperty.d.ts +6 -0
  40. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedFrameProperty.d.ts +9 -0
  41. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts +9 -0
  42. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockImageProperty.d.ts +13 -0
  43. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMarkdownProperty.d.ts +11 -0
  44. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty.d.ts +20 -0
  45. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockNumberProperty.d.ts +15 -0
  46. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockProperty.d.ts +34 -0
  47. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts +18 -0
  48. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts +26 -0
  49. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTableProperty.d.ts +11 -0
  50. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +19 -0
  51. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +15 -0
  52. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenPropertyProperty.d.ts +11 -0
  53. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty.d.ts +11 -0
  54. package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsColorRef.d.ts +3 -0
  55. package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsImageRef.d.ts +21 -0
  56. package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsLinkRef.d.ts +21 -0
  57. package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsSizeRef.d.ts +8 -0
  58. package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlock.d.ts +57 -0
  59. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntity.d.ts +27 -0
  60. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityConfiguration.d.ts +10 -0
  61. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityGroup.d.ts +29 -0
  62. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityHeader.d.ts +23 -0
  63. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityPage.d.ts +25 -0
  64. package/build/sdk-typescript/src/model/docs/sections/SDKDocsSection.d.ts +47 -0
  65. package/build/sdk-typescript/src/model/docs/sections/SDKDocsSectionColumn.d.ts +15 -0
  66. package/build/sdk-typescript/src/model/docs/sections/SDKDocsSectionItem.d.ts +15 -0
  67. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyConfiguration.d.ts +13 -0
  68. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyGroup.d.ts +38 -0
  69. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyItem.d.ts +26 -0
  70. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPage.d.ts +32 -0
  71. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageAsset.d.ts +15 -0
  72. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageBlock.d.ts +30 -0
  73. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyRichText.d.ts +10 -0
  74. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyRichTextSpan.d.ts +10 -0
  75. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyRichTextSpanAttribute.d.ts +14 -0
  76. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockAsset.d.ts +15 -0
  77. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockAssets.d.ts +22 -0
  78. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockCallout.d.ts +10 -0
  79. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockCode.d.ts +11 -0
  80. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockColumn.d.ts +4 -0
  81. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockColumnItem.d.ts +9 -0
  82. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockCustom.d.ts +15 -0
  83. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockDivider.d.ts +4 -0
  84. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedFigma.d.ts +4 -0
  85. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedGeneric.d.ts +13 -0
  86. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedLink.d.ts +15 -0
  87. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedStorybook.d.ts +4 -0
  88. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedYoutube.d.ts +4 -0
  89. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockFrame.d.ts +18 -0
  90. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockFrames.d.ts +24 -0
  91. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockHeading.d.ts +10 -0
  92. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockImage.d.ts +16 -0
  93. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockOrderedList.d.ts +4 -0
  94. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockQuote.d.ts +4 -0
  95. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockRenderCode.d.ts +33 -0
  96. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockShortcut.d.ts +35 -0
  97. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockShortcuts.d.ts +9 -0
  98. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTab.d.ts +4 -0
  99. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTabItem.d.ts +8 -0
  100. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTable.d.ts +21 -0
  101. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTableCell.d.ts +11 -0
  102. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTableColumn.d.ts +10 -0
  103. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTableRow.d.ts +4 -0
  104. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockText.d.ts +11 -0
  105. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockToken.d.ts +8 -0
  106. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTokenGroup.d.ts +10 -0
  107. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTokenList.d.ts +8 -0
  108. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockUnorderedList.d.ts +4 -0
  109. package/build/sdk-typescript/src/model/documentation/builder/SDKDocumentationLegacyBlockBuilder.d.ts +6 -0
  110. package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationLegacyItemConfiguration.d.ts +10 -0
  111. package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationLegacyItemHeader.d.ts +30 -0
  112. package/build/sdk-typescript/src/model/enums/SDKDocsBlockBehaviorDataType.d.ts +10 -0
  113. package/build/sdk-typescript/src/model/enums/SDKDocsBlockBehaviorSelectionType.d.ts +8 -0
  114. package/build/sdk-typescript/src/model/enums/SDKDocsBlockCategory.d.ts +20 -0
  115. package/build/sdk-typescript/src/model/enums/SDKDocsBlockImagePropertyAspectRatio.d.ts +10 -0
  116. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemEntityType.d.ts +14 -0
  117. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyOptionRenderingStyle.d.ts +10 -0
  118. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyRichTextStyle.d.ts +20 -0
  119. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyTextStyle.d.ts +8 -0
  120. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +48 -0
  121. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutType.d.ts +6 -0
  122. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutWidth.d.ts +26 -0
  123. package/build/sdk-typescript/src/model/enums/SDKDocsBlockOptionRenderStyle.d.ts +10 -0
  124. package/build/sdk-typescript/src/model/enums/SDKDocsBlockRichTextPropertyStyle.d.ts +22 -0
  125. package/build/sdk-typescript/src/model/enums/SDKDocsBlockTextPropertyStyle.d.ts +8 -0
  126. package/build/sdk-typescript/src/model/enums/SDKDocsEntityGroupBehavior.d.ts +4 -0
  127. package/build/sdk-typescript/src/model/enums/SDKDocsEntityType.d.ts +4 -0
  128. package/build/sdk-typescript/src/model/enums/SDKDocsSectionType.d.ts +6 -0
  129. package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyCalloutType.d.ts +6 -0
  130. package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyGroupBehavior.d.ts +4 -0
  131. package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyHeadingType.d.ts +5 -0
  132. package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyItemType.d.ts +4 -0
  133. package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyPageAssetType.d.ts +4 -0
  134. package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyPageBlockThemeType.d.ts +4 -0
  135. package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyPageBlockType.d.ts +31 -0
  136. package/build/sdk-typescript/src/model/exporters/SDKExporter.d.ts +2 -2
  137. package/build/sdk-typescript/src/model/jobs/SDKImportJob.d.ts +5 -1
  138. package/build/sdk-typescript/src/model/support/SDKSource.d.ts +1 -0
  139. package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +2 -0
  140. package/build/sdk-typescript/src/tests/validators.d.ts +1 -0
  141. package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +335 -0
  142. package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransform.d.ts +4 -4
  143. package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformBlock.d.ts +56 -56
  144. package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformUtil.d.ts +4 -4
  145. package/build/sdk-typescript/src/tools/search-index/SDKToolsDocSearch.d.ts +2 -2
  146. package/build/sdk-typescript/src/utils/DocumentationUtils.d.ts +2 -0
  147. package/build/supernova-sdk-typescript.js +2 -67144
  148. package/build/supernova-sdk-typescript.js.map +1 -1
  149. package/package.json +1 -1
  150. package/build/sdk-typescript/src/tests/Enterprise/PluginFigmaTokens.spec.d.ts +0 -1
@@ -0,0 +1,31 @@
1
+ export declare enum DocumentationLegacyPageBlockType {
2
+ text = "Text",
3
+ heading = "Heading",
4
+ code = "Code",
5
+ unorderedList = "UnorderedList",
6
+ orderedList = "OrderedList",
7
+ quote = "Quote",
8
+ callout = "Callout",
9
+ divider = "Divider",
10
+ image = "Image",
11
+ token = "Token",
12
+ tokenList = "TokenList",
13
+ tokenGroup = "TokenGroup",
14
+ shortcuts = "Shortcuts",
15
+ link = "Link",
16
+ figmaEmbed = "FigmaEmbed",
17
+ youtubeEmbed = "YoutubeEmbed",
18
+ storybookEmbed = "StorybookEmbed",
19
+ genericEmbed = "Embed",
20
+ figmaFrames = "FigmaFrames",
21
+ custom = "Custom",
22
+ renderCode = "RenderCode",
23
+ componentAssets = "ComponentAssets",
24
+ column = "Column",
25
+ columnItem = "ColumnItem",
26
+ tabs = "Tabs",
27
+ tabItem = "TabItem",
28
+ table = "Table",
29
+ tableCell = "TableCell",
30
+ tableRow = "TableRow"
31
+ }
@@ -63,9 +63,9 @@ export declare class Exporter {
63
63
  };
64
64
  /** Contribution of this exporter to the Supernova system */
65
65
  contributes: {
66
- /** Documentation block variants */
66
+ /** DocumentationLegacy block variants */
67
67
  blockVariants: Array<ExporterCustomBlockVariant>;
68
- /** Documentation blocks */
68
+ /** DocumentationLegacy blocks */
69
69
  blocks: Array<ExporterCustomBlock>;
70
70
  /** Exporter configuration */
71
71
  configuration: Array<ExporterConfigurationProperty>;
@@ -1,6 +1,9 @@
1
1
  import { ImportJobOperation } from "../enums/SDKImportJobOperation";
2
2
  import { ImportJobState } from "../enums/SDKImportJobState";
3
3
  import { Source, SourceRemoteModel } from "../support/SDKSource";
4
+ type SourceRemoteModelWithSourceId = Omit<SourceRemoteModel, "id"> & {
5
+ sourceId: string;
6
+ };
4
7
  export type ImportJobRemoteModel = {
5
8
  id: string;
6
9
  designSystemId: string;
@@ -10,7 +13,7 @@ export type ImportJobRemoteModel = {
10
13
  state: ImportJobState;
11
14
  error?: string;
12
15
  operation: ImportJobOperation;
13
- sources: Array<SourceRemoteModel>;
16
+ sources: Array<SourceRemoteModelWithSourceId>;
14
17
  };
15
18
  export declare class ImportJob {
16
19
  /** Unique identifier of the job */
@@ -33,3 +36,4 @@ export declare class ImportJob {
33
36
  sources: Array<Source>;
34
37
  constructor(model: ImportJobRemoteModel);
35
38
  }
39
+ export {};
@@ -108,6 +108,7 @@ export declare class Source {
108
108
  tokenStudio?: SourceModelTokenStudio | null;
109
109
  scope: SourceScope;
110
110
  get hasError(): boolean;
111
+ get hasWarning(): boolean;
111
112
  constructor(model: SourceRemoteModel);
112
113
  /** Constructs representation that can be used to write full object to remote */
113
114
  toRemote(): SourceRemoteModel;
@@ -2,6 +2,8 @@ export type TokenOriginModel = {
2
2
  id?: string;
3
3
  name?: string;
4
4
  sourceId?: string;
5
+ referenceOriginId?: string;
6
+ referencePersistentId?: string;
5
7
  };
6
8
  export declare class TokenOrigin {
7
9
  id: string | null;
@@ -82,3 +82,4 @@ export declare const validateColorTokenJustOpacityRef: (t: any, tokens: Token[],
82
82
  export declare const validateDimensionTokenRef: (t: any, tokens: Token[], description: string, refName: string, measure: number, unit: Unit) => void;
83
83
  export declare const validateBorderTokenRef: (t: any, tokens: Token[], description: string, refName: string, hex: string, position: BorderPosition, style: BorderStyle, measure: number, unit: Unit) => void;
84
84
  export declare const validateBorderTokenInnerRef: (t: any, tokens: Token[], name: string, hex: string, position: BorderPosition, style: BorderStyle, measure: number, unit: Unit) => void;
85
+ export declare const validateOrigin: (t: any, tokens: Token[], name: string, nameRef: string) => void;
@@ -0,0 +1,335 @@
1
+ import { DocsBlockDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockDefinition";
2
+ import { DocsBlockItem } from "../../model/docs/blocks/definition/SDKDocsBlockItem";
3
+ import { DocsBlockLayout } from "../../model/docs/blocks/definition/SDKDocsBlockLayout";
4
+ import { DocsBlockOnboarding } from "../../model/docs/blocks/definition/SDKDocsBlockOnboarding";
5
+ import { DocsBlockVariant } from "../../model/docs/blocks/definition/SDKDocsBlockVariant";
6
+ import { DocsBlockAssetPropertyDefinition, DocsBlockAssetPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockAssetProperty";
7
+ import { DocsBlockAssetPropertyPropertyDefinition, DocsBlockAssetPropertyPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockAssetPropertyProperty";
8
+ import { DocsBlockBooleanPropertyDefinition, DocsBlockBooleanPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockBooleanProperty";
9
+ import { DocsBlockCodePropertyDefinition, DocsBlockCodePropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockCodeProperty";
10
+ import { DocsBlockCodeSandboxPropertyDefinition, DocsBlockCodeSandboxPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty";
11
+ import { DocsBlockComponentPropertyDefinition, DocsBlockComponentPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockComponentProperty";
12
+ import { DocsBlockComponentPropertyPropertyDefinition, DocsBlockComponentPropertyPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockComponentPropertyProperty";
13
+ import { DocsBlockDividerPropertyDefinition, DocsBlockDividerPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockDividerProperty";
14
+ import { DocsBlockEmbedFramePropertyDefinition, DocsBlockEmbedFramePropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockEmbedFrameProperty";
15
+ import { DocsBlockEmbedUrlPropertyDefinition, DocsBlockEmbedUrlPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty";
16
+ import { DocsBlockImagePropertyDefinition, DocsBlockImagePropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockImageProperty";
17
+ import { DocsBlockMarkdownPropertyDefinition, DocsBlockMarkdownPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockMarkdownProperty";
18
+ import { DocsBlockMultiSelectPropertyDefinition, DocsBlockMultiSelectPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty";
19
+ import { DocsBlockNumberPropertyDefinition, DocsBlockNumberPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockNumberProperty";
20
+ import { DocsBlockItemPropertyAnyDefinition } from "../../model/docs/blocks/properties/SDKDocsBlockProperty";
21
+ import { DocsBlockRichTextPropertyDefinition, DocsBlockRichTextPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockRichTextProperty";
22
+ import { DocsBlockSingleSelectPropertyDefinition, DocsBlockSingleSelectPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty";
23
+ import { DocsBlockTablePropertyDefinition, DocsBlockTablePropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockTableProperty";
24
+ import { DocsBlockTextPropertyDefinition, DocsBlockTextPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockTextProperty";
25
+ import { DocsBlockTokenPropertyDefinition, DocsBlockTokenPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockTokenProperty";
26
+ import { DocsBlockTokenPropertyPropertyDefinition, DocsBlockTokenPropertyPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockTokenPropertyProperty";
27
+ import { DocsBlockTokenTypePropertyDefinition, DocsBlockTokenTypePropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty";
28
+ import { DocsBlockBehaviorDataType } from "../../model/enums/SDKDocsBlockBehaviorDataType";
29
+ import { DocsBlockBehaviorSelectionType } from "../../model/enums/SDKDocsBlockBehaviorSelectionType";
30
+ import { DocsBlockCategory } from "../../model/enums/SDKDocsBlockCategory";
31
+ import { DocsBlockItemVariantLayoutWidth } from "../../model/enums/SDKDocsBlockItemVariantLayoutWidth";
32
+ export declare class DocsBlockBuilder {
33
+ /** Create a layout definition with selected properties (or sublayouts) stacked into column */
34
+ columnLayout(children: Array<DocsBlockItemPropertyAnyDefinition | DocsBlockLayout>, width?: DocsBlockItemVariantLayoutWidth | undefined): DocsBlockLayout;
35
+ /** Create a layout definition with selected properties (or sublayouts) stacked into row */
36
+ rowLayout(children: Array<DocsBlockItemPropertyAnyDefinition | DocsBlockLayout>): DocsBlockLayout;
37
+ /** Create an item variant to render the item in a specific way */
38
+ variantUsingCustomLayout(options: {
39
+ id: string;
40
+ name: string;
41
+ image: string;
42
+ layout: DocsBlockLayout;
43
+ maxColumns?: number;
44
+ }): DocsBlockVariant;
45
+ /** Create and item variant to render the item with default layout (all properties will be stacked into a single column) */
46
+ variantUsingDefaultLayout(options: {
47
+ id: string;
48
+ name: string;
49
+ image: string;
50
+ properties: Array<DocsBlockItemPropertyAnyDefinition>;
51
+ maxColumns?: number;
52
+ }): DocsBlockVariant;
53
+ /** Create and item variant to render the item with default layout (all properties will be stacked into a single column) */
54
+ defaultVariantUsingDefaultLayout(options: {
55
+ image: string;
56
+ properties: Array<DocsBlockItemPropertyAnyDefinition>;
57
+ maxColumns?: number;
58
+ }): DocsBlockVariant;
59
+ /** Create block item with a single variant of rendering */
60
+ singleVariantItem(configuration: {
61
+ properties: Array<DocsBlockItemPropertyAnyDefinition>;
62
+ variant: DocsBlockVariant;
63
+ appearance?: {
64
+ isBordered?: boolean;
65
+ hasBackground?: boolean;
66
+ };
67
+ }): DocsBlockItem;
68
+ /** Create block item with multiple variants of rendering. The first variant becomes the default one */
69
+ multiVariantItem(configuration: {
70
+ properties: Array<DocsBlockItemPropertyAnyDefinition>;
71
+ variants: Array<DocsBlockVariant>;
72
+ appearance?: {
73
+ isBordered?: boolean;
74
+ hasBackground?: boolean;
75
+ };
76
+ }): DocsBlockItem;
77
+ /** Creates a core block definition which can't select from Supernova data, and its item can only be created once (Examples: Rich Text, Callout, Heading blocks) */
78
+ singleItemBlock(configuration: {
79
+ id: string;
80
+ name: string;
81
+ category: DocsBlockCategory;
82
+ description?: string;
83
+ item: DocsBlockItem;
84
+ linkable?: boolean;
85
+ isBordered?: boolean;
86
+ hasBackground?: boolean;
87
+ searchKeywords?: Array<string>;
88
+ onboarding?: DocsBlockOnboarding;
89
+ }): DocsBlockDefinition;
90
+ /** Creates a core block definition which can't select from Supernova data, and its items can be created multiple times (Examples: Shortcuts block) */
91
+ multiItemBlock(configuration: {
92
+ id: string;
93
+ name: string;
94
+ category: DocsBlockCategory;
95
+ item: DocsBlockItem;
96
+ maxItems?: number;
97
+ description?: string;
98
+ linkable?: boolean;
99
+ isBordered?: boolean;
100
+ hasBackground?: boolean;
101
+ searchKeywords?: Array<string>;
102
+ onboarding?: DocsBlockOnboarding;
103
+ }): DocsBlockDefinition;
104
+ /** Creates a core block definition which will be allowed to select from Supernova data (Examples: Token, Asset block) */
105
+ dataBlock(configuration: {
106
+ id: string;
107
+ name: string;
108
+ category: DocsBlockCategory;
109
+ item: DocsBlockItem;
110
+ dataType: Exclude<DocsBlockBehaviorDataType, DocsBlockBehaviorDataType.item>;
111
+ selectionType: DocsBlockBehaviorSelectionType;
112
+ maxSelection?: number;
113
+ description?: string;
114
+ linkable?: boolean;
115
+ isBordered?: boolean;
116
+ hasBackground?: boolean;
117
+ searchKeywords?: Array<string>;
118
+ onboarding?: DocsBlockOnboarding;
119
+ }): DocsBlockDefinition;
120
+ /** Creates onboarding entity */
121
+ onboarding(configuration: {
122
+ helpText: string;
123
+ documentationLink?: string;
124
+ }): DocsBlockOnboarding;
125
+ /** Create a block property with type .text and its specific options */
126
+ textProperty(configuration: {
127
+ id: string;
128
+ name: string;
129
+ description?: string;
130
+ options: DocsBlockTextPropertyOptions;
131
+ variants?: {
132
+ [key: string]: DocsBlockTextPropertyOptions;
133
+ };
134
+ }): DocsBlockTextPropertyDefinition;
135
+ /** Create a block property with type .richText and its specific options */
136
+ richTextProperty(configuration: {
137
+ id: string;
138
+ name: string;
139
+ description?: string;
140
+ options: DocsBlockRichTextPropertyOptions;
141
+ variants?: {
142
+ [key: string]: DocsBlockRichTextPropertyOptions;
143
+ };
144
+ }): DocsBlockRichTextPropertyDefinition;
145
+ /** Create a block property with type .boolean and its specific options */
146
+ booleanProperty(configuration: {
147
+ id: string;
148
+ name: string;
149
+ description?: string;
150
+ options: DocsBlockBooleanPropertyOptions;
151
+ variants?: {
152
+ [key: string]: DocsBlockBooleanPropertyOptions;
153
+ };
154
+ }): DocsBlockBooleanPropertyDefinition;
155
+ /** Create a block property with type .number and its specific options */
156
+ numericProperty(configuration: {
157
+ id: string;
158
+ name: string;
159
+ description?: string;
160
+ options: DocsBlockNumberPropertyOptions;
161
+ variants?: {
162
+ [key: string]: DocsBlockNumberPropertyOptions;
163
+ };
164
+ }): DocsBlockNumberPropertyDefinition;
165
+ /** Create a block property with type .singleSelect and its specific options */
166
+ singleSelectProperty(configuration: {
167
+ id: string;
168
+ name: string;
169
+ description?: string;
170
+ options: DocsBlockSingleSelectPropertyOptions;
171
+ variants?: {
172
+ [key: string]: DocsBlockSingleSelectPropertyOptions;
173
+ };
174
+ }): DocsBlockSingleSelectPropertyDefinition;
175
+ /** Create a block property with type .multiSelect and its specific options */
176
+ multiSelectProperty(configuration: {
177
+ id: string;
178
+ name: string;
179
+ description?: string;
180
+ options: DocsBlockMultiSelectPropertyOptions;
181
+ variants?: {
182
+ [key: string]: DocsBlockMultiSelectPropertyOptions;
183
+ };
184
+ }): DocsBlockMultiSelectPropertyDefinition;
185
+ /** Create a block property with type .image and its specific options */
186
+ imageProperty(configuration: {
187
+ id: string;
188
+ name: string;
189
+ description?: string;
190
+ options?: DocsBlockImagePropertyOptions;
191
+ variants?: {
192
+ [key: string]: DocsBlockImagePropertyOptions;
193
+ };
194
+ }): DocsBlockImagePropertyDefinition;
195
+ /** Create a block property with type .token and its specific options */
196
+ tokenProperty(configuration: {
197
+ id: string;
198
+ name: string;
199
+ description?: string;
200
+ options: DocsBlockTokenPropertyOptions;
201
+ variants?: {
202
+ [key: string]: DocsBlockTokenPropertyOptions;
203
+ };
204
+ }): DocsBlockTokenPropertyDefinition;
205
+ /** Create a block property with type .tokenType and its specific options */
206
+ tokenTypeProperty(configuration: {
207
+ id: string;
208
+ name: string;
209
+ description?: string;
210
+ options: DocsBlockTokenTypePropertyOptions;
211
+ variants?: {
212
+ [key: string]: DocsBlockTokenTypePropertyOptions;
213
+ };
214
+ }): DocsBlockTokenTypePropertyDefinition;
215
+ /** Create a block property with type .tokenProperty and its specific options */
216
+ tokenPropertyProperty(configuration: {
217
+ id: string;
218
+ name: string;
219
+ description?: string;
220
+ options: DocsBlockTokenPropertyPropertyOptions;
221
+ variants?: {
222
+ [key: string]: DocsBlockTokenPropertyPropertyOptions;
223
+ };
224
+ }): DocsBlockTokenPropertyPropertyDefinition;
225
+ /** Create a block property with type .component and its specific options */
226
+ componentProperty(configuration: {
227
+ id: string;
228
+ name: string;
229
+ description?: string;
230
+ options: DocsBlockComponentPropertyOptions;
231
+ variants?: {
232
+ [key: string]: DocsBlockComponentPropertyOptions;
233
+ };
234
+ }): DocsBlockComponentPropertyDefinition;
235
+ /** Create a block property with type .componentProperty and its specific options */
236
+ componentPropertyProperty(configuration: {
237
+ id: string;
238
+ name: string;
239
+ description?: string;
240
+ options: DocsBlockComponentPropertyPropertyOptions;
241
+ variants?: {
242
+ [key: string]: DocsBlockComponentPropertyPropertyOptions;
243
+ };
244
+ }): DocsBlockComponentPropertyPropertyDefinition;
245
+ /** Create a block property with type .asset and its specific options */
246
+ assetProperty(configuration: {
247
+ id: string;
248
+ name: string;
249
+ description?: string;
250
+ options: DocsBlockAssetPropertyOptions;
251
+ variants?: {
252
+ [key: string]: DocsBlockAssetPropertyOptions;
253
+ };
254
+ }): DocsBlockAssetPropertyDefinition;
255
+ /** Create a block property with type .assetProperty and its specific options */
256
+ assetPropertyProperty(configuration: {
257
+ id: string;
258
+ name: string;
259
+ description?: string;
260
+ options: DocsBlockAssetPropertyPropertyOptions;
261
+ variants?: {
262
+ [key: string]: DocsBlockAssetPropertyPropertyOptions;
263
+ };
264
+ }): DocsBlockAssetPropertyPropertyDefinition;
265
+ /** Create a block property with type .embedURL and its specific options */
266
+ embedUrlProperty(configuration: {
267
+ id: string;
268
+ name: string;
269
+ description?: string;
270
+ options: DocsBlockEmbedUrlPropertyOptions;
271
+ variants?: {
272
+ [key: string]: DocsBlockEmbedUrlPropertyOptions;
273
+ };
274
+ }): DocsBlockEmbedUrlPropertyDefinition;
275
+ /** Create a block property with type .embedFrame and its specific options */
276
+ embedFrameProperty(configuration: {
277
+ id: string;
278
+ name: string;
279
+ description?: string;
280
+ options: DocsBlockEmbedFramePropertyOptions;
281
+ variants?: {
282
+ [key: string]: DocsBlockEmbedFramePropertyOptions;
283
+ };
284
+ }): DocsBlockEmbedFramePropertyDefinition;
285
+ /** Create a block property with type .markdown and its specific options */
286
+ markdownProperty(configuration: {
287
+ id: string;
288
+ name: string;
289
+ description?: string;
290
+ options: DocsBlockMarkdownPropertyOptions;
291
+ variants?: {
292
+ [key: string]: DocsBlockMarkdownPropertyOptions;
293
+ };
294
+ }): DocsBlockMarkdownPropertyDefinition;
295
+ /** Create a block property with type .code and its specific options */
296
+ codeProperty(configuration: {
297
+ id: string;
298
+ name: string;
299
+ description?: string;
300
+ options: DocsBlockCodePropertyOptions;
301
+ variants?: {
302
+ [key: string]: DocsBlockCodePropertyOptions;
303
+ };
304
+ }): DocsBlockCodePropertyDefinition;
305
+ /** Create a block property with type .codeSandbox and its specific options */
306
+ codeSandboxProperty(configuration: {
307
+ id: string;
308
+ name: string;
309
+ description?: string;
310
+ options: DocsBlockCodeSandboxPropertyOptions;
311
+ variants?: {
312
+ [key: string]: DocsBlockCodeSandboxPropertyOptions;
313
+ };
314
+ }): DocsBlockCodeSandboxPropertyDefinition;
315
+ /** Create a block property with type .table and its specific options */
316
+ tableProperty(configuration: {
317
+ id: string;
318
+ name: string;
319
+ description?: string;
320
+ options: DocsBlockTablePropertyOptions;
321
+ variants?: {
322
+ [key: string]: DocsBlockTablePropertyOptions;
323
+ };
324
+ }): DocsBlockTablePropertyDefinition;
325
+ /** Create a block property with type .divider and its specific options */
326
+ dividerProperty(configuration: {
327
+ id: string;
328
+ name: string;
329
+ description?: string;
330
+ options: DocsBlockDividerPropertyOptions;
331
+ variants?: {
332
+ [key: string]: DocsBlockDividerPropertyOptions;
333
+ };
334
+ }): DocsBlockDividerPropertyDefinition;
335
+ }
@@ -1,6 +1,6 @@
1
1
  import { Supernova } from "../../core/SDKSupernova";
2
- import { DocumentationPage } from "../../model/documentation/SDKDocumentationPage";
3
- import { DocumentationPageBlockType } from "../../model/enums/SDKDocumentationPageBlockType";
2
+ import { DocumentationLegacyPage } from "../../model/documentation/SDKDocumentationLegacyPage";
3
+ import { DocumentationLegacyPageBlockType } from "../../model/enums/SDKDocumentationLegacyPageBlockType";
4
4
  import { MarkdownTransformBlock } from "./SDKToolsMarkdownTransformBlock";
5
5
  /** Output markdown mode. Commonmark and GitHub is currently supported */
6
6
  export declare enum MarkdownTransformType {
@@ -13,10 +13,10 @@ export declare class MarkdownTransform {
13
13
  blockTransformer: MarkdownTransformBlock;
14
14
  constructor(type: MarkdownTransformType, instance: Supernova, designSystemId: string, workspaceId: string, versionId: string);
15
15
  /** Converts entire definition of the page, including its metadata like title and description, to markdown */
16
- convertPageToMarkdown(page: DocumentationPage): Promise<string>;
16
+ convertPageToMarkdown(page: DocumentationLegacyPage): Promise<string>;
17
17
  /** Creates flattened structure of the blocks, even from the contained blocks, so it is easier to iterate through them */
18
18
  private flattenedBlocksOfPage;
19
19
  /** Flattens one leaf of blocks */
20
20
  private flattenedBlocksOfBlock;
21
- isContainer(blockType: DocumentationPageBlockType): boolean;
21
+ isContainer(blockType: DocumentationLegacyPageBlockType): boolean;
22
22
  }
@@ -1,32 +1,32 @@
1
1
  import { Supernova } from "../../core/SDKSupernova";
2
- import { DocumentationPageBlockAssets } from "../../model/documentation/blocks/SDKDocumentationPageBlockAssets";
3
- import { DocumentationPageBlockCallout } from "../../model/documentation/blocks/SDKDocumentationPageBlockCallout";
4
- import { DocumentationPageBlockCode } from "../../model/documentation/blocks/SDKDocumentationPageBlockCode";
5
- import { DocumentationPageBlockColumn } from "../../model/documentation/blocks/SDKDocumentationPageBlockColumn";
6
- import { DocumentationPageBlockColumnItem } from "../../model/documentation/blocks/SDKDocumentationPageBlockColumnItem";
7
- import { DocumentationPageBlockEmbedFigma } from "../../model/documentation/blocks/SDKDocumentationPageBlockEmbedFigma";
8
- import { DocumentationPageBlockEmbedGeneric } from "../../model/documentation/blocks/SDKDocumentationPageBlockEmbedGeneric";
9
- import { DocumentationPageBlockEmbedLink } from "../../model/documentation/blocks/SDKDocumentationPageBlockEmbedLink";
10
- import { DocumentationPageBlockEmbedStorybook } from "../../model/documentation/blocks/SDKDocumentationPageBlockEmbedStorybook";
11
- import { DocumentationPageBlockEmbedYoutube } from "../../model/documentation/blocks/SDKDocumentationPageBlockEmbedYoutube";
12
- import { DocumentationPageBlockFrames } from "../../model/documentation/blocks/SDKDocumentationPageBlockFrames";
13
- import { DocumentationPageBlockHeading } from "../../model/documentation/blocks/SDKDocumentationPageBlockHeading";
14
- import { DocumentationPageBlockImage } from "../../model/documentation/blocks/SDKDocumentationPageBlockImage";
15
- import { DocumentationPageOrderedList } from "../../model/documentation/blocks/SDKDocumentationPageBlockOrderedList";
16
- import { DocumentationPageBlockQuote } from "../../model/documentation/blocks/SDKDocumentationPageBlockQuote";
17
- import { DocumentationPageBlockRenderCode } from "../../model/documentation/blocks/SDKDocumentationPageBlockRenderCode";
18
- import { DocumentationPageBlockShortcuts } from "../../model/documentation/blocks/SDKDocumentationPageBlockShortcuts";
19
- import { DocumentationPageBlockTab } from "../../model/documentation/blocks/SDKDocumentationPageBlockTab";
20
- import { DocumentationPageBlockTabItem } from "../../model/documentation/blocks/SDKDocumentationPageBlockTabItem";
21
- import { DocumentationPageBlockTable } from "../../model/documentation/blocks/SDKDocumentationPageBlockTable";
22
- import { DocumentationPageBlockTableCell } from "../../model/documentation/blocks/SDKDocumentationPageBlockTableCell";
23
- import { DocumentationPageBlockText } from "../../model/documentation/blocks/SDKDocumentationPageBlockText";
24
- import { DocumentationPageBlockToken } from "../../model/documentation/blocks/SDKDocumentationPageBlockToken";
25
- import { DocumentationPageBlockTokenGroup } from "../../model/documentation/blocks/SDKDocumentationPageBlockTokenGroup";
26
- import { DocumentationPageBlockTokenList } from "../../model/documentation/blocks/SDKDocumentationPageBlockTokenList";
27
- import { DocumentationPageUnorderedList } from "../../model/documentation/blocks/SDKDocumentationPageBlockUnorderedList";
28
- import { DocumentationPage } from "../../model/documentation/SDKDocumentationPage";
29
- import { DocumentationPageBlock } from "../../model/documentation/SDKDocumentationPageBlock";
2
+ import { DocumentationLegacyPageBlockAssets } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockAssets";
3
+ import { DocumentationLegacyPageBlockCallout } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockCallout";
4
+ import { DocumentationLegacyPageBlockCode } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockCode";
5
+ import { DocumentationLegacyPageBlockColumn } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockColumn";
6
+ import { DocumentationLegacyPageBlockColumnItem } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockColumnItem";
7
+ import { DocumentationLegacyPageBlockEmbedFigma } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedFigma";
8
+ import { DocumentationLegacyPageBlockEmbedGeneric } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedGeneric";
9
+ import { DocumentationLegacyPageBlockEmbedLink } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedLink";
10
+ import { DocumentationLegacyPageBlockEmbedStorybook } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedStorybook";
11
+ import { DocumentationLegacyPageBlockEmbedYoutube } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedYoutube";
12
+ import { DocumentationLegacyPageBlockFrames } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockFrames";
13
+ import { DocumentationLegacyPageBlockHeading } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockHeading";
14
+ import { DocumentationLegacyPageBlockImage } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockImage";
15
+ import { DocumentationLegacyPageOrderedList } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockOrderedList";
16
+ import { DocumentationLegacyPageBlockQuote } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockQuote";
17
+ import { DocumentationLegacyPageBlockRenderCode } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockRenderCode";
18
+ import { DocumentationLegacyPageBlockShortcuts } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockShortcuts";
19
+ import { DocumentationLegacyPageBlockTab } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockTab";
20
+ import { DocumentationLegacyPageBlockTabItem } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockTabItem";
21
+ import { DocumentationLegacyPageBlockTable } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockTable";
22
+ import { DocumentationLegacyPageBlockTableCell } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockTableCell";
23
+ import { DocumentationLegacyPageBlockText } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockText";
24
+ import { DocumentationLegacyPageBlockToken } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockToken";
25
+ import { DocumentationLegacyPageBlockTokenGroup } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockTokenGroup";
26
+ import { DocumentationLegacyPageBlockTokenList } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockTokenList";
27
+ import { DocumentationLegacyPageUnorderedList } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockUnorderedList";
28
+ import { DocumentationLegacyPage } from "../../model/documentation/SDKDocumentationLegacyPage";
29
+ import { DocumentationLegacyPageBlock } from "../../model/documentation/SDKDocumentationLegacyPageBlock";
30
30
  import { MarkdownTransformType } from "./SDKToolsMarkdownTransform";
31
31
  /** Markdown block transformer */
32
32
  export declare class MarkdownTransformBlock {
@@ -39,37 +39,37 @@ export declare class MarkdownTransformBlock {
39
39
  newlineSeparator: string;
40
40
  constructor(type: MarkdownTransformType, instance: Supernova, designSystemId: string, workspaceId: string, versionId: string);
41
41
  /** Converts a single block - depending on the type - to a markdown definition of specific type */
42
- convertBlockToMarkdown(block: DocumentationPageBlock, pageContext: DocumentationPage): Promise<string | null>;
43
- convertHeadingBlock(block: DocumentationPageBlockHeading): string | null;
44
- convertCalloutBlock(block: DocumentationPageBlockCallout): string | null;
45
- convertQuoteBlock(block: DocumentationPageBlockQuote): string | null;
42
+ convertBlockToMarkdown(block: DocumentationLegacyPageBlock, pageContext: DocumentationLegacyPage): Promise<string | null>;
43
+ convertHeadingBlock(block: DocumentationLegacyPageBlockHeading): string | null;
44
+ convertCalloutBlock(block: DocumentationLegacyPageBlockCallout): string | null;
45
+ convertQuoteBlock(block: DocumentationLegacyPageBlockQuote): string | null;
46
46
  convertDividerBlock(): string | null;
47
- convertImageBlock(block: DocumentationPageBlockImage): string | null;
48
- convertOrderedListBlock(block: DocumentationPageOrderedList): string | null;
49
- convertUnorderedListBlock(block: DocumentationPageUnorderedList): string | null;
50
- convertLiveCodeBlock(block: DocumentationPageBlockRenderCode): string | null;
51
- convertCodeBlock(block: DocumentationPageBlockCode): string | null;
52
- convertTextBlock(block: DocumentationPageBlockText): string | null;
53
- convertGenericEmbedBlock(block: DocumentationPageBlockEmbedGeneric): string | null;
54
- convertStorybookEmbedBlock(block: DocumentationPageBlockEmbedStorybook): string | null;
55
- convertLinkBlock(block: DocumentationPageBlockEmbedLink): string | null;
56
- convertYoutubeEmbedBlock(block: DocumentationPageBlockEmbedYoutube): string | null;
57
- convertFigmaEmbedBlock(block: DocumentationPageBlockEmbedFigma): string | null;
58
- convertTokenBlock(block: DocumentationPageBlockToken): Promise<string | null>;
59
- convertTokenListBlock(block: DocumentationPageBlockTokenList): Promise<string | null>;
60
- convertTokenGroupBlock(block: DocumentationPageBlockTokenGroup): Promise<string | null>;
47
+ convertImageBlock(block: DocumentationLegacyPageBlockImage): string | null;
48
+ convertOrderedListBlock(block: DocumentationLegacyPageOrderedList): string | null;
49
+ convertUnorderedListBlock(block: DocumentationLegacyPageUnorderedList): string | null;
50
+ convertLiveCodeBlock(block: DocumentationLegacyPageBlockRenderCode): string | null;
51
+ convertCodeBlock(block: DocumentationLegacyPageBlockCode): string | null;
52
+ convertTextBlock(block: DocumentationLegacyPageBlockText): string | null;
53
+ convertGenericEmbedBlock(block: DocumentationLegacyPageBlockEmbedGeneric): string | null;
54
+ convertStorybookEmbedBlock(block: DocumentationLegacyPageBlockEmbedStorybook): string | null;
55
+ convertLinkBlock(block: DocumentationLegacyPageBlockEmbedLink): string | null;
56
+ convertYoutubeEmbedBlock(block: DocumentationLegacyPageBlockEmbedYoutube): string | null;
57
+ convertFigmaEmbedBlock(block: DocumentationLegacyPageBlockEmbedFigma): string | null;
58
+ convertTokenBlock(block: DocumentationLegacyPageBlockToken): Promise<string | null>;
59
+ convertTokenListBlock(block: DocumentationLegacyPageBlockTokenList): Promise<string | null>;
60
+ convertTokenGroupBlock(block: DocumentationLegacyPageBlockTokenGroup): Promise<string | null>;
61
61
  private flattenedGroupsFromRoot;
62
- convertComponentAssetBlock(block: DocumentationPageBlockAssets): Promise<string | null>;
63
- convertFigmaFramesBlock(block: DocumentationPageBlockFrames): string | null;
64
- convertShortcutsBlock(block: DocumentationPageBlockShortcuts, pageContext: DocumentationPage): Promise<string | null>;
62
+ convertComponentAssetBlock(block: DocumentationLegacyPageBlockAssets): Promise<string | null>;
63
+ convertFigmaFramesBlock(block: DocumentationLegacyPageBlockFrames): string | null;
64
+ convertShortcutsBlock(block: DocumentationLegacyPageBlockShortcuts, pageContext: DocumentationLegacyPage): Promise<string | null>;
65
65
  private relativePathToPage;
66
- convertTableBlock(block: DocumentationPageBlockTable, pageContext: DocumentationPage): Promise<string | null>;
66
+ convertTableBlock(block: DocumentationLegacyPageBlockTable, pageContext: DocumentationLegacyPage): Promise<string | null>;
67
67
  convertTableRowBlock(): string | null;
68
- convertTableCellBlock(block: DocumentationPageBlockTableCell, pageContext: DocumentationPage): Promise<string | null>;
69
- convertTabsBlock(block: DocumentationPageBlockTab, pageContext: DocumentationPage): Promise<string | null>;
70
- convertTabItemBlock(block: DocumentationPageBlockTabItem, pageContext: DocumentationPage): Promise<string | null>;
71
- convertColumnBlock(block: DocumentationPageBlockColumn, pageContext: DocumentationPage): Promise<string | null>;
72
- convertColumnItemBlock(block: DocumentationPageBlockColumnItem, pageContext: DocumentationPage): Promise<string | null>;
68
+ convertTableCellBlock(block: DocumentationLegacyPageBlockTableCell, pageContext: DocumentationLegacyPage): Promise<string | null>;
69
+ convertTabsBlock(block: DocumentationLegacyPageBlockTab, pageContext: DocumentationLegacyPage): Promise<string | null>;
70
+ convertTabItemBlock(block: DocumentationLegacyPageBlockTabItem, pageContext: DocumentationLegacyPage): Promise<string | null>;
71
+ convertColumnBlock(block: DocumentationLegacyPageBlockColumn, pageContext: DocumentationLegacyPage): Promise<string | null>;
72
+ convertColumnItemBlock(block: DocumentationLegacyPageBlockColumnItem, pageContext: DocumentationLegacyPage): Promise<string | null>;
73
73
  convertCustomBlock(): string | null;
74
- convertURLBlock(block: DocumentationPageBlockEmbedGeneric, userAction: string): string | null;
74
+ convertURLBlock(block: DocumentationLegacyPageBlockEmbedGeneric, userAction: string): string | null;
75
75
  }
@@ -1,5 +1,5 @@
1
- import { DocumentationPageBlockText } from "../../model/documentation/blocks/SDKDocumentationPageBlockText";
2
- import { DocumentationRichText } from "../../model/documentation/SDKDocumentationRichText";
1
+ import { DocumentationLegacyPageBlockText } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockText";
2
+ import { DocumentationLegacyRichText } from "../../model/documentation/SDKDocumentationLegacyRichText";
3
3
  import { Token } from "../../model/tokens/SDKToken";
4
4
  /** Markdown block transformer */
5
5
  export declare class MarkdownTransformUtil {
@@ -10,13 +10,13 @@ export declare class MarkdownTransformUtil {
10
10
  * This is very naive implementation and will break in complicated cases, like double control characters of the same type next to each other
11
11
  * Must improve later with something more sophisticated, ideally tree builder with branched resolution.
12
12
  */
13
- convertTextBlockToMarkdown(block: DocumentationPageBlockText): string | null;
13
+ convertTextBlockToMarkdown(block: DocumentationLegacyPageBlockText): string | null;
14
14
  /** Converts rich text to markdown
15
15
  *
16
16
  * This is very naive implementation and will break in complicated cases, like double control characters of the same type next to each other
17
17
  * Must improve later with something more sophisticated, ideally tree builder with branched resolution.
18
18
  */
19
- convertRichTextToMarkdown(richText: DocumentationRichText): string;
19
+ convertRichTextToMarkdown(richText: DocumentationLegacyRichText): string;
20
20
  /** Convert token to markdown representation */
21
21
  convertTokenToMarkdown(token: Token): string;
22
22
  }
@@ -1,4 +1,4 @@
1
- import { DocumentationPage } from "../../model/documentation/SDKDocumentationPage";
1
+ import { DocumentationLegacyPage } from "../../model/documentation/SDKDocumentationLegacyPage";
2
2
  import Fuse from "fuse.js";
3
3
  export declare enum DocSearchResultDataType {
4
4
  contentBlock = "contentBlock",
@@ -32,7 +32,7 @@ export declare class DocSearch {
32
32
  searchEngine: Fuse<object>;
33
33
  searchConfiguration: DocSearchConfiguration;
34
34
  constructor(configuration: DocSearchConfiguration);
35
- updateSearchIndex: (pages: Array<DocumentationPage>) => Array<DocSearchResultData>;
35
+ updateSearchIndex: (pages: Array<DocumentationLegacyPage>) => Array<DocSearchResultData>;
36
36
  search: (input: string) => Array<DocSearchResult>;
37
37
  /** When using this configuration, the results will be very precise and will not be deviating too much from the query */
38
38
  static defaultPreciseConfiguration(): DocSearchConfiguration;
@@ -0,0 +1,2 @@
1
+ export declare class DocumentationUtils {
2
+ }