@supernova-studio/supernova-sdk-beta 0.7.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +135 -0
- package/build/sdk-typescript/.eslintrc.d.cts +41 -0
- package/build/sdk-typescript/src/browser-bundle.d.ts +1 -0
- package/build/sdk-typescript/src/core/SDKSupernova.d.ts +77 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaAssets.d.ts +46 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +233 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaBrands.d.ts +35 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaBulkOperations.d.ts +68 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaComponents.d.ts +162 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDataSources.d.ts +54 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDesignSystems.d.ts +104 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +179 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaIntegrations.d.ts +91 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaMe.d.ts +22 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaMultiplayer.d.ts +10 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaNetwork.d.ts +9 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaResources.d.ts +46 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaStorage.d.ts +23 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaTokenValues.d.ts +136 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaTokens.d.ts +225 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaUsers.d.ts +6 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaVersions.d.ts +35 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +230 -0
- package/build/sdk-typescript/src/core/areas/SDKRemoteIdentifiers.d.ts +25 -0
- package/build/sdk-typescript/src/core/data/SDKConfiguration.d.ts +6 -0
- package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +55 -0
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +508 -0
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +232 -0
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreRenderRequests.d.ts +18 -0
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +237 -0
- package/build/sdk-typescript/src/core/errors/SDKSupernovaError.d.ts +47 -0
- package/build/sdk-typescript/src/core/resolvers/SDKAssetGroupResolver.d.ts +18 -0
- package/build/sdk-typescript/src/core/resolvers/SDKComponentGroupResolver.d.ts +13 -0
- package/build/sdk-typescript/src/core/resolvers/SDKComponentResolver.d.ts +7 -0
- package/build/sdk-typescript/src/core/resolvers/SDKDesignComponentGroupResolver.d.ts +10 -0
- package/build/sdk-typescript/src/core/resolvers/SDKDocsEntityMultiplayerItemResolver.d.ts +7 -0
- package/build/sdk-typescript/src/core/resolvers/SDKDocumentationItemResolver.d.ts +31 -0
- package/build/sdk-typescript/src/core/resolvers/SDKTokenGroupResolver.d.ts +10 -0
- package/build/sdk-typescript/src/core/resolvers/SDKTokenResolver.d.ts +105 -0
- package/build/sdk-typescript/src/exports-pulsar.d.ts +228 -0
- package/build/sdk-typescript/src/exports.d.ts +291 -0
- package/build/sdk-typescript/src/index.d.ts +5 -0
- package/build/sdk-typescript/src/model/acl/SDKAcl.d.ts +51 -0
- package/build/sdk-typescript/src/model/assets/SDKAsset.d.ts +17 -0
- package/build/sdk-typescript/src/model/assets/SDKRenderedAsset.d.ts +28 -0
- package/build/sdk-typescript/src/model/base/SDKBrand.d.ts +34 -0
- package/build/sdk-typescript/src/model/base/SDKDesignSystem.d.ts +54 -0
- package/build/sdk-typescript/src/model/base/SDKDesignSystemVersion.d.ts +45 -0
- package/build/sdk-typescript/src/model/base/SDKDocumentationLegacy.d.ts +10 -0
- package/build/sdk-typescript/src/model/components/SDKComponent.d.ts +32 -0
- package/build/sdk-typescript/src/model/components/SDKDesignComponent.d.ts +34 -0
- package/build/sdk-typescript/src/model/docs/SDKDocsConfiguration.d.ts +13 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockBehavior.d.ts +36 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockDefinition.d.ts +47 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockItemDefinition.d.ts +20 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockLayout.d.ts +19 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockOnboarding.d.ts +11 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockVariant.d.ts +35 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/assets/SDKDocsBlockActualAssets.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/blockquote/SDKDocsBlockActualBlockquote.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/callout/SDKDocsBlockActualCallout.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/code/SDKDocsBlockActualCode.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/code-react/SDKDocsBlockActualCodeReact.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/color-accessibility-grid/SDKDocsBlockActualAccessibilityGrid.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/color-ramps/SDKDocsBlockActualColorRamps.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/component-checklist/SDKDocsBlockActualComponentChecklist.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/component-checklist-all/SDKDocsBlockActualComponentChecklistAll.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/component-health/SDKDocsBlockActualComponentHealth.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/design-tokens/SDKDocsBlockActualDesignTokens.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/divider/SDKDocsBlockActualDivider.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed/SDKDocsBlockActualEmbed.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed-figma/SDKDocsBlockActualEmbedFigma.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed-lottie/SDKDocsBlockActualEmbedLottie.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed-youtube/SDKDocsBlockActualEmbedYoutube.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/figma-frames/SDKDocsBlockActualFigmaFrames.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/image/SDKDocsBlockActualImage.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/link/SDKDocsBlockActualLink.d.ts +8 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/markdown/SDKDocsBlockActualMarkdown.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/omni-multi-item/SDKDocsBlockActualOmniMultiItem.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/omni-single-item/SDKDocsBlockActualOmniSingleItem.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/ordered-list/SDKDocsBlockActualOrderedList.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/release-notes/SDKDocsBlockActualReleaseNotes.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/rich-text/SDKDocsBlockActualRichText.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/shortcut-links/SDKDocsBlockActualShortcutLinks.d.ts +8 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/storybook/SDKDocsBlockActualStorybook.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/table/SDKDocsBlockActualTable.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/title1/SDKDocsBlockActualTitle1.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/title2/SDKDocsBlockActualTitle2.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/title3/SDKDocsBlockActualTitle3.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/title4/SDKDocsBlockActualTitle4.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/title5/SDKDocsBlockActualTitle5.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/token-detail/SDKDocsBlockActualTokenDetail.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/token-list/SDKDocsBlockActualTokenList.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/unordered-list/SDKDocsBlockActualUnorderedList.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts +29 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetPropertyProperty.d.ts +12 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts +18 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeProperty.d.ts +16 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts +21 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockColorProperty.d.ts +13 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts +23 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentPropertyProperty.d.ts +12 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockDividerProperty.d.ts +12 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts +25 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockFigmaNodeProperty.d.ts +30 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockImageProperty.d.ts +25 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMarkdownProperty.d.ts +15 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty.d.ts +19 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty.d.ts +21 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockNumberProperty.d.ts +23 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockProperty.d.ts +30 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts +23 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts +27 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +24 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTableProperty.d.ts +38 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +23 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +36 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenPropertyProperty.d.ts +12 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty.d.ts +15 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockUrlProperty.d.ts +14 -0
- package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsColorRef.d.ts +3 -0
- package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsImageRef.d.ts +26 -0
- package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsLinkRef.d.ts +24 -0
- package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsSizeRef.d.ts +8 -0
- package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlock.d.ts +47 -0
- package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlockItem.d.ts +16 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntity.d.ts +30 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityConfiguration.d.ts +15 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityGroup.d.ts +51 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityHeader.d.ts +29 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityPage.d.ts +39 -0
- package/build/sdk-typescript/src/model/docs/sections/SDKDocsSection.d.ts +47 -0
- package/build/sdk-typescript/src/model/docs/sections/SDKDocsSectionColumn.d.ts +15 -0
- package/build/sdk-typescript/src/model/docs/sections/SDKDocsSectionItem.d.ts +15 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyConfiguration.d.ts +22 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyGroup.d.ts +40 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyItem.d.ts +26 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPage.d.ts +34 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageAsset.d.ts +21 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageBlock.d.ts +30 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyRichText.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyRichTextSpan.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyRichTextSpanAttribute.d.ts +14 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockAsset.d.ts +15 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockAssets.d.ts +22 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockCallout.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockCode.d.ts +11 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockColumn.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockColumnItem.d.ts +9 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockCustom.d.ts +15 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockDivider.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedFigma.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedGeneric.d.ts +13 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedLink.d.ts +15 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedStorybook.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedYoutube.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockFrame.d.ts +21 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockFrames.d.ts +24 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockHeading.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockImage.d.ts +16 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockOrderedList.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockQuote.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockRenderCode.d.ts +33 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockShortcut.d.ts +35 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockShortcuts.d.ts +9 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTab.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTabItem.d.ts +8 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTable.d.ts +21 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTableCell.d.ts +11 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTableColumn.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTableRow.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockText.d.ts +11 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockToken.d.ts +8 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTokenGroup.d.ts +10 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockTokenList.d.ts +8 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockUnorderedList.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/builder/SDKDocumentationLegacyBlockBuilder.d.ts +6 -0
- package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationLegacyItemConfiguration.d.ts +11 -0
- package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationLegacyItemHeader.d.ts +36 -0
- package/build/sdk-typescript/src/model/elements/SDKElementDataView.d.ts +30 -0
- package/build/sdk-typescript/src/model/elements/SDKElementDataViewColumn.d.ts +37 -0
- package/build/sdk-typescript/src/model/elements/SDKElementProperty.d.ts +73 -0
- package/build/sdk-typescript/src/model/elements/SDKElementPropertyOption.d.ts +45 -0
- package/build/sdk-typescript/src/model/elements/values/SDKElementPropertyValue.d.ts +15 -0
- package/build/sdk-typescript/src/model/enums/SDKAlignment.d.ts +10 -0
- package/build/sdk-typescript/src/model/enums/SDKAssetFormat.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKAssetScale.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKAssetScaleType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKBlurType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKBorderPosition.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKBorderStyle.d.ts +7 -0
- package/build/sdk-typescript/src/model/enums/SDKCloudWarningType.d.ts +14 -0
- package/build/sdk-typescript/src/model/enums/SDKCodeLanguage.d.ts +34 -0
- package/build/sdk-typescript/src/model/enums/SDKConnectionProviders.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKCustomDomainErrorCode.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKCustomDomainState.d.ts +9 -0
- package/build/sdk-typescript/src/model/enums/SDKDocBlockMode.d.ts +8 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockBehaviorDataType.d.ts +12 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockBehaviorSelectionType.d.ts +8 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockCategory.d.ts +26 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockContainerSize.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockImagePropertyAspectRatio.d.ts +12 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockImagePropertyWidth.d.ts +14 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemEntityType.d.ts +14 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyOptionRenderingStyle.d.ts +10 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyRichTextStyle.d.ts +20 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyTextStyle.d.ts +8 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +55 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutAlign.d.ts +8 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutColumnResizing.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutGap.d.ts +10 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutType.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutWidth.d.ts +26 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockMultiRichTextPropertyStyle.d.ts +8 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockOptionRenderStyle.d.ts +10 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockRichTextPropertyStyle.d.ts +18 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockTextPropertyColor.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockTextPropertyStyle.d.ts +26 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsEntityGroupBehavior.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsEntityType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsPublishStatus.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsSectionType.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationEnvironment.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyCalloutType.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyGroupBehavior.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyHeadingType.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyItemType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyPageAssetType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyPageBlockThemeType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyPageBlockType.d.ts +31 -0
- package/build/sdk-typescript/src/model/enums/SDKFrameAlignment.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKFrameLayout.d.ts +11 -0
- package/build/sdk-typescript/src/model/enums/SDKGradientType.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKImportJobOperation.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKImportJobState.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKIntegrationService.d.ts +7 -0
- package/build/sdk-typescript/src/model/enums/SDKRichTextSpanAttributeType.d.ts +7 -0
- package/build/sdk-typescript/src/model/enums/SDKShadowType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKSourceType.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKTextCase.d.ts +7 -0
- package/build/sdk-typescript/src/model/enums/SDKTextDecoration.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts +49 -0
- package/build/sdk-typescript/src/model/enums/SDKUnit.d.ts +17 -0
- package/build/sdk-typescript/src/model/enums/SDKUserRole.d.ts +8 -0
- package/build/sdk-typescript/src/model/enums/SDKVisibilityType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceNPMRegistryAuthType.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceNPMRegistryType.d.ts +12 -0
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionPlanInterval.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionProduct.d.ts +12 -0
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionStatus.d.ts +10 -0
- package/build/sdk-typescript/src/model/exporters/CodegenAccount.d.ts +9 -0
- package/build/sdk-typescript/src/model/exporters/CodegenAzureBranch.d.ts +7 -0
- package/build/sdk-typescript/src/model/exporters/CodegenAzureOrganization.d.ts +7 -0
- package/build/sdk-typescript/src/model/exporters/CodegenAzureProject.d.ts +7 -0
- package/build/sdk-typescript/src/model/exporters/CodegenAzureRepository.d.ts +11 -0
- package/build/sdk-typescript/src/model/exporters/CodegenBitbucketBranch.d.ts +7 -0
- package/build/sdk-typescript/src/model/exporters/CodegenBitbucketProject.d.ts +6 -0
- package/build/sdk-typescript/src/model/exporters/CodegenBitbucketRepository.d.ts +8 -0
- package/build/sdk-typescript/src/model/exporters/CodegenBitbucketWorkspace.d.ts +6 -0
- package/build/sdk-typescript/src/model/exporters/CodegenBranch.d.ts +8 -0
- package/build/sdk-typescript/src/model/exporters/CodegenConnection.d.ts +10 -0
- package/build/sdk-typescript/src/model/exporters/CodegenGitlabBranch.d.ts +7 -0
- package/build/sdk-typescript/src/model/exporters/CodegenGitlabGroup.d.ts +6 -0
- package/build/sdk-typescript/src/model/exporters/CodegenGitlabRepository.d.ts +9 -0
- package/build/sdk-typescript/src/model/exporters/CodegenRepository.d.ts +15 -0
- package/build/sdk-typescript/src/model/exporters/SDKConnections.d.ts +17 -0
- package/build/sdk-typescript/src/model/exporters/SDKExporter.d.ts +83 -0
- package/build/sdk-typescript/src/model/exporters/SDKPipeline.d.ts +113 -0
- package/build/sdk-typescript/src/model/exporters/custom_blocks/SDKExporterCustomBlock.d.ts +23 -0
- package/build/sdk-typescript/src/model/exporters/custom_blocks/SDKExporterCustomBlockProperty.d.ts +32 -0
- package/build/sdk-typescript/src/model/exporters/custom_blocks/SDKExporterCustomBlockVariant.d.ts +12 -0
- package/build/sdk-typescript/src/model/exporters/custom_properties/SDKExporterConfigurationProperty.d.ts +38 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuild.d.ts +115 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuildResults.d.ts +84 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportDestinations.d.ts +126 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenBranchModel.d.ts +5 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenOrganizationModel.d.ts +5 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenProjectModel.d.ts +5 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenRepositoryModel.d.ts +9 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenBranchModel.d.ts +5 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenProjectModel.d.ts +4 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenRepositoryModel.d.ts +6 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenWorkspaceModel.d.ts +4 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenAccountModel.d.ts +7 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenBranchModel.d.ts +6 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenConnectionModel.d.ts +8 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenRepositoryModel.d.ts +17 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteConnectionsModel.d.ts +9 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenBranchModel.d.ts +5 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenGroupModel.d.ts +4 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenRepositoryModel.d.ts +7 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemotePipelineModel.d.ts +57 -0
- package/build/sdk-typescript/src/model/groups/SDKAssetGroup.d.ts +24 -0
- package/build/sdk-typescript/src/model/groups/SDKComponentGroup.d.ts +40 -0
- package/build/sdk-typescript/src/model/groups/SDKDesignComponentGroup.d.ts +33 -0
- package/build/sdk-typescript/src/model/groups/SDKTokenGroup.d.ts +43 -0
- package/build/sdk-typescript/src/model/jobs/SDKImportJob.d.ts +34 -0
- package/build/sdk-typescript/src/model/membership/SDKMembership.d.ts +16 -0
- package/build/sdk-typescript/src/model/resources/SDKResource.d.ts +26 -0
- package/build/sdk-typescript/src/model/resources/SDKResourceAsset.d.ts +6 -0
- package/build/sdk-typescript/src/model/resources/SDKResourceFont.d.ts +25 -0
- package/build/sdk-typescript/src/model/support/SDKCustomDomain.d.ts +21 -0
- package/build/sdk-typescript/src/model/support/SDKDesignComponentOrigin.d.ts +23 -0
- package/build/sdk-typescript/src/model/support/SDKFigmaFrame.d.ts +22 -0
- package/build/sdk-typescript/src/model/support/SDKFigmaStructure.d.ts +27 -0
- package/build/sdk-typescript/src/model/support/SDKFigmaStructureDetail.d.ts +30 -0
- package/build/sdk-typescript/src/model/support/SDKFrameOrigin.d.ts +25 -0
- package/build/sdk-typescript/src/model/support/SDKLogger.d.ts +4 -0
- package/build/sdk-typescript/src/model/support/SDKSize.d.ts +9 -0
- package/build/sdk-typescript/src/model/support/SDKSource.d.ts +150 -0
- package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +18 -0
- package/build/sdk-typescript/src/model/themes/SDKThemeUtilities.d.ts +11 -0
- package/build/sdk-typescript/src/model/themes/SDKTokenTheme.d.ts +55 -0
- package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +46 -0
- package/build/sdk-typescript/src/model/tokens/SDKBlurToken.d.ts +22 -0
- package/build/sdk-typescript/src/model/tokens/SDKBorderToken.d.ts +24 -0
- package/build/sdk-typescript/src/model/tokens/SDKColorToken.d.ts +34 -0
- package/build/sdk-typescript/src/model/tokens/SDKDimensionToken.d.ts +104 -0
- package/build/sdk-typescript/src/model/tokens/SDKGradientToken.d.ts +26 -0
- package/build/sdk-typescript/src/model/tokens/SDKShadowToken.d.ts +26 -0
- package/build/sdk-typescript/src/model/tokens/SDKStringToken.d.ts +61 -0
- package/build/sdk-typescript/src/model/tokens/SDKTextCaseToken.d.ts +23 -0
- package/build/sdk-typescript/src/model/tokens/SDKTextDecorationToken.d.ts +26 -0
- package/build/sdk-typescript/src/model/tokens/SDKToken.d.ts +33 -0
- package/build/sdk-typescript/src/model/tokens/SDKTokenCompator.d.ts +20 -0
- package/build/sdk-typescript/src/model/tokens/SDKTokenValue.d.ts +201 -0
- package/build/sdk-typescript/src/model/tokens/SDKTypographyToken.d.ts +20 -0
- package/build/sdk-typescript/src/model/tokens/SDKVisibilityToken.d.ts +18 -0
- package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenData.d.ts +105 -0
- package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenModel.d.ts +64 -0
- package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenValue.d.ts +111 -0
- package/build/sdk-typescript/src/model/users/SDKUser.d.ts +53 -0
- package/build/sdk-typescript/src/model/users/SDKUserMembership.d.ts +18 -0
- package/build/sdk-typescript/src/model/users/SDKUserProfile.d.ts +55 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspace.d.ts +22 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceIPWhitelistSettings.d.ts +26 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceInvitation.d.ts +35 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceInvoice.d.ts +38 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceNPMRegistryAccessToken.d.ts +15 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceNPMRegistrySettings.d.ts +34 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceOnboarding.d.ts +30 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProduct.d.ts +21 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProductFeatures.d.ts +32 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProductPrice.d.ts +40 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProfile.d.ts +68 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceSSOSettings.d.ts +19 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceSubscription.d.ts +85 -0
- package/build/sdk-typescript/src/pulsar-interfaces.d.ts +40 -0
- package/build/sdk-typescript/src/tests/Areas/AreaAssets.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Areas/AreaBatchUpdates.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Areas/AreaBrands.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Areas/AreaDesignSystems.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Areas/AreaDocumentation.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Areas/AreaMe.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Areas/AreaStorage.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Areas/AreaTokens.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Areas/AreaWorkspace.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/FigmaTokensDataLoader.d.ts +33 -0
- package/build/sdk-typescript/src/tests/Serialization/User.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Serialization/Workspace.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Serialization/WorkspaceIPWhitelistSettings.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Serialization/WorkspaceNPMRegistrySettings.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Serialization/WorkspaceOnboarding.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Serialization/WorkspaceSSOSettings.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Tooling/PluginFigmaTokens.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Tooling/PluginJSONBuilder.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Tooling/ReadTokens.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Tooling/TokensModel.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Tooling/ToolDocSearch.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Tooling/ToolMarkdownTransform.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/helpers.d.ts +7 -0
- package/build/sdk-typescript/src/tests/validators.d.ts +86 -0
- package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +56 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONConverter.d.ts +39 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONGroupBuilder.d.ts +23 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONLoader.d.ts +28 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONParser.d.ts +44 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTMapLoader.d.ts +39 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTMapResolver.d.ts +7 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTThemeMerger.d.ts +15 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenGroupTreeMerger.d.ts +23 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenMerger.d.ts +16 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenReferenceResolver.d.ts +48 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenSetResolver.d.ts +11 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/collection/SDKDTTokenCollection.d.ts +13 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/expression/SDKDTExpressionParser.d.ts +5 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTGroupTree.d.ts +12 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTGroupTreeNode.d.ts +17 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTParentChildMapping.d.ts +5 -0
- package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +409 -0
- package/build/sdk-typescript/src/tools/json-builder/SDKToolsJSONBuilder.d.ts +58 -0
- package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementFigmaTokensTransformer.d.ts +37 -0
- package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementStyleDictionaryTransformer.d.ts +26 -0
- package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementTransformer.d.ts +68 -0
- package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransform.d.ts +22 -0
- package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformBlock.d.ts +75 -0
- package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformUtil.d.ts +22 -0
- package/build/sdk-typescript/src/tools/search-index/SDKToolsDocSearch.d.ts +47 -0
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewGenerator.d.ts +20 -0
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewMetadataGenerator.d.ts +8 -0
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewReferenceInfoGenerator.d.ts +9 -0
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewSegmentGenerator.d.ts +7 -0
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewStyleGenerator.d.ts +8 -0
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewTypes.d.ts +68 -0
- package/build/sdk-typescript/src/tools/token-transform/SDKToolsTokenTransform.d.ts +42 -0
- package/build/sdk-typescript/src/utils/CommonUtils.d.ts +5 -0
- package/build/sdk-typescript/src/utils/ComponentUtils.d.ts +12 -0
- package/build/sdk-typescript/src/utils/FlowUtils.d.ts +5 -0
- package/build/sdk-typescript/src/utils/StringUtils.d.ts +72 -0
- package/build/sdk-typescript/src/utils/TokenUtils.d.ts +294 -0
- package/build/sdk-typescript/src/utils/UnreachableCaseError.d.ts +3 -0
- package/build/sdk-typescript/src/utils/deepPartial.d.ts +3 -0
- package/build/supernova-sdk-typescript.js +3 -0
- package/build/supernova-sdk-typescript.js.LICENSE.txt +8 -0
- package/build/supernova-sdk-typescript.js.map +1 -0
- package/package.json +127 -0
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** Component property - Additional non-value options */
|
|
4
|
+
export type DocsBlockComponentPropertyOptions = {
|
|
5
|
+
/** How should the tokens be rendered in editor */
|
|
6
|
+
renderLayoutAs?: "List" | "Table";
|
|
7
|
+
/** Whether to allow selecting component custom properties. True by default */
|
|
8
|
+
allowPropertySelection?: boolean;
|
|
9
|
+
};
|
|
10
|
+
/** Component property - Data */
|
|
11
|
+
export type DocsBlockComponentPropertyData = DocsBlockPropertyData<Array<{
|
|
12
|
+
entityId: string;
|
|
13
|
+
entityType: "Component" | "ComponentGroup";
|
|
14
|
+
}>> & {
|
|
15
|
+
/** Selected component ids */
|
|
16
|
+
selectedPropertyIds?: Array<string>;
|
|
17
|
+
};
|
|
18
|
+
/** Component property - Definition model */
|
|
19
|
+
export type DocsBlockComponentPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockComponentPropertyOptions;
|
|
20
|
+
/** Component property - Definition */
|
|
21
|
+
export declare class DocsBlockComponentPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockComponentPropertyOptions, DocsBlockComponentPropertyData> {
|
|
22
|
+
type: DocsBlockItemPropertyType.component;
|
|
23
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** ComponentProperty property - Additional non-value options */
|
|
4
|
+
export type DocsBlockComponentPropertyPropertyOptions = Record<string, never>;
|
|
5
|
+
/** ComponentProperty property - Data */
|
|
6
|
+
export type DocsBlockComponentPropertyPropertyData = DocsBlockPropertyData<string> & Record<string, never>;
|
|
7
|
+
/** ComponentProperty property - Definition model */
|
|
8
|
+
export type DocsBlockComponentPropertyPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockComponentPropertyPropertyOptions;
|
|
9
|
+
/** ComponentProperty property - Definition */
|
|
10
|
+
export declare class DocsBlockComponentPropertyPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockComponentPropertyPropertyOptions, DocsBlockComponentPropertyPropertyData> {
|
|
11
|
+
type: DocsBlockItemPropertyType.componentProperty;
|
|
12
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockDividerProperty.d.ts
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** Divider property - Additional non-value options */
|
|
4
|
+
export type DocsBlockDividerPropertyOptions = Record<string, never>;
|
|
5
|
+
/** Divider property - Data */
|
|
6
|
+
export type DocsBlockDividerPropertyData = DocsBlockPropertyData<never> & Record<string, never>;
|
|
7
|
+
/** Divider property - Definition model */
|
|
8
|
+
export type DocsBlockDividerPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockDividerPropertyOptions;
|
|
9
|
+
/** Divider property - Definition */
|
|
10
|
+
export declare class DocsBlockDividerPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockDividerPropertyOptions, DocsBlockDividerPropertyData> {
|
|
11
|
+
type: DocsBlockItemPropertyType.divider;
|
|
12
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** EmbedUrl property - Additional non-value options */
|
|
4
|
+
export type DocsBlockEmbedUrlPropertyOptions = {
|
|
5
|
+
/** Defines what should be the default height of the embed */
|
|
6
|
+
defaultHeight: number;
|
|
7
|
+
/** If enabled, additional text can be provided for the embed property */
|
|
8
|
+
allowCaption?: boolean;
|
|
9
|
+
/** If enabled, the embed can be resized */
|
|
10
|
+
allowResize?: boolean;
|
|
11
|
+
/** Defined how to validate the embed URL */
|
|
12
|
+
urlValidationRegex?: string;
|
|
13
|
+
};
|
|
14
|
+
/** EmbedUrl property - Data */
|
|
15
|
+
export type DocsBlockEmbedUrlPropertyData = DocsBlockPropertyData<string | undefined> & {
|
|
16
|
+
alt?: string;
|
|
17
|
+
caption?: string;
|
|
18
|
+
height?: number;
|
|
19
|
+
};
|
|
20
|
+
/** EmbedUrl property - Definition model */
|
|
21
|
+
export type DocsBlockEmbedUrlPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockEmbedUrlPropertyOptions;
|
|
22
|
+
/** EmbedUrl property - Definition */
|
|
23
|
+
export declare class DocsBlockEmbedUrlPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockEmbedUrlPropertyOptions, DocsBlockEmbedUrlPropertyData> {
|
|
24
|
+
type: DocsBlockItemPropertyType.embedURL;
|
|
25
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockFigmaNodeProperty.d.ts
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { DocsBlockContainerSize } from "../../../enums/SDKDocsBlockContainerSize";
|
|
2
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
|
+
import { DocsColorRef } from "../support/SDKDocsColorRef";
|
|
4
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
5
|
+
/** FigmaNode property - Additional non-value options */
|
|
6
|
+
export type DocsBlockFigmaNodePropertyOptions = Record<string, never>;
|
|
7
|
+
/** FigmaNode property - Data */
|
|
8
|
+
export type DocsBlockFigmaNodePropertyData = DocsBlockPropertyData<Array<{
|
|
9
|
+
entityId: string;
|
|
10
|
+
entityMeta?: {
|
|
11
|
+
title?: string;
|
|
12
|
+
description?: string;
|
|
13
|
+
backgroundColor?: DocsColorRef | null;
|
|
14
|
+
};
|
|
15
|
+
}>> & {
|
|
16
|
+
/** Behavior of container size */
|
|
17
|
+
previewContainerSize?: DocsBlockContainerSize.centered | DocsBlockContainerSize.naturalHeight;
|
|
18
|
+
/** If enabled, search is visible */
|
|
19
|
+
showSearch?: boolean;
|
|
20
|
+
/** Number of columns */
|
|
21
|
+
columns?: number;
|
|
22
|
+
/** Shows details of each frame, or hides them all */
|
|
23
|
+
showFrameDetails?: boolean;
|
|
24
|
+
};
|
|
25
|
+
/** FigmaNode property - Definition model */
|
|
26
|
+
export type DocsBlockFigmaNodePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockFigmaNodePropertyOptions;
|
|
27
|
+
/** FigmaNode property - Definition */
|
|
28
|
+
export declare class DocsBlockFigmaNodePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockFigmaNodePropertyOptions, DocsBlockFigmaNodePropertyData> {
|
|
29
|
+
type: DocsBlockItemPropertyType.figmaNode;
|
|
30
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { Alignment } from "../../../enums/SDKAlignment";
|
|
2
|
+
import { DocsBlockImagePropertyAspectRatio } from "../../../enums/SDKDocsBlockImagePropertyAspectRatio";
|
|
3
|
+
import { DocsBlockImagePropertyWidth } from "../../../enums/SDKDocsBlockImagePropertyWidth";
|
|
4
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
5
|
+
import { DocsImageRef } from "../support/SDKDocsImageRef";
|
|
6
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
|
|
7
|
+
/** Image property - Additional non-value options */
|
|
8
|
+
export type DocsBlockImagePropertyOptions = {
|
|
9
|
+
width?: DocsBlockImagePropertyWidth;
|
|
10
|
+
aspectRatio?: DocsBlockImagePropertyAspectRatio;
|
|
11
|
+
allowCaption?: boolean;
|
|
12
|
+
recommendation?: string;
|
|
13
|
+
};
|
|
14
|
+
/** Image property - Data */
|
|
15
|
+
export type DocsBlockImagePropertyData = DocsBlockPropertyData<DocsImageRef | undefined> & {
|
|
16
|
+
alt: string;
|
|
17
|
+
caption?: string;
|
|
18
|
+
alignment?: Alignment;
|
|
19
|
+
};
|
|
20
|
+
/** Image property - Definition model */
|
|
21
|
+
export type DocsBlockImagePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockImagePropertyOptions;
|
|
22
|
+
/** Image property - Definition */
|
|
23
|
+
export declare class DocsBlockImagePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockImagePropertyOptions, DocsBlockImagePropertyData> {
|
|
24
|
+
type: DocsBlockItemPropertyType.image;
|
|
25
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMarkdownProperty.d.ts
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** Markdown property - Additional non-value options */
|
|
4
|
+
export type DocsBlockMarkdownPropertyOptions = {
|
|
5
|
+
/** Defines how to validate the markdown URL */
|
|
6
|
+
urlValidationRegex?: string;
|
|
7
|
+
};
|
|
8
|
+
/** Markdown property - Data */
|
|
9
|
+
export type DocsBlockMarkdownPropertyData = DocsBlockPropertyData<string> & Record<string, never>;
|
|
10
|
+
/** Markdown property - Definition model */
|
|
11
|
+
export type DocsBlockMarkdownPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockMarkdownPropertyOptions;
|
|
12
|
+
/** Markdown property - Definition */
|
|
13
|
+
export declare class DocsBlockMarkdownPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockMarkdownPropertyOptions, DocsBlockMarkdownPropertyData> {
|
|
14
|
+
type: DocsBlockItemPropertyType.markdown;
|
|
15
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty.d.ts
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { DocumentationLegacyRichTextModel } from "../../../documentation/SDKDocumentationLegacyRichText";
|
|
2
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
|
+
import { DocsBlockMultiRichTextPropertyStyle } from "../../../enums/SDKDocsBlockMultiRichTextPropertyStyle";
|
|
4
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
5
|
+
/** RichText property - Additional non-value options */
|
|
6
|
+
export type DocsBlockMultiRichTextPropertyOptions = {
|
|
7
|
+
/** Placeholder to show when rich text area is empty */
|
|
8
|
+
placeholder?: string;
|
|
9
|
+
/** Visual style of the rich text property */
|
|
10
|
+
multiRichTextStyle?: DocsBlockMultiRichTextPropertyStyle;
|
|
11
|
+
};
|
|
12
|
+
/** RichText property - Data */
|
|
13
|
+
export type DocsBlockMultiRichTextPropertyData = DocsBlockPropertyData<Array<DocumentationLegacyRichTextModel>>;
|
|
14
|
+
/** RichText property - Definition model */
|
|
15
|
+
export type DocsBlockRichTextPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockMultiRichTextPropertyOptions;
|
|
16
|
+
/** RichText property - Definition */
|
|
17
|
+
export declare class DocsBlockMultiRichTextPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockMultiRichTextPropertyOptions, DocsBlockMultiRichTextPropertyData> {
|
|
18
|
+
type: DocsBlockItemPropertyType.multiRichText;
|
|
19
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty.d.ts
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockOptionRenderingStyle } from "../../../enums/SDKDocsBlockOptionRenderStyle";
|
|
3
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
|
+
/** MultiSelect property - Additional non-value options */
|
|
5
|
+
export type DocsBlockMultiSelectPropertyOptions = {
|
|
6
|
+
defaultChoices: Array<string>;
|
|
7
|
+
choices: Array<{
|
|
8
|
+
value: string;
|
|
9
|
+
name: string;
|
|
10
|
+
icon?: string;
|
|
11
|
+
}>;
|
|
12
|
+
multiSelectStyle?: Exclude<DocsBlockOptionRenderingStyle, DocsBlockOptionRenderingStyle.toggleButton>;
|
|
13
|
+
};
|
|
14
|
+
/** MultiSelect property - Data */
|
|
15
|
+
export type DocsBlockMultiSelectPropertyData = DocsBlockPropertyData<Array<string>> & Record<string, never>;
|
|
16
|
+
/** MultiSelect property - Definition model */
|
|
17
|
+
export type DocsBlockMultiSelectPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockMultiSelectPropertyOptions;
|
|
18
|
+
/** MultiSelect property - Definition */
|
|
19
|
+
export declare class DocsBlockMultiSelectPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockMultiSelectPropertyOptions, DocsBlockMultiSelectPropertyData> {
|
|
20
|
+
type: DocsBlockItemPropertyType.multiSelect;
|
|
21
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** Number property - Additional non-value options */
|
|
4
|
+
export type DocsBlockNumberPropertyOptions = {
|
|
5
|
+
/** Default value to set when block is created */
|
|
6
|
+
defaultValue: number;
|
|
7
|
+
/** Minimum value */
|
|
8
|
+
min?: number;
|
|
9
|
+
/** Maximum value */
|
|
10
|
+
max?: number;
|
|
11
|
+
/** Step value */
|
|
12
|
+
step?: number;
|
|
13
|
+
/** Field placeholder */
|
|
14
|
+
placeholder?: string;
|
|
15
|
+
};
|
|
16
|
+
/** Number property - Data */
|
|
17
|
+
export type DocsBlockNumberPropertyData = DocsBlockPropertyData<number> & Record<string, never>;
|
|
18
|
+
/** Number property - Definition model */
|
|
19
|
+
export type DocsBlockNumberPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockNumberPropertyOptions;
|
|
20
|
+
/** Number property - Definition */
|
|
21
|
+
export declare class DocsBlockNumberPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockNumberPropertyOptions, DocsBlockNumberPropertyData> {
|
|
22
|
+
type: DocsBlockItemPropertyType.number;
|
|
23
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { PageBlockDefinitionProperty } from "@supernova-studio/model";
|
|
2
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
|
+
export type DocsBlockPropertyDefinitionModel = PageBlockDefinitionProperty;
|
|
4
|
+
export type DocsBlockPropertyData<T> = {
|
|
5
|
+
value: T;
|
|
6
|
+
};
|
|
7
|
+
/** Generic property definition for when we don't care about specific types in options, just want to use the property high-level data */
|
|
8
|
+
export type DocsBlockItemPropertyAnyDefinition = DocsBlockPropertyDefinition<any, DocsBlockPropertyData<any>>;
|
|
9
|
+
export declare class DocsBlockPropertyDefinition<T extends object, D extends DocsBlockPropertyData<any>> {
|
|
10
|
+
/** Property id, validated to be unique within a block, but not necessarily unique across all blocks */
|
|
11
|
+
id: string;
|
|
12
|
+
/** Human readable name that will show in the editor */
|
|
13
|
+
name: string;
|
|
14
|
+
/** Property type. There are many different types of properties, explained later */
|
|
15
|
+
type: DocsBlockItemPropertyType;
|
|
16
|
+
/** Human readable description that will show next to the property */
|
|
17
|
+
description: string | null;
|
|
18
|
+
/** Options specific to this property type */
|
|
19
|
+
options: T | null;
|
|
20
|
+
/**
|
|
21
|
+
* Overrides of options for different variants.
|
|
22
|
+
* Key/s must be set as id of the variant for override to go into effect.
|
|
23
|
+
* Options are resolved as variantOptions[key] > options > default for any variant.
|
|
24
|
+
* It is possible to override only a subset of options, in which case combination of default option settings and the override goes into effect */
|
|
25
|
+
variantOptions: {
|
|
26
|
+
[key: string]: T;
|
|
27
|
+
} | null;
|
|
28
|
+
constructor(model: DocsBlockPropertyDefinitionModel);
|
|
29
|
+
defaultData(): D;
|
|
30
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { DocumentationLegacyRichTextModel } from "../../../documentation/SDKDocumentationLegacyRichText";
|
|
2
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
|
+
import { DocsBlockRichTextPropertyStyle } from "../../../enums/SDKDocsBlockRichTextPropertyStyle";
|
|
4
|
+
import { DocumentationLegacyCalloutType } from "../../../enums/SDKDocumentationLegacyCalloutType";
|
|
5
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
6
|
+
/** RichText property - Additional non-value options */
|
|
7
|
+
export type DocsBlockRichTextPropertyOptions = {
|
|
8
|
+
/** Placeholder to show when rich text area is empty */
|
|
9
|
+
placeholder?: string;
|
|
10
|
+
/** Visual style of the rich text property */
|
|
11
|
+
richTextStyle?: DocsBlockRichTextPropertyStyle;
|
|
12
|
+
};
|
|
13
|
+
/** RichText property - Data */
|
|
14
|
+
export type DocsBlockRichTextPropertyData = DocsBlockPropertyData<DocumentationLegacyRichTextModel> & {
|
|
15
|
+
/** Selected token ids */
|
|
16
|
+
calloutType?: DocumentationLegacyCalloutType;
|
|
17
|
+
};
|
|
18
|
+
/** RichText property - Definition model */
|
|
19
|
+
export type DocsBlockRichTextPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockRichTextPropertyOptions;
|
|
20
|
+
/** RichText property - Definition */
|
|
21
|
+
export declare class DocsBlockRichTextPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockRichTextPropertyOptions, DocsBlockRichTextPropertyData> {
|
|
22
|
+
type: DocsBlockItemPropertyType.richText;
|
|
23
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockOptionRenderingStyle } from "../../../enums/SDKDocsBlockOptionRenderStyle";
|
|
3
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
|
+
/** SingleSelect property - Additional non-value options */
|
|
5
|
+
export type DocsBlockSingleSelectPropertyOptions = {
|
|
6
|
+
/** Default choices to set when block is created */
|
|
7
|
+
defaultChoice: string;
|
|
8
|
+
/** List of choices to choose from */
|
|
9
|
+
choices: Array<{
|
|
10
|
+
/** Option value / id */
|
|
11
|
+
value: string;
|
|
12
|
+
/** Option name */
|
|
13
|
+
name: string;
|
|
14
|
+
/** Option icon filename */
|
|
15
|
+
icon?: string;
|
|
16
|
+
}>;
|
|
17
|
+
/** Visual representation of the property */
|
|
18
|
+
singleSelectStyle?: DocsBlockOptionRenderingStyle;
|
|
19
|
+
};
|
|
20
|
+
/** SingleSelect property - Data */
|
|
21
|
+
export type DocsBlockSingleSelectPropertyData = DocsBlockPropertyData<string> & Record<string, never>;
|
|
22
|
+
/** SingleSelect property - Definition model */
|
|
23
|
+
export type DocsBlockSingleSelectPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockSingleSelectPropertyOptions;
|
|
24
|
+
/** SingleSelect property - Definition */
|
|
25
|
+
export declare class DocsBlockSingleSelectPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockSingleSelectPropertyOptions, DocsBlockSingleSelectPropertyData> {
|
|
26
|
+
type: DocsBlockItemPropertyType.singleSelect;
|
|
27
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
|
|
2
|
+
/** Storybook property - Additional non-value options */
|
|
3
|
+
export type DocsBlockStorybookPropertyOptions = {
|
|
4
|
+
/** Defines what should be the default height of the embed */
|
|
5
|
+
defaultHeight: number;
|
|
6
|
+
/** If enabled, additional text can be provided for the embed property */
|
|
7
|
+
allowCaption?: boolean;
|
|
8
|
+
/** If enabled, the embed can be resized */
|
|
9
|
+
allowResize?: boolean;
|
|
10
|
+
/** Defined how to validate the embed URL */
|
|
11
|
+
urlValidationRegex?: string;
|
|
12
|
+
};
|
|
13
|
+
/** Storybook property - Data */
|
|
14
|
+
export type DocsBlockStorybookPropertyData = DocsBlockPropertyData<string | undefined> & {
|
|
15
|
+
alt?: string;
|
|
16
|
+
caption?: string;
|
|
17
|
+
height?: number;
|
|
18
|
+
embedUrl?: string;
|
|
19
|
+
};
|
|
20
|
+
/** Storybook property - Definition model */
|
|
21
|
+
export type DocsBlockStorybookPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockStorybookPropertyOptions;
|
|
22
|
+
/** Storybook property - Definition */
|
|
23
|
+
export declare class DocsBlockStorybookPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockStorybookPropertyOptions, DocsBlockStorybookPropertyData> {
|
|
24
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { DocumentationLegacyRichTextModel } from "../../../documentation/SDKDocumentationLegacyRichText";
|
|
2
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
|
+
import { DocsImageRef } from "../support/SDKDocsImageRef";
|
|
4
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
|
|
5
|
+
/** Table property - Additional non-value options */
|
|
6
|
+
export type DocsBlockTablePropertyOptions = Record<string, never>;
|
|
7
|
+
export type DocsBlockTableRichTextNode = {
|
|
8
|
+
type: "RichText";
|
|
9
|
+
value: DocumentationLegacyRichTextModel;
|
|
10
|
+
};
|
|
11
|
+
export type DocsBlockTableImageNode = {
|
|
12
|
+
type: "Image";
|
|
13
|
+
value: DocsImageRef;
|
|
14
|
+
};
|
|
15
|
+
export type DocsBlockTableMultiRichTextNode = {
|
|
16
|
+
type: "MultiRichText";
|
|
17
|
+
value: Array<DocumentationLegacyRichTextModel>;
|
|
18
|
+
};
|
|
19
|
+
export type DocsBlockTableNode = DocsBlockTableRichTextNode | DocsBlockTableImageNode | DocsBlockTableMultiRichTextNode;
|
|
20
|
+
/** Table property - Data */
|
|
21
|
+
export type DocsBlockTablePropertyData = DocsBlockPropertyData<Array<{
|
|
22
|
+
cells: {
|
|
23
|
+
id: string;
|
|
24
|
+
alignment: "Left" | "Center" | "Right";
|
|
25
|
+
columnWidth: number;
|
|
26
|
+
nodes: Array<DocsBlockTableNode>;
|
|
27
|
+
}[];
|
|
28
|
+
}>> & {
|
|
29
|
+
highlightHeaderColumn?: boolean;
|
|
30
|
+
highlightHeaderRow?: boolean;
|
|
31
|
+
showBorder?: boolean;
|
|
32
|
+
};
|
|
33
|
+
/** Table property - Definition model */
|
|
34
|
+
export type DocsBlockTablePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockTablePropertyOptions;
|
|
35
|
+
/** Table property - Definition */
|
|
36
|
+
export declare class DocsBlockTablePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTablePropertyOptions, DocsBlockTablePropertyData> {
|
|
37
|
+
type: DocsBlockItemPropertyType.table;
|
|
38
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockTextPropertyColor } from "../../../enums/SDKDocsBlockTextPropertyColor";
|
|
3
|
+
import { DocsBlockTextPropertyStyle } from "../../../enums/SDKDocsBlockTextPropertyStyle";
|
|
4
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
5
|
+
/** Text property - Additional non-value options */
|
|
6
|
+
export type DocsBlockTextPropertyOptions = {
|
|
7
|
+
/** Field placeholder */
|
|
8
|
+
placeholder?: string;
|
|
9
|
+
/** Default value to set when block is created */
|
|
10
|
+
defaultValue?: string;
|
|
11
|
+
/** Visual style of the text property */
|
|
12
|
+
textStyle?: DocsBlockTextPropertyStyle;
|
|
13
|
+
/** Text color */
|
|
14
|
+
color?: DocsBlockTextPropertyColor;
|
|
15
|
+
};
|
|
16
|
+
/** Text property - Data */
|
|
17
|
+
export type DocsBlockTextPropertyData = DocsBlockPropertyData<string> & Record<string, never>;
|
|
18
|
+
/** Text property - Definition model */
|
|
19
|
+
export type DocsBlockTextPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockTextPropertyOptions;
|
|
20
|
+
/** Text property - Definition */
|
|
21
|
+
export declare class DocsBlockTextPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTextPropertyOptions, DocsBlockTextPropertyData> {
|
|
22
|
+
type: DocsBlockItemPropertyType.text;
|
|
23
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { TokenType } from "../../../enums/SDKTokenType";
|
|
3
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
|
+
/** Token property - Additional non-value options */
|
|
5
|
+
export type DocsBlockTokenPropertyOptions = {
|
|
6
|
+
/** Default theme to be chosen */
|
|
7
|
+
defaultTheme?: "none";
|
|
8
|
+
/** Default value preview */
|
|
9
|
+
defaultValuePreview?: "Split" | "Override";
|
|
10
|
+
/** Token types that are allowed to be selected. All types allowed if nothing is provided */
|
|
11
|
+
allowedTypes?: Array<TokenType>;
|
|
12
|
+
/** How should the tokens be rendered in editor */
|
|
13
|
+
renderLayoutAs?: "Grid" | "List";
|
|
14
|
+
/** Whether to allow selecting token custom properties. True by default */
|
|
15
|
+
allowPropertySelection?: boolean;
|
|
16
|
+
/** Whether to allow selecting themes. True by default */
|
|
17
|
+
allowThemeSelection?: boolean;
|
|
18
|
+
};
|
|
19
|
+
/** Token property - Data */
|
|
20
|
+
export type DocsBlockTokenPropertyData = DocsBlockPropertyData<Array<{
|
|
21
|
+
entityId: string;
|
|
22
|
+
entityType: "Token" | "TokenGroup";
|
|
23
|
+
}>> & {
|
|
24
|
+
/** Selected token ids */
|
|
25
|
+
selectedPropertyIds?: Array<string>;
|
|
26
|
+
/** Selected theme ids */
|
|
27
|
+
selectedThemeIds?: Array<string>;
|
|
28
|
+
/** Display mode of themes associated with the token property */
|
|
29
|
+
themeDisplayMode?: "Split" | "Override";
|
|
30
|
+
};
|
|
31
|
+
/** Token property - Definition model */
|
|
32
|
+
export type DocsBlockTokenPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockTokenPropertyOptions;
|
|
33
|
+
/** Token property - Definition */
|
|
34
|
+
export declare class DocsBlockTokenPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTokenPropertyOptions, DocsBlockTokenPropertyData> {
|
|
35
|
+
type: DocsBlockItemPropertyType.token;
|
|
36
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenPropertyProperty.d.ts
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** TokenProperty property - Additional non-value options */
|
|
4
|
+
export type DocsBlockTokenPropertyPropertyOptions = Record<string, never>;
|
|
5
|
+
/** TokenProperty property - Data */
|
|
6
|
+
export type DocsBlockTokenPropertyPropertyData = DocsBlockPropertyData<Array<string>> & Record<string, never>;
|
|
7
|
+
/** TokenProperty property - Definition model */
|
|
8
|
+
export type DocsBlockTokenPropertyPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockTokenPropertyPropertyOptions;
|
|
9
|
+
/** TokenProperty property - Definition */
|
|
10
|
+
export declare class DocsBlockTokenPropertyPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTokenPropertyPropertyOptions, DocsBlockTokenPropertyPropertyData> {
|
|
11
|
+
type: DocsBlockItemPropertyType.tokenProperty;
|
|
12
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty.d.ts
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { TokenType } from "../../../enums/SDKTokenType";
|
|
3
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
|
+
/** TokenType property - Additional non-value options */
|
|
5
|
+
export type DocsBlockTokenTypePropertyOptions = {
|
|
6
|
+
allowMultiSelect?: boolean;
|
|
7
|
+
};
|
|
8
|
+
/** TokenType property - Data */
|
|
9
|
+
export type DocsBlockTokenTypePropertyData = DocsBlockPropertyData<Array<TokenType>> & Record<string, never>;
|
|
10
|
+
/** TokenType property - Definition model */
|
|
11
|
+
export type DocsBlockTokenTypePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockTokenTypePropertyOptions;
|
|
12
|
+
/** TokenType property - Definition */
|
|
13
|
+
export declare class DocsBlockTokenTypePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTokenTypePropertyOptions, DocsBlockTokenTypePropertyData> {
|
|
14
|
+
type: DocsBlockItemPropertyType.tokenType;
|
|
15
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** Url property - Additional non-value options */
|
|
4
|
+
export type DocsBlockUrlPropertyOptions = {
|
|
5
|
+
urlValidationRegex?: string;
|
|
6
|
+
};
|
|
7
|
+
/** Url property - Data */
|
|
8
|
+
export type DocsBlockUrlPropertyData = DocsBlockPropertyData<string> & Record<string, never>;
|
|
9
|
+
/** Url property - Definition model */
|
|
10
|
+
export type DocsBlockUrlPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockUrlPropertyOptions;
|
|
11
|
+
/** Url property - Definition */
|
|
12
|
+
export declare class DocsBlockUrlPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockUrlPropertyOptions, DocsBlockUrlPropertyData> {
|
|
13
|
+
type: DocsBlockItemPropertyType.embedURL;
|
|
14
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { Supernova } from "../../../../exports";
|
|
2
|
+
/** An image data container */
|
|
3
|
+
export type DocsImageRef = {
|
|
4
|
+
/** Ref type */
|
|
5
|
+
type: DocsImageRefType;
|
|
6
|
+
/** Referenced resource, if any */
|
|
7
|
+
resource?: {
|
|
8
|
+
/** Absolute, directly consumable URL */
|
|
9
|
+
url: string;
|
|
10
|
+
/** Referenced resource, if any */
|
|
11
|
+
resourceId: string;
|
|
12
|
+
};
|
|
13
|
+
/** Referenced Figma file, if any */
|
|
14
|
+
figmaNode?: {
|
|
15
|
+
sourceId: string;
|
|
16
|
+
frameReferenceId: string;
|
|
17
|
+
};
|
|
18
|
+
};
|
|
19
|
+
export declare enum DocsImageRefType {
|
|
20
|
+
resource = "Resource",
|
|
21
|
+
figmaNode = "FigmaNode"
|
|
22
|
+
}
|
|
23
|
+
export declare function docsImageRefToUrl(image: DocsImageRef | undefined, sdk: Supernova, from: {
|
|
24
|
+
dsId: string;
|
|
25
|
+
versionId: string;
|
|
26
|
+
}): string | undefined;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/** A link data container */
|
|
2
|
+
export type DocsLinkRef = {
|
|
3
|
+
/** Ref type */
|
|
4
|
+
type: DocsLinkRefType;
|
|
5
|
+
/** Referenced page */
|
|
6
|
+
documentationItemId?: string;
|
|
7
|
+
/** Referenced page block - heading */
|
|
8
|
+
pageHeadingId?: string;
|
|
9
|
+
/** Referenced URL */
|
|
10
|
+
url?: string;
|
|
11
|
+
/** Open in other tab */
|
|
12
|
+
openInNewTab?: boolean;
|
|
13
|
+
};
|
|
14
|
+
export declare enum DocsLinkRefType {
|
|
15
|
+
documentationItem = "DocumentationItem",
|
|
16
|
+
pageHeading = "PageHeading",
|
|
17
|
+
url = "Url"
|
|
18
|
+
}
|
|
19
|
+
export declare function docsLinkToUrl(link: DocsLinkRef): string | undefined;
|
|
20
|
+
export declare function docsLinkToLinkAttributes(link: DocsLinkRef): {
|
|
21
|
+
href: string;
|
|
22
|
+
target: string;
|
|
23
|
+
} | undefined;
|
|
24
|
+
export declare function linkAttributeToDocsLink(href: string | null | undefined, target: string | null | undefined): DocsLinkRef | undefined;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { SizeTokenValue } from "../../../tokens/SDKTokenValue";
|
|
2
|
+
/** A size data container */
|
|
3
|
+
export type DocsSizeRef = {
|
|
4
|
+
/** Width value - either token reference or raw value */
|
|
5
|
+
width?: SizeTokenValue;
|
|
6
|
+
/** Height value - either token reference or raw value */
|
|
7
|
+
height?: SizeTokenValue;
|
|
8
|
+
};
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { PageBlockEditorModel } from "@supernova-studio/client";
|
|
2
|
+
import { DocsColorRef } from "../support/SDKDocsColorRef";
|
|
3
|
+
import { DocsLinkRef } from "../support/SDKDocsLinkRef";
|
|
4
|
+
import { DocsBlockItem } from "./SDKDocsBlockItem";
|
|
5
|
+
export type DocsBlockModel = PageBlockEditorModel;
|
|
6
|
+
export declare class DocsBlock {
|
|
7
|
+
/** Unique identifier of the block */
|
|
8
|
+
id: string;
|
|
9
|
+
/** Unique identifier of the block package */
|
|
10
|
+
packageId: string;
|
|
11
|
+
/** Unique identifier of the selected variant */
|
|
12
|
+
variantId: string | null;
|
|
13
|
+
/** Indentation of the block in levels (0, 1, 2), not pixels */
|
|
14
|
+
indentLevel: number;
|
|
15
|
+
/** Block appearance - Properties that are natively available for all blocks, such as background color */
|
|
16
|
+
appearance: {
|
|
17
|
+
/** Background color of all items of the block. Can be further overriden on every item */
|
|
18
|
+
itemBackgroundColor: DocsColorRef | null;
|
|
19
|
+
/** Number of columns */
|
|
20
|
+
numberOfColumns?: number;
|
|
21
|
+
};
|
|
22
|
+
/** Data of all items of the block */
|
|
23
|
+
data: Array<DocsBlockItem>;
|
|
24
|
+
constructor(model: DocsBlockModel);
|
|
25
|
+
/** Returns stored data of all properties. This will retrieve properties for item on the first position, ideal for single-item blocks */
|
|
26
|
+
allPropertyDataForSingleItem(): Record<string, object> | null;
|
|
27
|
+
/** Returns stored data of all properties. This will retrieve properties for item at any position */
|
|
28
|
+
allPropertyDataForItemAtIndex(index: number): Record<string, object> | null;
|
|
29
|
+
/** Returns stored data of a single property. This will retrieve property for item on the first position, ideal for single-item blocks */
|
|
30
|
+
propertyDataForSingleItem<T extends object>(propertyId: string): T | null;
|
|
31
|
+
/** Returns stored data of a single property. This will retrieve property for item at any position */
|
|
32
|
+
propertyDataForItemAtIndex<T extends object>(index: number, propertyId: string): T | null;
|
|
33
|
+
/** Returns stored link, if any. This will retrieve link for item on the first position, ideal for single-item blocks */
|
|
34
|
+
linkForSingleItem(): DocsLinkRef | null;
|
|
35
|
+
/** Returns stored link, if any. This will retrieve link for item at any position */
|
|
36
|
+
linkForItemAtIndex(index: number): DocsLinkRef | null;
|
|
37
|
+
/** Update data for property of specific key and index */
|
|
38
|
+
updatePropertyDataForItemAtIndex<T extends object>(index: number, propertyId: string, data: T): void;
|
|
39
|
+
/** Update data for property of specific key and index */
|
|
40
|
+
updatePropertyDataForSingleItem<T extends object>(propertyId: string, data: T): void;
|
|
41
|
+
/** Update link for item at specific index */
|
|
42
|
+
updateLinkForItemAtIndex(index: number, link: DocsLinkRef | undefined): void;
|
|
43
|
+
/** Update link for item at specific index */
|
|
44
|
+
updateLinkForSingleItem(link: DocsLinkRef | undefined): void;
|
|
45
|
+
/** Constructs representation that can be used to write full object to remote */
|
|
46
|
+
toRemote(): PageBlockEditorModel;
|
|
47
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { PageBlockItemV2 } from "@supernova-studio/model";
|
|
2
|
+
import { DocsLinkRef } from "../support/SDKDocsLinkRef";
|
|
3
|
+
export type DocsBlockItemModel = PageBlockItemV2;
|
|
4
|
+
export declare class DocsBlockItem {
|
|
5
|
+
/** Unique identifier of the block item */
|
|
6
|
+
id: string;
|
|
7
|
+
/** Dynamic key coming from property.id block definition */
|
|
8
|
+
props: {
|
|
9
|
+
[key: string]: object;
|
|
10
|
+
};
|
|
11
|
+
/** Link where the item points to, if any. Must be enabled in behaviors */
|
|
12
|
+
linksTo: DocsLinkRef | undefined;
|
|
13
|
+
constructor(model: DocsBlockItemModel);
|
|
14
|
+
/** Constructs representation that can be used to write full object to remote */
|
|
15
|
+
toRemote(): DocsBlockItemModel;
|
|
16
|
+
}
|