@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
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  <img src="https://github.com/Supernova-Studio/sdk-typescript/blob/main/readme-icon.png?raw=true" alt="Supernova SDK" style="max-width:100%; margin-bottom: 20px;" />
2
2
 
3
- # Supernova JS/TS SDK [![License](https://img.shields.io/badge/License-MIT-lightgray)](https://raw.githubusercontent.com/Supernova-Studio/sdk-typescript/main/LICENSE.md) [![SDK Status](https://img.shields.io/badge/SDK%20Status-Beta-blue)]() [![Version 1.7.0](https://img.shields.io/badge/Version-1.7.0-success)]()
3
+ # Supernova JS/TS SDK [![License](https://img.shields.io/badge/License-MIT-lightgray)](https://raw.githubusercontent.com/Supernova-Studio/sdk-typescript/main/LICENSE.md) [![SDK Status](https://img.shields.io/badge/SDK%20Status-Beta-blue)]() [![Version 2.0.1](https://img.shields.io/badge/Version-2.0.1-success)]()
4
4
 
5
5
  The Supernova SDK provides convenient access to the [Supernova.io](https://supernova.io) platform. It allows you to build design system tooling without worrying about building entire necessary infrastructure like syncing data from Figma, Storybook, writing entire documentation systems etc. - instead, you get all of this out of the box, and you can use the data coming from your single source of truth for any other purpose.
6
6
 
@@ -39,15 +39,6 @@ npm install @supernovaio/supernova-sdk
39
39
 
40
40
  Supernova SDK is made to run in both local (like Node.js) and remote environments (like browsers) so you can use it to develop your React sites or any kind of tool you would like to run as client-side app.
41
41
 
42
- ## Examples
43
-
44
- We have prepared several examples to show you some things that are possible:
45
-
46
- - [x] [Supernova + Gatsby Documentation Site Starter](https://github.com/Supernova-Studio/gatsby-documentation-site/)
47
- - [x] [Supernova Gatsby Source Plugin](https://github.com/Supernova-Studio/gatsby-source-supernova)
48
-
49
- We are working on a few more that will be available once SDK launches out of public beta. If you are interested in building something for Supernova as well, don't hesitate to [reach out](https://community.supernova.io) and talk with us!
50
-
51
42
 
52
43
  ## Obtaining API Key
53
44
 
@@ -1,4 +1,4 @@
1
- import { Source } from "../../model/support/SDKSource";
1
+ import { Source, SourceRemoteModelCloud } from "../../model/support/SDKSource";
2
2
  import { DataCore } from "../data/SDKDataCore";
3
3
  import { RemoteBrandIdentifier, RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
4
4
  export declare class AreaDataSources {
@@ -22,7 +22,7 @@ export declare class AreaDataSources {
22
22
  assets: boolean;
23
23
  documentationFrames: boolean;
24
24
  };
25
- autoImport: boolean;
25
+ autoImport: SourceRemoteModelCloud["autoImportMode"];
26
26
  themeId: string | null;
27
27
  }): Promise<Source>;
28
28
  updateFigmaSource(from: RemoteVersionIdentifier, sourceId: string, options: {
@@ -32,7 +32,7 @@ export declare class AreaDataSources {
32
32
  assets: boolean;
33
33
  documentationFrames: boolean;
34
34
  };
35
- autoImport?: boolean;
35
+ autoImport?: SourceRemoteModelCloud["autoImportMode"];
36
36
  themeId?: string | null;
37
37
  }): Promise<Source>;
38
38
  updateFigmaSourceClaimOwnership(from: RemoteVersionIdentifier, sourceId: string): Promise<Source>;
@@ -1,12 +1,11 @@
1
- import { Documentation } from "../../model/base/SDKDocumentation";
2
- import { DocumentationGroup } from "../../model/documentation/SDKDocumentationGroup";
3
- import { DocumentationItem } from "../../model/documentation/SDKDocumentationItem";
4
- import { DocumentationPage } from "../../model/documentation/SDKDocumentationPage";
5
- import { ElementDataView } from "../../model/elements/SDKElementDataView";
6
- import { ElementProperty } from "../../model/elements/SDKElementProperty";
7
- import { ExporterCustomBlock } from "../../model/exporters/custom_blocks/SDKExporterCustomBlock";
1
+ import { DocumentationLegacy, DocumentationLegacyPage } from "../../exports";
2
+ import { DocsBlockDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockDefinition";
3
+ import { DocsBlock } from "../../model/docs/blocks/usage/SDKDocsBlock";
4
+ import { DocsEntity } from "../../model/docs/entities/SDKDocsEntity";
5
+ import { DocsSection } from "../../model/docs/sections/SDKDocsSection";
6
+ import { DocumentationLegacyGroup } from "../../model/documentation/SDKDocumentationLegacyGroup";
8
7
  import { DataCore } from "../data/SDKDataCore";
9
- import { RemoteVersionIdentifier, RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
8
+ import { RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
10
9
  export declare class AreaDocumentation {
11
10
  /** Internal: Engine */
12
11
  private dataCore;
@@ -15,36 +14,29 @@ export declare class AreaDocumentation {
15
14
  * @param from - Remote version to fetch from
16
15
  * @returns Documentation object
17
16
  */
18
- getDocumentation(from: RemoteWorkspaceVersionIdentifier): Promise<Documentation>;
19
- /** Fetches all documentation structural entities, like groups and pages
20
- * @param from - Remote version to fetch from
21
- * @returns All documentation items
22
- */
23
- getDocumentationItems(from: RemoteWorkspaceVersionIdentifier): Promise<Array<DocumentationItem>>;
17
+ getDocumentation(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacy>;
24
18
  /** Fetches all documentation groups
25
19
  * @param from - Remote version to fetch from
26
20
  * @returns All documentation groups
27
21
  */
28
- getDocumentationGroups(from: RemoteWorkspaceVersionIdentifier): Promise<Array<DocumentationGroup>>;
22
+ getDocumentationGroups(from: RemoteWorkspaceVersionIdentifier): Promise<Array<DocumentationLegacyGroup>>;
29
23
  /** Fetches all documentation pages
30
24
  * @param from - Remote version to fetch from
31
25
  * @returns All documentation pages
32
26
  */
33
- getDocumentationPages(from: RemoteWorkspaceVersionIdentifier): Promise<Array<DocumentationPage>>;
34
- /** Fetches all custom blocks that are defined in the active documentation exporter
27
+ getDocumentationPages(from: RemoteWorkspaceVersionIdentifier): Promise<Array<DocumentationLegacyPage>>;
28
+ /** Fetches object containing the structure of the docs - documentation pages and groups with metadata but without the page payloads
29
+ * Not implemented for now
35
30
  * @param from - Remote version to fetch from
36
- * @returns All custom blocks
31
+ * @returnsDocumentationLegacy object
37
32
  */
38
- /** All custom blocks that were registered with the active exporter configuration */
39
- getCustomBlocks(from: RemoteVersionIdentifier): Promise<Array<ExporterCustomBlock>>;
40
- /** Retrieves all remote property definitions for documentation pages
33
+ getDocumentationStructureFromRoot(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacyGroup>;
34
+ /** Fetches entire documentation documentation structure, including all pages and groups and their payloads
41
35
  * @param from - Remote version to fetch from
42
- * @returns All property definitions in the specified version
43
- */
44
- getPageProperties(from: RemoteVersionIdentifier): Promise<Array<ElementProperty>>;
45
- /** Retrieves all remote property views for documentation pages
46
- * @param from - Remote version to fetch from
47
- * @returns All property views in the specified version
36
+ * @returns All documentation items
48
37
  */
49
- getPageDataViews(from: RemoteVersionIdentifier): Promise<Array<ElementDataView>>;
38
+ getDocumentationFromRoot(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacyGroup>;
39
+ getDocumentationMockedStructure(): Array<DocsEntity>;
40
+ getDocumentationMockedPageContent(pageId: string): Array<DocsBlock | DocsSection>;
41
+ getDocumentationMockedEditorBlockDefinitions(): Array<DocsBlockDefinition>;
50
42
  }
@@ -4,10 +4,10 @@ import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
4
4
  import { Brand, BrandUpdateModel } from "../../model/base/SDKBrand";
5
5
  import { DesignSystem } from "../../model/base/SDKDesignSystem";
6
6
  import { DesignSystemVersion, DesignSystemVersionUpdateModel } from "../../model/base/SDKDesignSystemVersion";
7
- import { Documentation } from "../../model/base/SDKDocumentation";
7
+ import { DocumentationLegacy } from "../../model/base/SDKDocumentationLegacy";
8
8
  import { Component } from "../../model/components/SDKComponent";
9
9
  import { DesignComponent } from "../../model/components/SDKDesignComponent";
10
- import { DocumentationItem } from "../../model/documentation/SDKDocumentationItem";
10
+ import { DocumentationLegacyItem } from "../../model/documentation/SDKDocumentationLegacyItem";
11
11
  import { ElementDataView } from "../../model/elements/SDKElementDataView";
12
12
  import { ElementDataViewColumn } from "../../model/elements/SDKElementDataViewColumn";
13
13
  import { ElementProperty, ElementPropertyCreationModel, ElementPropertyTargetElementType, ElementPropertyUpdateModel } from "../../model/elements/SDKElementProperty";
@@ -24,7 +24,7 @@ import { DesignComponentGroup } from "../../model/groups/SDKDesignComponentGroup
24
24
  import { TokenGroup } from "../../model/groups/SDKTokenGroup";
25
25
  import { ImportJob } from "../../model/jobs/SDKImportJob";
26
26
  import { Membership } from "../../model/membership/SDKMembership";
27
- import { Source } from "../../model/support/SDKSource";
27
+ import { Source, SourceRemoteModelCloud } from "../../model/support/SDKSource";
28
28
  import { TokenTheme } from "../../model/themes/SDKTokenTheme";
29
29
  import { Token } from "../../model/tokens/SDKToken";
30
30
  import { User } from "../../model/users/SDKUser";
@@ -196,9 +196,9 @@ export declare class DataCore {
196
196
  /** Render assets as PNG, SVG, PDF, or combinations of it */
197
197
  renderedAssets(designSystemId: string, versionId: string, assets: Array<Asset>, groups: Array<AssetGroup>, settings: RenderedAssetRequestSettings): Promise<Array<RenderedAsset>>;
198
198
  /** Retrieve the main documentation object through which all docs data can be accessed */
199
- documentation(workspaceId: string, designSystemId: string, versionId: string): Promise<Documentation>;
199
+ documentation(workspaceId: string, designSystemId: string, versionId: string): Promise<DocumentationLegacy>;
200
200
  /** Download all necessary data for documentation items (groups and pages) and retrieve them resolved */
201
- documentationItems(workspaceId: string, designSystemId: string, versionId: string): Promise<Array<DocumentationItem>>;
201
+ documentationItems(workspaceId: string, designSystemId: string, versionId: string): Promise<Array<DocumentationLegacyItem>>;
202
202
  /** Retrieve currently deployed documentation url */
203
203
  documentationDomain(designSystemId: string, versionId: string): Promise<string | null>;
204
204
  /** Publish the documentation */
@@ -279,7 +279,7 @@ export declare class DataCore {
279
279
  assets: boolean;
280
280
  documentationFrames: boolean;
281
281
  };
282
- autoImport: boolean;
282
+ autoImport: SourceRemoteModelCloud["autoImportMode"];
283
283
  themeId: string | null;
284
284
  }): Promise<Source>;
285
285
  updateFigmaSource(designSystemId: string, sourceId: string, options: {
@@ -289,7 +289,7 @@ export declare class DataCore {
289
289
  assets: boolean;
290
290
  documentationFrames: boolean;
291
291
  };
292
- autoImport?: boolean;
292
+ autoImport?: SourceRemoteModelCloud["autoImportMode"];
293
293
  themeId?: string | null;
294
294
  }): Promise<Source>;
295
295
  updateFigmaSourceClaimOwnership(designSystemId: string, sourceId: string): Promise<Source>;
@@ -304,4 +304,6 @@ export declare class DataCore {
304
304
  getImportJob(designSystemId: string, versionId: string, jobId: string): Promise<ImportJob>;
305
305
  getImportJobs(designSystemId: string, versionId: string): Promise<Array<ImportJob>>;
306
306
  scheduleImportJobForFigmaSources(designSystemId: string, versionId: string, sourceIds: Array<string>, dryRun: boolean): Promise<ImportJob>;
307
+ getTokenStudioData(designSystemId: string, versionId: string): Promise<object>;
308
+ writeTokenStudioData(designSystemId: string, versionId: string, data: object): Promise<boolean>;
307
309
  }
@@ -2,11 +2,11 @@ import { AclRemoteModel } from "../../../model/acl/SDKAcl";
2
2
  import { BrandRemoteModel } from "../../../model/base/SDKBrand";
3
3
  import { DesignSystemRemoteModel } from "../../../model/base/SDKDesignSystem";
4
4
  import { DesignSystemVersionRemoteModel } from "../../../model/base/SDKDesignSystemVersion";
5
- import { DocumentationModel } from "../../../model/base/SDKDocumentation";
5
+ import { DocumentationLegacyModel } from "../../../model/base/SDKDocumentationLegacy";
6
6
  import { ComponentRemoteModel } from "../../../model/components/SDKComponent";
7
7
  import { DesignComponentRemoteModel } from "../../../model/components/SDKDesignComponent";
8
- import { DocumentationGroupModel } from "../../../model/documentation/SDKDocumentationGroup";
9
- import { DocumentationPageModel } from "../../../model/documentation/SDKDocumentationPage";
8
+ import { DocumentationLegacyGroupModel } from "../../../model/documentation/SDKDocumentationLegacyGroup";
9
+ import { DocumentationLegacyPageModel } from "../../../model/documentation/SDKDocumentationLegacyPage";
10
10
  import { ElementDataViewRemoteModel } from "../../../model/elements/SDKElementDataView";
11
11
  import { ElementPropertyRemoteModel } from "../../../model/elements/SDKElementProperty";
12
12
  import { ElementPropertyValueRemoteModel } from "../../../model/elements/values/SDKElementPropertyValue";
@@ -65,11 +65,11 @@ export declare class DataCoreReadRequests {
65
65
  /** Remote: Get design system documentation url */
66
66
  getRemoteDocumentationUrl(designSystemId: string, versionId: string): Promise<string | null>;
67
67
  /** Remote: Get documentation metadata */
68
- getRemoteDocumentationStructure(designSystemId: string, versionId: string): Promise<DocumentationModel>;
68
+ getRemoteDocumentationStructure(designSystemId: string, versionId: string): Promise<DocumentationLegacyModel>;
69
69
  /** Remote: Get content of the documentation - groups and pages */
70
70
  getRemoteDocumentationItems(designSystemId: string, versionId: string): Promise<{
71
- groups: Array<DocumentationGroupModel>;
72
- pages: Array<DocumentationPageModel>;
71
+ groups: Array<DocumentationLegacyGroupModel>;
72
+ pages: Array<DocumentationLegacyPageModel>;
73
73
  }>;
74
74
  /** Remote: Get custom blocks for currently installed documentation exporter under specific ds */
75
75
  getRemoteExporterCustomBlocks(designSystemId: string, versionId: string): Promise<Array<ExporterCustomBlockModel>>;
@@ -97,7 +97,7 @@ export declare class DataCoreReadRequests {
97
97
  getRemoteTokenUsage(designSystemId: string, versionId: string, tokenId: string): Promise<{
98
98
  tokens: Array<TokenRemoteModel>;
99
99
  components: Array<DesignComponentRemoteModel>;
100
- documentationPages: Array<DocumentationPageModel>;
100
+ documentationPages: Array<DocumentationLegacyPageModel>;
101
101
  }>;
102
102
  /** Remote: Get all supernova-type components (note: Not design components, those have separate endpoints) */
103
103
  getRemoteComponents(designSystemId: string, versionId: string): Promise<Array<ComponentRemoteModel>>;
@@ -128,4 +128,5 @@ export declare class DataCoreReadRequests {
128
128
  getVersions(designSystemId: string): Promise<Array<DesignSystemVersionRemoteModel>>;
129
129
  getImportJobs(designSystemId: string, versionId: string): Promise<Array<ImportJobRemoteModel>>;
130
130
  getImportJob(designSystemId: string, versionId: string, jobId: string): Promise<ImportJobRemoteModel>;
131
+ getTokenStudioData(designSystemId: string, versionId: string): Promise<object>;
131
132
  }
@@ -124,4 +124,5 @@ export declare class DataCoreWriteRequests {
124
124
  linkFigmaSource(designSystemId: string, data: object): Promise<SourceRemoteModel>;
125
125
  updateFigmaSource(designSystemId: string, sourceId: string, data: object): Promise<SourceRemoteModel>;
126
126
  updateFigmaSourceClaimOwnership(designSystemId: string, sourceId: string): Promise<SourceRemoteModel>;
127
+ writeTokenStudioJSONData(designSystemId: string, versionId: string, data: object): Promise<boolean>;
127
128
  }
@@ -1,20 +1,20 @@
1
- import { DocumentationConfiguration } from "../../model/documentation/SDKDocumentationConfiguration";
2
- import { DocumentationGroupModel } from "../../model/documentation/SDKDocumentationGroup";
3
- import { DocumentationItem, DocumentationItemModel } from "../../model/documentation/SDKDocumentationItem";
4
- import { DocumentationPageModel } from "../../model/documentation/SDKDocumentationPage";
1
+ import { DocumentationLegacyConfiguration } from "../../model/documentation/SDKDocumentationLegacyConfiguration";
2
+ import { DocumentationLegacyGroupModel } from "../../model/documentation/SDKDocumentationLegacyGroup";
3
+ import { DocumentationLegacyItem, DocumentationLegacyItemModel } from "../../model/documentation/SDKDocumentationLegacyItem";
4
+ import { DocumentationLegacyPageModel } from "../../model/documentation/SDKDocumentationLegacyPage";
5
5
  import { ExporterCustomBlock } from "../../model/exporters/custom_blocks/SDKExporterCustomBlock";
6
- export declare class DocumentationItemResolver {
7
- hashedItems: Map<string, DocumentationItemModel>;
8
- resolvedItems: Map<string, DocumentationItem>;
6
+ export declare class DocumentationLegacyItemResolver {
7
+ hashedItems: Map<string, DocumentationLegacyItemModel>;
8
+ resolvedItems: Map<string, DocumentationLegacyItem>;
9
9
  customBlocks: Array<ExporterCustomBlock>;
10
- configuration: DocumentationConfiguration;
10
+ configuration: DocumentationLegacyConfiguration;
11
11
  workspaceHandle: string;
12
12
  versionId: string;
13
13
  designSystemId: string;
14
14
  designSystemName: string;
15
15
  docsUrl: string | undefined;
16
- constructor(customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration, designSystemId: string, designSystemName: string, versionId: string, workspaceHandle: string, docsUrl: string | undefined);
17
- resolveItemData(pageDetails: Array<DocumentationPageModel>, groupDetails: Array<DocumentationGroupModel>): Array<DocumentationItem>;
16
+ constructor(customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationLegacyConfiguration, designSystemId: string, designSystemName: string, versionId: string, workspaceHandle: string, docsUrl: string | undefined);
17
+ resolveItemData(pageDetails: Array<DocumentationLegacyPageModel>, groupDetails: Array<DocumentationLegacyGroupModel>): Array<DocumentationLegacyItem>;
18
18
  private resolveItemsForGroup;
19
19
  private resolveBlockChains;
20
20
  private resolveBlockGroup;
@@ -36,51 +36,87 @@ export { ElementPropertyOption, ElementPropertyOptionBadgeColor, } from "./model
36
36
  export { ElementDataView } from "./model/elements/SDKElementDataView";
37
37
  export { ElementDataViewColumn, ElementDataViewColumnBasePropertyType, ElementDataViewColumnType, } from "./model/elements/SDKElementDataViewColumn";
38
38
  export { DesignComponent } from "./model/components/SDKDesignComponent";
39
- export { Documentation } from "./model/base/SDKDocumentation";
40
- export { DocumentationPageBlockAsset } from "./model/documentation/blocks/SDKDocumentationPageBlockAsset";
41
- export { DocumentationPageBlockAssets } from "./model/documentation/blocks/SDKDocumentationPageBlockAssets";
42
- export { DocumentationPageBlockCallout } from "./model/documentation/blocks/SDKDocumentationPageBlockCallout";
43
- export { DocumentationPageBlockCode } from "./model/documentation/blocks/SDKDocumentationPageBlockCode";
44
- export { DocumentationPageBlockCustom } from "./model/documentation/blocks/SDKDocumentationPageBlockCustom";
45
- export { DocumentationPageBlockDivider } from "./model/documentation/blocks/SDKDocumentationPageBlockDivider";
46
- export { DocumentationPageBlockEmbedFigma } from "./model/documentation/blocks/SDKDocumentationPageBlockEmbedFigma";
47
- export { DocumentationPageBlockEmbedGeneric } from "./model/documentation/blocks/SDKDocumentationPageBlockEmbedGeneric";
48
- export { DocumentationPageBlockEmbedLink } from "./model/documentation/blocks/SDKDocumentationPageBlockEmbedLink";
49
- export { DocumentationPageBlockEmbedStorybook } from "./model/documentation/blocks/SDKDocumentationPageBlockEmbedStorybook";
50
- export { DocumentationPageBlockEmbedYoutube } from "./model/documentation/blocks/SDKDocumentationPageBlockEmbedYoutube";
51
- export { DocumentationPageBlockFrame } from "./model/documentation/blocks/SDKDocumentationPageBlockFrame";
52
- export { DocumentationPageBlockFrames } from "./model/documentation/blocks/SDKDocumentationPageBlockFrames";
53
- export { DocumentationPageBlockHeading } from "./model/documentation/blocks/SDKDocumentationPageBlockHeading";
54
- export { DocumentationPageBlockImage } from "./model/documentation/blocks/SDKDocumentationPageBlockImage";
55
- export { DocumentationPageOrderedList } from "./model/documentation/blocks/SDKDocumentationPageBlockOrderedList";
56
- export { DocumentationPageBlockQuote } from "./model/documentation/blocks/SDKDocumentationPageBlockQuote";
57
- export { DocumentationPageBlockRenderCode } from "./model/documentation/blocks/SDKDocumentationPageBlockRenderCode";
58
- export { DocumentationPageBlockShortcut, DocumentationPageBlockShortcutType, } from "./model/documentation/blocks/SDKDocumentationPageBlockShortcut";
59
- export { DocumentationPageBlockShortcuts } from "./model/documentation/blocks/SDKDocumentationPageBlockShortcuts";
60
- export { DocumentationPageBlockText } from "./model/documentation/blocks/SDKDocumentationPageBlockText";
61
- export { DocumentationPageBlockToken } from "./model/documentation/blocks/SDKDocumentationPageBlockToken";
62
- export { DocumentationPageBlockTokenGroup } from "./model/documentation/blocks/SDKDocumentationPageBlockTokenGroup";
63
- export { DocumentationPageBlockTokenList } from "./model/documentation/blocks/SDKDocumentationPageBlockTokenList";
64
- export { DocumentationPageUnorderedList } from "./model/documentation/blocks/SDKDocumentationPageBlockUnorderedList";
65
- export { DocumentationPageBlockColumn } from "./model/documentation/blocks/SDKDocumentationPageBlockColumn";
66
- export { DocumentationPageBlockColumnItem } from "./model/documentation/blocks/SDKDocumentationPageBlockColumnItem";
67
- export { DocumentationPageBlockTab } from "./model/documentation/blocks/SDKDocumentationPageBlockTab";
68
- export { DocumentationPageBlockTabItem } from "./model/documentation/blocks/SDKDocumentationPageBlockTabItem";
69
- export { DocumentationPageBlockTable } from "./model/documentation/blocks/SDKDocumentationPageBlockTable";
70
- export { DocumentationPageBlockTableCell } from "./model/documentation/blocks/SDKDocumentationPageBlockTableCell";
71
- export { DocumentationPageBlockTableRow } from "./model/documentation/blocks/SDKDocumentationPageBlockTableRow";
72
- export { DocumentationPageBlockTableColumn } from "./model/documentation/blocks/SDKDocumentationPageBlockTableColumn";
73
- export { DocumentationItemHeader } from "./model/documentation/configuration/SDKDocumentationItemHeader";
74
- export { DocumentationItemConfiguration } from "./model/documentation/configuration/SDKDocumentationItemConfiguration";
75
- export { DocumentationConfiguration } from "./model/documentation/SDKDocumentationConfiguration";
76
- export { DocumentationGroup } from "./model/documentation/SDKDocumentationGroup";
77
- export { DocumentationItem } from "./model/documentation/SDKDocumentationItem";
78
- export { DocumentationPage } from "./model/documentation/SDKDocumentationPage";
79
- export { DocumentationPageBlock } from "./model/documentation/SDKDocumentationPageBlock";
80
- export { DocumentationPageAsset } from "./model/documentation/SDKDocumentationPageAsset";
81
- export { DocumentationRichText } from "./model/documentation/SDKDocumentationRichText";
82
- export { RichTextSpan } from "./model/documentation/SDKDocumentationRichTextSpan";
83
- export { RichTextSpanAttribute } from "./model/documentation/SDKDocumentationRichTextSpanAttribute";
39
+ export { DocsBlockBehavior } from "./model/docs/blocks/definition/SDKDocsBlockBehavior";
40
+ export { DocsBlockDefinition } from "./model/docs/blocks/definition/SDKDocsBlockDefinition";
41
+ export { DocsBlockItem } from "./model/docs/blocks/definition/SDKDocsBlockItem";
42
+ export { DocsBlockLayout } from "./model/docs/blocks/definition/SDKDocsBlockLayout";
43
+ export { DocsBlockOnboarding } from "./model/docs/blocks/definition/SDKDocsBlockOnboarding";
44
+ export { DocsBlockVariant } from "./model/docs/blocks/definition/SDKDocsBlockVariant";
45
+ export { DocsEntity } from "./model/docs/entities/SDKDocsEntity";
46
+ export { DocsEntityGroup } from "./model/docs/entities/SDKDocsEntityGroup";
47
+ export { DocsEntityPage } from "./model/docs/entities/SDKDocsEntityPage";
48
+ export { DocsBlockAssetPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockAssetProperty";
49
+ export { DocsBlockAssetPropertyPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockAssetPropertyProperty";
50
+ export { DocsBlockBooleanPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockBooleanProperty";
51
+ export { DocsBlockCodePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockCodeProperty";
52
+ export { DocsBlockCodeSandboxPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty";
53
+ export { DocsBlockComponentPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockComponentProperty";
54
+ export { DocsBlockComponentPropertyPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockComponentPropertyProperty";
55
+ export { DocsBlockEmbedFramePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockEmbedFrameProperty";
56
+ export { DocsBlockEmbedUrlPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty";
57
+ export { DocsBlockImagePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockImageProperty";
58
+ export { DocsBlockMarkdownPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockMarkdownProperty";
59
+ export { DocsBlockMultiSelectPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty";
60
+ export { DocsBlockNumberPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockNumberProperty";
61
+ export { DocsBlockPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockProperty";
62
+ export { DocsBlockRichTextPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockRichTextProperty";
63
+ export { DocsBlockSingleSelectPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty";
64
+ export { DocsBlockTablePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTableProperty";
65
+ export { DocsBlockTextPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTextProperty";
66
+ export { DocsBlockTokenPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTokenProperty";
67
+ export { DocsBlockTokenPropertyPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTokenPropertyProperty";
68
+ export { DocsBlockTokenTypePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty";
69
+ export { DocsBlockDividerPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockDividerProperty";
70
+ export { DocsColorRef } from "./model/docs/blocks/support/SDKDocsColorRef";
71
+ export { DocsImageRef, DocsImageRefType, } from "./model/docs/blocks/support/SDKDocsImageRef";
72
+ export { DocsLinkRef, DocsLinkRefType, } from "./model/docs/blocks/support/SDKDocsLinkRef";
73
+ export { DocsSizeRef } from "./model/docs/blocks/support/SDKDocsSizeRef";
74
+ export { DocsBlock } from "./model/docs/blocks/usage/SDKDocsBlock";
75
+ export { DocumentationLegacy } from "./model/base/SDKDocumentationLegacy";
76
+ export { DocumentationLegacyPageBlockAsset } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockAsset";
77
+ export { DocumentationLegacyPageBlockAssets } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockAssets";
78
+ export { DocumentationLegacyPageBlockCallout } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockCallout";
79
+ export { DocumentationLegacyPageBlockCode } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockCode";
80
+ export { DocumentationLegacyPageBlockCustom } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockCustom";
81
+ export { DocumentationLegacyPageBlockDivider } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockDivider";
82
+ export { DocumentationLegacyPageBlockEmbedFigma } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedFigma";
83
+ export { DocumentationLegacyPageBlockEmbedGeneric } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedGeneric";
84
+ export { DocumentationLegacyPageBlockEmbedLink } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedLink";
85
+ export { DocumentationLegacyPageBlockEmbedStorybook } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedStorybook";
86
+ export { DocumentationLegacyPageBlockEmbedYoutube } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedYoutube";
87
+ export { DocumentationLegacyPageBlockFrame } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockFrame";
88
+ export { DocumentationLegacyPageBlockFrames } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockFrames";
89
+ export { DocumentationLegacyPageBlockHeading } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockHeading";
90
+ export { DocumentationLegacyPageBlockImage } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockImage";
91
+ export { DocumentationLegacyPageOrderedList } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockOrderedList";
92
+ export { DocumentationLegacyPageBlockQuote } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockQuote";
93
+ export { DocumentationLegacyPageBlockRenderCode } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockRenderCode";
94
+ export { DocumentationLegacyPageBlockShortcut, DocumentationLegacyPageBlockShortcutType, } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockShortcut";
95
+ export { DocumentationLegacyPageBlockShortcuts } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockShortcuts";
96
+ export { DocumentationLegacyPageBlockText } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockText";
97
+ export { DocumentationLegacyPageBlockToken } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockToken";
98
+ export { DocumentationLegacyPageBlockTokenGroup } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockTokenGroup";
99
+ export { DocumentationLegacyPageBlockTokenList } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockTokenList";
100
+ export { DocumentationLegacyPageUnorderedList } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockUnorderedList";
101
+ export { DocumentationLegacyPageBlockColumn } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockColumn";
102
+ export { DocumentationLegacyPageBlockColumnItem } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockColumnItem";
103
+ export { DocumentationLegacyPageBlockTab } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockTab";
104
+ export { DocumentationLegacyPageBlockTabItem } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockTabItem";
105
+ export { DocumentationLegacyPageBlockTable } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockTable";
106
+ export { DocumentationLegacyPageBlockTableCell } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockTableCell";
107
+ export { DocumentationLegacyPageBlockTableRow } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockTableRow";
108
+ export { DocumentationLegacyPageBlockTableColumn } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockTableColumn";
109
+ export { DocumentationLegacyItemHeader } from "./model/documentation/configuration/SDKDocumentationLegacyItemHeader";
110
+ export { DocumentationLegacyItemConfiguration } from "./model/documentation/configuration/SDKDocumentationLegacyItemConfiguration";
111
+ export { DocumentationLegacyConfiguration } from "./model/documentation/SDKDocumentationLegacyConfiguration";
112
+ export { DocumentationLegacyGroup } from "./model/documentation/SDKDocumentationLegacyGroup";
113
+ export { DocumentationLegacyItem } from "./model/documentation/SDKDocumentationLegacyItem";
114
+ export { DocumentationLegacyPage } from "./model/documentation/SDKDocumentationLegacyPage";
115
+ export { DocumentationLegacyPageBlock } from "./model/documentation/SDKDocumentationLegacyPageBlock";
116
+ export { DocumentationLegacyPageAsset } from "./model/documentation/SDKDocumentationLegacyPageAsset";
117
+ export { DocumentationLegacyRichText } from "./model/documentation/SDKDocumentationLegacyRichText";
118
+ export { RichTextSpan } from "./model/documentation/SDKDocumentationLegacyRichTextSpan";
119
+ export { RichTextSpanAttribute } from "./model/documentation/SDKDocumentationLegacyRichTextSpanAttribute";
84
120
  export { AssetGroup } from "./model/groups/SDKAssetGroup";
85
121
  export { DesignComponentGroup } from "./model/groups/SDKDesignComponentGroup";
86
122
  export { TokenGroup } from "./model/groups/SDKTokenGroup";
@@ -91,13 +127,28 @@ export { AssetScaleType } from "./model/enums/SDKAssetScaleType";
91
127
  export { BlurType } from "./model/enums/SDKBlurType";
92
128
  export { BorderPosition } from "./model/enums/SDKBorderPosition";
93
129
  export { BorderStyle } from "./model/enums/SDKBorderStyle";
94
- export { DocumentationCalloutType } from "./model/enums/SDKDocumentationCalloutType";
95
- export { DocumentationGroupBehavior } from "./model/enums/SDKDocumentationGroupBehavior";
96
- export { DocumentationHeadingType } from "./model/enums/SDKDocumentationHeadingType";
97
- export { DocumentationItemType } from "./model/enums/SDKDocumentationItemType";
98
- export { DocumentationPageAssetType } from "./model/enums/SDKDocumentationPageAssetType";
99
- export { DocumentationPageBlockType } from "./model/enums/SDKDocumentationPageBlockType";
100
- export { DocumentationPageBlockThemeType } from "./model/enums/SDKDocumentationPageBlockThemeType";
130
+ export { DocumentationLegacyCalloutType } from "./model/enums/SDKDocumentationLegacyCalloutType";
131
+ export { DocumentationLegacyGroupBehavior } from "./model/enums/SDKDocumentationLegacyGroupBehavior";
132
+ export { DocumentationLegacyHeadingType } from "./model/enums/SDKDocumentationLegacyHeadingType";
133
+ export { DocumentationLegacyItemType } from "./model/enums/SDKDocumentationLegacyItemType";
134
+ export { DocumentationLegacyPageAssetType } from "./model/enums/SDKDocumentationLegacyPageAssetType";
135
+ export { DocumentationLegacyPageBlockType } from "./model/enums/SDKDocumentationLegacyPageBlockType";
136
+ export { DocumentationLegacyPageBlockThemeType } from "./model/enums/SDKDocumentationLegacyPageBlockThemeType";
137
+ export { DocsBlockBehaviorDataType } from "./model/enums/SDKDocsBlockBehaviorDataType";
138
+ export { DocsBlockBehaviorSelectionType } from "./model/enums/SDKDocsBlockBehaviorSelectionType";
139
+ export { DocsBlockImagePropertyAspectRatio } from "./model/enums/SDKDocsBlockImagePropertyAspectRatio";
140
+ export { DocsBlockItemEntityType } from "./model/enums/SDKDocsBlockItemEntityType";
141
+ export { DocsBlockItemPropertyOptionRenderingStyle } from "./model/enums/SDKDocsBlockItemPropertyOptionRenderingStyle";
142
+ export { DocsBlockItemPropertyRichTextStyle } from "./model/enums/SDKDocsBlockItemPropertyRichTextStyle";
143
+ export { DocsBlockItemPropertyTextStyle } from "./model/enums/SDKDocsBlockItemPropertyTextStyle";
144
+ export { DocsBlockItemPropertyType } from "./model/enums/SDKDocsBlockItemPropertyType";
145
+ export { DocsBlockItemVariantLayoutType } from "./model/enums/SDKDocsBlockItemVariantLayoutType";
146
+ export { DocsBlockItemVariantLayoutWidth } from "./model/enums/SDKDocsBlockItemVariantLayoutWidth";
147
+ export { DocsBlockOptionRenderingStyle } from "./model/enums/SDKDocsBlockOptionRenderStyle";
148
+ export { DocsBlockRichTextPropertyStyle } from "./model/enums/SDKDocsBlockRichTextPropertyStyle";
149
+ export { DocsEntityGroupBehavior } from "./model/enums/SDKDocsEntityGroupBehavior";
150
+ export { DocsEntityType } from "./model/enums/SDKDocsEntityType";
151
+ export { DocsSectionType } from "./model/enums/SDKDocsSectionType";
101
152
  export { FrameAlignment } from "./model/enums/SDKFrameAlignment";
102
153
  export { FrameLayout } from "./model/enums/SDKFrameLayout";
103
154
  export { GradientType } from "./model/enums/SDKGradientType";
@@ -35,9 +35,9 @@ export declare class DesignSystem {
35
35
  isMultiBrand: boolean;
36
36
  /** Unique identifier of exporter package used for the documentation */
37
37
  documentationExporterId: string;
38
- /** Documentation URL slug */
38
+ /** DocumentationLegacy URL slug */
39
39
  documentationSlug: string;
40
- /** Documentation URL slug - user override */
40
+ /** DocumentationLegacy URL slug - user override */
41
41
  documentationUserSlug: string | null;
42
42
  /** Binding multiple design systems together */
43
43
  designSystemSwitcher: {
@@ -0,0 +1,10 @@
1
+ import { DocumentationLegacyConfiguration, DocumentationLegacyConfigurationModel } from "../documentation/SDKDocumentationLegacyConfiguration";
2
+ import { WorkspaceNPMRegistrySettings } from "../workspaces/SDKWorkspaceNPMRegistrySettings";
3
+ export type DocumentationLegacyModel = {
4
+ settings: DocumentationLegacyConfigurationModel;
5
+ };
6
+ export declare class DocumentationLegacy {
7
+ /** DocumentationLegacy settings */
8
+ settings: DocumentationLegacyConfiguration;
9
+ constructor(model: DocumentationLegacyModel, registry: WorkspaceNPMRegistrySettings | null);
10
+ }
@@ -0,0 +1,13 @@
1
+ import { WorkspaceNPMRegistrySettings } from "../workspaces/SDKWorkspaceNPMRegistrySettings";
2
+ export type DocsConfigurationModel = {
3
+ tabbed: boolean;
4
+ storybookEmbedErrorMessage?: string;
5
+ renderCodePackageJson?: string;
6
+ };
7
+ export declare class DocsConfiguration {
8
+ tabbedNavigation: boolean;
9
+ storybookError: string | null;
10
+ packageJson: string | null;
11
+ npmRegistry: WorkspaceNPMRegistrySettings | null;
12
+ constructor(model: DocsConfigurationModel, registry: WorkspaceNPMRegistrySettings | null);
13
+ }
@@ -0,0 +1,45 @@
1
+ import { DocsBlockBehaviorDataType } from "../../../enums/SDKDocsBlockBehaviorDataType";
2
+ import { DocsBlockBehaviorSelectionType } from "../../../enums/SDKDocsBlockBehaviorSelectionType";
3
+ export type DocsBlockBehaviorModel = {
4
+ dataType: DocsBlockBehaviorDataType;
5
+ items?: {
6
+ numberOfItems?: number;
7
+ allowLinks?: boolean;
8
+ };
9
+ entities?: {
10
+ selectionType: DocsBlockBehaviorSelectionType;
11
+ maxSelected?: number;
12
+ };
13
+ };
14
+ export declare class DocsBlockBehavior {
15
+ /** Defines what data block uses, and generates */
16
+ dataType: DocsBlockBehaviorDataType;
17
+ /** This property only goes into effect when dataType === "Item" and is ignored otherwise */
18
+ items: {
19
+ /**
20
+ * If numberOfItems is 0, then block can have multiple items, and unlimited amount of them
21
+ * If numberOfItems === 1, then block has exactly one item and none other can be created
22
+ * If numberOfItems > 1, then block can have multiple items, but they are limited by upper bound
23
+ * This property must be set and any other values than mentioned above are invalid
24
+ */
25
+ numberOfItems: number;
26
+ /** When enabled, each item can additionally link to page/url * */
27
+ allowLinks: boolean;
28
+ } | null;
29
+ /** This property only goes into effect when dataType !== "Item" */
30
+ entities: {
31
+ /**
32
+ * If selectionType === "Entity", then only an entity of specific "dataType" can be selected (and no groups of that type)
33
+ * If selectionType === "Group", then only a group of specific "dataType" can be selected (and no entity of that type)
34
+ * If selectionType === "EntityAndGroup", then both can be selected, even together
35
+ */
36
+ selectionType: DocsBlockBehaviorSelectionType;
37
+ /**
38
+ * Limits number of items that user can select.
39
+ * Group counts as one (so 2 means 2 groups, or group and item etc.).
40
+ * 0 means unlimited.
41
+ * */
42
+ maxSelected: number;
43
+ } | null;
44
+ constructor(model: DocsBlockBehaviorModel);
45
+ }
@@ -0,0 +1,55 @@
1
+ import { DocsBlockCategory } from "../../../enums/SDKDocsBlockCategory";
2
+ import { DocsImageRef } from "../support/SDKDocsImageRef";
3
+ import { DocsBlockBehavior, DocsBlockBehaviorModel } from "./SDKDocsBlockBehavior";
4
+ import { DocsBlockItem, DocsBlockItemModel } from "./SDKDocsBlockItem";
5
+ import { DocsBlockOnboarding, DocsBlockOnboardingModel } from "./SDKDocsBlockOnboarding";
6
+ export type DocsBlockDefinitionModel = {
7
+ id: string;
8
+ name: string;
9
+ description: string;
10
+ category: DocsBlockCategory;
11
+ icon?: DocsImageRef;
12
+ documentationLink?: string;
13
+ searchKeywords?: Array<string>;
14
+ item: DocsBlockItemModel;
15
+ behavior: DocsBlockBehaviorModel;
16
+ editorOptions?: {
17
+ onboarding?: DocsBlockOnboardingModel;
18
+ };
19
+ appearance?: {
20
+ isBordered?: boolean;
21
+ hasBackground?: boolean;
22
+ };
23
+ };
24
+ export declare class DocsBlockDefinition {
25
+ /** Unique id of the block. Block id must be unique across all blocks registered to Supernova in preparation for block store. Reserved ids will be created for all core blocks and they'll be installed by default to every exporter */
26
+ id: string;
27
+ /** Defines the name of the block */
28
+ name: string;
29
+ /** Describes the block in more detail */
30
+ description: string;
31
+ /** Block category */
32
+ category: DocsBlockCategory;
33
+ /** Block icon filename */
34
+ icon: DocsImageRef | null;
35
+ /** Link to documentation or resource explaining the behavior of the block and its options */
36
+ documentationLink: string | null;
37
+ searchKeywords: Array<string>;
38
+ /** Primary definition of the block. See DocsBlockItem for more information */
39
+ item: DocsBlockItem;
40
+ /** Primary definition of the layered block behavior. See Block Behaviors for more information */
41
+ behavior: DocsBlockBehavior;
42
+ /** Top-level editor options for the block itself (but not for its items). This configuration has no bearing on front-end side of rendering and is only for editor */
43
+ editorOptions: {
44
+ /** When provided, the first time block is used (for every user individually), onboarding layer will show up for that block, explaining what it is. */
45
+ onboarding: DocsBlockOnboarding | null;
46
+ };
47
+ /** All appearance options for top-level block wrapper */
48
+ appearance: {
49
+ /** With border enabled, a light border will be rendered in editor around the block. For example, rich text have this disabled as it is just a text */
50
+ isBordered: boolean;
51
+ /** When background option is enabled, background color can be set for the block */
52
+ hasBackground: boolean;
53
+ };
54
+ constructor(model: DocsBlockDefinitionModel);
55
+ }