@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,46 @@
|
|
|
1
|
+
import { DTOFigmaNode } from "@supernova-studio/client";
|
|
2
|
+
import { DocsImageRef, ResourceAsset, ResourceFont } from "../../exports";
|
|
3
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
4
|
+
import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
5
|
+
export declare class AreaResources {
|
|
6
|
+
/** Internal: Engine */
|
|
7
|
+
private dataCore;
|
|
8
|
+
constructor(dataCore: DataCore);
|
|
9
|
+
/** Fetches all remote asset resources in the version
|
|
10
|
+
* @param from - Remote version to fetch from
|
|
11
|
+
* @returns All image resources in the specified version
|
|
12
|
+
*/
|
|
13
|
+
getAssetResources(from: RemoteVersionIdentifier): Promise<Array<ResourceAsset>>;
|
|
14
|
+
/** Fetches all remote font resources in the version
|
|
15
|
+
* @param from - Remote version to fetch from
|
|
16
|
+
* @returns All font resources in the specified version
|
|
17
|
+
*/
|
|
18
|
+
getFontResources(from: RemoteVersionIdentifier): Promise<Array<ResourceFont>>;
|
|
19
|
+
/** Fetches all Figma frames that were rendered font resources in the version
|
|
20
|
+
* @param from - Remote version to fetch from
|
|
21
|
+
* @returns All font resources in the specified version
|
|
22
|
+
*/
|
|
23
|
+
getFigmaFrames(from: RemoteVersionIdentifier): Promise<Array<DTOFigmaNode>>;
|
|
24
|
+
/**
|
|
25
|
+
* @param from - Remote version to fetch from
|
|
26
|
+
* @param frameReferenceId - Unique stable identifier of the Figma frame (Supernova id, not Figma id)
|
|
27
|
+
* @returns URL of the hosted image of the Figma frame that is stable across updates
|
|
28
|
+
*/
|
|
29
|
+
getFigmaFrameHostedUrl(from: RemoteVersionIdentifier, frameReferenceId: string): string;
|
|
30
|
+
/** Retrieves stable URL
|
|
31
|
+
* @param from - Remote version to fetch from
|
|
32
|
+
* @param frameReferenceId - Unique stable identifier of the Figma frame (Supernova id, not Figma id)
|
|
33
|
+
* @returns URL of the hosted image resource, either uploaded file or Figma frame
|
|
34
|
+
*/
|
|
35
|
+
getImageRefHostedUrl(from: RemoteVersionIdentifier, imageRef: DocsImageRef | undefined): string | undefined;
|
|
36
|
+
/** Uploads new asset resource */
|
|
37
|
+
uploadAssetResource(from: RemoteVersionIdentifier, asset: File): Promise<ResourceAsset>;
|
|
38
|
+
/** Uploads new font resource */
|
|
39
|
+
uploadFontResource(from: RemoteVersionIdentifier, font: File): Promise<ResourceFont | null>;
|
|
40
|
+
/** Uploads new font resources */
|
|
41
|
+
uploadFontResources(from: RemoteVersionIdentifier, fonts: FileList): Promise<ResourceFont[]>;
|
|
42
|
+
/** Deletes single resource of any type */
|
|
43
|
+
deleteResource(from: RemoteVersionIdentifier, resourceId: string): Promise<void>;
|
|
44
|
+
/** Deletes multiple resource of any type */
|
|
45
|
+
deleteResources(from: RemoteVersionIdentifier, resourceIds: string[]): Promise<void>;
|
|
46
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
2
|
+
export declare class AreaStorage {
|
|
3
|
+
/** Internal: Engine */
|
|
4
|
+
private dataCore;
|
|
5
|
+
constructor(dataCore: DataCore);
|
|
6
|
+
/** Read data from key-value storage
|
|
7
|
+
* @param designSystemId - Design system ID to read the data from
|
|
8
|
+
* @param key - Unique data key to read
|
|
9
|
+
*/
|
|
10
|
+
readKeyValueStorageData(designSystemId: string, key: string): Promise<string | object | null>;
|
|
11
|
+
/** Set data to key-value storage. Limit of 20mb per a design system.
|
|
12
|
+
* @param designSystemId - Design system ID to store data for
|
|
13
|
+
* @param key - Unique data key under which the data will be stored
|
|
14
|
+
* @param value - String or object to be stored. Anything else must be converted to JSON string first
|
|
15
|
+
* @returns Nothing
|
|
16
|
+
*/
|
|
17
|
+
setKeyValueStorageData(designSystemId: string, key: string, value: string | object): Promise<void>;
|
|
18
|
+
/** Unsets the data from key-value storage based on the key name
|
|
19
|
+
* @param designSystemId - Design system ID to remove the data from
|
|
20
|
+
* @param key - Unique data key to delete
|
|
21
|
+
*/
|
|
22
|
+
unsetKeyValueStorageData(designSystemId: string, key: string): Promise<void>;
|
|
23
|
+
}
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
import { BlurToken, BlurType, BorderPosition, BorderStyle, BorderToken, GradientToken, GradientType, OpacityToken, RadiusToken, ShadowToken, ShadowType, TextCaseToken, TextDecorationToken, TokenTheme, TypographyToken, VisibilityToken } from "../../exports";
|
|
2
|
+
import { ColorToken } from "../../model/tokens/SDKColorToken";
|
|
3
|
+
import { BorderWidthToken, DimensionToken, DurationToken, FontSizeToken, LetterSpacingToken, LineHeightToken, ParagraphSpacingToken, SizeToken, SpaceToken, ZIndexToken } from "../../model/tokens/SDKDimensionToken";
|
|
4
|
+
import { FontFamilyToken, FontWeightToken, ProductCopyToken, StringToken } from "../../model/tokens/SDKStringToken";
|
|
5
|
+
import { AnyMultiLayerToken, AnySingleLayerToken, AnyToken, BorderWidthTokenValue, ColorTokenValue, ColorValue, DimensionTokenValue, DurationTokenValue, FontFamilyTokenValue, FontSizeTokenValue, FontWeightTokenValue, LetterSpacingTokenValue, LineHeightTokenValue, OpacityTokenValue, ParagraphSpacingTokenValue, ProductCopyTokenValue, RadiusTokenValue, RawValue, SizeTokenValue, SpaceTokenValue, StringTokenValue, TextCaseTokenValue, TextDecorationTokenValue, VisibilityTokenValue, ZIndexTokenValue } from "../../model/tokens/SDKTokenValue";
|
|
6
|
+
export declare class AreaTokenValues {
|
|
7
|
+
/** Creates a new theme with updated overrides */
|
|
8
|
+
tokenThemeByUpdatingOverride(theme: TokenTheme, override: AnyToken): TokenTheme;
|
|
9
|
+
/** Creates a new theme with removed override */
|
|
10
|
+
tokenThemeByRemovingOverride(theme: TokenTheme, tokenId: string): TokenTheme;
|
|
11
|
+
/** Creates a new color token with updated .color value */
|
|
12
|
+
colorTokenByUpdatingColor(token: ColorToken, newValue: ColorValue | ColorToken): ColorToken;
|
|
13
|
+
/** Creates a new color token with updated .opacity value */
|
|
14
|
+
colorTokenByUpdatingOpacity(token: ColorToken, newValue: number | OpacityToken): ColorToken;
|
|
15
|
+
/** Creates a new blur token with updated .type value */
|
|
16
|
+
blurTokenByUpdatingType(token: BlurToken, newValue: BlurType): BlurToken;
|
|
17
|
+
/** Creates a new blur token with updated .radius value */
|
|
18
|
+
blurTokenByUpdatingRadius(token: BlurToken, newValue: RawValue<DimensionTokenValue> | RadiusToken): BlurToken;
|
|
19
|
+
/** Creates a new typography token with updated .fontFamily value */
|
|
20
|
+
typographyTokenByUpdatingFontFamily(token: TypographyToken, newValue: RawValue<FontFamilyTokenValue> | FontFamilyToken): TypographyToken;
|
|
21
|
+
/** Creates a new typography token with updated .fontWeight value */
|
|
22
|
+
typographyTokenByUpdatingFontWeight(token: TypographyToken, newValue: RawValue<FontWeightTokenValue> | FontWeightToken): TypographyToken;
|
|
23
|
+
/** Creates a new typography token with updated .fontSize value */
|
|
24
|
+
typographyTokenByUpdatingFontSize(token: TypographyToken, newValue: RawValue<FontSizeTokenValue> | FontSizeToken): TypographyToken;
|
|
25
|
+
/** Creates a new typography token with updated .letterSpacing value */
|
|
26
|
+
typographyTokenByUpdatingLetterSpacing(token: TypographyToken, newValue: RawValue<LetterSpacingTokenValue> | LetterSpacingToken): TypographyToken;
|
|
27
|
+
/** Creates a new typography token with updated .lineHeight value */
|
|
28
|
+
typographyTokenByUpdatingLineHeight(token: TypographyToken, newValue: RawValue<LineHeightTokenValue> | LineHeightToken): TypographyToken;
|
|
29
|
+
/** Creates a new typography token with updated .paragraphSpacing value */
|
|
30
|
+
typographyTokenByUpdatingParagraphSpacing(token: TypographyToken, newValue: RawValue<ParagraphSpacingTokenValue> | ParagraphSpacingToken): TypographyToken;
|
|
31
|
+
/** Creates a new typography token with updated .paragraphSpacing value */
|
|
32
|
+
typographyTokenByUpdatingParagraphIndent(token: TypographyToken, newValue: RawValue<ParagraphSpacingTokenValue> | ParagraphSpacingToken): TypographyToken;
|
|
33
|
+
/** Creates a new border token with updated .position value */
|
|
34
|
+
typographyTokenByUpdatingTextDecoration(token: TypographyToken, newValue: RawValue<TextDecorationTokenValue> | TextDecorationToken): TypographyToken;
|
|
35
|
+
/** Creates a new typography token with updated .textCase value */
|
|
36
|
+
typographyTokenByUpdatingTextCase(token: TypographyToken, newValue: RawValue<TextCaseTokenValue> | TextCaseToken): TypographyToken;
|
|
37
|
+
/** Creates a new border token with updated .color value. Do note, opacity is ignored */
|
|
38
|
+
borderTokenByUpdatingColor(token: BorderToken, newValue: ColorValue | ColorToken): BorderToken;
|
|
39
|
+
/** Creates a new border token with updated color.opacity value */
|
|
40
|
+
borderTokenByUpdatingOpacity(token: BorderToken, newValue: number | OpacityToken): BorderToken;
|
|
41
|
+
/** Creates a new border token with updated .width value */
|
|
42
|
+
borderTokenByUpdatingWidth(token: BorderToken, newValue: RawValue<BorderWidthTokenValue> | BorderWidthToken): BorderToken;
|
|
43
|
+
/** Creates a new border token with updated .position value */
|
|
44
|
+
borderTokenByUpdatingPosition(token: BorderToken, newValue: BorderPosition): BorderToken;
|
|
45
|
+
/** Creates a new border token with updated .style value */
|
|
46
|
+
borderTokenByUpdatingStyle(token: BorderToken, newValue: BorderStyle): BorderToken;
|
|
47
|
+
/** Creates a new dimension token with updated value */
|
|
48
|
+
dimensionTokenByUpdatingValue(token: DimensionToken, newValue: RawValue<DimensionTokenValue>): DimensionToken;
|
|
49
|
+
/** Creates a new size token with updated value */
|
|
50
|
+
sizeTokenByUpdatingValue(token: SizeToken, newValue: RawValue<SizeTokenValue>): SizeToken;
|
|
51
|
+
/** Creates a new space token with updated value */
|
|
52
|
+
spaceTokenByUpdatingValue(token: SpaceToken, newValue: RawValue<SpaceTokenValue>): SpaceToken;
|
|
53
|
+
/** Creates a new opacity token with updated value */
|
|
54
|
+
opacityTokenByUpdatingValue(token: OpacityToken, newValue: RawValue<OpacityTokenValue>): OpacityToken;
|
|
55
|
+
/** Creates a new font size token with updated value */
|
|
56
|
+
fontSizeTokenByUpdatingValue(token: FontSizeToken, newValue: RawValue<FontSizeTokenValue>): FontSizeToken;
|
|
57
|
+
/** Creates a new font size token with updated value */
|
|
58
|
+
lineHeightTokenByUpdatingValue(token: LineHeightToken, newValue: RawValue<LineHeightTokenValue>): LineHeightToken;
|
|
59
|
+
/** Creates a new letter spacing token with updated value */
|
|
60
|
+
letterSpacingTokenByUpdatingValue(token: LetterSpacingToken, newValue: RawValue<LetterSpacingTokenValue>): LetterSpacingToken;
|
|
61
|
+
/** Creates a new paragraph spacing token with updated value */
|
|
62
|
+
paragraphSpacingTokenByUpdatingValue(token: ParagraphSpacingToken, newValue: RawValue<ParagraphSpacingTokenValue>): ParagraphSpacingToken;
|
|
63
|
+
/** Creates a new border width token with updated value */
|
|
64
|
+
borderWidthTokenByUpdatingValue(token: BorderWidthToken, newValue: RawValue<BorderWidthTokenValue>): BorderWidthToken;
|
|
65
|
+
/** Creates a new radius token with updated value */
|
|
66
|
+
radiusTokenByUpdatingValue(token: RadiusToken, newValue: RawValue<RadiusTokenValue>): RadiusToken;
|
|
67
|
+
/** Creates a new duration token with updated value */
|
|
68
|
+
durationTokenByUpdatingValue(token: DurationToken, newValue: RawValue<DurationTokenValue>): DurationToken;
|
|
69
|
+
/** Creates a new z-index token with updated value */
|
|
70
|
+
zIndexTokenByUpdatingValue(token: ZIndexToken, newValue: RawValue<ZIndexTokenValue>): ZIndexToken;
|
|
71
|
+
/** Creates a new string token with updated value */
|
|
72
|
+
stringTokenByUpdatingValue(token: StringToken, newValue: RawValue<StringTokenValue>): StringToken;
|
|
73
|
+
/** Creates a new product copy token with updated value */
|
|
74
|
+
productCopyTokenByUpdatingValue(token: ProductCopyToken, newValue: RawValue<ProductCopyTokenValue>): ProductCopyToken;
|
|
75
|
+
/** Creates a new font family token with updated value */
|
|
76
|
+
fontFamilyTokenByUpdatingValue(token: FontFamilyToken, newValue: RawValue<FontFamilyTokenValue>): FontFamilyToken;
|
|
77
|
+
/** Creates a new font weight token with updated value */
|
|
78
|
+
fontWeightTokenByUpdatingValue(token: FontWeightToken, newValue: RawValue<FontWeightTokenValue>): FontWeightToken;
|
|
79
|
+
/** Creates a new text case token with updated value */
|
|
80
|
+
textCaseTokenByUpdatingValue(token: TextCaseToken, newValue: RawValue<TextCaseTokenValue>): TextCaseToken;
|
|
81
|
+
/** Creates a new text case token with updated value */
|
|
82
|
+
textDecorationTokenByUpdatingValue(token: TextDecorationToken, newValue: RawValue<TextDecorationTokenValue>): TextDecorationToken;
|
|
83
|
+
/** Creates a new visibility token with updated value */
|
|
84
|
+
visibilityTokenByUpdatingValue(token: VisibilityToken, newValue: RawValue<VisibilityTokenValue>): VisibilityToken;
|
|
85
|
+
/** Creates a new shadow token with one new extra layer added at the end of all layers */
|
|
86
|
+
shadowTokenByAddingLayer(token: ShadowToken): ShadowToken;
|
|
87
|
+
/** Creates a new shadow token by removing one of the layers */
|
|
88
|
+
shadowTokenByRemovingLayer(token: ShadowToken, layerIndex: number): ShadowToken;
|
|
89
|
+
/** Creates a new shadow token with updated .color value. Do note, opacity is ignored */
|
|
90
|
+
shadowTokenByUpdatingColor(token: ShadowToken, layerIndex: number, newValue: ColorValue | ColorToken): ShadowToken;
|
|
91
|
+
/** Creates a new shadow token with updated .color value */
|
|
92
|
+
shadowTokenByUpdatingOpacity(token: ShadowToken, layerIndex: number, newValue: number | OpacityToken): ShadowToken;
|
|
93
|
+
/** Creates a new shadow token with updated .x value */
|
|
94
|
+
shadowTokenByUpdatingX(token: ShadowToken, layerIndex: number, newValue: number): ShadowToken;
|
|
95
|
+
/** Creates a new shadow token with updated .y value */
|
|
96
|
+
shadowTokenByUpdatingY(token: ShadowToken, layerIndex: number, newValue: number): ShadowToken;
|
|
97
|
+
/** Creates a new shadow token with updated .radius value */
|
|
98
|
+
shadowTokenByUpdatingRadius(token: ShadowToken, layerIndex: number, newValue: number): ShadowToken;
|
|
99
|
+
/** Creates a new shadow token with updated .spread value */
|
|
100
|
+
shadowTokenByUpdatingSpread(token: ShadowToken, layerIndex: number, newValue: number): ShadowToken;
|
|
101
|
+
/** Creates a new shadow token with updated .type value */
|
|
102
|
+
shadowTokenByUpdatingType(token: ShadowToken, layerIndex: number, newValue: ShadowType): ShadowToken;
|
|
103
|
+
/** Creates a new gradient token with updated .to value */
|
|
104
|
+
gradientTokenByUpdatingTo(token: GradientToken, layerIndex: number, newValue: {
|
|
105
|
+
x: number;
|
|
106
|
+
y: number;
|
|
107
|
+
}): GradientToken;
|
|
108
|
+
/** Creates a new gradient token with updated .from value */
|
|
109
|
+
gradientTokenByUpdatingFrom(token: GradientToken, layerIndex: number, newValue: {
|
|
110
|
+
x: number;
|
|
111
|
+
y: number;
|
|
112
|
+
}): GradientToken;
|
|
113
|
+
/** Creates a new gradient token with updated .to value */
|
|
114
|
+
gradientTokenByUpdatingType(token: GradientToken, layerIndex: number, newValue: GradientType): GradientToken;
|
|
115
|
+
/** Creates a new gradient token with updated .aspectRatio value */
|
|
116
|
+
gradientTokenByUpdatingAspectRatio(token: GradientToken, layerIndex: number, newValue: number): GradientToken;
|
|
117
|
+
/** Creates a new gradient token with updated .to value */
|
|
118
|
+
gradientTokenByUpdatingStops(token: GradientToken, layerIndex: number, newValue: Array<{
|
|
119
|
+
position: number;
|
|
120
|
+
color: ColorTokenValue | ColorToken;
|
|
121
|
+
}>): GradientToken;
|
|
122
|
+
/** Creates a new token where value is reference to the provided token. Token and reference must be of the same type */
|
|
123
|
+
tokenByReferencing<T extends AnyToken>(token: T, reference: T): T;
|
|
124
|
+
/** Creates a new multilayer token where one of the layers is reference to the provided token. Token and reference must be of the same type */
|
|
125
|
+
multilayerTokenByReferencing<T extends AnyMultiLayerToken, R extends T>(token: T, layerIndex: number, reference: R): T;
|
|
126
|
+
/** Creates a new token where value is raw, but taken from the previously referenced token. Token must have had reference before */
|
|
127
|
+
tokenByDisconnectingReference<T extends AnySingleLayerToken>(token: T): T;
|
|
128
|
+
/** Creates a new multilayer token where one of the layers value is raw, but taken from the previously referenced token. That layer must have had reference before */
|
|
129
|
+
multilayerTokenByDisconnectingReference<T extends AnySingleLayerToken>(token: T, layerIndex: number): T;
|
|
130
|
+
/** Checks if token as a whole is a reference to another token */
|
|
131
|
+
isReferencedToken(token: AnySingleLayerToken): boolean;
|
|
132
|
+
/** Checks if a token layer of multilayer token is a reference to another token */
|
|
133
|
+
isReferencedMultilayerTokenLayer(token: AnyMultiLayerToken, layerIndex: number): boolean;
|
|
134
|
+
/** Checks if a token was imported from some foreign source. Not imported tokens were always created in Supernova */
|
|
135
|
+
isTokenImported(token: AnyToken): boolean;
|
|
136
|
+
}
|
|
@@ -0,0 +1,225 @@
|
|
|
1
|
+
import { AnyToken } from "../../exports";
|
|
2
|
+
import { ElementDataView } from "../../model/elements/SDKElementDataView";
|
|
3
|
+
import { ElementDataViewColumn } from "../../model/elements/SDKElementDataViewColumn";
|
|
4
|
+
import { ElementProperty, ElementPropertyCreationModel, ElementPropertyUpdateModel } from "../../model/elements/SDKElementProperty";
|
|
5
|
+
import { ElementPropertyValue } from "../../model/elements/values/SDKElementPropertyValue";
|
|
6
|
+
import { TokenType } from "../../model/enums/SDKTokenType";
|
|
7
|
+
import { TokenGroup } from "../../model/groups/SDKTokenGroup";
|
|
8
|
+
import { TokenTheme } from "../../model/themes/SDKTokenTheme";
|
|
9
|
+
import { Token } from "../../model/tokens/SDKToken";
|
|
10
|
+
import { TokenTypeMapToken } from "../../utils/TokenUtils";
|
|
11
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
12
|
+
import { AreaTokenValues } from "./SDKAreaTokenValues";
|
|
13
|
+
import { RemoteBrandIdentifier, RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
14
|
+
export declare class AreaTokens {
|
|
15
|
+
/** Internal: Engine */
|
|
16
|
+
private dataCore;
|
|
17
|
+
/** Update helpers for everything token related */
|
|
18
|
+
values: AreaTokenValues;
|
|
19
|
+
constructor(dataCore: DataCore);
|
|
20
|
+
/** Fetches all remote tokens in the version
|
|
21
|
+
* @param from - Remote version to fetch from
|
|
22
|
+
* @param filter - Optional filter to apply. Multiple filters can be used at once
|
|
23
|
+
* @param filter.type - When provided, only tokens of the specified type will be returned
|
|
24
|
+
* @param filter.brandId - When provided, only tokens of the specified brand will be returned
|
|
25
|
+
* @returns Tokens in the specified version with filter applied
|
|
26
|
+
*/
|
|
27
|
+
getTokens(from: RemoteVersionIdentifier, filter?: {
|
|
28
|
+
type?: TokenType;
|
|
29
|
+
brandId?: string;
|
|
30
|
+
}): Promise<Array<Token>>;
|
|
31
|
+
/** Retrieves all occurances of the specified token in the version - its usages in other tokens, components and documentation pages
|
|
32
|
+
* @param from - Remote version to fetch from
|
|
33
|
+
* @param idInVersion - Token to check for references
|
|
34
|
+
* @returns Persistent identifiers of tokens, components, documentation pages that contain the specified token
|
|
35
|
+
*/
|
|
36
|
+
getTokenUsage(from: RemoteVersionIdentifier, idInVersion: string): Promise<{
|
|
37
|
+
tokens: Array<string>;
|
|
38
|
+
components: Array<string>;
|
|
39
|
+
documentationPages: Array<string>;
|
|
40
|
+
}>;
|
|
41
|
+
/** Fetches all remote token groups in this version
|
|
42
|
+
* @param from - Remote version to fetch from
|
|
43
|
+
* @param filter - Optional filter to apply. Multiple filters can be used at once
|
|
44
|
+
* @param filter.type - When provided, only token groups of the specified type will be returned
|
|
45
|
+
* @param filter.brandId - When provided, only token groups of the specified brand will be returned
|
|
46
|
+
* @returns Token groups in the specified version with filter applied
|
|
47
|
+
*/
|
|
48
|
+
getTokenGroups(from: RemoteVersionIdentifier, filter?: {
|
|
49
|
+
type?: TokenType;
|
|
50
|
+
brandId?: string;
|
|
51
|
+
}): Promise<Array<TokenGroup>>;
|
|
52
|
+
/** Fetches all remote themes in the version
|
|
53
|
+
* @param from - Remote version to fetch from
|
|
54
|
+
* @returns All themes in the specified version
|
|
55
|
+
*/
|
|
56
|
+
getTokenThemes(from: RemoteVersionIdentifier): Promise<Array<TokenTheme>>;
|
|
57
|
+
/** Retrieves all remote property definitions for tokens
|
|
58
|
+
* @param from - Remote version to fetch from
|
|
59
|
+
* @returns All property definitions in the specified version
|
|
60
|
+
*/
|
|
61
|
+
getTokenProperties(from: RemoteVersionIdentifier): Promise<Array<ElementProperty>>;
|
|
62
|
+
/** Retrieves all remote property definitions for tokens
|
|
63
|
+
* @param from - Remote version to fetch from
|
|
64
|
+
* @returns All property definitions in the specified version
|
|
65
|
+
*/
|
|
66
|
+
getTokenPropertyValues(from: RemoteVersionIdentifier): Promise<Array<ElementPropertyValue>>;
|
|
67
|
+
/** Retrieves all remote property views for tokens
|
|
68
|
+
* @param from - Remote version to fetch from
|
|
69
|
+
* @returns All property views in the specified version
|
|
70
|
+
*/
|
|
71
|
+
getTokenDataViews(from: RemoteVersionIdentifier): Promise<Array<ElementDataView>>;
|
|
72
|
+
/** Creates remote token. This method can only be used once per token and will assign persistent id to the token. Calling this version on token that already has id assigned will result in error
|
|
73
|
+
* @param to - Remote version to write to
|
|
74
|
+
* @param token - Token to create
|
|
75
|
+
* @param parentId - Id of the group to add the token to. This is id of the group, not the versioned id
|
|
76
|
+
* @returns New remote token ids
|
|
77
|
+
*/
|
|
78
|
+
createToken(to: RemoteVersionIdentifier, token: Token, parentId: string): Promise<{
|
|
79
|
+
id: string;
|
|
80
|
+
idInVersion: string;
|
|
81
|
+
}>;
|
|
82
|
+
/** Creates local token. This token doesn't have id associated with it on remote, and must be created once with `createToken` to be stored in design system
|
|
83
|
+
* @param tokenType - Type of token to create
|
|
84
|
+
* @returns New token of the specified type, filled with default values
|
|
85
|
+
*/
|
|
86
|
+
createLocalToken<T extends TokenType>(tokenType: T, versionId: string, brandId: string, properties: Array<ElementProperty>): TokenTypeMapToken[T];
|
|
87
|
+
/** Creates local token override. This theme override doesn't have id associated with it on remote, and must be created once with `createThemeOverride` to be stored in design system
|
|
88
|
+
* @param tokenType - Type of token to create
|
|
89
|
+
* @returns New token of the specified type, filled with default values
|
|
90
|
+
*/
|
|
91
|
+
createLocalThemeOverride<T extends AnyToken>(theme: TokenTheme, baseToken: T): T;
|
|
92
|
+
/** Creates remote token 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
|
|
93
|
+
* @param to - Remote version to write to
|
|
94
|
+
* @param group - Group to create
|
|
95
|
+
* @param parentId - Id of the group to add the group to. This is id of the group, not the versioned id
|
|
96
|
+
* @returns New remote token group ids
|
|
97
|
+
*/
|
|
98
|
+
createTokenGroup(to: RemoteVersionIdentifier, group: TokenGroup, parentId: string): Promise<{
|
|
99
|
+
id: string;
|
|
100
|
+
idInVersion: string;
|
|
101
|
+
}>;
|
|
102
|
+
/** Creates local token group. This group doesn't have id associated with it on remote, and must be created once with `createTokenGroup` to be stored in design system
|
|
103
|
+
* @param tokenType - Type of token to create the group for
|
|
104
|
+
* @param versionId - Id of the version to create the group in
|
|
105
|
+
* @param brandId - Id of the brand to create the group in
|
|
106
|
+
* @returns New group with id assigned
|
|
107
|
+
*/
|
|
108
|
+
createLocalTokenGroup(tokenType: TokenType, versionId: string, brandId: string): TokenGroup;
|
|
109
|
+
/** Updates remote token. This method can only be used on tokens that already exist in the version
|
|
110
|
+
* @param to - Remote version to write to
|
|
111
|
+
* @param token - Token to update
|
|
112
|
+
* @returns Nothing
|
|
113
|
+
*/
|
|
114
|
+
updateToken(to: RemoteVersionIdentifier, token: Token): Promise<void>;
|
|
115
|
+
/** Updates remote token groups. This method can only be used on token groups that already exist in the version
|
|
116
|
+
* @param to - Remote version to write to
|
|
117
|
+
* @param token - Token group to update
|
|
118
|
+
* @returns Nothing
|
|
119
|
+
*/
|
|
120
|
+
updateTokenGroup(to: RemoteVersionIdentifier, group: TokenGroup): Promise<void>;
|
|
121
|
+
/** Updates remote token property value. This also creates the property value if it doesn't exist
|
|
122
|
+
* @param to - Remote version to write to
|
|
123
|
+
* @param newValue - Value to set - this can be multiple things, from ID to raw string value to others
|
|
124
|
+
* @param forToken - Token to assign the value to
|
|
125
|
+
* @param forProperty - Property to assign the value to
|
|
126
|
+
*/
|
|
127
|
+
updateTokenPropertyValue(to: RemoteVersionIdentifier, newValue: string, forToken: Token, forProperty: ElementProperty): Promise<void>;
|
|
128
|
+
/** Deletes remote token property value
|
|
129
|
+
* @param to - Remote version to write to
|
|
130
|
+
* @param valueId - Value identifier
|
|
131
|
+
*/
|
|
132
|
+
deleteTokenPropertyValue(to: RemoteVersionIdentifier, valueId: string): Promise<void>;
|
|
133
|
+
/** Create token property
|
|
134
|
+
* @param to - Remote version to write to
|
|
135
|
+
* @param model - Property creation model to create the property from
|
|
136
|
+
*/
|
|
137
|
+
createTokenProperty(to: RemoteVersionIdentifier, model: ElementPropertyCreationModel): Promise<{
|
|
138
|
+
id: string;
|
|
139
|
+
idInVersion: string;
|
|
140
|
+
}>;
|
|
141
|
+
/** Update token property
|
|
142
|
+
* @param to - Remote version to write to
|
|
143
|
+
* @param propertyIdInVersion - Remote element property to update
|
|
144
|
+
* @param model - Property update model to apply to property
|
|
145
|
+
*/
|
|
146
|
+
updateTokenProperty(to: RemoteVersionIdentifier, propertyIdInVersion: string, model: ElementPropertyUpdateModel): Promise<void>;
|
|
147
|
+
/** Delete token property. This will remove all values associated with the property
|
|
148
|
+
* @param to - Remote version to write to
|
|
149
|
+
* @param propertyIdInVersion - Id of the property to delete
|
|
150
|
+
*/
|
|
151
|
+
deleteTokenProperty(to: RemoteVersionIdentifier, propertyIdInVersion: string): Promise<void>;
|
|
152
|
+
/** Resize specific token column
|
|
153
|
+
* @param to - Remote version to write to
|
|
154
|
+
* @param columnIdInVersion - Id of the column to update
|
|
155
|
+
* @param newWidth - New width of the column
|
|
156
|
+
*/
|
|
157
|
+
updateResizeTokenColumn(to: RemoteVersionIdentifier, view: ElementDataView, column: ElementDataViewColumn, newWidth: number): Promise<void>;
|
|
158
|
+
/** Move column to a new index and reorder all other columns around it
|
|
159
|
+
* @param to - Remote version to write to
|
|
160
|
+
* @param colum - Column object to move
|
|
161
|
+
* @param newIndex - New index to move the token to
|
|
162
|
+
*/
|
|
163
|
+
updateReorderTokenColumn(to: RemoteVersionIdentifier, view: ElementDataView, column: ElementDataViewColumn, newIndex: number): Promise<void>;
|
|
164
|
+
/** Creates local token theme. This group doesn't have id associated with it on remote, and must be created once with `createTokenTheme` to be stored in design system
|
|
165
|
+
* @param versionId - Id of the version to create the theme in
|
|
166
|
+
* @param brandId - Id of the brand to create the theme in
|
|
167
|
+
* @returns New group with id assigned
|
|
168
|
+
*/
|
|
169
|
+
createLocalTokenTheme(versionId: string, brandId: string): TokenTheme;
|
|
170
|
+
/** Creates remote token theme. This method can only be used once per theme and will assign persistent id to the theme. Calling this version on theme that already has id assigned will result in error
|
|
171
|
+
* @param to - Remote version to write to
|
|
172
|
+
* @param theme - Theme to create
|
|
173
|
+
* @returns New remote theme ids
|
|
174
|
+
*/
|
|
175
|
+
createTokenTheme(to: RemoteVersionIdentifier, theme: TokenTheme): Promise<{
|
|
176
|
+
id: string;
|
|
177
|
+
idInVersion: string;
|
|
178
|
+
}>;
|
|
179
|
+
/** Updates token theme. This method can only be used on themes that already exist in the version
|
|
180
|
+
* @param to - Remote version to write to
|
|
181
|
+
* @param theme - Token theme to update
|
|
182
|
+
* @returns Nothing
|
|
183
|
+
*/
|
|
184
|
+
updateTokenTheme(to: RemoteVersionIdentifier, theme: TokenTheme): Promise<void>;
|
|
185
|
+
/** Deletes remote token. Calling this method on token that doesn't exist in the version will result in error
|
|
186
|
+
* @param to - Remote version to write to
|
|
187
|
+
* @param tokenIdInVersion - Token idInVersion to delete
|
|
188
|
+
* @returns Nothing
|
|
189
|
+
*/
|
|
190
|
+
deleteToken(to: RemoteVersionIdentifier, tokenIdInVersion: string): Promise<void>;
|
|
191
|
+
/** Deletes remote token group. This method will also fix the token 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
|
|
192
|
+
* @param to - Remote version to write to
|
|
193
|
+
* @param tokenGroupIdInVersion - Token group idInVersion to delete
|
|
194
|
+
* @returns Nothing
|
|
195
|
+
*/
|
|
196
|
+
ungroupTokenGroup(to: RemoteVersionIdentifier, tokenGroupIdInVersion: string): Promise<void>;
|
|
197
|
+
/** Deletes remote token group and all its descendants. All items (groups and tokens) underneath will be deleted. Calling this method on group that doesn't exist in the version will result in error
|
|
198
|
+
* @param to - Remote version to write to
|
|
199
|
+
* @param tokenGroupToDelete - Token group to delete
|
|
200
|
+
* @param tokens - All available tokens
|
|
201
|
+
* @param tokenGroups - All available token groups
|
|
202
|
+
* @returns Nothing
|
|
203
|
+
*/
|
|
204
|
+
deleteTokenGroup(to: RemoteVersionIdentifier, tokenGroupToDelete: TokenGroup, tokens: Array<Token>, tokenGroups: Array<TokenGroup>): Promise<void>;
|
|
205
|
+
/** Deletes remote token theme. This method will also remove all theme overrides and disconnect theme from assigned column, all of which will be updated
|
|
206
|
+
* @param to - Remote version to write to
|
|
207
|
+
* @param idInVersion - Theme idInVersion to delete
|
|
208
|
+
* @returns Nothing
|
|
209
|
+
*/
|
|
210
|
+
deleteTokenTheme(to: RemoteVersionIdentifier, idInVersion: string): Promise<void>;
|
|
211
|
+
/** Warning: INTERNAL, DO NOT USE YET, NOT STABLE INTERFACE. Write tokens in bulk */
|
|
212
|
+
writeTokens(to: RemoteVersionIdentifier, tokens: Array<Token>, groups: Array<TokenGroup>, deleteTokens: Array<Token>, deleteTokenGroups: Array<TokenGroup>): Promise<void>;
|
|
213
|
+
/** Warning: INTERNAL, DO NOT USE YET, NOT STABLE INTERFACE. Write theme in bulk */
|
|
214
|
+
writeTheme(to: RemoteVersionIdentifier, theme: TokenTheme): Promise<void>;
|
|
215
|
+
/** Resolves tokens by applying themes to them and retrieves new token set where values correctly correspond to that theme */
|
|
216
|
+
computeTokensByApplyingThemes(tokens: Array<Token>, themes: Array<TokenTheme>): Promise<Array<Token>>;
|
|
217
|
+
/** Separates groups by types */
|
|
218
|
+
computeGroupTrees(groups: Array<TokenGroup>): Promise<Map<TokenType, Array<TokenGroup>>>;
|
|
219
|
+
/** Get determistic mocked token data. Must be used with mocked token groups */
|
|
220
|
+
getMockedTokens(from: RemoteBrandIdentifier): Promise<Array<Token>>;
|
|
221
|
+
/** Get determistic mocked token group data. Must be used with mocked tokens */
|
|
222
|
+
getMockedTokenGroups(from: RemoteBrandIdentifier): Promise<Array<TokenGroup>>;
|
|
223
|
+
/** Get determistic mocked token data views. Must be used with mocked tokens */
|
|
224
|
+
getMockedTokenDataViews(from: RemoteVersionIdentifier): Promise<Array<ElementDataView>>;
|
|
225
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { DesignSystemVersion, DesignSystemVersionUpdateModel } from "../../model/base/SDKDesignSystemVersion";
|
|
2
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
3
|
+
import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
4
|
+
export declare class AreaVersions {
|
|
5
|
+
/** Internal: Engine */
|
|
6
|
+
private dataCore;
|
|
7
|
+
constructor(dataCore: DataCore);
|
|
8
|
+
/** Fetches active design system version - the one to which all changes are being written currently. There is always one active version available for any provided design system. */
|
|
9
|
+
getActiveVersion(designSystemId: string): Promise<DesignSystemVersion | null>;
|
|
10
|
+
/** Creates new version and retrieves the newly created version object.
|
|
11
|
+
* @param designSystemId - ID of the design system
|
|
12
|
+
* @param model - new version model
|
|
13
|
+
* @returns Newly created version object
|
|
14
|
+
*/
|
|
15
|
+
createVersion(designSystemId: string, model: DesignSystemVersionUpdateModel): Promise<DesignSystemVersion>;
|
|
16
|
+
/** Edits version
|
|
17
|
+
* @param designSystemId - ID of the design system
|
|
18
|
+
* @param versionId - ID of version
|
|
19
|
+
* @param model - new version model
|
|
20
|
+
* @returns nothing
|
|
21
|
+
*/
|
|
22
|
+
editVersion(designSystemId: string, versionId: string, model: DesignSystemVersionUpdateModel): Promise<void>;
|
|
23
|
+
/** Deletes version
|
|
24
|
+
* @param designSystemId - ID of the design system
|
|
25
|
+
* @param versionId - ID of version
|
|
26
|
+
* @returns nothing
|
|
27
|
+
*/
|
|
28
|
+
deleteVersion(designSystemId: string, versionId: string): Promise<void>;
|
|
29
|
+
/** Fetches all design system versions of provided design system */
|
|
30
|
+
getVersions(designSystemId: string): Promise<Array<DesignSystemVersion>>;
|
|
31
|
+
/** Fetches design system version by id */
|
|
32
|
+
getVersion(from: RemoteVersionIdentifier): Promise<DesignSystemVersion>;
|
|
33
|
+
getTokenStudioData(from: RemoteVersionIdentifier): Promise<object>;
|
|
34
|
+
writeTokenStudioData(from: RemoteVersionIdentifier, data: object): Promise<object>;
|
|
35
|
+
}
|