@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/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2021 Supernova.io
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
<img src="https://github.com/Supernova-Studio/sdk-typescript/blob/main/readme-icon.png?raw=true" alt="Supernova SDK" style="max-width:100%; margin-bottom: 20px;" />
|
|
2
|
+
|
|
3
|
+
# Supernova JS/TS SDK [](https://raw.githubusercontent.com/Supernova-Studio/sdk-typescript/main/LICENSE.md) []() []()
|
|
4
|
+
|
|
5
|
+
The Supernova SDK provides convenient access to the [Supernova.io](https://supernova.io) platform. It allows you to build design system tooling without worrying about building entire necessary infrastructure like syncing data from Figma, Storybook, writing entire documentation systems etc. - instead, you get all of this out of the box, and you can use the data coming from your single source of truth for any other purpose.
|
|
6
|
+
|
|
7
|
+
## Features
|
|
8
|
+
|
|
9
|
+
SDK comes with all functionality (all will come with more once it reaches general release) you need to build design system tooling you previously only dreamt of:
|
|
10
|
+
|
|
11
|
+
- [x] Read API for `Tokens`, `Assets`, `Components`, `Design Components`
|
|
12
|
+
- [x] Read API for Account-level objects like `Workspaces`, `Design Systems`
|
|
13
|
+
- [x] Support for `single-branded` and `multi-branded` `Design Systems`
|
|
14
|
+
- [x] Read API for `Documentation`, including entire structure, content and configuration
|
|
15
|
+
- [x] Block or markdown `Documentation` representation
|
|
16
|
+
- [x] Rendering pipeline to export your assets as svg, png, pdf
|
|
17
|
+
- [x] Write Token API
|
|
18
|
+
- [ ] (coming) Version management
|
|
19
|
+
- [ ] (coming) Exporter management
|
|
20
|
+
- [ ] (coming) Integrations with awesome community tools (Figma Tokens, Style Dictionary, Raycast..)
|
|
21
|
+
|
|
22
|
+
And of course, features that make all developers happy!
|
|
23
|
+
|
|
24
|
+
- [x] Fully Typescript-enabled code
|
|
25
|
+
- [x] Heavily performance-optimized code and caching
|
|
26
|
+
- [x] Fully documented objects and attributes
|
|
27
|
+
- [x] Plug & play library design
|
|
28
|
+
- [x] Performant even for large design systems with lot of data
|
|
29
|
+
- [x] Extensive examples showing most of the capabilities
|
|
30
|
+
- [x] Unit tests
|
|
31
|
+
|
|
32
|
+
## Installing
|
|
33
|
+
|
|
34
|
+
To install, simply run:
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
npm install @supernovaio/sdk
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Supernova SDK is made to run in both local (like Node.js) and remote environments (like browsers) so you can use it to develop your React sites or any kind of tool you would like to run as client-side app.
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
## Obtaining API Key
|
|
44
|
+
|
|
45
|
+
Before you can use the SDK, you must obtain your personal access key from your [Supernova.io](https://supernova.io) profile. To do this, sign-in to [Supernova Cloud](https://cloud.supernova.io/), click on your profile picture > profile settings > authentication and generate a new key. [See more information](https://developers.supernova.io/getting-started#obtain-your-developer-key) if you need additional help.
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
## Access Rights
|
|
49
|
+
|
|
50
|
+
Usage of the SDK adheres to the [general access rights](https://learn.supernova.io/workspace/team-management/roles.html) that the account which generated the access key has. For example, if you are a viewer in a specific workspace, then you will not be able to do any change to that workspace through the SDK and error will be thrown instead. For vast majority of use-cases, being editor-level is enough however.
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
## Quick-start
|
|
54
|
+
|
|
55
|
+
It is time to put this SDK to good use! To start, import the main Supernova SDK object:
|
|
56
|
+
|
|
57
|
+
```typescript
|
|
58
|
+
import { Supernova } from "@supernovaio/sdk"
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
And instantiate it with your API key:
|
|
62
|
+
|
|
63
|
+
```typescript
|
|
64
|
+
const supernova = new Supernova(key)
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Supernova instance is used for several purposes, but the main one is to select specific design system you want to fetch the data from.
|
|
68
|
+
|
|
69
|
+
## How are data structured
|
|
70
|
+
|
|
71
|
+
All your design system data live under the following structure (that will match your specific setup, what versions you have created and so on):
|
|
72
|
+
|
|
73
|
+
```
|
|
74
|
+
Workspace 1
|
|
75
|
+
Design System 1
|
|
76
|
+
Version Draft
|
|
77
|
+
Brand 1
|
|
78
|
+
Brand 2
|
|
79
|
+
Version 1.0
|
|
80
|
+
Brand 1
|
|
81
|
+
Brand 2
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
- `Workspace` is what you are a member of and is object that encapsulates everything, from your team to all design systems that were created under it. You can be a member of an unlimited number of workspaces, but in the majority of cases users are members of just a single one. You can have different roles and access rights under each of the workspaces you belong to.
|
|
85
|
+
- Every `Design System` belongs to one `Workspace` and contains things like design system configuration, integration settings and admin-related tools.
|
|
86
|
+
- Each `Design System` contains at minimum one active `Version` called `Shared Draft` - this version is where you write your data and is the only one which is allowed to be written to as well.
|
|
87
|
+
- `Version` is data container for all design system information - like `Tokens`, `Assets`, `DesignComponents` and `Documentation`.
|
|
88
|
+
- `Version` object has all methods you need to access every piece of data you have in Supernova design system.
|
|
89
|
+
- Each `Version` additionally contains `Brands`. As Supernova supports multi-branded design systems, `Brands` further separate data into data packs that only represent data belonging to one specific brand (for example, set of core tokens shared across all brands, but then subset of tokens specific only to that brand).
|
|
90
|
+
- There is always at least one `Brand` in each `Version`, even if multi-branded functionality is disabled.
|
|
91
|
+
- `Brand` object has all methods you need to access every piece of data you have in Supernova design system related to one specific brand.
|
|
92
|
+
|
|
93
|
+
To access the data, you first need to select which `Workspace`, `Design System` and `Version` (optionally `Brand`) you want to use.
|
|
94
|
+
|
|
95
|
+
## Using SDK
|
|
96
|
+
|
|
97
|
+
You can find full list of [what is possible, and how, here](https://github.com/Supernova-Studio/sdk-typescript/tree/main/docs).
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
## Resolution Caching
|
|
101
|
+
|
|
102
|
+
Supernova SDK works little bit differently than you would probably expect by default. Because of how complex the design system data is (as an example, a token can contain references to other tokens and can also be made of different types of tokens which can then be used in designComponents...) the SDK does all necessary resolution for you beforehand.
|
|
103
|
+
|
|
104
|
+
To allow reuse of the data, the resolved results are cached and used in follow-up resolutions (for example, if you would first access your design tokens and then access documentation that uses the tokens, tokens would be reused). In many situations, this is what you want. However, there are some cases where this behavior is not what you want, like longer-running sessions:
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
### Longer-running sessions
|
|
108
|
+
|
|
109
|
+
If you are building a client-side app, your users might stay there for a long time without refreshing their session (like reloading a browser). This means the data will always come from the time of the first request as you are always using the same Supernova instance. To prevent this, you can disable cache layer completely:
|
|
110
|
+
|
|
111
|
+
```typescript
|
|
112
|
+
instance.setResolutionCacheEnabled(false)
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
With cache disabled, every request will download all necessary information for every request. This is not particulary efficient, especially for very-large design systems, but we put this option so you can control this behavior if you want to. Cache is enabled by default.
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
## What's next
|
|
119
|
+
|
|
120
|
+
As this is still beta, we are working hard on improving it before the first official release. The following are areas we'd like to solve before general release:
|
|
121
|
+
|
|
122
|
+
- [ ] DesignComponent API
|
|
123
|
+
- [ ] Write API
|
|
124
|
+
- [ ] Metadata API
|
|
125
|
+
- [ ] Automation triggers
|
|
126
|
+
- [ ] More examples
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
## Contributions
|
|
130
|
+
|
|
131
|
+
If you have additional ideas about how to make this project better, let us know by opening an issue! You can also open pull requests if you've worked on improving something yourself and would like to contribute back to the community.
|
|
132
|
+
|
|
133
|
+
We will be reviewing feature-pull-requests on case-by-case basis, but in general, we are super open to your new ideas and we welcome them! And finally, thank you for your support! You are an amazing community.
|
|
134
|
+
|
|
135
|
+
Supernova Engineering Team
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
declare const _extends: string[];
|
|
2
|
+
export { _extends as extends };
|
|
3
|
+
export declare const root: boolean;
|
|
4
|
+
export declare const overrides: {
|
|
5
|
+
files: string[];
|
|
6
|
+
plugins: string[];
|
|
7
|
+
rules: {
|
|
8
|
+
"@typescript-eslint/unbound-method": string;
|
|
9
|
+
"jest/unbound-method": string;
|
|
10
|
+
};
|
|
11
|
+
}[];
|
|
12
|
+
export declare namespace parserOptions {
|
|
13
|
+
const tsconfigRootDir: string;
|
|
14
|
+
const project: string[];
|
|
15
|
+
}
|
|
16
|
+
export declare const rules: {
|
|
17
|
+
"@typescript-eslint/no-unsafe-assignment": string;
|
|
18
|
+
"@typescript-eslint/no-unsafe-member-access": string;
|
|
19
|
+
"@typescript-eslint/unbound-method": string;
|
|
20
|
+
"@typescript-eslint/no-unused-vars": string;
|
|
21
|
+
"no-restricted-syntax": string;
|
|
22
|
+
"fp/no-mutation": string;
|
|
23
|
+
"no-param-reassign": (string | {
|
|
24
|
+
props: boolean;
|
|
25
|
+
})[];
|
|
26
|
+
"@typescript-eslint/restrict-template-expressions": string;
|
|
27
|
+
"no-nested-ternary": string;
|
|
28
|
+
"no-prototype-builtins": string;
|
|
29
|
+
"prefer-destructuring": string;
|
|
30
|
+
"@typescript-eslint/no-unsafe-argument": string;
|
|
31
|
+
"@typescript-eslint/no-unsafe-return": string;
|
|
32
|
+
"@typescript-eslint/no-unsafe-call": string;
|
|
33
|
+
"@typescript-eslint/no-explicit-any": string;
|
|
34
|
+
"@typescript-eslint/no-var-requires": string;
|
|
35
|
+
"no-await-in-loop": string;
|
|
36
|
+
"no-continue": string;
|
|
37
|
+
"@typescript-eslint/no-useless-constructor": string;
|
|
38
|
+
"no-console": string;
|
|
39
|
+
"@typescript-eslint/require-await": string;
|
|
40
|
+
"max-classes-per-file": string;
|
|
41
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./exports";
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
import { AreaAssets } from "./areas/SDKAreaAssets";
|
|
2
|
+
import { AreaAutomation } from "./areas/SDKAreaAutomation";
|
|
3
|
+
import { AreaBrands } from "./areas/SDKAreaBrands";
|
|
4
|
+
import { AreaBulkOperations } from "./areas/SDKAreaBulkOperations";
|
|
5
|
+
import { AreaComponents } from "./areas/SDKAreaComponents";
|
|
6
|
+
import { AreaDataSources } from "./areas/SDKAreaDataSources";
|
|
7
|
+
import { AreaDesignSystems } from "./areas/SDKAreaDesignSystems";
|
|
8
|
+
import { AreaDocumentation } from "./areas/SDKAreaDocumentation";
|
|
9
|
+
import { AreaIntegrations } from "./areas/SDKAreaIntegrations";
|
|
10
|
+
import { AreaMe } from "./areas/SDKAreaMe";
|
|
11
|
+
import { AreaMultiplayer } from "./areas/SDKAreaMultiplayer";
|
|
12
|
+
import { AreaNetwork } from "./areas/SDKAreaNetwork";
|
|
13
|
+
import { AreaResources } from "./areas/SDKAreaResources";
|
|
14
|
+
import { AreaStorage } from "./areas/SDKAreaStorage";
|
|
15
|
+
import { AreaTokens } from "./areas/SDKAreaTokens";
|
|
16
|
+
import { AreaUsers } from "./areas/SDKAreaUsers";
|
|
17
|
+
import { AreaVersions } from "./areas/SDKAreaVersions";
|
|
18
|
+
import { AreaWorkspaces } from "./areas/SDKAreaWorkspaces";
|
|
19
|
+
import { DataBridgeRequestHook } from "./data/SDKDataBridge";
|
|
20
|
+
/** Main Supernova.io SDK object. Use this to connect to your data instance and retrieve workspace / design system / version from which you can access all neccessary data. */
|
|
21
|
+
export declare class Supernova {
|
|
22
|
+
private apiKey;
|
|
23
|
+
private apiUrl;
|
|
24
|
+
private apiVersion;
|
|
25
|
+
private requestHook;
|
|
26
|
+
private dataCore;
|
|
27
|
+
/** Get, create, update, manipulate or delete workspaces */
|
|
28
|
+
workspaces: AreaWorkspaces;
|
|
29
|
+
/** Get, create, update, manipulate or delete design systems */
|
|
30
|
+
designSystems: AreaDesignSystems;
|
|
31
|
+
/** Get, create, update, manipulate or delete versions */
|
|
32
|
+
versions: AreaVersions;
|
|
33
|
+
/** Get, create, update, manipulate or delete brands */
|
|
34
|
+
brands: AreaBrands;
|
|
35
|
+
/** Get, create, update, manipulate or delete tokens */
|
|
36
|
+
tokens: AreaTokens;
|
|
37
|
+
/** Get, create, update, manipulate or delete components */
|
|
38
|
+
components: AreaComponents;
|
|
39
|
+
/** Get, create, update, manipulate or delete assets */
|
|
40
|
+
assets: AreaAssets;
|
|
41
|
+
/** Get, create, update, manipulate or delete resources */
|
|
42
|
+
resources: AreaResources;
|
|
43
|
+
/** Get, create, update, manipulate or delete documentation items */
|
|
44
|
+
documentation: AreaDocumentation;
|
|
45
|
+
/** Get, create, update, manipulate or delete pipelines and automation jobs */
|
|
46
|
+
automation: AreaAutomation;
|
|
47
|
+
/** Get, create, update, manipulate or delete users */
|
|
48
|
+
users: AreaUsers;
|
|
49
|
+
/** Get, create, update, manipulate or delete current user */
|
|
50
|
+
me: AreaMe;
|
|
51
|
+
/** Get, create, update, manipulate or delete integrations */
|
|
52
|
+
integrations: AreaIntegrations;
|
|
53
|
+
/** Get, create, update, manipulate or delete data sources */
|
|
54
|
+
dataSources: AreaDataSources;
|
|
55
|
+
/** Get, create, update, manipulate or delete data from Supernova en masse */
|
|
56
|
+
bulkOperations: AreaBulkOperations;
|
|
57
|
+
/** Read and write data using Supernova key-value storage */
|
|
58
|
+
storage: AreaStorage;
|
|
59
|
+
/** Get access to network in exporter packages */
|
|
60
|
+
network: AreaNetwork;
|
|
61
|
+
/** Get access to multiplayer capabilities */
|
|
62
|
+
multiplayer: AreaMultiplayer;
|
|
63
|
+
/**
|
|
64
|
+
* Create new Supernova.io SDK object.
|
|
65
|
+
* @param apiKey API key to use for authentication
|
|
66
|
+
* @param options Options for SDK
|
|
67
|
+
* @param options.url URL of the Supernova.io instance to connect to. Defaults to production environment
|
|
68
|
+
* @param options.requestHook Hook for observing requests
|
|
69
|
+
* @param options.bypassEnvFetch When enabled, internal node-fetch lib will be used in environments when fetch is not available. Defaults to false
|
|
70
|
+
*/
|
|
71
|
+
constructor(apiKey: string, options?: {
|
|
72
|
+
apiUrl?: string;
|
|
73
|
+
requestHook?: DataBridgeRequestHook;
|
|
74
|
+
bypassEnvFetch?: boolean;
|
|
75
|
+
proxyUrl?: string;
|
|
76
|
+
});
|
|
77
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { DTOFigmaNode } from "@supernova-studio/client";
|
|
2
|
+
import { Asset } from "../../model/assets/SDKAsset";
|
|
3
|
+
import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
|
|
4
|
+
import { AssetFormat } from "../../model/enums/SDKAssetFormat";
|
|
5
|
+
import { AssetScale } from "../../model/enums/SDKAssetScale";
|
|
6
|
+
import { AssetGroup } from "../../model/groups/SDKAssetGroup";
|
|
7
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
8
|
+
import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
9
|
+
export declare class AreaAssets {
|
|
10
|
+
/** Internal: Engine */
|
|
11
|
+
private dataCore;
|
|
12
|
+
constructor(dataCore: DataCore);
|
|
13
|
+
/** Fetches all remote assets in the version
|
|
14
|
+
* @param from - Remote version to fetch from
|
|
15
|
+
* @returns All assets in the specified version
|
|
16
|
+
*/
|
|
17
|
+
getAssets(from: RemoteVersionIdentifier): Promise<Array<Asset>>;
|
|
18
|
+
/** Fetches all remote asset groups in the version
|
|
19
|
+
* @param from - Remote version to fetch from
|
|
20
|
+
* @returns All asset groups in the specified version
|
|
21
|
+
*/
|
|
22
|
+
getAssetGroups(from: RemoteVersionIdentifier): Promise<Array<AssetGroup>>;
|
|
23
|
+
/** Renders all assets in this version and retrieves URLs from which assets can be downloaded as key-value.
|
|
24
|
+
*
|
|
25
|
+
* You can only render one combination of size/format with one request - use more requests if you need to render more. Assets that are rendered as "png" will use "scale" attribute, however, when the format is "svg" or "pdf", scale attribute is ignored and will always render the original size.
|
|
26
|
+
*
|
|
27
|
+
* Note that assets are not persistent and URLs will expire quickly - you must download them and store them locally / remotely and can never use this URL publicly as it won't work after a short time
|
|
28
|
+
* @param from - Remote version to fetch from
|
|
29
|
+
* @param assets - Assets to render
|
|
30
|
+
* @param groups - All asset groups in the version
|
|
31
|
+
* @param format - Format to render (png, svg, pdf)
|
|
32
|
+
* @param scale - Scale to render (1x, 2x, 3x, 4x)
|
|
33
|
+
* @returns All assets that were provided in the request, rendered in the specified format and scale
|
|
34
|
+
*/
|
|
35
|
+
getRenderedAssets(from: RemoteVersionIdentifier, assets: Array<Asset>, groups: Array<AssetGroup>, format: AssetFormat, scale: AssetScale): Promise<Array<RenderedAsset>>;
|
|
36
|
+
/** Renders figma frames based on the source and node id. The result is a URL to the hosted image of the Figma frame that is stable across updates.
|
|
37
|
+
*
|
|
38
|
+
* @returns Rendered Figma frames
|
|
39
|
+
*/
|
|
40
|
+
getRenderedFigmaFrames(from: RemoteVersionIdentifier, framesToRender: Array<{
|
|
41
|
+
sourceId: string;
|
|
42
|
+
figmaFileNodeId: string;
|
|
43
|
+
}>): Promise<Array<DTOFigmaNode>>;
|
|
44
|
+
/** Passes data through Supernova CORS proxy to prevent issues with accessing foreign data from browser */
|
|
45
|
+
dataThroughCorsProxy(urlToRelay: string): Promise<ArrayBuffer | undefined>;
|
|
46
|
+
}
|
|
@@ -0,0 +1,233 @@
|
|
|
1
|
+
import { CodegenAccount } from "../../model/exporters/CodegenAccount";
|
|
2
|
+
import { CodegenAzureOrganization } from "../../model/exporters/CodegenAzureOrganization";
|
|
3
|
+
import { CodegenAzureProject } from "../../model/exporters/CodegenAzureProject";
|
|
4
|
+
import { CodegenAzureRepository } from "../../model/exporters/CodegenAzureRepository";
|
|
5
|
+
import { CodegenBitbucketBranch } from "../../model/exporters/CodegenBitbucketBranch";
|
|
6
|
+
import { CodegenBitbucketProject } from "../../model/exporters/CodegenBitbucketProject";
|
|
7
|
+
import { CodegenBitbucketRepository } from "../../model/exporters/CodegenBitbucketRepository";
|
|
8
|
+
import { CodegenBitbucketWorkspace } from "../../model/exporters/CodegenBitbucketWorkspace";
|
|
9
|
+
import { CodegenBranch } from "../../model/exporters/CodegenBranch";
|
|
10
|
+
import { CodegenConnection } from "../../model/exporters/CodegenConnection";
|
|
11
|
+
import { CodegenGitlabBranch } from "../../model/exporters/CodegenGitlabBranch";
|
|
12
|
+
import { CodegenGitlabGroup } from "../../model/exporters/CodegenGitlabGroup";
|
|
13
|
+
import { CodegenGitlabRepository } from "../../model/exporters/CodegenGitlabRepository";
|
|
14
|
+
import { CodegenRepository } from "../../model/exporters/CodegenRepository";
|
|
15
|
+
import { Exporter, NewExporterPayload } from "../../model/exporters/SDKExporter";
|
|
16
|
+
import { NewPipelinePayload, Pipeline, PipelineUpdateModel } from "../../model/exporters/SDKPipeline";
|
|
17
|
+
import { ExporterCustomBlockVariant } from "../../model/exporters/custom_blocks/SDKExporterCustomBlockVariant";
|
|
18
|
+
import { ExporterConfigurationProperty } from "../../model/exporters/custom_properties/SDKExporterConfigurationProperty";
|
|
19
|
+
import { ExportBuild } from "../../model/exporters/exporter_builds/SDKExportBuild";
|
|
20
|
+
import { ExportBuildResultLog } from "../../model/exporters/exporter_builds/SDKExportBuildResults";
|
|
21
|
+
import { ImportJob } from "../../model/jobs/SDKImportJob";
|
|
22
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
23
|
+
import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
24
|
+
export declare class AreaAutomation {
|
|
25
|
+
/** Internal: Engine */
|
|
26
|
+
private dataCore;
|
|
27
|
+
constructor(dataCore: DataCore);
|
|
28
|
+
/** Fetches all pipelines that are available by workspace id and design system id */
|
|
29
|
+
getPipelines(workspaceId: string, designSystemId?: string): Promise<Array<Pipeline>>;
|
|
30
|
+
/**
|
|
31
|
+
* Fetches all github connections for user
|
|
32
|
+
* @returns Github Connections
|
|
33
|
+
*/
|
|
34
|
+
getGithubConnections(): Promise<CodegenConnection[]>;
|
|
35
|
+
/**
|
|
36
|
+
* Fetches github accounts
|
|
37
|
+
* @returns Github accounts
|
|
38
|
+
*/
|
|
39
|
+
getGithubAccounts(githubConnectionId: string): Promise<CodegenAccount[]>;
|
|
40
|
+
/**
|
|
41
|
+
* Fetches github repositories
|
|
42
|
+
* @returns Github repositories
|
|
43
|
+
*/
|
|
44
|
+
getGithubRepositories(githubConnectionId: string, handle: string): Promise<CodegenRepository[]>;
|
|
45
|
+
/**
|
|
46
|
+
* Fetches github
|
|
47
|
+
* @returns Github branches
|
|
48
|
+
*/
|
|
49
|
+
getGithubBranches(githubConnectionId: string, handle: string, repoName: string): Promise<CodegenBranch[]>;
|
|
50
|
+
/**
|
|
51
|
+
* Fetches all Gitlab connections for user
|
|
52
|
+
* @returns Gitlab Connections
|
|
53
|
+
*/
|
|
54
|
+
getGitlabConnections(): Promise<CodegenConnection[]>;
|
|
55
|
+
/**
|
|
56
|
+
* Fetches Gitlab groups
|
|
57
|
+
* @param connectionId
|
|
58
|
+
* @returns Gitlab groups
|
|
59
|
+
*/
|
|
60
|
+
getGitlabGroups(connectionId: string): Promise<CodegenGitlabGroup[]>;
|
|
61
|
+
/**
|
|
62
|
+
* Fetches Gitlab repositories
|
|
63
|
+
* @param connectionId
|
|
64
|
+
* @param groupId
|
|
65
|
+
* @returns Gitlab repositories
|
|
66
|
+
*/
|
|
67
|
+
getGitlabRepositories(connectionId: string, groupId: string): Promise<CodegenGitlabRepository[]>;
|
|
68
|
+
/**
|
|
69
|
+
* Fetches Gitlab
|
|
70
|
+
* @param connectionId
|
|
71
|
+
* @param repoId
|
|
72
|
+
* @returns Gitlab branches
|
|
73
|
+
*/
|
|
74
|
+
getGitlabBranches(connectionId: string, repoId: string): Promise<CodegenGitlabBranch[]>;
|
|
75
|
+
/**
|
|
76
|
+
* Fetches all Azure connections for user
|
|
77
|
+
* @returns Azure Connections
|
|
78
|
+
*/
|
|
79
|
+
getAzureConnections(): Promise<CodegenConnection[]>;
|
|
80
|
+
/**
|
|
81
|
+
* Fetches Azure organizations
|
|
82
|
+
* @param connectionId
|
|
83
|
+
* @returns Azure organizations
|
|
84
|
+
*/
|
|
85
|
+
getAzureOrganizations(connectionId: string): Promise<CodegenAzureOrganization[]>;
|
|
86
|
+
/**
|
|
87
|
+
* Fetches Azure projects
|
|
88
|
+
* @param connectionId
|
|
89
|
+
* @param organizationId
|
|
90
|
+
* @returns Azure projects
|
|
91
|
+
*/
|
|
92
|
+
getAzureProjects(connectionId: string, organizationId: string): Promise<CodegenAzureProject[]>;
|
|
93
|
+
/**
|
|
94
|
+
* Fetches Azure repositories
|
|
95
|
+
* @param connectionId
|
|
96
|
+
* @param organizationId
|
|
97
|
+
* @param projectId
|
|
98
|
+
* @returns Azure repositories
|
|
99
|
+
*/
|
|
100
|
+
getAzureRepositories(connectionId: string, organizationId: string, projectId: string): Promise<CodegenAzureRepository[]>;
|
|
101
|
+
/**
|
|
102
|
+
* Fetches Azure branches
|
|
103
|
+
* @param connectionId
|
|
104
|
+
* @param organizationId
|
|
105
|
+
* @param projectId
|
|
106
|
+
* @param repositoryId
|
|
107
|
+
* @returns Azure branches
|
|
108
|
+
*/
|
|
109
|
+
getAzureBranches(connectionId: string, organizationId: string, projectId: string, repositoryId: string): Promise<CodegenGitlabBranch[]>;
|
|
110
|
+
/**
|
|
111
|
+
* Fetches all Bitbucket connections for user
|
|
112
|
+
* @returns Bitbucket Connections
|
|
113
|
+
*/
|
|
114
|
+
getBitbucketConnections(): Promise<CodegenConnection[]>;
|
|
115
|
+
/**
|
|
116
|
+
* Fetches Bitbucket workspaces
|
|
117
|
+
* @param connectionId
|
|
118
|
+
* @returns Bitbucket workspaces
|
|
119
|
+
*/
|
|
120
|
+
getBitbucketWorkspaces(connectionId: string): Promise<CodegenBitbucketWorkspace[]>;
|
|
121
|
+
/**
|
|
122
|
+
* Fetches Bitbucket projects
|
|
123
|
+
* @param connectionId
|
|
124
|
+
* @param workspaceId
|
|
125
|
+
* @returns Bitbucket projects
|
|
126
|
+
*/
|
|
127
|
+
getBitbucketProjects(connectionId: string, workspaceId: string): Promise<CodegenBitbucketProject[]>;
|
|
128
|
+
/**
|
|
129
|
+
* Fetches Bitbucket repositories
|
|
130
|
+
* @param connectionId
|
|
131
|
+
* @param workspaceId
|
|
132
|
+
* @param projectId
|
|
133
|
+
* @returns Bitbucket repositories
|
|
134
|
+
*/
|
|
135
|
+
getBitbucketRepositories(connectionId: string, workspaceId: string, projectId?: string): Promise<CodegenBitbucketRepository[]>;
|
|
136
|
+
/**
|
|
137
|
+
* Fetches Bitbucket branches
|
|
138
|
+
* @param connectionId
|
|
139
|
+
* @param workspaceId
|
|
140
|
+
* @param projectId
|
|
141
|
+
* @param repositoryId
|
|
142
|
+
* @returns Bitbucket branches
|
|
143
|
+
*/
|
|
144
|
+
getBitbucketBranches(connectionId: string, workspaceId: string, projectId: string, repositoryId: string): Promise<CodegenBitbucketBranch[]>;
|
|
145
|
+
/** Fetches all builds of pipelines
|
|
146
|
+
* @param workspaceId - Identifier of the workspace where the pipeline is installed
|
|
147
|
+
* @param versionId - Identifier of the version where the pipeline is installed
|
|
148
|
+
*/
|
|
149
|
+
getExportBuilds(workspaceId: string, versionId: string): Promise<Array<ExportBuild>>;
|
|
150
|
+
/** Fetches build logs of a specific build
|
|
151
|
+
* @param workspaceId - Identifier of the workspace where the pipeline is installed
|
|
152
|
+
* @param buildId - Identifier of the build to fetch logs for
|
|
153
|
+
*/
|
|
154
|
+
getExportBuildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLog>>;
|
|
155
|
+
/** Fetches exporters belonging to workspace by id */
|
|
156
|
+
getExporters(workspaceId: string, filter?: {
|
|
157
|
+
installedOnly?: boolean;
|
|
158
|
+
}): Promise<Array<Exporter>>;
|
|
159
|
+
/** Updates exporter
|
|
160
|
+
* @param workspaceId - Identifier of the workspace where the exporter is installed
|
|
161
|
+
* @param exporterId - Identifier of the exporter to update
|
|
162
|
+
* @param payload - Payload to update exporter with
|
|
163
|
+
*/
|
|
164
|
+
updateExporter(workspaceId: string, exporterId: string, payload: NewExporterPayload): Promise<Exporter>;
|
|
165
|
+
/** Updates exporter configuration property value
|
|
166
|
+
* @param designSystemId
|
|
167
|
+
* @param exporterId
|
|
168
|
+
* @param propertyKey
|
|
169
|
+
* @param propertyValue
|
|
170
|
+
*/
|
|
171
|
+
updateExporterConfigurationPropertyValue(designSystemId: string, exporterId: string, propertyKey: string, propertyValue: any): Promise<void>;
|
|
172
|
+
/** Deletes exporter configuration property value
|
|
173
|
+
* @param designSystemId
|
|
174
|
+
* @param exporterId
|
|
175
|
+
* @param propertyKey
|
|
176
|
+
*/
|
|
177
|
+
deleteExporterConfigurationPropertyValue(designSystemId: string, exporterId: string, propertyKey: string): Promise<void>;
|
|
178
|
+
/** Deletes exporter
|
|
179
|
+
* @param workspaceId - Identifier of the workspace where the exporter is installed
|
|
180
|
+
* @param exporterId - Identifier of the exporter to delete
|
|
181
|
+
*/
|
|
182
|
+
deleteExporter(workspaceId: string, exporterId: string): Promise<void>;
|
|
183
|
+
/** Pulls latest version of exporter from remote repository
|
|
184
|
+
* @param workspaceId - Identifier of the workspace where the exporter is installed
|
|
185
|
+
* @param exporterId - Identifier of the exporter to pull
|
|
186
|
+
*/
|
|
187
|
+
pullLatestExporter(workspaceId: string, exporterId: string): Promise<Exporter>;
|
|
188
|
+
/** Fetches all custom configuration properties that specific exporter provides
|
|
189
|
+
* @param exporterId - Identifier of the exporter to fetch configuration for
|
|
190
|
+
* @param from - Remote version to fetch from
|
|
191
|
+
* @returns All custom blocks
|
|
192
|
+
*/
|
|
193
|
+
getExporterConfiguration(workspaceId: string, exporterId: string, designSystemId: string): Promise<Array<ExporterConfigurationProperty>>;
|
|
194
|
+
/** Fetches all custom variants that specific exporter provides
|
|
195
|
+
* @param workspaceId - Identifier of the workspace where the exporter is installed
|
|
196
|
+
* @param exporterId - Identifier of the exporter to fetch configuration for
|
|
197
|
+
* @returns All custom variants
|
|
198
|
+
*/
|
|
199
|
+
getExporterBlockVariants(workspaceId: string, exporterId: string): Promise<Array<ExporterCustomBlockVariant>>;
|
|
200
|
+
/** Gets all import jobs that are currently in progress.
|
|
201
|
+
* @param userId - User id to delete integration for. Can only be invoked on user id that is currently authenticated.
|
|
202
|
+
* @returns Nothing
|
|
203
|
+
*/
|
|
204
|
+
getImportJobs(from: RemoteVersionIdentifier): Promise<Array<ImportJob>>;
|
|
205
|
+
getImportJob(from: RemoteVersionIdentifier, jobId: string): Promise<ImportJob>;
|
|
206
|
+
scheduleImportJobForFigmaSources(from: RemoteVersionIdentifier, sourceIds: Array<string>, dryRun?: boolean): Promise<ImportJob>;
|
|
207
|
+
/** Create pipeline
|
|
208
|
+
* @param workspaceId string
|
|
209
|
+
* @param pipeline Pipeline
|
|
210
|
+
* @returns Pipeline
|
|
211
|
+
*/
|
|
212
|
+
createPipeline(workspaceId: string, pipeline: NewPipelinePayload): Promise<Pipeline>;
|
|
213
|
+
/** Update pipeline
|
|
214
|
+
* @param workspaceId string
|
|
215
|
+
* @param pipeline Pipeline
|
|
216
|
+
* @returns Pipeline
|
|
217
|
+
*/
|
|
218
|
+
updatePipeline(workspaceId: string, pipelineUpdateModel: PipelineUpdateModel): Promise<Pipeline>;
|
|
219
|
+
/**
|
|
220
|
+
* Run pipeline
|
|
221
|
+
* @param workspaceId string
|
|
222
|
+
* @param designSystemVersionId string
|
|
223
|
+
* @param pipelineId string
|
|
224
|
+
*/
|
|
225
|
+
runPipeline(workspaceId: string, designSystemVersionId: string, pipelineId: string): Promise<Pipeline>;
|
|
226
|
+
/** Create exporter
|
|
227
|
+
* @param workspaceId string
|
|
228
|
+
* @param payload NewExporterPayload
|
|
229
|
+
* @returns Exporter
|
|
230
|
+
*/
|
|
231
|
+
createExporter(workspaceId: string, payload: NewExporterPayload): Promise<Exporter>;
|
|
232
|
+
deletePipeline(workspaceId: string, pipelineId: string): Promise<void>;
|
|
233
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { Brand, BrandUpdateModel } from "../../model/base/SDKBrand";
|
|
2
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
3
|
+
import { RemoteBrandIdentifier, RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
4
|
+
export declare class AreaBrands {
|
|
5
|
+
/** Internal: Engine */
|
|
6
|
+
private dataCore;
|
|
7
|
+
constructor(dataCore: DataCore);
|
|
8
|
+
/** Fetches all remote brands in the version
|
|
9
|
+
* @param from - Remote version to fetch from
|
|
10
|
+
* @returns All brands in the specified version
|
|
11
|
+
*/
|
|
12
|
+
getBrands(from: RemoteVersionIdentifier): Promise<Array<Brand>>;
|
|
13
|
+
/** Fetches a single brand
|
|
14
|
+
* @param from - Remote brand to fetch from
|
|
15
|
+
* @returns Brand in the specified version
|
|
16
|
+
*/
|
|
17
|
+
getBrand(from: RemoteBrandIdentifier): Promise<Brand>;
|
|
18
|
+
/** Creates new brand and retrieves the newly created brand object.
|
|
19
|
+
* @param from - Remote brand to fetch from
|
|
20
|
+
* @param model - new brand model
|
|
21
|
+
* @returns Newly created brand object
|
|
22
|
+
*/
|
|
23
|
+
createBrand(from: RemoteVersionIdentifier, model: BrandUpdateModel): Promise<Brand>;
|
|
24
|
+
/** Edits brand
|
|
25
|
+
* @param from - Remote brand to fetch from
|
|
26
|
+
* @param model - new version model
|
|
27
|
+
* @returns nothing
|
|
28
|
+
*/
|
|
29
|
+
editBrand(from: RemoteBrandIdentifier, brand: Brand): Promise<void>;
|
|
30
|
+
/** Deletes brand
|
|
31
|
+
* @param from - Remote brand to fetch from
|
|
32
|
+
* @returns nothing
|
|
33
|
+
*/
|
|
34
|
+
deleteBrand(from: RemoteBrandIdentifier): Promise<void>;
|
|
35
|
+
}
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import { Component } from "../../model/components/SDKComponent";
|
|
2
|
+
import { ElementProperty } from "../../model/elements/SDKElementProperty";
|
|
3
|
+
import { TokenGroup } from "../../model/groups/SDKTokenGroup";
|
|
4
|
+
import { ImportJob } from "../../model/jobs/SDKImportJob";
|
|
5
|
+
import { TokenThemeOverrideTranserObject } from "../../model/themes/SDKTokenThemeOverride";
|
|
6
|
+
import { AnyToken } from "../../model/tokens/SDKTokenValue";
|
|
7
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
8
|
+
import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
9
|
+
export type TokenUpdateTransactionData = {
|
|
10
|
+
token: AnyToken;
|
|
11
|
+
tokenParent: TokenGroup;
|
|
12
|
+
tokenMode: "create" | "update";
|
|
13
|
+
propertyValuesToCreateOrUpdate?: Array<{
|
|
14
|
+
property: ElementProperty;
|
|
15
|
+
value: string | boolean | number;
|
|
16
|
+
}>;
|
|
17
|
+
propertyValuesToDelete?: Array<string>;
|
|
18
|
+
themeValuesToCreate?: Array<{
|
|
19
|
+
themeId: string;
|
|
20
|
+
themeOverrideTransferObject: TokenThemeOverrideTranserObject;
|
|
21
|
+
}>;
|
|
22
|
+
themeValuesToUpdate?: Array<{
|
|
23
|
+
themeId: string;
|
|
24
|
+
themeOverrideTransferObject: TokenThemeOverrideTranserObject;
|
|
25
|
+
}>;
|
|
26
|
+
themeValuesToDelete?: Array<string>;
|
|
27
|
+
};
|
|
28
|
+
export type ComponentUpdateTransactionData = {
|
|
29
|
+
component: Component;
|
|
30
|
+
componentMode: "create" | "update";
|
|
31
|
+
propertyValuesToCreateOrUpdate?: Array<{
|
|
32
|
+
property: ElementProperty;
|
|
33
|
+
value: string | boolean | number;
|
|
34
|
+
}>;
|
|
35
|
+
propertyValuesToDelete?: Array<string>;
|
|
36
|
+
};
|
|
37
|
+
export declare class AreaBulkOperations {
|
|
38
|
+
/** Internal: Engine */
|
|
39
|
+
private dataCore;
|
|
40
|
+
constructor(dataCore: DataCore);
|
|
41
|
+
/** Import tokens in bulk using new import routine
|
|
42
|
+
*
|
|
43
|
+
* @param designSystemId - Remote design system to write to
|
|
44
|
+
* @param brandId - Remote brand to write to
|
|
45
|
+
* @param sourceName - Name of the source, such as Figma file name
|
|
46
|
+
* @param sourceId - Unique ID of the source, such as Figma file id
|
|
47
|
+
* @param sourceType - Source from which import originates. Currently only "FigmaVariablesPlugin" is supported
|
|
48
|
+
* @param payload - Payload to import. Types to come
|
|
49
|
+
* @returns Nothing
|
|
50
|
+
*/
|
|
51
|
+
importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", payload: any): Promise<ImportJob>;
|
|
52
|
+
/** Batch updates, creates or deletes token data from Supernova at once. Use this method to perform multiple operations at once instead of chaining single update operations. Batch routine runs everything in a single transaction, so either all operations succeed or all fail.
|
|
53
|
+
*
|
|
54
|
+
* WARNING: This method is not yet complete and only supports limited set of operations. Also, doesn't work as transation just yet.
|
|
55
|
+
* @param to - Remote version to write to
|
|
56
|
+
* @param data - Update information. All keys except token and its parent are optional and any combination of optional properties is allowed.
|
|
57
|
+
* @returns Nothing
|
|
58
|
+
*/
|
|
59
|
+
updateTokenData(to: RemoteVersionIdentifier, data: TokenUpdateTransactionData): Promise<void>;
|
|
60
|
+
/** Batch updates, creates or deletes component data from Supernova at once. Use this method to perform multiple operations at once instead of chaining single update operations. Batch routine runs everything in a single transaction, so either all operations succeed or all fail.
|
|
61
|
+
*
|
|
62
|
+
* WARNING: This method is not yet complete and only supports limited set of operations. Also, doesn't work as transation just yet.
|
|
63
|
+
* @param to - Remote version to write to
|
|
64
|
+
* @param data - Update information. All keys except component and its parent are optional and any combination of optional properties is allowed.
|
|
65
|
+
* @returns Nothing
|
|
66
|
+
*/
|
|
67
|
+
updateComponentData(to: RemoteVersionIdentifier, data: ComponentUpdateTransactionData): Promise<void>;
|
|
68
|
+
}
|