@supernova-studio/supernova-sdk-beta 1.6.25 → 1.6.27
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/README.md +3 -3
- package/build/sdk-typescript/src/core/SDKSupernova.d.ts +19 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +167 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaBulkOperations.d.ts +12 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDataSources.d.ts +14 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDesignSystems.d.ts +37 -2
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +94 -4
- package/build/sdk-typescript/src/core/areas/SDKAreaIntegrations.d.ts +27 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaNetwork.d.ts +9 -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 +69 -1
- package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +3 -1
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +120 -5
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +61 -2
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +99 -5
- package/build/sdk-typescript/src/core/resolvers/SDKTokenResolver.d.ts +2 -1
- package/build/sdk-typescript/src/exports-pulsar.d.ts +228 -0
- package/build/sdk-typescript/src/exports.d.ts +63 -25
- package/build/sdk-typescript/src/index.d.ts +4 -0
- package/build/sdk-typescript/src/model/assets/SDKAsset.d.ts +1 -0
- package/build/sdk-typescript/src/model/base/SDKDesignSystem.d.ts +6 -8
- package/build/sdk-typescript/src/model/components/SDKDesignComponent.d.ts +2 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockLayout.d.ts +13 -5
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockVariant.d.ts +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{h1/SDKDocsBlockActualH1.d.ts → embed/SDKDocsBlockActualEmbed.d.ts} +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed-figma/SDKDocsBlockActualEmbedFigma.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed-lottie/SDKDocsBlockActualEmbedLottie.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed-youtube/SDKDocsBlockActualEmbedYoutube.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/markdown/SDKDocsBlockActualMarkdown.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{links/SDKDocsBlockActualLinks.d.ts → shortcut-links/SDKDocsBlockActualShortcutLinks.d.ts} +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/storybook/SDKDocsBlockActualStorybook.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{h2/SDKDocsBlockActualH2.d.ts → table/SDKDocsBlockActualTable.d.ts} +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{h3/SDKDocsBlockActualH3.d.ts → title1/SDKDocsBlockActualTitle1.d.ts} +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{h4/SDKDocsBlockActualH4.d.ts → title2/SDKDocsBlockActualTitle2.d.ts} +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/title3/SDKDocsBlockActualTitle3.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/title4/SDKDocsBlockActualTitle4.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/title5/SDKDocsBlockActualTitle5.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockImageProperty.d.ts +2 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +3 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityGroup.d.ts +2 -2
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityHeader.d.ts +2 -2
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyConfiguration.d.ts +9 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyGroup.d.ts +2 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPage.d.ts +3 -1
- 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/SDKDocumentationLegacyItemConfiguration.d.ts +1 -0
- package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationLegacyItemHeader.d.ts +8 -2
- package/build/sdk-typescript/src/model/enums/SDKBorderPosition.d.ts +1 -0
- package/build/sdk-typescript/src/model/enums/SDKBorderStyle.d.ts +1 -0
- package/build/sdk-typescript/src/model/enums/SDKCloudWarningType.d.ts +14 -0
- package/build/sdk-typescript/src/model/enums/SDKConnectionProviders.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKCustomDomainErrorCode.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKCustomDomainState.d.ts +9 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockCategory.d.ts +15 -9
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockImagePropertyWidth.d.ts +12 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +4 -2
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutAlign.d.ts +8 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutColumnResizing.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutGap.d.ts +10 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockTextPropertyColor.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockTextPropertyStyle.d.ts +20 -4
- package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts +3 -3
- 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/enums/SDKWorkspaceSubscriptionStatus.d.ts +6 -14
- 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/SDKExporter.d.ts +16 -12
- package/build/sdk-typescript/src/model/exporters/SDKPipeline.d.ts +113 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuild.d.ts +104 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuildResults.d.ts +72 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportDestinations.d.ts +111 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenBranchModel.d.ts +5 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenOrganizationModel.d.ts +5 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenProjectModel.d.ts +5 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenRepositoryModel.d.ts +9 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenBranchModel.d.ts +5 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenProjectModel.d.ts +4 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenRepositoryModel.d.ts +6 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenWorkspaceModel.d.ts +4 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenAccountModel.d.ts +7 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenBranchModel.d.ts +6 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenConnectionModel.d.ts +8 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenRepositoryModel.d.ts +17 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteConnectionsModel.d.ts +9 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenBranchModel.d.ts +5 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenGroupModel.d.ts +4 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenRepositoryModel.d.ts +7 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemotePipelineModel.d.ts +57 -0
- package/build/sdk-typescript/src/model/jobs/SDKImportJob.d.ts +2 -7
- package/build/sdk-typescript/src/model/support/SDKCustomDomain.d.ts +21 -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/support/SDKSource.d.ts +20 -8
- package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +3 -0
- package/build/sdk-typescript/src/model/tokens/SDKDimensionToken.d.ts +1 -1
- package/build/sdk-typescript/src/model/users/SDKUser.d.ts +6 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspace.d.ts +0 -5
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceInvitation.d.ts +35 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceInvoice.d.ts +38 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProduct.d.ts +21 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProductFeatures.d.ts +3 -1
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProductPrice.d.ts +40 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceSubscription.d.ts +34 -35
- package/build/sdk-typescript/src/pulsar-interfaces.d.ts +40 -0
- package/build/sdk-typescript/src/tests/Areas/AreaStorage.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +7 -3
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONParser.d.ts +3 -1
- package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +25 -4
- package/build/supernova-sdk-typescript.js +2 -70428
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +17 -15
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/h5/SDKDocsBlockActualH5.d.ts +0 -6
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionStatusInternal.d.ts +0 -8
- package/build/sdk-typescript/src/tests/Areas/AreaTokenValues.d.ts +0 -0
|
@@ -1,13 +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";
|
|
6
|
+
import { WorkspaceInvitation, WorkspaceInvitationUpdateModel } from "../../model/workspaces/SDKWorkspaceInvitation";
|
|
7
|
+
import { WorkspaceInvoice } from "../../model/workspaces/SDKWorkspaceInvoice";
|
|
5
8
|
import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
6
9
|
import { WorkspaceNPMRegistrySettings, WorkspaceNPMRegistrySettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
|
|
7
10
|
import { WorkspaceOnboarding, WorkspaceOnboardingUpdateModel } from "../../model/workspaces/SDKWorkspaceOnboarding";
|
|
11
|
+
import { WorkspaceProduct } from "../../model/workspaces/SDKWorkspaceProduct";
|
|
8
12
|
import { SubscriptionProductFeatures } from "../../model/workspaces/SDKWorkspaceProductFeatures";
|
|
9
13
|
import { WorkspaceProfileUpdateModel } from "../../model/workspaces/SDKWorkspaceProfile";
|
|
10
14
|
import { WorkspaceSSOSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
15
|
+
import { WorkspaceSubscription } from "../../model/workspaces/SDKWorkspaceSubscription";
|
|
11
16
|
import { DataCore } from "../data/SDKDataCore";
|
|
12
17
|
export declare class AreaWorkspaces {
|
|
13
18
|
/** Internal: Engine */
|
|
@@ -33,7 +38,11 @@ export declare class AreaWorkspaces {
|
|
|
33
38
|
* @returns All users that are members of the provided workspace
|
|
34
39
|
*/
|
|
35
40
|
userMemberships(workspaceId: string): Promise<Array<UserMembership>>;
|
|
36
|
-
|
|
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>;
|
|
37
46
|
acls(): Promise<Acl>;
|
|
38
47
|
/** Validates if the handle is available for use
|
|
39
48
|
* @param handle - Handle to validate
|
|
@@ -60,6 +69,26 @@ export declare class AreaWorkspaces {
|
|
|
60
69
|
* @returns Workspace SSO settings or null if the workspace is not using SSO
|
|
61
70
|
*/
|
|
62
71
|
workspaceSSOSettings(workspaceId: string): Promise<WorkspaceSSOSettingsUpdateModel | null>;
|
|
72
|
+
/** Fetches all invitations that are part of the workspace.
|
|
73
|
+
* @param workspaceId - ID of the workspace
|
|
74
|
+
* @returns All invitations of the provided workspace
|
|
75
|
+
*/
|
|
76
|
+
workspaceInvitations(workspaceId: string): Promise<Array<WorkspaceInvitation>>;
|
|
77
|
+
/** Fetches all invoices for the workspace.
|
|
78
|
+
* @param workspaceId - ID of the workspace
|
|
79
|
+
* @returns All invoices of the provided workspace
|
|
80
|
+
*/
|
|
81
|
+
workspaceInvoices(workspaceId: string): Promise<Array<WorkspaceInvoice>>;
|
|
82
|
+
/** Fetches a subscription of the workspace.
|
|
83
|
+
* @param workspaceId - ID of the workspace
|
|
84
|
+
* @returns A subscription of the provided workspace
|
|
85
|
+
*/
|
|
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>>;
|
|
63
92
|
/** Creates new workspace and retrieves the newly created workspace object. The user who creates the workspace becomes its owner
|
|
64
93
|
* @param name - Name of the workspace
|
|
65
94
|
* @param handle - Handle of the workspace to create. Use `validateIsWorkspaceHandleAvailable` to check if the handle is available
|
|
@@ -110,6 +139,33 @@ export declare class AreaWorkspaces {
|
|
|
110
139
|
* @returns Nothing
|
|
111
140
|
*/
|
|
112
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>;
|
|
113
169
|
/** Deletes a single workspace. This action is irreversible, all data will be lost, and can only be performed by the workspace owner
|
|
114
170
|
* @param workspaceId - ID of the workspace
|
|
115
171
|
* @returns Nothing
|
|
@@ -125,4 +181,16 @@ export declare class AreaWorkspaces {
|
|
|
125
181
|
* @returns Nothing
|
|
126
182
|
*/
|
|
127
183
|
deleteWorkspaceNPMRegistrySettings(workspaceId: string): Promise<void>;
|
|
184
|
+
/** Deletes a member from the workspace.
|
|
185
|
+
* @param workspaceId - ID of the workspace
|
|
186
|
+
* @param userId - ID of the member
|
|
187
|
+
* @returns Nothing
|
|
188
|
+
*/
|
|
189
|
+
deleteWorkspaceMember(workspaceId: string, userId: string): Promise<void>;
|
|
190
|
+
/** Deletes an invitation from the workspace.
|
|
191
|
+
* @param workspaceId - ID of the workspace
|
|
192
|
+
* @param invitationId - ID of the invitation
|
|
193
|
+
* @returns Nothing
|
|
194
|
+
*/
|
|
195
|
+
deleteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
128
196
|
}
|
|
@@ -17,6 +17,7 @@ export type DataBridgeConfiguration = {
|
|
|
17
17
|
apiVersion: string;
|
|
18
18
|
accessToken: string;
|
|
19
19
|
target: string | null;
|
|
20
|
+
bypassEnvFetch: boolean;
|
|
20
21
|
requestHook: DataBridgeRequestHook | null;
|
|
21
22
|
debugRequestObserver?: DebugRequestObserver | null;
|
|
22
23
|
debugResponseObserver?: DebugResponseObserver | null;
|
|
@@ -26,6 +27,7 @@ export declare class DataBridge {
|
|
|
26
27
|
apiUrl: string;
|
|
27
28
|
apiVersion: string;
|
|
28
29
|
target: string | null;
|
|
30
|
+
bypassEnvFetch: boolean;
|
|
29
31
|
requestHook: DataBridgeRequestHook | null;
|
|
30
32
|
debugRequestObserver: DebugRequestObserver | null;
|
|
31
33
|
debugResponseObserver: DebugResponseObserver | null;
|
|
@@ -34,7 +36,7 @@ export declare class DataBridge {
|
|
|
34
36
|
get(endpoint: string): Promise<any>;
|
|
35
37
|
put(endpoint: string, payload: any | null): Promise<any>;
|
|
36
38
|
post(endpoint: string, payload: any | null): Promise<any>;
|
|
37
|
-
upload(endpoint: string, fileKey: string, file: File): Promise<any>;
|
|
39
|
+
upload(endpoint: string, fileKey: string, file: File, method?: "PUT" | "POST"): Promise<any>;
|
|
38
40
|
private request;
|
|
39
41
|
private handleResponse;
|
|
40
42
|
private buildRequestConfig;
|
|
@@ -2,28 +2,55 @@ import { Acl } from "../../model/acl/SDKAcl";
|
|
|
2
2
|
import { Asset } from "../../model/assets/SDKAsset";
|
|
3
3
|
import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
|
|
4
4
|
import { Brand, BrandUpdateModel } from "../../model/base/SDKBrand";
|
|
5
|
-
import { DesignSystem } from "../../model/base/SDKDesignSystem";
|
|
5
|
+
import { DesignSystem, DesignSystemSwitcher } from "../../model/base/SDKDesignSystem";
|
|
6
6
|
import { DesignSystemVersion, DesignSystemVersionUpdateModel } from "../../model/base/SDKDesignSystemVersion";
|
|
7
|
-
import { DocumentationLegacy } from "../../model/base/SDKDocumentationLegacy";
|
|
7
|
+
import { DocumentationLegacy, DocumentationLegacyModel } from "../../model/base/SDKDocumentationLegacy";
|
|
8
8
|
import { Component } from "../../model/components/SDKComponent";
|
|
9
9
|
import { DesignComponent } from "../../model/components/SDKDesignComponent";
|
|
10
|
+
import { DocumentationLegacyGroup, DocumentationLegacyGroupModel } from "../../model/documentation/SDKDocumentationLegacyGroup";
|
|
10
11
|
import { DocumentationLegacyItem } from "../../model/documentation/SDKDocumentationLegacyItem";
|
|
12
|
+
import { DocumentationLegacyPage, DocumentationLegacyPageModel } from "../../model/documentation/SDKDocumentationLegacyPage";
|
|
11
13
|
import { ElementDataView } from "../../model/elements/SDKElementDataView";
|
|
12
14
|
import { ElementDataViewColumn } from "../../model/elements/SDKElementDataViewColumn";
|
|
13
15
|
import { ElementProperty, ElementPropertyCreationModel, ElementPropertyTargetElementType, ElementPropertyUpdateModel } from "../../model/elements/SDKElementProperty";
|
|
14
16
|
import { ElementPropertyValue } from "../../model/elements/values/SDKElementPropertyValue";
|
|
17
|
+
import { ConnectionProviders } from "../../model/enums/SDKConnectionProviders";
|
|
15
18
|
import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
|
|
16
19
|
import { TokenType } from "../../model/enums/SDKTokenType";
|
|
20
|
+
import { UserRoleWithoutOwner } from "../../model/enums/SDKUserRole";
|
|
21
|
+
import { CodegenAccount } from "../../model/exporters/CodegenAccount";
|
|
22
|
+
import { CodegenAzureBranch } from "../../model/exporters/CodegenAzureBranch";
|
|
23
|
+
import { CodegenAzureOrganization } from "../../model/exporters/CodegenAzureOrganization";
|
|
24
|
+
import { CodegenAzureProject } from "../../model/exporters/CodegenAzureProject";
|
|
25
|
+
import { CodegenAzureRepository } from "../../model/exporters/CodegenAzureRepository";
|
|
26
|
+
import { CodegenBitbucketBranch } from "../../model/exporters/CodegenBitbucketBranch";
|
|
27
|
+
import { CodegenBitbucketProject } from "../../model/exporters/CodegenBitbucketProject";
|
|
28
|
+
import { CodegenBitbucketRepository } from "../../model/exporters/CodegenBitbucketRepository";
|
|
29
|
+
import { CodegenBitbucketWorkspace } from "../../model/exporters/CodegenBitbucketWorkspace";
|
|
30
|
+
import { CodegenBranch } from "../../model/exporters/CodegenBranch";
|
|
31
|
+
import { CodegenConnection } from "../../model/exporters/CodegenConnection";
|
|
32
|
+
import { CodegenGitlabBranch } from "../../model/exporters/CodegenGitlabBranch";
|
|
33
|
+
import { CodegenGitlabGroup } from "../../model/exporters/CodegenGitlabGroup";
|
|
34
|
+
import { CodegenGitlabRepository } from "../../model/exporters/CodegenGitlabRepository";
|
|
35
|
+
import { CodegenRepository } from "../../model/exporters/CodegenRepository";
|
|
17
36
|
import { ExporterCustomBlock } from "../../model/exporters/custom_blocks/SDKExporterCustomBlock";
|
|
18
37
|
import { ExporterCustomBlockVariant } from "../../model/exporters/custom_blocks/SDKExporterCustomBlockVariant";
|
|
19
38
|
import { ExporterConfigurationProperty } from "../../model/exporters/custom_properties/SDKExporterConfigurationProperty";
|
|
39
|
+
import { ExportBuild } from "../../model/exporters/exporter_builds/SDKExportBuild";
|
|
40
|
+
import { ExportBuildResultLog } from "../../model/exporters/exporter_builds/SDKExportBuildResults";
|
|
41
|
+
import { ConnectionRemoteModel } from "../../model/exporters/remote/SDKRemoteConnectionsModel";
|
|
42
|
+
import { AzurePersonalAccessTokenConnectionPayload, PersonalAccessTokenConnectionPayload } from "../../model/exporters/SDKConnections";
|
|
20
43
|
import { Exporter } from "../../model/exporters/SDKExporter";
|
|
44
|
+
import { NewPipelinePayload, Pipeline, PipelineUpdateModel } from "../../model/exporters/SDKPipeline";
|
|
21
45
|
import { AssetGroup } from "../../model/groups/SDKAssetGroup";
|
|
22
46
|
import { ComponentGroup } from "../../model/groups/SDKComponentGroup";
|
|
23
47
|
import { DesignComponentGroup } from "../../model/groups/SDKDesignComponentGroup";
|
|
24
48
|
import { TokenGroup } from "../../model/groups/SDKTokenGroup";
|
|
25
49
|
import { ImportJob } from "../../model/jobs/SDKImportJob";
|
|
26
50
|
import { Membership } from "../../model/membership/SDKMembership";
|
|
51
|
+
import { CustomDomain } from "../../model/support/SDKCustomDomain";
|
|
52
|
+
import { FigmaStructure } from "../../model/support/SDKFigmaStructure";
|
|
53
|
+
import { FigmaStructureDetail } from "../../model/support/SDKFigmaStructureDetail";
|
|
27
54
|
import { Source, SourceRemoteModelCloud } from "../../model/support/SDKSource";
|
|
28
55
|
import { TokenTheme } from "../../model/themes/SDKTokenTheme";
|
|
29
56
|
import { Token } from "../../model/tokens/SDKToken";
|
|
@@ -31,15 +58,23 @@ import { User } from "../../model/users/SDKUser";
|
|
|
31
58
|
import { UserMembership } from "../../model/users/SDKUserMembership";
|
|
32
59
|
import { UserProfileUpdateModel } from "../../model/users/SDKUserProfile";
|
|
33
60
|
import { Workspace } from "../../model/workspaces/SDKWorkspace";
|
|
61
|
+
import { WorkspaceInvitation, WorkspaceInvitationUpdateModel } from "../../model/workspaces/SDKWorkspaceInvitation";
|
|
62
|
+
import { WorkspaceInvoice } from "../../model/workspaces/SDKWorkspaceInvoice";
|
|
34
63
|
import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
35
64
|
import { WorkspaceNPMRegistrySettings, WorkspaceNPMRegistrySettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
|
|
36
65
|
import { WorkspaceOnboarding, WorkspaceOnboardingUpdateModel } from "../../model/workspaces/SDKWorkspaceOnboarding";
|
|
66
|
+
import { WorkspaceProduct } from "../../model/workspaces/SDKWorkspaceProduct";
|
|
37
67
|
import { SubscriptionProductFeatures } from "../../model/workspaces/SDKWorkspaceProductFeatures";
|
|
38
68
|
import { WorkspaceProfileUpdateModel } from "../../model/workspaces/SDKWorkspaceProfile";
|
|
39
69
|
import { WorkspaceSSOSettings, WorkspaceSSOSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
70
|
+
import { WorkspaceSubscription } from "../../model/workspaces/SDKWorkspaceSubscription";
|
|
40
71
|
import { ComponentUpdateTransactionData, TokenUpdateTransactionData } from "../areas/SDKAreaBulkOperations";
|
|
41
72
|
import { RenderedAssetRequestSettings } from "./requests/SDKDataCoreRenderRequests";
|
|
42
73
|
import { DataBridge } from "./SDKDataBridge";
|
|
74
|
+
import { RequestInfo, RequestInit, Response } from "node-fetch";
|
|
75
|
+
export type DeepPartial<T> = T extends object ? {
|
|
76
|
+
[P in keyof T]?: DeepPartial<T[P]>;
|
|
77
|
+
} : T;
|
|
43
78
|
export declare class DataCore {
|
|
44
79
|
/** Read part of the network calls */
|
|
45
80
|
private read;
|
|
@@ -47,7 +82,10 @@ export declare class DataCore {
|
|
|
47
82
|
private write;
|
|
48
83
|
/** Asset generation part of the network calls */
|
|
49
84
|
private render;
|
|
85
|
+
/** Bridge */
|
|
86
|
+
private bridge;
|
|
50
87
|
constructor(bridge: DataBridge);
|
|
88
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
51
89
|
/** Remote: Get information about currently logged in user */
|
|
52
90
|
currentUser(): Promise<User>;
|
|
53
91
|
/** Remote: Get information about a specific user */
|
|
@@ -56,7 +94,6 @@ export declare class DataCore {
|
|
|
56
94
|
memberships(userId: string): Promise<Array<Membership>>;
|
|
57
95
|
/** Remote: Get information about all workspaces user has access to, including which role they play */
|
|
58
96
|
userMemberships(workspaceId: string): Promise<Array<UserMembership>>;
|
|
59
|
-
subscriptionProductFeatures(): Promise<SubscriptionProductFeatures>;
|
|
60
97
|
acls(): Promise<Acl>;
|
|
61
98
|
/** Deletes the user by id. Can only really delete its own user */
|
|
62
99
|
deleteUser(userId: string): Promise<void>;
|
|
@@ -134,6 +171,28 @@ export declare class DataCore {
|
|
|
134
171
|
id: string;
|
|
135
172
|
idInVersion: string;
|
|
136
173
|
}>;
|
|
174
|
+
/** Create a page within documentation */
|
|
175
|
+
createDocumentationPage(designSystemId: string, versionId: string, parentItemPersistentId: string, newTitle?: string): Promise<DocumentationLegacyPage>;
|
|
176
|
+
/** Create a group within documentation */
|
|
177
|
+
createDocumentationGroup(designSystemId: string, versionId: string, parentItemPersistentId: string, data: Partial<DocumentationLegacyGroupModel>): Promise<DocumentationLegacyGroup>;
|
|
178
|
+
/** Ungroup a documentaiton group */
|
|
179
|
+
ungroupDocumentationGroup(designSystemId: string, versionId: string, groupId: string): Promise<void>;
|
|
180
|
+
/** Updates a documentation group */
|
|
181
|
+
updateDocumentationGroup(designSystemId: string, versionId: string, group: DocumentationLegacyGroup, updateModel: Partial<DocumentationLegacyGroupModel>): Promise<DocumentationLegacyGroup>;
|
|
182
|
+
/** Updates a documentation page or tab */
|
|
183
|
+
updateDocumentationPageOrTab(designSystemId: string, versionId: string, page: DocumentationLegacyPage, updateModel: DeepPartial<DocumentationLegacyPageModel>): Promise<void>;
|
|
184
|
+
/** Updates a documentation page header image */
|
|
185
|
+
updateDocumentationHeaderImage(designSystemId: string, versionId: string, page: DocumentationLegacyPage | DocumentationLegacyGroup, image: File | null): Promise<DocumentationLegacyPage | DocumentationLegacyGroup>;
|
|
186
|
+
/** Duplicate a documentation page or tab */
|
|
187
|
+
duplicateDocumentationPageOrTab(designSystemId: string, versionId: string, idInVersion: string, newPersistentId?: string): Promise<DocumentationLegacyPage>;
|
|
188
|
+
/** Duplicate a documentation group or tabbed page */
|
|
189
|
+
duplicateDocumentationGroupOrTabbedPage(designSystemId: string, versionId: string, idInVersion: string, newPersistentId?: string): Promise<void>;
|
|
190
|
+
/** Delete a documentation page */
|
|
191
|
+
deleteDocumentationPage(designSystemId: string, versionId: string, idInVerision: string): Promise<void>;
|
|
192
|
+
/** Delete a documentation group */
|
|
193
|
+
deleteDocumentationGroup(designSystemId: string, versionId: string, group: DocumentationLegacyGroup): Promise<void>;
|
|
194
|
+
/** Delete a documentation group and tree inside it */
|
|
195
|
+
deleteDocumentationGroupAndTree(designSystemId: string, versionId: string, group: DocumentationLegacyGroup): Promise<void>;
|
|
137
196
|
/** Create a custom property in remote */
|
|
138
197
|
updateTokenProperty(designSystemId: string, versionId: string, propertyIdInVersion: string, model: ElementPropertyUpdateModel): Promise<void>;
|
|
139
198
|
/** Delete a custom property in remote */
|
|
@@ -197,6 +256,7 @@ export declare class DataCore {
|
|
|
197
256
|
renderedAssets(designSystemId: string, versionId: string, assets: Array<Asset>, groups: Array<AssetGroup>, settings: RenderedAssetRequestSettings): Promise<Array<RenderedAsset>>;
|
|
198
257
|
/** Retrieve the main documentation object through which all docs data can be accessed */
|
|
199
258
|
documentation(workspaceId: string, designSystemId: string, versionId: string): Promise<DocumentationLegacy>;
|
|
259
|
+
updateDocumentationStructure(designSystemId: string, versionId: string, model: DocumentationLegacyModel): Promise<void>;
|
|
200
260
|
/** Download all necessary data for documentation items (groups and pages) and retrieve them resolved */
|
|
201
261
|
documentationItems(workspaceId: string, designSystemId: string, versionId: string): Promise<Array<DocumentationLegacyItem>>;
|
|
202
262
|
/** Retrieve currently deployed documentation url */
|
|
@@ -207,6 +267,29 @@ export declare class DataCore {
|
|
|
207
267
|
jobId: string;
|
|
208
268
|
exporterId: string;
|
|
209
269
|
}>;
|
|
270
|
+
pipelines(workspaceId: string, designSystemId: string): Promise<Array<Pipeline>>;
|
|
271
|
+
githubConnections(): Promise<Array<CodegenConnection>>;
|
|
272
|
+
githubAccounts(githubConnectionId: string): Promise<Array<CodegenAccount>>;
|
|
273
|
+
githubRepositories(githubConnectionId: string, handle: string): Promise<Array<CodegenRepository>>;
|
|
274
|
+
githubBranches(githubConnectionId: string, handle: string, repoName: string): Promise<Array<CodegenBranch>>;
|
|
275
|
+
gitlabConnections(): Promise<Array<CodegenConnection>>;
|
|
276
|
+
gitlabGroups(connectionId: string): Promise<Array<CodegenGitlabGroup>>;
|
|
277
|
+
gitlabRepositories(connectionId: string, groupId: string): Promise<Array<CodegenGitlabRepository>>;
|
|
278
|
+
gitlabBranches(connectionId: string, repoId: string): Promise<Array<CodegenGitlabBranch>>;
|
|
279
|
+
azureConnections(): Promise<Array<CodegenConnection>>;
|
|
280
|
+
azureOrganizations(connectionId: string): Promise<Array<CodegenAzureOrganization>>;
|
|
281
|
+
azureProjects(connectionId: string, organizationId: string): Promise<Array<CodegenAzureProject>>;
|
|
282
|
+
azureRepositories(connectionId: string, organizationId: string, projectId: string): Promise<Array<CodegenAzureRepository>>;
|
|
283
|
+
azureBranches(connectionId: string, organizationId: string, projectId: string, repositoryId: string): Promise<Array<CodegenAzureBranch>>;
|
|
284
|
+
bitbucketConnections(): Promise<Array<CodegenConnection>>;
|
|
285
|
+
bitbucketWorkspaces(connectionId: string): Promise<Array<CodegenBitbucketWorkspace>>;
|
|
286
|
+
bitbucketProjects(connectionId: string, workspaceId: string): Promise<Array<CodegenBitbucketProject>>;
|
|
287
|
+
bitbucketRepositories(connectionId: string, workspaceId: string, projectKey?: string): Promise<Array<CodegenBitbucketRepository>>;
|
|
288
|
+
bitbucketBranches(connectionId: string, workspaceId: string, projectId: string, repositoryId: string): Promise<Array<CodegenBitbucketBranch>>;
|
|
289
|
+
createPipeline(workspaceId: string, pipeline: NewPipelinePayload): Promise<Pipeline>;
|
|
290
|
+
updatePipeline(workspaceId: string, pipelineUpdateModel: PipelineUpdateModel): Promise<Pipeline>;
|
|
291
|
+
runPipeline(workspaceId: string, designSystemVersionId: string, pipelineId: string): Promise<Pipeline>;
|
|
292
|
+
deletePipeline(workspaceId: string, pipelineId: string): Promise<void>;
|
|
210
293
|
/** Download information about current exporter custom blocks and retrieve them resolved */
|
|
211
294
|
documentationExporterCustomBlocks(designSystemId: string, versionId: string): Promise<Array<ExporterCustomBlock>>;
|
|
212
295
|
/** Download information about current exporter custom block variants and retrieve them resolved */
|
|
@@ -221,13 +304,18 @@ export declare class DataCore {
|
|
|
221
304
|
/** Download information about installed exporter and retrieve it resolved */
|
|
222
305
|
exporter(workspaceId: string, exporterId: string): Promise<Exporter>;
|
|
223
306
|
/** Download information about all installed exporter and retrieve it resolved */
|
|
224
|
-
exporters(workspaceId: string
|
|
307
|
+
exporters(workspaceId: string, filter?: {
|
|
308
|
+
installedOnly?: boolean;
|
|
309
|
+
}): Promise<Array<Exporter>>;
|
|
310
|
+
exportBuilds(workspaceId: string, exporterId: string, limit?: number): Promise<Array<ExportBuild>>;
|
|
225
311
|
/** Download information about documentation builds and retrieve it resolved */
|
|
226
312
|
documentationBuilds(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment, limit?: number): Promise<Array<{
|
|
227
313
|
status: "InProgress" | "Success" | "Failed";
|
|
228
314
|
id: string | null;
|
|
229
315
|
exporterId: string | null;
|
|
230
316
|
}>>;
|
|
317
|
+
buildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLog>>;
|
|
318
|
+
workspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeatures>;
|
|
231
319
|
/** Download information about a single workspace and retrieve it resolved */
|
|
232
320
|
workspace(workspaceId: string): Promise<Workspace>;
|
|
233
321
|
createWorkspace(name: string, handle?: string): Promise<Workspace>;
|
|
@@ -237,12 +325,18 @@ export declare class DataCore {
|
|
|
237
325
|
createBrand(designSystemId: string, versionId: any, model: BrandUpdateModel): Promise<Brand>;
|
|
238
326
|
editBrand(designSystemId: string, versionId: string, brandId: string, brand: Brand): Promise<void>;
|
|
239
327
|
deleteBrand(designSystemId: string, versionId: string, brandId: string): Promise<void>;
|
|
328
|
+
deleteCustomDomain(designSystemId: string): Promise<void>;
|
|
329
|
+
updateCustomDomain(designSystemId: string, customerDomain: string): Promise<CustomDomain>;
|
|
240
330
|
/** Validate that workspace handle is available */
|
|
241
331
|
validateIsWorkspaceHandleAvailable(handle: string): Promise<boolean>;
|
|
242
332
|
workspaceOnboarding(workspaceId: string): Promise<WorkspaceOnboarding>;
|
|
243
333
|
workspaceIPWhitelistSettings(workspaceId: string): Promise<WorkspaceIPWhitelistSettings | null>;
|
|
244
334
|
workspaceNPMRegistrySettings(workspaceId: string): Promise<WorkspaceNPMRegistrySettings | null>;
|
|
245
335
|
workspaceSSOSettings(workspaceId: string): Promise<WorkspaceSSOSettings | null>;
|
|
336
|
+
workspaceInvitations(workspaceId: string): Promise<Array<WorkspaceInvitation>>;
|
|
337
|
+
workspaceInvoices(workspaceId: string): Promise<Array<WorkspaceInvoice>>;
|
|
338
|
+
workspaceSubscription(workspaceId: string): Promise<WorkspaceSubscription>;
|
|
339
|
+
workspaceAvailableProducts(workspaceId: string): Promise<Array<WorkspaceProduct>>;
|
|
246
340
|
updateWorkspaceProfile(workspaceId: string, profile: WorkspaceProfileUpdateModel): Promise<void>;
|
|
247
341
|
testIpWhitelistSettings(workspaceId: string, ipWhitelistSettings: WorkspaceIPWhitelistSettingsUpdateModel): Promise<{
|
|
248
342
|
accessible: boolean;
|
|
@@ -252,9 +346,15 @@ export declare class DataCore {
|
|
|
252
346
|
updateWorkspaceSSOSettings(workspaceId: string, ssoSettings: WorkspaceSSOSettingsUpdateModel): Promise<void>;
|
|
253
347
|
updateWorkspaceIPWhitelistSettings(workspaceId: string, ipWhitelistSettings: WorkspaceIPWhitelistSettingsUpdateModel): Promise<void>;
|
|
254
348
|
updateWorkspaceNPMRegistrySettings(workspaceId: string, npmRegistrySettings: WorkspaceNPMRegistrySettingsUpdateModel): Promise<void>;
|
|
349
|
+
updateWorkspaceOwnership(workspaceId: string, newOwnerUserId: string): Promise<void>;
|
|
350
|
+
updateWorkspaceMemberRole(workspaceId: string, userId: string, newRole: UserRoleWithoutOwner): Promise<void>;
|
|
351
|
+
updateWorkspaceInvitationRole(workspaceId: string, invitationId: string, newRole: UserRoleWithoutOwner): Promise<void>;
|
|
352
|
+
addWorkspaceInvitations(workspaceId: string, invitations: Array<WorkspaceInvitationUpdateModel>): Promise<void>;
|
|
255
353
|
deleteWorkspace(workspaceId: string): Promise<void>;
|
|
256
354
|
deleteWorkspaceAvatar(workspaceId: string): Promise<void>;
|
|
257
355
|
deleteWorkspaceNPMRegistrySettings(workspaceId: string): Promise<void>;
|
|
356
|
+
deleteWorkspaceMember(workspaceId: string, userId: string): Promise<void>;
|
|
357
|
+
deleteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
258
358
|
/** Download information about a single design system and retrieve it resolved */
|
|
259
359
|
designSystem(designSystemId: string): Promise<DesignSystem>;
|
|
260
360
|
/** Download information about design systems that user has access to under a single workspace and retrieve it resolved */
|
|
@@ -265,12 +365,22 @@ export declare class DataCore {
|
|
|
265
365
|
updateDesignSystemMetadata(designSystemId: string, name: string, description?: string): Promise<void>;
|
|
266
366
|
/** Updates a design system multibrand option */
|
|
267
367
|
updateDesignSystemIsMultibrand(designSystem: DesignSystem, isMultibrand: boolean): Promise<void>;
|
|
368
|
+
/** Updates a design system switcher */
|
|
369
|
+
updateDesignSystemSwitcher(designSystem: DesignSystem, designSystemSwitcher: DesignSystemSwitcher): Promise<void>;
|
|
370
|
+
/** Updates design system doc exporter id */
|
|
371
|
+
updateDesignSystemDocExporterId(designSystem: DesignSystem, docExporterId: string): Promise<void>;
|
|
372
|
+
/** Updates a design system multibrand option */
|
|
373
|
+
updateDesignSystemDocumentationSlug(designSystem: DesignSystem, docUserSlug: string): Promise<void>;
|
|
268
374
|
/** Delete a design system */
|
|
269
375
|
deleteDesignSystem(designSystemId: string): Promise<void>;
|
|
376
|
+
/** Download information about a custom domain */
|
|
377
|
+
designSystemCustomDomain(designSystemId: string): Promise<CustomDomain>;
|
|
270
378
|
/** Download information about a desing system source within a design system design and retrieve it resolved */
|
|
271
379
|
designSystemSource(designSystemId: string, sourceId: string): Promise<Source>;
|
|
272
380
|
/** Download information about all desing system sources within a design system design and retrieve it resolved */
|
|
273
381
|
designSystemSources(designSystemId: string): Promise<Array<Source>>;
|
|
382
|
+
getFigmaNodeStructures(designSystemId: string, versionId: string): Promise<Array<FigmaStructure>>;
|
|
383
|
+
getFigmaNodeStructureDetail(designSystemId: string, versionId: string, figmaStructureId: string): Promise<FigmaStructureDetail>;
|
|
274
384
|
deleteFigmaSource(designSystemId: string, sourceId: string): Promise<void>;
|
|
275
385
|
linkFigmaSource(designSystemId: string, brandId: string, url: string, options: {
|
|
276
386
|
scopes: {
|
|
@@ -299,11 +409,16 @@ export declare class DataCore {
|
|
|
299
409
|
getBrand(designSystemId: string, versionId: string, brandId: string): Promise<Brand>;
|
|
300
410
|
getOAuthURL(service: "figma" | "bitbucket" | "github" | "gitlab" | "azure"): Promise<string>;
|
|
301
411
|
deleteOAuthIntegration(userId: string, service: "figma" | "bitbucket" | "github" | "gitlab" | "azure"): Promise<void>;
|
|
412
|
+
createPersonalAccessTokenConnection(service: ConnectionProviders, connection: PersonalAccessTokenConnectionPayload | AzurePersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
|
|
302
413
|
bulkUpdateTokenData(designSystemId: string, versionId: string, data: TokenUpdateTransactionData): Promise<any>;
|
|
303
414
|
bulkUpdateComponentData(designSystemId: string, versionId: string, data: ComponentUpdateTransactionData): Promise<any>;
|
|
415
|
+
importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", payload: any): Promise<ImportJob>;
|
|
304
416
|
getImportJob(designSystemId: string, versionId: string, jobId: string): Promise<ImportJob>;
|
|
305
417
|
getImportJobs(designSystemId: string, versionId: string): Promise<Array<ImportJob>>;
|
|
306
418
|
scheduleImportJobForFigmaSources(designSystemId: string, versionId: string, sourceIds: Array<string>, dryRun: boolean): Promise<ImportJob>;
|
|
307
419
|
getTokenStudioData(designSystemId: string, versionId: string): Promise<object>;
|
|
308
|
-
writeTokenStudioData(designSystemId: string, versionId: string, data: object): Promise<
|
|
420
|
+
writeTokenStudioData(designSystemId: string, versionId: string, data: object): Promise<object>;
|
|
421
|
+
readKeyValueStorageData(designSystemId: string, key: string): Promise<string | object | undefined>;
|
|
422
|
+
setKeyValueStorageData(designSystemId: string, key: string, value: string | object): Promise<void>;
|
|
423
|
+
unsetKeyValueStorageData(designSystemId: string, key: string): Promise<void>;
|
|
309
424
|
}
|
|
@@ -12,24 +12,49 @@ import { ElementPropertyRemoteModel } from "../../../model/elements/SDKElementPr
|
|
|
12
12
|
import { ElementPropertyValueRemoteModel } from "../../../model/elements/values/SDKElementPropertyValue";
|
|
13
13
|
import { DocumentationEnvironment } from "../../../model/enums/SDKDocumentationEnvironment";
|
|
14
14
|
import { TokenType } from "../../../model/enums/SDKTokenType";
|
|
15
|
+
import { CodegenBitbucketProject } from "../../../model/exporters/CodegenBitbucketProject";
|
|
15
16
|
import { ExporterCustomBlockModel } from "../../../model/exporters/custom_blocks/SDKExporterCustomBlock";
|
|
17
|
+
import { ExportBuildModel } from "../../../model/exporters/exporter_builds/SDKExportBuild";
|
|
18
|
+
import { ExportBuildResultLogModel } from "../../../model/exporters/exporter_builds/SDKExportBuildResults";
|
|
19
|
+
import { CodegenAzureBranchRemoteModel } from "../../../model/exporters/remote/SDKRemoteAzureCodegenBranchModel";
|
|
20
|
+
import { CodegenAzureOrganizationRemoteModel } from "../../../model/exporters/remote/SDKRemoteAzureCodegenOrganizationModel";
|
|
21
|
+
import { CodegenAzureProjectRemoteModel } from "../../../model/exporters/remote/SDKRemoteAzureCodegenProjectModel";
|
|
22
|
+
import { CodegenAzureRepositoryRemoteModel } from "../../../model/exporters/remote/SDKRemoteAzureCodegenRepositoryModel";
|
|
23
|
+
import { CodegenBitbucketBranchRemoteModel } from "../../../model/exporters/remote/SDKRemoteBitbucketCodegenBranchModel";
|
|
24
|
+
import { CodegenBitbucketRepositoryRemoteModel } from "../../../model/exporters/remote/SDKRemoteBitbucketCodegenRepositoryModel";
|
|
25
|
+
import { CodegenBitbucketWorkspaceRemoteModel } from "../../../model/exporters/remote/SDKRemoteBitbucketCodegenWorkspaceModel";
|
|
26
|
+
import { CodegenAccountRemoteModel } from "../../../model/exporters/remote/SDKRemoteCodegenAccountModel";
|
|
27
|
+
import { CodegenBranchRemoteModel } from "../../../model/exporters/remote/SDKRemoteCodegenBranchModel";
|
|
28
|
+
import { CodegenConnectionRemoteModel } from "../../../model/exporters/remote/SDKRemoteCodegenConnectionModel";
|
|
29
|
+
import { CodegenRepositoryRemoteModel } from "../../../model/exporters/remote/SDKRemoteCodegenRepositoryModel";
|
|
30
|
+
import { CodegenGitlabBranchRemoteModel } from "../../../model/exporters/remote/SDKRemoteGitlabCodegenBranchModel";
|
|
31
|
+
import { CodegenGitlabGroupRemoteModel } from "../../../model/exporters/remote/SDKRemoteGitlabCodegenGroupModel";
|
|
32
|
+
import { CodegenGitlabRepositoryRemoteModel } from "../../../model/exporters/remote/SDKRemoteGitlabCodegenRepositoryModel";
|
|
33
|
+
import { PipelineRemoteModel } from "../../../model/exporters/remote/SDKRemotePipelineModel";
|
|
16
34
|
import { ExporterModel } from "../../../model/exporters/SDKExporter";
|
|
17
35
|
import { ComponentGroupRemoteModel } from "../../../model/groups/SDKComponentGroup";
|
|
18
36
|
import { DesignComponentGroupRemoteModel } from "../../../model/groups/SDKDesignComponentGroup";
|
|
19
37
|
import { TokenGroupRemoteModel } from "../../../model/groups/SDKTokenGroup";
|
|
20
38
|
import { ImportJobRemoteModel } from "../../../model/jobs/SDKImportJob";
|
|
21
39
|
import { MembershipRemoteModel } from "../../../model/membership/SDKMembership";
|
|
40
|
+
import { CustomDomainRemoteModel } from "../../../model/support/SDKCustomDomain";
|
|
41
|
+
import { FigmaStructureModel } from "../../../model/support/SDKFigmaStructure";
|
|
42
|
+
import { FigmaStructureDetailModel } from "../../../model/support/SDKFigmaStructureDetail";
|
|
22
43
|
import { SourceRemoteModel } from "../../../model/support/SDKSource";
|
|
23
44
|
import { TokenThemeRemoteModel } from "../../../model/themes/SDKTokenTheme";
|
|
24
45
|
import { TokenRemoteModel } from "../../../model/tokens/remote/SDKRemoteTokenModel";
|
|
25
46
|
import { UserRemoteModel } from "../../../model/users/SDKUser";
|
|
26
47
|
import { UserMembershipRemoteModel } from "../../../model/users/SDKUserMembership";
|
|
27
48
|
import { WorkspaceRemoteModel } from "../../../model/workspaces/SDKWorkspace";
|
|
49
|
+
import { WorkspaceInvitationRemoteModel } from "../../../model/workspaces/SDKWorkspaceInvitation";
|
|
50
|
+
import { WorkspaceInvoiceRemoteModel } from "../../../model/workspaces/SDKWorkspaceInvoice";
|
|
28
51
|
import { WorkspaceIPWhitelistSettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
29
52
|
import { WorkspaceNPMRegistrySettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
|
|
30
53
|
import { WorkspaceOnboardingRemoteModel } from "../../../model/workspaces/SDKWorkspaceOnboarding";
|
|
54
|
+
import { WorkspaceProductRemoteModel } from "../../../model/workspaces/SDKWorkspaceProduct";
|
|
31
55
|
import { SubscriptionProductFeaturesRemoteModel } from "../../../model/workspaces/SDKWorkspaceProductFeatures";
|
|
32
56
|
import { WorkspaceSSOSettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
57
|
+
import { WorkspaceSubscriptionRemoteModel } from "../../../model/workspaces/SDKWorkspaceSubscription";
|
|
33
58
|
import { DataBridge } from "../SDKDataBridge";
|
|
34
59
|
export declare class DataCoreReadRequests {
|
|
35
60
|
private bridge;
|
|
@@ -40,8 +65,8 @@ export declare class DataCoreReadRequests {
|
|
|
40
65
|
getRemoteUser(userId: any): Promise<UserRemoteModel>;
|
|
41
66
|
/** Remote: Get information about all workspaces user can access */
|
|
42
67
|
getRemoteMemberships(userId: string): Promise<Array<MembershipRemoteModel>>;
|
|
43
|
-
getRemoteSubscriptionProductFeatures(): Promise<SubscriptionProductFeaturesRemoteModel>;
|
|
44
68
|
getRemoteAcls(): Promise<AclRemoteModel>;
|
|
69
|
+
getRemoteWorkspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeaturesRemoteModel>;
|
|
45
70
|
/** Remote: Get information about a specific workspace */
|
|
46
71
|
getRemoteWorkspaceDetail(workspaceId: string): Promise<WorkspaceRemoteModel>;
|
|
47
72
|
/** Remote: Validate can use workspace handle */
|
|
@@ -54,14 +79,24 @@ export declare class DataCoreReadRequests {
|
|
|
54
79
|
getRemoteWorkspaceIPWhitelistSettings(workspaceId: string): Promise<WorkspaceIPWhitelistSettingsRemoteModel | null>;
|
|
55
80
|
getRemoteWorkspaceNPMRegistrySettings(workspaceId: string): Promise<WorkspaceNPMRegistrySettingsRemoteModel | null>;
|
|
56
81
|
getRemoteWorkspaceSSOSettings(workspaceId: string): Promise<WorkspaceSSOSettingsRemoteModel | null>;
|
|
82
|
+
getRemoteWorkspaceInvitations(workspaceId: string): Promise<Array<WorkspaceInvitationRemoteModel>>;
|
|
83
|
+
getRemoteWorkspaceInvoices(workspaceId: string): Promise<Array<WorkspaceInvoiceRemoteModel>>;
|
|
84
|
+
getRemoteWorkspaceSubscription(workspaceId: string): Promise<WorkspaceSubscriptionRemoteModel>;
|
|
85
|
+
getRemoteWorkspaceAvailableProducts(workspaceId: string): Promise<Array<WorkspaceProductRemoteModel>>;
|
|
57
86
|
/** Remote: Get information about one specific design system */
|
|
58
87
|
getRemoteDesignSystem(designSystemId: string): Promise<DesignSystemRemoteModel>;
|
|
59
88
|
/** Remote: Get information about all design systems under specific workspace */
|
|
60
89
|
getRemoteDesignSystems(workspaceId: string): Promise<Array<DesignSystemRemoteModel>>;
|
|
90
|
+
/** Remote: Get custom domain */
|
|
91
|
+
getRemoteCustomDomain(designSystemId: string): Promise<CustomDomainRemoteModel>;
|
|
61
92
|
/** Remote: Get a single design source */
|
|
62
93
|
getRemoteSource(designSystemId: string, sourceId: string): Promise<SourceRemoteModel>;
|
|
63
94
|
/** Remote: Get all design sources of a single design system */
|
|
64
95
|
getRemoteSources(designSystemId: string): Promise<Array<SourceRemoteModel>>;
|
|
96
|
+
/** Remote: Get all figma node structures */
|
|
97
|
+
getFigmaNodeStructures(designSystemId: string, versionId: string): Promise<Array<FigmaStructureModel>>;
|
|
98
|
+
/** Remote: Get figma node detail */
|
|
99
|
+
getFigmaNodeStructureDetail(designSystemId: string, versionId: string, figmaStructureId: string): Promise<FigmaStructureDetailModel>;
|
|
65
100
|
/** Remote: Get design system documentation url */
|
|
66
101
|
getRemoteDocumentationUrl(designSystemId: string, versionId: string): Promise<string | null>;
|
|
67
102
|
/** Remote: Get documentation metadata */
|
|
@@ -81,7 +116,9 @@ export declare class DataCoreReadRequests {
|
|
|
81
116
|
/** Remote: Get structural details and metadata about specific installed exporter */
|
|
82
117
|
getRemoteExporter(workspaceId: string, exporterId: string): Promise<ExporterModel>;
|
|
83
118
|
/** Remote: Get structural details and metadata about all exporters */
|
|
84
|
-
getRemoteExporters(workspaceId: string
|
|
119
|
+
getRemoteExporters(workspaceId: string, filter?: {
|
|
120
|
+
installedOnly?: boolean;
|
|
121
|
+
}): Promise<Array<ExporterModel>>;
|
|
85
122
|
/** Remote: Get all tokens from all categories */
|
|
86
123
|
getRemoteTokens(designSystemId: string, versionId: string, filter?: {
|
|
87
124
|
type?: TokenType;
|
|
@@ -116,11 +153,32 @@ export declare class DataCoreReadRequests {
|
|
|
116
153
|
getRemoteElementDataViewDefinitions(designSystemId: string, versionId: string): Promise<Array<ElementDataViewRemoteModel>>;
|
|
117
154
|
/** Remote: Get all property values that were set by the user for each elemen */
|
|
118
155
|
getRemoteElementPropertyValues(designSystemId: string, versionId: string): Promise<ElementPropertyValueRemoteModel[]>;
|
|
156
|
+
getRemotePipelines(workspaceId: string, designSystemId: string): Promise<PipelineRemoteModel[]>;
|
|
157
|
+
getRemoteGithubConnections(): Promise<CodegenConnectionRemoteModel[]>;
|
|
158
|
+
getRemoteGithubAccounts(githubConnectId: string): Promise<CodegenAccountRemoteModel[]>;
|
|
159
|
+
getRemoteGithubRepositories(githubConnectId: string, handle: string): Promise<CodegenRepositoryRemoteModel[]>;
|
|
160
|
+
getRemoteGithubBranches(githubConnectId: string, handle: string, repoName: string): Promise<CodegenBranchRemoteModel[]>;
|
|
161
|
+
getRemoteGitlabConnections(): Promise<CodegenConnectionRemoteModel[]>;
|
|
162
|
+
getRemoteGitlabGroups(connectionId: string): Promise<CodegenGitlabGroupRemoteModel[]>;
|
|
163
|
+
getRemoteGitlabRepositories(connectionId: string, groupId: string): Promise<CodegenGitlabRepositoryRemoteModel[]>;
|
|
164
|
+
getRemoteGitlabBranches(connectionId: string, repoId: string): Promise<CodegenGitlabBranchRemoteModel[]>;
|
|
165
|
+
getRemoteAzureConnections(): Promise<CodegenConnectionRemoteModel[]>;
|
|
166
|
+
getRemoteAzureOrganizations(connectionId: string): Promise<CodegenAzureOrganizationRemoteModel[]>;
|
|
167
|
+
getRemoteAzureProjects(connectionId: string, organizationId: string): Promise<CodegenAzureProjectRemoteModel[]>;
|
|
168
|
+
getRemoteAzureRepositories(connectionId: string, organizationId: string, projectId: string): Promise<CodegenAzureRepositoryRemoteModel[]>;
|
|
169
|
+
getRemoteAzureBranches(connectionId: string, organizationId: string, projectId: string, repositoryId: string): Promise<CodegenAzureBranchRemoteModel[]>;
|
|
170
|
+
getRemoteBitbucketConnections(): Promise<CodegenConnectionRemoteModel[]>;
|
|
171
|
+
getRemoteBitbucketWorkspaces(connectionId: string): Promise<CodegenBitbucketWorkspaceRemoteModel[]>;
|
|
172
|
+
getRemoteBitbucketProjects(connectionId: string, worksapceId: string): Promise<CodegenBitbucketProject[]>;
|
|
173
|
+
getRemoteBitbucketRepositories(connectionId: string, workspaceId: string, projectKey?: string): Promise<CodegenBitbucketRepositoryRemoteModel[]>;
|
|
174
|
+
getRemoteBitbucketBranches(connectionId: string, workspaceId: string, projectId: string, repositoryId: string): Promise<CodegenBitbucketBranchRemoteModel[]>;
|
|
175
|
+
getRemoteBuilds(workspaceId: string, versionId: string): Promise<Array<ExportBuildModel>>;
|
|
119
176
|
getRemoteDocumentationBuilds(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment, limit?: number): Promise<Array<{
|
|
120
177
|
status: "InProgress" | "Success" | "Failed";
|
|
121
178
|
id: string | null;
|
|
122
179
|
exporterId: string | null;
|
|
123
180
|
}>>;
|
|
181
|
+
getRemoteBuildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLogModel>>;
|
|
124
182
|
getBrands(designSystemId: string, versionId: string): Promise<Array<BrandRemoteModel>>;
|
|
125
183
|
getBrand(designSystemId: string, versionId: string, brandId: string): Promise<BrandRemoteModel>;
|
|
126
184
|
getOAuthURL(service: "figma" | "bitbucket" | "github" | "gitlab" | "azure"): Promise<string>;
|
|
@@ -128,5 +186,6 @@ export declare class DataCoreReadRequests {
|
|
|
128
186
|
getVersions(designSystemId: string): Promise<Array<DesignSystemVersionRemoteModel>>;
|
|
129
187
|
getImportJobs(designSystemId: string, versionId: string): Promise<Array<ImportJobRemoteModel>>;
|
|
130
188
|
getImportJob(designSystemId: string, versionId: string, jobId: string): Promise<ImportJobRemoteModel>;
|
|
189
|
+
getKeyValueStorageData(designSystemId: string, keys: Array<string>): Promise<Record<string, string>>;
|
|
131
190
|
getTokenStudioData(designSystemId: string, versionId: string): Promise<object>;
|
|
132
191
|
}
|