@supernova-studio/supernova-sdk-beta 1.6.27 → 1.6.29
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/areas/SDKAreaAutomation.d.ts +25 -3
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +6 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaIntegrations.d.ts +1 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +32 -4
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +22 -8
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +6 -4
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +20 -4
- 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 +26 -3
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockDefinition.d.ts +2 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/token-detail/SDKDocsBlockActualTokenDetail.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/token-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/SDKDocsBlockAssetProperty.d.ts +15 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetPropertyProperty.d.ts +9 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts +9 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeProperty.d.ts +13 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts +13 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts +15 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentPropertyProperty.d.ts +9 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockDividerProperty.d.ts +9 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts +12 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockImageProperty.d.ts +15 -5
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMarkdownProperty.d.ts +10 -9
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty.d.ts +10 -9
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockNumberProperty.d.ts +9 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockProperty.d.ts +6 -2
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts +11 -10
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts +10 -9
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +12 -4
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTableProperty.d.ts +14 -8
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +10 -9
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +23 -8
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenPropertyProperty.d.ts +10 -9
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty.d.ts +13 -9
- package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlock.d.ts +33 -24
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyGroup.d.ts +3 -3
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageAsset.d.ts +1 -1
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockFrame.d.ts +1 -1
- package/build/sdk-typescript/src/model/enums/SDKCodeLanguage.d.ts +33 -0
- package/build/sdk-typescript/src/model/enums/SDKDocBlockMode.d.ts +8 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +0 -3
- package/build/sdk-typescript/src/model/exporters/SDKExporter.d.ts +7 -2
- package/build/sdk-typescript/src/model/membership/SDKMembership.d.ts +5 -5
- 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/workspaces/SDKWorkspaceSSOSettings.d.ts +2 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceSubscription.d.ts +4 -0
- package/build/sdk-typescript/src/tests/helpers.d.ts +1 -1
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONConverter.d.ts +1 -1
- package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +0 -11
- 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 +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedFrameProperty.d.ts +0 -9
- package/build/sdk-typescript/src/tests/Enterprise/PluginFigmaTokens.spec.d.ts +0 -1
- package/build/sdk-typescript/src/utils/DocumentationUtils.d.ts +0 -2
|
@@ -13,12 +13,12 @@ import { CodegenGitlabBranch } from "../../model/exporters/CodegenGitlabBranch";
|
|
|
13
13
|
import { CodegenGitlabGroup } from "../../model/exporters/CodegenGitlabGroup";
|
|
14
14
|
import { CodegenGitlabRepository } from "../../model/exporters/CodegenGitlabRepository";
|
|
15
15
|
import { CodegenRepository } from "../../model/exporters/CodegenRepository";
|
|
16
|
+
import { Exporter, NewExporterPayload } from "../../model/exporters/SDKExporter";
|
|
17
|
+
import { NewPipelinePayload, Pipeline, PipelineUpdateModel } from "../../model/exporters/SDKPipeline";
|
|
16
18
|
import { ExporterCustomBlockVariant } from "../../model/exporters/custom_blocks/SDKExporterCustomBlockVariant";
|
|
17
19
|
import { ExporterConfigurationProperty } from "../../model/exporters/custom_properties/SDKExporterConfigurationProperty";
|
|
18
20
|
import { ExportBuild } from "../../model/exporters/exporter_builds/SDKExportBuild";
|
|
19
21
|
import { ExportBuildResultLog } from "../../model/exporters/exporter_builds/SDKExportBuildResults";
|
|
20
|
-
import { Exporter } from "../../model/exporters/SDKExporter";
|
|
21
|
-
import { NewPipelinePayload, Pipeline, PipelineUpdateModel } from "../../model/exporters/SDKPipeline";
|
|
22
22
|
import { ImportJob } from "../../model/jobs/SDKImportJob";
|
|
23
23
|
import { DataCore } from "../data/SDKDataCore";
|
|
24
24
|
import { RemoteVersionIdentifier, RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
@@ -27,7 +27,7 @@ export declare class AreaAutomation {
|
|
|
27
27
|
private dataCore;
|
|
28
28
|
constructor(dataCore: DataCore);
|
|
29
29
|
/** Fetches all pipelines that are available by workspace id and design system id */
|
|
30
|
-
getPipelines(workspaceId: string, designSystemId
|
|
30
|
+
getPipelines(workspaceId: string, designSystemId?: string): Promise<Array<Pipeline>>;
|
|
31
31
|
/**
|
|
32
32
|
* Fetches all github connections for user
|
|
33
33
|
* @returns Github Connections
|
|
@@ -157,6 +157,22 @@ export declare class AreaAutomation {
|
|
|
157
157
|
getExporters(workspaceId: string, filter?: {
|
|
158
158
|
installedOnly?: boolean;
|
|
159
159
|
}): Promise<Array<Exporter>>;
|
|
160
|
+
/** Updates exporter
|
|
161
|
+
* @param workspaceId - Identifier of the workspace where the exporter is installed
|
|
162
|
+
* @param exporterId - Identifier of the exporter to update
|
|
163
|
+
* @param payload - Payload to update exporter with
|
|
164
|
+
*/
|
|
165
|
+
updateExporter(workspaceId: string, exporterId: string, payload: NewExporterPayload): Promise<Exporter>;
|
|
166
|
+
/** Deletes exporter
|
|
167
|
+
* @param workspaceId - Identifier of the workspace where the exporter is installed
|
|
168
|
+
* @param exporterId - Identifier of the exporter to delete
|
|
169
|
+
*/
|
|
170
|
+
deleteExporter(workspaceId: string, exporterId: string): Promise<void>;
|
|
171
|
+
/** Pulls latest version of exporter from remote repository
|
|
172
|
+
* @param workspaceId - Identifier of the workspace where the exporter is installed
|
|
173
|
+
* @param exporterId - Identifier of the exporter to pull
|
|
174
|
+
*/
|
|
175
|
+
pullLatestExporter(workspaceId: string, exporterId: string): Promise<Exporter>;
|
|
160
176
|
/** Fetches all custom configuration properties that specific exporter provides
|
|
161
177
|
* @param exporterId - Identifier of the exporter to fetch configuration for
|
|
162
178
|
* @param from - Remote version to fetch from
|
|
@@ -207,5 +223,11 @@ export declare class AreaAutomation {
|
|
|
207
223
|
* @param pipelineId string
|
|
208
224
|
*/
|
|
209
225
|
runPipeline(workspaceId: string, designSystemVersionId: string, pipelineId: string): Promise<Pipeline>;
|
|
226
|
+
/** Create exporter
|
|
227
|
+
* @param workspaceId string
|
|
228
|
+
* @param payload NewExporterPayload
|
|
229
|
+
* @returns Exporter
|
|
230
|
+
*/
|
|
231
|
+
createExporter(workspaceId: string, payload: NewExporterPayload): Promise<Exporter>;
|
|
210
232
|
deletePipeline(workspaceId: string, pipelineId: string): Promise<void>;
|
|
211
233
|
}
|
|
@@ -126,6 +126,12 @@ export declare class AreaDocumentation {
|
|
|
126
126
|
* @returns All documentation items
|
|
127
127
|
*/
|
|
128
128
|
getDocumentationFromRoot(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacyGroup>;
|
|
129
|
+
/** Get ID of the multiplayer room for a given documentation page
|
|
130
|
+
* @param from - Remote version to fetch from
|
|
131
|
+
* @param pageId - ID of the documentation page
|
|
132
|
+
* @returns Room ID that can be immediately used to join the multiplayer room
|
|
133
|
+
*/
|
|
134
|
+
getDocumentationPageRoomId(from: RemoteWorkspaceVersionIdentifier, pageId: string): Promise<string>;
|
|
129
135
|
getDocumentationMockedStructure(): Array<DocsEntity>;
|
|
130
136
|
getDocumentationMockedPageContent(pageId: string): Array<DocsBlock | DocsSection>;
|
|
131
137
|
getDocumentationMockedEditorBlockDefinitions(): Array<DocsBlockDefinition>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { ConnectionRemoteModel } from "../../model/exporters/remote/SDKRemoteConnectionsModel";
|
|
2
1
|
import { AzurePersonalAccessTokenConnectionPayload, PersonalAccessTokenConnectionPayload } from "../../model/exporters/SDKConnections";
|
|
2
|
+
import { ConnectionRemoteModel } from "../../model/exporters/remote/SDKRemoteConnectionsModel";
|
|
3
3
|
import { DataCore } from "../data/SDKDataCore";
|
|
4
4
|
export declare class AreaIntegrations {
|
|
5
5
|
/** Internal: Engine */
|
|
@@ -3,16 +3,16 @@ import { UserRoleWithoutOwner } from "../../model/enums/SDKUserRole";
|
|
|
3
3
|
import { Membership } from "../../model/membership/SDKMembership";
|
|
4
4
|
import { UserMembership } from "../../model/users/SDKUserMembership";
|
|
5
5
|
import { Workspace } from "../../model/workspaces/SDKWorkspace";
|
|
6
|
+
import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
6
7
|
import { WorkspaceInvitation, WorkspaceInvitationUpdateModel } from "../../model/workspaces/SDKWorkspaceInvitation";
|
|
7
8
|
import { WorkspaceInvoice } from "../../model/workspaces/SDKWorkspaceInvoice";
|
|
8
|
-
import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
9
9
|
import { WorkspaceNPMRegistrySettings, WorkspaceNPMRegistrySettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
|
|
10
10
|
import { WorkspaceOnboarding, WorkspaceOnboardingUpdateModel } from "../../model/workspaces/SDKWorkspaceOnboarding";
|
|
11
11
|
import { WorkspaceProduct } from "../../model/workspaces/SDKWorkspaceProduct";
|
|
12
12
|
import { SubscriptionProductFeatures } from "../../model/workspaces/SDKWorkspaceProductFeatures";
|
|
13
13
|
import { WorkspaceProfileUpdateModel } from "../../model/workspaces/SDKWorkspaceProfile";
|
|
14
|
-
import { WorkspaceSSOSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
15
|
-
import { WorkspaceSubscription } from "../../model/workspaces/SDKWorkspaceSubscription";
|
|
14
|
+
import { WorkspaceSSOSettings, WorkspaceSSOSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
15
|
+
import { WorkspaceSubscription, WorkspaceSubscriptionUpdateModel } from "../../model/workspaces/SDKWorkspaceSubscription";
|
|
16
16
|
import { DataCore } from "../data/SDKDataCore";
|
|
17
17
|
export declare class AreaWorkspaces {
|
|
18
18
|
/** Internal: Engine */
|
|
@@ -68,7 +68,7 @@ export declare class AreaWorkspaces {
|
|
|
68
68
|
* @param workspaceId - ID of the workspace
|
|
69
69
|
* @returns Workspace SSO settings or null if the workspace is not using SSO
|
|
70
70
|
*/
|
|
71
|
-
workspaceSSOSettings(workspaceId: string): Promise<
|
|
71
|
+
workspaceSSOSettings(workspaceId: string): Promise<WorkspaceSSOSettings | null>;
|
|
72
72
|
/** Fetches all invitations that are part of the workspace.
|
|
73
73
|
* @param workspaceId - ID of the workspace
|
|
74
74
|
* @returns All invitations of the provided workspace
|
|
@@ -166,6 +166,34 @@ export declare class AreaWorkspaces {
|
|
|
166
166
|
* @returns Nothing
|
|
167
167
|
*/
|
|
168
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
|
+
* @param quantity - number of seats to be pre-selected in the checkout
|
|
175
|
+
* @returns string - URL to the Stripe checkout
|
|
176
|
+
*/
|
|
177
|
+
createCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity?: number | null): Promise<string>;
|
|
178
|
+
/** Creates a new Stripe customer portal session.
|
|
179
|
+
* @param workspaceId - ID of the workspace
|
|
180
|
+
* @param returnUrl - URL to redirect to from the portal
|
|
181
|
+
* @param update - describes the subscription updates to be applied
|
|
182
|
+
* @param cancel - describes if the subscription must be cancelled
|
|
183
|
+
* @returns string - URL to the Stripe customer portal
|
|
184
|
+
*/
|
|
185
|
+
createPortalSession(workspaceId: string, returnUrl: string, update?: WorkspaceSubscriptionUpdateModel | null, cancel?: boolean | null): Promise<string>;
|
|
186
|
+
/** Resend an invitation to the workspace.
|
|
187
|
+
* @param workspaceId - ID of the workspace
|
|
188
|
+
* @param invitationId - ID of the invitation
|
|
189
|
+
* @returns Nothing
|
|
190
|
+
*/
|
|
191
|
+
resendWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
192
|
+
/** Restore a cancelled workspace subscription.
|
|
193
|
+
* @param workspaceId - ID of the workspace
|
|
194
|
+
* @returns Nothing
|
|
195
|
+
*/
|
|
196
|
+
restoreWorkspaceSubscription(workspaceId: string): Promise<void>;
|
|
169
197
|
/** Deletes a single workspace. This action is irreversible, all data will be lost, and can only be performed by the workspace owner
|
|
170
198
|
* @param workspaceId - ID of the workspace
|
|
171
199
|
* @returns Nothing
|
|
@@ -33,15 +33,15 @@ import { CodegenGitlabBranch } from "../../model/exporters/CodegenGitlabBranch";
|
|
|
33
33
|
import { CodegenGitlabGroup } from "../../model/exporters/CodegenGitlabGroup";
|
|
34
34
|
import { CodegenGitlabRepository } from "../../model/exporters/CodegenGitlabRepository";
|
|
35
35
|
import { CodegenRepository } from "../../model/exporters/CodegenRepository";
|
|
36
|
+
import { AzurePersonalAccessTokenConnectionPayload, PersonalAccessTokenConnectionPayload } from "../../model/exporters/SDKConnections";
|
|
37
|
+
import { Exporter, ExporterProvider, NewExporterPayload } from "../../model/exporters/SDKExporter";
|
|
38
|
+
import { NewPipelinePayload, Pipeline, PipelineUpdateModel } from "../../model/exporters/SDKPipeline";
|
|
36
39
|
import { ExporterCustomBlock } from "../../model/exporters/custom_blocks/SDKExporterCustomBlock";
|
|
37
40
|
import { ExporterCustomBlockVariant } from "../../model/exporters/custom_blocks/SDKExporterCustomBlockVariant";
|
|
38
41
|
import { ExporterConfigurationProperty } from "../../model/exporters/custom_properties/SDKExporterConfigurationProperty";
|
|
39
42
|
import { ExportBuild } from "../../model/exporters/exporter_builds/SDKExportBuild";
|
|
40
43
|
import { ExportBuildResultLog } from "../../model/exporters/exporter_builds/SDKExportBuildResults";
|
|
41
44
|
import { ConnectionRemoteModel } from "../../model/exporters/remote/SDKRemoteConnectionsModel";
|
|
42
|
-
import { AzurePersonalAccessTokenConnectionPayload, PersonalAccessTokenConnectionPayload } from "../../model/exporters/SDKConnections";
|
|
43
|
-
import { Exporter } from "../../model/exporters/SDKExporter";
|
|
44
|
-
import { NewPipelinePayload, Pipeline, PipelineUpdateModel } from "../../model/exporters/SDKPipeline";
|
|
45
45
|
import { AssetGroup } from "../../model/groups/SDKAssetGroup";
|
|
46
46
|
import { ComponentGroup } from "../../model/groups/SDKComponentGroup";
|
|
47
47
|
import { DesignComponentGroup } from "../../model/groups/SDKDesignComponentGroup";
|
|
@@ -58,16 +58,16 @@ import { User } from "../../model/users/SDKUser";
|
|
|
58
58
|
import { UserMembership } from "../../model/users/SDKUserMembership";
|
|
59
59
|
import { UserProfileUpdateModel } from "../../model/users/SDKUserProfile";
|
|
60
60
|
import { Workspace } from "../../model/workspaces/SDKWorkspace";
|
|
61
|
+
import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
61
62
|
import { WorkspaceInvitation, WorkspaceInvitationUpdateModel } from "../../model/workspaces/SDKWorkspaceInvitation";
|
|
62
63
|
import { WorkspaceInvoice } from "../../model/workspaces/SDKWorkspaceInvoice";
|
|
63
|
-
import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
64
64
|
import { WorkspaceNPMRegistrySettings, WorkspaceNPMRegistrySettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
|
|
65
65
|
import { WorkspaceOnboarding, WorkspaceOnboardingUpdateModel } from "../../model/workspaces/SDKWorkspaceOnboarding";
|
|
66
66
|
import { WorkspaceProduct } from "../../model/workspaces/SDKWorkspaceProduct";
|
|
67
67
|
import { SubscriptionProductFeatures } from "../../model/workspaces/SDKWorkspaceProductFeatures";
|
|
68
68
|
import { WorkspaceProfileUpdateModel } from "../../model/workspaces/SDKWorkspaceProfile";
|
|
69
69
|
import { WorkspaceSSOSettings, WorkspaceSSOSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
70
|
-
import { WorkspaceSubscription } from "../../model/workspaces/SDKWorkspaceSubscription";
|
|
70
|
+
import { WorkspaceSubscription, WorkspaceSubscriptionUpdateModel } from "../../model/workspaces/SDKWorkspaceSubscription";
|
|
71
71
|
import { ComponentUpdateTransactionData, TokenUpdateTransactionData } from "../areas/SDKAreaBulkOperations";
|
|
72
72
|
import { RenderedAssetRequestSettings } from "./requests/SDKDataCoreRenderRequests";
|
|
73
73
|
import { DataBridge } from "./SDKDataBridge";
|
|
@@ -259,6 +259,8 @@ export declare class DataCore {
|
|
|
259
259
|
updateDocumentationStructure(designSystemId: string, versionId: string, model: DocumentationLegacyModel): Promise<void>;
|
|
260
260
|
/** Download all necessary data for documentation items (groups and pages) and retrieve them resolved */
|
|
261
261
|
documentationItems(workspaceId: string, designSystemId: string, versionId: string): Promise<Array<DocumentationLegacyItem>>;
|
|
262
|
+
/** Get ID of the multiplayer room for a given documentation page */
|
|
263
|
+
getDocumentationPageRoomId(designSystemId: string, versionId: string, pageId: string): Promise<string>;
|
|
262
264
|
/** Retrieve currently deployed documentation url */
|
|
263
265
|
documentationDomain(designSystemId: string, versionId: string): Promise<string | null>;
|
|
264
266
|
/** Publish the documentation */
|
|
@@ -267,7 +269,7 @@ export declare class DataCore {
|
|
|
267
269
|
jobId: string;
|
|
268
270
|
exporterId: string;
|
|
269
271
|
}>;
|
|
270
|
-
pipelines(workspaceId: string, designSystemId
|
|
272
|
+
pipelines(workspaceId: string, designSystemId?: string): Promise<Array<Pipeline>>;
|
|
271
273
|
githubConnections(): Promise<Array<CodegenConnection>>;
|
|
272
274
|
githubAccounts(githubConnectionId: string): Promise<Array<CodegenAccount>>;
|
|
273
275
|
githubRepositories(githubConnectionId: string, handle: string): Promise<Array<CodegenRepository>>;
|
|
@@ -307,6 +309,14 @@ export declare class DataCore {
|
|
|
307
309
|
exporters(workspaceId: string, filter?: {
|
|
308
310
|
installedOnly?: boolean;
|
|
309
311
|
}): Promise<Array<Exporter>>;
|
|
312
|
+
/** Create new exporter and return Exporter as a result */
|
|
313
|
+
createExporter(workspaceId: string, payload: NewExporterPayload): Promise<Exporter>;
|
|
314
|
+
/** Edit exporter */
|
|
315
|
+
updateExporter(workspaceId: string, exporterId: string, payload: NewExporterPayload): Promise<Exporter>;
|
|
316
|
+
/** Delete exporter */
|
|
317
|
+
deleteExporter(workspaceId: string, exporterId: string): Promise<void>;
|
|
318
|
+
/** Pull updates for exporter */
|
|
319
|
+
pullLatestExporter(workspaceId: string, exporterId: string): Promise<Exporter>;
|
|
310
320
|
exportBuilds(workspaceId: string, exporterId: string, limit?: number): Promise<Array<ExportBuild>>;
|
|
311
321
|
/** Download information about documentation builds and retrieve it resolved */
|
|
312
322
|
documentationBuilds(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment, limit?: number): Promise<Array<{
|
|
@@ -355,6 +365,10 @@ export declare class DataCore {
|
|
|
355
365
|
deleteWorkspaceNPMRegistrySettings(workspaceId: string): Promise<void>;
|
|
356
366
|
deleteWorkspaceMember(workspaceId: string, userId: string): Promise<void>;
|
|
357
367
|
deleteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
368
|
+
createCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity: number | null): Promise<string>;
|
|
369
|
+
createPortalSession(workspaceId: string, returnUrl: string, update: WorkspaceSubscriptionUpdateModel | null, cancel: boolean | null): Promise<string>;
|
|
370
|
+
resendWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
371
|
+
restoreWorkspaceSubscription(workspaceId: string): Promise<void>;
|
|
358
372
|
/** Download information about a single design system and retrieve it resolved */
|
|
359
373
|
designSystem(designSystemId: string): Promise<DesignSystem>;
|
|
360
374
|
/** Download information about design systems that user has access to under a single workspace and retrieve it resolved */
|
|
@@ -407,8 +421,8 @@ export declare class DataCore {
|
|
|
407
421
|
version(designSystemId: string, versionId: string): Promise<DesignSystemVersion>;
|
|
408
422
|
getBrands(designSystemId: string, versionId: string): Promise<Array<Brand>>;
|
|
409
423
|
getBrand(designSystemId: string, versionId: string, brandId: string): Promise<Brand>;
|
|
410
|
-
getOAuthURL(service: "figma" |
|
|
411
|
-
deleteOAuthIntegration(userId: string, service: "figma" |
|
|
424
|
+
getOAuthURL(service: "figma" | ExporterProvider): Promise<string>;
|
|
425
|
+
deleteOAuthIntegration(userId: string, service: "figma" | ExporterProvider): Promise<void>;
|
|
412
426
|
createPersonalAccessTokenConnection(service: ConnectionProviders, connection: PersonalAccessTokenConnectionPayload | AzurePersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
|
|
413
427
|
bulkUpdateTokenData(designSystemId: string, versionId: string, data: TokenUpdateTransactionData): Promise<any>;
|
|
414
428
|
bulkUpdateComponentData(designSystemId: string, versionId: string, data: ComponentUpdateTransactionData): Promise<any>;
|
|
@@ -13,6 +13,7 @@ import { ElementPropertyValueRemoteModel } from "../../../model/elements/values/
|
|
|
13
13
|
import { DocumentationEnvironment } from "../../../model/enums/SDKDocumentationEnvironment";
|
|
14
14
|
import { TokenType } from "../../../model/enums/SDKTokenType";
|
|
15
15
|
import { CodegenBitbucketProject } from "../../../model/exporters/CodegenBitbucketProject";
|
|
16
|
+
import { ExporterModel, ExporterProvider } from "../../../model/exporters/SDKExporter";
|
|
16
17
|
import { ExporterCustomBlockModel } from "../../../model/exporters/custom_blocks/SDKExporterCustomBlock";
|
|
17
18
|
import { ExportBuildModel } from "../../../model/exporters/exporter_builds/SDKExportBuild";
|
|
18
19
|
import { ExportBuildResultLogModel } from "../../../model/exporters/exporter_builds/SDKExportBuildResults";
|
|
@@ -31,7 +32,6 @@ import { CodegenGitlabBranchRemoteModel } from "../../../model/exporters/remote/
|
|
|
31
32
|
import { CodegenGitlabGroupRemoteModel } from "../../../model/exporters/remote/SDKRemoteGitlabCodegenGroupModel";
|
|
32
33
|
import { CodegenGitlabRepositoryRemoteModel } from "../../../model/exporters/remote/SDKRemoteGitlabCodegenRepositoryModel";
|
|
33
34
|
import { PipelineRemoteModel } from "../../../model/exporters/remote/SDKRemotePipelineModel";
|
|
34
|
-
import { ExporterModel } from "../../../model/exporters/SDKExporter";
|
|
35
35
|
import { ComponentGroupRemoteModel } from "../../../model/groups/SDKComponentGroup";
|
|
36
36
|
import { DesignComponentGroupRemoteModel } from "../../../model/groups/SDKDesignComponentGroup";
|
|
37
37
|
import { TokenGroupRemoteModel } from "../../../model/groups/SDKTokenGroup";
|
|
@@ -46,9 +46,9 @@ import { TokenRemoteModel } from "../../../model/tokens/remote/SDKRemoteTokenMod
|
|
|
46
46
|
import { UserRemoteModel } from "../../../model/users/SDKUser";
|
|
47
47
|
import { UserMembershipRemoteModel } from "../../../model/users/SDKUserMembership";
|
|
48
48
|
import { WorkspaceRemoteModel } from "../../../model/workspaces/SDKWorkspace";
|
|
49
|
+
import { WorkspaceIPWhitelistSettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
49
50
|
import { WorkspaceInvitationRemoteModel } from "../../../model/workspaces/SDKWorkspaceInvitation";
|
|
50
51
|
import { WorkspaceInvoiceRemoteModel } from "../../../model/workspaces/SDKWorkspaceInvoice";
|
|
51
|
-
import { WorkspaceIPWhitelistSettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
52
52
|
import { WorkspaceNPMRegistrySettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
|
|
53
53
|
import { WorkspaceOnboardingRemoteModel } from "../../../model/workspaces/SDKWorkspaceOnboarding";
|
|
54
54
|
import { WorkspaceProductRemoteModel } from "../../../model/workspaces/SDKWorkspaceProduct";
|
|
@@ -106,6 +106,8 @@ export declare class DataCoreReadRequests {
|
|
|
106
106
|
groups: Array<DocumentationLegacyGroupModel>;
|
|
107
107
|
pages: Array<DocumentationLegacyPageModel>;
|
|
108
108
|
}>;
|
|
109
|
+
/** Remote: Get id of the room for a specific page */
|
|
110
|
+
getRemoteDocumentationPageRoomId(designSystemId: string, versionId: string, pageId: string): Promise<string>;
|
|
109
111
|
/** Remote: Get custom blocks for currently installed documentation exporter under specific ds */
|
|
110
112
|
getRemoteExporterCustomBlocks(designSystemId: string, versionId: string): Promise<Array<ExporterCustomBlockModel>>;
|
|
111
113
|
/** Remote: Get user configuration of specific installed exporter */
|
|
@@ -153,7 +155,7 @@ export declare class DataCoreReadRequests {
|
|
|
153
155
|
getRemoteElementDataViewDefinitions(designSystemId: string, versionId: string): Promise<Array<ElementDataViewRemoteModel>>;
|
|
154
156
|
/** Remote: Get all property values that were set by the user for each elemen */
|
|
155
157
|
getRemoteElementPropertyValues(designSystemId: string, versionId: string): Promise<ElementPropertyValueRemoteModel[]>;
|
|
156
|
-
getRemotePipelines(workspaceId: string, designSystemId
|
|
158
|
+
getRemotePipelines(workspaceId: string, designSystemId?: string): Promise<PipelineRemoteModel[]>;
|
|
157
159
|
getRemoteGithubConnections(): Promise<CodegenConnectionRemoteModel[]>;
|
|
158
160
|
getRemoteGithubAccounts(githubConnectId: string): Promise<CodegenAccountRemoteModel[]>;
|
|
159
161
|
getRemoteGithubRepositories(githubConnectId: string, handle: string): Promise<CodegenRepositoryRemoteModel[]>;
|
|
@@ -181,7 +183,7 @@ export declare class DataCoreReadRequests {
|
|
|
181
183
|
getRemoteBuildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLogModel>>;
|
|
182
184
|
getBrands(designSystemId: string, versionId: string): Promise<Array<BrandRemoteModel>>;
|
|
183
185
|
getBrand(designSystemId: string, versionId: string, brandId: string): Promise<BrandRemoteModel>;
|
|
184
|
-
getOAuthURL(service: "figma" |
|
|
186
|
+
getOAuthURL(service: "figma" | ExporterProvider): Promise<string>;
|
|
185
187
|
getVersion(designSystemId: string, versionId: string): Promise<DesignSystemVersionRemoteModel>;
|
|
186
188
|
getVersions(designSystemId: string): Promise<Array<DesignSystemVersionRemoteModel>>;
|
|
187
189
|
getImportJobs(designSystemId: string, versionId: string): Promise<Array<ImportJobRemoteModel>>;
|
|
@@ -10,26 +10,28 @@ import { ElementPropertyRemoteModel } from "../../../model/elements/SDKElementPr
|
|
|
10
10
|
import { ConnectionProviders } from "../../../model/enums/SDKConnectionProviders";
|
|
11
11
|
import { DocumentationEnvironment } from "../../../model/enums/SDKDocumentationEnvironment";
|
|
12
12
|
import { UserRoleWithoutOwner } from "../../../model/enums/SDKUserRole";
|
|
13
|
-
import { ConnectionRemoteModel } from "../../../model/exporters/remote/SDKRemoteConnectionsModel";
|
|
14
13
|
import { AzurePersonalAccessTokenConnectionPayload, PersonalAccessTokenConnectionPayload } from "../../../model/exporters/SDKConnections";
|
|
15
14
|
import { NewPipelinePayload, PipelineUpdateModel } from "../../../model/exporters/SDKPipeline";
|
|
15
|
+
import { ConnectionRemoteModel } from "../../../model/exporters/remote/SDKRemoteConnectionsModel";
|
|
16
16
|
import { ComponentGroup, ComponentGroupRemoteModel } from "../../../model/groups/SDKComponentGroup";
|
|
17
17
|
import { TokenGroup, TokenGroupRemoteModel } from "../../../model/groups/SDKTokenGroup";
|
|
18
18
|
import { ImportJobRemoteModel } from "../../../model/jobs/SDKImportJob";
|
|
19
19
|
import { CustomDomainRemoteModel } from "../../../model/support/SDKCustomDomain";
|
|
20
20
|
import { SourceRemoteModel } from "../../../model/support/SDKSource";
|
|
21
21
|
import { TokenThemeRemoteModel } from "../../../model/themes/SDKTokenTheme";
|
|
22
|
-
import { TokenRemoteModel } from "../../../model/tokens/remote/SDKRemoteTokenModel";
|
|
23
22
|
import { Token } from "../../../model/tokens/SDKToken";
|
|
23
|
+
import { TokenRemoteModel } from "../../../model/tokens/remote/SDKRemoteTokenModel";
|
|
24
24
|
import { UserProfileUpdateModel } from "../../../model/users/SDKUserProfile";
|
|
25
25
|
import { WorkspaceRemoteModel } from "../../../model/workspaces/SDKWorkspace";
|
|
26
|
-
import { WorkspaceInvitationUpdateModel } from "../../../model/workspaces/SDKWorkspaceInvitation";
|
|
27
26
|
import { WorkspaceIPWhitelistSettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
27
|
+
import { WorkspaceInvitationUpdateModel } from "../../../model/workspaces/SDKWorkspaceInvitation";
|
|
28
28
|
import { WorkspaceNPMRegistrySettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
|
|
29
29
|
import { WorkspaceOnboardingUpdateModel } from "../../../model/workspaces/SDKWorkspaceOnboarding";
|
|
30
30
|
import { WorkspaceProfileUpdateModel } from "../../../model/workspaces/SDKWorkspaceProfile";
|
|
31
31
|
import { WorkspaceSSOSettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
32
|
+
import { WorkspaceSubscriptionUpdateModel } from "../../../model/workspaces/SDKWorkspaceSubscription";
|
|
32
33
|
import { DataBridge } from "../SDKDataBridge";
|
|
34
|
+
import { ExporterProvider, NewExporterPayload } from "model/exporters/SDKExporter";
|
|
33
35
|
export declare class DataCoreWriteRequests {
|
|
34
36
|
private bridge;
|
|
35
37
|
constructor(bridge: DataBridge);
|
|
@@ -96,6 +98,14 @@ export declare class DataCoreWriteRequests {
|
|
|
96
98
|
deleteRemoteWorkspaceMember(workspaceId: string, userId: string): Promise<void>;
|
|
97
99
|
/** Remote: Deletes an invitation */
|
|
98
100
|
deleteRemoteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
101
|
+
/** Remote: create Checkout session */
|
|
102
|
+
createRemoteCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity?: number | null): Promise<string>;
|
|
103
|
+
/** Remote: create Customer portal session */
|
|
104
|
+
createRemotePortalSession(workspaceId: string, returnUrl: string, update: WorkspaceSubscriptionUpdateModel | null, cancel: boolean | null): Promise<string>;
|
|
105
|
+
/** Remote: Resend the invitation */
|
|
106
|
+
resendRemoteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
107
|
+
/** Remote: Restore the cancelled subscription */
|
|
108
|
+
restoreRemoteWorkspaceSubscription(workspaceId: string): Promise<void>;
|
|
99
109
|
/** Remote: Creates a new design system */
|
|
100
110
|
createRemoteDesignSystem(workspaceId: string, name: string, description?: string): Promise<DesignSystemRemoteModel>;
|
|
101
111
|
/** Remote: Updates a design system metadata */
|
|
@@ -198,7 +208,7 @@ export declare class DataCoreWriteRequests {
|
|
|
198
208
|
updateReorderComponentColumn(designSystemId: string, versionId: string, viewId: string, columnId: string, newIndex: number): Promise<void>;
|
|
199
209
|
updateResizeComponentColumn(designSystemId: string, versionId: string, viewId: string, columnType: ElementDataViewColumnType, columnId: string, columnThemeId: string | undefined, columnBasePropertyType: string | undefined, columnPropertyDefinitionId: string | undefined, newWidth: number): Promise<void>;
|
|
200
210
|
/** Remote: Deletes a OAuth integration */
|
|
201
|
-
deleteOAuthIntegration(userId: string, service: "figma" |
|
|
211
|
+
deleteOAuthIntegration(userId: string, service: "figma" | ExporterProvider): Promise<void>;
|
|
202
212
|
/** Remote: Create Personal Access token connection */
|
|
203
213
|
createPersonalAccessTokenConnection(service: ConnectionProviders, connection: PersonalAccessTokenConnectionPayload | AzurePersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
|
|
204
214
|
/** Remote: Create pipeline */
|
|
@@ -209,6 +219,12 @@ export declare class DataCoreWriteRequests {
|
|
|
209
219
|
runRemotePipeline(workspaceId: string, designSystemVersionId: string, pipelineId: string): Promise<any>;
|
|
210
220
|
/** Remote: Delete pipeline */
|
|
211
221
|
deleteRemotePipeline(workspaceId: string, pipelineId: string): Promise<void>;
|
|
222
|
+
/** Remote: Create exporter */
|
|
223
|
+
createRemoteExporter(workspaceId: string, payload: NewExporterPayload): Promise<any>;
|
|
224
|
+
/** Remote: Updates an exporter */
|
|
225
|
+
updateRemoteExporter(workspaceId: string, exporterId: string, payload: NewExporterPayload): Promise<any>;
|
|
226
|
+
/** Remote: Deletes an exporter */
|
|
227
|
+
deleteRemoteExporter(workspaceId: string, exporterId: string): Promise<any>;
|
|
212
228
|
/** Remote: Schedules import job */
|
|
213
229
|
scheduleImportJobForFigmaSources(designSystemId: string, versionId: string, sourceIds: Array<string>, dryRun: boolean): Promise<ImportJobRemoteModel>;
|
|
214
230
|
/** Remote: Deletes a remote data source */
|
|
@@ -7,9 +7,6 @@ import { Source } from "../../model/support/SDKSource";
|
|
|
7
7
|
import { TokenOrigin } from "../../model/support/SDKTokenOrigin";
|
|
8
8
|
import { TokenTheme, TokenThemeRemoteModel } from "../../model/themes/SDKTokenTheme";
|
|
9
9
|
import { TokenThemeOverrideRemoteModel } from "../../model/themes/SDKTokenThemeOverride";
|
|
10
|
-
import { AnyDimensionTokenRemoteData, AnyOptionTokenRemoteData, AnyOptionTokenRemoteValue, AnyStringTokenRemoteData, BorderWidthTokenRemoteData, ColorTokenRemoteData, GradientTokenRemoteData, ShadowTokenRemoteData } from "../../model/tokens/remote/SDKRemoteTokenData";
|
|
11
|
-
import { AnyOptionTokenRemoteModel, BlurTokenRemoteModel, BorderTokenRemoteModel, ColorTokenRemoteModel, DimensionTokenRemoteModel, GradientTokenRemoteModel, ShadowTokenRemoteModel, StringTokenRemoteModel, TokenRemoteModel, TypographyTokenRemoteModel } from "../../model/tokens/remote/SDKRemoteTokenModel";
|
|
12
|
-
import { AnyDimensionTokenRemoteValue, BlurTokenRemoteValue, BorderTokenRemoteValue, ColorTokenRemoteValue, GradientStopRemoteValue, GradientTokenRemoteValue, ShadowTokenRemoteValue, StringTokenRemoteValue, TypographyTokenRemoteValue } from "../../model/tokens/remote/SDKRemoteTokenValue";
|
|
13
10
|
import { BlurToken } from "../../model/tokens/SDKBlurToken";
|
|
14
11
|
import { BorderToken } from "../../model/tokens/SDKBorderToken";
|
|
15
12
|
import { ColorToken } from "../../model/tokens/SDKColorToken";
|
|
@@ -20,6 +17,9 @@ import { AnyStringToken } from "../../model/tokens/SDKStringToken";
|
|
|
20
17
|
import { Token } from "../../model/tokens/SDKToken";
|
|
21
18
|
import { AnyOptionToken, AnyOptionTokenValue, AnyStringTokenValue, BlurTokenValue, BorderTokenValue, BorderWidthTokenValue, ColorTokenValue, DimensionTokenValue, DurationTokenValue, FontSizeTokenValue, GradientStopValue, GradientTokenValue, LetterSpacingTokenValue, LineHeightTokenValue, OpacityTokenValue, ParagraphSpacingTokenValue, RadiusTokenValue, ShadowTokenValue, SizeTokenValue, SpaceTokenValue, TypographyTokenValue, ZIndexTokenValue } from "../../model/tokens/SDKTokenValue";
|
|
22
19
|
import { TypographyToken } from "../../model/tokens/SDKTypographyToken";
|
|
20
|
+
import { AnyDimensionTokenRemoteData, AnyOptionTokenRemoteData, AnyOptionTokenRemoteValue, AnyStringTokenRemoteData, BorderWidthTokenRemoteData, ColorTokenRemoteData, GradientTokenRemoteData, ShadowTokenRemoteData } from "../../model/tokens/remote/SDKRemoteTokenData";
|
|
21
|
+
import { AnyOptionTokenRemoteModel, BlurTokenRemoteModel, BorderTokenRemoteModel, ColorTokenRemoteModel, DimensionTokenRemoteModel, GradientTokenRemoteModel, ShadowTokenRemoteModel, StringTokenRemoteModel, TokenRemoteModel, TypographyTokenRemoteModel } from "../../model/tokens/remote/SDKRemoteTokenModel";
|
|
22
|
+
import { AnyDimensionTokenRemoteValue, BlurTokenRemoteValue, BorderTokenRemoteValue, ColorTokenRemoteValue, GradientStopRemoteValue, GradientTokenRemoteValue, ShadowTokenRemoteValue, StringTokenRemoteValue, TypographyTokenRemoteValue } from "../../model/tokens/remote/SDKRemoteTokenValue";
|
|
23
23
|
export declare class TokenResolver {
|
|
24
24
|
hashedTokens: Map<string, TokenRemoteModel>;
|
|
25
25
|
resolvedTokens: Map<string, Token>;
|
|
@@ -53,7 +53,6 @@ export type { DocsBlockCodePropertyDefinition } from "./model/docs/blocks/proper
|
|
|
53
53
|
export type { DocsBlockCodeSandboxPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty";
|
|
54
54
|
export type { DocsBlockComponentPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockComponentProperty";
|
|
55
55
|
export type { DocsBlockComponentPropertyPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockComponentPropertyProperty";
|
|
56
|
-
export type { DocsBlockEmbedFramePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockEmbedFrameProperty";
|
|
57
56
|
export type { DocsBlockEmbedUrlPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty";
|
|
58
57
|
export type { DocsBlockImagePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockImageProperty";
|
|
59
58
|
export type { DocsBlockMarkdownPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockMarkdownProperty";
|
|
@@ -68,6 +67,7 @@ export type { DocsBlockTokenPropertyDefinition } from "./model/docs/blocks/prope
|
|
|
68
67
|
export type { DocsBlockTokenPropertyPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTokenPropertyProperty";
|
|
69
68
|
export type { DocsBlockTokenTypePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty";
|
|
70
69
|
export type { DocsBlockDividerPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockDividerProperty";
|
|
70
|
+
export type { DocsBlockStorybookPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockStorybookProperty";
|
|
71
71
|
export type { DocsColorRef } from "./model/docs/blocks/support/SDKDocsColorRef";
|
|
72
72
|
export type { DocsImageRef } from "./model/docs/blocks/support/SDKDocsImageRef";
|
|
73
73
|
export type { DocsLinkRef } from "./model/docs/blocks/support/SDKDocsLinkRef";
|
|
@@ -15,12 +15,14 @@ export { WorkspaceProfile } from "./model/workspaces/SDKWorkspaceProfile";
|
|
|
15
15
|
export type { WorkspaceProfileUpdateModel } from "./model/workspaces/SDKWorkspaceProfile";
|
|
16
16
|
export { WorkspaceOnboarding } from "./model/workspaces/SDKWorkspaceOnboarding";
|
|
17
17
|
export { WorkspaceSubscription } from "./model/workspaces/SDKWorkspaceSubscription";
|
|
18
|
+
export type { WorkspaceSubscriptionUpdateModel } from "./model/workspaces/SDKWorkspaceSubscription";
|
|
18
19
|
export { WorkspaceIPWhitelistSettings } from "./model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
19
20
|
export { WorkspaceSSOSettings } from "./model/workspaces/SDKWorkspaceSSOSettings";
|
|
20
21
|
export { WorkspaceNPMRegistrySettings } from "./model/workspaces/SDKWorkspaceNPMRegistrySettings";
|
|
21
22
|
export { WorkspaceInvitation } from "./model/workspaces/SDKWorkspaceInvitation";
|
|
22
23
|
export type { WorkspaceInvitationUpdateModel } from "./model/workspaces/SDKWorkspaceInvitation";
|
|
23
24
|
export { WorkspaceInvoice } from "./model/workspaces/SDKWorkspaceInvoice";
|
|
25
|
+
export { WorkspaceProduct } from "./model/workspaces/SDKWorkspaceProduct";
|
|
24
26
|
export { User } from "./model/users/SDKUser";
|
|
25
27
|
export { UserProfile } from "./model/users/SDKUserProfile";
|
|
26
28
|
export { UserMembership } from "./model/users/SDKUserMembership";
|
|
@@ -33,7 +35,7 @@ export { Brand } from "./model/base/SDKBrand";
|
|
|
33
35
|
export { DesignSystem } from "./model/base/SDKDesignSystem";
|
|
34
36
|
export { DesignSystemVersion } from "./model/base/SDKDesignSystemVersion";
|
|
35
37
|
export { Membership } from "./model/membership/SDKMembership";
|
|
36
|
-
export { Exporter } from "./model/exporters/SDKExporter";
|
|
38
|
+
export { Exporter, type NewExporterPayload, type ExporterProvider, } from "./model/exporters/SDKExporter";
|
|
37
39
|
export { Pipeline } from "./model/exporters/SDKPipeline";
|
|
38
40
|
export type { NewPipelinePayload, PipelineUpdateModel, AzureDestinationPayload, GithubDestinationPayload, BitbucketDestinationPayload, GitlabDestinationPayload, DocumentationDestinationPayload, } from "./model/exporters/SDKPipeline";
|
|
39
41
|
export type { PersonalAccessTokenConnectionPayload, AzurePersonalAccessTokenConnectionPayload, } from "./model/exporters/SDKConnections";
|
|
@@ -60,28 +62,49 @@ export { DocsBlockVariant } from "./model/docs/blocks/definition/SDKDocsBlockVar
|
|
|
60
62
|
export { DocsEntity } from "./model/docs/entities/SDKDocsEntity";
|
|
61
63
|
export { DocsEntityGroup } from "./model/docs/entities/SDKDocsEntityGroup";
|
|
62
64
|
export { DocsEntityPage } from "./model/docs/entities/SDKDocsEntityPage";
|
|
65
|
+
export { DocsBlockPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockProperty";
|
|
66
|
+
export type { DocsBlockItemPropertyAnyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockProperty";
|
|
63
67
|
export { DocsBlockAssetPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockAssetProperty";
|
|
68
|
+
export type { DocsBlockAssetPropertyData, DocsBlockAssetPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockAssetProperty";
|
|
64
69
|
export { DocsBlockAssetPropertyPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockAssetPropertyProperty";
|
|
70
|
+
export type { DocsBlockAssetPropertyPropertyData, DocsBlockAssetPropertyPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockAssetPropertyProperty";
|
|
65
71
|
export { DocsBlockBooleanPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockBooleanProperty";
|
|
72
|
+
export type { DocsBlockBooleanPropertyData, DocsBlockBooleanPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockBooleanProperty";
|
|
66
73
|
export { DocsBlockCodePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockCodeProperty";
|
|
74
|
+
export type { DocsBlockCodePropertyData, DocsBlockCodePropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockCodeProperty";
|
|
67
75
|
export { DocsBlockCodeSandboxPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty";
|
|
76
|
+
export type { DocsBlockCodeSandboxPropertyData, DocsBlockCodeSandboxPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty";
|
|
68
77
|
export { DocsBlockComponentPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockComponentProperty";
|
|
78
|
+
export type { DocsBlockComponentPropertyData, DocsBlockComponentPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockComponentProperty";
|
|
69
79
|
export { DocsBlockComponentPropertyPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockComponentPropertyProperty";
|
|
70
|
-
export {
|
|
80
|
+
export type { DocsBlockComponentPropertyPropertyData, DocsBlockComponentPropertyPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockComponentPropertyProperty";
|
|
71
81
|
export { DocsBlockEmbedUrlPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty";
|
|
82
|
+
export type { DocsBlockEmbedUrlPropertyData, DocsBlockEmbedUrlPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty";
|
|
72
83
|
export { DocsBlockImagePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockImageProperty";
|
|
84
|
+
export type { DocsBlockImagePropertyData, DocsBlockImagePropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockImageProperty";
|
|
73
85
|
export { DocsBlockMarkdownPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockMarkdownProperty";
|
|
86
|
+
export type { DocsBlockMarkdownPropertyData, DocsBlockMarkdownPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockMarkdownProperty";
|
|
74
87
|
export { DocsBlockMultiSelectPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty";
|
|
88
|
+
export type { DocsBlockMultiSelectPropertyData, DocsBlockMultiSelectPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty";
|
|
75
89
|
export { DocsBlockNumberPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockNumberProperty";
|
|
76
|
-
export {
|
|
90
|
+
export type { DocsBlockNumberPropertyData, DocsBlockNumberPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockNumberProperty";
|
|
77
91
|
export { DocsBlockRichTextPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockRichTextProperty";
|
|
92
|
+
export type { DocsBlockRichTextPropertyData, DocsBlockRichTextPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockRichTextProperty";
|
|
78
93
|
export { DocsBlockSingleSelectPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty";
|
|
94
|
+
export type { DocsBlockSingleSelectPropertyData, DocsBlockSingleSelectPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty";
|
|
79
95
|
export { DocsBlockTablePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTableProperty";
|
|
96
|
+
export type { DocsBlockTablePropertyData, DocsBlockTablePropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockTableProperty";
|
|
80
97
|
export { DocsBlockTextPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTextProperty";
|
|
98
|
+
export type { DocsBlockTextPropertyData, DocsBlockTextPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockTextProperty";
|
|
81
99
|
export { DocsBlockTokenPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTokenProperty";
|
|
100
|
+
export type { DocsBlockTokenPropertyData, DocsBlockTokenPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockTokenProperty";
|
|
82
101
|
export { DocsBlockTokenPropertyPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTokenPropertyProperty";
|
|
102
|
+
export type { DocsBlockTokenPropertyPropertyData, DocsBlockTokenPropertyPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockTokenPropertyProperty";
|
|
83
103
|
export { DocsBlockTokenTypePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty";
|
|
104
|
+
export type { DocsBlockTokenTypePropertyData, DocsBlockTokenTypePropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty";
|
|
84
105
|
export { DocsBlockDividerPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockDividerProperty";
|
|
106
|
+
export type { DocsBlockDividerPropertyData, DocsBlockDividerPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockDividerProperty";
|
|
107
|
+
export type { DocsBlockStorybookPropertyData, DocsBlockStorybookPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockStorybookProperty";
|
|
85
108
|
export type { DocsColorRef } from "./model/docs/blocks/support/SDKDocsColorRef";
|
|
86
109
|
export { DocsImageRefType } from "./model/docs/blocks/support/SDKDocsImageRef";
|
|
87
110
|
export type { DocsImageRef } from "./model/docs/blocks/support/SDKDocsImageRef";
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { DocsBlockMode } from "../../../enums/SDKDocBlockMode";
|
|
1
2
|
import { DocsBlockCategory } from "../../../enums/SDKDocsBlockCategory";
|
|
2
3
|
import { DocsImageRef } from "../support/SDKDocsImageRef";
|
|
3
4
|
import { DocsBlockBehavior, DocsBlockBehaviorModel } from "./SDKDocsBlockBehavior";
|
|
@@ -52,4 +53,5 @@ export declare class DocsBlockDefinition {
|
|
|
52
53
|
hasBackground: boolean;
|
|
53
54
|
};
|
|
54
55
|
constructor(model: DocsBlockDefinitionModel);
|
|
56
|
+
get blockMode(): DocsBlockMode;
|
|
55
57
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts
CHANGED
|
@@ -1,6 +1,18 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** Asset property - Additional non-value options */
|
|
2
4
|
export type DocsBlockAssetPropertyOptions = Record<string, never>;
|
|
5
|
+
/** Asset property - Data */
|
|
6
|
+
export type DocsBlockAssetPropertyData = DocsBlockPropertyData<Array<{
|
|
7
|
+
entityId: string;
|
|
8
|
+
entityType: "asset" | "assetGroup";
|
|
9
|
+
}>> & {
|
|
10
|
+
/** Selected asset ids */
|
|
11
|
+
selectedPropertyIds?: Array<string>;
|
|
12
|
+
};
|
|
13
|
+
/** Asset property - Definition model */
|
|
3
14
|
export type DocsBlockAssetPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockAssetPropertyOptions;
|
|
4
|
-
/** Asset property */
|
|
5
|
-
export declare class DocsBlockAssetPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockAssetPropertyOptions> {
|
|
15
|
+
/** Asset property - Definition */
|
|
16
|
+
export declare class DocsBlockAssetPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockAssetPropertyOptions, DocsBlockAssetPropertyData> {
|
|
17
|
+
type: DocsBlockItemPropertyType.asset;
|
|
6
18
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetPropertyProperty.d.ts
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** Asset property property - Additional non-value options */
|
|
2
4
|
export type DocsBlockAssetPropertyPropertyOptions = Record<string, never>;
|
|
5
|
+
/** Asset property property - Data */
|
|
6
|
+
export type DocsBlockAssetPropertyPropertyData = DocsBlockPropertyData<Array<string>> & Record<string, never>;
|
|
7
|
+
/** Asset property property - Definition model */
|
|
3
8
|
export type DocsBlockAssetPropertyPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockAssetPropertyPropertyOptions;
|
|
4
|
-
/** Asset property */
|
|
5
|
-
export declare class DocsBlockAssetPropertyPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockAssetPropertyPropertyOptions> {
|
|
9
|
+
/** Asset property property - Definition */
|
|
10
|
+
export declare class DocsBlockAssetPropertyPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockAssetPropertyPropertyOptions, DocsBlockAssetPropertyPropertyData> {
|
|
11
|
+
type: DocsBlockItemPropertyType.assetProperty;
|
|
6
12
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts
CHANGED
|
@@ -1,12 +1,18 @@
|
|
|
1
1
|
import { DocsBlockItemPropertyOptionRenderingStyle } from "../../../enums/SDKDocsBlockItemPropertyOptionRenderingStyle";
|
|
2
|
-
import {
|
|
2
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
|
+
/** Boolean property - Additional non-value options */
|
|
3
5
|
export type DocsBlockBooleanPropertyOptions = {
|
|
4
6
|
/** Default value to set when block is created */
|
|
5
7
|
defaultValue?: boolean;
|
|
6
8
|
/** Visual representation of the property */
|
|
7
9
|
style?: Exclude<DocsBlockItemPropertyOptionRenderingStyle, DocsBlockItemPropertyOptionRenderingStyle.select>;
|
|
8
10
|
};
|
|
11
|
+
/** Boolean property - Data */
|
|
12
|
+
export type DocsBlockBooleanPropertyData = DocsBlockPropertyData<boolean> & Record<string, never>;
|
|
13
|
+
/** Boolean property - Definition model */
|
|
9
14
|
export type DocsBlockBooleanPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockBooleanPropertyOptions;
|
|
10
|
-
/** Boolean property */
|
|
11
|
-
export declare class DocsBlockBooleanPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockBooleanPropertyOptions> {
|
|
15
|
+
/** Boolean property - Definition */
|
|
16
|
+
export declare class DocsBlockBooleanPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockBooleanPropertyOptions, DocsBlockBooleanPropertyData> {
|
|
17
|
+
type: DocsBlockItemPropertyType.boolean;
|
|
12
18
|
}
|