@supernova-studio/supernova-sdk-beta 1.6.25 → 1.6.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (135) hide show
  1. package/README.md +3 -3
  2. package/build/sdk-typescript/src/core/SDKSupernova.d.ts +19 -1
  3. package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +167 -1
  4. package/build/sdk-typescript/src/core/areas/SDKAreaBulkOperations.d.ts +12 -0
  5. package/build/sdk-typescript/src/core/areas/SDKAreaDataSources.d.ts +14 -0
  6. package/build/sdk-typescript/src/core/areas/SDKAreaDesignSystems.d.ts +37 -2
  7. package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +94 -4
  8. package/build/sdk-typescript/src/core/areas/SDKAreaIntegrations.d.ts +27 -0
  9. package/build/sdk-typescript/src/core/areas/SDKAreaNetwork.d.ts +9 -0
  10. package/build/sdk-typescript/src/core/areas/SDKAreaStorage.d.ts +23 -0
  11. package/build/sdk-typescript/src/core/areas/SDKAreaVersions.d.ts +1 -1
  12. package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +69 -1
  13. package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +3 -1
  14. package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +120 -5
  15. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +61 -2
  16. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +99 -5
  17. package/build/sdk-typescript/src/core/resolvers/SDKTokenResolver.d.ts +2 -1
  18. package/build/sdk-typescript/src/exports-pulsar.d.ts +228 -0
  19. package/build/sdk-typescript/src/exports.d.ts +63 -25
  20. package/build/sdk-typescript/src/index.d.ts +4 -0
  21. package/build/sdk-typescript/src/model/assets/SDKAsset.d.ts +1 -0
  22. package/build/sdk-typescript/src/model/base/SDKDesignSystem.d.ts +6 -8
  23. package/build/sdk-typescript/src/model/components/SDKDesignComponent.d.ts +2 -0
  24. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockLayout.d.ts +13 -5
  25. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockVariant.d.ts +1 -1
  26. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{h1/SDKDocsBlockActualH1.d.ts → embed/SDKDocsBlockActualEmbed.d.ts} +1 -1
  27. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed-figma/SDKDocsBlockActualEmbedFigma.d.ts +6 -0
  28. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed-lottie/SDKDocsBlockActualEmbedLottie.d.ts +6 -0
  29. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed-youtube/SDKDocsBlockActualEmbedYoutube.d.ts +6 -0
  30. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/markdown/SDKDocsBlockActualMarkdown.d.ts +6 -0
  31. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{links/SDKDocsBlockActualLinks.d.ts → shortcut-links/SDKDocsBlockActualShortcutLinks.d.ts} +1 -1
  32. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/storybook/SDKDocsBlockActualStorybook.d.ts +6 -0
  33. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{h2/SDKDocsBlockActualH2.d.ts → table/SDKDocsBlockActualTable.d.ts} +1 -1
  34. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{h3/SDKDocsBlockActualH3.d.ts → title1/SDKDocsBlockActualTitle1.d.ts} +1 -1
  35. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{h4/SDKDocsBlockActualH4.d.ts → title2/SDKDocsBlockActualTitle2.d.ts} +1 -1
  36. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/title3/SDKDocsBlockActualTitle3.d.ts +6 -0
  37. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/title4/SDKDocsBlockActualTitle4.d.ts +6 -0
  38. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/title5/SDKDocsBlockActualTitle5.d.ts +6 -0
  39. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts +6 -0
  40. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockImageProperty.d.ts +2 -0
  41. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +6 -0
  42. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +3 -0
  43. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityGroup.d.ts +2 -2
  44. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityHeader.d.ts +2 -2
  45. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyConfiguration.d.ts +9 -0
  46. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyGroup.d.ts +2 -0
  47. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPage.d.ts +3 -1
  48. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageAsset.d.ts +6 -0
  49. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockFrame.d.ts +4 -1
  50. package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationLegacyItemConfiguration.d.ts +1 -0
  51. package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationLegacyItemHeader.d.ts +8 -2
  52. package/build/sdk-typescript/src/model/enums/SDKBorderPosition.d.ts +1 -0
  53. package/build/sdk-typescript/src/model/enums/SDKBorderStyle.d.ts +1 -0
  54. package/build/sdk-typescript/src/model/enums/SDKCloudWarningType.d.ts +14 -0
  55. package/build/sdk-typescript/src/model/enums/SDKConnectionProviders.d.ts +6 -0
  56. package/build/sdk-typescript/src/model/enums/SDKCustomDomainErrorCode.d.ts +5 -0
  57. package/build/sdk-typescript/src/model/enums/SDKCustomDomainState.d.ts +9 -0
  58. package/build/sdk-typescript/src/model/enums/SDKDocsBlockCategory.d.ts +15 -9
  59. package/build/sdk-typescript/src/model/enums/SDKDocsBlockImagePropertyWidth.d.ts +12 -0
  60. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +4 -2
  61. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutAlign.d.ts +8 -0
  62. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutColumnResizing.d.ts +6 -0
  63. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutGap.d.ts +10 -0
  64. package/build/sdk-typescript/src/model/enums/SDKDocsBlockTextPropertyColor.d.ts +6 -0
  65. package/build/sdk-typescript/src/model/enums/SDKDocsBlockTextPropertyStyle.d.ts +20 -4
  66. package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts +3 -3
  67. package/build/sdk-typescript/src/model/enums/SDKUserRole.d.ts +1 -0
  68. package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionProduct.d.ts +1 -1
  69. package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionStatus.d.ts +6 -14
  70. package/build/sdk-typescript/src/model/exporters/CodegenAccount.d.ts +9 -0
  71. package/build/sdk-typescript/src/model/exporters/CodegenAzureBranch.d.ts +7 -0
  72. package/build/sdk-typescript/src/model/exporters/CodegenAzureOrganization.d.ts +7 -0
  73. package/build/sdk-typescript/src/model/exporters/CodegenAzureProject.d.ts +7 -0
  74. package/build/sdk-typescript/src/model/exporters/CodegenAzureRepository.d.ts +11 -0
  75. package/build/sdk-typescript/src/model/exporters/CodegenBitbucketBranch.d.ts +7 -0
  76. package/build/sdk-typescript/src/model/exporters/CodegenBitbucketProject.d.ts +6 -0
  77. package/build/sdk-typescript/src/model/exporters/CodegenBitbucketRepository.d.ts +8 -0
  78. package/build/sdk-typescript/src/model/exporters/CodegenBitbucketWorkspace.d.ts +6 -0
  79. package/build/sdk-typescript/src/model/exporters/CodegenBranch.d.ts +8 -0
  80. package/build/sdk-typescript/src/model/exporters/CodegenConnection.d.ts +10 -0
  81. package/build/sdk-typescript/src/model/exporters/CodegenGitlabBranch.d.ts +7 -0
  82. package/build/sdk-typescript/src/model/exporters/CodegenGitlabGroup.d.ts +6 -0
  83. package/build/sdk-typescript/src/model/exporters/CodegenGitlabRepository.d.ts +9 -0
  84. package/build/sdk-typescript/src/model/exporters/CodegenRepository.d.ts +15 -0
  85. package/build/sdk-typescript/src/model/exporters/SDKConnections.d.ts +8 -0
  86. package/build/sdk-typescript/src/model/exporters/SDKExporter.d.ts +16 -12
  87. package/build/sdk-typescript/src/model/exporters/SDKPipeline.d.ts +113 -0
  88. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuild.d.ts +104 -0
  89. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuildResults.d.ts +72 -0
  90. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportDestinations.d.ts +111 -0
  91. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenBranchModel.d.ts +5 -0
  92. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenOrganizationModel.d.ts +5 -0
  93. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenProjectModel.d.ts +5 -0
  94. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenRepositoryModel.d.ts +9 -0
  95. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenBranchModel.d.ts +5 -0
  96. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenProjectModel.d.ts +4 -0
  97. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenRepositoryModel.d.ts +6 -0
  98. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenWorkspaceModel.d.ts +4 -0
  99. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenAccountModel.d.ts +7 -0
  100. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenBranchModel.d.ts +6 -0
  101. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenConnectionModel.d.ts +8 -0
  102. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenRepositoryModel.d.ts +17 -0
  103. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteConnectionsModel.d.ts +9 -0
  104. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenBranchModel.d.ts +5 -0
  105. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenGroupModel.d.ts +4 -0
  106. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenRepositoryModel.d.ts +7 -0
  107. package/build/sdk-typescript/src/model/exporters/remote/SDKRemotePipelineModel.d.ts +57 -0
  108. package/build/sdk-typescript/src/model/jobs/SDKImportJob.d.ts +2 -7
  109. package/build/sdk-typescript/src/model/support/SDKCustomDomain.d.ts +21 -0
  110. package/build/sdk-typescript/src/model/support/SDKFigmaFrame.d.ts +20 -0
  111. package/build/sdk-typescript/src/model/support/SDKFigmaStructure.d.ts +27 -0
  112. package/build/sdk-typescript/src/model/support/SDKFigmaStructureDetail.d.ts +30 -0
  113. package/build/sdk-typescript/src/model/support/SDKLogger.d.ts +4 -0
  114. package/build/sdk-typescript/src/model/support/SDKSource.d.ts +20 -8
  115. package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +3 -0
  116. package/build/sdk-typescript/src/model/tokens/SDKDimensionToken.d.ts +1 -1
  117. package/build/sdk-typescript/src/model/users/SDKUser.d.ts +6 -0
  118. package/build/sdk-typescript/src/model/workspaces/SDKWorkspace.d.ts +0 -5
  119. package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceInvitation.d.ts +35 -0
  120. package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceInvoice.d.ts +38 -0
  121. package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProduct.d.ts +21 -0
  122. package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProductFeatures.d.ts +3 -1
  123. package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProductPrice.d.ts +40 -0
  124. package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceSubscription.d.ts +34 -35
  125. package/build/sdk-typescript/src/pulsar-interfaces.d.ts +40 -0
  126. package/build/sdk-typescript/src/tests/Areas/AreaStorage.spec.d.ts +1 -0
  127. package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +7 -3
  128. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONParser.d.ts +3 -1
  129. package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +25 -4
  130. package/build/supernova-sdk-typescript.js +2 -70428
  131. package/build/supernova-sdk-typescript.js.map +1 -1
  132. package/package.json +17 -15
  133. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/h5/SDKDocsBlockActualH5.d.ts +0 -6
  134. package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionStatusInternal.d.ts +0 -8
  135. package/build/sdk-typescript/src/tests/Areas/AreaTokenValues.d.ts +0 -0
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/supernova-sdk
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/supernova-sdk"
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, null, null) // Ignore 2 additional attributes for now
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,8 @@ 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";
12
+ import { AreaStorage } from "./areas/SDKAreaStorage";
11
13
  import { AreaTokens } from "./areas/SDKAreaTokens";
12
14
  import { AreaUsers } from "./areas/SDKAreaUsers";
13
15
  import { AreaVersions } from "./areas/SDKAreaVersions";
@@ -48,5 +50,21 @@ export declare class Supernova {
48
50
  dataSources: AreaDataSources;
49
51
  /** Get, create, update, manipulate or delete data from Supernova en masse */
50
52
  bulkOperations: AreaBulkOperations;
51
- constructor(apiKey: string, url?: string | null, requestHook?: DataBridgeRequestHook | null);
53
+ /** Read and write data using Supernova key-value storage */
54
+ storage: AreaStorage;
55
+ /** Get access to network in exporter packages */
56
+ network: AreaNetwork;
57
+ /**
58
+ * Create new Supernova.io SDK object.
59
+ * @param apiKey API key to use for authentication
60
+ * @param options Options for SDK
61
+ * @param options.url URL of the Supernova.io instance to connect to. Defaults to production environment
62
+ * @param options.requestHook Hook for observing requests
63
+ * @param options.bypassEnvFetch When enabled, internal node-fetch lib will be used in environments when fetch is not available. Defaults to false
64
+ */
65
+ constructor(apiKey: string, options?: {
66
+ apiUrl?: string;
67
+ requestHook?: DataBridgeRequestHook;
68
+ bypassEnvFetch?: boolean;
69
+ });
52
70
  }
@@ -1,7 +1,24 @@
1
1
  import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
2
+ import { CodegenAccount } from "../../model/exporters/CodegenAccount";
3
+ import { CodegenAzureOrganization } from "../../model/exporters/CodegenAzureOrganization";
4
+ import { CodegenAzureProject } from "../../model/exporters/CodegenAzureProject";
5
+ import { CodegenAzureRepository } from "../../model/exporters/CodegenAzureRepository";
6
+ import { CodegenBitbucketBranch } from "../../model/exporters/CodegenBitbucketBranch";
7
+ import { CodegenBitbucketProject } from "../../model/exporters/CodegenBitbucketProject";
8
+ import { CodegenBitbucketRepository } from "../../model/exporters/CodegenBitbucketRepository";
9
+ import { CodegenBitbucketWorkspace } from "../../model/exporters/CodegenBitbucketWorkspace";
10
+ import { CodegenBranch } from "../../model/exporters/CodegenBranch";
11
+ import { CodegenConnection } from "../../model/exporters/CodegenConnection";
12
+ import { CodegenGitlabBranch } from "../../model/exporters/CodegenGitlabBranch";
13
+ import { CodegenGitlabGroup } from "../../model/exporters/CodegenGitlabGroup";
14
+ import { CodegenGitlabRepository } from "../../model/exporters/CodegenGitlabRepository";
15
+ import { CodegenRepository } from "../../model/exporters/CodegenRepository";
2
16
  import { ExporterCustomBlockVariant } from "../../model/exporters/custom_blocks/SDKExporterCustomBlockVariant";
3
17
  import { ExporterConfigurationProperty } from "../../model/exporters/custom_properties/SDKExporterConfigurationProperty";
18
+ import { ExportBuild } from "../../model/exporters/exporter_builds/SDKExportBuild";
19
+ import { ExportBuildResultLog } from "../../model/exporters/exporter_builds/SDKExportBuildResults";
4
20
  import { Exporter } from "../../model/exporters/SDKExporter";
21
+ import { NewPipelinePayload, Pipeline, PipelineUpdateModel } from "../../model/exporters/SDKPipeline";
5
22
  import { ImportJob } from "../../model/jobs/SDKImportJob";
6
23
  import { DataCore } from "../data/SDKDataCore";
7
24
  import { RemoteVersionIdentifier, RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
@@ -9,8 +26,137 @@ export declare class AreaAutomation {
9
26
  /** Internal: Engine */
10
27
  private dataCore;
11
28
  constructor(dataCore: DataCore);
29
+ /** Fetches all pipelines that are available by workspace id and design system id */
30
+ getPipelines(workspaceId: string, designSystemId: string): Promise<Array<Pipeline>>;
31
+ /**
32
+ * Fetches all github connections for user
33
+ * @returns Github Connections
34
+ */
35
+ getGithubConnections(): Promise<CodegenConnection[]>;
36
+ /**
37
+ * Fetches github accounts
38
+ * @returns Github accounts
39
+ */
40
+ getGithubAccounts(githubConnectionId: string): Promise<CodegenAccount[]>;
41
+ /**
42
+ * Fetches github repositories
43
+ * @returns Github repositories
44
+ */
45
+ getGithubRepositories(githubConnectionId: string, handle: string): Promise<CodegenRepository[]>;
46
+ /**
47
+ * Fetches github
48
+ * @returns Github branches
49
+ */
50
+ getGithubBranches(githubConnectionId: string, handle: string, repoName: string): Promise<CodegenBranch[]>;
51
+ /**
52
+ * Fetches all Gitlab connections for user
53
+ * @returns Gitlab Connections
54
+ */
55
+ getGitlabConnections(): Promise<CodegenConnection[]>;
56
+ /**
57
+ * Fetches Gitlab groups
58
+ * @param connectionId
59
+ * @returns Gitlab groups
60
+ */
61
+ getGitlabGroups(connectionId: string): Promise<CodegenGitlabGroup[]>;
62
+ /**
63
+ * Fetches Gitlab repositories
64
+ * @param connectionId
65
+ * @param groupId
66
+ * @returns Gitlab repositories
67
+ */
68
+ getGitlabRepositories(connectionId: string, groupId: string): Promise<CodegenGitlabRepository[]>;
69
+ /**
70
+ * Fetches Gitlab
71
+ * @param connectionId
72
+ * @param repoId
73
+ * @returns Gitlab branches
74
+ */
75
+ getGitlabBranches(connectionId: string, repoId: string): Promise<CodegenGitlabBranch[]>;
76
+ /**
77
+ * Fetches all Azure connections for user
78
+ * @returns Azure Connections
79
+ */
80
+ getAzureConnections(): Promise<CodegenConnection[]>;
81
+ /**
82
+ * Fetches Azure organizations
83
+ * @param connectionId
84
+ * @returns Azure organizations
85
+ */
86
+ getAzureOrganizations(connectionId: string): Promise<CodegenAzureOrganization[]>;
87
+ /**
88
+ * Fetches Azure projects
89
+ * @param connectionId
90
+ * @param organizationId
91
+ * @returns Azure projects
92
+ */
93
+ getAzureProjects(connectionId: string, organizationId: string): Promise<CodegenAzureProject[]>;
94
+ /**
95
+ * Fetches Azure repositories
96
+ * @param connectionId
97
+ * @param organizationId
98
+ * @param projectId
99
+ * @returns Azure repositories
100
+ */
101
+ getAzureRepositories(connectionId: string, organizationId: string, projectId: string): Promise<CodegenAzureRepository[]>;
102
+ /**
103
+ * Fetches Azure branches
104
+ * @param connectionId
105
+ * @param organizationId
106
+ * @param projectId
107
+ * @param repositoryId
108
+ * @returns Azure branches
109
+ */
110
+ getAzureBranches(connectionId: string, organizationId: string, projectId: string, repositoryId: string): Promise<CodegenGitlabBranch[]>;
111
+ /**
112
+ * Fetches all Bitbucket connections for user
113
+ * @returns Bitbucket Connections
114
+ */
115
+ getBitbucketConnections(): Promise<CodegenConnection[]>;
116
+ /**
117
+ * Fetches Bitbucket workspaces
118
+ * @param connectionId
119
+ * @returns Bitbucket workspaces
120
+ */
121
+ getBitbucketWorkspaces(connectionId: string): Promise<CodegenBitbucketWorkspace[]>;
122
+ /**
123
+ * Fetches Bitbucket projects
124
+ * @param connectionId
125
+ * @param workspaceId
126
+ * @returns Bitbucket projects
127
+ */
128
+ getBitbucketProjects(connectionId: string, workspaceId: string): Promise<CodegenBitbucketProject[]>;
129
+ /**
130
+ * Fetches Bitbucket repositories
131
+ * @param connectionId
132
+ * @param workspaceId
133
+ * @param projectId
134
+ * @returns Bitbucket repositories
135
+ */
136
+ getBitbucketRepositories(connectionId: string, workspaceId: string, projectId?: string): Promise<CodegenBitbucketRepository[]>;
137
+ /**
138
+ * Fetches Bitbucket branches
139
+ * @param connectionId
140
+ * @param workspaceId
141
+ * @param projectId
142
+ * @param repositoryId
143
+ * @returns Bitbucket branches
144
+ */
145
+ getBitbucketBranches(connectionId: string, workspaceId: string, projectId: string, repositoryId: string): Promise<CodegenBitbucketBranch[]>;
146
+ /** Fetches all builds of pipelines
147
+ * @param workspaceId - Identifier of the workspace where the pipeline is installed
148
+ * @param versionId - Identifier of the version where the pipeline is installed
149
+ */
150
+ getExportBuilds(workspaceId: string, versionId: string): Promise<Array<ExportBuild>>;
151
+ /** Fetches build logs of a specific build
152
+ * @param workspaceId - Identifier of the workspace where the pipeline is installed
153
+ * @param buildId - Identifier of the build to fetch logs for
154
+ */
155
+ getExportBuildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLog>>;
12
156
  /** Fetches exporters belonging to workspace by id */
13
- getExporters(workspaceId: string): Promise<Array<Exporter>>;
157
+ getExporters(workspaceId: string, filter?: {
158
+ installedOnly?: boolean;
159
+ }): Promise<Array<Exporter>>;
14
160
  /** Fetches all custom configuration properties that specific exporter provides
15
161
  * @param exporterId - Identifier of the exporter to fetch configuration for
16
162
  * @param from - Remote version to fetch from
@@ -42,4 +188,24 @@ export declare class AreaAutomation {
42
188
  getImportJobs(from: RemoteVersionIdentifier): Promise<Array<ImportJob>>;
43
189
  getImportJob(from: RemoteVersionIdentifier, jobId: string): Promise<ImportJob>;
44
190
  scheduleImportJobForFigmaSources(from: RemoteVersionIdentifier, sourceIds: Array<string>, dryRun?: boolean): Promise<ImportJob>;
191
+ /** Create pipeline
192
+ * @param workspaceId string
193
+ * @param pipeline Pipeline
194
+ * @returns Pipeline
195
+ */
196
+ createPipeline(workspaceId: string, pipeline: NewPipelinePayload): Promise<Pipeline>;
197
+ /** Update pipeline
198
+ * @param workspaceId string
199
+ * @param pipeline Pipeline
200
+ * @returns Pipeline
201
+ */
202
+ updatePipeline(workspaceId: string, pipelineUpdateModel: PipelineUpdateModel): Promise<Pipeline>;
203
+ /**
204
+ * Run pipeline
205
+ * @param workspaceId string
206
+ * @param designSystemVersionId string
207
+ * @param pipelineId string
208
+ */
209
+ runPipeline(workspaceId: string, designSystemVersionId: string, pipelineId: string): Promise<Pipeline>;
210
+ deletePipeline(workspaceId: string, pipelineId: string): Promise<void>;
45
211
  }
@@ -1,6 +1,7 @@
1
1
  import { Component } from "../../model/components/SDKComponent";
2
2
  import { ElementProperty } from "../../model/elements/SDKElementProperty";
3
3
  import { TokenGroup } from "../../model/groups/SDKTokenGroup";
4
+ import { ImportJob } from "../../model/jobs/SDKImportJob";
4
5
  import { TokenTheme } from "../../model/themes/SDKTokenTheme";
5
6
  import { AnyToken } from "../../model/tokens/SDKTokenValue";
6
7
  import { DataCore } from "../data/SDKDataCore";
@@ -29,6 +30,17 @@ export declare class AreaBulkOperations {
29
30
  /** Internal: Engine */
30
31
  private dataCore;
31
32
  constructor(dataCore: DataCore);
33
+ /** Import tokens in bulk using new import routine
34
+ *
35
+ * @param designSystemId - Remote design system to write to
36
+ * @param brandId - Remote brand to write to
37
+ * @param sourceName - Name of the source, such as Figma file name
38
+ * @param sourceId - Unique ID of the source, such as Figma file id
39
+ * @param sourceType - Source from which import originates. Currently only "FigmaVariablesPlugin" is supported
40
+ * @param payload - Payload to import. Types to come
41
+ * @returns Nothing
42
+ */
43
+ importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", payload: any): Promise<ImportJob>;
32
44
  /** Batch updates, creates or deletes token data from Supernova at once. Use this method to perform multiple operations at once instead of chaining single update operations. Batch routine runs everything in a single transaction, so either all operations succeed or all fail.
33
45
  *
34
46
  * WARNING: This method is not yet complete and only supports limited set of operations. Also, doesn't work as transation just yet.
@@ -1,3 +1,5 @@
1
+ import { FigmaStructure } from "../../model/support/SDKFigmaStructure";
2
+ import { FigmaStructureDetail } from "../../model/support/SDKFigmaStructureDetail";
1
3
  import { Source, SourceRemoteModelCloud } from "../../model/support/SDKSource";
2
4
  import { DataCore } from "../data/SDKDataCore";
3
5
  import { RemoteBrandIdentifier, RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
@@ -15,6 +17,18 @@ export declare class AreaDataSources {
15
17
  * @returns All data sources in the specified version
16
18
  */
17
19
  getDataSources(from: RemoteVersionIdentifier): Promise<Array<Source>>;
20
+ /** Retrieves all figma frames structures
21
+ * @param from - Remote version to fetch from
22
+ * @returns All data sources in the specified version
23
+ */
24
+ getFigmaNodeStructures(from: RemoteVersionIdentifier): Promise<Array<FigmaStructure>>;
25
+ /** Retrieves figma frame structure detail
26
+ * @param from - Remote version to fetch from
27
+ * @returns All data sources in the specified version
28
+ */
29
+ getFigmaNodeStructureDetail(from: RemoteVersionIdentifier & {
30
+ figmaStructureId: string;
31
+ }): Promise<FigmaStructureDetail>;
18
32
  linkFigmaSource(from: RemoteBrandIdentifier, url: string, options: {
19
33
  scopes: {
20
34
  tokens: boolean;
@@ -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 designSystemId - ID of the design system
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, DocumentationLegacyPage } from "../../exports";
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";
7
- import { DataCore } from "../data/SDKDataCore";
8
- import { RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
6
+ import { DocumentationLegacyGroup, DocumentationLegacyGroupModel } from "../../model/documentation/SDKDocumentationLegacyGroup";
7
+ import { DocumentationLegacyPage, DocumentationLegacyPageModel } from "../../model/documentation/SDKDocumentationLegacyPage";
8
+ import { DataCore, DeepPartial } from "../data/SDKDataCore";
9
+ import { RemoteVersionIdentifier, RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
9
10
  export declare class AreaDocumentation {
10
11
  /** Internal: Engine */
11
12
  private dataCore;
@@ -15,11 +16,100 @@ 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 page
79
+ */
80
+ updateDocumentationPageOrTab(from: RemoteWorkspaceVersionIdentifier, page: DocumentationLegacyPage, updateModel: DeepPartial<DocumentationLegacyPageModel>): Promise<void>;
81
+ /** Updates a documentation page header image
82
+ * @param from - Remote version to fetch from
83
+ * @param page - page to update
84
+ * @param file - file to update a page header with
85
+ * @returns page
86
+ */
87
+ updateDocumentationHeaderImage(from: RemoteWorkspaceVersionIdentifier, page: DocumentationLegacyPage | DocumentationLegacyGroup, file: File | null): Promise<DocumentationLegacyPage | DocumentationLegacyGroup>;
88
+ /** Duplicates a documentation tab or 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 page or tab
92
+ * @returns Promise<DocumentationLegacyPage>
93
+ */
94
+ duplicateDocumentationPageOrTab(from: RemoteWorkspaceVersionIdentifier, idInVersion: string, newPersistentId?: string): Promise<DocumentationLegacyPage>;
95
+ /** Duplicates a documentation group or tabbed page
96
+ * @param from - Remote version to fetch from
97
+ * @param idInVersion - id of page or tab to be duplicated
98
+ * @param newPersistentId - suggested persistent id of a new group or tabbed page
99
+ * @returns nothing
100
+ */
101
+ duplicateDocumentationGroupOrTabbedPage(from: RemoteWorkspaceVersionIdentifier, idInVersion: string, newPersistentId?: string): Promise<void>;
102
+ /** Ungroups a documentation group
103
+ * @param from - Remote version to fetch from
104
+ * @param idInVersion - id of a group
105
+ * @returns nothing
106
+ */
107
+ ungroupDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, idInVersion: string): Promise<void>;
108
+ /** Fetches all documentation items
109
+ * @param from - Remote version to fetch from
110
+ * @returns All documentation pages
111
+ */
112
+ getDocumentationItems(from: RemoteWorkspaceVersionIdentifier): Promise<import("../..").DocumentationLegacyItem[]>;
23
113
  /** Fetches all documentation pages
24
114
  * @param from - Remote version to fetch from
25
115
  * @returns All documentation pages
@@ -1,3 +1,5 @@
1
+ import { ConnectionRemoteModel } from "../../model/exporters/remote/SDKRemoteConnectionsModel";
2
+ import { AzurePersonalAccessTokenConnectionPayload, PersonalAccessTokenConnectionPayload } from "../../model/exporters/SDKConnections";
1
3
  import { DataCore } from "../data/SDKDataCore";
2
4
  export declare class AreaIntegrations {
3
5
  /** Internal: Engine */
@@ -23,6 +25,31 @@ export declare class AreaIntegrations {
23
25
  * @returns Azure OAuth URL
24
26
  */
25
27
  getAzureOAuthURL(): Promise<string>;
28
+ /** Creates user GitHub personal access token integration.
29
+ * @param customUrl - Custom GitHub URL. If not provided, default GitHub URL will be used.
30
+ * @param token - GitHub access token.
31
+ * @param name - Name of the integration.
32
+ */
33
+ createGitHubPersonalAccessTokenConnection(connection: PersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
34
+ /** Creates user GitLab personal access token integration.
35
+ * @param customUrl - Custom GitLab URL. If not provided, default GitLab URL will be used.
36
+ * @param token - GitLab access token.
37
+ * @param name - Name of the integration.
38
+ */
39
+ createGitLabPersonalAccessTokenConnection(connection: PersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
40
+ /** Creates user Bitbucket personal access token integration.
41
+ * @param customUrl - Custom Bitbucket URL. If not provided, default Bitbucket URL will be used.
42
+ * @param token - Bitbucket access token.
43
+ * @param name - Name of the integration.
44
+ * @param organization - Organization name.
45
+ */
46
+ createBitbucketPersonalAccessTokenConnection(connection: PersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
47
+ /** Creates user Azure personal access token integration.
48
+ * @param customUrl - Custom Azure URL. If not provided, default Azure URL will be used.
49
+ * @param token - Azure access token.
50
+ * @param name - Name of the integration.
51
+ */
52
+ createAzurePersonalAccessTokenConnection(connection: AzurePersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
26
53
  /** Deletes user Figma OAuth integration.
27
54
  * @param userId - User id to delete integration for. Can only be invoked on user id that is currently authenticated.
28
55
  * @returns Nothing
@@ -0,0 +1,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
+ }
@@ -0,0 +1,23 @@
1
+ import { DataCore } from "../data/SDKDataCore";
2
+ export declare class AreaStorage {
3
+ /** Internal: Engine */
4
+ private dataCore;
5
+ constructor(dataCore: DataCore);
6
+ /** Read data from key-value storage
7
+ * @param designSystemId - Design system ID to read the data from
8
+ * @param key - Unique data key to read
9
+ */
10
+ readKeyValueStorageData(designSystemId: string, key: string): Promise<string | object | null>;
11
+ /** Set data to key-value storage. Limit of 20mb per a design system.
12
+ * @param designSystemId - Design system ID to store data for
13
+ * @param key - Unique data key under which the data will be stored
14
+ * @param value - String or object to be stored. Anything else must be converted to JSON string first
15
+ * @returns Nothing
16
+ */
17
+ setKeyValueStorageData(designSystemId: string, key: string, value: string | object): Promise<void>;
18
+ /** Unsets the data from key-value storage based on the key name
19
+ * @param designSystemId - Design system ID to remove the data from
20
+ * @param key - Unique data key to delete
21
+ */
22
+ unsetKeyValueStorageData(designSystemId: string, key: string): Promise<void>;
23
+ }
@@ -31,5 +31,5 @@ export declare class AreaVersions {
31
31
  /** Fetches design system version by id */
32
32
  getVersion(from: RemoteVersionIdentifier): Promise<DesignSystemVersion>;
33
33
  getTokenStudioData(from: RemoteVersionIdentifier): Promise<object>;
34
- writeTokenStudioData(from: RemoteVersionIdentifier, data: object): Promise<boolean>;
34
+ writeTokenStudioData(from: RemoteVersionIdentifier, data: object): Promise<object>;
35
35
  }