@supernova-studio/supernova-sdk-beta 1.6.28 → 1.6.30
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 +23 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +6 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +9 -2
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +16 -5
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +4 -2
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +12 -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/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 +21 -10
- 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/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/workspaces/SDKWorkspaceSubscription.d.ts +0 -1
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONConverter.d.ts +1 -0
- package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +0 -11
- package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementTransformer.d.ts +1 -1
- package/build/supernova-sdk-typescript.js +1 -1
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +118 -118
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedFrameProperty.d.ts +0 -9
- package/build/sdk-typescript/src/utils/DocumentationUtils.d.ts +0 -2
|
@@ -13,7 +13,7 @@ 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 } from "../../model/exporters/SDKExporter";
|
|
16
|
+
import { Exporter, NewExporterPayload } from "../../model/exporters/SDKExporter";
|
|
17
17
|
import { NewPipelinePayload, Pipeline, PipelineUpdateModel } from "../../model/exporters/SDKPipeline";
|
|
18
18
|
import { ExporterCustomBlockVariant } from "../../model/exporters/custom_blocks/SDKExporterCustomBlockVariant";
|
|
19
19
|
import { ExporterConfigurationProperty } from "../../model/exporters/custom_properties/SDKExporterConfigurationProperty";
|
|
@@ -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>;
|
|
@@ -171,22 +171,29 @@ export declare class AreaWorkspaces {
|
|
|
171
171
|
* @param priceId - ID of the Stripe price to be applied to the workspace
|
|
172
172
|
* @param successUrl - URL to redirect to after successful payment
|
|
173
173
|
* @param cancelUrl - URL to redirect to after failed payment
|
|
174
|
+
* @param quantity - number of seats to be pre-selected in the checkout
|
|
174
175
|
* @returns string - URL to the Stripe checkout
|
|
175
176
|
*/
|
|
176
|
-
createCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string): Promise<string>;
|
|
177
|
+
createCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity?: number | null): Promise<string>;
|
|
177
178
|
/** Creates a new Stripe customer portal session.
|
|
178
179
|
* @param workspaceId - ID of the workspace
|
|
179
180
|
* @param returnUrl - URL to redirect to from the portal
|
|
180
181
|
* @param update - describes the subscription updates to be applied
|
|
182
|
+
* @param cancel - describes if the subscription must be cancelled
|
|
181
183
|
* @returns string - URL to the Stripe customer portal
|
|
182
184
|
*/
|
|
183
|
-
createPortalSession(workspaceId: string, returnUrl: string, update?: WorkspaceSubscriptionUpdateModel | null): Promise<string>;
|
|
185
|
+
createPortalSession(workspaceId: string, returnUrl: string, update?: WorkspaceSubscriptionUpdateModel | null, cancel?: boolean | null): Promise<string>;
|
|
184
186
|
/** Resend an invitation to the workspace.
|
|
185
187
|
* @param workspaceId - ID of the workspace
|
|
186
188
|
* @param invitationId - ID of the invitation
|
|
187
189
|
* @returns Nothing
|
|
188
190
|
*/
|
|
189
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>;
|
|
190
197
|
/** Deletes a single workspace. This action is irreversible, all data will be lost, and can only be performed by the workspace owner
|
|
191
198
|
* @param workspaceId - ID of the workspace
|
|
192
199
|
* @returns Nothing
|
|
@@ -34,7 +34,7 @@ import { CodegenGitlabGroup } from "../../model/exporters/CodegenGitlabGroup";
|
|
|
34
34
|
import { CodegenGitlabRepository } from "../../model/exporters/CodegenGitlabRepository";
|
|
35
35
|
import { CodegenRepository } from "../../model/exporters/CodegenRepository";
|
|
36
36
|
import { AzurePersonalAccessTokenConnectionPayload, PersonalAccessTokenConnectionPayload } from "../../model/exporters/SDKConnections";
|
|
37
|
-
import { Exporter } from "../../model/exporters/SDKExporter";
|
|
37
|
+
import { Exporter, ExporterProvider, NewExporterPayload } from "../../model/exporters/SDKExporter";
|
|
38
38
|
import { NewPipelinePayload, Pipeline, PipelineUpdateModel } from "../../model/exporters/SDKPipeline";
|
|
39
39
|
import { ExporterCustomBlock } from "../../model/exporters/custom_blocks/SDKExporterCustomBlock";
|
|
40
40
|
import { ExporterCustomBlockVariant } from "../../model/exporters/custom_blocks/SDKExporterCustomBlockVariant";
|
|
@@ -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 */
|
|
@@ -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,9 +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>;
|
|
358
|
-
createCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string): Promise<string>;
|
|
359
|
-
createPortalSession(workspaceId: string, returnUrl: string, update: WorkspaceSubscriptionUpdateModel | null): Promise<string>;
|
|
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>;
|
|
360
370
|
resendWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
371
|
+
restoreWorkspaceSubscription(workspaceId: string): Promise<void>;
|
|
361
372
|
/** Download information about a single design system and retrieve it resolved */
|
|
362
373
|
designSystem(designSystemId: string): Promise<DesignSystem>;
|
|
363
374
|
/** Download information about design systems that user has access to under a single workspace and retrieve it resolved */
|
|
@@ -410,8 +421,8 @@ export declare class DataCore {
|
|
|
410
421
|
version(designSystemId: string, versionId: string): Promise<DesignSystemVersion>;
|
|
411
422
|
getBrands(designSystemId: string, versionId: string): Promise<Array<Brand>>;
|
|
412
423
|
getBrand(designSystemId: string, versionId: string, brandId: string): Promise<Brand>;
|
|
413
|
-
getOAuthURL(service: "figma" |
|
|
414
|
-
deleteOAuthIntegration(userId: string, service: "figma" |
|
|
424
|
+
getOAuthURL(service: "figma" | ExporterProvider): Promise<string>;
|
|
425
|
+
deleteOAuthIntegration(userId: string, service: "figma" | ExporterProvider): Promise<void>;
|
|
415
426
|
createPersonalAccessTokenConnection(service: ConnectionProviders, connection: PersonalAccessTokenConnectionPayload | AzurePersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
|
|
416
427
|
bulkUpdateTokenData(designSystemId: string, versionId: string, data: TokenUpdateTransactionData): Promise<any>;
|
|
417
428
|
bulkUpdateComponentData(designSystemId: string, versionId: string, data: ComponentUpdateTransactionData): Promise<any>;
|
|
@@ -13,7 +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 } from "../../../model/exporters/SDKExporter";
|
|
16
|
+
import { ExporterModel, ExporterProvider } from "../../../model/exporters/SDKExporter";
|
|
17
17
|
import { ExporterCustomBlockModel } from "../../../model/exporters/custom_blocks/SDKExporterCustomBlock";
|
|
18
18
|
import { ExportBuildModel } from "../../../model/exporters/exporter_builds/SDKExportBuild";
|
|
19
19
|
import { ExportBuildResultLogModel } from "../../../model/exporters/exporter_builds/SDKExportBuildResults";
|
|
@@ -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 */
|
|
@@ -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>>;
|
|
@@ -31,6 +31,7 @@ import { WorkspaceProfileUpdateModel } from "../../../model/workspaces/SDKWorksp
|
|
|
31
31
|
import { WorkspaceSSOSettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
32
32
|
import { WorkspaceSubscriptionUpdateModel } from "../../../model/workspaces/SDKWorkspaceSubscription";
|
|
33
33
|
import { DataBridge } from "../SDKDataBridge";
|
|
34
|
+
import { ExporterProvider, NewExporterPayload } from "model/exporters/SDKExporter";
|
|
34
35
|
export declare class DataCoreWriteRequests {
|
|
35
36
|
private bridge;
|
|
36
37
|
constructor(bridge: DataBridge);
|
|
@@ -98,11 +99,13 @@ export declare class DataCoreWriteRequests {
|
|
|
98
99
|
/** Remote: Deletes an invitation */
|
|
99
100
|
deleteRemoteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
100
101
|
/** Remote: create Checkout session */
|
|
101
|
-
createRemoteCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string): Promise<string>;
|
|
102
|
+
createRemoteCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity?: number | null): Promise<string>;
|
|
102
103
|
/** Remote: create Customer portal session */
|
|
103
|
-
createRemotePortalSession(workspaceId: string, returnUrl: string, update: WorkspaceSubscriptionUpdateModel | null): Promise<string>;
|
|
104
|
+
createRemotePortalSession(workspaceId: string, returnUrl: string, update: WorkspaceSubscriptionUpdateModel | null, cancel: boolean | null): Promise<string>;
|
|
104
105
|
/** Remote: Resend the invitation */
|
|
105
106
|
resendRemoteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
107
|
+
/** Remote: Restore the cancelled subscription */
|
|
108
|
+
restoreRemoteWorkspaceSubscription(workspaceId: string): Promise<void>;
|
|
106
109
|
/** Remote: Creates a new design system */
|
|
107
110
|
createRemoteDesignSystem(workspaceId: string, name: string, description?: string): Promise<DesignSystemRemoteModel>;
|
|
108
111
|
/** Remote: Updates a design system metadata */
|
|
@@ -205,7 +208,7 @@ export declare class DataCoreWriteRequests {
|
|
|
205
208
|
updateReorderComponentColumn(designSystemId: string, versionId: string, viewId: string, columnId: string, newIndex: number): Promise<void>;
|
|
206
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>;
|
|
207
210
|
/** Remote: Deletes a OAuth integration */
|
|
208
|
-
deleteOAuthIntegration(userId: string, service: "figma" |
|
|
211
|
+
deleteOAuthIntegration(userId: string, service: "figma" | ExporterProvider): Promise<void>;
|
|
209
212
|
/** Remote: Create Personal Access token connection */
|
|
210
213
|
createPersonalAccessTokenConnection(service: ConnectionProviders, connection: PersonalAccessTokenConnectionPayload | AzurePersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
|
|
211
214
|
/** Remote: Create pipeline */
|
|
@@ -216,6 +219,12 @@ export declare class DataCoreWriteRequests {
|
|
|
216
219
|
runRemotePipeline(workspaceId: string, designSystemVersionId: string, pipelineId: string): Promise<any>;
|
|
217
220
|
/** Remote: Delete pipeline */
|
|
218
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>;
|
|
219
228
|
/** Remote: Schedules import job */
|
|
220
229
|
scheduleImportJobForFigmaSources(designSystemId: string, versionId: string, sourceIds: Array<string>, dryRun: boolean): Promise<ImportJobRemoteModel>;
|
|
221
230
|
/** Remote: Deletes a remote data source */
|
|
@@ -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
|
}
|
|
@@ -1,6 +1,16 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CodeLanguage } from "../../../enums/SDKCodeLanguage";
|
|
2
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
|
|
4
|
+
/** Code property - Additional non-value options */
|
|
2
5
|
export type DocsBlockCodePropertyOptions = Record<string, never>;
|
|
6
|
+
/** Code property - Data */
|
|
7
|
+
export type DocsBlockCodePropertyData = DocsBlockPropertyData<string> & {
|
|
8
|
+
format?: CodeLanguage;
|
|
9
|
+
caption?: string;
|
|
10
|
+
};
|
|
11
|
+
/** Code property - Definition model */
|
|
3
12
|
export type DocsBlockCodePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockCodePropertyOptions;
|
|
4
|
-
/** Code property */
|
|
5
|
-
export declare class DocsBlockCodePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockCodePropertyOptions> {
|
|
13
|
+
/** Code property - Definition */
|
|
14
|
+
export declare class DocsBlockCodePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockCodePropertyOptions, DocsBlockCodePropertyData> {
|
|
15
|
+
type: DocsBlockItemPropertyType.code;
|
|
6
16
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts
CHANGED
|
@@ -1,6 +1,16 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** Code Sandbox property - Additional non-value options */
|
|
2
4
|
export type DocsBlockCodeSandboxPropertyOptions = Record<string, never>;
|
|
5
|
+
/** Code Sandbox property - Data */
|
|
6
|
+
export type DocsBlockCodeSandboxPropertyData = DocsBlockPropertyData<string> & {
|
|
7
|
+
showCode?: boolean;
|
|
8
|
+
backgroundColor?: string;
|
|
9
|
+
alignPreview?: "left" | "center";
|
|
10
|
+
};
|
|
11
|
+
/** Code Sandbox property - Definition model */
|
|
3
12
|
export type DocsBlockCodeSandboxPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockCodeSandboxPropertyOptions;
|
|
4
|
-
/**
|
|
5
|
-
export declare class DocsBlockCodeSandboxPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockCodeSandboxPropertyOptions> {
|
|
13
|
+
/** Code Sandbox property - Definition */
|
|
14
|
+
export declare class DocsBlockCodeSandboxPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockCodeSandboxPropertyOptions, DocsBlockCodeSandboxPropertyData> {
|
|
15
|
+
type: DocsBlockItemPropertyType.codeSandbox;
|
|
6
16
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts
CHANGED
|
@@ -1,6 +1,18 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** Component property - Additional non-value options */
|
|
2
4
|
export type DocsBlockComponentPropertyOptions = Record<string, never>;
|
|
5
|
+
/** Component property - Data */
|
|
6
|
+
export type DocsBlockComponentPropertyData = DocsBlockPropertyData<Array<{
|
|
7
|
+
entityId: string;
|
|
8
|
+
entityType: "component" | "componentGroup";
|
|
9
|
+
}>> & {
|
|
10
|
+
/** Selected component ids */
|
|
11
|
+
selectedPropertyIds?: Array<string>;
|
|
12
|
+
};
|
|
13
|
+
/** Component property - Definition model */
|
|
3
14
|
export type DocsBlockComponentPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockComponentPropertyOptions;
|
|
4
|
-
/** Component property */
|
|
5
|
-
export declare class DocsBlockComponentPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockComponentPropertyOptions> {
|
|
15
|
+
/** Component property - Definition */
|
|
16
|
+
export declare class DocsBlockComponentPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockComponentPropertyOptions, DocsBlockComponentPropertyData> {
|
|
17
|
+
type: DocsBlockItemPropertyType.component;
|
|
6
18
|
}
|
|
@@ -1,6 +1,12 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** ComponentProperty property - Additional non-value options */
|
|
2
4
|
export type DocsBlockComponentPropertyPropertyOptions = Record<string, never>;
|
|
5
|
+
/** ComponentProperty property - Data */
|
|
6
|
+
export type DocsBlockComponentPropertyPropertyData = DocsBlockPropertyData<string> & Record<string, never>;
|
|
7
|
+
/** ComponentProperty property - Definition model */
|
|
3
8
|
export type DocsBlockComponentPropertyPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockComponentPropertyPropertyOptions;
|
|
4
|
-
/** ComponentProperty property */
|
|
5
|
-
export declare class DocsBlockComponentPropertyPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockComponentPropertyPropertyOptions> {
|
|
9
|
+
/** ComponentProperty property - Definition */
|
|
10
|
+
export declare class DocsBlockComponentPropertyPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockComponentPropertyPropertyOptions, DocsBlockComponentPropertyPropertyData> {
|
|
11
|
+
type: DocsBlockItemPropertyType.componentProperty;
|
|
6
12
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockDividerProperty.d.ts
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** Divider property - Additional non-value options */
|
|
2
4
|
export type DocsBlockDividerPropertyOptions = Record<string, never>;
|
|
5
|
+
/** Divider property - Data */
|
|
6
|
+
export type DocsBlockDividerPropertyData = DocsBlockPropertyData<never> & Record<string, never>;
|
|
7
|
+
/** Divider property - Definition model */
|
|
3
8
|
export type DocsBlockDividerPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockDividerPropertyOptions;
|
|
4
|
-
/** Divider property */
|
|
5
|
-
export declare class DocsBlockDividerPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockDividerPropertyOptions> {
|
|
9
|
+
/** Divider property - Definition */
|
|
10
|
+
export declare class DocsBlockDividerPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockDividerPropertyOptions, DocsBlockDividerPropertyData> {
|
|
11
|
+
type: DocsBlockItemPropertyType.divider;
|
|
6
12
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** EmbedUrl property - Additional non-value options */
|
|
2
4
|
export type DocsBlockEmbedUrlPropertyOptions = {
|
|
3
5
|
/** Defines what should be the default height of the embed */
|
|
4
6
|
defaultHeight: number;
|
|
@@ -9,7 +11,14 @@ export type DocsBlockEmbedUrlPropertyOptions = {
|
|
|
9
11
|
/** Defined how to validate the embed URL */
|
|
10
12
|
urlValidationRegex?: string;
|
|
11
13
|
};
|
|
14
|
+
/** EmbedUrl property - Data */
|
|
15
|
+
export type DocsBlockEmbedUrlPropertyData = DocsBlockPropertyData<string> & {
|
|
16
|
+
caption?: string;
|
|
17
|
+
height?: number;
|
|
18
|
+
};
|
|
19
|
+
/** EmbedUrl property - Definition model */
|
|
12
20
|
export type DocsBlockEmbedUrlPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockEmbedUrlPropertyOptions;
|
|
13
|
-
/** EmbedUrl property */
|
|
14
|
-
export declare class DocsBlockEmbedUrlPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockEmbedUrlPropertyOptions> {
|
|
21
|
+
/** EmbedUrl property - Definition */
|
|
22
|
+
export declare class DocsBlockEmbedUrlPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockEmbedUrlPropertyOptions, DocsBlockEmbedUrlPropertyData> {
|
|
23
|
+
type: DocsBlockItemPropertyType.embedURL;
|
|
15
24
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockImageProperty.d.ts
CHANGED
|
@@ -1,15 +1,25 @@
|
|
|
1
|
+
import { Alignment } from "../../../enums/SDKAlignment";
|
|
1
2
|
import { DocsBlockImagePropertyAspectRatio } from "../../../enums/SDKDocsBlockImagePropertyAspectRatio";
|
|
2
3
|
import { DocsBlockImagePropertyWidth } from "../../../enums/SDKDocsBlockImagePropertyWidth";
|
|
3
|
-
import {
|
|
4
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
5
|
+
import { DocsImageRef } from "../support/SDKDocsImageRef";
|
|
6
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
|
|
7
|
+
/** Image property - Additional non-value options */
|
|
4
8
|
export type DocsBlockImagePropertyOptions = {
|
|
5
9
|
width?: DocsBlockImagePropertyWidth;
|
|
6
10
|
aspectRatio?: DocsBlockImagePropertyAspectRatio;
|
|
7
11
|
allowCaption?: boolean;
|
|
8
12
|
recommendation?: string;
|
|
9
13
|
};
|
|
10
|
-
|
|
11
|
-
|
|
14
|
+
/** Image property - Data */
|
|
15
|
+
export type DocsBlockImagePropertyData = DocsBlockPropertyData<DocsImageRef | undefined> & {
|
|
16
|
+
alt: string;
|
|
17
|
+
caption?: string;
|
|
18
|
+
alignment?: Alignment;
|
|
12
19
|
};
|
|
13
|
-
/** Image property */
|
|
14
|
-
export
|
|
20
|
+
/** Image property - Definition model */
|
|
21
|
+
export type DocsBlockImagePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockImagePropertyOptions;
|
|
22
|
+
/** Image property - Definition */
|
|
23
|
+
export declare class DocsBlockImagePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockImagePropertyOptions, DocsBlockImagePropertyData> {
|
|
24
|
+
type: DocsBlockItemPropertyType.image;
|
|
15
25
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMarkdownProperty.d.ts
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** Markdown property - Additional non-value options */
|
|
2
4
|
export type DocsBlockMarkdownPropertyOptions = Record<string, never>;
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
export declare class DocsBlockMarkdownPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockMarkdownPropertyOptions> {
|
|
5
|
+
/** Markdown property - Data */
|
|
6
|
+
export type DocsBlockMarkdownPropertyData = DocsBlockPropertyData<string> & Record<string, never>;
|
|
7
|
+
/** Markdown property - Definition model */
|
|
8
|
+
export type DocsBlockMarkdownPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockMarkdownPropertyOptions;
|
|
9
|
+
/** Markdown property - Definition */
|
|
10
|
+
export declare class DocsBlockMarkdownPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockMarkdownPropertyOptions, DocsBlockMarkdownPropertyData> {
|
|
11
|
+
type: DocsBlockItemPropertyType.markdown;
|
|
11
12
|
}
|