@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
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
import { Component } from "../../model/components/SDKComponent";
|
|
2
|
+
import { DesignComponent } from "../../model/components/SDKDesignComponent";
|
|
3
|
+
import { ElementDataView } from "../../model/elements/SDKElementDataView";
|
|
4
|
+
import { ElementDataViewColumn } from "../../model/elements/SDKElementDataViewColumn";
|
|
5
|
+
import { ElementProperty, ElementPropertyCreationModel, ElementPropertyUpdateModel } from "../../model/elements/SDKElementProperty";
|
|
6
|
+
import { ElementPropertyValue } from "../../model/elements/values/SDKElementPropertyValue";
|
|
7
|
+
import { ComponentGroup } from "../../model/groups/SDKComponentGroup";
|
|
8
|
+
import { DesignComponentGroup } from "../../model/groups/SDKDesignComponentGroup";
|
|
9
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
10
|
+
import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
11
|
+
export declare class AreaComponents {
|
|
12
|
+
/** Internal: Engine */
|
|
13
|
+
private dataCore;
|
|
14
|
+
constructor(dataCore: DataCore);
|
|
15
|
+
/** Fetches all remote components in the version
|
|
16
|
+
* @param from - Remote version to fetch from
|
|
17
|
+
* @returns All components in the specified version
|
|
18
|
+
*/
|
|
19
|
+
getComponents(from: RemoteVersionIdentifier, filter?: {
|
|
20
|
+
brandId?: string;
|
|
21
|
+
}): Promise<Array<Component>>;
|
|
22
|
+
/** Fetches all remote component groups in the version
|
|
23
|
+
* @param from - Remote version to fetch from
|
|
24
|
+
* @returns All component groups in the specified version
|
|
25
|
+
*/
|
|
26
|
+
getComponentGroups(from: RemoteVersionIdentifier): Promise<Array<ComponentGroup>>;
|
|
27
|
+
/** Fetches all remote design components in the version
|
|
28
|
+
* @param from - Remote version to fetch from
|
|
29
|
+
* @returns All design components in the specified version
|
|
30
|
+
*/
|
|
31
|
+
getDesignComponents(from: RemoteVersionIdentifier, filter?: {
|
|
32
|
+
brandId?: string;
|
|
33
|
+
}): Promise<Array<DesignComponent>>;
|
|
34
|
+
/** Fetches all remote design component groups in the version
|
|
35
|
+
* @param from - Remote version to fetch from
|
|
36
|
+
* @param filter - Optional filter
|
|
37
|
+
* @returns All design component groups in the specified version
|
|
38
|
+
*/
|
|
39
|
+
getDesignComponentGroups(from: RemoteVersionIdentifier, filter?: {
|
|
40
|
+
brandId?: string;
|
|
41
|
+
}): Promise<Array<DesignComponentGroup>>;
|
|
42
|
+
/** Retrieves all remote properties for components
|
|
43
|
+
* @param from - Remote version to fetch from
|
|
44
|
+
* @returns All component properties in the specified version
|
|
45
|
+
*/
|
|
46
|
+
getComponentProperties(from: RemoteVersionIdentifier): Promise<Array<ElementProperty>>;
|
|
47
|
+
/** Retrieves all remote property definitions for components
|
|
48
|
+
* @param from - Remote version to fetch from
|
|
49
|
+
* @returns All property definitions in the specified version
|
|
50
|
+
*/
|
|
51
|
+
getComponentPropertyValues(from: RemoteVersionIdentifier): Promise<Array<ElementPropertyValue>>;
|
|
52
|
+
/** Retrieves all remote property views for components
|
|
53
|
+
* @param from - Remote version to fetch from
|
|
54
|
+
* @returns All component views in the specified version
|
|
55
|
+
*/
|
|
56
|
+
getComponentDataViews(from: RemoteVersionIdentifier): Promise<Array<ElementDataView>>;
|
|
57
|
+
/** Creates remote component. This method can only be used once per component and will assign persistent id to the component. Calling this version on component that already has id assigned will result in error
|
|
58
|
+
* @param to - Remote version to write to
|
|
59
|
+
* @param component - Component to create
|
|
60
|
+
* @param parentId - Id of the group to add the component to. This is id of the group, not the versioned id
|
|
61
|
+
* @returns New remote component ids
|
|
62
|
+
*/
|
|
63
|
+
createComponent(to: RemoteVersionIdentifier, component: Component): Promise<{
|
|
64
|
+
id: string;
|
|
65
|
+
idInVersion: string;
|
|
66
|
+
}>;
|
|
67
|
+
/** Creates local component. This component doesn't have id associated with it on remote, and must be created once with `createComponent` to be stored in design system
|
|
68
|
+
* @returns New component filled with default values not associated with remote (yet)
|
|
69
|
+
*/
|
|
70
|
+
createLocalComponent(versionId: string, brandId: string): Component;
|
|
71
|
+
/** Creates remote component group. This method can only be used once per group and will assign persistent id to the group. Calling this version on group that already has id assigned will result in error
|
|
72
|
+
* @param to - Remote version to write to
|
|
73
|
+
* @param group - Group to create
|
|
74
|
+
* @param parentId - Id of the group to add the group to. This is id of the group, not the versioned id
|
|
75
|
+
* @returns New remote component group ids
|
|
76
|
+
*/
|
|
77
|
+
createComponentGroup(to: RemoteVersionIdentifier, group: ComponentGroup): Promise<{
|
|
78
|
+
id: string;
|
|
79
|
+
idInVersion: string;
|
|
80
|
+
}>;
|
|
81
|
+
/** Creates local component group. This group doesn't have id associated with it on remote, and must be created once with `createComponentGroup` to be stored in design system
|
|
82
|
+
* @param versionId - Id of the version to create the group in
|
|
83
|
+
* @param brandId - Id of the brand to create the group in
|
|
84
|
+
* @returns New group with id assigned
|
|
85
|
+
*/
|
|
86
|
+
createLocalComponentGroup(versionId: string, brandId: string): ComponentGroup;
|
|
87
|
+
/** Updates remote component. This method can only be used on components that already exist in the version
|
|
88
|
+
* @param to - Remote version to write to
|
|
89
|
+
* @param component - Component to update
|
|
90
|
+
* @returns Nothing
|
|
91
|
+
*/
|
|
92
|
+
updateComponent(to: RemoteVersionIdentifier, component: Component): Promise<void>;
|
|
93
|
+
/** Updates remote component groups. This method can only be used on component groups that already exist in the version
|
|
94
|
+
* @param to - Remote version to write to
|
|
95
|
+
* @param component - Component group to update
|
|
96
|
+
* @returns Nothing
|
|
97
|
+
*/
|
|
98
|
+
updateComponentGroup(to: RemoteVersionIdentifier, group: ComponentGroup): Promise<void>;
|
|
99
|
+
/** Updates remote component property value. This also creates the property value if it doesn't exist
|
|
100
|
+
* @param to - Remote version to write to
|
|
101
|
+
* @param newValue - Value to set - this can be multiple things, from ID to raw string value to others
|
|
102
|
+
* @param forComponent - Component to assign the value to
|
|
103
|
+
* @param forProperty - Property to assign the value to
|
|
104
|
+
*/
|
|
105
|
+
updateComponentPropertyValue(to: RemoteVersionIdentifier, newValue: string, forComponent: Component, forProperty: ElementProperty): Promise<void>;
|
|
106
|
+
/** Deletes remote component property value
|
|
107
|
+
* @param to - Remote version to write to
|
|
108
|
+
* @param valueId - Value identifier
|
|
109
|
+
*/
|
|
110
|
+
deleteComponentPropertyValue(to: RemoteVersionIdentifier, valueId: string): Promise<void>;
|
|
111
|
+
/** Create component property
|
|
112
|
+
* @param to - Remote version to write to
|
|
113
|
+
* @param model - Property creation model to create the property from
|
|
114
|
+
*/
|
|
115
|
+
createComponentProperty(to: RemoteVersionIdentifier, model: ElementPropertyCreationModel): Promise<{
|
|
116
|
+
id: string;
|
|
117
|
+
idInVersion: string;
|
|
118
|
+
}>;
|
|
119
|
+
/** Update component property
|
|
120
|
+
* @param to - Remote version to write to
|
|
121
|
+
* @param propertyIdInVersion - Remote element property to update
|
|
122
|
+
* @param model - Property update model to apply to property
|
|
123
|
+
*/
|
|
124
|
+
updateComponentProperty(to: RemoteVersionIdentifier, propertyIdInVersion: string, model: ElementPropertyUpdateModel): Promise<void>;
|
|
125
|
+
/** Delete component property. This will remove all values associated with the property
|
|
126
|
+
* @param to - Remote version to write to
|
|
127
|
+
* @param propertyIdInVersion - Id of the property to delete
|
|
128
|
+
*/
|
|
129
|
+
deleteComponentProperty(to: RemoteVersionIdentifier, propertyIdInVersion: string): Promise<void>;
|
|
130
|
+
/** Resize specific component column
|
|
131
|
+
* @param to - Remote version to write to
|
|
132
|
+
* @param columnIdInVersion - Id of the column to update
|
|
133
|
+
* @param newWidth - New width of the column
|
|
134
|
+
*/
|
|
135
|
+
updateResizeComponentColumn(to: RemoteVersionIdentifier, view: ElementDataView, column: ElementDataViewColumn, newWidth: number): Promise<void>;
|
|
136
|
+
/** Move column to a new index and reorder all other columns around it
|
|
137
|
+
* @param to - Remote version to write to
|
|
138
|
+
* @param colum - Column object to move
|
|
139
|
+
* @param newIndex - New index to move the component to
|
|
140
|
+
*/
|
|
141
|
+
updateReorderComponentColumn(to: RemoteVersionIdentifier, view: ElementDataView, column: ElementDataViewColumn, newIndex: number): Promise<void>;
|
|
142
|
+
/** Deletes remote component. Calling this method on component that doesn't exist in the version will result in error
|
|
143
|
+
* @param to - Remote version to write to
|
|
144
|
+
* @param componentIdInVersion - Component idInVersion to delete
|
|
145
|
+
* @returns Nothing
|
|
146
|
+
*/
|
|
147
|
+
deleteComponent(to: RemoteVersionIdentifier, componentIdInVersion: string): Promise<void>;
|
|
148
|
+
/** Deletes remote component group. This method will also fix the component group tree by moving any subgroups to parent - do note it will NOT delete contents of the group. Calling this method on group that doesn't exist in the version will result in error
|
|
149
|
+
* @param to - Remote version to write to
|
|
150
|
+
* @param componentGroupIdInVersion - Component group idInVersion to delete
|
|
151
|
+
* @returns Nothing
|
|
152
|
+
*/
|
|
153
|
+
ungroupComponentGroup(to: RemoteVersionIdentifier, componentGroupIdInVersion: string): Promise<void>;
|
|
154
|
+
/** Deletes remote component group and all its descendants. All items (groups and components) underneath will be deleted. Calling this method on group that doesn't exist in the version will result in error
|
|
155
|
+
* @param to - Remote version to write to
|
|
156
|
+
* @param componentGroupToDelete - Component group to delete
|
|
157
|
+
* @param allComponents - Components for lookup
|
|
158
|
+
* @param allComponentGroup - Component group for lookup
|
|
159
|
+
* @returns Nothing
|
|
160
|
+
*/
|
|
161
|
+
deleteComponentGroup(to: RemoteVersionIdentifier, componentGroupToDelete: ComponentGroup, components: Array<Component>, componentGroups: Array<ComponentGroup>): Promise<void>;
|
|
162
|
+
}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { FigmaStructure } from "../../model/support/SDKFigmaStructure";
|
|
2
|
+
import { FigmaStructureDetail } from "../../model/support/SDKFigmaStructureDetail";
|
|
3
|
+
import { Source, SourceRemoteModelCloud } from "../../model/support/SDKSource";
|
|
4
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
5
|
+
import { RemoteBrandIdentifier, RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
6
|
+
export declare class AreaDataSources {
|
|
7
|
+
/** Internal: Engine */
|
|
8
|
+
private dataCore;
|
|
9
|
+
constructor(dataCore: DataCore);
|
|
10
|
+
/** Retrieves a single source by its id
|
|
11
|
+
* @param from - Remote version to fetch from
|
|
12
|
+
* @returns Single data source
|
|
13
|
+
*/
|
|
14
|
+
getDataSourceById(from: RemoteVersionIdentifier, sourceId: string): Promise<Source>;
|
|
15
|
+
/** Retrieves all sources associated with specified design system
|
|
16
|
+
* @param from - Remote version to fetch from
|
|
17
|
+
* @returns All data sources in the specified version
|
|
18
|
+
*/
|
|
19
|
+
getDataSources(from: RemoteVersionIdentifier): Promise<Array<Source>>;
|
|
20
|
+
/** Retrieves all figma frames structures
|
|
21
|
+
* @param from - Remote version to fetch from
|
|
22
|
+
* @returns All data sources in the specified version
|
|
23
|
+
*/
|
|
24
|
+
getFigmaNodeStructures(from: RemoteVersionIdentifier): Promise<Array<FigmaStructure>>;
|
|
25
|
+
/** Retrieves figma frame structure detail
|
|
26
|
+
* @param from - Remote version to fetch from
|
|
27
|
+
* @returns All data sources in the specified version
|
|
28
|
+
*/
|
|
29
|
+
getFigmaNodeStructureDetail(from: RemoteVersionIdentifier & {
|
|
30
|
+
figmaStructureId: string;
|
|
31
|
+
}): Promise<FigmaStructureDetail>;
|
|
32
|
+
linkFigmaSource(from: RemoteBrandIdentifier, url: string, options: {
|
|
33
|
+
scopes: {
|
|
34
|
+
tokens: boolean;
|
|
35
|
+
components: boolean;
|
|
36
|
+
assets: boolean;
|
|
37
|
+
documentationFrames: boolean;
|
|
38
|
+
};
|
|
39
|
+
autoImport: SourceRemoteModelCloud["autoImportMode"];
|
|
40
|
+
themeId: string | null;
|
|
41
|
+
}): Promise<Source>;
|
|
42
|
+
updateFigmaSource(from: RemoteVersionIdentifier, sourceId: string, options: {
|
|
43
|
+
scopes?: {
|
|
44
|
+
tokens: boolean;
|
|
45
|
+
components: boolean;
|
|
46
|
+
assets: boolean;
|
|
47
|
+
documentationFrames: boolean;
|
|
48
|
+
};
|
|
49
|
+
autoImport?: SourceRemoteModelCloud["autoImportMode"];
|
|
50
|
+
themeId?: string | null;
|
|
51
|
+
}): Promise<Source>;
|
|
52
|
+
updateFigmaSourceClaimOwnership(from: RemoteVersionIdentifier, sourceId: string): Promise<Source>;
|
|
53
|
+
deleteFigmaSource(from: RemoteVersionIdentifier, sourceId: string): Promise<void>;
|
|
54
|
+
}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import { DTODocumentationLinkPreviewRequest } from "@supernova-studio/client";
|
|
2
|
+
import { DesignSystem, DesignSystemWithWorkspaceShortModel, DesignSystemSwitcher } from "../../model/base/SDKDesignSystem";
|
|
3
|
+
import { CustomDomain } from "../../model/support/SDKCustomDomain";
|
|
4
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
5
|
+
export declare class AreaDesignSystems {
|
|
6
|
+
/** Internal: Engine */
|
|
7
|
+
private dataCore;
|
|
8
|
+
constructor(dataCore: DataCore);
|
|
9
|
+
/** Fetches all design systems belonging to the workspace
|
|
10
|
+
* @param workspaceId - Workspace to fetch from
|
|
11
|
+
* @returns All design systems in the specified version
|
|
12
|
+
*/
|
|
13
|
+
designSystems(workspaceId: string): Promise<Array<DesignSystem>>;
|
|
14
|
+
/** Fetches all design systems belonging to the workspace
|
|
15
|
+
* @param userId - User id to fetch from
|
|
16
|
+
* @returns All design systems in the specified version
|
|
17
|
+
*/
|
|
18
|
+
designSystemsByUserId(userId: string): Promise<Array<DesignSystemWithWorkspaceShortModel>>;
|
|
19
|
+
/** Fetches a specific design system by its id
|
|
20
|
+
* @param designSystemId - Design system to fetch
|
|
21
|
+
* @returns Design system with the specified id
|
|
22
|
+
*/
|
|
23
|
+
designSystem(designSystemId: string): Promise<DesignSystem | null>;
|
|
24
|
+
/** Retrieves custom domain information for a design system
|
|
25
|
+
* @param designSystemId - ID of the design system
|
|
26
|
+
* @returns custom domain information
|
|
27
|
+
*/
|
|
28
|
+
designSystemCustomDomain(designSystemId: string): Promise<CustomDomain>;
|
|
29
|
+
/** Creates a new design system and retrieves the newly created DS object
|
|
30
|
+
* @param name - Name of the design system
|
|
31
|
+
* @returns Newly created design system object
|
|
32
|
+
*/
|
|
33
|
+
createDesignSystem(workspaceId: string, name: string, description?: string): Promise<DesignSystem>;
|
|
34
|
+
getBlockDefinitions(designSystemId: string, versionId: string): Promise<import("../..").DocsBlockDefinition[]>;
|
|
35
|
+
getUrlPreview(designSystemId: string, versionId: string, request: DTODocumentationLinkPreviewRequest): Promise<{
|
|
36
|
+
linkPreview: {
|
|
37
|
+
title?: string | undefined;
|
|
38
|
+
description?: string | undefined;
|
|
39
|
+
thumbnail?: {
|
|
40
|
+
type: "Resource" | "FigmaNode";
|
|
41
|
+
resource?: {
|
|
42
|
+
url: string;
|
|
43
|
+
resourceId: string;
|
|
44
|
+
} | undefined;
|
|
45
|
+
figmaNode?: {
|
|
46
|
+
sourceId: string;
|
|
47
|
+
frameReferenceId: string;
|
|
48
|
+
} | undefined;
|
|
49
|
+
} | undefined;
|
|
50
|
+
};
|
|
51
|
+
}>;
|
|
52
|
+
/** Updates design system metadata for a specific design system
|
|
53
|
+
* @param designSystemId - ID of the design system
|
|
54
|
+
* @param name - New DS name
|
|
55
|
+
* @param description - New DS description
|
|
56
|
+
* @returns Nothing
|
|
57
|
+
*/
|
|
58
|
+
updateDesignSystemMetadata(designSystemId: string, name: string, description?: string): Promise<void>;
|
|
59
|
+
/** Enabled or disables multibrand functionality for a specific design system
|
|
60
|
+
* @param designSystem - design system to update
|
|
61
|
+
* @param isMultibrand - Multibrand functionality enabled or disabled
|
|
62
|
+
* @returns Nothing
|
|
63
|
+
*/
|
|
64
|
+
updateDesignSystemIsMultibrand(designSystem: DesignSystem, isMultibrand: boolean): Promise<void>;
|
|
65
|
+
/** Enabled or disables multibrand functionality for a specific design system
|
|
66
|
+
* @param designSystem - design system to update
|
|
67
|
+
* @param designSystemSwitcher - Design system switcher options
|
|
68
|
+
* @returns Nothing
|
|
69
|
+
*/
|
|
70
|
+
updateDesignSystemSwitcher(designSystem: DesignSystem, designSystemSwitcher: DesignSystemSwitcher): Promise<void>;
|
|
71
|
+
/** Enabled or disables multibrand functionality for a specific design system
|
|
72
|
+
* @param designSystem - design system to update
|
|
73
|
+
* @param docExporterId - Design system doc exporter id
|
|
74
|
+
* @returns Nothing
|
|
75
|
+
*/
|
|
76
|
+
updateDesignSystemDocExporterId(designSystem: DesignSystem, docExporterId: string): Promise<void>;
|
|
77
|
+
/** Changes documentation slug for design system
|
|
78
|
+
* @param designSystem - design system to update
|
|
79
|
+
* @param docUserSlug - Documentation slug
|
|
80
|
+
* @returns Nothing
|
|
81
|
+
*/
|
|
82
|
+
updateDesignSystemDocumentationSlug(designSystem: DesignSystem, docUserSlug: string): Promise<void>;
|
|
83
|
+
/** Updates custom domain of a specific design system
|
|
84
|
+
* @param designSystemId - ID of the design system
|
|
85
|
+
* @param newDomain - new custom domain
|
|
86
|
+
* @returns nothing
|
|
87
|
+
*/
|
|
88
|
+
updateDesignSystemCustomDomain(designSystemId: string, newDomain: string): Promise<CustomDomain>;
|
|
89
|
+
/** Deletes a design system. This action is irreversible, all data will be lost, and can only be performed by the admins of the workspace
|
|
90
|
+
* @param designSystemId - ID of the design system
|
|
91
|
+
* @returns Nothing. RIP design system.
|
|
92
|
+
*/
|
|
93
|
+
deleteDesignSystem(designSystemId: string): Promise<void>;
|
|
94
|
+
/** Deletes custom domain
|
|
95
|
+
* @param designSystemId - ID of the design system
|
|
96
|
+
* @returns nothing
|
|
97
|
+
*/
|
|
98
|
+
deleteDesignSystemCustomDomain(designSystemId: string): Promise<void>;
|
|
99
|
+
/** starts ssl generation for custom domain
|
|
100
|
+
* @param designSystemId - ID of the design system
|
|
101
|
+
* @returns nothing
|
|
102
|
+
*/
|
|
103
|
+
startSslGenerationForCustomDomain(designSystemId: string): Promise<void>;
|
|
104
|
+
}
|
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTODeleteDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOMoveDocumentationGroupInput, DTOCreateDocumentationTabInput } from "@supernova-studio/client";
|
|
2
|
+
import { DocumentationLegacy, DocumentationLegacyModel } from "../../model/base/SDKDocumentationLegacy";
|
|
3
|
+
import { DocsBlockDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockDefinition";
|
|
4
|
+
import { DocsBlock } from "../../model/docs/blocks/usage/SDKDocsBlock";
|
|
5
|
+
import { DocsEntity } from "../../model/docs/entities/SDKDocsEntity";
|
|
6
|
+
import { DocsEntityGroupModel } from "../../model/docs/entities/SDKDocsEntityGroup";
|
|
7
|
+
import { DocsEntityPageModel } from "../../model/docs/entities/SDKDocsEntityPage";
|
|
8
|
+
import { DocsSection } from "../../model/docs/sections/SDKDocsSection";
|
|
9
|
+
import { DocumentationLegacyGroup } from "../../model/documentation/SDKDocumentationLegacyGroup";
|
|
10
|
+
import { DocsPublishStatus } from "../../model/enums/SDKDocsPublishStatus";
|
|
11
|
+
import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
|
|
12
|
+
import { ExportBuild, ExportBuildStatus } from "../../model/exporters/exporter_builds/SDKExportBuild";
|
|
13
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
14
|
+
import { RemoteVersionIdentifier, RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
15
|
+
export declare class AreaDocumentation {
|
|
16
|
+
/** Internal: Engine */
|
|
17
|
+
private dataCore;
|
|
18
|
+
constructor(dataCore: DataCore);
|
|
19
|
+
/** Fetches object containing the main information about the docs. This does not contain structure or content of the documentation
|
|
20
|
+
* @param from - Remote version to fetch from
|
|
21
|
+
* @returns Documentation object
|
|
22
|
+
*/
|
|
23
|
+
getDocumentation(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacy>;
|
|
24
|
+
getDocumentationStructure(from: RemoteWorkspaceVersionIdentifier): Promise<(DocsEntityPageModel | DocsEntityGroupModel)[]>;
|
|
25
|
+
/** Fetches url string where to find documentation
|
|
26
|
+
* @param from - Remote version to fetch from
|
|
27
|
+
* @returns documentation url string
|
|
28
|
+
*/
|
|
29
|
+
getDocumentationUrl(from: RemoteVersionIdentifier): Promise<string>;
|
|
30
|
+
/** Retrieve information for an ongoing publishing build if any exists. */
|
|
31
|
+
isPublishing(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment): Promise<{
|
|
32
|
+
status: DocsPublishStatus.inProgress;
|
|
33
|
+
job: ExportBuild;
|
|
34
|
+
} | {
|
|
35
|
+
status: DocsPublishStatus.idle;
|
|
36
|
+
job: null;
|
|
37
|
+
}>;
|
|
38
|
+
/** Fetches a documentation build.
|
|
39
|
+
* @param workspaceId - Identifier of the workspace associated with the build.
|
|
40
|
+
* @param buildId - Identifier of the build.
|
|
41
|
+
*/
|
|
42
|
+
getDocumentationBuild(workspaceId: string, buildId: string): Promise<ExportBuild>;
|
|
43
|
+
/** Fetches documentation builds filtered according to the params.
|
|
44
|
+
* @param workspaceId - Identifier of the workspace associated with the builds.
|
|
45
|
+
* @param versionId - Identifier of the design system version associated with the builds.
|
|
46
|
+
* @param environment - Environment of the builds.
|
|
47
|
+
* @param status - Status of the builds.
|
|
48
|
+
* @param createdByUserId - Identifier of the user who created the builds.
|
|
49
|
+
* @param limit - Number of builds to return.
|
|
50
|
+
*/
|
|
51
|
+
getDocumentationBuilds(workspaceId: string, versionId: string, environment: DocumentationEnvironment, status?: ExportBuildStatus, createdByUserId?: string, limit?: number): Promise<Array<ExportBuild>>;
|
|
52
|
+
/** Updates documentation structure
|
|
53
|
+
* @param from - Remote version to fetch from
|
|
54
|
+
* @param model - documentation legacy model
|
|
55
|
+
* @returns nothing
|
|
56
|
+
*/
|
|
57
|
+
updateDocumentationStructure(from: RemoteVersionIdentifier, model: DocumentationLegacyModel): Promise<void>;
|
|
58
|
+
/** Creates a documentation page within documentation group
|
|
59
|
+
* @param from - Remote version to fetch from
|
|
60
|
+
* @param payload - The update model
|
|
61
|
+
* @returns Newly created documentation page
|
|
62
|
+
*/
|
|
63
|
+
createDocumentationPage(from: RemoteWorkspaceVersionIdentifier, payload: Omit<DTOCreateDocumentationPageInputV2, "persistentId">): Promise<string>;
|
|
64
|
+
/** Creates a documentation group within documentation group
|
|
65
|
+
* @param from - Remote version to fetch from
|
|
66
|
+
* @param parentItemPersistentId - Peristent ID of the parent group
|
|
67
|
+
* @param data - The update model
|
|
68
|
+
* @returns Newly created documentation group
|
|
69
|
+
*/
|
|
70
|
+
createDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: Omit<DTOCreateDocumentationGroupInput, "persistentId">): Promise<string>;
|
|
71
|
+
/** Creates a documentation tab group within documentation group
|
|
72
|
+
* @param from - Remote version to fetch from
|
|
73
|
+
* @param data - The update model
|
|
74
|
+
* @returns Newly created documentation group
|
|
75
|
+
*/
|
|
76
|
+
createDocumentationTab(from: RemoteWorkspaceVersionIdentifier, payload: Omit<DTOCreateDocumentationTabInput, "persistentId">): Promise<string>;
|
|
77
|
+
/** Updates a documentation group within documentation group
|
|
78
|
+
* @param from - Remote version to fetch from
|
|
79
|
+
* @param group - Group to update
|
|
80
|
+
* @param updateModel - Group update model with optional fields
|
|
81
|
+
* @returns Newly created documentation group
|
|
82
|
+
*/
|
|
83
|
+
updateDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTOUpdateDocumentationGroupInput): Promise<any>;
|
|
84
|
+
/** Moves a documentation page
|
|
85
|
+
* @param from - Remote version to fetch from
|
|
86
|
+
* @param payload - The update model
|
|
87
|
+
* @returns nothing
|
|
88
|
+
*/
|
|
89
|
+
moveDocumentationPage(from: RemoteWorkspaceVersionIdentifier, payload: DTOMoveDocumentationPageInputV2): Promise<any>;
|
|
90
|
+
/** Moves a documentation group
|
|
91
|
+
* @param from - Remote version to fetch from
|
|
92
|
+
* @param payload - The update model
|
|
93
|
+
* @returns nothing
|
|
94
|
+
*/
|
|
95
|
+
moveDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTOMoveDocumentationGroupInput): Promise<any>;
|
|
96
|
+
/** Deletes a documentation group
|
|
97
|
+
* @param from - Remote version to fetch from
|
|
98
|
+
* @param group - Group to delete
|
|
99
|
+
* @returns nothing
|
|
100
|
+
*/
|
|
101
|
+
deleteDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTODeleteDocumentationGroupInput): Promise<void>;
|
|
102
|
+
/** Deletes a documentation group and its tree
|
|
103
|
+
* @param from - Remote version to fetch from
|
|
104
|
+
* @param group - Group to delete
|
|
105
|
+
* @returns nothing
|
|
106
|
+
*/
|
|
107
|
+
deleteDocumentationGroupAndTree(from: RemoteWorkspaceVersionIdentifier, id: string): Promise<void>;
|
|
108
|
+
/** Deletes a documentation page
|
|
109
|
+
* @param from - Remote version to fetch from
|
|
110
|
+
* @param page - Page to delete
|
|
111
|
+
* @returns nothing
|
|
112
|
+
*/
|
|
113
|
+
deleteDocumentationPage(from: RemoteWorkspaceVersionIdentifier, id: string): Promise<void>;
|
|
114
|
+
/** Deletes a documentation tab group
|
|
115
|
+
* @param from - Remote version to fetch from
|
|
116
|
+
* @param page - Page to delete
|
|
117
|
+
* @returns nothing
|
|
118
|
+
*/
|
|
119
|
+
deleteDocumentationTabGroup(from: RemoteWorkspaceVersionIdentifier, id: string): Promise<void>;
|
|
120
|
+
/** Updates a documentation tab or page
|
|
121
|
+
* @param from - Remote version to fetch from
|
|
122
|
+
* @param page - page to update
|
|
123
|
+
* @param updateModel - data to update page with
|
|
124
|
+
* @returns page
|
|
125
|
+
*/
|
|
126
|
+
updateDocumentationPageOrTab(from: RemoteWorkspaceVersionIdentifier, payload: DTOUpdateDocumentationPageInputV2): Promise<any>;
|
|
127
|
+
/** Duplicates a documentation tab or page
|
|
128
|
+
* @param from - Remote version to fetch from
|
|
129
|
+
* @param idInVersion - id of page or tab to be duplicated
|
|
130
|
+
* @param newPersistentId - suggested persistent id of a new page or tab
|
|
131
|
+
* @returns Promise<DocumentationLegacyPage>
|
|
132
|
+
*/
|
|
133
|
+
duplicateDocumentationPageOrTab(from: RemoteWorkspaceVersionIdentifier, payload: Omit<DTODuplicateDocumentationPageInputV2, "persistentId">): Promise<string>;
|
|
134
|
+
/** Duplicates a documentation group or tabbed page
|
|
135
|
+
* @param from - Remote version to fetch from
|
|
136
|
+
* @param idInVersion - id of page or tab to be duplicated
|
|
137
|
+
* @param newPersistentId - suggested persistent id of a new group or tabbed page
|
|
138
|
+
* @returns nothing
|
|
139
|
+
*/
|
|
140
|
+
duplicateDocumentationGroupOrTabbedPage(from: RemoteWorkspaceVersionIdentifier, payload: Omit<DTODuplicateDocumentationGroupInput, "persistentId">): Promise<void>;
|
|
141
|
+
/** Ungroups a documentation group
|
|
142
|
+
* @param from - Remote version to fetch from
|
|
143
|
+
* @param idInVersion - id of a group
|
|
144
|
+
* @returns nothing
|
|
145
|
+
*/
|
|
146
|
+
ungroupDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTODeleteDocumentationGroupInput): Promise<void>;
|
|
147
|
+
/** Fetches object containing the structure of the docs - documentation pages and groups with metadata but without the page payloads
|
|
148
|
+
* Not implemented for now
|
|
149
|
+
* @param from - Remote version to fetch from
|
|
150
|
+
* @returnsDocumentationLegacy object
|
|
151
|
+
*/
|
|
152
|
+
getDocumentationStructureFromRoot(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacyGroup>;
|
|
153
|
+
/** Fetches entire documentation documentation structure, including all pages and groups and their payloads
|
|
154
|
+
* @param from - Remote version to fetch from
|
|
155
|
+
* @returns All documentation items
|
|
156
|
+
*/
|
|
157
|
+
getDocumentationFromRoot(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacyGroup>;
|
|
158
|
+
/** Get ID of the multiplayer room for a given documentation page
|
|
159
|
+
* @param from - Remote version to fetch from
|
|
160
|
+
* @param pageId - ID of the documentation page
|
|
161
|
+
* @returns Room ID that can be immediately used to join the multiplayer room
|
|
162
|
+
*/
|
|
163
|
+
getDocumentationPageRoomId(from: RemoteWorkspaceVersionIdentifier, pageId: string): Promise<string>;
|
|
164
|
+
/** Get id of the room for a specific design system and version. This room contains doc structure
|
|
165
|
+
* @param from - Remote version to fetch from
|
|
166
|
+
* @returns Room ID that can be immediately used to join the multiplayer room
|
|
167
|
+
*/
|
|
168
|
+
getDocumentationVersionRoomId(from: RemoteWorkspaceVersionIdentifier): Promise<string>;
|
|
169
|
+
/** Publish documentation. This queues a build on Supernova's server that will be processed by the asynchronous CI/CD pipeline.
|
|
170
|
+
* You can request status of the build with associated `isPublishing` method.
|
|
171
|
+
* @param to - Remote version where the build should be created
|
|
172
|
+
* @param environment - Environment to publish to
|
|
173
|
+
* @param isForcing - If true, a new build will be created regardless if an in-progress build already exists.
|
|
174
|
+
* */
|
|
175
|
+
publish(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment, isForcing?: boolean): Promise<ExportBuild>;
|
|
176
|
+
getDocumentationMockedStructure(): Array<DocsEntity>;
|
|
177
|
+
getDocumentationMockedPageContent(pageId: string): Array<DocsBlock | DocsSection>;
|
|
178
|
+
getDocumentationMockedEditorBlockDefinitions(): Array<DocsBlockDefinition>;
|
|
179
|
+
}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import { AzurePersonalAccessTokenConnectionPayload, PersonalAccessTokenConnectionPayload } from "../../model/exporters/SDKConnections";
|
|
2
|
+
import { ConnectionRemoteModel } from "../../model/exporters/remote/SDKRemoteConnectionsModel";
|
|
3
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
4
|
+
export declare class AreaIntegrations {
|
|
5
|
+
/** Internal: Engine */
|
|
6
|
+
private dataCore;
|
|
7
|
+
constructor(dataCore: DataCore);
|
|
8
|
+
/**
|
|
9
|
+
* @returns Array of AuthenticationTokens
|
|
10
|
+
*/
|
|
11
|
+
getAuthenticationTokens(): Promise<import("../../model/exporters/SDKConnections").AuthenticationTokens>;
|
|
12
|
+
/** Returns URL that can be used to authenticate current user (identified by the token) with Figma
|
|
13
|
+
* @returns Figma OAuth URL
|
|
14
|
+
*/
|
|
15
|
+
getFigmaOAuthURL(): Promise<string>;
|
|
16
|
+
/** Returns URL that can be used to authenticate current user (identified by the token) with GitHub
|
|
17
|
+
* @returns GitHub OAuth URL
|
|
18
|
+
*/
|
|
19
|
+
getGitHubOAuthURL(): Promise<string>;
|
|
20
|
+
/** Returns URL that can be used to authenticate current user (identified by the token) with GitLab
|
|
21
|
+
* @returns GitLab OAuth URL
|
|
22
|
+
*/
|
|
23
|
+
getGitLabOAuthURL(): Promise<string>;
|
|
24
|
+
/** Returns URL that can be used to authenticate current user (identified by the token) with Bitbucket
|
|
25
|
+
* @returns Bitbucket OAuth URL
|
|
26
|
+
*/
|
|
27
|
+
getBitbucketOAuthURL(): Promise<string>;
|
|
28
|
+
/** Returns URL that can be used to authenticate current user (identified by the token) with Azure
|
|
29
|
+
* @returns Azure OAuth URL
|
|
30
|
+
*/
|
|
31
|
+
getAzureOAuthURL(): Promise<string>;
|
|
32
|
+
/** Creates a Personal Access Token.
|
|
33
|
+
* @param name - Name of the token.
|
|
34
|
+
* @param scope - Scope of the token.
|
|
35
|
+
*/
|
|
36
|
+
createAuthenticationToken(name: string, scope?: string): Promise<import("../../model/exporters/SDKConnections").CreateAuthenticationTokenPayload>;
|
|
37
|
+
/** Creates user GitHub personal access token integration.
|
|
38
|
+
* @param customUrl - Custom GitHub URL. If not provided, default GitHub URL will be used.
|
|
39
|
+
* @param token - GitHub access token.
|
|
40
|
+
* @param name - Name of the integration.
|
|
41
|
+
*/
|
|
42
|
+
createGitHubPersonalAccessTokenConnection(connection: PersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
|
|
43
|
+
/** Creates user GitLab personal access token integration.
|
|
44
|
+
* @param customUrl - Custom GitLab URL. If not provided, default GitLab URL will be used.
|
|
45
|
+
* @param token - GitLab access token.
|
|
46
|
+
* @param name - Name of the integration.
|
|
47
|
+
*/
|
|
48
|
+
createGitLabPersonalAccessTokenConnection(connection: PersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
|
|
49
|
+
/** Creates user Bitbucket personal access token integration.
|
|
50
|
+
* @param customUrl - Custom Bitbucket URL. If not provided, default Bitbucket URL will be used.
|
|
51
|
+
* @param token - Bitbucket access token.
|
|
52
|
+
* @param name - Name of the integration.
|
|
53
|
+
* @param organization - Organization name.
|
|
54
|
+
*/
|
|
55
|
+
createBitbucketPersonalAccessTokenConnection(connection: PersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
|
|
56
|
+
/** Creates user Azure personal access token integration.
|
|
57
|
+
* @param customUrl - Custom Azure URL. If not provided, default Azure URL will be used.
|
|
58
|
+
* @param token - Azure access token.
|
|
59
|
+
* @param name - Name of the integration.
|
|
60
|
+
*/
|
|
61
|
+
createAzurePersonalAccessTokenConnection(connection: AzurePersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
|
|
62
|
+
/**
|
|
63
|
+
* @returns Array of AuthenticationTokens
|
|
64
|
+
*/
|
|
65
|
+
deleteAuthenticationToken(id: string): Promise<import("../../model/exporters/SDKConnections").AuthenticationTokenPayload>;
|
|
66
|
+
/** Deletes user Figma OAuth integration.
|
|
67
|
+
* @param userId - User id to delete integration for. Can only be invoked on user id that is currently authenticated.
|
|
68
|
+
* @returns Nothing
|
|
69
|
+
*/
|
|
70
|
+
deleteFigmaOAuthIntegration(userId: string): Promise<void>;
|
|
71
|
+
/** Deletes user GitHub OAuth integration.
|
|
72
|
+
* @param userId - User id to delete integration for. Can only be invoked on user id that is currently authenticated.
|
|
73
|
+
* @returns Nothing
|
|
74
|
+
*/
|
|
75
|
+
deleteGitHubOAuthIntegration(userId: string): Promise<void>;
|
|
76
|
+
/** Deletes user GitLab OAuth integration.
|
|
77
|
+
* @param userId - User id to delete integration for. Can only be invoked on user id that is currently authenticated.
|
|
78
|
+
* @returns Nothing
|
|
79
|
+
*/
|
|
80
|
+
deleteGitLabOAuthIntegration(userId: string): Promise<void>;
|
|
81
|
+
/** Deletes user Bitbucket OAuth integration.
|
|
82
|
+
* @param userId - User id to delete integration for. Can only be invoked on user id that is currently authenticated.
|
|
83
|
+
* @returns Nothing
|
|
84
|
+
*/
|
|
85
|
+
deleteBitbucketOAuthIntegration(userId: string): Promise<void>;
|
|
86
|
+
/** Deletes user Azure OAuth integration.
|
|
87
|
+
* @param userId - User id to delete integration for. Can only be invoked on user id that is currently authenticated.
|
|
88
|
+
* @returns Nothing
|
|
89
|
+
*/
|
|
90
|
+
deleteAzureOAuthIntegration(userId: string): Promise<void>;
|
|
91
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { User } from "../../model/users/SDKUser";
|
|
2
|
+
import { UserProfileUpdateModel } from "../../model/users/SDKUserProfile";
|
|
3
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
4
|
+
export declare class AreaMe {
|
|
5
|
+
/** Internal: Engine */
|
|
6
|
+
private dataCore;
|
|
7
|
+
constructor(dataCore: DataCore);
|
|
8
|
+
/** Fetches current user profile based on the API key provided to Supernova instance. */
|
|
9
|
+
me(): Promise<User>;
|
|
10
|
+
/** Invalidates all session keys for the current user, effectively logging out from all decises. */
|
|
11
|
+
logout(): Promise<void>;
|
|
12
|
+
/** Updates the current user based on the API key provided to Supernova instance. */
|
|
13
|
+
updateProfile(userId: string, profile: UserProfileUpdateModel): Promise<void>;
|
|
14
|
+
/** Updates the avatar of the current user */
|
|
15
|
+
updateAvatar(userId: string, avatar: File): Promise<void>;
|
|
16
|
+
/** Deletes the current user user based on the API key provided to Supernova instance. Also removes all owned workspaces and updates memberships where user belongs. */
|
|
17
|
+
deleteMe(userId: string): Promise<void>;
|
|
18
|
+
/** Checks whether user can be deleted. There are certain restrictions, like users who don't have all bills settled in their associated workspaces can't be deleted, for example */
|
|
19
|
+
canDeleteMe(userId: string): Promise<boolean>;
|
|
20
|
+
/** Updates the avatar of the current user */
|
|
21
|
+
deleteAvatar(userId: string): Promise<void>;
|
|
22
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
2
|
+
export declare class AreaMultiplayer {
|
|
3
|
+
/** Internal: Engine */
|
|
4
|
+
private dataCore;
|
|
5
|
+
constructor(dataCore: DataCore);
|
|
6
|
+
/** Return multiplayer access token for specific room. */
|
|
7
|
+
getMultiplayerToken(room: string): Promise<{
|
|
8
|
+
token: string;
|
|
9
|
+
}>;
|
|
10
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
2
|
+
import { RequestInfo, RequestInit, Response } from "node-fetch";
|
|
3
|
+
export declare class AreaNetwork {
|
|
4
|
+
/** Internal: Engine */
|
|
5
|
+
private dataCore;
|
|
6
|
+
constructor(dataCore: DataCore);
|
|
7
|
+
/** Fires network request using node-fetch library */
|
|
8
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
9
|
+
}
|