@supernova-studio/supernova-sdk-beta 1.6.49 → 2.0.17

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 (81) hide show
  1. package/README.md +19 -0
  2. package/build/sdk-typescript/src/core/SDKSupernova.d.ts +3 -0
  3. package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +2 -131
  4. package/build/sdk-typescript/src/core/areas/SDKAreaDataSources.d.ts +1 -1
  5. package/build/sdk-typescript/src/core/areas/SDKAreaDesignSystems.d.ts +1 -1
  6. package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +15 -1
  7. package/build/sdk-typescript/src/core/areas/SDKAreaIntegrations.d.ts +1 -73
  8. package/build/sdk-typescript/src/core/areas/SDKAreaTokens.d.ts +1 -1
  9. package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaceIntegrations.d.ts +99 -0
  10. package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +13 -44
  11. package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +6 -2
  12. package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +40 -39
  13. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +19 -37
  14. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +5 -2
  15. package/build/sdk-typescript/src/core/resolvers/SDKDocsEntityMultiplayerItemResolver.d.ts +1 -1
  16. package/build/sdk-typescript/src/exports.d.ts +4 -1
  17. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/figma-component/SDKDocsBlockActualFigmaComponent.d.ts +6 -0
  18. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/figma-component-propstable/SDKDocsBlockActualFigmaComponentPropsTable.d.ts +6 -0
  19. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockFigmaComponentProperty.d.ts +40 -0
  20. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +3 -0
  21. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntity.d.ts +4 -1
  22. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityDraftState.d.ts +16 -0
  23. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityGroup.d.ts +3 -1
  24. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityPage.d.ts +3 -1
  25. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyItem.d.ts +2 -0
  26. package/build/sdk-typescript/src/model/enums/SDKCloudWarningType.d.ts +2 -1
  27. package/build/sdk-typescript/src/model/enums/SDKDocsBlockBehaviorDataType.d.ts +3 -1
  28. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +3 -1
  29. package/build/sdk-typescript/src/model/exporters/SDKPipeline.d.ts +38 -43
  30. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuild.d.ts +7 -7
  31. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuildResults.d.ts +21 -18
  32. package/build/sdk-typescript/src/model/exporters/remote/SDKRemotePipelineModel.d.ts +9 -15
  33. package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +4 -0
  34. package/build/sdk-typescript/src/model/themes/SDKTokenTheme.d.ts +2 -2
  35. package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +2 -2
  36. package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenModel.d.ts +2 -0
  37. package/build/sdk-typescript/src/model/users/SDKUser.d.ts +5 -1
  38. package/build/sdk-typescript/src/model/users/SDKUserProfile.d.ts +23 -12
  39. package/build/sdk-typescript/src/model/users/SDKUserWorkspaceNotificationSettings.d.ts +16 -0
  40. package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceIntegration.d.ts +8 -24
  41. package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceIntegrationGetGitProviders.d.ts +15 -0
  42. package/build/sdk-typescript/src/model/workspaces/integrations/GitProvidersBranches.d.ts +13 -0
  43. package/build/sdk-typescript/src/model/workspaces/integrations/GitProvidersOrganizations.d.ts +15 -0
  44. package/build/sdk-typescript/src/model/workspaces/integrations/GitProvidersProjects.d.ts +15 -0
  45. package/build/sdk-typescript/src/model/workspaces/integrations/GitProvidersRepositories.d.ts +16 -0
  46. package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +11 -0
  47. package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewTypes.d.ts +2 -0
  48. package/build/supernova-sdk-typescript.js +1 -1
  49. package/build/supernova-sdk-typescript.js.map +1 -1
  50. package/package.json +3 -3
  51. package/build/sdk-typescript/src/browser-bundle.d.ts +0 -1
  52. package/build/sdk-typescript/src/model/exporters/CodegenAccount.d.ts +0 -9
  53. package/build/sdk-typescript/src/model/exporters/CodegenAzureBranch.d.ts +0 -7
  54. package/build/sdk-typescript/src/model/exporters/CodegenAzureOrganization.d.ts +0 -7
  55. package/build/sdk-typescript/src/model/exporters/CodegenAzureProject.d.ts +0 -7
  56. package/build/sdk-typescript/src/model/exporters/CodegenAzureRepository.d.ts +0 -11
  57. package/build/sdk-typescript/src/model/exporters/CodegenBitbucketBranch.d.ts +0 -7
  58. package/build/sdk-typescript/src/model/exporters/CodegenBitbucketProject.d.ts +0 -6
  59. package/build/sdk-typescript/src/model/exporters/CodegenBitbucketRepository.d.ts +0 -8
  60. package/build/sdk-typescript/src/model/exporters/CodegenBitbucketWorkspace.d.ts +0 -6
  61. package/build/sdk-typescript/src/model/exporters/CodegenBranch.d.ts +0 -8
  62. package/build/sdk-typescript/src/model/exporters/CodegenConnection.d.ts +0 -10
  63. package/build/sdk-typescript/src/model/exporters/CodegenGitlabBranch.d.ts +0 -7
  64. package/build/sdk-typescript/src/model/exporters/CodegenGitlabGroup.d.ts +0 -6
  65. package/build/sdk-typescript/src/model/exporters/CodegenGitlabRepository.d.ts +0 -9
  66. package/build/sdk-typescript/src/model/exporters/CodegenRepository.d.ts +0 -15
  67. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenBranchModel.d.ts +0 -5
  68. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenOrganizationModel.d.ts +0 -5
  69. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenProjectModel.d.ts +0 -5
  70. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenRepositoryModel.d.ts +0 -9
  71. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenBranchModel.d.ts +0 -5
  72. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenProjectModel.d.ts +0 -4
  73. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenRepositoryModel.d.ts +0 -6
  74. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenWorkspaceModel.d.ts +0 -4
  75. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenAccountModel.d.ts +0 -7
  76. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenBranchModel.d.ts +0 -6
  77. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenConnectionModel.d.ts +0 -8
  78. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenRepositoryModel.d.ts +0 -17
  79. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenBranchModel.d.ts +0 -5
  80. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenGroupModel.d.ts +0 -4
  81. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenRepositoryModel.d.ts +0 -7
package/README.md CHANGED
@@ -114,6 +114,25 @@ instance.setResolutionCacheEnabled(false)
114
114
 
115
115
  With cache disabled, every request will download all necessary information for every request. This is not particulary efficient, especially for very-large design systems, but we put this option so you can control this behavior if you want to. Cache is enabled by default.
116
116
 
117
+ ### Release
118
+
119
+ SDK should be released via CI by opening PR `develop -> publish-sdk` branch once we need to release it.
120
+
121
+ Please, in this PR:
122
+
123
+ - bump a version in `sdk-typescript/scripts/packages/**.json` files
124
+ - check that versions of `@supernova-studio/client` and `@supernova-studio/model` are up-to-date with main `package.json` in root folder of whole repository
125
+
126
+ Several packages are released:
127
+
128
+ - `@supernovaio/sdk` - main SDK used by customers, Pulsar etc
129
+ - `@supernovaio/sdk-exporters` - SDK used by exporters helpers
130
+ - `@supernova-studio/supernova-sdk-beta` - SDK used by old BE during Token Studio import only
131
+
132
+ Having separate version for old BE makes it simpler to release BE without necessity to update & release Pulsar, when we only need changes/fixes in SDK for Token Studio (which happens more often than changes we need for Pulsar).
133
+
134
+ Emergency release could be done manually via scripts, like `npm run publish-package-sdk`.
135
+ Please, avoid this and try using CI instead, and it helps you with ensuring tests are passed.
117
136
 
118
137
  ## What's next
119
138
 
@@ -15,6 +15,7 @@ import { AreaStorage } from "./areas/SDKAreaStorage";
15
15
  import { AreaTokens } from "./areas/SDKAreaTokens";
16
16
  import { AreaUsers } from "./areas/SDKAreaUsers";
17
17
  import { AreaVersions } from "./areas/SDKAreaVersions";
18
+ import { AreaWorkspaceIntegrations } from "./areas/SDKAreaWorkspaceIntegrations";
18
19
  import { AreaWorkspaces } from "./areas/SDKAreaWorkspaces";
19
20
  import { DataBridgeRequestHook } from "./data/SDKDataBridge";
20
21
  /** Main Supernova.io SDK object. Use this to connect to your data instance and retrieve workspace / design system / version from which you can access all neccessary data. */
@@ -50,6 +51,8 @@ export declare class Supernova {
50
51
  me: AreaMe;
51
52
  /** Get, create, update, manipulate or delete integrations */
52
53
  integrations: AreaIntegrations;
54
+ /** Get, create, update, manipulate or delete workspace integrations */
55
+ workspaceIntegrations: AreaWorkspaceIntegrations;
53
56
  /** Get, create, update, manipulate or delete data sources */
54
57
  dataSources: AreaDataSources;
55
58
  /** Get, create, update, manipulate or delete data from Supernova en masse */
@@ -1,17 +1,3 @@
1
- import { CodegenAccount } from "../../model/exporters/CodegenAccount";
2
- import { CodegenAzureOrganization } from "../../model/exporters/CodegenAzureOrganization";
3
- import { CodegenAzureProject } from "../../model/exporters/CodegenAzureProject";
4
- import { CodegenAzureRepository } from "../../model/exporters/CodegenAzureRepository";
5
- import { CodegenBitbucketBranch } from "../../model/exporters/CodegenBitbucketBranch";
6
- import { CodegenBitbucketProject } from "../../model/exporters/CodegenBitbucketProject";
7
- import { CodegenBitbucketRepository } from "../../model/exporters/CodegenBitbucketRepository";
8
- import { CodegenBitbucketWorkspace } from "../../model/exporters/CodegenBitbucketWorkspace";
9
- import { CodegenBranch } from "../../model/exporters/CodegenBranch";
10
- import { CodegenConnection } from "../../model/exporters/CodegenConnection";
11
- import { CodegenGitlabBranch } from "../../model/exporters/CodegenGitlabBranch";
12
- import { CodegenGitlabGroup } from "../../model/exporters/CodegenGitlabGroup";
13
- import { CodegenGitlabRepository } from "../../model/exporters/CodegenGitlabRepository";
14
- import { CodegenRepository } from "../../model/exporters/CodegenRepository";
15
1
  import { Exporter, NewExporterPayload } from "../../model/exporters/SDKExporter";
16
2
  import { NewPipelinePayload, Pipeline, PipelineUpdateModel } from "../../model/exporters/SDKPipeline";
17
3
  import { ExporterCustomBlockVariant } from "../../model/exporters/custom_blocks/SDKExporterCustomBlockVariant";
@@ -27,121 +13,6 @@ export declare class AreaAutomation {
27
13
  constructor(dataCore: DataCore);
28
14
  /** Fetches all pipelines that are available by workspace id and design system id */
29
15
  getPipelines(workspaceId: string, designSystemId?: string): Promise<Array<Pipeline>>;
30
- /**
31
- * Fetches all github connections for user
32
- * @returns Github Connections
33
- */
34
- getGithubConnections(): Promise<CodegenConnection[]>;
35
- /**
36
- * Fetches github accounts
37
- * @returns Github accounts
38
- */
39
- getGithubAccounts(githubConnectionId: string): Promise<CodegenAccount[]>;
40
- /**
41
- * Fetches github repositories
42
- * @returns Github repositories
43
- */
44
- getGithubRepositories(githubConnectionId: string, handle: string): Promise<CodegenRepository[]>;
45
- /**
46
- * Fetches github
47
- * @returns Github branches
48
- */
49
- getGithubBranches(githubConnectionId: string, handle: string, repoName: string): Promise<CodegenBranch[]>;
50
- /**
51
- * Fetches all Gitlab connections for user
52
- * @returns Gitlab Connections
53
- */
54
- getGitlabConnections(): Promise<CodegenConnection[]>;
55
- /**
56
- * Fetches Gitlab groups
57
- * @param connectionId
58
- * @returns Gitlab groups
59
- */
60
- getGitlabGroups(connectionId: string): Promise<CodegenGitlabGroup[]>;
61
- /**
62
- * Fetches Gitlab repositories
63
- * @param connectionId
64
- * @param groupId
65
- * @returns Gitlab repositories
66
- */
67
- getGitlabRepositories(connectionId: string, groupId: string): Promise<CodegenGitlabRepository[]>;
68
- /**
69
- * Fetches Gitlab
70
- * @param connectionId
71
- * @param repoId
72
- * @returns Gitlab branches
73
- */
74
- getGitlabBranches(connectionId: string, repoId: string): Promise<CodegenGitlabBranch[]>;
75
- /**
76
- * Fetches all Azure connections for user
77
- * @returns Azure Connections
78
- */
79
- getAzureConnections(): Promise<CodegenConnection[]>;
80
- /**
81
- * Fetches Azure organizations
82
- * @param connectionId
83
- * @returns Azure organizations
84
- */
85
- getAzureOrganizations(connectionId: string): Promise<CodegenAzureOrganization[]>;
86
- /**
87
- * Fetches Azure projects
88
- * @param connectionId
89
- * @param organizationId
90
- * @returns Azure projects
91
- */
92
- getAzureProjects(connectionId: string, organizationId: string): Promise<CodegenAzureProject[]>;
93
- /**
94
- * Fetches Azure repositories
95
- * @param connectionId
96
- * @param organizationId
97
- * @param projectId
98
- * @returns Azure repositories
99
- */
100
- getAzureRepositories(connectionId: string, organizationId: string, projectId: string): Promise<CodegenAzureRepository[]>;
101
- /**
102
- * Fetches Azure branches
103
- * @param connectionId
104
- * @param organizationId
105
- * @param projectId
106
- * @param repositoryId
107
- * @returns Azure branches
108
- */
109
- getAzureBranches(connectionId: string, organizationId: string, projectId: string, repositoryId: string): Promise<CodegenGitlabBranch[]>;
110
- /**
111
- * Fetches all Bitbucket connections for user
112
- * @returns Bitbucket Connections
113
- */
114
- getBitbucketConnections(): Promise<CodegenConnection[]>;
115
- /**
116
- * Fetches Bitbucket workspaces
117
- * @param connectionId
118
- * @returns Bitbucket workspaces
119
- */
120
- getBitbucketWorkspaces(connectionId: string): Promise<CodegenBitbucketWorkspace[]>;
121
- /**
122
- * Fetches Bitbucket projects
123
- * @param connectionId
124
- * @param workspaceId
125
- * @returns Bitbucket projects
126
- */
127
- getBitbucketProjects(connectionId: string, workspaceId: string): Promise<CodegenBitbucketProject[]>;
128
- /**
129
- * Fetches Bitbucket repositories
130
- * @param connectionId
131
- * @param workspaceId
132
- * @param projectId
133
- * @returns Bitbucket repositories
134
- */
135
- getBitbucketRepositories(connectionId: string, workspaceId: string, projectId?: string): Promise<CodegenBitbucketRepository[]>;
136
- /**
137
- * Fetches Bitbucket branches
138
- * @param connectionId
139
- * @param workspaceId
140
- * @param projectId
141
- * @param repositoryId
142
- * @returns Bitbucket branches
143
- */
144
- getBitbucketBranches(connectionId: string, workspaceId: string, projectId: string, repositoryId: string): Promise<CodegenBitbucketBranch[]>;
145
16
  /** Fetches all builds of pipelines
146
17
  * @param workspaceId - Identifier of the workspace where the pipeline is installed
147
18
  * @param versionId - Identifier of the version where the pipeline is installed
@@ -215,14 +86,14 @@ export declare class AreaAutomation {
215
86
  * @param pipeline Pipeline
216
87
  * @returns Pipeline
217
88
  */
218
- updatePipeline(workspaceId: string, pipelineUpdateModel: PipelineUpdateModel): Promise<Pipeline>;
89
+ updatePipeline(workspaceId: string, pipelineUpdateModel: PipelineUpdateModel): Promise<void>;
219
90
  /**
220
91
  * Run pipeline
221
92
  * @param workspaceId string
222
93
  * @param designSystemVersionId string
223
94
  * @param pipelineId string
224
95
  */
225
- runPipeline(workspaceId: string, designSystemVersionId: string, pipelineId: string): Promise<Pipeline>;
96
+ runPipeline(workspaceId: string, designSystemVersionId: string, pipelineId: string): Promise<void>;
226
97
  /** Create exporter
227
98
  * @param workspaceId string
228
99
  * @param payload NewExporterPayload
@@ -46,10 +46,10 @@ export declare class AreaDataSources {
46
46
  components: boolean;
47
47
  assets: boolean;
48
48
  documentationFrames: boolean;
49
+ isUnpublishedContentFallbackEnabled: boolean;
49
50
  };
50
51
  autoImport?: SourceRemoteModelCloud["autoImportMode"];
51
52
  themeId?: string | null;
52
53
  }): Promise<Source>;
53
- updateFigmaSourceClaimOwnership(from: RemoteVersionIdentifier, sourceId: string): Promise<Source>;
54
54
  deleteFigmaSource(from: RemoteVersionIdentifier, sourceId: string): Promise<void>;
55
55
  }
@@ -29,8 +29,8 @@ export declare class AreaDesignSystems {
29
29
  getBlockDefinitions(designSystemId: string, versionId: string): Promise<import("../..").DocsBlockDefinition[]>;
30
30
  getUrlPreview(designSystemId: string, versionId: string, request: DTODocumentationLinkPreviewRequest): Promise<{
31
31
  linkPreview: {
32
- title?: string | undefined;
33
32
  description?: string | undefined;
33
+ title?: string | undefined;
34
34
  thumbnail?: {
35
35
  type: "Resource" | "FigmaNode";
36
36
  resource?: {
@@ -1,4 +1,4 @@
1
- import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTODeleteDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOMoveDocumentationGroupInput, DTOCreateDocumentationTabInput, DTODocumentationPageAnchor } from "@supernova-studio/client";
1
+ import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTODeleteDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOMoveDocumentationGroupInput, DTOCreateDocumentationTabInput, DTODocumentationPageAnchor, DTODesignElementsDataDiffResponse, DTOPublishDocumentationRequest } from "@supernova-studio/client";
2
2
  import { DocumentationLegacy, DocumentationLegacyModel } from "../../model/base/SDKDocumentationLegacy";
3
3
  import { DocsBlockDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockDefinition";
4
4
  import { DocsBlock } from "../../model/docs/blocks/usage/SDKDocsBlock";
@@ -22,6 +22,12 @@ export declare class AreaDocumentation {
22
22
  */
23
23
  getDocumentation(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacy>;
24
24
  getDocumentationStructure(from: RemoteWorkspaceVersionIdentifier): Promise<(DocsEntityPageModel | DocsEntityGroupModel)[]>;
25
+ /**
26
+ * Fetches the differences in elements, such as design tokens and assets, that have occurred since the documentation was published.
27
+ * @param from Remote version to fetch from
28
+ * @returns Documentation elements diff
29
+ */
30
+ getDocumentationElementsDiff(from: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment): Promise<DTODesignElementsDataDiffResponse>;
25
31
  /** Fetches url string where to find documentation
26
32
  * @param from - Remote version to fetch from
27
33
  * @returns documentation url string
@@ -178,6 +184,14 @@ export declare class AreaDocumentation {
178
184
  * @param isForcing - If true, a new build will be created regardless if an in-progress build already exists.
179
185
  * */
180
186
  publish(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment, isForcing?: boolean): Promise<ExportBuild>;
187
+ /** Publish documentation drafts. This queues a build on Supernova's server that will be processed by the asynchronous CI/CD pipeline.
188
+ * You can request status of the build with associated `isPublishing` method. New endpoint supports publishing drafts.
189
+ * @param to - Remote version where the build should be created
190
+ * @param environment - Environment to publish to
191
+ * @param changes - Specific page/group ids that needs to be published
192
+ * @param isForcing - If true, a new build will be created regardless if an in-progress build already exists.
193
+ * */
194
+ publishDrafts(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment, changes: DTOPublishDocumentationRequest["changes"], isForcing?: boolean): Promise<ExportBuild>;
181
195
  getDocumentationPageAnchors(from: RemoteWorkspaceVersionIdentifier, pageId: string): Promise<Array<DTODocumentationPageAnchor>>;
182
196
  getDocumentationMockedStructure(): Array<DocsEntity>;
183
197
  getDocumentationMockedPageContent(pageId: string): Array<DocsBlock | DocsSection>;
@@ -1,6 +1,4 @@
1
- import { AzurePersonalAccessTokenConnectionPayload, PersonalAccessTokenConnectionPayload } from "../../model/exporters/SDKConnections";
2
- import { ConnectionRemoteModel } from "../../model/exporters/remote/SDKRemoteConnectionsModel";
3
- import { DataCore } from "../data/SDKDataCore";
1
+ import type { DataCore } from "../data/SDKDataCore";
4
2
  export declare class AreaIntegrations {
5
3
  /** Internal: Engine */
6
4
  private dataCore;
@@ -9,83 +7,13 @@ export declare class AreaIntegrations {
9
7
  * @returns Array of AuthenticationTokens
10
8
  */
11
9
  getAuthenticationTokens(): Promise<import("../../model/exporters/SDKConnections").AuthenticationTokens>;
12
- /** Returns URL that can be used to authenticate current user (identified by the token) with Figma
13
- * @returns Figma OAuth URL
14
- */
15
- getFigmaOAuthURL(): Promise<string>;
16
- /** Returns URL that can be used to authenticate current user (identified by the token) with GitHub
17
- * @returns GitHub OAuth URL
18
- */
19
- getGitHubOAuthURL(): Promise<string>;
20
- /** Returns URL that can be used to authenticate current user (identified by the token) with GitLab
21
- * @returns GitLab OAuth URL
22
- */
23
- getGitLabOAuthURL(): Promise<string>;
24
- /** Returns URL that can be used to authenticate current user (identified by the token) with Bitbucket
25
- * @returns Bitbucket OAuth URL
26
- */
27
- getBitbucketOAuthURL(): Promise<string>;
28
- /** Returns URL that can be used to authenticate current user (identified by the token) with Azure
29
- * @returns Azure OAuth URL
30
- */
31
- getAzureOAuthURL(): Promise<string>;
32
10
  /** Creates a Personal Access Token.
33
11
  * @param name - Name of the token.
34
12
  * @param scope - Scope of the token.
35
13
  */
36
14
  createAuthenticationToken(name: string, scope?: string): Promise<import("../../model/exporters/SDKConnections").CreateAuthenticationTokenPayload>;
37
- /** Creates user GitHub personal access token integration.
38
- * @param customUrl - Custom GitHub URL. If not provided, default GitHub URL will be used.
39
- * @param token - GitHub access token.
40
- * @param name - Name of the integration.
41
- */
42
- createGitHubPersonalAccessTokenConnection(connection: PersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
43
- /** Creates user GitLab personal access token integration.
44
- * @param customUrl - Custom GitLab URL. If not provided, default GitLab URL will be used.
45
- * @param token - GitLab access token.
46
- * @param name - Name of the integration.
47
- */
48
- createGitLabPersonalAccessTokenConnection(connection: PersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
49
- /** Creates user Bitbucket personal access token integration.
50
- * @param customUrl - Custom Bitbucket URL. If not provided, default Bitbucket URL will be used.
51
- * @param token - Bitbucket access token.
52
- * @param name - Name of the integration.
53
- * @param organization - Organization name.
54
- */
55
- createBitbucketPersonalAccessTokenConnection(connection: PersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
56
- /** Creates user Azure personal access token integration.
57
- * @param customUrl - Custom Azure URL. If not provided, default Azure URL will be used.
58
- * @param token - Azure access token.
59
- * @param name - Name of the integration.
60
- */
61
- createAzurePersonalAccessTokenConnection(connection: AzurePersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
62
15
  /**
63
16
  * @returns Array of AuthenticationTokens
64
17
  */
65
18
  deleteAuthenticationToken(id: string): Promise<import("../../model/exporters/SDKConnections").AuthenticationTokenPayload>;
66
- /** Deletes user Figma OAuth integration.
67
- * @param userId - User id to delete integration for. Can only be invoked on user id that is currently authenticated.
68
- * @returns Nothing
69
- */
70
- deleteFigmaOAuthIntegration(userId: string): Promise<void>;
71
- /** Deletes user GitHub OAuth integration.
72
- * @param userId - User id to delete integration for. Can only be invoked on user id that is currently authenticated.
73
- * @returns Nothing
74
- */
75
- deleteGitHubOAuthIntegration(userId: string): Promise<void>;
76
- /** Deletes user GitLab OAuth integration.
77
- * @param userId - User id to delete integration for. Can only be invoked on user id that is currently authenticated.
78
- * @returns Nothing
79
- */
80
- deleteGitLabOAuthIntegration(userId: string): Promise<void>;
81
- /** Deletes user Bitbucket OAuth integration.
82
- * @param userId - User id to delete integration for. Can only be invoked on user id that is currently authenticated.
83
- * @returns Nothing
84
- */
85
- deleteBitbucketOAuthIntegration(userId: string): Promise<void>;
86
- /** Deletes user Azure OAuth integration.
87
- * @param userId - User id to delete integration for. Can only be invoked on user id that is currently authenticated.
88
- * @returns Nothing
89
- */
90
- deleteAzureOAuthIntegration(userId: string): Promise<void>;
91
19
  }
@@ -114,7 +114,7 @@ export declare class AreaTokens {
114
114
  updateToken(to: RemoteVersionIdentifier, token: Token): Promise<void>;
115
115
  /** Updates remote token groups. This method can only be used on token groups that already exist in the version
116
116
  * @param to - Remote version to write to
117
- * @param token - Token group to update
117
+ * @param group - Token group to update
118
118
  * @returns Nothing
119
119
  */
120
120
  updateTokenGroup(to: RemoteVersionIdentifier, group: TokenGroup): Promise<void>;
@@ -0,0 +1,99 @@
1
+ import { WorkspaceIntegrationType, WorkspaceIntegrations } from "../../model/workspaces/SDKWorkspaceIntegration";
2
+ import { WorkspaceIntegrationAccessTokenPayload } from "../../model/workspaces/SDKWorkspaceIntegrationAccessToken";
3
+ import { WorkspaceIntegrationGetGitProvidersInput } from "../../model/workspaces/SDKWorkspaceIntegrationGetGitProviders";
4
+ import { OAuth2IntegrationTypes, WorkspaceIntegrationOauthRequest } from "../../model/workspaces/SDKWorkspaceIntegrationOauthRequest";
5
+ import { GitProvidersBranches } from "../../model/workspaces/integrations/GitProvidersBranches";
6
+ import { GitProvidersOrganizations } from "../../model/workspaces/integrations/GitProvidersOrganizations";
7
+ import { GitProvidersProjects } from "../../model/workspaces/integrations/GitProvidersProjects";
8
+ import { GitProvidersRepositories } from "../../model/workspaces/integrations/GitProvidersRepositories";
9
+ import type { DataCore } from "../data/SDKDataCore";
10
+ export declare class AreaWorkspaceIntegrations {
11
+ /** Internal: Engine */
12
+ private dataCore;
13
+ constructor(dataCore: DataCore);
14
+ /** Fetches integrations of one specific workspace by provided id
15
+ * @param workspaceId - ID of the workspace
16
+ * @returns Object with integrations of given workspace
17
+ */
18
+ getIntegrations(workspaceId: string): Promise<WorkspaceIntegrations>;
19
+ /** Fetches redirect url for oauth of one specific workspace integration by workspace id and integration type
20
+ * @param workspaceId - ID of the workspace
21
+ * @param type - Type of integration
22
+ * @returns Object with redirect url
23
+ */
24
+ getRedirectUrl({ workspaceId, type, }: {
25
+ workspaceId: string;
26
+ type: OAuth2IntegrationTypes;
27
+ }): Promise<WorkspaceIntegrationOauthRequest>;
28
+ /** Fetches Organizations
29
+ * @param workspaceId - ID of the workspace
30
+ * @param integrationId - ID of the integration
31
+ * @returns
32
+ */
33
+ fetchGitProviderOrganization({ workspaceId, integrationId, }: {
34
+ workspaceId: string;
35
+ integrationId: string;
36
+ }): Promise<GitProvidersOrganizations>;
37
+ /** Fetches Projects
38
+ * @param workspaceId - ID of the workspace
39
+ * @param integrationId - ID of the integration
40
+ * @param params - Query string parameters
41
+ * @returns
42
+ */
43
+ fetchGitProviderProjects({ workspaceId, integrationId, params, }: {
44
+ workspaceId: string;
45
+ integrationId: string;
46
+ params?: WorkspaceIntegrationGetGitProvidersInput;
47
+ }): Promise<GitProvidersProjects>;
48
+ /** Fetches Repositaries
49
+ * @param workspaceId - ID of the workspace
50
+ * @param integrationId - ID of the integration
51
+ * @param params - Query string parameters
52
+ * @returns
53
+ */
54
+ fetchGitProviderRepositories({ workspaceId, integrationId, params, }: {
55
+ workspaceId: string;
56
+ integrationId: string;
57
+ params?: WorkspaceIntegrationGetGitProvidersInput;
58
+ }): Promise<GitProvidersRepositories>;
59
+ /** Fetches Branches
60
+ * @param workspaceId - ID of the workspace
61
+ * @param integrationId - ID of the integration
62
+ * @param params - Query string parameters
63
+ * @returns
64
+ */
65
+ fetchGitProviderBranches({ workspaceId, integrationId, params, }: {
66
+ workspaceId: string;
67
+ integrationId: string;
68
+ params?: WorkspaceIntegrationGetGitProvidersInput;
69
+ }): Promise<GitProvidersBranches>;
70
+ /** Creates a new workspace integration via PAT by workspace id and PAT input
71
+ * @param workspaceId - ID of the workspace
72
+ * @param payload - PAT input
73
+ * @returns Workspace integrations with updated integration
74
+ */
75
+ createWorkspaceIntegrationAccessToken({ workspaceId, payload, }: {
76
+ workspaceId: string;
77
+ payload: WorkspaceIntegrationAccessTokenPayload;
78
+ }): Promise<WorkspaceIntegrations>;
79
+ /** Delete workspace integration's connection
80
+ * @param workspaceId - ID of the workspace
81
+ * @param integrationId - ID of the integration
82
+ * @param credentialId - ID of the credential
83
+ * @returns Workspace integrations with updated integration
84
+ */
85
+ deleteWorkspaceIntegrationCredential(data: {
86
+ workspaceId: string;
87
+ integrationId: string;
88
+ credentialId: string;
89
+ }): Promise<WorkspaceIntegrationType>;
90
+ /** Delete workspace integration
91
+ * @param workspaceId - ID of the workspace
92
+ * @param integrationId - ID of the integration
93
+ * @returns Workspace integrations with updated integration
94
+ */
95
+ deleteWorkspaceIntegration(data: {
96
+ workspaceId: string;
97
+ integrationId: string;
98
+ }): Promise<WorkspaceIntegrationType>;
99
+ }
@@ -2,11 +2,9 @@ import { Acl } from "../../model/acl/SDKAcl";
2
2
  import { UserRoleWithoutOwner } from "../../model/enums/SDKUserRole";
3
3
  import { Membership } from "../../model/membership/SDKMembership";
4
4
  import { UserMembership } from "../../model/users/SDKUserMembership";
5
+ import { UserWorkspaceNotificationSettings, UserWorkspaceNotificationSettingsUpdateModel } from "../../model/users/SDKUserWorkspaceNotificationSettings";
5
6
  import { Workspace } from "../../model/workspaces/SDKWorkspace";
6
7
  import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
7
- import { WorkspaceIntegrationType, WorkspaceIntegrations } from "../../model/workspaces/SDKWorkspaceIntegration";
8
- import { WorkspaceIntegrationAccessTokenPayload } from "../../model/workspaces/SDKWorkspaceIntegrationAccessToken";
9
- import { OAuth2IntegrationTypes, WorkspaceIntegrationOauthRequest } from "../../model/workspaces/SDKWorkspaceIntegrationOauthRequest";
10
8
  import { WorkspaceInvitation, WorkspaceInvitationUpdateModel } from "../../model/workspaces/SDKWorkspaceInvitation";
11
9
  import { WorkspaceInvoice } from "../../model/workspaces/SDKWorkspaceInvoice";
12
10
  import { WorkspaceNPMRegistryAccessTokenRemoteModel } from "../../model/workspaces/SDKWorkspaceNPMRegistryAccessToken";
@@ -27,47 +25,6 @@ export declare class AreaWorkspaces {
27
25
  * @returns Full workspace object
28
26
  */
29
27
  workspace(workspaceId: string): Promise<Workspace>;
30
- /** Fetches integrations of one specific workspace by provided id
31
- * @param workspaceId - ID of the workspace
32
- * @returns Object with integrations of given workspace
33
- */
34
- workspaceIntegrations(workspaceId: string): Promise<WorkspaceIntegrations>;
35
- /** Fetches redirect url for oauth of one specific workspace integration by workspace id and integration type
36
- * @param workspaceId - ID of the workspace
37
- * @returns Object with redirect url
38
- */
39
- workspaceIntegrationRedirectUrl({ workspaceId, type, }: {
40
- workspaceId: string;
41
- type: OAuth2IntegrationTypes;
42
- }): Promise<WorkspaceIntegrationOauthRequest>;
43
- /** Creates a new workspace integration via PAT by workspace id and PAT input
44
- * @param workspaceId - ID of the workspace
45
- * @returns Workspace integrations with updated integration
46
- */
47
- createWorkspaceIntegrationAccessToken({ workspaceId, payload, }: {
48
- workspaceId: string;
49
- payload: WorkspaceIntegrationAccessTokenPayload;
50
- }): Promise<WorkspaceIntegrations>;
51
- /** Delete workspace integration's connection
52
- * @param workspaceId - ID of the workspace
53
- * @param integrationId - ID of the integration
54
- * @param credentialId - ID of the credential
55
- * @returns Workspace integrations with updated integration
56
- */
57
- deleteWorkspaceIntegrationCredential(data: {
58
- workspaceId: string;
59
- integrationId: string;
60
- credentialId: string;
61
- }): Promise<WorkspaceIntegrationType>;
62
- /** Delete workspace integration
63
- * @param workspaceId - ID of the workspace
64
- * @param integrationId - ID of the integration
65
- * @returns Workspace integrations with updated integration
66
- */
67
- deleteWorkspaceIntegration(data: {
68
- workspaceId: string;
69
- integrationId: string;
70
- }): Promise<WorkspaceIntegrationType>;
71
28
  /** Fetches all workspaces user has access to. Use `memberships` instead if you want to also know which role the current user has in which workspace
72
29
  * @param userId - ID of the user
73
30
  * @returns All workspaces user is part of
@@ -83,6 +40,12 @@ export declare class AreaWorkspaces {
83
40
  * @returns All users that are members of the provided workspace
84
41
  */
85
42
  userMemberships(workspaceId: string): Promise<Array<UserMembership>>;
43
+ /** Fetches user workspace notification settings
44
+ * @param userId - ID of the user
45
+ * @param workspaceId - ID of the workspace
46
+ * @returns All user workspace notification settings
47
+ */
48
+ userWorkspaceNotificationSettings(userId: string, workspaceId: string): Promise<UserWorkspaceNotificationSettings>;
86
49
  /** Fetches product features grouped by product code
87
50
  * @param workspaceId - ID of the workspace
88
51
  * @returns Product features
@@ -189,6 +152,12 @@ export declare class AreaWorkspaces {
189
152
  * @returns Nothing
190
153
  */
191
154
  updateWorkspaceNPMRegistrySettings(workspaceId: string, npmRegistrySettings: WorkspaceNPMRegistrySettingsUpdateModel): Promise<void>;
155
+ /** Updates notification settings
156
+ * @param userId - ID of the user
157
+ * @param workspaceId - ID of the workspace
158
+ * @returns Nothing
159
+ */
160
+ updateUserWorkspaceNotificationSettings(userId: string, workspaceId: string, notificationSettings: UserWorkspaceNotificationSettingsUpdateModel): Promise<void>;
192
161
  /** Transfers an ownership of the workspace.
193
162
  * Old owner receives new owner's previous role.
194
163
  * @param workspaceId - ID of the workspace
@@ -1,4 +1,4 @@
1
- import { HttpsProxyAgent } from "https-proxy-agent";
1
+ import { GitProviderValues } from "../../model/workspaces/SDKWorkspaceIntegrationGetGitProviders";
2
2
  type DataBridgeRequestHookResult = {
3
3
  skipDefaultAuth?: boolean;
4
4
  };
@@ -30,7 +30,7 @@ export declare class DataBridge {
30
30
  apiVersion: string;
31
31
  target: string | null;
32
32
  bypassEnvFetch: boolean;
33
- proxyAgent: HttpsProxyAgent<string> | undefined;
33
+ proxyUrl: string | undefined;
34
34
  requestHook: DataBridgeRequestHook | null;
35
35
  debugRequestObserver: DebugRequestObserver | null;
36
36
  debugResponseObserver: DebugResponseObserver | null;
@@ -44,13 +44,17 @@ export declare class DataBridge {
44
44
  private request;
45
45
  private handleResponse;
46
46
  private buildRequestConfig;
47
+ private getProxyAgent;
48
+ private getFetchInvoker;
47
49
  getBaseEndpoint(fragment: string | null): string;
48
50
  getPublicEndpoint(fragment: string): string;
49
51
  getAclEndpoint(resource?: string): string;
50
52
  getUserEndpoint(userId: string, fragment: string | null): string;
53
+ getUserWorkspaceEndpoint(userId: string, wsId: string, fragment: string | null): string;
51
54
  getWorkspaceEndpoint(wsId: string, fragment: string | null): string;
52
55
  getWorkspaceIntegrationCredentialEndpoint(wsId: string, integrationId: string, credentialId: string): string;
53
56
  getWorkspaceIntegrationEndpoint(wsId: string, integrationId: string): string;
57
+ getWorkspaceIntegrationGitProvidersEndpoint(wsId: string, integrationId: string, operation: GitProviderValues): string;
54
58
  getDesignSystemEndpoint(dsId: string, fragment: string | null): string;
55
59
  getVersionEndpoint(dsId: string, dsVersionId: string, fragment: string | null): string;
56
60
  getVersionCreationJobEndpoint(dsId: string, jobId: string): string;