@supernova-studio/supernova-sdk-beta 1.6.26 → 1.6.28
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/src/core/SDKSupernova.d.ts +3 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +140 -6
- package/build/sdk-typescript/src/core/areas/SDKAreaBulkOperations.d.ts +2 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaDataSources.d.ts +14 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +10 -3
- package/build/sdk-typescript/src/core/areas/SDKAreaIntegrations.d.ts +27 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaStorage.d.ts +23 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaVersions.d.ts +1 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +65 -6
- package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +1 -1
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +71 -11
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +50 -6
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +38 -8
- package/build/sdk-typescript/src/core/resolvers/SDKTokenResolver.d.ts +3 -3
- package/build/sdk-typescript/src/exports-pulsar.d.ts +1 -1
- package/build/sdk-typescript/src/exports.d.ts +11 -2
- 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-group/SDKDocsBlockActualTokenGroup.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/properties/SDKDocsBlockTokenProperty.d.ts +4 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityHeader.d.ts +2 -2
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyGroup.d.ts +3 -3
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageAsset.d.ts +6 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockFrame.d.ts +4 -1
- package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationLegacyItemHeader.d.ts +5 -2
- package/build/sdk-typescript/src/model/enums/SDKConnectionProviders.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKUserRole.d.ts +1 -0
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionProduct.d.ts +1 -1
- 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 +8 -0
- package/build/sdk-typescript/src/model/exporters/SDKPipeline.d.ts +43 -61
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuildResults.d.ts +1 -2
- 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 +2 -0
- package/build/sdk-typescript/src/model/support/SDKFigmaFrame.d.ts +20 -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/SDKLogger.d.ts +4 -0
- package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +1 -1
- package/build/sdk-typescript/src/model/tokens/SDKStringToken.d.ts +2 -2
- package/build/sdk-typescript/src/model/users/SDKUser.d.ts +6 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceInvitation.d.ts +5 -1
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProduct.d.ts +21 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProductPrice.d.ts +40 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceSSOSettings.d.ts +2 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceSubscription.d.ts +34 -7
- package/build/sdk-typescript/src/tests/Areas/AreaStorage.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/helpers.d.ts +1 -1
- package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +6 -2
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONConverter.d.ts +1 -1
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONParser.d.ts +3 -1
- package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformBlock.d.ts +2 -2
- package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformUtil.d.ts +1 -1
- package/build/sdk-typescript/src/tools/token-transform/SDKToolsTokenTransform.d.ts +1 -1
- package/build/sdk-typescript/src/utils/TokenUtils.d.ts +6 -6
- package/build/supernova-sdk-typescript.js +1 -1
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +2 -2
|
@@ -9,6 +9,7 @@ import { AreaDocumentation } from "./areas/SDKAreaDocumentation";
|
|
|
9
9
|
import { AreaIntegrations } from "./areas/SDKAreaIntegrations";
|
|
10
10
|
import { AreaMe } from "./areas/SDKAreaMe";
|
|
11
11
|
import { AreaNetwork } from "./areas/SDKAreaNetwork";
|
|
12
|
+
import { AreaStorage } from "./areas/SDKAreaStorage";
|
|
12
13
|
import { AreaTokens } from "./areas/SDKAreaTokens";
|
|
13
14
|
import { AreaUsers } from "./areas/SDKAreaUsers";
|
|
14
15
|
import { AreaVersions } from "./areas/SDKAreaVersions";
|
|
@@ -49,6 +50,8 @@ export declare class Supernova {
|
|
|
49
50
|
dataSources: AreaDataSources;
|
|
50
51
|
/** Get, create, update, manipulate or delete data from Supernova en masse */
|
|
51
52
|
bulkOperations: AreaBulkOperations;
|
|
53
|
+
/** Read and write data using Supernova key-value storage */
|
|
54
|
+
storage: AreaStorage;
|
|
52
55
|
/** Get access to network in exporter packages */
|
|
53
56
|
network: AreaNetwork;
|
|
54
57
|
/**
|
|
@@ -1,10 +1,24 @@
|
|
|
1
1
|
import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
|
|
2
|
+
import { CodegenAccount } from "../../model/exporters/CodegenAccount";
|
|
3
|
+
import { CodegenAzureOrganization } from "../../model/exporters/CodegenAzureOrganization";
|
|
4
|
+
import { CodegenAzureProject } from "../../model/exporters/CodegenAzureProject";
|
|
5
|
+
import { CodegenAzureRepository } from "../../model/exporters/CodegenAzureRepository";
|
|
6
|
+
import { CodegenBitbucketBranch } from "../../model/exporters/CodegenBitbucketBranch";
|
|
7
|
+
import { CodegenBitbucketProject } from "../../model/exporters/CodegenBitbucketProject";
|
|
8
|
+
import { CodegenBitbucketRepository } from "../../model/exporters/CodegenBitbucketRepository";
|
|
9
|
+
import { CodegenBitbucketWorkspace } from "../../model/exporters/CodegenBitbucketWorkspace";
|
|
10
|
+
import { CodegenBranch } from "../../model/exporters/CodegenBranch";
|
|
11
|
+
import { CodegenConnection } from "../../model/exporters/CodegenConnection";
|
|
12
|
+
import { CodegenGitlabBranch } from "../../model/exporters/CodegenGitlabBranch";
|
|
13
|
+
import { CodegenGitlabGroup } from "../../model/exporters/CodegenGitlabGroup";
|
|
14
|
+
import { CodegenGitlabRepository } from "../../model/exporters/CodegenGitlabRepository";
|
|
15
|
+
import { CodegenRepository } from "../../model/exporters/CodegenRepository";
|
|
16
|
+
import { Exporter } from "../../model/exporters/SDKExporter";
|
|
17
|
+
import { NewPipelinePayload, Pipeline, PipelineUpdateModel } from "../../model/exporters/SDKPipeline";
|
|
2
18
|
import { ExporterCustomBlockVariant } from "../../model/exporters/custom_blocks/SDKExporterCustomBlockVariant";
|
|
3
19
|
import { ExporterConfigurationProperty } from "../../model/exporters/custom_properties/SDKExporterConfigurationProperty";
|
|
4
20
|
import { ExportBuild } from "../../model/exporters/exporter_builds/SDKExportBuild";
|
|
5
|
-
import {
|
|
6
|
-
import { Exporter } from "../../model/exporters/SDKExporter";
|
|
7
|
-
import { NewPipelinePayload, Pipeline } from "../../model/exporters/SDKPipeline";
|
|
21
|
+
import { ExportBuildResultLog } from "../../model/exporters/exporter_builds/SDKExportBuildResults";
|
|
8
22
|
import { ImportJob } from "../../model/jobs/SDKImportJob";
|
|
9
23
|
import { DataCore } from "../data/SDKDataCore";
|
|
10
24
|
import { RemoteVersionIdentifier, RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
@@ -12,13 +26,133 @@ export declare class AreaAutomation {
|
|
|
12
26
|
/** Internal: Engine */
|
|
13
27
|
private dataCore;
|
|
14
28
|
constructor(dataCore: DataCore);
|
|
15
|
-
/** Fetches all pipelines that are available
|
|
16
|
-
getPipelines(workspaceId: string): Promise<Array<Pipeline>>;
|
|
29
|
+
/** Fetches all pipelines that are available by workspace id and design system id */
|
|
30
|
+
getPipelines(workspaceId: string, designSystemId?: string): Promise<Array<Pipeline>>;
|
|
31
|
+
/**
|
|
32
|
+
* Fetches all github connections for user
|
|
33
|
+
* @returns Github Connections
|
|
34
|
+
*/
|
|
35
|
+
getGithubConnections(): Promise<CodegenConnection[]>;
|
|
36
|
+
/**
|
|
37
|
+
* Fetches github accounts
|
|
38
|
+
* @returns Github accounts
|
|
39
|
+
*/
|
|
40
|
+
getGithubAccounts(githubConnectionId: string): Promise<CodegenAccount[]>;
|
|
41
|
+
/**
|
|
42
|
+
* Fetches github repositories
|
|
43
|
+
* @returns Github repositories
|
|
44
|
+
*/
|
|
45
|
+
getGithubRepositories(githubConnectionId: string, handle: string): Promise<CodegenRepository[]>;
|
|
46
|
+
/**
|
|
47
|
+
* Fetches github
|
|
48
|
+
* @returns Github branches
|
|
49
|
+
*/
|
|
50
|
+
getGithubBranches(githubConnectionId: string, handle: string, repoName: string): Promise<CodegenBranch[]>;
|
|
51
|
+
/**
|
|
52
|
+
* Fetches all Gitlab connections for user
|
|
53
|
+
* @returns Gitlab Connections
|
|
54
|
+
*/
|
|
55
|
+
getGitlabConnections(): Promise<CodegenConnection[]>;
|
|
56
|
+
/**
|
|
57
|
+
* Fetches Gitlab groups
|
|
58
|
+
* @param connectionId
|
|
59
|
+
* @returns Gitlab groups
|
|
60
|
+
*/
|
|
61
|
+
getGitlabGroups(connectionId: string): Promise<CodegenGitlabGroup[]>;
|
|
62
|
+
/**
|
|
63
|
+
* Fetches Gitlab repositories
|
|
64
|
+
* @param connectionId
|
|
65
|
+
* @param groupId
|
|
66
|
+
* @returns Gitlab repositories
|
|
67
|
+
*/
|
|
68
|
+
getGitlabRepositories(connectionId: string, groupId: string): Promise<CodegenGitlabRepository[]>;
|
|
69
|
+
/**
|
|
70
|
+
* Fetches Gitlab
|
|
71
|
+
* @param connectionId
|
|
72
|
+
* @param repoId
|
|
73
|
+
* @returns Gitlab branches
|
|
74
|
+
*/
|
|
75
|
+
getGitlabBranches(connectionId: string, repoId: string): Promise<CodegenGitlabBranch[]>;
|
|
76
|
+
/**
|
|
77
|
+
* Fetches all Azure connections for user
|
|
78
|
+
* @returns Azure Connections
|
|
79
|
+
*/
|
|
80
|
+
getAzureConnections(): Promise<CodegenConnection[]>;
|
|
81
|
+
/**
|
|
82
|
+
* Fetches Azure organizations
|
|
83
|
+
* @param connectionId
|
|
84
|
+
* @returns Azure organizations
|
|
85
|
+
*/
|
|
86
|
+
getAzureOrganizations(connectionId: string): Promise<CodegenAzureOrganization[]>;
|
|
87
|
+
/**
|
|
88
|
+
* Fetches Azure projects
|
|
89
|
+
* @param connectionId
|
|
90
|
+
* @param organizationId
|
|
91
|
+
* @returns Azure projects
|
|
92
|
+
*/
|
|
93
|
+
getAzureProjects(connectionId: string, organizationId: string): Promise<CodegenAzureProject[]>;
|
|
94
|
+
/**
|
|
95
|
+
* Fetches Azure repositories
|
|
96
|
+
* @param connectionId
|
|
97
|
+
* @param organizationId
|
|
98
|
+
* @param projectId
|
|
99
|
+
* @returns Azure repositories
|
|
100
|
+
*/
|
|
101
|
+
getAzureRepositories(connectionId: string, organizationId: string, projectId: string): Promise<CodegenAzureRepository[]>;
|
|
102
|
+
/**
|
|
103
|
+
* Fetches Azure branches
|
|
104
|
+
* @param connectionId
|
|
105
|
+
* @param organizationId
|
|
106
|
+
* @param projectId
|
|
107
|
+
* @param repositoryId
|
|
108
|
+
* @returns Azure branches
|
|
109
|
+
*/
|
|
110
|
+
getAzureBranches(connectionId: string, organizationId: string, projectId: string, repositoryId: string): Promise<CodegenGitlabBranch[]>;
|
|
111
|
+
/**
|
|
112
|
+
* Fetches all Bitbucket connections for user
|
|
113
|
+
* @returns Bitbucket Connections
|
|
114
|
+
*/
|
|
115
|
+
getBitbucketConnections(): Promise<CodegenConnection[]>;
|
|
116
|
+
/**
|
|
117
|
+
* Fetches Bitbucket workspaces
|
|
118
|
+
* @param connectionId
|
|
119
|
+
* @returns Bitbucket workspaces
|
|
120
|
+
*/
|
|
121
|
+
getBitbucketWorkspaces(connectionId: string): Promise<CodegenBitbucketWorkspace[]>;
|
|
122
|
+
/**
|
|
123
|
+
* Fetches Bitbucket projects
|
|
124
|
+
* @param connectionId
|
|
125
|
+
* @param workspaceId
|
|
126
|
+
* @returns Bitbucket projects
|
|
127
|
+
*/
|
|
128
|
+
getBitbucketProjects(connectionId: string, workspaceId: string): Promise<CodegenBitbucketProject[]>;
|
|
129
|
+
/**
|
|
130
|
+
* Fetches Bitbucket repositories
|
|
131
|
+
* @param connectionId
|
|
132
|
+
* @param workspaceId
|
|
133
|
+
* @param projectId
|
|
134
|
+
* @returns Bitbucket repositories
|
|
135
|
+
*/
|
|
136
|
+
getBitbucketRepositories(connectionId: string, workspaceId: string, projectId?: string): Promise<CodegenBitbucketRepository[]>;
|
|
137
|
+
/**
|
|
138
|
+
* Fetches Bitbucket branches
|
|
139
|
+
* @param connectionId
|
|
140
|
+
* @param workspaceId
|
|
141
|
+
* @param projectId
|
|
142
|
+
* @param repositoryId
|
|
143
|
+
* @returns Bitbucket branches
|
|
144
|
+
*/
|
|
145
|
+
getBitbucketBranches(connectionId: string, workspaceId: string, projectId: string, repositoryId: string): Promise<CodegenBitbucketBranch[]>;
|
|
17
146
|
/** Fetches all builds of pipelines
|
|
18
147
|
* @param workspaceId - Identifier of the workspace where the pipeline is installed
|
|
19
148
|
* @param versionId - Identifier of the version where the pipeline is installed
|
|
20
149
|
*/
|
|
21
150
|
getExportBuilds(workspaceId: string, versionId: string): Promise<Array<ExportBuild>>;
|
|
151
|
+
/** Fetches build logs of a specific build
|
|
152
|
+
* @param workspaceId - Identifier of the workspace where the pipeline is installed
|
|
153
|
+
* @param buildId - Identifier of the build to fetch logs for
|
|
154
|
+
*/
|
|
155
|
+
getExportBuildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLog>>;
|
|
22
156
|
/** Fetches exporters belonging to workspace by id */
|
|
23
157
|
getExporters(workspaceId: string, filter?: {
|
|
24
158
|
installedOnly?: boolean;
|
|
@@ -65,7 +199,7 @@ export declare class AreaAutomation {
|
|
|
65
199
|
* @param pipeline Pipeline
|
|
66
200
|
* @returns Pipeline
|
|
67
201
|
*/
|
|
68
|
-
updatePipeline(workspaceId: string,
|
|
202
|
+
updatePipeline(workspaceId: string, pipelineUpdateModel: PipelineUpdateModel): Promise<Pipeline>;
|
|
69
203
|
/**
|
|
70
204
|
* Run pipeline
|
|
71
205
|
* @param workspaceId string
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { Component } from "../../model/components/SDKComponent";
|
|
2
2
|
import { ElementProperty } from "../../model/elements/SDKElementProperty";
|
|
3
3
|
import { TokenGroup } from "../../model/groups/SDKTokenGroup";
|
|
4
|
+
import { ImportJob } from "../../model/jobs/SDKImportJob";
|
|
4
5
|
import { TokenTheme } from "../../model/themes/SDKTokenTheme";
|
|
5
6
|
import { AnyToken } from "../../model/tokens/SDKTokenValue";
|
|
6
7
|
import { DataCore } from "../data/SDKDataCore";
|
|
@@ -39,7 +40,7 @@ export declare class AreaBulkOperations {
|
|
|
39
40
|
* @param payload - Payload to import. Types to come
|
|
40
41
|
* @returns Nothing
|
|
41
42
|
*/
|
|
42
|
-
importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", payload: any): Promise<
|
|
43
|
+
importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", payload: any): Promise<ImportJob>;
|
|
43
44
|
/** Batch updates, creates or deletes token data from Supernova at once. Use this method to perform multiple operations at once instead of chaining single update operations. Batch routine runs everything in a single transaction, so either all operations succeed or all fail.
|
|
44
45
|
*
|
|
45
46
|
* WARNING: This method is not yet complete and only supports limited set of operations. Also, doesn't work as transation just yet.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { FigmaStructure } from "../../model/support/SDKFigmaStructure";
|
|
2
|
+
import { FigmaStructureDetail } from "../../model/support/SDKFigmaStructureDetail";
|
|
1
3
|
import { Source, SourceRemoteModelCloud } from "../../model/support/SDKSource";
|
|
2
4
|
import { DataCore } from "../data/SDKDataCore";
|
|
3
5
|
import { RemoteBrandIdentifier, RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
@@ -15,6 +17,18 @@ export declare class AreaDataSources {
|
|
|
15
17
|
* @returns All data sources in the specified version
|
|
16
18
|
*/
|
|
17
19
|
getDataSources(from: RemoteVersionIdentifier): Promise<Array<Source>>;
|
|
20
|
+
/** Retrieves all figma frames structures
|
|
21
|
+
* @param from - Remote version to fetch from
|
|
22
|
+
* @returns All data sources in the specified version
|
|
23
|
+
*/
|
|
24
|
+
getFigmaNodeStructures(from: RemoteVersionIdentifier): Promise<Array<FigmaStructure>>;
|
|
25
|
+
/** Retrieves figma frame structure detail
|
|
26
|
+
* @param from - Remote version to fetch from
|
|
27
|
+
* @returns All data sources in the specified version
|
|
28
|
+
*/
|
|
29
|
+
getFigmaNodeStructureDetail(from: RemoteVersionIdentifier & {
|
|
30
|
+
figmaStructureId: string;
|
|
31
|
+
}): Promise<FigmaStructureDetail>;
|
|
18
32
|
linkFigmaSource(from: RemoteBrandIdentifier, url: string, options: {
|
|
19
33
|
scopes: {
|
|
20
34
|
tokens: boolean;
|
|
@@ -5,7 +5,7 @@ import { DocsEntity } from "../../model/docs/entities/SDKDocsEntity";
|
|
|
5
5
|
import { DocsSection } from "../../model/docs/sections/SDKDocsSection";
|
|
6
6
|
import { DocumentationLegacyGroup, DocumentationLegacyGroupModel } from "../../model/documentation/SDKDocumentationLegacyGroup";
|
|
7
7
|
import { DocumentationLegacyPage, DocumentationLegacyPageModel } from "../../model/documentation/SDKDocumentationLegacyPage";
|
|
8
|
-
import { DataCore } from "../data/SDKDataCore";
|
|
8
|
+
import { DataCore, DeepPartial } from "../data/SDKDataCore";
|
|
9
9
|
import { RemoteVersionIdentifier, RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
10
10
|
export declare class AreaDocumentation {
|
|
11
11
|
/** Internal: Engine */
|
|
@@ -75,9 +75,16 @@ export declare class AreaDocumentation {
|
|
|
75
75
|
* @param from - Remote version to fetch from
|
|
76
76
|
* @param page - page to update
|
|
77
77
|
* @param updateModel - data to update page with
|
|
78
|
-
* @returns
|
|
78
|
+
* @returns page
|
|
79
|
+
*/
|
|
80
|
+
updateDocumentationPageOrTab(from: RemoteWorkspaceVersionIdentifier, page: DocumentationLegacyPage, updateModel: DeepPartial<DocumentationLegacyPageModel>): Promise<void>;
|
|
81
|
+
/** Updates a documentation page header image
|
|
82
|
+
* @param from - Remote version to fetch from
|
|
83
|
+
* @param page - page to update
|
|
84
|
+
* @param file - file to update a page header with
|
|
85
|
+
* @returns page
|
|
79
86
|
*/
|
|
80
|
-
|
|
87
|
+
updateDocumentationHeaderImage(from: RemoteWorkspaceVersionIdentifier, page: DocumentationLegacyPage | DocumentationLegacyGroup, file: File | null): Promise<DocumentationLegacyPage | DocumentationLegacyGroup>;
|
|
81
88
|
/** Duplicates a documentation tab or page
|
|
82
89
|
* @param from - Remote version to fetch from
|
|
83
90
|
* @param idInVersion - id of page or tab to be duplicated
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { AzurePersonalAccessTokenConnectionPayload, PersonalAccessTokenConnectionPayload } from "../../model/exporters/SDKConnections";
|
|
2
|
+
import { ConnectionRemoteModel } from "../../model/exporters/remote/SDKRemoteConnectionsModel";
|
|
1
3
|
import { DataCore } from "../data/SDKDataCore";
|
|
2
4
|
export declare class AreaIntegrations {
|
|
3
5
|
/** Internal: Engine */
|
|
@@ -23,6 +25,31 @@ export declare class AreaIntegrations {
|
|
|
23
25
|
* @returns Azure OAuth URL
|
|
24
26
|
*/
|
|
25
27
|
getAzureOAuthURL(): Promise<string>;
|
|
28
|
+
/** Creates user GitHub personal access token integration.
|
|
29
|
+
* @param customUrl - Custom GitHub URL. If not provided, default GitHub URL will be used.
|
|
30
|
+
* @param token - GitHub access token.
|
|
31
|
+
* @param name - Name of the integration.
|
|
32
|
+
*/
|
|
33
|
+
createGitHubPersonalAccessTokenConnection(connection: PersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
|
|
34
|
+
/** Creates user GitLab personal access token integration.
|
|
35
|
+
* @param customUrl - Custom GitLab URL. If not provided, default GitLab URL will be used.
|
|
36
|
+
* @param token - GitLab access token.
|
|
37
|
+
* @param name - Name of the integration.
|
|
38
|
+
*/
|
|
39
|
+
createGitLabPersonalAccessTokenConnection(connection: PersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
|
|
40
|
+
/** Creates user Bitbucket personal access token integration.
|
|
41
|
+
* @param customUrl - Custom Bitbucket URL. If not provided, default Bitbucket URL will be used.
|
|
42
|
+
* @param token - Bitbucket access token.
|
|
43
|
+
* @param name - Name of the integration.
|
|
44
|
+
* @param organization - Organization name.
|
|
45
|
+
*/
|
|
46
|
+
createBitbucketPersonalAccessTokenConnection(connection: PersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
|
|
47
|
+
/** Creates user Azure personal access token integration.
|
|
48
|
+
* @param customUrl - Custom Azure URL. If not provided, default Azure URL will be used.
|
|
49
|
+
* @param token - Azure access token.
|
|
50
|
+
* @param name - Name of the integration.
|
|
51
|
+
*/
|
|
52
|
+
createAzurePersonalAccessTokenConnection(connection: AzurePersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
|
|
26
53
|
/** Deletes user Figma OAuth integration.
|
|
27
54
|
* @param userId - User id to delete integration for. Can only be invoked on user id that is currently authenticated.
|
|
28
55
|
* @returns Nothing
|
|
@@ -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
|
+
}
|
|
@@ -31,5 +31,5 @@ export declare class AreaVersions {
|
|
|
31
31
|
/** Fetches design system version by id */
|
|
32
32
|
getVersion(from: RemoteVersionIdentifier): Promise<DesignSystemVersion>;
|
|
33
33
|
getTokenStudioData(from: RemoteVersionIdentifier): Promise<object>;
|
|
34
|
-
writeTokenStudioData(from: RemoteVersionIdentifier, data: object): Promise<
|
|
34
|
+
writeTokenStudioData(from: RemoteVersionIdentifier, data: object): Promise<object>;
|
|
35
35
|
}
|
|
@@ -1,16 +1,18 @@
|
|
|
1
1
|
import { Acl } from "../../model/acl/SDKAcl";
|
|
2
|
+
import { UserRoleWithoutOwner } from "../../model/enums/SDKUserRole";
|
|
2
3
|
import { Membership } from "../../model/membership/SDKMembership";
|
|
3
4
|
import { UserMembership } from "../../model/users/SDKUserMembership";
|
|
4
5
|
import { Workspace } from "../../model/workspaces/SDKWorkspace";
|
|
5
|
-
import { WorkspaceInvitation } from "../../model/workspaces/SDKWorkspaceInvitation";
|
|
6
|
-
import { WorkspaceInvoice } from "../../model/workspaces/SDKWorkspaceInvoice";
|
|
7
6
|
import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
7
|
+
import { WorkspaceInvitation, WorkspaceInvitationUpdateModel } from "../../model/workspaces/SDKWorkspaceInvitation";
|
|
8
|
+
import { WorkspaceInvoice } from "../../model/workspaces/SDKWorkspaceInvoice";
|
|
8
9
|
import { WorkspaceNPMRegistrySettings, WorkspaceNPMRegistrySettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
|
|
9
10
|
import { WorkspaceOnboarding, WorkspaceOnboardingUpdateModel } from "../../model/workspaces/SDKWorkspaceOnboarding";
|
|
11
|
+
import { WorkspaceProduct } from "../../model/workspaces/SDKWorkspaceProduct";
|
|
10
12
|
import { SubscriptionProductFeatures } from "../../model/workspaces/SDKWorkspaceProductFeatures";
|
|
11
13
|
import { WorkspaceProfileUpdateModel } from "../../model/workspaces/SDKWorkspaceProfile";
|
|
12
|
-
import { WorkspaceSSOSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
13
|
-
import { WorkspaceSubscription } from "../../model/workspaces/SDKWorkspaceSubscription";
|
|
14
|
+
import { WorkspaceSSOSettings, WorkspaceSSOSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
15
|
+
import { WorkspaceSubscription, WorkspaceSubscriptionUpdateModel } from "../../model/workspaces/SDKWorkspaceSubscription";
|
|
14
16
|
import { DataCore } from "../data/SDKDataCore";
|
|
15
17
|
export declare class AreaWorkspaces {
|
|
16
18
|
/** Internal: Engine */
|
|
@@ -36,7 +38,11 @@ export declare class AreaWorkspaces {
|
|
|
36
38
|
* @returns All users that are members of the provided workspace
|
|
37
39
|
*/
|
|
38
40
|
userMemberships(workspaceId: string): Promise<Array<UserMembership>>;
|
|
39
|
-
|
|
41
|
+
/** Fetches product features grouped by product code
|
|
42
|
+
* @param workspaceId - ID of the workspace
|
|
43
|
+
* @returns Product features
|
|
44
|
+
*/
|
|
45
|
+
workspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeatures>;
|
|
40
46
|
acls(): Promise<Acl>;
|
|
41
47
|
/** Validates if the handle is available for use
|
|
42
48
|
* @param handle - Handle to validate
|
|
@@ -62,7 +68,7 @@ export declare class AreaWorkspaces {
|
|
|
62
68
|
* @param workspaceId - ID of the workspace
|
|
63
69
|
* @returns Workspace SSO settings or null if the workspace is not using SSO
|
|
64
70
|
*/
|
|
65
|
-
workspaceSSOSettings(workspaceId: string): Promise<
|
|
71
|
+
workspaceSSOSettings(workspaceId: string): Promise<WorkspaceSSOSettings | null>;
|
|
66
72
|
/** Fetches all invitations that are part of the workspace.
|
|
67
73
|
* @param workspaceId - ID of the workspace
|
|
68
74
|
* @returns All invitations of the provided workspace
|
|
@@ -78,6 +84,11 @@ export declare class AreaWorkspaces {
|
|
|
78
84
|
* @returns A subscription of the provided workspace
|
|
79
85
|
*/
|
|
80
86
|
workspaceSubscription(workspaceId: string): Promise<WorkspaceSubscription>;
|
|
87
|
+
/** Fetches all products that are available to the workspace.
|
|
88
|
+
* @param workspaceId - ID of the workspace
|
|
89
|
+
* @returns All available products
|
|
90
|
+
*/
|
|
91
|
+
workspaceAvailableProducts(workspaceId: string): Promise<Array<WorkspaceProduct>>;
|
|
81
92
|
/** Creates new workspace and retrieves the newly created workspace object. The user who creates the workspace becomes its owner
|
|
82
93
|
* @param name - Name of the workspace
|
|
83
94
|
* @param handle - Handle of the workspace to create. Use `validateIsWorkspaceHandleAvailable` to check if the handle is available
|
|
@@ -128,6 +139,54 @@ export declare class AreaWorkspaces {
|
|
|
128
139
|
* @returns Nothing
|
|
129
140
|
*/
|
|
130
141
|
updateWorkspaceNPMRegistrySettings(workspaceId: string, npmRegistrySettings: WorkspaceNPMRegistrySettingsUpdateModel): Promise<void>;
|
|
142
|
+
/** Transfers an ownership of the workspace.
|
|
143
|
+
* Old owner receives new owner's previous role.
|
|
144
|
+
* @param workspaceId - ID of the workspace
|
|
145
|
+
* @param newOwnerUserId - ID of the user to transfer the ownership to
|
|
146
|
+
* @returns Nothing
|
|
147
|
+
*/
|
|
148
|
+
updateWorkspaceOwnership(workspaceId: string, newOwnerUserId: string): Promise<void>;
|
|
149
|
+
/** Updates a role of a member.
|
|
150
|
+
* @param workspaceId - ID of the workspace
|
|
151
|
+
* @param userId - ID of the user
|
|
152
|
+
* @param newRole - New role of the user
|
|
153
|
+
* @returns Nothing
|
|
154
|
+
*/
|
|
155
|
+
updateWorkspaceMemberRole(workspaceId: string, userId: string, newRole: UserRoleWithoutOwner): Promise<void>;
|
|
156
|
+
/** Updates a role of an invitation.
|
|
157
|
+
* @param workspaceId - ID of the workspace
|
|
158
|
+
* @param invitationId - ID of the invitation
|
|
159
|
+
* @param newRole - New role
|
|
160
|
+
* @returns Nothing
|
|
161
|
+
*/
|
|
162
|
+
updateWorkspaceInvitationRole(workspaceId: string, invitationId: string, newRole: UserRoleWithoutOwner): Promise<void>;
|
|
163
|
+
/** Invites new members to the workspace
|
|
164
|
+
* @param workspaceId - ID of the workspace
|
|
165
|
+
* @param invitations - array of invitations
|
|
166
|
+
* @returns Nothing
|
|
167
|
+
*/
|
|
168
|
+
addWorkspaceInvitations(workspaceId: string, invitations: Array<WorkspaceInvitationUpdateModel>): Promise<void>;
|
|
169
|
+
/** Creates a new Stripe checkout session.
|
|
170
|
+
* @param workspaceId - ID of the workspace
|
|
171
|
+
* @param priceId - ID of the Stripe price to be applied to the workspace
|
|
172
|
+
* @param successUrl - URL to redirect to after successful payment
|
|
173
|
+
* @param cancelUrl - URL to redirect to after failed payment
|
|
174
|
+
* @returns string - URL to the Stripe checkout
|
|
175
|
+
*/
|
|
176
|
+
createCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string): Promise<string>;
|
|
177
|
+
/** Creates a new Stripe customer portal session.
|
|
178
|
+
* @param workspaceId - ID of the workspace
|
|
179
|
+
* @param returnUrl - URL to redirect to from the portal
|
|
180
|
+
* @param update - describes the subscription updates to be applied
|
|
181
|
+
* @returns string - URL to the Stripe customer portal
|
|
182
|
+
*/
|
|
183
|
+
createPortalSession(workspaceId: string, returnUrl: string, update?: WorkspaceSubscriptionUpdateModel | null): Promise<string>;
|
|
184
|
+
/** Resend an invitation to the workspace.
|
|
185
|
+
* @param workspaceId - ID of the workspace
|
|
186
|
+
* @param invitationId - ID of the invitation
|
|
187
|
+
* @returns Nothing
|
|
188
|
+
*/
|
|
189
|
+
resendWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
131
190
|
/** Deletes a single workspace. This action is irreversible, all data will be lost, and can only be performed by the workspace owner
|
|
132
191
|
* @param workspaceId - ID of the workspace
|
|
133
192
|
* @returns Nothing
|
|
@@ -36,7 +36,7 @@ export declare class DataBridge {
|
|
|
36
36
|
get(endpoint: string): Promise<any>;
|
|
37
37
|
put(endpoint: string, payload: any | null): Promise<any>;
|
|
38
38
|
post(endpoint: string, payload: any | null): Promise<any>;
|
|
39
|
-
upload(endpoint: string, fileKey: string, file: File): Promise<any>;
|
|
39
|
+
upload(endpoint: string, fileKey: string, file: File, method?: "PUT" | "POST"): Promise<any>;
|
|
40
40
|
private request;
|
|
41
41
|
private handleResponse;
|
|
42
42
|
private buildRequestConfig;
|