@supernova-studio/supernova-sdk-beta 1.6.25 → 1.6.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/build/sdk-typescript/src/core/SDKSupernova.d.ts +16 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +33 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaBulkOperations.d.ts +11 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDesignSystems.d.ts +37 -2
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +86 -3
- package/build/sdk-typescript/src/core/areas/SDKAreaNetwork.d.ts +9 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +30 -0
- package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +2 -0
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +61 -3
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +16 -1
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +75 -4
- package/build/sdk-typescript/src/core/resolvers/SDKTokenResolver.d.ts +2 -1
- package/build/sdk-typescript/src/exports-pulsar.d.ts +228 -0
- package/build/sdk-typescript/src/exports.d.ts +53 -24
- package/build/sdk-typescript/src/index.d.ts +4 -0
- package/build/sdk-typescript/src/model/assets/SDKAsset.d.ts +1 -0
- package/build/sdk-typescript/src/model/base/SDKDesignSystem.d.ts +6 -8
- package/build/sdk-typescript/src/model/components/SDKDesignComponent.d.ts +2 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockLayout.d.ts +13 -5
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockVariant.d.ts +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{h1/SDKDocsBlockActualH1.d.ts → embed/SDKDocsBlockActualEmbed.d.ts} +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed-figma/SDKDocsBlockActualEmbedFigma.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed-lottie/SDKDocsBlockActualEmbedLottie.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed-youtube/SDKDocsBlockActualEmbedYoutube.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/markdown/SDKDocsBlockActualMarkdown.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{links/SDKDocsBlockActualLinks.d.ts → shortcut-links/SDKDocsBlockActualShortcutLinks.d.ts} +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/storybook/SDKDocsBlockActualStorybook.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{h2/SDKDocsBlockActualH2.d.ts → table/SDKDocsBlockActualTable.d.ts} +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{h3/SDKDocsBlockActualH3.d.ts → title1/SDKDocsBlockActualTitle1.d.ts} +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{h4/SDKDocsBlockActualH4.d.ts → title2/SDKDocsBlockActualTitle2.d.ts} +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/title3/SDKDocsBlockActualTitle3.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/title4/SDKDocsBlockActualTitle4.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/title5/SDKDocsBlockActualTitle5.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockImageProperty.d.ts +2 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +3 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityGroup.d.ts +2 -2
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyConfiguration.d.ts +9 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyGroup.d.ts +2 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPage.d.ts +3 -1
- package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationLegacyItemConfiguration.d.ts +1 -0
- package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationLegacyItemHeader.d.ts +3 -0
- package/build/sdk-typescript/src/model/enums/SDKBorderPosition.d.ts +1 -0
- package/build/sdk-typescript/src/model/enums/SDKBorderStyle.d.ts +1 -0
- package/build/sdk-typescript/src/model/enums/SDKCloudWarningType.d.ts +14 -0
- package/build/sdk-typescript/src/model/enums/SDKCustomDomainErrorCode.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKCustomDomainState.d.ts +9 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockCategory.d.ts +15 -9
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockImagePropertyWidth.d.ts +12 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +4 -2
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutAlign.d.ts +8 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutColumnResizing.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutGap.d.ts +10 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockTextPropertyColor.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockTextPropertyStyle.d.ts +20 -4
- package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts +3 -3
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionStatus.d.ts +6 -14
- package/build/sdk-typescript/src/model/exporters/SDKExporter.d.ts +16 -12
- package/build/sdk-typescript/src/model/exporters/SDKPipeline.d.ts +131 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuild.d.ts +104 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuildResults.d.ts +73 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportDestinations.d.ts +111 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemotePipelineModel.d.ts +55 -0
- package/build/sdk-typescript/src/model/jobs/SDKImportJob.d.ts +2 -7
- package/build/sdk-typescript/src/model/support/SDKCustomDomain.d.ts +21 -0
- package/build/sdk-typescript/src/model/support/SDKSource.d.ts +20 -8
- package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +3 -0
- package/build/sdk-typescript/src/model/tokens/SDKDimensionToken.d.ts +1 -1
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspace.d.ts +0 -5
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceInvitation.d.ts +31 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceInvoice.d.ts +38 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProductFeatures.d.ts +3 -1
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceSubscription.d.ts +8 -31
- package/build/sdk-typescript/src/pulsar-interfaces.d.ts +40 -0
- package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +1 -1
- package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +25 -4
- package/build/supernova-sdk-typescript.js +2 -70428
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +17 -15
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/h5/SDKDocsBlockActualH5.d.ts +0 -6
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionStatusInternal.d.ts +0 -8
- package/build/sdk-typescript/src/tests/Areas/AreaTokenValues.d.ts +0 -0
- package/build/sdk-typescript/src/tests/Enterprise/PluginFigmaTokens.spec.d.ts +0 -1
package/README.md
CHANGED
|
@@ -34,7 +34,7 @@ And of course, features that make all developers happy!
|
|
|
34
34
|
To install, simply run:
|
|
35
35
|
|
|
36
36
|
```bash
|
|
37
|
-
npm install @supernovaio/
|
|
37
|
+
npm install @supernovaio/sdk
|
|
38
38
|
```
|
|
39
39
|
|
|
40
40
|
Supernova SDK is made to run in both local (like Node.js) and remote environments (like browsers) so you can use it to develop your React sites or any kind of tool you would like to run as client-side app.
|
|
@@ -55,13 +55,13 @@ Usage of the SDK adheres to the [general access rights](https://learn.supernova.
|
|
|
55
55
|
It is time to put this SDK to good use! To start, import the main Supernova SDK object:
|
|
56
56
|
|
|
57
57
|
```typescript
|
|
58
|
-
import { Supernova } from "@supernovaio/
|
|
58
|
+
import { Supernova } from "@supernovaio/sdk"
|
|
59
59
|
```
|
|
60
60
|
|
|
61
61
|
And instantiate it with your API key:
|
|
62
62
|
|
|
63
63
|
```typescript
|
|
64
|
-
const supernova = new Supernova(key
|
|
64
|
+
const supernova = new Supernova(key)
|
|
65
65
|
```
|
|
66
66
|
|
|
67
67
|
Supernova instance is used for several purposes, but the main one is to select specific design system you want to fetch the data from.
|
|
@@ -8,6 +8,7 @@ import { AreaDesignSystems } from "./areas/SDKAreaDesignSystems";
|
|
|
8
8
|
import { AreaDocumentation } from "./areas/SDKAreaDocumentation";
|
|
9
9
|
import { AreaIntegrations } from "./areas/SDKAreaIntegrations";
|
|
10
10
|
import { AreaMe } from "./areas/SDKAreaMe";
|
|
11
|
+
import { AreaNetwork } from "./areas/SDKAreaNetwork";
|
|
11
12
|
import { AreaTokens } from "./areas/SDKAreaTokens";
|
|
12
13
|
import { AreaUsers } from "./areas/SDKAreaUsers";
|
|
13
14
|
import { AreaVersions } from "./areas/SDKAreaVersions";
|
|
@@ -48,5 +49,19 @@ export declare class Supernova {
|
|
|
48
49
|
dataSources: AreaDataSources;
|
|
49
50
|
/** Get, create, update, manipulate or delete data from Supernova en masse */
|
|
50
51
|
bulkOperations: AreaBulkOperations;
|
|
51
|
-
|
|
52
|
+
/** Get access to network in exporter packages */
|
|
53
|
+
network: AreaNetwork;
|
|
54
|
+
/**
|
|
55
|
+
* Create new Supernova.io SDK object.
|
|
56
|
+
* @param apiKey API key to use for authentication
|
|
57
|
+
* @param options Options for SDK
|
|
58
|
+
* @param options.url URL of the Supernova.io instance to connect to. Defaults to production environment
|
|
59
|
+
* @param options.requestHook Hook for observing requests
|
|
60
|
+
* @param options.bypassEnvFetch When enabled, internal node-fetch lib will be used in environments when fetch is not available. Defaults to false
|
|
61
|
+
*/
|
|
62
|
+
constructor(apiKey: string, options?: {
|
|
63
|
+
apiUrl?: string;
|
|
64
|
+
requestHook?: DataBridgeRequestHook;
|
|
65
|
+
bypassEnvFetch?: boolean;
|
|
66
|
+
});
|
|
52
67
|
}
|
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
|
|
2
2
|
import { ExporterCustomBlockVariant } from "../../model/exporters/custom_blocks/SDKExporterCustomBlockVariant";
|
|
3
3
|
import { ExporterConfigurationProperty } from "../../model/exporters/custom_properties/SDKExporterConfigurationProperty";
|
|
4
|
+
import { ExportBuild } from "../../model/exporters/exporter_builds/SDKExportBuild";
|
|
5
|
+
import { PipelineRemoteModel } from "../../model/exporters/remote/SDKRemotePipelineModel";
|
|
4
6
|
import { Exporter } from "../../model/exporters/SDKExporter";
|
|
7
|
+
import { NewPipelinePayload, Pipeline } from "../../model/exporters/SDKPipeline";
|
|
5
8
|
import { ImportJob } from "../../model/jobs/SDKImportJob";
|
|
6
9
|
import { DataCore } from "../data/SDKDataCore";
|
|
7
10
|
import { RemoteVersionIdentifier, RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
@@ -9,8 +12,17 @@ export declare class AreaAutomation {
|
|
|
9
12
|
/** Internal: Engine */
|
|
10
13
|
private dataCore;
|
|
11
14
|
constructor(dataCore: DataCore);
|
|
15
|
+
/** Fetches all pipelines that are available for the workspace by id */
|
|
16
|
+
getPipelines(workspaceId: string): Promise<Array<Pipeline>>;
|
|
17
|
+
/** Fetches all builds of pipelines
|
|
18
|
+
* @param workspaceId - Identifier of the workspace where the pipeline is installed
|
|
19
|
+
* @param versionId - Identifier of the version where the pipeline is installed
|
|
20
|
+
*/
|
|
21
|
+
getExportBuilds(workspaceId: string, versionId: string): Promise<Array<ExportBuild>>;
|
|
12
22
|
/** Fetches exporters belonging to workspace by id */
|
|
13
|
-
getExporters(workspaceId: string
|
|
23
|
+
getExporters(workspaceId: string, filter?: {
|
|
24
|
+
installedOnly?: boolean;
|
|
25
|
+
}): Promise<Array<Exporter>>;
|
|
14
26
|
/** Fetches all custom configuration properties that specific exporter provides
|
|
15
27
|
* @param exporterId - Identifier of the exporter to fetch configuration for
|
|
16
28
|
* @param from - Remote version to fetch from
|
|
@@ -42,4 +54,24 @@ export declare class AreaAutomation {
|
|
|
42
54
|
getImportJobs(from: RemoteVersionIdentifier): Promise<Array<ImportJob>>;
|
|
43
55
|
getImportJob(from: RemoteVersionIdentifier, jobId: string): Promise<ImportJob>;
|
|
44
56
|
scheduleImportJobForFigmaSources(from: RemoteVersionIdentifier, sourceIds: Array<string>, dryRun?: boolean): Promise<ImportJob>;
|
|
57
|
+
/** Create pipeline
|
|
58
|
+
* @param workspaceId string
|
|
59
|
+
* @param pipeline Pipeline
|
|
60
|
+
* @returns Pipeline
|
|
61
|
+
*/
|
|
62
|
+
createPipeline(workspaceId: string, pipeline: NewPipelinePayload): Promise<Pipeline>;
|
|
63
|
+
/** Update pipeline
|
|
64
|
+
* @param workspaceId string
|
|
65
|
+
* @param pipeline Pipeline
|
|
66
|
+
* @returns Pipeline
|
|
67
|
+
*/
|
|
68
|
+
updatePipeline(workspaceId: string, pipeline: PipelineRemoteModel): Promise<Pipeline>;
|
|
69
|
+
/**
|
|
70
|
+
* Run pipeline
|
|
71
|
+
* @param workspaceId string
|
|
72
|
+
* @param designSystemVersionId string
|
|
73
|
+
* @param pipelineId string
|
|
74
|
+
*/
|
|
75
|
+
runPipeline(workspaceId: string, designSystemVersionId: string, pipelineId: string): Promise<Pipeline>;
|
|
76
|
+
deletePipeline(workspaceId: string, pipelineId: string): Promise<void>;
|
|
45
77
|
}
|
|
@@ -29,6 +29,17 @@ export declare class AreaBulkOperations {
|
|
|
29
29
|
/** Internal: Engine */
|
|
30
30
|
private dataCore;
|
|
31
31
|
constructor(dataCore: DataCore);
|
|
32
|
+
/** Import tokens in bulk using new import routine
|
|
33
|
+
*
|
|
34
|
+
* @param designSystemId - Remote design system to write to
|
|
35
|
+
* @param brandId - Remote brand to write to
|
|
36
|
+
* @param sourceName - Name of the source, such as Figma file name
|
|
37
|
+
* @param sourceId - Unique ID of the source, such as Figma file id
|
|
38
|
+
* @param sourceType - Source from which import originates. Currently only "FigmaVariablesPlugin" is supported
|
|
39
|
+
* @param payload - Payload to import. Types to come
|
|
40
|
+
* @returns Nothing
|
|
41
|
+
*/
|
|
42
|
+
importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", payload: any): Promise<any>;
|
|
32
43
|
/** Batch updates, creates or deletes token data from Supernova at once. Use this method to perform multiple operations at once instead of chaining single update operations. Batch routine runs everything in a single transaction, so either all operations succeed or all fail.
|
|
33
44
|
*
|
|
34
45
|
* WARNING: This method is not yet complete and only supports limited set of operations. Also, doesn't work as transation just yet.
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import { DesignSystem } from "../../model/base/SDKDesignSystem";
|
|
1
|
+
import { DesignSystem, DesignSystemSwitcher } from "../../model/base/SDKDesignSystem";
|
|
2
|
+
import { CustomDomain } from "../../model/support/SDKCustomDomain";
|
|
2
3
|
import { DataCore } from "../data/SDKDataCore";
|
|
3
4
|
export declare class AreaDesignSystems {
|
|
4
5
|
/** Internal: Engine */
|
|
@@ -14,6 +15,11 @@ export declare class AreaDesignSystems {
|
|
|
14
15
|
* @returns Design system with the specified id
|
|
15
16
|
*/
|
|
16
17
|
designSystem(designSystemId: string): Promise<DesignSystem | null>;
|
|
18
|
+
/** Retrieves custom domain information for a design system
|
|
19
|
+
* @param designSystemId - ID of the design system
|
|
20
|
+
* @returns custom domain information
|
|
21
|
+
*/
|
|
22
|
+
designSystemCustomDomain(designSystemId: string): Promise<CustomDomain>;
|
|
17
23
|
/** Creates a new design system and retrieves the newly created DS object
|
|
18
24
|
* @param name - Name of the design system
|
|
19
25
|
* @returns Newly created design system object
|
|
@@ -27,14 +33,43 @@ export declare class AreaDesignSystems {
|
|
|
27
33
|
*/
|
|
28
34
|
updateDesignSystemMetadata(designSystemId: string, name: string, description?: string): Promise<void>;
|
|
29
35
|
/** Enabled or disables multibrand functionality for a specific design system
|
|
30
|
-
* @param
|
|
36
|
+
* @param designSystem - design system to update
|
|
31
37
|
* @param isMultibrand - Multibrand functionality enabled or disabled
|
|
32
38
|
* @returns Nothing
|
|
33
39
|
*/
|
|
34
40
|
updateDesignSystemIsMultibrand(designSystem: DesignSystem, isMultibrand: boolean): Promise<void>;
|
|
41
|
+
/** Enabled or disables multibrand functionality for a specific design system
|
|
42
|
+
* @param designSystem - design system to update
|
|
43
|
+
* @param designSystemSwitcher - Design system switcher options
|
|
44
|
+
* @returns Nothing
|
|
45
|
+
*/
|
|
46
|
+
updateDesignSystemSwitcher(designSystem: DesignSystem, designSystemSwitcher: DesignSystemSwitcher): Promise<void>;
|
|
47
|
+
/** Enabled or disables multibrand functionality for a specific design system
|
|
48
|
+
* @param designSystem - design system to update
|
|
49
|
+
* @param docExporterId - Design system doc exporter id
|
|
50
|
+
* @returns Nothing
|
|
51
|
+
*/
|
|
52
|
+
updateDesignSystemDocExporterId(designSystem: DesignSystem, docExporterId: string): Promise<void>;
|
|
53
|
+
/** Changes documentation slug for design system
|
|
54
|
+
* @param designSystem - design system to update
|
|
55
|
+
* @param docUserSlug - Documentation slug
|
|
56
|
+
* @returns Nothing
|
|
57
|
+
*/
|
|
58
|
+
updateDesignSystemDocumentationSlug(designSystem: DesignSystem, docUserSlug: string): Promise<void>;
|
|
59
|
+
/** Updates custom domain of a specific design system
|
|
60
|
+
* @param designSystemId - ID of the design system
|
|
61
|
+
* @param newDomain - new custom domain
|
|
62
|
+
* @returns nothing
|
|
63
|
+
*/
|
|
64
|
+
updateDesignSystemCustomDomain(designSystemId: string, newDomain: string): Promise<CustomDomain>;
|
|
35
65
|
/** Deletes a design system. This action is irreversible, all data will be lost, and can only be performed by the admins of the workspace
|
|
36
66
|
* @param designSystemId - ID of the design system
|
|
37
67
|
* @returns Nothing. RIP design system.
|
|
38
68
|
*/
|
|
39
69
|
deleteDesignSystem(designSystemId: string): Promise<void>;
|
|
70
|
+
/** Deletes custom domain
|
|
71
|
+
* @param designSystemId - ID of the design system
|
|
72
|
+
* @returns nothing
|
|
73
|
+
*/
|
|
74
|
+
deleteDesignSystemCustomDomain(designSystemId: string): Promise<void>;
|
|
40
75
|
}
|
|
@@ -1,11 +1,12 @@
|
|
|
1
|
-
import { DocumentationLegacy,
|
|
1
|
+
import { DocumentationLegacy, DocumentationLegacyModel } from "../../model/base/SDKDocumentationLegacy";
|
|
2
2
|
import { DocsBlockDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockDefinition";
|
|
3
3
|
import { DocsBlock } from "../../model/docs/blocks/usage/SDKDocsBlock";
|
|
4
4
|
import { DocsEntity } from "../../model/docs/entities/SDKDocsEntity";
|
|
5
5
|
import { DocsSection } from "../../model/docs/sections/SDKDocsSection";
|
|
6
|
-
import { DocumentationLegacyGroup } from "../../model/documentation/SDKDocumentationLegacyGroup";
|
|
6
|
+
import { DocumentationLegacyGroup, DocumentationLegacyGroupModel } from "../../model/documentation/SDKDocumentationLegacyGroup";
|
|
7
|
+
import { DocumentationLegacyPage, DocumentationLegacyPageModel } from "../../model/documentation/SDKDocumentationLegacyPage";
|
|
7
8
|
import { DataCore } from "../data/SDKDataCore";
|
|
8
|
-
import { RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
9
|
+
import { RemoteVersionIdentifier, RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
9
10
|
export declare class AreaDocumentation {
|
|
10
11
|
/** Internal: Engine */
|
|
11
12
|
private dataCore;
|
|
@@ -15,11 +16,93 @@ export declare class AreaDocumentation {
|
|
|
15
16
|
* @returns Documentation object
|
|
16
17
|
*/
|
|
17
18
|
getDocumentation(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacy>;
|
|
19
|
+
/** Fetches url string where to find documentation
|
|
20
|
+
* @param from - Remote version to fetch from
|
|
21
|
+
* @returns documentation url string
|
|
22
|
+
*/
|
|
23
|
+
getDocumentationUrl(from: RemoteVersionIdentifier): Promise<string>;
|
|
24
|
+
/** Updates documentation structure
|
|
25
|
+
* @param from - Remote version to fetch from
|
|
26
|
+
* @param model - documentation legacy model
|
|
27
|
+
* @returns nothing
|
|
28
|
+
*/
|
|
29
|
+
updateDocumentationStructure(from: RemoteVersionIdentifier, model: DocumentationLegacyModel): Promise<void>;
|
|
18
30
|
/** Fetches all documentation groups
|
|
19
31
|
* @param from - Remote version to fetch from
|
|
20
32
|
* @returns All documentation groups
|
|
21
33
|
*/
|
|
22
34
|
getDocumentationGroups(from: RemoteWorkspaceVersionIdentifier): Promise<Array<DocumentationLegacyGroup>>;
|
|
35
|
+
/** Creates a documentation page within documentation group
|
|
36
|
+
* @param from - Remote version to fetch from
|
|
37
|
+
* @param parentItemPersistentId - Peristent ID of the parent group
|
|
38
|
+
* @param newTitle - title of the newly created page
|
|
39
|
+
* @returns Newly created documentation page
|
|
40
|
+
*/
|
|
41
|
+
createDocumentationPage(from: RemoteWorkspaceVersionIdentifier, parentItemPersistentId: string, newTitle?: string): Promise<DocumentationLegacyPage>;
|
|
42
|
+
/** Creates a documentation group within documentation group
|
|
43
|
+
* @param from - Remote version to fetch from
|
|
44
|
+
* @param parentItemPersistentId - Peristent ID of the parent group
|
|
45
|
+
* @param data - The update model
|
|
46
|
+
* @returns Newly created documentation group
|
|
47
|
+
*/
|
|
48
|
+
createDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, parentItemPersistentId: string, data: Partial<DocumentationLegacyGroupModel>): Promise<DocumentationLegacyGroup>;
|
|
49
|
+
/** Updates a documentation group within documentation group
|
|
50
|
+
* @param from - Remote version to fetch from
|
|
51
|
+
* @param group - Group to update
|
|
52
|
+
* @param updateModel - Group update model with optional fields
|
|
53
|
+
* @returns Newly created documentation group
|
|
54
|
+
*/
|
|
55
|
+
updateDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, group: DocumentationLegacyGroup, updateModel: Partial<DocumentationLegacyGroupModel>): Promise<DocumentationLegacyGroup>;
|
|
56
|
+
/** Deletes a documentation group
|
|
57
|
+
* @param from - Remote version to fetch from
|
|
58
|
+
* @param group - Group to delete
|
|
59
|
+
* @returns nothing
|
|
60
|
+
*/
|
|
61
|
+
deleteDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, group: DocumentationLegacyGroup): Promise<void>;
|
|
62
|
+
/** Deletes a documentation group and its tree
|
|
63
|
+
* @param from - Remote version to fetch from
|
|
64
|
+
* @param group - Group to delete
|
|
65
|
+
* @returns nothing
|
|
66
|
+
*/
|
|
67
|
+
deleteDocumentationGroupAndTree(from: RemoteWorkspaceVersionIdentifier, group: DocumentationLegacyGroup): Promise<void>;
|
|
68
|
+
/** Deletes a documentation page
|
|
69
|
+
* @param from - Remote version to fetch from
|
|
70
|
+
* @param page - Page to delete
|
|
71
|
+
* @returns nothing
|
|
72
|
+
*/
|
|
73
|
+
deleteDocumentationPage(from: RemoteWorkspaceVersionIdentifier, idInVersion: string): Promise<void>;
|
|
74
|
+
/** Updates a documentation tab or page
|
|
75
|
+
* @param from - Remote version to fetch from
|
|
76
|
+
* @param page - page to update
|
|
77
|
+
* @param updateModel - data to update page with
|
|
78
|
+
* @returns nothing
|
|
79
|
+
*/
|
|
80
|
+
updateDocumentationPageOrTab(from: RemoteWorkspaceVersionIdentifier, page: DocumentationLegacyPage, updateModel: Partial<DocumentationLegacyPageModel>): Promise<DocumentationLegacyPage>;
|
|
81
|
+
/** Duplicates a documentation tab or page
|
|
82
|
+
* @param from - Remote version to fetch from
|
|
83
|
+
* @param idInVersion - id of page or tab to be duplicated
|
|
84
|
+
* @param newPersistentId - suggested persistent id of a new page or tab
|
|
85
|
+
* @returns Promise<DocumentationLegacyPage>
|
|
86
|
+
*/
|
|
87
|
+
duplicateDocumentationPageOrTab(from: RemoteWorkspaceVersionIdentifier, idInVersion: string, newPersistentId?: string): Promise<DocumentationLegacyPage>;
|
|
88
|
+
/** Duplicates a documentation group or tabbed page
|
|
89
|
+
* @param from - Remote version to fetch from
|
|
90
|
+
* @param idInVersion - id of page or tab to be duplicated
|
|
91
|
+
* @param newPersistentId - suggested persistent id of a new group or tabbed page
|
|
92
|
+
* @returns nothing
|
|
93
|
+
*/
|
|
94
|
+
duplicateDocumentationGroupOrTabbedPage(from: RemoteWorkspaceVersionIdentifier, idInVersion: string, newPersistentId?: string): Promise<void>;
|
|
95
|
+
/** Ungroups a documentation group
|
|
96
|
+
* @param from - Remote version to fetch from
|
|
97
|
+
* @param idInVersion - id of a group
|
|
98
|
+
* @returns nothing
|
|
99
|
+
*/
|
|
100
|
+
ungroupDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, idInVersion: string): Promise<void>;
|
|
101
|
+
/** Fetches all documentation items
|
|
102
|
+
* @param from - Remote version to fetch from
|
|
103
|
+
* @returns All documentation pages
|
|
104
|
+
*/
|
|
105
|
+
getDocumentationItems(from: RemoteWorkspaceVersionIdentifier): Promise<import("../..").DocumentationLegacyItem[]>;
|
|
23
106
|
/** Fetches all documentation pages
|
|
24
107
|
* @param from - Remote version to fetch from
|
|
25
108
|
* @returns All documentation pages
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
2
|
+
import { RequestInfo, RequestInit, Response } from "node-fetch";
|
|
3
|
+
export declare class AreaNetwork {
|
|
4
|
+
/** Internal: Engine */
|
|
5
|
+
private dataCore;
|
|
6
|
+
constructor(dataCore: DataCore);
|
|
7
|
+
/** Fires network request using node-fetch library */
|
|
8
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
9
|
+
}
|
|
@@ -2,12 +2,15 @@ import { Acl } from "../../model/acl/SDKAcl";
|
|
|
2
2
|
import { Membership } from "../../model/membership/SDKMembership";
|
|
3
3
|
import { UserMembership } from "../../model/users/SDKUserMembership";
|
|
4
4
|
import { Workspace } from "../../model/workspaces/SDKWorkspace";
|
|
5
|
+
import { WorkspaceInvitation } from "../../model/workspaces/SDKWorkspaceInvitation";
|
|
6
|
+
import { WorkspaceInvoice } from "../../model/workspaces/SDKWorkspaceInvoice";
|
|
5
7
|
import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
6
8
|
import { WorkspaceNPMRegistrySettings, WorkspaceNPMRegistrySettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
|
|
7
9
|
import { WorkspaceOnboarding, WorkspaceOnboardingUpdateModel } from "../../model/workspaces/SDKWorkspaceOnboarding";
|
|
8
10
|
import { SubscriptionProductFeatures } from "../../model/workspaces/SDKWorkspaceProductFeatures";
|
|
9
11
|
import { WorkspaceProfileUpdateModel } from "../../model/workspaces/SDKWorkspaceProfile";
|
|
10
12
|
import { WorkspaceSSOSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
13
|
+
import { WorkspaceSubscription } from "../../model/workspaces/SDKWorkspaceSubscription";
|
|
11
14
|
import { DataCore } from "../data/SDKDataCore";
|
|
12
15
|
export declare class AreaWorkspaces {
|
|
13
16
|
/** Internal: Engine */
|
|
@@ -60,6 +63,21 @@ export declare class AreaWorkspaces {
|
|
|
60
63
|
* @returns Workspace SSO settings or null if the workspace is not using SSO
|
|
61
64
|
*/
|
|
62
65
|
workspaceSSOSettings(workspaceId: string): Promise<WorkspaceSSOSettingsUpdateModel | null>;
|
|
66
|
+
/** Fetches all invitations that are part of the workspace.
|
|
67
|
+
* @param workspaceId - ID of the workspace
|
|
68
|
+
* @returns All invitations of the provided workspace
|
|
69
|
+
*/
|
|
70
|
+
workspaceInvitations(workspaceId: string): Promise<Array<WorkspaceInvitation>>;
|
|
71
|
+
/** Fetches all invoices for the workspace.
|
|
72
|
+
* @param workspaceId - ID of the workspace
|
|
73
|
+
* @returns All invoices of the provided workspace
|
|
74
|
+
*/
|
|
75
|
+
workspaceInvoices(workspaceId: string): Promise<Array<WorkspaceInvoice>>;
|
|
76
|
+
/** Fetches a subscription of the workspace.
|
|
77
|
+
* @param workspaceId - ID of the workspace
|
|
78
|
+
* @returns A subscription of the provided workspace
|
|
79
|
+
*/
|
|
80
|
+
workspaceSubscription(workspaceId: string): Promise<WorkspaceSubscription>;
|
|
63
81
|
/** Creates new workspace and retrieves the newly created workspace object. The user who creates the workspace becomes its owner
|
|
64
82
|
* @param name - Name of the workspace
|
|
65
83
|
* @param handle - Handle of the workspace to create. Use `validateIsWorkspaceHandleAvailable` to check if the handle is available
|
|
@@ -125,4 +143,16 @@ export declare class AreaWorkspaces {
|
|
|
125
143
|
* @returns Nothing
|
|
126
144
|
*/
|
|
127
145
|
deleteWorkspaceNPMRegistrySettings(workspaceId: string): Promise<void>;
|
|
146
|
+
/** Deletes a member from the workspace.
|
|
147
|
+
* @param workspaceId - ID of the workspace
|
|
148
|
+
* @param userId - ID of the member
|
|
149
|
+
* @returns Nothing
|
|
150
|
+
*/
|
|
151
|
+
deleteWorkspaceMember(workspaceId: string, userId: string): Promise<void>;
|
|
152
|
+
/** Deletes an invitation from the workspace.
|
|
153
|
+
* @param workspaceId - ID of the workspace
|
|
154
|
+
* @param invitationId - ID of the invitation
|
|
155
|
+
* @returns Nothing
|
|
156
|
+
*/
|
|
157
|
+
deleteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
128
158
|
}
|
|
@@ -17,6 +17,7 @@ export type DataBridgeConfiguration = {
|
|
|
17
17
|
apiVersion: string;
|
|
18
18
|
accessToken: string;
|
|
19
19
|
target: string | null;
|
|
20
|
+
bypassEnvFetch: boolean;
|
|
20
21
|
requestHook: DataBridgeRequestHook | null;
|
|
21
22
|
debugRequestObserver?: DebugRequestObserver | null;
|
|
22
23
|
debugResponseObserver?: DebugResponseObserver | null;
|
|
@@ -26,6 +27,7 @@ export declare class DataBridge {
|
|
|
26
27
|
apiUrl: string;
|
|
27
28
|
apiVersion: string;
|
|
28
29
|
target: string | null;
|
|
30
|
+
bypassEnvFetch: boolean;
|
|
29
31
|
requestHook: DataBridgeRequestHook | null;
|
|
30
32
|
debugRequestObserver: DebugRequestObserver | null;
|
|
31
33
|
debugResponseObserver: DebugResponseObserver | null;
|
|
@@ -2,12 +2,14 @@ import { Acl } from "../../model/acl/SDKAcl";
|
|
|
2
2
|
import { Asset } from "../../model/assets/SDKAsset";
|
|
3
3
|
import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
|
|
4
4
|
import { Brand, BrandUpdateModel } from "../../model/base/SDKBrand";
|
|
5
|
-
import { DesignSystem } from "../../model/base/SDKDesignSystem";
|
|
5
|
+
import { DesignSystem, DesignSystemSwitcher } from "../../model/base/SDKDesignSystem";
|
|
6
6
|
import { DesignSystemVersion, DesignSystemVersionUpdateModel } from "../../model/base/SDKDesignSystemVersion";
|
|
7
|
-
import { DocumentationLegacy } from "../../model/base/SDKDocumentationLegacy";
|
|
7
|
+
import { DocumentationLegacy, DocumentationLegacyModel } from "../../model/base/SDKDocumentationLegacy";
|
|
8
8
|
import { Component } from "../../model/components/SDKComponent";
|
|
9
9
|
import { DesignComponent } from "../../model/components/SDKDesignComponent";
|
|
10
|
+
import { DocumentationLegacyGroup, DocumentationLegacyGroupModel } from "../../model/documentation/SDKDocumentationLegacyGroup";
|
|
10
11
|
import { DocumentationLegacyItem } from "../../model/documentation/SDKDocumentationLegacyItem";
|
|
12
|
+
import { DocumentationLegacyPage, DocumentationLegacyPageModel } from "../../model/documentation/SDKDocumentationLegacyPage";
|
|
11
13
|
import { ElementDataView } from "../../model/elements/SDKElementDataView";
|
|
12
14
|
import { ElementDataViewColumn } from "../../model/elements/SDKElementDataViewColumn";
|
|
13
15
|
import { ElementProperty, ElementPropertyCreationModel, ElementPropertyTargetElementType, ElementPropertyUpdateModel } from "../../model/elements/SDKElementProperty";
|
|
@@ -17,13 +19,17 @@ import { TokenType } from "../../model/enums/SDKTokenType";
|
|
|
17
19
|
import { ExporterCustomBlock } from "../../model/exporters/custom_blocks/SDKExporterCustomBlock";
|
|
18
20
|
import { ExporterCustomBlockVariant } from "../../model/exporters/custom_blocks/SDKExporterCustomBlockVariant";
|
|
19
21
|
import { ExporterConfigurationProperty } from "../../model/exporters/custom_properties/SDKExporterConfigurationProperty";
|
|
22
|
+
import { ExportBuild } from "../../model/exporters/exporter_builds/SDKExportBuild";
|
|
23
|
+
import { PipelineRemoteModel } from "../../model/exporters/remote/SDKRemotePipelineModel";
|
|
20
24
|
import { Exporter } from "../../model/exporters/SDKExporter";
|
|
25
|
+
import { NewPipelinePayload, Pipeline } from "../../model/exporters/SDKPipeline";
|
|
21
26
|
import { AssetGroup } from "../../model/groups/SDKAssetGroup";
|
|
22
27
|
import { ComponentGroup } from "../../model/groups/SDKComponentGroup";
|
|
23
28
|
import { DesignComponentGroup } from "../../model/groups/SDKDesignComponentGroup";
|
|
24
29
|
import { TokenGroup } from "../../model/groups/SDKTokenGroup";
|
|
25
30
|
import { ImportJob } from "../../model/jobs/SDKImportJob";
|
|
26
31
|
import { Membership } from "../../model/membership/SDKMembership";
|
|
32
|
+
import { CustomDomain } from "../../model/support/SDKCustomDomain";
|
|
27
33
|
import { Source, SourceRemoteModelCloud } from "../../model/support/SDKSource";
|
|
28
34
|
import { TokenTheme } from "../../model/themes/SDKTokenTheme";
|
|
29
35
|
import { Token } from "../../model/tokens/SDKToken";
|
|
@@ -31,15 +37,19 @@ import { User } from "../../model/users/SDKUser";
|
|
|
31
37
|
import { UserMembership } from "../../model/users/SDKUserMembership";
|
|
32
38
|
import { UserProfileUpdateModel } from "../../model/users/SDKUserProfile";
|
|
33
39
|
import { Workspace } from "../../model/workspaces/SDKWorkspace";
|
|
40
|
+
import { WorkspaceInvitation } from "../../model/workspaces/SDKWorkspaceInvitation";
|
|
41
|
+
import { WorkspaceInvoice } from "../../model/workspaces/SDKWorkspaceInvoice";
|
|
34
42
|
import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
35
43
|
import { WorkspaceNPMRegistrySettings, WorkspaceNPMRegistrySettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
|
|
36
44
|
import { WorkspaceOnboarding, WorkspaceOnboardingUpdateModel } from "../../model/workspaces/SDKWorkspaceOnboarding";
|
|
37
45
|
import { SubscriptionProductFeatures } from "../../model/workspaces/SDKWorkspaceProductFeatures";
|
|
38
46
|
import { WorkspaceProfileUpdateModel } from "../../model/workspaces/SDKWorkspaceProfile";
|
|
39
47
|
import { WorkspaceSSOSettings, WorkspaceSSOSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
48
|
+
import { WorkspaceSubscription } from "../../model/workspaces/SDKWorkspaceSubscription";
|
|
40
49
|
import { ComponentUpdateTransactionData, TokenUpdateTransactionData } from "../areas/SDKAreaBulkOperations";
|
|
41
50
|
import { RenderedAssetRequestSettings } from "./requests/SDKDataCoreRenderRequests";
|
|
42
51
|
import { DataBridge } from "./SDKDataBridge";
|
|
52
|
+
import { RequestInfo, RequestInit, Response } from "node-fetch";
|
|
43
53
|
export declare class DataCore {
|
|
44
54
|
/** Read part of the network calls */
|
|
45
55
|
private read;
|
|
@@ -47,7 +57,10 @@ export declare class DataCore {
|
|
|
47
57
|
private write;
|
|
48
58
|
/** Asset generation part of the network calls */
|
|
49
59
|
private render;
|
|
60
|
+
/** Bridge */
|
|
61
|
+
private bridge;
|
|
50
62
|
constructor(bridge: DataBridge);
|
|
63
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
51
64
|
/** Remote: Get information about currently logged in user */
|
|
52
65
|
currentUser(): Promise<User>;
|
|
53
66
|
/** Remote: Get information about a specific user */
|
|
@@ -134,6 +147,26 @@ export declare class DataCore {
|
|
|
134
147
|
id: string;
|
|
135
148
|
idInVersion: string;
|
|
136
149
|
}>;
|
|
150
|
+
/** Create a page within documentation */
|
|
151
|
+
createDocumentationPage(designSystemId: string, versionId: string, parentItemPersistentId: string, newTitle?: string): Promise<DocumentationLegacyPage>;
|
|
152
|
+
/** Create a group within documentation */
|
|
153
|
+
createDocumentationGroup(designSystemId: string, versionId: string, parentItemPersistentId: string, data: Partial<DocumentationLegacyGroupModel>): Promise<DocumentationLegacyGroup>;
|
|
154
|
+
/** Ungroup a documentaiton group */
|
|
155
|
+
ungroupDocumentationGroup(designSystemId: string, versionId: string, groupId: string): Promise<void>;
|
|
156
|
+
/** Updates a documentation group */
|
|
157
|
+
updateDocumentationGroup(designSystemId: string, versionId: string, group: DocumentationLegacyGroup, updateModel: Partial<DocumentationLegacyGroupModel>): Promise<DocumentationLegacyGroup>;
|
|
158
|
+
/** Updates a documentation page or tab */
|
|
159
|
+
updateDocumentationPageOrTab(designSystemId: string, versionId: string, page: DocumentationLegacyPage, updateModel: Partial<DocumentationLegacyPageModel>): Promise<DocumentationLegacyPage>;
|
|
160
|
+
/** Duplicate a documentation page or tab */
|
|
161
|
+
duplicateDocumentationPageOrTab(designSystemId: string, versionId: string, idInVersion: string, newPersistentId?: string): Promise<DocumentationLegacyPage>;
|
|
162
|
+
/** Duplicate a documentation group or tabbed page */
|
|
163
|
+
duplicateDocumentationGroupOrTabbedPage(designSystemId: string, versionId: string, idInVersion: string, newPersistentId?: string): Promise<void>;
|
|
164
|
+
/** Delete a documentation page */
|
|
165
|
+
deleteDocumentationPage(designSystemId: string, versionId: string, idInVerision: string): Promise<void>;
|
|
166
|
+
/** Delete a documentation group */
|
|
167
|
+
deleteDocumentationGroup(designSystemId: string, versionId: string, group: DocumentationLegacyGroup): Promise<void>;
|
|
168
|
+
/** Delete a documentation group and tree inside it */
|
|
169
|
+
deleteDocumentationGroupAndTree(designSystemId: string, versionId: string, group: DocumentationLegacyGroup): Promise<void>;
|
|
137
170
|
/** Create a custom property in remote */
|
|
138
171
|
updateTokenProperty(designSystemId: string, versionId: string, propertyIdInVersion: string, model: ElementPropertyUpdateModel): Promise<void>;
|
|
139
172
|
/** Delete a custom property in remote */
|
|
@@ -197,6 +230,7 @@ export declare class DataCore {
|
|
|
197
230
|
renderedAssets(designSystemId: string, versionId: string, assets: Array<Asset>, groups: Array<AssetGroup>, settings: RenderedAssetRequestSettings): Promise<Array<RenderedAsset>>;
|
|
198
231
|
/** Retrieve the main documentation object through which all docs data can be accessed */
|
|
199
232
|
documentation(workspaceId: string, designSystemId: string, versionId: string): Promise<DocumentationLegacy>;
|
|
233
|
+
updateDocumentationStructure(designSystemId: string, versionId: string, model: DocumentationLegacyModel): Promise<void>;
|
|
200
234
|
/** Download all necessary data for documentation items (groups and pages) and retrieve them resolved */
|
|
201
235
|
documentationItems(workspaceId: string, designSystemId: string, versionId: string): Promise<Array<DocumentationLegacyItem>>;
|
|
202
236
|
/** Retrieve currently deployed documentation url */
|
|
@@ -207,6 +241,11 @@ export declare class DataCore {
|
|
|
207
241
|
jobId: string;
|
|
208
242
|
exporterId: string;
|
|
209
243
|
}>;
|
|
244
|
+
pipelines(workspaceId: string): Promise<Array<Pipeline>>;
|
|
245
|
+
createPipeline(workspaceId: string, pipeline: NewPipelinePayload): Promise<Pipeline>;
|
|
246
|
+
updatePipeline(workspaceId: string, pipeline: PipelineRemoteModel): Promise<Pipeline>;
|
|
247
|
+
runPipeline(workspaceId: string, designSystemVersionId: string, pipelineId: string): Promise<Pipeline>;
|
|
248
|
+
deletePipeline(workspaceId: string, pipelineId: string): Promise<void>;
|
|
210
249
|
/** Download information about current exporter custom blocks and retrieve them resolved */
|
|
211
250
|
documentationExporterCustomBlocks(designSystemId: string, versionId: string): Promise<Array<ExporterCustomBlock>>;
|
|
212
251
|
/** Download information about current exporter custom block variants and retrieve them resolved */
|
|
@@ -221,7 +260,10 @@ export declare class DataCore {
|
|
|
221
260
|
/** Download information about installed exporter and retrieve it resolved */
|
|
222
261
|
exporter(workspaceId: string, exporterId: string): Promise<Exporter>;
|
|
223
262
|
/** Download information about all installed exporter and retrieve it resolved */
|
|
224
|
-
exporters(workspaceId: string
|
|
263
|
+
exporters(workspaceId: string, filter?: {
|
|
264
|
+
installedOnly?: boolean;
|
|
265
|
+
}): Promise<Array<Exporter>>;
|
|
266
|
+
exportBuilds(workspaceId: string, exporterId: string, limit?: number): Promise<Array<ExportBuild>>;
|
|
225
267
|
/** Download information about documentation builds and retrieve it resolved */
|
|
226
268
|
documentationBuilds(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment, limit?: number): Promise<Array<{
|
|
227
269
|
status: "InProgress" | "Success" | "Failed";
|
|
@@ -237,12 +279,17 @@ export declare class DataCore {
|
|
|
237
279
|
createBrand(designSystemId: string, versionId: any, model: BrandUpdateModel): Promise<Brand>;
|
|
238
280
|
editBrand(designSystemId: string, versionId: string, brandId: string, brand: Brand): Promise<void>;
|
|
239
281
|
deleteBrand(designSystemId: string, versionId: string, brandId: string): Promise<void>;
|
|
282
|
+
deleteCustomDomain(designSystemId: string): Promise<void>;
|
|
283
|
+
updateCustomDomain(designSystemId: string, customerDomain: string): Promise<CustomDomain>;
|
|
240
284
|
/** Validate that workspace handle is available */
|
|
241
285
|
validateIsWorkspaceHandleAvailable(handle: string): Promise<boolean>;
|
|
242
286
|
workspaceOnboarding(workspaceId: string): Promise<WorkspaceOnboarding>;
|
|
243
287
|
workspaceIPWhitelistSettings(workspaceId: string): Promise<WorkspaceIPWhitelistSettings | null>;
|
|
244
288
|
workspaceNPMRegistrySettings(workspaceId: string): Promise<WorkspaceNPMRegistrySettings | null>;
|
|
245
289
|
workspaceSSOSettings(workspaceId: string): Promise<WorkspaceSSOSettings | null>;
|
|
290
|
+
workspaceInvitations(workspaceId: string): Promise<Array<WorkspaceInvitation>>;
|
|
291
|
+
workspaceInvoices(workspaceId: string): Promise<Array<WorkspaceInvoice>>;
|
|
292
|
+
workspaceSubscription(workspaceId: string): Promise<WorkspaceSubscription>;
|
|
246
293
|
updateWorkspaceProfile(workspaceId: string, profile: WorkspaceProfileUpdateModel): Promise<void>;
|
|
247
294
|
testIpWhitelistSettings(workspaceId: string, ipWhitelistSettings: WorkspaceIPWhitelistSettingsUpdateModel): Promise<{
|
|
248
295
|
accessible: boolean;
|
|
@@ -255,6 +302,8 @@ export declare class DataCore {
|
|
|
255
302
|
deleteWorkspace(workspaceId: string): Promise<void>;
|
|
256
303
|
deleteWorkspaceAvatar(workspaceId: string): Promise<void>;
|
|
257
304
|
deleteWorkspaceNPMRegistrySettings(workspaceId: string): Promise<void>;
|
|
305
|
+
deleteWorkspaceMember(workspaceId: string, userId: string): Promise<void>;
|
|
306
|
+
deleteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
258
307
|
/** Download information about a single design system and retrieve it resolved */
|
|
259
308
|
designSystem(designSystemId: string): Promise<DesignSystem>;
|
|
260
309
|
/** Download information about design systems that user has access to under a single workspace and retrieve it resolved */
|
|
@@ -265,8 +314,16 @@ export declare class DataCore {
|
|
|
265
314
|
updateDesignSystemMetadata(designSystemId: string, name: string, description?: string): Promise<void>;
|
|
266
315
|
/** Updates a design system multibrand option */
|
|
267
316
|
updateDesignSystemIsMultibrand(designSystem: DesignSystem, isMultibrand: boolean): Promise<void>;
|
|
317
|
+
/** Updates a design system switcher */
|
|
318
|
+
updateDesignSystemSwitcher(designSystem: DesignSystem, designSystemSwitcher: DesignSystemSwitcher): Promise<void>;
|
|
319
|
+
/** Updates design system doc exporter id */
|
|
320
|
+
updateDesignSystemDocExporterId(designSystem: DesignSystem, docExporterId: string): Promise<void>;
|
|
321
|
+
/** Updates a design system multibrand option */
|
|
322
|
+
updateDesignSystemDocumentationSlug(designSystem: DesignSystem, docUserSlug: string): Promise<void>;
|
|
268
323
|
/** Delete a design system */
|
|
269
324
|
deleteDesignSystem(designSystemId: string): Promise<void>;
|
|
325
|
+
/** Download information about a custom domain */
|
|
326
|
+
designSystemCustomDomain(designSystemId: string): Promise<CustomDomain>;
|
|
270
327
|
/** Download information about a desing system source within a design system design and retrieve it resolved */
|
|
271
328
|
designSystemSource(designSystemId: string, sourceId: string): Promise<Source>;
|
|
272
329
|
/** Download information about all desing system sources within a design system design and retrieve it resolved */
|
|
@@ -301,6 +358,7 @@ export declare class DataCore {
|
|
|
301
358
|
deleteOAuthIntegration(userId: string, service: "figma" | "bitbucket" | "github" | "gitlab" | "azure"): Promise<void>;
|
|
302
359
|
bulkUpdateTokenData(designSystemId: string, versionId: string, data: TokenUpdateTransactionData): Promise<any>;
|
|
303
360
|
bulkUpdateComponentData(designSystemId: string, versionId: string, data: ComponentUpdateTransactionData): Promise<any>;
|
|
361
|
+
importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", payload: any): Promise<ImportJob>;
|
|
304
362
|
getImportJob(designSystemId: string, versionId: string, jobId: string): Promise<ImportJob>;
|
|
305
363
|
getImportJobs(designSystemId: string, versionId: string): Promise<Array<ImportJob>>;
|
|
306
364
|
scheduleImportJobForFigmaSources(designSystemId: string, versionId: string, sourceIds: Array<string>, dryRun: boolean): Promise<ImportJob>;
|
|
@@ -13,24 +13,30 @@ 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 { ExporterCustomBlockModel } from "../../../model/exporters/custom_blocks/SDKExporterCustomBlock";
|
|
16
|
+
import { ExportBuildModel } from "../../../model/exporters/exporter_builds/SDKExportBuild";
|
|
16
17
|
import { ExporterModel } from "../../../model/exporters/SDKExporter";
|
|
18
|
+
import { PipelineModel } from "../../../model/exporters/SDKPipeline";
|
|
17
19
|
import { ComponentGroupRemoteModel } from "../../../model/groups/SDKComponentGroup";
|
|
18
20
|
import { DesignComponentGroupRemoteModel } from "../../../model/groups/SDKDesignComponentGroup";
|
|
19
21
|
import { TokenGroupRemoteModel } from "../../../model/groups/SDKTokenGroup";
|
|
20
22
|
import { ImportJobRemoteModel } from "../../../model/jobs/SDKImportJob";
|
|
21
23
|
import { MembershipRemoteModel } from "../../../model/membership/SDKMembership";
|
|
24
|
+
import { CustomDomainRemoteModel } from "../../../model/support/SDKCustomDomain";
|
|
22
25
|
import { SourceRemoteModel } from "../../../model/support/SDKSource";
|
|
23
26
|
import { TokenThemeRemoteModel } from "../../../model/themes/SDKTokenTheme";
|
|
24
27
|
import { TokenRemoteModel } from "../../../model/tokens/remote/SDKRemoteTokenModel";
|
|
25
28
|
import { UserRemoteModel } from "../../../model/users/SDKUser";
|
|
26
29
|
import { UserMembershipRemoteModel } from "../../../model/users/SDKUserMembership";
|
|
27
30
|
import { WorkspaceRemoteModel } from "../../../model/workspaces/SDKWorkspace";
|
|
31
|
+
import { WorkspaceInvitationRemoteModel } from "../../../model/workspaces/SDKWorkspaceInvitation";
|
|
32
|
+
import { WorkspaceInvoiceRemoteModel } from "../../../model/workspaces/SDKWorkspaceInvoice";
|
|
28
33
|
import { WorkspaceIPWhitelistSettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
29
34
|
import { WorkspaceNPMRegistrySettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
|
|
30
35
|
import { WorkspaceOnboardingRemoteModel } from "../../../model/workspaces/SDKWorkspaceOnboarding";
|
|
31
36
|
import { SubscriptionProductFeaturesRemoteModel } from "../../../model/workspaces/SDKWorkspaceProductFeatures";
|
|
32
37
|
import { WorkspaceSSOSettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
33
38
|
import { DataBridge } from "../SDKDataBridge";
|
|
39
|
+
import { WorkspaceSubscriptionRemoteModel } from "../../../model/workspaces/SDKWorkspaceSubscription";
|
|
34
40
|
export declare class DataCoreReadRequests {
|
|
35
41
|
private bridge;
|
|
36
42
|
constructor(bridge: DataBridge);
|
|
@@ -54,10 +60,15 @@ export declare class DataCoreReadRequests {
|
|
|
54
60
|
getRemoteWorkspaceIPWhitelistSettings(workspaceId: string): Promise<WorkspaceIPWhitelistSettingsRemoteModel | null>;
|
|
55
61
|
getRemoteWorkspaceNPMRegistrySettings(workspaceId: string): Promise<WorkspaceNPMRegistrySettingsRemoteModel | null>;
|
|
56
62
|
getRemoteWorkspaceSSOSettings(workspaceId: string): Promise<WorkspaceSSOSettingsRemoteModel | null>;
|
|
63
|
+
getRemoteWorkspaceInvitations(workspaceId: string): Promise<Array<WorkspaceInvitationRemoteModel>>;
|
|
64
|
+
getRemoteWorkspaceInvoices(workspaceId: string): Promise<Array<WorkspaceInvoiceRemoteModel>>;
|
|
65
|
+
getRemoteWorkspaceSubscription(workspaceId: string): Promise<WorkspaceSubscriptionRemoteModel>;
|
|
57
66
|
/** Remote: Get information about one specific design system */
|
|
58
67
|
getRemoteDesignSystem(designSystemId: string): Promise<DesignSystemRemoteModel>;
|
|
59
68
|
/** Remote: Get information about all design systems under specific workspace */
|
|
60
69
|
getRemoteDesignSystems(workspaceId: string): Promise<Array<DesignSystemRemoteModel>>;
|
|
70
|
+
/** Remote: Get custom domain */
|
|
71
|
+
getRemoteCustomDomain(designSystemId: string): Promise<CustomDomainRemoteModel>;
|
|
61
72
|
/** Remote: Get a single design source */
|
|
62
73
|
getRemoteSource(designSystemId: string, sourceId: string): Promise<SourceRemoteModel>;
|
|
63
74
|
/** Remote: Get all design sources of a single design system */
|
|
@@ -81,7 +92,9 @@ export declare class DataCoreReadRequests {
|
|
|
81
92
|
/** Remote: Get structural details and metadata about specific installed exporter */
|
|
82
93
|
getRemoteExporter(workspaceId: string, exporterId: string): Promise<ExporterModel>;
|
|
83
94
|
/** Remote: Get structural details and metadata about all exporters */
|
|
84
|
-
getRemoteExporters(workspaceId: string
|
|
95
|
+
getRemoteExporters(workspaceId: string, filter?: {
|
|
96
|
+
installedOnly?: boolean;
|
|
97
|
+
}): Promise<Array<ExporterModel>>;
|
|
85
98
|
/** Remote: Get all tokens from all categories */
|
|
86
99
|
getRemoteTokens(designSystemId: string, versionId: string, filter?: {
|
|
87
100
|
type?: TokenType;
|
|
@@ -116,6 +129,8 @@ export declare class DataCoreReadRequests {
|
|
|
116
129
|
getRemoteElementDataViewDefinitions(designSystemId: string, versionId: string): Promise<Array<ElementDataViewRemoteModel>>;
|
|
117
130
|
/** Remote: Get all property values that were set by the user for each elemen */
|
|
118
131
|
getRemoteElementPropertyValues(designSystemId: string, versionId: string): Promise<ElementPropertyValueRemoteModel[]>;
|
|
132
|
+
getRemotePipelines(workspaceId: string): Promise<PipelineModel[]>;
|
|
133
|
+
getRemoteBuilds(workspaceId: string, versionId: string): Promise<Array<ExportBuildModel>>;
|
|
119
134
|
getRemoteDocumentationBuilds(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment, limit?: number): Promise<Array<{
|
|
120
135
|
status: "InProgress" | "Success" | "Failed";
|
|
121
136
|
id: string | null;
|