@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,57 @@
1
+ import { DocsBlockItemEntityType } from "../../../enums/SDKDocsBlockItemEntityType";
2
+ import { DocsColorRef } from "../support/SDKDocsColorRef";
3
+ import { DocsLinkRef } from "../support/SDKDocsLinkRef";
4
+ export type DocsBlockStaticDataValue = string | number | boolean | object | Array<string | number | boolean | object>;
5
+ export type DocsBlockModel = {
6
+ id: string;
7
+ packageId: string;
8
+ layoutId?: string;
9
+ indentLevel: number;
10
+ appearance?: {
11
+ itemBackgroundColor?: DocsColorRef;
12
+ };
13
+ staticData?: Array<{
14
+ [key: string]: DocsBlockStaticDataValue;
15
+ link?: DocsLinkRef;
16
+ }>;
17
+ dynamicData?: Array<{
18
+ entityId: string;
19
+ entityType: DocsBlockItemEntityType;
20
+ }>;
21
+ dynamicDataOrder: Array<string>;
22
+ };
23
+ export declare class DocsBlock {
24
+ /** Unique identifier of the block */
25
+ id: string;
26
+ /** Unique identifier of the block package */
27
+ packageId: string;
28
+ /** Unique identifier of the layout variant */
29
+ layoutId: string | null;
30
+ /** Indentation of the block in levels (0, 1, 2), not pixels */
31
+ indentLevel: number;
32
+ /** Block appearance - Properties that are natively available for all blocks, such as background color */
33
+ appearance: {
34
+ /** Background color of all items of the block. Can be further overriden on every item */
35
+ itemBackgroundColor: DocsColorRef | null;
36
+ };
37
+ /** Static data represents data for items that are created without dynamic reference to entities in Supernova - an example of this would be a shortcut.
38
+ * This is an array, because for blocks with items being able to form grids, we need more than a single definition (each item has its own settings then)
39
+ * Property resolution:
40
+ * data > default (in block property definition) > not set
41
+ */
42
+ staticData: Array<{
43
+ /** Dynamic key coming from property.id block definition */
44
+ [key: string]: DocsBlockStaticDataValue;
45
+ /** Link where the item points to, if any. Must be enabled in behaviors */
46
+ link?: DocsLinkRef;
47
+ }>;
48
+ /** Dynamic data represents data for items that reference entities in Supernova - an example of this would be a token block.
49
+ * This is an array, because multiple entities can be selected at once */
50
+ dynamicData: Array<{
51
+ entityId: string;
52
+ entityType: DocsBlockItemEntityType;
53
+ }>;
54
+ /** If user re-ordered items that are pulled dynamically, order from this field should take precedent over default ordering */
55
+ dynamicDataOrder: Array<string>;
56
+ constructor(model: DocsBlockModel);
57
+ }
@@ -0,0 +1,27 @@
1
+ import { DocsEntityType } from "../../enums/SDKDocsEntityType";
2
+ import { DocsEntityConfiguration, DocsEntityConfigurationModel } from "./SDKDocsEntityConfiguration";
3
+ export type DocsEntityModel = {
4
+ persistentId: string;
5
+ shortPersistentId: string;
6
+ id: string;
7
+ designSystemVersionId: string;
8
+ title: string;
9
+ type: DocsEntityType;
10
+ slug: string;
11
+ userSlug?: string;
12
+ configuration: DocsEntityConfigurationModel;
13
+ createdAt?: string;
14
+ updatedAt?: string;
15
+ };
16
+ export declare class DocsEntity {
17
+ id: string;
18
+ persistentId: string;
19
+ type: DocsEntityType;
20
+ title: string;
21
+ configuration: DocsEntityConfiguration;
22
+ slug: string;
23
+ userSlug: string | null;
24
+ createdAt: Date | null;
25
+ updatedAt: Date | null;
26
+ constructor(model: DocsEntityModel);
27
+ }
@@ -0,0 +1,10 @@
1
+ import { DocsEntityHeader, DocsEntityHeaderModel } from "./SDKDocsEntityHeader";
2
+ export type DocsEntityConfigurationModel = {
3
+ header: DocsEntityHeaderModel;
4
+ showSidebar: boolean;
5
+ };
6
+ export declare class DocsEntityConfiguration {
7
+ header: DocsEntityHeader;
8
+ showSidebar: boolean;
9
+ constructor(model: DocsEntityConfigurationModel);
10
+ }
@@ -0,0 +1,29 @@
1
+ import { DocsEntityGroupBehavior } from "../../enums/SDKDocsEntityGroupBehavior";
2
+ import { DocsEntity, DocsEntityModel } from "./SDKDocsEntity";
3
+ export type DocumentationLegacyGroupModel = {
4
+ isRoot: boolean;
5
+ childrenIds: Array<string>;
6
+ parentId: string | null;
7
+ groupBehavior: DocsEntityGroupBehavior;
8
+ } & DocsEntityModel;
9
+ export declare class DocsEntityGroup extends DocsEntity {
10
+ /** If true, this is unique within documentation (just one) that contains all top-level objects and is root of the docs tree (root > groups > items > blocks ...) */
11
+ isRoot: boolean;
12
+ /** IDs of items belonging to the documentation group. Can be page or group */
13
+ childrenIds: Array<string>;
14
+ /** Parent group reference */
15
+ parentId: string | null;
16
+ /** Signifies how the group should behave. If set to "tabs", group behaves as "page", but contains multiple tabbed pages inside it. "Group" signifies virtual group used for content structuring */
17
+ groupBehavior: DocsEntityGroupBehavior;
18
+ /** Internal */
19
+ relativeFirstPageUrl: string | null;
20
+ /** Internal */
21
+ deployedFirstPageUrl: string | null;
22
+ constructor(model: DocumentationLegacyGroupModel);
23
+ /** Internal: Modifies object with new paths. Don't use outside SDK environment as it doesn't propagate the data back to source */
24
+ internalOverridePaths(relative: string | null, deployed: string | null): void;
25
+ /** Retrieve relative page path without the associated domain for the first page in the group. Will work even when documentation was not yet deployed */
26
+ relativeDocsPageUrl(): string | null;
27
+ /** Retrieve page url for the first page in the group, if the documentation was already deployed (either default or custom domain) */
28
+ deployedDocsPageUrl(): string | null;
29
+ }
@@ -0,0 +1,23 @@
1
+ import { Alignment } from "../../enums/SDKAlignment";
2
+ import { AssetScaleType } from "../../enums/SDKAssetScaleType";
3
+ import { DocsColorRef } from "../blocks/support/SDKDocsColorRef";
4
+ export type DocsEntityHeaderModel = {
5
+ description: string;
6
+ alignment: Alignment;
7
+ foregroundColor?: DocsColorRef;
8
+ backgroundColor?: DocsColorRef;
9
+ backgroundImageScaleType: AssetScaleType;
10
+ showBackgroundOverlay: boolean;
11
+ showCoverText: boolean;
12
+ minHeight: number;
13
+ };
14
+ export declare class DocsEntityHeader {
15
+ description: string;
16
+ alignment: Alignment;
17
+ foregroundColor: DocsColorRef | null;
18
+ backgroundColor: DocsColorRef | null;
19
+ showBackgroundOverlay: boolean;
20
+ showCoverText: boolean;
21
+ minHeight: number;
22
+ constructor(model: DocsEntityHeaderModel);
23
+ }
@@ -0,0 +1,25 @@
1
+ import { DocsEntity, DocsEntityModel } from "./SDKDocsEntity";
2
+ export type DocsEntityPageModel = {
3
+ childrenIds: Array<string>;
4
+ } & DocsEntityModel;
5
+ export declare class DocsEntityPage extends DocsEntity {
6
+ /** Containing group. Can either be true group (abstract), or tab group */
7
+ parentId: string;
8
+ /** Internal */
9
+ deployedUrl: string | null;
10
+ /** Internal */
11
+ relativeUrl: string | null;
12
+ /** Internal */
13
+ editorUrl: string | null;
14
+ /** IDs of items belonging to the documentation group. Can be blocks and sections */
15
+ childrenIds: Array<string>;
16
+ constructor(model: DocsEntityPageModel);
17
+ /** Internal: Modifies object with new paths. Don't use outside SDK environment as it doesn't propagate the data back to source */
18
+ internalOverridePaths(deployed: string | null, editor: string | null, relative: string | null): void;
19
+ /** Retrieve editor page URL that can be opened */
20
+ editorPageUrl(): string | null;
21
+ /** Retrieve documentation page URL, if the documentation was already deployed (either default or custom domain) */
22
+ deployedPageUrl(): string | null;
23
+ /** Retrieve relative page path without the associated domain. Will work even when documentation was not yet deployed */
24
+ relativePageUrl(): string | null;
25
+ }
@@ -0,0 +1,47 @@
1
+ import { DocsSectionType } from "../../enums/SDKDocsSectionType";
2
+ import { DocsColorRef } from "../blocks/support/SDKDocsColorRef";
3
+ import { DocsSectionItemModel } from "./SDKDocsSectionItem";
4
+ export type DocsSectionModel = {
5
+ id: string;
6
+ type: DocsSectionType;
7
+ appearance?: {
8
+ expandToEdges: boolean;
9
+ contentExpandToEdges: boolean;
10
+ backgroundColor?: DocsColorRef;
11
+ foregroundColor?: DocsColorRef;
12
+ padding?: {
13
+ top?: number;
14
+ bottom?: number;
15
+ left?: number;
16
+ right?: number;
17
+ };
18
+ };
19
+ items: Array<DocsSectionItemModel>;
20
+ };
21
+ export declare class DocsSection {
22
+ /** Unique identifier of section, uuidv4() on create * */
23
+ id: string;
24
+ /** Section type */
25
+ type: DocsSectionType;
26
+ /** Global appearance properties for the section like background color, expanding to edges, etc. */
27
+ appearance: {
28
+ /** Section background is expanded to fill available area, including side margins */
29
+ expandToEdges: boolean;
30
+ /** Content of the section is expanded to fill available area, including side margins */
31
+ contentExpandToEdges: boolean;
32
+ /** Background color of the section */
33
+ backgroundColor: DocsColorRef | null;
34
+ /** Foreground color of the section */
35
+ foregroundColor: DocsColorRef | null;
36
+ /** Content offset from the sides */
37
+ padding: {
38
+ top: number;
39
+ bottom: number;
40
+ left: number;
41
+ right: number;
42
+ };
43
+ };
44
+ /** Section items contained within this section. At least one is always present */
45
+ items: Array<DocsSectionItemModel>;
46
+ constructor(model: DocsSectionModel);
47
+ }
@@ -0,0 +1,15 @@
1
+ import { DocsSizeRef } from "../blocks/support/SDKDocsSizeRef";
2
+ export type DocsSectionColumnModel = {
3
+ id: string;
4
+ width?: DocsSizeRef;
5
+ blockIds: Array<string>;
6
+ };
7
+ export declare class DocsSectionColumn {
8
+ /** Unique identifier of column */
9
+ id: string;
10
+ /** Width of the column */
11
+ width: DocsSizeRef | null;
12
+ /** Blocks contained within this column */
13
+ blockIds: Array<string>;
14
+ constructor(model: DocsSectionColumnModel);
15
+ }
@@ -0,0 +1,15 @@
1
+ import { DocsSectionColumn, DocsSectionColumnModel } from "./SDKDocsSectionColumn";
2
+ export type DocsSectionItemModel = {
3
+ id: string;
4
+ title: string;
5
+ columns: Array<DocsSectionColumnModel>;
6
+ };
7
+ export declare class DocsSectionItem {
8
+ /** Unique identifier of section item, uuidv4() on create * */
9
+ id: string;
10
+ /** User-provided item title */
11
+ title: string;
12
+ /** Section item columns contained within this section item. At least one is always present */
13
+ columns: Array<DocsSectionColumn>;
14
+ constructor(model: DocsSectionItemModel);
15
+ }
@@ -0,0 +1,13 @@
1
+ import { WorkspaceNPMRegistrySettings } from "../workspaces/SDKWorkspaceNPMRegistrySettings";
2
+ export type DocumentationLegacyConfigurationModel = {
3
+ tabbed: boolean;
4
+ storybookEmbedErrorMessage?: string;
5
+ renderCodePackageJson?: string;
6
+ };
7
+ export declare class DocumentationLegacyConfiguration {
8
+ tabbedNavigation: boolean;
9
+ storybookError: string | null;
10
+ packageJson: string | null;
11
+ npmRegistry: WorkspaceNPMRegistrySettings | null;
12
+ constructor(model: DocumentationLegacyConfigurationModel, registry: WorkspaceNPMRegistrySettings | null);
13
+ }
@@ -0,0 +1,38 @@
1
+ import { DocumentationLegacyGroupBehavior } from "../enums/SDKDocumentationLegacyGroupBehavior";
2
+ import { DocumentationLegacyItem, DocumentationLegacyItemModel } from "./SDKDocumentationLegacyItem";
3
+ import { DocumentationLegacyPage } from "./SDKDocumentationLegacyPage";
4
+ export type DocumentationLegacyGroupModel = {
5
+ isRoot: boolean;
6
+ childrenIds: Array<string>;
7
+ groupBehavior: DocumentationLegacyGroupBehavior;
8
+ } & DocumentationLegacyItemModel;
9
+ export declare class DocumentationLegacyGroup extends DocumentationLegacyItem {
10
+ /** If true, this is unique within documentation (just one) that contains all top-level objects and is root of the docs tree (root > groups > items > blocks ...) */
11
+ isRoot: boolean;
12
+ /** IDs of items belonging to the documentation group. Can be page or group */
13
+ childrenIds: Array<string>;
14
+ /** Items belonging to the documentation group. Can be page or group */
15
+ children: Array<DocumentationLegacyItem>;
16
+ /** Parent group reference */
17
+ parent: DocumentationLegacyGroup | null;
18
+ /** Signifies how the group should behave. If set to "tabs", group behaves as "page", but contains multiple tabbed pages inside it. "Group" signifies virtual group used for content structuring */
19
+ groupBehavior: DocumentationLegacyGroupBehavior;
20
+ /** Children filtered to be only groups */
21
+ get subgroups(): Array<DocumentationLegacyGroup>;
22
+ /** Children filtered to be only pages */
23
+ get pages(): Array<DocumentationLegacyPage>;
24
+ /** Internal */
25
+ relativeFirstPageUrl: string | null;
26
+ /** Internal */
27
+ deployedFirstPageUrl: string | null;
28
+ constructor(model: DocumentationLegacyGroupModel);
29
+ addChild(item: DocumentationLegacyItem): void;
30
+ addChildren(groups: Array<DocumentationLegacyItem>): void;
31
+ setParent(parent: DocumentationLegacyGroup | null): void;
32
+ /** Internal: Modifies object with new paths. Don't use outside SDK environment as it doesn't propagate the data back to source */
33
+ internalOverridePaths(relative: string | null, deployed: string | null): void;
34
+ /** Retrieve relative page path without the associated domain for the first page in the group. Will work even when documentation was not yet deployed */
35
+ relativeDocsPageUrl(): string | null;
36
+ /** Retrieve page url for the first page in the group, if the documentation was already deployed (either default or custom domain) */
37
+ deployedDocsPageUrl(): string | null;
38
+ }
@@ -0,0 +1,26 @@
1
+ import { DocumentationLegacyItemType } from "../enums/SDKDocumentationLegacyItemType";
2
+ import { DocumentationLegacyItemConfiguration, DocumentationLegacyItemConfigurationModel } from "./configuration/SDKDocumentationLegacyItemConfiguration";
3
+ export type DocumentationLegacyItemModel = {
4
+ persistentId: string;
5
+ id: string;
6
+ designSystemVersionId: string;
7
+ title: string;
8
+ type: DocumentationLegacyItemType;
9
+ slug: string;
10
+ userSlug?: string;
11
+ configuration: DocumentationLegacyItemConfigurationModel;
12
+ createdAt?: string;
13
+ updatedAt?: string;
14
+ };
15
+ export declare class DocumentationLegacyItem {
16
+ id: string;
17
+ persistentId: string;
18
+ type: DocumentationLegacyItemType;
19
+ title: string;
20
+ configuration: DocumentationLegacyItemConfiguration;
21
+ slug: string;
22
+ userSlug: string | null;
23
+ createdAt: Date | null;
24
+ updatedAt: Date | null;
25
+ constructor(model: DocumentationLegacyItemModel);
26
+ }
@@ -0,0 +1,32 @@
1
+ import { ExporterCustomBlock } from "../exporters/custom_blocks/SDKExporterCustomBlock";
2
+ import { DocumentationLegacyConfiguration } from "./SDKDocumentationLegacyConfiguration";
3
+ import { DocumentationLegacyGroup } from "./SDKDocumentationLegacyGroup";
4
+ import { DocumentationLegacyItem, DocumentationLegacyItemModel } from "./SDKDocumentationLegacyItem";
5
+ import { DocumentationLegacyPageBlock, DocumentationLegacyPageBlockModel } from "./SDKDocumentationLegacyPageBlock";
6
+ export type DocumentationLegacyPageModel = {
7
+ path: string;
8
+ blocks?: Array<DocumentationLegacyPageBlockModel>;
9
+ } & DocumentationLegacyItemModel;
10
+ export declare class DocumentationLegacyPage extends DocumentationLegacyItem {
11
+ /** All blocks that were defined on the top level of the page */
12
+ blocks?: Array<DocumentationLegacyPageBlock>;
13
+ /** Containing group. Can either be true group (abstract), or tab group */
14
+ parent: DocumentationLegacyGroup;
15
+ /** Internal */
16
+ deployedUrl: string | null;
17
+ /** Internal */
18
+ relativeUrl: string;
19
+ /** Internal */
20
+ editorUrl: string | null;
21
+ constructor(model: DocumentationLegacyPageModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationLegacyConfiguration);
22
+ /** Internal: Modifies object with new paths. Don't use outside SDK environment as it doesn't propagate the data back to source */
23
+ internalOverridePaths(deployed: string | null, editor: string | null): void;
24
+ /** Internal: Sets new parent. Used when manipulating with object internally. Don't use outside SDK environment */
25
+ setParent(parent: DocumentationLegacyGroup): void;
26
+ /** Retrieve editor page URL that can be opened */
27
+ editorPageUrl(): string | null;
28
+ /** Retrieve documentation page URL, if the documentation was already deployed (either default or custom domain) */
29
+ deployedPageUrl(): string | null;
30
+ /** Retrieve relative page path without the associated domain. Will work even when documentation was not yet deployed */
31
+ relativePageUrl(): string | null;
32
+ }
@@ -0,0 +1,15 @@
1
+ import { DocumentationLegacyPageAssetType } from "../enums/SDKDocumentationLegacyPageAssetType";
2
+ import { DocumentationLegacyPageBlockFrame, DocumentationLegacyPageBlockFrameModel } from "./blocks/SDKDocumentationLegacyPageBlockFrame";
3
+ export type DocumentationLegacyPageAssetModel = {
4
+ id: string;
5
+ url?: string;
6
+ type: DocumentationLegacyPageAssetType;
7
+ figmaFrame?: DocumentationLegacyPageBlockFrameModel;
8
+ };
9
+ export declare class DocumentationLegacyPageAsset {
10
+ id: string;
11
+ url: string | null;
12
+ type: DocumentationLegacyPageAssetType;
13
+ frame: DocumentationLegacyPageBlockFrame | null;
14
+ constructor(model: DocumentationLegacyPageAssetModel);
15
+ }
@@ -0,0 +1,30 @@
1
+ import { DocumentationLegacyPageBlockThemeType } from "../enums/SDKDocumentationLegacyPageBlockThemeType";
2
+ import { DocumentationLegacyPageBlockType } from "../enums/SDKDocumentationLegacyPageBlockType";
3
+ export type DocumentationLegacyPageBlockModel = {
4
+ persistentId: string;
5
+ designObjectId: string;
6
+ type: DocumentationLegacyPageBlockType;
7
+ children?: Array<DocumentationLegacyPageBlockModel>;
8
+ variantKey?: string;
9
+ theme?: {
10
+ themeIds: Array<string>;
11
+ type: DocumentationLegacyPageBlockThemeType;
12
+ };
13
+ blacklistedElementProperties?: Array<string>;
14
+ userMetadata?: string;
15
+ };
16
+ export declare class DocumentationLegacyPageBlock {
17
+ id: string;
18
+ children?: Array<DocumentationLegacyPageBlock>;
19
+ type: DocumentationLegacyPageBlockType;
20
+ beginsTypeChain: boolean;
21
+ endsTypeChain: boolean;
22
+ variantKey: string | null;
23
+ theme: {
24
+ themeIds: Array<string>;
25
+ type: DocumentationLegacyPageBlockThemeType;
26
+ } | null;
27
+ blacklistedElementProperties: Array<string> | null;
28
+ userMetadata: object | Array<any> | null;
29
+ constructor(model: DocumentationLegacyPageBlockModel, children: Array<DocumentationLegacyPageBlock>);
30
+ }
@@ -0,0 +1,10 @@
1
+ import { RichTextSpan, RichTextSpanModel } from "./SDKDocumentationLegacyRichTextSpan";
2
+ export type DocumentationLegacyRichTextModel = {
3
+ spans: Array<RichTextSpanModel>;
4
+ };
5
+ export declare class DocumentationLegacyRichText {
6
+ spans: Array<RichTextSpan>;
7
+ constructor(model: DocumentationLegacyRichTextModel);
8
+ /** Convert rich text into plain text, omitting any formatting */
9
+ asPlainText(): string;
10
+ }
@@ -0,0 +1,10 @@
1
+ import { RichTextSpanAttribute, RichTextSpanAttributeModel } from "./SDKDocumentationLegacyRichTextSpanAttribute";
2
+ export type RichTextSpanModel = {
3
+ text: string;
4
+ attributes: Array<RichTextSpanAttributeModel>;
5
+ };
6
+ export declare class RichTextSpan {
7
+ text: string;
8
+ attributes: Array<RichTextSpanAttribute>;
9
+ constructor(model: RichTextSpanModel);
10
+ }
@@ -0,0 +1,14 @@
1
+ import { RichTextSpanAttributeType } from "../enums/SDKRichTextSpanAttributeType";
2
+ export type RichTextSpanAttributeModel = {
3
+ type: RichTextSpanAttributeType;
4
+ link?: string;
5
+ documentationItemId?: string;
6
+ openInNewWindow: boolean;
7
+ };
8
+ export declare class RichTextSpanAttribute {
9
+ type: RichTextSpanAttributeType;
10
+ link: string | null;
11
+ openInNewWindow: boolean;
12
+ documentationItemId: string | null;
13
+ constructor(model: RichTextSpanAttributeModel);
14
+ }
@@ -0,0 +1,15 @@
1
+ import { ColorTokenRemoteData } from "../../tokens/remote/SDKRemoteTokenData";
2
+ export type DocumentationLegacyPageBlockAssetModel = {
3
+ componentAssetId: string;
4
+ title?: string;
5
+ description?: string;
6
+ backgroundColor?: ColorTokenRemoteData;
7
+ };
8
+ export declare class DocumentationLegacyPageBlockAsset {
9
+ assetId: string;
10
+ title: string | null;
11
+ description: string | null;
12
+ previewUrl: string | null;
13
+ backgroundColor: ColorTokenRemoteData | null;
14
+ constructor(model: DocumentationLegacyPageBlockAssetModel, blockBackgroundColor: ColorTokenRemoteData | null);
15
+ }
@@ -0,0 +1,22 @@
1
+ import { FrameAlignment } from "../../enums/SDKFrameAlignment";
2
+ import { FrameLayout } from "../../enums/SDKFrameLayout";
3
+ import { ColorTokenRemoteData } from "../../tokens/remote/SDKRemoteTokenData";
4
+ import { DocumentationLegacyPageBlock, DocumentationLegacyPageBlockModel } from "../SDKDocumentationLegacyPageBlock";
5
+ import { DocumentationLegacyPageBlockAsset, DocumentationLegacyPageBlockAssetModel } from "./SDKDocumentationLegacyPageBlockAsset";
6
+ export type DocumentationLegacyPageBlockAssetsModel = {
7
+ componentAssets: Array<DocumentationLegacyPageBlockAssetModel>;
8
+ figmaFrameProperties: {
9
+ alignment: FrameAlignment;
10
+ color?: ColorTokenRemoteData;
11
+ layout: FrameLayout;
12
+ };
13
+ } & DocumentationLegacyPageBlockModel;
14
+ export declare class DocumentationLegacyPageBlockAssets extends DocumentationLegacyPageBlock {
15
+ assets: Array<DocumentationLegacyPageBlockAsset>;
16
+ properties: {
17
+ backgroundColor: ColorTokenRemoteData | null;
18
+ alignment: FrameAlignment;
19
+ layout: FrameLayout;
20
+ };
21
+ constructor(model: DocumentationLegacyPageBlockAssetsModel, children: Array<DocumentationLegacyPageBlock>);
22
+ }
@@ -0,0 +1,10 @@
1
+ import { DocumentationLegacyCalloutType } from "../../enums/SDKDocumentationLegacyCalloutType";
2
+ import { DocumentationLegacyPageBlock } from "../SDKDocumentationLegacyPageBlock";
3
+ import { DocumentationLegacyPageBlockText, DocumentationLegacyPageBlockTextModel } from "./SDKDocumentationLegacyPageBlockText";
4
+ export type DocumentationLegacyPageBlockCalloutModel = {
5
+ calloutType: DocumentationLegacyCalloutType;
6
+ } & DocumentationLegacyPageBlockTextModel;
7
+ export declare class DocumentationLegacyPageBlockCallout extends DocumentationLegacyPageBlockText {
8
+ calloutType: DocumentationLegacyCalloutType;
9
+ constructor(model: DocumentationLegacyPageBlockCalloutModel, children: Array<DocumentationLegacyPageBlock>);
10
+ }
@@ -0,0 +1,11 @@
1
+ import { DocumentationLegacyPageBlock } from "../SDKDocumentationLegacyPageBlock";
2
+ import { DocumentationLegacyPageBlockText, DocumentationLegacyPageBlockTextModel } from "./SDKDocumentationLegacyPageBlockText";
3
+ export type DocumentationLegacyPageBlockCodeModel = {
4
+ codeLanguage?: string;
5
+ caption?: string;
6
+ } & DocumentationLegacyPageBlockTextModel;
7
+ export declare class DocumentationLegacyPageBlockCode extends DocumentationLegacyPageBlockText {
8
+ codeLanguage: string | null;
9
+ caption: string | null;
10
+ constructor(model: DocumentationLegacyPageBlockCodeModel, children: Array<DocumentationLegacyPageBlock>);
11
+ }
@@ -0,0 +1,4 @@
1
+ import { DocumentationLegacyPageBlock, DocumentationLegacyPageBlockModel } from "../SDKDocumentationLegacyPageBlock";
2
+ export type DocumentationLegacyPageBlockColumnModel = DocumentationLegacyPageBlockModel;
3
+ export declare class DocumentationLegacyPageBlockColumn extends DocumentationLegacyPageBlock {
4
+ }
@@ -0,0 +1,9 @@
1
+ import { DimensionTokenRemoteData } from "../../tokens/remote/SDKRemoteTokenData";
2
+ import { DocumentationLegacyPageBlock, DocumentationLegacyPageBlockModel } from "../SDKDocumentationLegacyPageBlock";
3
+ export type DocumentationLegacyPageBlockColumnItemModel = {
4
+ width: DimensionTokenRemoteData;
5
+ } & DocumentationLegacyPageBlockModel;
6
+ export declare class DocumentationLegacyPageBlockColumnItem extends DocumentationLegacyPageBlock {
7
+ width: DimensionTokenRemoteData;
8
+ constructor(model: DocumentationLegacyPageBlockColumnItemModel, children: Array<DocumentationLegacyPageBlock>);
9
+ }
@@ -0,0 +1,15 @@
1
+ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
2
+ import { DocumentationLegacyPageBlock, DocumentationLegacyPageBlockModel } from "../SDKDocumentationLegacyPageBlock";
3
+ export type DocumentationLegacyPageBlockCustomModel = {
4
+ customBlockKey: string;
5
+ customBlockProperties?: Array<{
6
+ key: string;
7
+ value: any;
8
+ }>;
9
+ } & DocumentationLegacyPageBlockModel;
10
+ export declare class DocumentationLegacyPageBlockCustom extends DocumentationLegacyPageBlock {
11
+ key: string;
12
+ properties: object;
13
+ block: ExporterCustomBlock | null;
14
+ constructor(model: DocumentationLegacyPageBlockCustomModel, children: Array<DocumentationLegacyPageBlock>, customBlocks: Array<ExporterCustomBlock>);
15
+ }
@@ -0,0 +1,4 @@
1
+ import { DocumentationLegacyPageBlock, DocumentationLegacyPageBlockModel } from "../SDKDocumentationLegacyPageBlock";
2
+ export type DocumentationLegacyPageBlockDividerModel = DocumentationLegacyPageBlockModel;
3
+ export declare class DocumentationLegacyPageBlockDivider extends DocumentationLegacyPageBlock {
4
+ }
@@ -0,0 +1,4 @@
1
+ import { DocumentationLegacyPageBlockEmbedGeneric, DocumentationLegacyPageBlockEmbedGenericModel } from "./SDKDocumentationLegacyPageBlockEmbedGeneric";
2
+ export type DocumentationLegacyPageBlockEmbedFigmaModel = DocumentationLegacyPageBlockEmbedGenericModel;
3
+ export declare class DocumentationLegacyPageBlockEmbedFigma extends DocumentationLegacyPageBlockEmbedGeneric {
4
+ }
@@ -0,0 +1,13 @@
1
+ import { Size, SizeModel } from "../../support/SDKSize";
2
+ import { DocumentationLegacyPageBlock, DocumentationLegacyPageBlockModel } from "../SDKDocumentationLegacyPageBlock";
3
+ export type DocumentationLegacyPageBlockEmbedGenericModel = {
4
+ url?: string;
5
+ size?: SizeModel;
6
+ caption?: string;
7
+ } & DocumentationLegacyPageBlockModel;
8
+ export declare class DocumentationLegacyPageBlockEmbedGeneric extends DocumentationLegacyPageBlock {
9
+ url: string | null;
10
+ size: Size | null;
11
+ caption: string | null;
12
+ constructor(model: DocumentationLegacyPageBlockEmbedGenericModel, children: Array<DocumentationLegacyPageBlock>);
13
+ }
@@ -0,0 +1,15 @@
1
+ import { DocumentationLegacyPageBlock } from "../SDKDocumentationLegacyPageBlock";
2
+ import { DocumentationLegacyPageBlockEmbedGeneric, DocumentationLegacyPageBlockEmbedGenericModel } from "./SDKDocumentationLegacyPageBlockEmbedGeneric";
3
+ export type DocumentationLegacyPageBlockEmbedLinkModel = {
4
+ urlPreview?: {
5
+ title?: string;
6
+ description?: string;
7
+ thumbnailUrl?: string;
8
+ };
9
+ } & DocumentationLegacyPageBlockEmbedGenericModel;
10
+ export declare class DocumentationLegacyPageBlockEmbedLink extends DocumentationLegacyPageBlockEmbedGeneric {
11
+ title: string | null;
12
+ description: string | null;
13
+ thumbnailUrl: string | null;
14
+ constructor(model: DocumentationLegacyPageBlockEmbedLinkModel, children: Array<DocumentationLegacyPageBlock>);
15
+ }
@@ -0,0 +1,4 @@
1
+ import { DocumentationLegacyPageBlockEmbedGeneric, DocumentationLegacyPageBlockEmbedGenericModel } from "./SDKDocumentationLegacyPageBlockEmbedGeneric";
2
+ export type DocumentationLegacyPageBlockEmbedStorybookModel = DocumentationLegacyPageBlockEmbedGenericModel;
3
+ export declare class DocumentationLegacyPageBlockEmbedStorybook extends DocumentationLegacyPageBlockEmbedGeneric {
4
+ }
@@ -0,0 +1,4 @@
1
+ import { DocumentationLegacyPageBlockEmbedGeneric, DocumentationLegacyPageBlockEmbedGenericModel } from "./SDKDocumentationLegacyPageBlockEmbedGeneric";
2
+ export type DocumentationLegacyPageBlockEmbedYoutubeModel = DocumentationLegacyPageBlockEmbedGenericModel;
3
+ export declare class DocumentationLegacyPageBlockEmbedYoutube extends DocumentationLegacyPageBlockEmbedGeneric {
4
+ }
@@ -0,0 +1,18 @@
1
+ import { FrameOrigin, FrameOriginModel } from "../../support/SDKFrameOrigin";
2
+ import { ColorTokenRemoteData } from "../../tokens/remote/SDKRemoteTokenData";
3
+ export type DocumentationLegacyPageBlockFrameModel = {
4
+ sourceId: string;
5
+ sourceFrameId: string;
6
+ title?: string;
7
+ description?: string;
8
+ backgroundColor?: ColorTokenRemoteData;
9
+ origin: FrameOriginModel;
10
+ };
11
+ export declare class DocumentationLegacyPageBlockFrame {
12
+ title: string | null;
13
+ description: string | null;
14
+ previewUrl: string;
15
+ backgroundColor: ColorTokenRemoteData | null;
16
+ origin: FrameOrigin | null;
17
+ constructor(model: DocumentationLegacyPageBlockFrameModel, blockBackgroundColor: ColorTokenRemoteData | null);
18
+ }