@supernova-studio/supernova-sdk-beta 1.6.48 → 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.
- package/README.md +19 -0
- package/build/sdk-typescript/src/core/SDKSupernova.d.ts +3 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +2 -131
- package/build/sdk-typescript/src/core/areas/SDKAreaDataSources.d.ts +1 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaDesignSystems.d.ts +1 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +15 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaIntegrations.d.ts +1 -73
- package/build/sdk-typescript/src/core/areas/SDKAreaTokens.d.ts +1 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaceIntegrations.d.ts +99 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +13 -44
- package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +6 -2
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +40 -39
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +19 -37
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +5 -2
- package/build/sdk-typescript/src/core/resolvers/SDKDocsEntityMultiplayerItemResolver.d.ts +1 -1
- package/build/sdk-typescript/src/exports.d.ts +6 -3
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/figma-component/SDKDocsBlockActualFigmaComponent.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/figma-component-propstable/SDKDocsBlockActualFigmaComponentPropsTable.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockFigmaComponentProperty.d.ts +40 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +3 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntity.d.ts +4 -1
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityDraftState.d.ts +16 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityGroup.d.ts +3 -1
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityPage.d.ts +3 -1
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyItem.d.ts +2 -0
- package/build/sdk-typescript/src/model/enums/SDKCloudWarningType.d.ts +2 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockBehaviorDataType.d.ts +3 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +3 -1
- package/build/sdk-typescript/src/model/exporters/SDKPipeline.d.ts +38 -43
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuild.d.ts +7 -7
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuildResults.d.ts +21 -18
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemotePipelineModel.d.ts +9 -15
- package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +4 -0
- package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenModel.d.ts +2 -0
- package/build/sdk-typescript/src/model/users/SDKUser.d.ts +5 -1
- package/build/sdk-typescript/src/model/users/SDKUserProfile.d.ts +23 -12
- package/build/sdk-typescript/src/model/users/SDKUserWorkspaceNotificationSettings.d.ts +16 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceIntegration.d.ts +8 -24
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceIntegrationGetGitProviders.d.ts +15 -0
- package/build/sdk-typescript/src/model/workspaces/integrations/GitProvidersBranches.d.ts +13 -0
- package/build/sdk-typescript/src/model/workspaces/integrations/GitProvidersOrganizations.d.ts +15 -0
- package/build/sdk-typescript/src/model/workspaces/integrations/GitProvidersProjects.d.ts +15 -0
- package/build/sdk-typescript/src/model/workspaces/integrations/GitProvidersRepositories.d.ts +16 -0
- package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +11 -0
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewTypes.d.ts +2 -0
- package/build/supernova-sdk-typescript.js +1 -1
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +3 -3
- package/build/sdk-typescript/src/browser-bundle.d.ts +0 -1
- package/build/sdk-typescript/src/model/exporters/CodegenAccount.d.ts +0 -9
- package/build/sdk-typescript/src/model/exporters/CodegenAzureBranch.d.ts +0 -7
- package/build/sdk-typescript/src/model/exporters/CodegenAzureOrganization.d.ts +0 -7
- package/build/sdk-typescript/src/model/exporters/CodegenAzureProject.d.ts +0 -7
- package/build/sdk-typescript/src/model/exporters/CodegenAzureRepository.d.ts +0 -11
- package/build/sdk-typescript/src/model/exporters/CodegenBitbucketBranch.d.ts +0 -7
- package/build/sdk-typescript/src/model/exporters/CodegenBitbucketProject.d.ts +0 -6
- package/build/sdk-typescript/src/model/exporters/CodegenBitbucketRepository.d.ts +0 -8
- package/build/sdk-typescript/src/model/exporters/CodegenBitbucketWorkspace.d.ts +0 -6
- package/build/sdk-typescript/src/model/exporters/CodegenBranch.d.ts +0 -8
- package/build/sdk-typescript/src/model/exporters/CodegenConnection.d.ts +0 -10
- package/build/sdk-typescript/src/model/exporters/CodegenGitlabBranch.d.ts +0 -7
- package/build/sdk-typescript/src/model/exporters/CodegenGitlabGroup.d.ts +0 -6
- package/build/sdk-typescript/src/model/exporters/CodegenGitlabRepository.d.ts +0 -9
- package/build/sdk-typescript/src/model/exporters/CodegenRepository.d.ts +0 -15
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenBranchModel.d.ts +0 -5
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenOrganizationModel.d.ts +0 -5
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenProjectModel.d.ts +0 -5
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenRepositoryModel.d.ts +0 -9
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenBranchModel.d.ts +0 -5
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenProjectModel.d.ts +0 -4
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenRepositoryModel.d.ts +0 -6
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenWorkspaceModel.d.ts +0 -4
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenAccountModel.d.ts +0 -7
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenBranchModel.d.ts +0 -6
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenConnectionModel.d.ts +0 -8
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenRepositoryModel.d.ts +0 -17
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenBranchModel.d.ts +0 -5
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenGroupModel.d.ts +0 -4
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenRepositoryModel.d.ts +0 -7
|
@@ -1,13 +1,11 @@
|
|
|
1
|
+
import { DTOPipeline } from "@supernova-studio/client";
|
|
1
2
|
import { ExportBuild } from "./exporter_builds/SDKExportBuild";
|
|
2
|
-
import { PipelineRemoteModel } from "./remote/SDKRemotePipelineModel";
|
|
3
3
|
export type GithubDestinationPayload = {
|
|
4
|
-
connectionId: string;
|
|
5
4
|
branch: string;
|
|
6
5
|
relativePath: string;
|
|
7
6
|
url: string;
|
|
8
7
|
};
|
|
9
8
|
export type AzureDestinationPayload = {
|
|
10
|
-
connectionId: string;
|
|
11
9
|
organizationId: string;
|
|
12
10
|
projectId: string;
|
|
13
11
|
repositoryId: string;
|
|
@@ -15,7 +13,6 @@ export type AzureDestinationPayload = {
|
|
|
15
13
|
relativePath: string;
|
|
16
14
|
};
|
|
17
15
|
export type BitbucketDestinationPayload = {
|
|
18
|
-
connectionId: string;
|
|
19
16
|
workspaceSlug: string;
|
|
20
17
|
projectKey: string;
|
|
21
18
|
repoSlug: string;
|
|
@@ -23,7 +20,6 @@ export type BitbucketDestinationPayload = {
|
|
|
23
20
|
relativePath: string;
|
|
24
21
|
};
|
|
25
22
|
export type GitlabDestinationPayload = {
|
|
26
|
-
connectionId: string;
|
|
27
23
|
projectId: string;
|
|
28
24
|
branch: string;
|
|
29
25
|
relativePath: string;
|
|
@@ -31,9 +27,15 @@ export type GitlabDestinationPayload = {
|
|
|
31
27
|
export type DocumentationDestinationPayload = {
|
|
32
28
|
environment: "Live" | "Preview";
|
|
33
29
|
};
|
|
30
|
+
export type GitObjectQuery = {
|
|
31
|
+
organization?: string;
|
|
32
|
+
project?: string;
|
|
33
|
+
repository?: string;
|
|
34
|
+
};
|
|
35
|
+
export type NewPipelinePayloadDestination = "Github" | "Gitlab" | "Bitbucket" | "Azure" | "WebhookUrl" | "S3" | "Documentation";
|
|
34
36
|
export type NewPipelinePayload = {
|
|
35
|
-
|
|
36
|
-
|
|
37
|
+
brandPersistentId?: string;
|
|
38
|
+
themePersistentId?: string;
|
|
37
39
|
designSystemId: string;
|
|
38
40
|
destinations: {
|
|
39
41
|
azure: AzureDestinationPayload | null;
|
|
@@ -48,66 +50,59 @@ export type NewPipelinePayload = {
|
|
|
48
50
|
exporterId: string;
|
|
49
51
|
isEnabled: boolean;
|
|
50
52
|
name: string;
|
|
53
|
+
destination: NewPipelinePayloadDestination;
|
|
54
|
+
gitQuery: GitObjectQuery;
|
|
51
55
|
};
|
|
52
|
-
export type PipelineUpdateModel = Omit<
|
|
56
|
+
export type PipelineUpdateModel = Omit<DTOPipeline, "latestJobs" | "workspaceId" | "designSystem">;
|
|
53
57
|
export declare class Pipeline {
|
|
54
58
|
id: string;
|
|
55
59
|
workspaceId: string;
|
|
56
|
-
|
|
57
|
-
id: string;
|
|
58
|
-
meta: {
|
|
59
|
-
name: string;
|
|
60
|
-
description: string;
|
|
61
|
-
};
|
|
62
|
-
};
|
|
60
|
+
designSystemId: string;
|
|
63
61
|
name: string;
|
|
64
62
|
isEnabled: boolean;
|
|
65
|
-
eventType: "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
|
|
63
|
+
eventType: "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "None";
|
|
66
64
|
exporterId: string;
|
|
67
65
|
destinations: {
|
|
68
|
-
webhookUrl
|
|
69
|
-
documentation
|
|
66
|
+
webhookUrl?: string;
|
|
67
|
+
documentation?: {
|
|
70
68
|
environment: "Live" | "Preview";
|
|
71
|
-
}
|
|
72
|
-
s3
|
|
73
|
-
github
|
|
74
|
-
connectionId: string;
|
|
69
|
+
};
|
|
70
|
+
s3?: Record<any, any>;
|
|
71
|
+
github?: {
|
|
75
72
|
url: string;
|
|
76
73
|
branch: string;
|
|
77
|
-
relativePath
|
|
78
|
-
}
|
|
79
|
-
azure
|
|
80
|
-
connectionId: string;
|
|
74
|
+
relativePath?: string;
|
|
75
|
+
};
|
|
76
|
+
azure?: {
|
|
81
77
|
organizationId: string;
|
|
82
78
|
projectId: string;
|
|
83
79
|
repositoryId: string;
|
|
84
80
|
branch: string;
|
|
85
|
-
relativePath
|
|
86
|
-
url
|
|
87
|
-
}
|
|
88
|
-
gitlab
|
|
89
|
-
connectionId: string;
|
|
81
|
+
relativePath?: string;
|
|
82
|
+
url?: string;
|
|
83
|
+
};
|
|
84
|
+
gitlab?: {
|
|
90
85
|
projectId: string;
|
|
91
86
|
branch: string;
|
|
92
|
-
relativePath
|
|
93
|
-
url
|
|
94
|
-
}
|
|
95
|
-
bitbucket
|
|
96
|
-
connectionId: string;
|
|
87
|
+
relativePath?: string;
|
|
88
|
+
url?: string;
|
|
89
|
+
};
|
|
90
|
+
bitbucket?: {
|
|
97
91
|
workspaceSlug: string;
|
|
98
92
|
projectKey: string;
|
|
99
93
|
repoSlug: string;
|
|
100
94
|
branch: string;
|
|
101
|
-
relativePath
|
|
102
|
-
url
|
|
103
|
-
}
|
|
95
|
+
relativePath?: string;
|
|
96
|
+
url?: string;
|
|
97
|
+
};
|
|
104
98
|
};
|
|
105
|
-
|
|
106
|
-
|
|
99
|
+
brandPersistentId?: string;
|
|
100
|
+
themePersistentId?: string;
|
|
107
101
|
latestJobs: Array<ExportBuild>;
|
|
108
|
-
constructor(data:
|
|
102
|
+
constructor(data: DTOPipeline);
|
|
109
103
|
get isBuildOnly(): boolean;
|
|
110
104
|
get gitProviderType(): "github" | "bitbucket" | "gitlab" | "azure" | null;
|
|
111
|
-
get toRemoteModel():
|
|
105
|
+
get toRemoteModel(): DTOPipeline;
|
|
112
106
|
get isRunning(): boolean;
|
|
107
|
+
private parseLatestJobs;
|
|
113
108
|
}
|
|
@@ -22,8 +22,8 @@ export declare enum ExportBuildStatus {
|
|
|
22
22
|
export type ExportBuildModel = {
|
|
23
23
|
index: number | null;
|
|
24
24
|
id: string;
|
|
25
|
-
createdAt:
|
|
26
|
-
finishedAt:
|
|
25
|
+
createdAt: Date;
|
|
26
|
+
finishedAt: Date;
|
|
27
27
|
designSystem: {
|
|
28
28
|
id: string;
|
|
29
29
|
meta: {
|
|
@@ -40,15 +40,15 @@ export type ExportBuildModel = {
|
|
|
40
40
|
version: string;
|
|
41
41
|
isReadonly: boolean;
|
|
42
42
|
};
|
|
43
|
-
result: ExportBuildResult
|
|
43
|
+
result: ExportBuildResult;
|
|
44
44
|
status: ExportBuildStatus;
|
|
45
45
|
estimatedExecutionTime: number | null;
|
|
46
46
|
createdBy: ExportBuildCreatedBy | null;
|
|
47
47
|
destinations: ExportDestinations;
|
|
48
48
|
scheduleId: string | null;
|
|
49
49
|
exporterId: string;
|
|
50
|
-
|
|
51
|
-
|
|
50
|
+
brandPersistentId: string | null;
|
|
51
|
+
themePersistentId: string | null;
|
|
52
52
|
};
|
|
53
53
|
/** Build run entry */
|
|
54
54
|
export declare class ExportBuild {
|
|
@@ -65,7 +65,7 @@ export declare class ExportBuild {
|
|
|
65
65
|
id: string;
|
|
66
66
|
meta: {
|
|
67
67
|
name: string;
|
|
68
|
-
description
|
|
68
|
+
description?: string;
|
|
69
69
|
};
|
|
70
70
|
};
|
|
71
71
|
/** The version of the design system used in the export build */
|
|
@@ -73,7 +73,7 @@ export declare class ExportBuild {
|
|
|
73
73
|
id: string;
|
|
74
74
|
meta: {
|
|
75
75
|
name: string;
|
|
76
|
-
description
|
|
76
|
+
description?: string;
|
|
77
77
|
};
|
|
78
78
|
version: string;
|
|
79
79
|
isReadonly: boolean;
|
|
@@ -1,13 +1,16 @@
|
|
|
1
1
|
export type S3ExportBuildResultModel = {
|
|
2
|
-
|
|
3
|
-
|
|
2
|
+
bucket: string;
|
|
3
|
+
files: Array<string>;
|
|
4
|
+
path: string;
|
|
4
5
|
};
|
|
5
6
|
/** The type definition for the data model of an S3 export build result. */
|
|
6
7
|
export declare class S3ExportBuildResult {
|
|
8
|
+
/** The S3 bucket associated with the export build result */
|
|
9
|
+
bucket: string;
|
|
7
10
|
/** An array of URLs associated with the export build result */
|
|
8
|
-
|
|
11
|
+
files: Array<string>;
|
|
9
12
|
/** A URL associated with the export build result */
|
|
10
|
-
|
|
13
|
+
path: string;
|
|
11
14
|
constructor(data: S3ExportBuildResultModel);
|
|
12
15
|
}
|
|
13
16
|
export type ExportBuildPullRequestResultModel = {
|
|
@@ -55,30 +58,30 @@ export declare class ExportBuildResultLog {
|
|
|
55
58
|
}
|
|
56
59
|
export type ExportBuildResultModel = {
|
|
57
60
|
logs: Array<ExportBuildResultLog>;
|
|
58
|
-
s3
|
|
59
|
-
azure
|
|
60
|
-
bitbucket
|
|
61
|
-
github
|
|
62
|
-
gitlab
|
|
63
|
-
documentation
|
|
64
|
-
error
|
|
61
|
+
s3?: S3ExportBuildResult;
|
|
62
|
+
azure?: ExportBuildPullRequestResult;
|
|
63
|
+
bitbucket?: ExportBuildPullRequestResult;
|
|
64
|
+
github?: ExportBuildPullRequestResult;
|
|
65
|
+
gitlab?: ExportBuildPullRequestResult;
|
|
66
|
+
documentation?: ExportBuildDocumentationResult;
|
|
67
|
+
error?: string;
|
|
65
68
|
};
|
|
66
69
|
export declare class ExportBuildResult {
|
|
67
70
|
/** An array of log entries associated with the export build result */
|
|
68
71
|
logs: Array<ExportBuildResultLog>;
|
|
69
72
|
/** The S3 export build result, or null if not available */
|
|
70
|
-
s3
|
|
73
|
+
s3?: S3ExportBuildResult;
|
|
71
74
|
/** The Azure export build pull request result, or null if not available */
|
|
72
|
-
azure
|
|
75
|
+
azure?: ExportBuildPullRequestResult;
|
|
73
76
|
/** The Bitbucket export build pull request result, or null if not available */
|
|
74
|
-
bitbucket
|
|
77
|
+
bitbucket?: ExportBuildPullRequestResult;
|
|
75
78
|
/** The GitHub export build pull request result, or null if not available */
|
|
76
|
-
github
|
|
79
|
+
github?: ExportBuildPullRequestResult;
|
|
77
80
|
/** The GitLab export build pull request result, or null if not available */
|
|
78
|
-
gitlab
|
|
81
|
+
gitlab?: ExportBuildPullRequestResult;
|
|
79
82
|
/** The documentation build result, or null if not available */
|
|
80
|
-
documentation
|
|
83
|
+
documentation?: ExportBuildDocumentationResult;
|
|
81
84
|
/** The error message, or null if not available */
|
|
82
|
-
error
|
|
85
|
+
error?: string;
|
|
83
86
|
constructor(data: ExportBuildResultModel);
|
|
84
87
|
}
|
|
@@ -2,30 +2,24 @@ import { ExportBuildModel } from "../exporter_builds/SDKExportBuild";
|
|
|
2
2
|
export type PipelineRemoteModel = {
|
|
3
3
|
id: string;
|
|
4
4
|
workspaceId: string;
|
|
5
|
-
|
|
6
|
-
id: string;
|
|
7
|
-
meta: {
|
|
8
|
-
name: string;
|
|
9
|
-
description: string;
|
|
10
|
-
};
|
|
11
|
-
};
|
|
5
|
+
designSystemId: string;
|
|
12
6
|
name: string;
|
|
13
7
|
isEnabled: boolean;
|
|
14
8
|
eventType: "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
|
|
15
9
|
exporterId: string;
|
|
16
10
|
destinations: {
|
|
17
11
|
webhookUrl: string | null;
|
|
18
|
-
|
|
12
|
+
destinationSnDocs: {
|
|
19
13
|
environment: "Live" | "Preview";
|
|
20
14
|
} | null;
|
|
21
|
-
|
|
22
|
-
|
|
15
|
+
destinationS3: Record<any, any> | null;
|
|
16
|
+
destinationGithub: {
|
|
23
17
|
connectionId: string;
|
|
24
18
|
url: string;
|
|
25
19
|
branch: string;
|
|
26
20
|
relativePath: string;
|
|
27
21
|
} | null;
|
|
28
|
-
|
|
22
|
+
destinationAzure: {
|
|
29
23
|
connectionId: string;
|
|
30
24
|
organizationId: string;
|
|
31
25
|
projectId: string;
|
|
@@ -34,14 +28,14 @@ export type PipelineRemoteModel = {
|
|
|
34
28
|
relativePath: string;
|
|
35
29
|
url: string;
|
|
36
30
|
} | null;
|
|
37
|
-
|
|
31
|
+
destinationGitlab: {
|
|
38
32
|
connectionId: string;
|
|
39
33
|
projectId: string;
|
|
40
34
|
branch: string;
|
|
41
35
|
relativePath: string;
|
|
42
36
|
url: string;
|
|
43
37
|
} | null;
|
|
44
|
-
|
|
38
|
+
destinationBitbucket: {
|
|
45
39
|
connectionId: string;
|
|
46
40
|
workspaceSlug: string;
|
|
47
41
|
projectKey: string;
|
|
@@ -51,7 +45,7 @@ export type PipelineRemoteModel = {
|
|
|
51
45
|
url: string;
|
|
52
46
|
} | null;
|
|
53
47
|
};
|
|
54
|
-
|
|
55
|
-
|
|
48
|
+
brandPersistentId: string | null;
|
|
49
|
+
themePersistentId: string | null;
|
|
56
50
|
latestJobs: Array<ExportBuildModel> | null;
|
|
57
51
|
};
|
|
@@ -6,6 +6,8 @@ export type TokenOriginModel = {
|
|
|
6
6
|
sourceType?: SourceType;
|
|
7
7
|
referenceOriginId?: string;
|
|
8
8
|
referencePersistentId?: string;
|
|
9
|
+
referenceResolutionFailed?: boolean;
|
|
10
|
+
key?: string;
|
|
9
11
|
};
|
|
10
12
|
export declare class TokenOrigin {
|
|
11
13
|
id: string | null;
|
|
@@ -14,5 +16,7 @@ export declare class TokenOrigin {
|
|
|
14
16
|
sourceType?: SourceType | null;
|
|
15
17
|
referenceOriginId?: string | null;
|
|
16
18
|
referencePersistentId?: string | null;
|
|
19
|
+
referenceResolutionFailed?: boolean | null;
|
|
20
|
+
key?: string | null;
|
|
17
21
|
constructor(model: TokenOriginModel);
|
|
18
22
|
}
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
import { UserProfile, UserProfileRemoteModel, UserProfileTransportModel } from "./SDKUserProfile";
|
|
2
|
+
type UserSource = "SignUp" | "Invite" | "SSO";
|
|
2
3
|
export type UserRemoteModel = {
|
|
3
4
|
id: string;
|
|
4
5
|
email: string;
|
|
6
|
+
source: UserSource | null;
|
|
5
7
|
createdAt: string;
|
|
6
8
|
profile: UserProfileRemoteModel;
|
|
7
9
|
linkedIntegrations?: LinkedIntegrations;
|
|
@@ -21,7 +23,7 @@ type UserLinkedIntegration = {
|
|
|
21
23
|
avatarUrl?: string;
|
|
22
24
|
customUrl?: string;
|
|
23
25
|
};
|
|
24
|
-
export type UserTransportModel = Pick<User, "id" | "email"> & {
|
|
26
|
+
export type UserTransportModel = Pick<User, "id" | "email" | "source"> & {
|
|
25
27
|
createdAt: string;
|
|
26
28
|
profile: UserProfileTransportModel;
|
|
27
29
|
linkedIntegrations?: LinkedIntegrations;
|
|
@@ -38,6 +40,8 @@ export declare class User {
|
|
|
38
40
|
createdAt: Date | null;
|
|
39
41
|
/** User profile */
|
|
40
42
|
profile: UserProfile;
|
|
43
|
+
/** Source of user account */
|
|
44
|
+
source: UserSource | null;
|
|
41
45
|
/** Linked integrations */
|
|
42
46
|
linkedIntegrations: LinkedIntegrations | null;
|
|
43
47
|
constructor(model: UserRemoteModel);
|
|
@@ -1,7 +1,12 @@
|
|
|
1
|
-
export
|
|
2
|
-
export
|
|
3
|
-
export
|
|
4
|
-
export
|
|
1
|
+
export declare const UserOnboardingDepartments: readonly ["Design", "Product", "Engineering", "Brand", "Other"];
|
|
2
|
+
export type UserOnboardingDepartment = (typeof UserOnboardingDepartments)[number];
|
|
3
|
+
export declare const UserOnboardingJobLevels: readonly ["Executive", "Manager", "IndividualContributor", "Other"];
|
|
4
|
+
export type UserOnboardingJobLevel = (typeof UserOnboardingJobLevels)[number];
|
|
5
|
+
export declare const UserOnboardingCompanySizes: readonly ["Just me", "2 - 49", "50 - 249", "250 - 999", "1,000 - 4,999", "5,000 - 9,999", "More than 10,000"];
|
|
6
|
+
export type UserOnboardingCompanySize = (typeof UserOnboardingCompanySizes)[number];
|
|
7
|
+
export declare const UserOnboardingDesignSystemTeamSizes: readonly ["We don’t have a design system team", "Only one person", "2 - 5", "6 - 10", "More than 10"];
|
|
8
|
+
export type UserOnboardingDesignSystemTeamSize = (typeof UserOnboardingDesignSystemTeamSizes)[number];
|
|
9
|
+
export type UserOnboardingDefaultDestination = "tokens" | "docs";
|
|
5
10
|
export type UserProfileRemoteModel = {
|
|
6
11
|
name?: string;
|
|
7
12
|
nickname?: string;
|
|
@@ -11,12 +16,15 @@ export type UserProfileRemoteModel = {
|
|
|
11
16
|
};
|
|
12
17
|
export type UserProfileOnboardingRemoteModel = {
|
|
13
18
|
companyName?: string;
|
|
14
|
-
numberOfPeopleInOrg?:
|
|
15
|
-
numberOfPeopleInDesignTeam?:
|
|
16
|
-
department?:
|
|
19
|
+
numberOfPeopleInOrg?: UserOnboardingCompanySize;
|
|
20
|
+
numberOfPeopleInDesignTeam?: UserOnboardingDesignSystemTeamSize;
|
|
21
|
+
department?: UserOnboardingDepartment;
|
|
17
22
|
jobTitle?: string;
|
|
18
23
|
phase?: string;
|
|
19
|
-
jobLevel?:
|
|
24
|
+
jobLevel?: UserOnboardingJobLevel;
|
|
25
|
+
designSystemName?: string;
|
|
26
|
+
figmaUrl?: string;
|
|
27
|
+
defaultDestination?: UserOnboardingDefaultDestination;
|
|
20
28
|
};
|
|
21
29
|
export type UserProfileTransportModel = UserProfileRemoteModel;
|
|
22
30
|
export type UserProfileOnboardingUpdateModel = UserProfileOnboardingRemoteModel;
|
|
@@ -37,12 +45,15 @@ export declare class UserProfile {
|
|
|
37
45
|
/** Onboarding object */
|
|
38
46
|
onboarding: {
|
|
39
47
|
companyName: string | null;
|
|
40
|
-
numberOfPeopleInOrg:
|
|
41
|
-
numberOfPeopleInDesignTeam:
|
|
42
|
-
department:
|
|
48
|
+
numberOfPeopleInOrg: UserOnboardingCompanySize | null;
|
|
49
|
+
numberOfPeopleInDesignTeam: UserOnboardingDesignSystemTeamSize | null;
|
|
50
|
+
department: UserOnboardingDepartment | null;
|
|
43
51
|
jobTitle: string | null;
|
|
44
52
|
phase: string | null;
|
|
45
|
-
jobLevel:
|
|
53
|
+
jobLevel: UserOnboardingJobLevel | null;
|
|
54
|
+
designSystemName: string | null;
|
|
55
|
+
figmaUrl: string | null;
|
|
56
|
+
defaultDestination: UserOnboardingDefaultDestination | null;
|
|
46
57
|
} | null;
|
|
47
58
|
constructor(model: UserProfileRemoteModel);
|
|
48
59
|
/** Constructs directly manipulable update object for user profile */
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
export type LiveblocksNotificationSettings = {
|
|
2
|
+
sendCommentNotificationEmails: boolean;
|
|
3
|
+
};
|
|
4
|
+
export type UserWorkspaceNotificationSettingsRemoteModel = {
|
|
5
|
+
liveblocksNotificationSettings: LiveblocksNotificationSettings;
|
|
6
|
+
};
|
|
7
|
+
export type UserWorkspaceNotificationSettingsUpdateModel = UserWorkspaceNotificationSettingsRemoteModel;
|
|
8
|
+
export declare class UserWorkspaceNotificationSettings {
|
|
9
|
+
liveblocksNotificationSettings: LiveblocksNotificationSettings;
|
|
10
|
+
constructor(model: UserWorkspaceNotificationSettingsRemoteModel);
|
|
11
|
+
static initial(): UserWorkspaceNotificationSettings;
|
|
12
|
+
toUpdateObject(): UserWorkspaceNotificationSettingsUpdateModel;
|
|
13
|
+
toRemote(): UserWorkspaceNotificationSettingsRemoteModel;
|
|
14
|
+
toTransport(): UserWorkspaceNotificationSettingsRemoteModel;
|
|
15
|
+
static fromTransport(model: UserWorkspaceNotificationSettingsRemoteModel): UserWorkspaceNotificationSettings;
|
|
16
|
+
}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
|
+
import { DTOIntegrationCredentials } from "@supernova-studio/client";
|
|
1
2
|
import { OAuth2IntegrationTypes } from "./SDKWorkspaceIntegrationOauthRequest";
|
|
2
3
|
export type WorkspaceIntegrationsRemoteModel = {
|
|
3
4
|
integrations: Array<WorkspaceIntegrationType>;
|
|
5
|
+
hasFigmaIntegration: boolean;
|
|
4
6
|
};
|
|
5
7
|
export type WorkspaceLinkedIntegrations = {
|
|
6
8
|
Figma?: WorkspaceIntegrationType[];
|
|
@@ -11,36 +13,17 @@ export type WorkspaceLinkedIntegrations = {
|
|
|
11
13
|
Azure?: WorkspaceIntegrationType[];
|
|
12
14
|
Bitbucket?: WorkspaceIntegrationType[];
|
|
13
15
|
};
|
|
14
|
-
type
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
email: string;
|
|
19
|
-
};
|
|
20
|
-
type WorkspaceIntegrationUser = {
|
|
21
|
-
id: string;
|
|
22
|
-
email: string;
|
|
23
|
-
name: string;
|
|
24
|
-
avatar?: string;
|
|
25
|
-
};
|
|
26
|
-
type WorkspaceIntegrationCredential = {
|
|
27
|
-
id: string;
|
|
28
|
-
integrationId: number;
|
|
29
|
-
userId: string;
|
|
30
|
-
createdAt: string;
|
|
31
|
-
accessToken: string;
|
|
32
|
-
refreshToken: string;
|
|
33
|
-
type: "OAuth2" | "PAT" | "GithubApp";
|
|
34
|
-
tokenName?: string;
|
|
35
|
-
profile: WorkspaceIntegrationCredentialProfile;
|
|
36
|
-
user: WorkspaceIntegrationUser;
|
|
16
|
+
type WorkspaceIntegrationCredential = DTOIntegrationCredentials & {
|
|
17
|
+
profile: NonNullable<DTOIntegrationCredentials["profile"]>;
|
|
18
|
+
user: NonNullable<DTOIntegrationCredentials["user"]>;
|
|
19
|
+
state: "Active" | "Inactive";
|
|
37
20
|
};
|
|
38
21
|
type WorkspaceIntegrationDesignSystem = {
|
|
39
22
|
brandId: string;
|
|
40
23
|
designSystemId: string;
|
|
41
24
|
date: string;
|
|
42
25
|
title?: string;
|
|
43
|
-
user
|
|
26
|
+
user?: DTOIntegrationCredentials["user"];
|
|
44
27
|
};
|
|
45
28
|
export type WorkspaceIntegrationType = {
|
|
46
29
|
id: string;
|
|
@@ -70,6 +53,7 @@ export declare class WorkspaceIntegration implements WorkspaceIntegrationType {
|
|
|
70
53
|
export declare class WorkspaceIntegrations {
|
|
71
54
|
/** List of integrations of the workspace */
|
|
72
55
|
integrations: Array<WorkspaceIntegrationType>;
|
|
56
|
+
get hasFigmaIntegration(): boolean;
|
|
73
57
|
constructor(model: WorkspaceIntegrationsRemoteModel);
|
|
74
58
|
}
|
|
75
59
|
export {};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
export declare const GitProviderEndpoints: {
|
|
2
|
+
readonly Organizations: "organizations";
|
|
3
|
+
readonly Projects: "projects";
|
|
4
|
+
readonly Repositories: "repositories";
|
|
5
|
+
readonly Branches: "branches";
|
|
6
|
+
};
|
|
7
|
+
export type GitProviderEndpointsKeys = keyof typeof GitProviderEndpoints;
|
|
8
|
+
export type GitProviderValues = (typeof GitProviderEndpoints)[GitProviderEndpointsKeys];
|
|
9
|
+
export type WorkspaceIntegrationGetGitProvidersInput = {
|
|
10
|
+
organization?: string;
|
|
11
|
+
project?: string;
|
|
12
|
+
repository?: string;
|
|
13
|
+
branch?: string;
|
|
14
|
+
user?: string;
|
|
15
|
+
};
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { DTOGitBranch } from "@supernova-studio/client";
|
|
2
|
+
export type GitProviderBranchesRemoteModel = {
|
|
3
|
+
branches: Array<DTOGitBranch>;
|
|
4
|
+
};
|
|
5
|
+
export declare class GitProvidersBranch implements DTOGitBranch {
|
|
6
|
+
name: string;
|
|
7
|
+
lastCommitId: string;
|
|
8
|
+
constructor(model: DTOGitBranch);
|
|
9
|
+
}
|
|
10
|
+
export declare class GitProvidersBranches {
|
|
11
|
+
branches: Array<GitProvidersBranch>;
|
|
12
|
+
constructor(model: GitProviderBranchesRemoteModel);
|
|
13
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { DTOGitOrganization } from "@supernova-studio/client";
|
|
2
|
+
export type GitProvidersOrganizationsRemoteModel = {
|
|
3
|
+
organizations: Array<DTOGitOrganization>;
|
|
4
|
+
};
|
|
5
|
+
export declare class GitProvidersOrganization implements DTOGitOrganization {
|
|
6
|
+
id: string;
|
|
7
|
+
name: string;
|
|
8
|
+
url: string;
|
|
9
|
+
slug: string;
|
|
10
|
+
constructor(model: DTOGitOrganization);
|
|
11
|
+
}
|
|
12
|
+
export declare class GitProvidersOrganizations {
|
|
13
|
+
organizations: Array<GitProvidersOrganization>;
|
|
14
|
+
constructor(model: GitProvidersOrganizationsRemoteModel);
|
|
15
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { DTOGitProject } from "@supernova-studio/client";
|
|
2
|
+
export type GitProvidersProjectsRemoteModel = {
|
|
3
|
+
projects: Array<DTOGitProject>;
|
|
4
|
+
};
|
|
5
|
+
export declare class GitProvidersProject implements DTOGitProject {
|
|
6
|
+
id: string;
|
|
7
|
+
name: string;
|
|
8
|
+
url: string;
|
|
9
|
+
slug: string;
|
|
10
|
+
constructor(model: DTOGitProject);
|
|
11
|
+
}
|
|
12
|
+
export declare class GitProvidersProjects {
|
|
13
|
+
projects: Array<GitProvidersProject>;
|
|
14
|
+
constructor(model: GitProvidersProjectsRemoteModel);
|
|
15
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { DTOGitRepository } from "@supernova-studio/client";
|
|
2
|
+
export type GitProvidersRepositoriesRemoteModel = {
|
|
3
|
+
repositories: Array<DTOGitRepository>;
|
|
4
|
+
};
|
|
5
|
+
export declare class GitProvidersRepository implements DTOGitRepository {
|
|
6
|
+
id: string;
|
|
7
|
+
name: string;
|
|
8
|
+
url: string;
|
|
9
|
+
defaultBranch: string | undefined;
|
|
10
|
+
slug: string;
|
|
11
|
+
constructor(model: DTOGitRepository);
|
|
12
|
+
}
|
|
13
|
+
export declare class GitProvidersRepositories {
|
|
14
|
+
repositories: Array<GitProvidersRepository>;
|
|
15
|
+
constructor(model: GitProvidersRepositoriesRemoteModel);
|
|
16
|
+
}
|
|
@@ -13,6 +13,7 @@ import { DocsBlockComponentPropertyDefinition, DocsBlockComponentPropertyOptions
|
|
|
13
13
|
import { DocsBlockComponentPropertyPropertyDefinition, DocsBlockComponentPropertyPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockComponentPropertyProperty";
|
|
14
14
|
import { DocsBlockDividerPropertyDefinition, DocsBlockDividerPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockDividerProperty";
|
|
15
15
|
import { DocsBlockEmbedUrlPropertyDefinition, DocsBlockEmbedUrlPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty";
|
|
16
|
+
import { DocsBlockFigmaComponentPropertyDefinition, DocsBlockFigmaComponentPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockFigmaComponentProperty";
|
|
16
17
|
import { DocsBlockFigmaNodePropertyDefinition } from "../../model/docs/blocks/properties/SDKDocsBlockFigmaNodeProperty";
|
|
17
18
|
import { DocsBlockImagePropertyDefinition, DocsBlockImagePropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockImageProperty";
|
|
18
19
|
import { DocsBlockMarkdownPropertyDefinition, DocsBlockMarkdownPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockMarkdownProperty";
|
|
@@ -296,6 +297,16 @@ export declare class DocsBlockBuilder {
|
|
|
296
297
|
[key: string]: DocsBlockComponentPropertyPropertyOptions;
|
|
297
298
|
};
|
|
298
299
|
}): DocsBlockComponentPropertyPropertyDefinition;
|
|
300
|
+
/** Create a block property with type .figmaComponentProperty and its specific options */
|
|
301
|
+
figmaComponentProperty(configuration: {
|
|
302
|
+
id: string;
|
|
303
|
+
name: string;
|
|
304
|
+
description?: string;
|
|
305
|
+
options: DocsBlockFigmaComponentPropertyOptions;
|
|
306
|
+
variants?: {
|
|
307
|
+
[key: string]: DocsBlockFigmaComponentPropertyOptions;
|
|
308
|
+
};
|
|
309
|
+
}): DocsBlockFigmaComponentPropertyDefinition;
|
|
299
310
|
/** Create a block property with type .asset and its specific options */
|
|
300
311
|
assetProperty(configuration: {
|
|
301
312
|
id: string;
|
|
@@ -2,11 +2,13 @@ export type TokenUtilPreviewTokenValueSegment = {
|
|
|
2
2
|
value: string;
|
|
3
3
|
referencedName?: string;
|
|
4
4
|
prefersReferenceName?: boolean;
|
|
5
|
+
referenceResolutionFailed?: boolean;
|
|
5
6
|
};
|
|
6
7
|
export type TokenUtilPreviewTokenType = "blur" | "border" | "borderWidth" | "color" | "copy" | "fontFamily" | "fontSize" | "fontWeight" | "dimension" | "duration" | "gradient" | "lineHeight" | "letterSpacing" | "opacity" | "paragraphSpacing" | "radius" | "shadow" | "size" | "space" | "string" | "textCase" | "textDecoration" | "typography" | "visibility" | "zIndex";
|
|
7
8
|
export type TokenUtilPreviewMetadata = {
|
|
8
9
|
displayValue: string;
|
|
9
10
|
referencedTo?: string;
|
|
11
|
+
referenceResolutionFailed?: boolean;
|
|
10
12
|
tokenType: TokenUtilPreviewTokenType;
|
|
11
13
|
} & ({
|
|
12
14
|
meta?: null;
|