@supernova-studio/supernova-sdk-beta 1.6.36 → 1.6.38
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/build/sdk-typescript/.eslintrc.d.cts +41 -0
- package/build/sdk-typescript/src/core/SDKSupernova.d.ts +4 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaAssets.d.ts +11 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +14 -14
- package/build/sdk-typescript/src/core/areas/SDKAreaBrands.d.ts +1 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaBulkOperations.d.ts +10 -2
- package/build/sdk-typescript/src/core/areas/SDKAreaComponents.d.ts +10 -3
- package/build/sdk-typescript/src/core/areas/SDKAreaDesignSystems.d.ts +24 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +78 -37
- package/build/sdk-typescript/src/core/areas/SDKAreaIntegrations.d.ts +13 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaMultiplayer.d.ts +10 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaResources.d.ts +25 -3
- package/build/sdk-typescript/src/core/areas/SDKAreaTokens.d.ts +2 -2
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +6 -0
- package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +5 -1
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +95 -39
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +48 -16
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +44 -53
- package/build/sdk-typescript/src/core/errors/SDKSupernovaError.d.ts +4 -2
- package/build/sdk-typescript/src/core/resolvers/SDKAssetGroupResolver.d.ts +4 -0
- package/build/sdk-typescript/src/core/resolvers/SDKDocsEntityMultiplayerItemResolver.d.ts +7 -0
- package/build/sdk-typescript/src/core/resolvers/SDKTokenResolver.d.ts +4 -4
- package/build/sdk-typescript/src/exports.d.ts +22 -4
- package/build/sdk-typescript/src/model/base/SDKDesignSystem.d.ts +1 -7
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockBehavior.d.ts +2 -11
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockDefinition.d.ts +13 -23
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockItemDefinition.d.ts +3 -10
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockLayout.d.ts +2 -7
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockVariant.d.ts +9 -18
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{token-group/SDKDocsBlockActualTokenGroup.d.ts → color-ramps/SDKDocsBlockActualColorRamps.d.ts} +1 -1
- 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/properties/SDKDocsBlockAssetProperty.d.ts +9 -5
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts +4 -2
- 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 +2 -2
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts +2 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockFigmaNodeProperty.d.ts +30 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMarkdownProperty.d.ts +4 -1
- 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 +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockNumberProperty.d.ts +3 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockProperty.d.ts +2 -10
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts +3 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +13 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTableProperty.d.ts +23 -2
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +8 -2
- package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsColorRef.d.ts +2 -2
- package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsImageRef.d.ts +18 -13
- package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsLinkRef.d.ts +10 -7
- package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlock.d.ts +11 -24
- package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlockItem.d.ts +2 -7
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntity.d.ts +5 -2
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityConfiguration.d.ts +6 -1
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityGroup.d.ts +24 -2
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityHeader.d.ts +8 -2
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityPage.d.ts +14 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageAsset.d.ts +1 -1
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockRenderCode.d.ts +1 -1
- package/build/sdk-typescript/src/model/elements/SDKElementProperty.d.ts +1 -1
- package/build/sdk-typescript/src/model/elements/SDKElementPropertyOption.d.ts +27 -5
- package/build/sdk-typescript/src/model/enums/SDKAlignment.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKCodeLanguage.d.ts +9 -8
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockBehaviorDataType.d.ts +1 -1
- package/build/sdk-typescript/src/model/enums/{SDKDocsBlockAssetPropertyPreviewContainerSize.d.ts → SDKDocsBlockContainerSize.d.ts} +1 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +7 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutAlign.d.ts +3 -3
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutColumnResizing.d.ts +2 -2
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutGap.d.ts +4 -4
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockMultiRichTextPropertyStyle.d.ts +8 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockRichTextPropertyStyle.d.ts +0 -4
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockTextPropertyStyle.d.ts +3 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsPublishStatus.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts +19 -19
- package/build/sdk-typescript/src/model/enums/SDKUserRole.d.ts +2 -2
- package/build/sdk-typescript/src/model/exporters/SDKConnections.d.ts +9 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuild.d.ts +11 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuildResults.d.ts +12 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportDestinations.d.ts +16 -1
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteConnectionsModel.d.ts +1 -1
- package/build/sdk-typescript/src/model/groups/SDKAssetGroup.d.ts +4 -0
- package/build/sdk-typescript/src/model/resources/SDKResourceFont.d.ts +2 -2
- package/build/sdk-typescript/src/model/support/SDKFigmaFrame.d.ts +2 -0
- package/build/sdk-typescript/src/model/support/SDKSource.d.ts +14 -5
- package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +1 -1
- package/build/sdk-typescript/src/model/themes/SDKTokenTheme.d.ts +8 -8
- package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +13 -8
- package/build/sdk-typescript/src/model/tokens/SDKColorToken.d.ts +2 -1
- package/build/sdk-typescript/src/model/tokens/SDKDimensionToken.d.ts +1 -1
- package/build/sdk-typescript/src/model/tokens/SDKShadowToken.d.ts +1 -0
- package/build/sdk-typescript/src/model/tokens/SDKStringToken.d.ts +1 -1
- package/build/sdk-typescript/src/model/tokens/SDKTextCaseToken.d.ts +1 -1
- package/build/sdk-typescript/src/model/tokens/SDKTextDecorationToken.d.ts +1 -1
- package/build/sdk-typescript/src/model/tokens/SDKTokenCompator.d.ts +2 -2
- package/build/sdk-typescript/src/model/tokens/SDKTokenValue.d.ts +3 -3
- package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenValue.d.ts +1 -1
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceNPMRegistryAccessToken.d.ts +15 -0
- package/build/sdk-typescript/src/tests/Areas/AreaAssets.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/FigmaTokensDataLoader.d.ts +3 -3
- package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +2 -1
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONParser.d.ts +1 -1
- package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTGroupTree.d.ts +1 -1
- package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +47 -6
- package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementFigmaTokensTransformer.d.ts +1 -1
- package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementTransformer.d.ts +1 -1
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewGenerator.d.ts +4 -1
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewReferenceInfoGenerator.d.ts +0 -1
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewStyleGenerator.d.ts +4 -1
- package/build/sdk-typescript/src/tools/token-transform/SDKToolsTokenTransform.d.ts +3 -1
- package/build/sdk-typescript/src/utils/CommonUtils.d.ts +5 -0
- package/build/sdk-typescript/src/utils/TokenUtils.d.ts +5 -4
- package/build/sdk-typescript/src/utils/deepPartial.d.ts +3 -0
- package/build/supernova-sdk-typescript.js +1 -1
- package/build/supernova-sdk-typescript.js.LICENSE.txt +0 -14
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +122 -118
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTOMoveDocumentationPageInputV2, DTOMoveDocumentationGroupInput, DTOCreateDocumentationTabInput, // TODO? DTODeleteDocumentationTabGroupInput,
|
|
2
|
+
DTOFigmaNodeRenderInput, DTOFigmaNode, DTODocumentationLinkPreviewRequest, DTODeleteDocumentationTabGroupInput } from "@supernova-studio/client";
|
|
3
|
+
import { ExportBuildStatus, ResourceFont, TokenThemeOverrideTranserObject, DocsBlockDefinition } from "../../exports";
|
|
2
4
|
import { Acl } from "../../model/acl/SDKAcl";
|
|
3
5
|
import { Asset } from "../../model/assets/SDKAsset";
|
|
4
6
|
import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
|
|
@@ -8,9 +10,8 @@ import { DesignSystemVersion, DesignSystemVersionUpdateModel } from "../../model
|
|
|
8
10
|
import { DocumentationLegacy, DocumentationLegacyModel } from "../../model/base/SDKDocumentationLegacy";
|
|
9
11
|
import { Component } from "../../model/components/SDKComponent";
|
|
10
12
|
import { DesignComponent } from "../../model/components/SDKDesignComponent";
|
|
11
|
-
import {
|
|
12
|
-
import {
|
|
13
|
-
import { DocumentationLegacyPage, DocumentationLegacyPageModel } from "../../model/documentation/SDKDocumentationLegacyPage";
|
|
13
|
+
import { DocsEntityGroupModel } from "../../model/docs/entities/SDKDocsEntityGroup";
|
|
14
|
+
import { DocsEntityPageModel } from "../../model/docs/entities/SDKDocsEntityPage";
|
|
14
15
|
import { ElementDataView } from "../../model/elements/SDKElementDataView";
|
|
15
16
|
import { ElementDataViewColumn } from "../../model/elements/SDKElementDataViewColumn";
|
|
16
17
|
import { ElementProperty, ElementPropertyCreationModel, ElementPropertyTargetElementType, ElementPropertyUpdateModel } from "../../model/elements/SDKElementProperty";
|
|
@@ -63,6 +64,7 @@ import { Workspace } from "../../model/workspaces/SDKWorkspace";
|
|
|
63
64
|
import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
64
65
|
import { WorkspaceInvitation, WorkspaceInvitationUpdateModel } from "../../model/workspaces/SDKWorkspaceInvitation";
|
|
65
66
|
import { WorkspaceInvoice } from "../../model/workspaces/SDKWorkspaceInvoice";
|
|
67
|
+
import { WorkspaceNPMRegistryAccessTokenRemoteModel } from "../../model/workspaces/SDKWorkspaceNPMRegistryAccessToken";
|
|
66
68
|
import { WorkspaceNPMRegistrySettings, WorkspaceNPMRegistrySettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
|
|
67
69
|
import { WorkspaceOnboarding, WorkspaceOnboardingUpdateModel } from "../../model/workspaces/SDKWorkspaceOnboarding";
|
|
68
70
|
import { WorkspaceProduct } from "../../model/workspaces/SDKWorkspaceProduct";
|
|
@@ -74,9 +76,6 @@ import { ComponentUpdateTransactionData, TokenUpdateTransactionData } from "../a
|
|
|
74
76
|
import { RenderedAssetRequestSettings } from "./requests/SDKDataCoreRenderRequests";
|
|
75
77
|
import { DataBridge } from "./SDKDataBridge";
|
|
76
78
|
import { RequestInfo, RequestInit, Response } from "node-fetch";
|
|
77
|
-
export type DeepPartial<T> = T extends object ? {
|
|
78
|
-
[P in keyof T]?: DeepPartial<T[P]>;
|
|
79
|
-
} : T;
|
|
80
79
|
export declare class DataCore {
|
|
81
80
|
/** Read part of the network calls */
|
|
82
81
|
private read;
|
|
@@ -87,7 +86,14 @@ export declare class DataCore {
|
|
|
87
86
|
/** Bridge */
|
|
88
87
|
private bridge;
|
|
89
88
|
constructor(bridge: DataBridge);
|
|
89
|
+
/** Only for internal functionality */
|
|
90
|
+
getBridgeInternal(): DataBridge;
|
|
90
91
|
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
92
|
+
dataThroughCorsProxy(urlToRalay: string): Promise<ArrayBuffer | undefined>;
|
|
93
|
+
/** Remote: Get single-use multiplayer token */
|
|
94
|
+
multiplayerToken(room: string): Promise<{
|
|
95
|
+
token: string;
|
|
96
|
+
}>;
|
|
91
97
|
/** Remote: Get information about currently logged in user */
|
|
92
98
|
currentUser(): Promise<User>;
|
|
93
99
|
/** Remote: Get information about a specific user */
|
|
@@ -154,6 +160,11 @@ export declare class DataCore {
|
|
|
154
160
|
themes(designSystemId: string, versionId: string): Promise<Array<TokenTheme>>;
|
|
155
161
|
/** Update existing token theme in remote */
|
|
156
162
|
updateTokenTheme(designSystemId: string, versionId: string, theme: TokenTheme): Promise<void>;
|
|
163
|
+
createThemeOverrideForToken(designSystemId: string, versionId: string, themeId: string, override: TokenThemeOverrideTranserObject): Promise<void>;
|
|
164
|
+
/** Update theme override for token */
|
|
165
|
+
updateThemeOverrideForToken(designSystemId: string, versionId: string, tokenPersistentId: string, themeId: string, override: TokenThemeOverrideTranserObject): Promise<void>;
|
|
166
|
+
/** Delete theme override for token */
|
|
167
|
+
deleteThemeOverrideForToken(designSystemId: string, versionId: string, tokenId: string, themeId: string): Promise<void>;
|
|
157
168
|
/** Write the tokens to remote */
|
|
158
169
|
writeTokenData(designSystemId: string, versionId: string, tokens: Array<Token>, groups: Array<TokenGroup>, deleteTokens: Array<Token>, deleteGroups: Array<TokenGroup>): Promise<void>;
|
|
159
170
|
writeTokenThemeData(designSystemId: string, versionId: string, theme: TokenTheme): Promise<void>;
|
|
@@ -163,6 +174,7 @@ export declare class DataCore {
|
|
|
163
174
|
ungroupTokenGroup(designSystemId: string, versionId: string, groupId: string): Promise<void>;
|
|
164
175
|
/** Delete group from remote */
|
|
165
176
|
deleteTokenGroup(designSystemId: string, versionId: string, tokenGroupToDelete: TokenGroup, tokens: Array<Token>, tokenGroups: Array<TokenGroup>): Promise<void>;
|
|
177
|
+
private flattenedChildren;
|
|
166
178
|
private itemsToDeleteFromGroup;
|
|
167
179
|
/** Update token property at remote */
|
|
168
180
|
updateTokenPropertyValue(designSystemId: string, versionId: string, newValue: string | boolean | number, token: Token, property: ElementProperty): Promise<void>;
|
|
@@ -174,27 +186,33 @@ export declare class DataCore {
|
|
|
174
186
|
idInVersion: string;
|
|
175
187
|
}>;
|
|
176
188
|
/** Create a page within documentation */
|
|
177
|
-
createDocumentationPage(designSystemId: string, versionId: string,
|
|
189
|
+
createDocumentationPage(designSystemId: string, versionId: string, payload: Omit<DTOCreateDocumentationPageInputV2, "persistentId">): Promise<string>;
|
|
178
190
|
/** Create a group within documentation */
|
|
179
|
-
createDocumentationGroup(designSystemId: string, versionId: string,
|
|
191
|
+
createDocumentationGroup(designSystemId: string, versionId: string, payload: Omit<DTOCreateDocumentationGroupInput, "persistentId">): Promise<string>;
|
|
192
|
+
/** Create a tab group within documentation */
|
|
193
|
+
createDocumentationTab(designSystemId: string, versionId: string, payload: Omit<DTOCreateDocumentationTabInput, "persistentId">): Promise<string>;
|
|
180
194
|
/** Ungroup a documentaiton group */
|
|
181
|
-
ungroupDocumentationGroup(designSystemId: string, versionId: string,
|
|
195
|
+
ungroupDocumentationGroup(designSystemId: string, versionId: string, payload: DTODeleteDocumentationGroupInput): Promise<void>;
|
|
182
196
|
/** Updates a documentation group */
|
|
183
|
-
updateDocumentationGroup(designSystemId: string, versionId: string,
|
|
197
|
+
updateDocumentationGroup(designSystemId: string, versionId: string, payload: DTOUpdateDocumentationGroupInput): Promise<any>;
|
|
184
198
|
/** Updates a documentation page or tab */
|
|
185
|
-
updateDocumentationPageOrTab(designSystemId: string, versionId: string,
|
|
186
|
-
/**
|
|
187
|
-
|
|
199
|
+
updateDocumentationPageOrTab(designSystemId: string, versionId: string, payload: DTOUpdateDocumentationPageInputV2): Promise<any>;
|
|
200
|
+
/** Move a documentation page */
|
|
201
|
+
moveDocumentationPage(designSystemId: string, versionId: string, payload: DTOMoveDocumentationPageInputV2): Promise<any>;
|
|
202
|
+
/** Move a documentation group */
|
|
203
|
+
moveDocumentationGroup(designSystemId: string, versionId: string, payload: DTOMoveDocumentationGroupInput): Promise<any>;
|
|
188
204
|
/** Duplicate a documentation page or tab */
|
|
189
|
-
duplicateDocumentationPageOrTab(designSystemId: string, versionId: string,
|
|
205
|
+
duplicateDocumentationPageOrTab(designSystemId: string, versionId: string, payload: Omit<DTODuplicateDocumentationPageInputV2, "persistentId">): Promise<string>;
|
|
190
206
|
/** Duplicate a documentation group or tabbed page */
|
|
191
|
-
duplicateDocumentationGroupOrTabbedPage(designSystemId: string, versionId: string,
|
|
207
|
+
duplicateDocumentationGroupOrTabbedPage(designSystemId: string, versionId: string, payload: Omit<DTODuplicateDocumentationGroupInput, "persistentId">): Promise<string>;
|
|
192
208
|
/** Delete a documentation page */
|
|
193
|
-
deleteDocumentationPage(designSystemId: string, versionId: string,
|
|
209
|
+
deleteDocumentationPage(designSystemId: string, versionId: string, payload: DTODeleteDocumentationPageInputV2): Promise<void>;
|
|
210
|
+
/** Delete a documentation tab group */
|
|
211
|
+
deleteDocumentationTabGroup(designSystemId: string, versionId: string, payload: DTODeleteDocumentationTabGroupInput): Promise<void>;
|
|
194
212
|
/** Delete a documentation group */
|
|
195
|
-
deleteDocumentationGroup(designSystemId: string, versionId: string,
|
|
213
|
+
deleteDocumentationGroup(designSystemId: string, versionId: string, payload: DTODeleteDocumentationGroupInput): Promise<void>;
|
|
196
214
|
/** Delete a documentation group and tree inside it */
|
|
197
|
-
deleteDocumentationGroupAndTree(designSystemId: string, versionId: string,
|
|
215
|
+
deleteDocumentationGroupAndTree(designSystemId: string, versionId: string, id: string): Promise<void>;
|
|
198
216
|
/** Create a custom property in remote */
|
|
199
217
|
updateTokenProperty(designSystemId: string, versionId: string, propertyIdInVersion: string, model: ElementPropertyUpdateModel): Promise<void>;
|
|
200
218
|
/** Delete a custom property in remote */
|
|
@@ -206,11 +224,17 @@ export declare class DataCore {
|
|
|
206
224
|
/** Delete theme from remote */
|
|
207
225
|
deleteTokenTheme(designSystemId: string, versionId: string, themeId: string): Promise<void>;
|
|
208
226
|
/** Download all necessary data for components and retrieve them resolved */
|
|
209
|
-
components(designSystemId: string, versionId: string
|
|
227
|
+
components(designSystemId: string, versionId: string, filter?: {
|
|
228
|
+
brandId?: string;
|
|
229
|
+
}): Promise<Array<Component>>;
|
|
210
230
|
/** Download all necessary data for component groups and retrieve them resolved */
|
|
211
231
|
componentGroups(designSystemId: string, versionId: string): Promise<Array<ComponentGroup>>;
|
|
212
|
-
designComponents(designSystemId: string, versionId: string
|
|
213
|
-
|
|
232
|
+
designComponents(designSystemId: string, versionId: string, filter?: {
|
|
233
|
+
brandId?: string;
|
|
234
|
+
}): Promise<Array<DesignComponent>>;
|
|
235
|
+
designComponentGroups(designSystemId: string, versionId: string, filter?: {
|
|
236
|
+
brandId?: string;
|
|
237
|
+
}): Promise<Array<DesignComponentGroup>>;
|
|
214
238
|
/** Write new component to remote */
|
|
215
239
|
createComponent(designSystemId: string, versionId: string, component: Component): Promise<{
|
|
216
240
|
id: string;
|
|
@@ -256,21 +280,25 @@ export declare class DataCore {
|
|
|
256
280
|
assetGroups(designSystemId: string, versionId: string): Promise<Array<AssetGroup>>;
|
|
257
281
|
/** Render assets as PNG, SVG, PDF, or combinations of it */
|
|
258
282
|
renderedAssets(designSystemId: string, versionId: string, assets: Array<Asset>, groups: Array<AssetGroup>, settings: RenderedAssetRequestSettings): Promise<Array<RenderedAsset>>;
|
|
283
|
+
/** Render Figma frames */
|
|
284
|
+
renderedFigmaFrames(designSystemId: string, versionId: string, payload: Array<DTOFigmaNodeRenderInput>): Promise<Array<DTOFigmaNode>>;
|
|
285
|
+
/** Fetches all Figma frames that were rendered under specific version
|
|
286
|
+
* @param from - Remote version to fetch from
|
|
287
|
+
* @returns All Figma frames in the specified version (only rendered, for documentation etc.)
|
|
288
|
+
*/
|
|
289
|
+
figmaFrames(designSystemId: string, versionId: string): Promise<Array<DTOFigmaNode>>;
|
|
259
290
|
/** Retrieve the main documentation object through which all docs data can be accessed */
|
|
260
291
|
documentation(workspaceId: string, designSystemId: string, versionId: string): Promise<DocumentationLegacy>;
|
|
292
|
+
getDocumentationStructure(designSystemId: string, versionId: string): Promise<(DocsEntityPageModel | DocsEntityGroupModel)[]>;
|
|
261
293
|
updateDocumentationStructure(designSystemId: string, versionId: string, model: DocumentationLegacyModel): Promise<void>;
|
|
262
|
-
/** Download all necessary data for documentation items (groups and pages) and retrieve them resolved */
|
|
263
|
-
documentationItems(workspaceId: string, designSystemId: string, versionId: string): Promise<Array<DocumentationLegacyItem>>;
|
|
264
294
|
/** Get ID of the multiplayer room for a given documentation page */
|
|
265
295
|
getDocumentationPageRoomId(designSystemId: string, versionId: string, pageId: string): Promise<string>;
|
|
296
|
+
/** Remote: Get id of the room for a specific design system and version. This room contains doc structure */
|
|
297
|
+
getDocumentationVersionRoomId(designSystemId: string, versionId: string): Promise<string>;
|
|
266
298
|
/** Retrieve currently deployed documentation url */
|
|
267
299
|
documentationDomain(designSystemId: string, versionId: string): Promise<string | null>;
|
|
268
300
|
/** Publish the documentation */
|
|
269
|
-
documentationPublish(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<
|
|
270
|
-
status: "Queued" | "InProgress" | "Failure";
|
|
271
|
-
jobId: string;
|
|
272
|
-
exporterId: string;
|
|
273
|
-
}>;
|
|
301
|
+
documentationPublish(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<ExportBuild>;
|
|
274
302
|
/** Retrieve all asset resources */
|
|
275
303
|
assetResources(designSystemId: string, versionId: string): Promise<Array<ResourceAsset>>;
|
|
276
304
|
/** Retrieve all font resources */
|
|
@@ -278,9 +306,13 @@ export declare class DataCore {
|
|
|
278
306
|
/** Upload asset resource */
|
|
279
307
|
uploadAssetResource(designSystemId: string, versionId: string, asset: File): Promise<ResourceAsset>;
|
|
280
308
|
/** Upload font resource */
|
|
281
|
-
uploadFontResource(designSystemId: string, versionId: string, font: File): Promise<ResourceFont>;
|
|
282
|
-
/**
|
|
309
|
+
uploadFontResource(designSystemId: string, versionId: string, font: File): Promise<ResourceFont | null>;
|
|
310
|
+
/** Upload font resources */
|
|
311
|
+
uploadFontResources(designSystemId: string, versionId: string, fonts: FileList): Promise<ResourceFont[]>;
|
|
312
|
+
/** Delete any single resource */
|
|
283
313
|
deleteResource(designSystemId: string, versionId: string, resourceId: string): Promise<void>;
|
|
314
|
+
/** Delete any multiple resources */
|
|
315
|
+
deleteResources(designSystemId: string, versionId: string, resourceIds: string[]): Promise<void>;
|
|
284
316
|
pipelines(workspaceId: string, designSystemId?: string): Promise<Array<Pipeline>>;
|
|
285
317
|
githubConnections(): Promise<Array<CodegenConnection>>;
|
|
286
318
|
githubAccounts(githubConnectionId: string): Promise<Array<CodegenAccount>>;
|
|
@@ -325,17 +357,18 @@ export declare class DataCore {
|
|
|
325
357
|
createExporter(workspaceId: string, payload: NewExporterPayload): Promise<Exporter>;
|
|
326
358
|
/** Edit exporter */
|
|
327
359
|
updateExporter(workspaceId: string, exporterId: string, payload: NewExporterPayload): Promise<Exporter>;
|
|
360
|
+
/** Update exporter configuration property value */
|
|
361
|
+
updateExporterConfigurationPropertyValue(designSystemId: string, exporterId: string, propertyKey: string, propertyValue: any): Promise<void>;
|
|
362
|
+
/** Delete exporter configuration property value */
|
|
363
|
+
deleteExporterConfigurationPropertyValue(designSystemId: string, exporterId: string, propertyKey: string): Promise<void>;
|
|
328
364
|
/** Delete exporter */
|
|
329
365
|
deleteExporter(workspaceId: string, exporterId: string): Promise<void>;
|
|
330
366
|
/** Pull updates for exporter */
|
|
331
367
|
pullLatestExporter(workspaceId: string, exporterId: string): Promise<Exporter>;
|
|
332
|
-
exportBuilds(workspaceId: string,
|
|
368
|
+
exportBuilds(workspaceId: string, versionId: string): Promise<Array<ExportBuild>>;
|
|
369
|
+
documentationBuild(workspaceId: string, buildId: string): Promise<ExportBuild>;
|
|
333
370
|
/** Download information about documentation builds and retrieve it resolved */
|
|
334
|
-
documentationBuilds(workspaceId: string,
|
|
335
|
-
status: "InProgress" | "Success" | "Failed";
|
|
336
|
-
id: string | null;
|
|
337
|
-
exporterId: string | null;
|
|
338
|
-
}>>;
|
|
371
|
+
documentationBuilds(workspaceId: string, versionId: string, environment: DocumentationEnvironment, status?: ExportBuildStatus, createdByUserId?: string, limit?: number): Promise<Array<ExportBuild>>;
|
|
339
372
|
buildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLog>>;
|
|
340
373
|
workspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeatures>;
|
|
341
374
|
/** Download information about a single workspace and retrieve it resolved */
|
|
@@ -349,11 +382,13 @@ export declare class DataCore {
|
|
|
349
382
|
deleteBrand(designSystemId: string, versionId: string, brandId: string): Promise<void>;
|
|
350
383
|
deleteCustomDomain(designSystemId: string): Promise<void>;
|
|
351
384
|
updateCustomDomain(designSystemId: string, customerDomain: string): Promise<CustomDomain>;
|
|
385
|
+
startSslGenerationForCustomDomain(designSystemId: string): Promise<void>;
|
|
352
386
|
/** Validate that workspace handle is available */
|
|
353
387
|
validateIsWorkspaceHandleAvailable(handle: string): Promise<boolean>;
|
|
354
388
|
workspaceOnboarding(workspaceId: string): Promise<WorkspaceOnboarding>;
|
|
355
389
|
workspaceIPWhitelistSettings(workspaceId: string): Promise<WorkspaceIPWhitelistSettings | null>;
|
|
356
390
|
workspaceNPMRegistrySettings(workspaceId: string): Promise<WorkspaceNPMRegistrySettings | null>;
|
|
391
|
+
workspaceNPMRegistryAccessToken(workspaceId: string): Promise<WorkspaceNPMRegistryAccessTokenRemoteModel | null>;
|
|
357
392
|
workspaceSSOSettings(workspaceId: string): Promise<WorkspaceSSOSettings | null>;
|
|
358
393
|
workspaceInvitations(workspaceId: string): Promise<Array<WorkspaceInvitation>>;
|
|
359
394
|
workspaceInvoices(workspaceId: string): Promise<Array<WorkspaceInvoice>>;
|
|
@@ -377,8 +412,8 @@ export declare class DataCore {
|
|
|
377
412
|
deleteWorkspaceNPMRegistrySettings(workspaceId: string): Promise<void>;
|
|
378
413
|
deleteWorkspaceMember(workspaceId: string, userId: string): Promise<void>;
|
|
379
414
|
deleteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
380
|
-
createCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity
|
|
381
|
-
createPortalSession(workspaceId: string, returnUrl: string, update
|
|
415
|
+
createCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity?: number | null): Promise<string>;
|
|
416
|
+
createPortalSession(workspaceId: string, returnUrl: string, update?: WorkspaceSubscriptionUpdateModel | null, cancel?: boolean | null): Promise<string>;
|
|
382
417
|
resendWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
383
418
|
restoreWorkspaceSubscription(workspaceId: string): Promise<void>;
|
|
384
419
|
/** Download information about a single design system and retrieve it resolved */
|
|
@@ -387,6 +422,24 @@ export declare class DataCore {
|
|
|
387
422
|
designSystems(workspaceId: any): Promise<Array<DesignSystem>>;
|
|
388
423
|
/** Creates a design system */
|
|
389
424
|
createDesignSystem(workspaceId: string, name: string, description?: string): Promise<DesignSystem>;
|
|
425
|
+
getBlockDefinitions(designSystemId: string, versionId: string): Promise<Array<DocsBlockDefinition>>;
|
|
426
|
+
getUrlPreview(designSystemId: string, versionId: string, request: DTODocumentationLinkPreviewRequest): Promise<{
|
|
427
|
+
linkPreview: {
|
|
428
|
+
title?: string | undefined;
|
|
429
|
+
description?: string | undefined;
|
|
430
|
+
thumbnail?: {
|
|
431
|
+
type: "Resource" | "FigmaNode";
|
|
432
|
+
resource?: {
|
|
433
|
+
url: string;
|
|
434
|
+
resourceId: string;
|
|
435
|
+
} | undefined;
|
|
436
|
+
figmaNode?: {
|
|
437
|
+
sourceId: string;
|
|
438
|
+
frameReferenceId: string;
|
|
439
|
+
} | undefined;
|
|
440
|
+
} | undefined;
|
|
441
|
+
};
|
|
442
|
+
}>;
|
|
390
443
|
/** Updates a design system metadata */
|
|
391
444
|
updateDesignSystemMetadata(designSystemId: string, name: string, description?: string): Promise<void>;
|
|
392
445
|
/** Updates a design system multibrand option */
|
|
@@ -433,6 +486,9 @@ export declare class DataCore {
|
|
|
433
486
|
version(designSystemId: string, versionId: string): Promise<DesignSystemVersion>;
|
|
434
487
|
getBrands(designSystemId: string, versionId: string): Promise<Array<Brand>>;
|
|
435
488
|
getBrand(designSystemId: string, versionId: string, brandId: string): Promise<Brand>;
|
|
489
|
+
getAuthenticationTokens(): Promise<import("../../model/exporters/SDKConnections").AuthenticationTokens>;
|
|
490
|
+
deleteAuthenticationToken(id: string): Promise<import("../../model/exporters/SDKConnections").AuthenticationTokenPayload>;
|
|
491
|
+
createAuthenticationToken(name: string, scope?: string): Promise<import("../../model/exporters/SDKConnections").CreateAuthenticationTokenPayload>;
|
|
436
492
|
getOAuthURL(service: "figma" | ExporterProvider): Promise<string>;
|
|
437
493
|
deleteOAuthIntegration(userId: string, service: "figma" | ExporterProvider): Promise<void>;
|
|
438
494
|
createPersonalAccessTokenConnection(service: ConnectionProviders, connection: PersonalAccessTokenConnectionPayload | AzurePersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { DTODocumentationLinkPreviewRequest, DTOFigmaNode } from "@supernova-studio/client";
|
|
1
2
|
import { AclRemoteModel } from "../../../model/acl/SDKAcl";
|
|
2
3
|
import { BrandRemoteModel } from "../../../model/base/SDKBrand";
|
|
3
4
|
import { DesignSystemRemoteModel } from "../../../model/base/SDKDesignSystem";
|
|
@@ -5,7 +6,9 @@ import { DesignSystemVersionRemoteModel } from "../../../model/base/SDKDesignSys
|
|
|
5
6
|
import { DocumentationLegacyModel } from "../../../model/base/SDKDocumentationLegacy";
|
|
6
7
|
import { ComponentRemoteModel } from "../../../model/components/SDKComponent";
|
|
7
8
|
import { DesignComponentRemoteModel } from "../../../model/components/SDKDesignComponent";
|
|
8
|
-
import {
|
|
9
|
+
import { DocsBlockDefinitionModel } from "../../../model/docs/blocks/definition/SDKDocsBlockDefinition";
|
|
10
|
+
import { DocsEntityGroupModel } from "../../../model/docs/entities/SDKDocsEntityGroup";
|
|
11
|
+
import { DocsEntityPageModel } from "../../../model/docs/entities/SDKDocsEntityPage";
|
|
9
12
|
import { DocumentationLegacyPageModel } from "../../../model/documentation/SDKDocumentationLegacyPage";
|
|
10
13
|
import { ElementDataViewRemoteModel } from "../../../model/elements/SDKElementDataView";
|
|
11
14
|
import { ElementPropertyRemoteModel } from "../../../model/elements/SDKElementProperty";
|
|
@@ -13,9 +16,10 @@ import { ElementPropertyValueRemoteModel } from "../../../model/elements/values/
|
|
|
13
16
|
import { DocumentationEnvironment } from "../../../model/enums/SDKDocumentationEnvironment";
|
|
14
17
|
import { TokenType } from "../../../model/enums/SDKTokenType";
|
|
15
18
|
import { CodegenBitbucketProject } from "../../../model/exporters/CodegenBitbucketProject";
|
|
19
|
+
import { AuthenticationTokens } from "../../../model/exporters/SDKConnections";
|
|
16
20
|
import { ExporterModel, ExporterProvider } from "../../../model/exporters/SDKExporter";
|
|
17
21
|
import { ExporterCustomBlockModel } from "../../../model/exporters/custom_blocks/SDKExporterCustomBlock";
|
|
18
|
-
import { ExportBuildModel } from "../../../model/exporters/exporter_builds/SDKExportBuild";
|
|
22
|
+
import { ExportBuildModel, ExportBuildStatus } from "../../../model/exporters/exporter_builds/SDKExportBuild";
|
|
19
23
|
import { ExportBuildResultLogModel } from "../../../model/exporters/exporter_builds/SDKExportBuildResults";
|
|
20
24
|
import { CodegenAzureBranchRemoteModel } from "../../../model/exporters/remote/SDKRemoteAzureCodegenBranchModel";
|
|
21
25
|
import { CodegenAzureOrganizationRemoteModel } from "../../../model/exporters/remote/SDKRemoteAzureCodegenOrganizationModel";
|
|
@@ -51,6 +55,7 @@ import { WorkspaceRemoteModel } from "../../../model/workspaces/SDKWorkspace";
|
|
|
51
55
|
import { WorkspaceIPWhitelistSettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
52
56
|
import { WorkspaceInvitationRemoteModel } from "../../../model/workspaces/SDKWorkspaceInvitation";
|
|
53
57
|
import { WorkspaceInvoiceRemoteModel } from "../../../model/workspaces/SDKWorkspaceInvoice";
|
|
58
|
+
import { WorkspaceNPMRegistryAccessTokenRemoteModel } from "../../../model/workspaces/SDKWorkspaceNPMRegistryAccessToken";
|
|
54
59
|
import { WorkspaceNPMRegistrySettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
|
|
55
60
|
import { WorkspaceOnboardingRemoteModel } from "../../../model/workspaces/SDKWorkspaceOnboarding";
|
|
56
61
|
import { WorkspaceProductRemoteModel } from "../../../model/workspaces/SDKWorkspaceProduct";
|
|
@@ -61,6 +66,11 @@ import { DataBridge } from "../SDKDataBridge";
|
|
|
61
66
|
export declare class DataCoreReadRequests {
|
|
62
67
|
private bridge;
|
|
63
68
|
constructor(bridge: DataBridge);
|
|
69
|
+
getDataThroughCorsProxy(url: string): Promise<ArrayBuffer | undefined>;
|
|
70
|
+
/** Remote: Get information about currently logged in user */
|
|
71
|
+
getRemoteMultiplayerToken(room: string): Promise<{
|
|
72
|
+
token: string;
|
|
73
|
+
}>;
|
|
64
74
|
/** Remote: Get information about currently logged in user */
|
|
65
75
|
getRemoteCurrentUser(): Promise<UserRemoteModel>;
|
|
66
76
|
/** Remote: Get information about a specific user */
|
|
@@ -80,6 +90,7 @@ export declare class DataCoreReadRequests {
|
|
|
80
90
|
/** Remote: Get information about the workspace IP whitelisting configuration */
|
|
81
91
|
getRemoteWorkspaceIPWhitelistSettings(workspaceId: string): Promise<WorkspaceIPWhitelistSettingsRemoteModel | null>;
|
|
82
92
|
getRemoteWorkspaceNPMRegistrySettings(workspaceId: string): Promise<WorkspaceNPMRegistrySettingsRemoteModel | null>;
|
|
93
|
+
getRemoteWorkspaceNPMRegistryAccessToken(workspaceId: string): Promise<WorkspaceNPMRegistryAccessTokenRemoteModel | null>;
|
|
83
94
|
getRemoteWorkspaceSSOSettings(workspaceId: string): Promise<WorkspaceSSOSettingsRemoteModel | null>;
|
|
84
95
|
getRemoteWorkspaceInvitations(workspaceId: string): Promise<Array<WorkspaceInvitationRemoteModel>>;
|
|
85
96
|
getRemoteWorkspaceInvoices(workspaceId: string): Promise<Array<WorkspaceInvoiceRemoteModel>>;
|
|
@@ -103,13 +114,12 @@ export declare class DataCoreReadRequests {
|
|
|
103
114
|
getRemoteDocumentationUrl(designSystemId: string, versionId: string): Promise<string | null>;
|
|
104
115
|
/** Remote: Get documentation metadata */
|
|
105
116
|
getRemoteDocumentationStructure(designSystemId: string, versionId: string): Promise<DocumentationLegacyModel>;
|
|
106
|
-
/** Remote: Get
|
|
107
|
-
|
|
108
|
-
groups: Array<DocumentationLegacyGroupModel>;
|
|
109
|
-
pages: Array<DocumentationLegacyPageModel>;
|
|
110
|
-
}>;
|
|
117
|
+
/** Remote: Get documentation metadata */
|
|
118
|
+
getRemoteRealDocumentationStructure(designSystemId: string, versionId: string): Promise<(DocsEntityPageModel | DocsEntityGroupModel)[]>;
|
|
111
119
|
/** Remote: Get id of the room for a specific page */
|
|
112
120
|
getRemoteDocumentationPageRoomId(designSystemId: string, versionId: string, pageId: string): Promise<string>;
|
|
121
|
+
/** Remote: Get id of the room for a specific design system and version. This room contains doc structure */
|
|
122
|
+
getRemoteDocumentationVersionRoomId(designSystemId: string, versionId: string): Promise<string>;
|
|
113
123
|
/** Remote: Get custom blocks for currently installed documentation exporter under specific ds */
|
|
114
124
|
getRemoteExporterCustomBlocks(designSystemId: string, versionId: string): Promise<Array<ExporterCustomBlockModel>>;
|
|
115
125
|
/** Remote: Get user configuration of specific installed exporter */
|
|
@@ -117,6 +127,24 @@ export declare class DataCoreReadRequests {
|
|
|
117
127
|
key: string;
|
|
118
128
|
value: any;
|
|
119
129
|
}>>;
|
|
130
|
+
getBlockDefinitions(designSystemId: string, versionId: string): Promise<Array<DocsBlockDefinitionModel>>;
|
|
131
|
+
getUrlPreview(designSystemId: string, versionId: string, request: DTODocumentationLinkPreviewRequest): Promise<{
|
|
132
|
+
linkPreview: {
|
|
133
|
+
title?: string | undefined;
|
|
134
|
+
description?: string | undefined;
|
|
135
|
+
thumbnail?: {
|
|
136
|
+
type: "Resource" | "FigmaNode";
|
|
137
|
+
resource?: {
|
|
138
|
+
url: string;
|
|
139
|
+
resourceId: string;
|
|
140
|
+
} | undefined;
|
|
141
|
+
figmaNode?: {
|
|
142
|
+
sourceId: string;
|
|
143
|
+
frameReferenceId: string;
|
|
144
|
+
} | undefined;
|
|
145
|
+
} | undefined;
|
|
146
|
+
};
|
|
147
|
+
}>;
|
|
120
148
|
/** Remote: Get structural details and metadata about specific installed exporter */
|
|
121
149
|
getRemoteExporter(workspaceId: string, exporterId: string): Promise<ExporterModel>;
|
|
122
150
|
/** Remote: Get structural details and metadata about all exporters */
|
|
@@ -145,13 +173,19 @@ export declare class DataCoreReadRequests {
|
|
|
145
173
|
documentationPages: Array<DocumentationLegacyPageModel>;
|
|
146
174
|
}>;
|
|
147
175
|
/** Remote: Get all supernova-type components (note: Not design components, those have separate endpoints) */
|
|
148
|
-
getRemoteComponents(designSystemId: string, versionId: string
|
|
176
|
+
getRemoteComponents(designSystemId: string, versionId: string, filter?: {
|
|
177
|
+
brandId?: string;
|
|
178
|
+
}): Promise<Array<ComponentRemoteModel>>;
|
|
149
179
|
/** Remote: Get all component groups */
|
|
150
180
|
getRemoteComponentGroups(designSystemId: string, versionId: string): Promise<Array<ComponentGroupRemoteModel>>;
|
|
151
181
|
/** Remote: Get design components (right now, those are only components coming from Figma) */
|
|
152
|
-
getRemoteDesignComponents(designSystemId: string, versionId: string
|
|
182
|
+
getRemoteDesignComponents(designSystemId: string, versionId: string, filter?: {
|
|
183
|
+
brandId?: string;
|
|
184
|
+
}): Promise<Array<DesignComponentRemoteModel>>;
|
|
153
185
|
/** Remote: Get design component groups (right now, those are only components coming from Figma) */
|
|
154
|
-
getRemoteDesignComponentGroups(designSystemId: string, versionId: string
|
|
186
|
+
getRemoteDesignComponentGroups(designSystemId: string, versionId: string, filter?: {
|
|
187
|
+
brandId?: string;
|
|
188
|
+
}): Promise<Array<DesignComponentGroupRemoteModel>>;
|
|
155
189
|
/** Remote: Get assets (right now, those are only components coming from Figma, but this will change in the future) */
|
|
156
190
|
getRemoteAssets(designSystemId: string, versionId: string): Promise<Array<DesignComponentRemoteModel>>;
|
|
157
191
|
/** Remote: Get design component groups (right now, those are only components coming from Figma, but this will change in the future) */
|
|
@@ -161,6 +195,7 @@ export declare class DataCoreReadRequests {
|
|
|
161
195
|
getRemoteElementDataViewDefinitions(designSystemId: string, versionId: string): Promise<Array<ElementDataViewRemoteModel>>;
|
|
162
196
|
/** Remote: Get all property values that were set by the user for each elemen */
|
|
163
197
|
getRemoteElementPropertyValues(designSystemId: string, versionId: string): Promise<ElementPropertyValueRemoteModel[]>;
|
|
198
|
+
getRemoteFigmaFrames(designSystemId: string, versionId: string): Promise<Array<DTOFigmaNode>>;
|
|
164
199
|
getRemotePipelines(workspaceId: string, designSystemId?: string): Promise<PipelineRemoteModel[]>;
|
|
165
200
|
getRemoteGithubConnections(): Promise<CodegenConnectionRemoteModel[]>;
|
|
166
201
|
getRemoteGithubAccounts(githubConnectId: string): Promise<CodegenAccountRemoteModel[]>;
|
|
@@ -180,15 +215,12 @@ export declare class DataCoreReadRequests {
|
|
|
180
215
|
getRemoteBitbucketProjects(connectionId: string, worksapceId: string): Promise<CodegenBitbucketProject[]>;
|
|
181
216
|
getRemoteBitbucketRepositories(connectionId: string, workspaceId: string, projectKey?: string): Promise<CodegenBitbucketRepositoryRemoteModel[]>;
|
|
182
217
|
getRemoteBitbucketBranches(connectionId: string, workspaceId: string, projectId: string, repositoryId: string): Promise<CodegenBitbucketBranchRemoteModel[]>;
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
status: "InProgress" | "Success" | "Failed";
|
|
186
|
-
id: string | null;
|
|
187
|
-
exporterId: string | null;
|
|
188
|
-
}>>;
|
|
218
|
+
getRemoteBuild(workspaceId: string, buildId: string): Promise<ExportBuildModel>;
|
|
219
|
+
getRemoteBuilds(workspaceId: string, versionId: string, docsEnvironment?: DocumentationEnvironment, limit?: number, offset?: number, scheduleId?: string, exporterId?: string, destinations?: Array<"s3" | "webhook" | "github" | "documentation" | "azure" | "gitlab">, createdByUserId?: string, status?: ExportBuildStatus): Promise<Array<ExportBuildModel>>;
|
|
189
220
|
getRemoteBuildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLogModel>>;
|
|
190
221
|
getBrands(designSystemId: string, versionId: string): Promise<Array<BrandRemoteModel>>;
|
|
191
222
|
getBrand(designSystemId: string, versionId: string, brandId: string): Promise<BrandRemoteModel>;
|
|
223
|
+
getAuthenticationTokens(): Promise<AuthenticationTokens>;
|
|
192
224
|
getOAuthURL(service: "figma" | ExporterProvider): Promise<string>;
|
|
193
225
|
getVersion(designSystemId: string, versionId: string): Promise<DesignSystemVersionRemoteModel>;
|
|
194
226
|
getVersions(designSystemId: string): Promise<Array<DesignSystemVersionRemoteModel>>;
|
|
@@ -1,17 +1,19 @@
|
|
|
1
|
+
import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTOUpdateDocumentationPageInputV2, DTOMoveDocumentationPageInputV2, DTOMoveDocumentationGroupInput, DTOCreateDocumentationTabInput, DTOFigmaNodeRenderInput, DTOFigmaNode } from "@supernova-studio/client";
|
|
2
|
+
import { TokenThemeOverrideTranserObject } from "../../../exports";
|
|
1
3
|
import { Brand, BrandRemoteModel, BrandUpdateModel } from "../../../model/base/SDKBrand";
|
|
2
4
|
import { DesignSystem, DesignSystemRemoteModel, DesignSystemSwitcher } from "../../../model/base/SDKDesignSystem";
|
|
3
5
|
import { DesignSystemVersionRemoteModel, DesignSystemVersionUpdateModel } from "../../../model/base/SDKDesignSystemVersion";
|
|
4
6
|
import { DocumentationLegacyModel } from "../../../model/base/SDKDocumentationLegacy";
|
|
5
7
|
import { Component, ComponentRemoteModel, ComponentUpdateRemoteModel } from "../../../model/components/SDKComponent";
|
|
6
|
-
import { DocumentationLegacyGroup, DocumentationLegacyGroupModel } from "../../../model/documentation/SDKDocumentationLegacyGroup";
|
|
7
|
-
import { DocumentationLegacyPage, DocumentationLegacyPageModel } from "../../../model/documentation/SDKDocumentationLegacyPage";
|
|
8
8
|
import { ElementDataViewColumnType } from "../../../model/elements/SDKElementDataViewColumn";
|
|
9
9
|
import { ElementPropertyRemoteModel } from "../../../model/elements/SDKElementProperty";
|
|
10
10
|
import { ConnectionProviders } from "../../../model/enums/SDKConnectionProviders";
|
|
11
11
|
import { DocumentationEnvironment } from "../../../model/enums/SDKDocumentationEnvironment";
|
|
12
12
|
import { UserRoleWithoutOwner } from "../../../model/enums/SDKUserRole";
|
|
13
|
-
import { AzurePersonalAccessTokenConnectionPayload, PersonalAccessTokenConnectionPayload } from "../../../model/exporters/SDKConnections";
|
|
13
|
+
import { AuthenticationTokenPayload, AzurePersonalAccessTokenConnectionPayload, CreateAuthenticationTokenPayload, PersonalAccessTokenConnectionPayload } from "../../../model/exporters/SDKConnections";
|
|
14
|
+
import { ExporterProvider, NewExporterPayload } from "../../../model/exporters/SDKExporter";
|
|
14
15
|
import { NewPipelinePayload, PipelineUpdateModel } from "../../../model/exporters/SDKPipeline";
|
|
16
|
+
import { ExportBuildModel } from "../../../model/exporters/exporter_builds/SDKExportBuild";
|
|
15
17
|
import { ConnectionRemoteModel } from "../../../model/exporters/remote/SDKRemoteConnectionsModel";
|
|
16
18
|
import { ComponentGroup, ComponentGroupRemoteModel } from "../../../model/groups/SDKComponentGroup";
|
|
17
19
|
import { TokenGroup, TokenGroupRemoteModel } from "../../../model/groups/SDKTokenGroup";
|
|
@@ -33,7 +35,6 @@ import { WorkspaceProfileUpdateModel } from "../../../model/workspaces/SDKWorksp
|
|
|
33
35
|
import { WorkspaceSSOSettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
34
36
|
import { WorkspaceSubscriptionUpdateModel } from "../../../model/workspaces/SDKWorkspaceSubscription";
|
|
35
37
|
import { DataBridge } from "../SDKDataBridge";
|
|
36
|
-
import { ExporterProvider, NewExporterPayload } from "model/exporters/SDKExporter";
|
|
37
38
|
export declare class DataCoreWriteRequests {
|
|
38
39
|
private bridge;
|
|
39
40
|
constructor(bridge: DataBridge);
|
|
@@ -67,6 +68,7 @@ export declare class DataCoreWriteRequests {
|
|
|
67
68
|
updateRemoteCustomDomain(designSystemId: string, customerDomain: string): Promise<CustomDomainRemoteModel>;
|
|
68
69
|
/** Remote: Deletes custom domain */
|
|
69
70
|
deleteRemoteCustomDomain(designSystemId: string): Promise<void>;
|
|
71
|
+
startSslGenerationForCustomDomain(designSystemId: string): Promise<void>;
|
|
70
72
|
/** Remote: Updates a workspace profile */
|
|
71
73
|
updateRemoteWorkspaceProfile(workspaceId: string, profile: WorkspaceProfileUpdateModel): Promise<void>;
|
|
72
74
|
testIpWhitelistSettings(workspaceId: string, ipWhitelistSettings: WorkspaceIPWhitelistSettingsUpdateModel): Promise<{
|
|
@@ -103,7 +105,7 @@ export declare class DataCoreWriteRequests {
|
|
|
103
105
|
/** Remote: create Checkout session */
|
|
104
106
|
createRemoteCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity?: number | null): Promise<string>;
|
|
105
107
|
/** Remote: create Customer portal session */
|
|
106
|
-
createRemotePortalSession(workspaceId: string, returnUrl: string, update
|
|
108
|
+
createRemotePortalSession(workspaceId: string, returnUrl: string, update?: WorkspaceSubscriptionUpdateModel | null, cancel?: boolean | null): Promise<string>;
|
|
107
109
|
/** Remote: Resend the invitation */
|
|
108
110
|
resendRemoteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
109
111
|
/** Remote: Restore the cancelled subscription */
|
|
@@ -124,59 +126,33 @@ export declare class DataCoreWriteRequests {
|
|
|
124
126
|
updateRemoteDesignSystemDocumentationSlug(designSystem: DesignSystem, docUserSlug: string): Promise<void>;
|
|
125
127
|
/** Remote: Deletes a design system */
|
|
126
128
|
deleteDesignSystem(designSystemId: string): Promise<void>;
|
|
127
|
-
|
|
128
|
-
createRemoteDocumentationPage(designSystemId: string, versionId: string, data:
|
|
129
|
-
page: DocumentationLegacyPageModel;
|
|
130
|
-
}>;
|
|
129
|
+
private elementAction;
|
|
130
|
+
createRemoteDocumentationPage(designSystemId: string, versionId: string, data: DTOCreateDocumentationPageInputV2): Promise<any>;
|
|
131
131
|
/** Remote: create a group within documentation */
|
|
132
|
-
createRemoteDocumentationGroup(designSystemId: string, versionId: string,
|
|
133
|
-
|
|
134
|
-
|
|
132
|
+
createRemoteDocumentationGroup(designSystemId: string, versionId: string, data: DTOCreateDocumentationGroupInput): Promise<any>;
|
|
133
|
+
/** Remote: create a group within documentation */
|
|
134
|
+
createRemoteDocumentationTab(designSystemId: string, versionId: string, data: DTOCreateDocumentationTabInput): Promise<any>;
|
|
135
135
|
/** Remote: update a documentation page */
|
|
136
|
-
|
|
137
|
-
result: {
|
|
138
|
-
page: DocumentationLegacyPageModel;
|
|
139
|
-
};
|
|
140
|
-
}>;
|
|
141
|
-
/** Remote: update a documentation page header image */
|
|
142
|
-
updateRemoteDocumentationHeaderImage(designSystemId: string, versionId: string, page: DocumentationLegacyPage | DocumentationLegacyGroup, image: File | null): Promise<{
|
|
143
|
-
result: {
|
|
144
|
-
page: DocumentationLegacyPageModel;
|
|
145
|
-
} | {
|
|
146
|
-
group: DocumentationLegacyGroupModel;
|
|
147
|
-
};
|
|
148
|
-
}>;
|
|
136
|
+
updateRemoteDocumentationPage(designSystemId: string, versionId: string, data: DTOUpdateDocumentationPageInputV2): Promise<any>;
|
|
149
137
|
/** Remote: updates a documentation group */
|
|
150
|
-
updateRemoteDocumentationGroup(designSystemId: string, versionId: string,
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
138
|
+
updateRemoteDocumentationGroup(designSystemId: string, versionId: string, data: DTOUpdateDocumentationGroupInput): Promise<any>;
|
|
139
|
+
/** Remote: moves a documentation page */
|
|
140
|
+
moveRemoteDocumentationPage(designSystemId: string, versionId: string, data: DTOMoveDocumentationPageInputV2): Promise<any>;
|
|
141
|
+
/** Remote: moves a documentation group */
|
|
142
|
+
moveRemoteDocumentationGroup(designSystemId: string, versionId: string, data: DTOMoveDocumentationGroupInput): Promise<any>;
|
|
155
143
|
/** Remote: creates a duplicate of a documentation page */
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
};
|
|
160
|
-
}>;
|
|
161
|
-
/** Remote: creates a duplicate of a documentation group or tabbed page */
|
|
162
|
-
duplicateRemoteDocumentationGroupOrTabbedPage(designSystemId: string, versionId: string, idInVersion: string, persistentId: string): Promise<{
|
|
163
|
-
result: {
|
|
164
|
-
group: DocumentationLegacyGroupModel;
|
|
165
|
-
};
|
|
166
|
-
}>;
|
|
144
|
+
duplicateRemoteDocumentationPage(designSystemId: string, versionId: string, data: DTODuplicateDocumentationPageInputV2): Promise<any>;
|
|
145
|
+
/** Remote: creates a duplicate of a documentation group */
|
|
146
|
+
duplicateRemoteDocumentationGroup(designSystemId: string, versionId: string, data: DTODuplicateDocumentationGroupInput): Promise<any>;
|
|
167
147
|
/** Remote: deletes a documentation page */
|
|
168
|
-
deleteRemoteDocumentationPage(designSystemId: string, versionId: string,
|
|
169
|
-
/** Remote:
|
|
170
|
-
|
|
148
|
+
deleteRemoteDocumentationPage(designSystemId: string, versionId: string, data: DTODeleteDocumentationPageInputV2): Promise<any>;
|
|
149
|
+
/** Remote: deletes a documentation tab group */
|
|
150
|
+
deleteRemoteDocumentationTabGroup(designSystemId: string, versionId: string, data: DTODeleteDocumentationTabGroupInput): Promise<any>;
|
|
171
151
|
/** Remote: Deletes a documentation group */
|
|
172
|
-
deleteRemoteDocumentationGroup(designSystemId: string, versionId: string,
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
status: "Queued" | "InProgress" | "Failure";
|
|
177
|
-
jobId: string;
|
|
178
|
-
exporterId: string;
|
|
179
|
-
}>;
|
|
152
|
+
deleteRemoteDocumentationGroup(designSystemId: string, versionId: string, data: DTODeleteDocumentationGroupInput): Promise<any>;
|
|
153
|
+
publishDocumentation(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<ExportBuildModel>;
|
|
154
|
+
/** Remote: Render specific figma frames */
|
|
155
|
+
renderFigmaFrames(designSystemId: string, versionId: string, data: Array<DTOFigmaNodeRenderInput>): Promise<Array<DTOFigmaNode>>;
|
|
180
156
|
createRemoteToken(designSystemId: string, versionId: string, token: TokenRemoteModel): Promise<TokenRemoteModel>;
|
|
181
157
|
updateRemoteToken(designSystemId: string, versionId: string, token: TokenRemoteModel): Promise<TokenRemoteModel>;
|
|
182
158
|
createRemoteTokenGroup(designSystemId: string, versionId: string, group: TokenGroupRemoteModel): Promise<TokenGroupRemoteModel>;
|
|
@@ -186,6 +162,9 @@ export declare class DataCoreWriteRequests {
|
|
|
186
162
|
createRemoteTokenTheme(designSystemId: string, versionId: string, theme: TokenThemeRemoteModel): Promise<TokenThemeRemoteModel>;
|
|
187
163
|
updateRemoteTokenTheme(designSystemId: string, versionId: string, group: TokenThemeRemoteModel): Promise<void>;
|
|
188
164
|
deleteRemoteTokenTheme(designSystemId: string, versionId: string, themeId: string): Promise<void>;
|
|
165
|
+
createThemeOverrideForToken(designSystemId: string, versionId: string, themeId: string, override: TokenThemeOverrideTranserObject): Promise<void>;
|
|
166
|
+
updateThemeOverrideForToken(designSystemId: string, versionId: string, tokenPersistentId: string, themeId: string, override: TokenThemeOverrideTranserObject): Promise<void>;
|
|
167
|
+
deleteThemeOverrideForToken(designSystemId: string, versionId: string, tokenPersistentId: string, themeId: string): Promise<void>;
|
|
189
168
|
writeTokenData(designSystemId: string, versionId: string, tokens: Array<TokenRemoteModel>, groups: Array<TokenGroupRemoteModel>, deleteTokens: Array<Token>, deleteTokenGroups: Array<TokenGroup>): Promise<void>;
|
|
190
169
|
writeTokenThemeData(designSystemId: string, versionId: string, theme: TokenThemeRemoteModel): Promise<void>;
|
|
191
170
|
updateTokenPropertyValue(designSystemId: string, versionId: string, newValue: string | boolean | number, tokenId: string, propertyId: string): Promise<void>;
|
|
@@ -198,9 +177,13 @@ export declare class DataCoreWriteRequests {
|
|
|
198
177
|
/** Remote: Upload a new asset resource */
|
|
199
178
|
uploadAssetResource(designSystemId: string, versionId: string, asset: File): Promise<ResourceAssetModel>;
|
|
200
179
|
/** Remote: Upload a new font resource */
|
|
201
|
-
uploadFontResource(designSystemId: string, versionId: string, font: File): Promise<ResourceFontModel>;
|
|
180
|
+
uploadFontResource(designSystemId: string, versionId: string, font: File): Promise<ResourceFontModel | null>;
|
|
181
|
+
/** Remote: Upload a new font resources */
|
|
182
|
+
uploadFontResources(designSystemId: string, versionId: string, fonts: FileList): Promise<ResourceFontModel[]>;
|
|
202
183
|
/** Remote: Delete a resource */
|
|
203
184
|
deleteResource(designSystemId: string, versionId: string, resourceId: string): Promise<void>;
|
|
185
|
+
/** Remote: Delete resources */
|
|
186
|
+
deleteResources(designSystemId: string, versionId: string, resourceIds: string[]): Promise<void>;
|
|
204
187
|
createRemoteComponent(designSystemId: string, versionId: string, component: ComponentRemoteModel): Promise<ComponentRemoteModel>;
|
|
205
188
|
updateRemoteComponent(designSystemId: string, versionId: string, component: ComponentUpdateRemoteModel): Promise<ComponentRemoteModel>;
|
|
206
189
|
createRemoteComponentGroup(designSystemId: string, versionId: string, group: ComponentGroupRemoteModel): Promise<ComponentGroupRemoteModel>;
|
|
@@ -217,6 +200,10 @@ export declare class DataCoreWriteRequests {
|
|
|
217
200
|
updateResizeComponentColumn(designSystemId: string, versionId: string, viewId: string, columnType: ElementDataViewColumnType, columnId: string, columnThemeId: string | undefined, columnBasePropertyType: string | undefined, columnPropertyDefinitionId: string | undefined, newWidth: number): Promise<void>;
|
|
218
201
|
/** Remote: Deletes a OAuth integration */
|
|
219
202
|
deleteOAuthIntegration(userId: string, service: "figma" | ExporterProvider): Promise<void>;
|
|
203
|
+
/** Remote: Create Authentication Token */
|
|
204
|
+
createAuthenticationToken(name: string, scope?: string): Promise<CreateAuthenticationTokenPayload>;
|
|
205
|
+
/** Remote: Delete Authentication Token */
|
|
206
|
+
deleteAuthenticationToken(id: string): Promise<AuthenticationTokenPayload>;
|
|
220
207
|
/** Remote: Create Personal Access token connection */
|
|
221
208
|
createPersonalAccessTokenConnection(service: ConnectionProviders, connection: PersonalAccessTokenConnectionPayload | AzurePersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
|
|
222
209
|
/** Remote: Create pipeline */
|
|
@@ -233,6 +220,10 @@ export declare class DataCoreWriteRequests {
|
|
|
233
220
|
updateRemoteExporter(workspaceId: string, exporterId: string, payload: NewExporterPayload): Promise<any>;
|
|
234
221
|
/** Remote: Deletes an exporter */
|
|
235
222
|
deleteRemoteExporter(workspaceId: string, exporterId: string): Promise<any>;
|
|
223
|
+
/** Remote: Updates an exporter configuration property value */
|
|
224
|
+
updateRemoteExporterConfigurationPropertyValue(designSystemId: string, exporterId: string, propertyKey: string, propertyValue: any): Promise<any>;
|
|
225
|
+
/** Remote: Deletes an exporter configuration property value */
|
|
226
|
+
deleteRemoteExporterConfigurationPropertyValue(designSystemId: string, exporterId: string, propertyKey: string): Promise<any>;
|
|
236
227
|
/** Remote: Schedules import job */
|
|
237
228
|
scheduleImportJobForFigmaSources(designSystemId: string, versionId: string, sourceIds: Array<string>, dryRun: boolean): Promise<ImportJobRemoteModel>;
|
|
238
229
|
/** Remote: Deletes a remote data source */
|