@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
@@ -5,3 +5,4 @@ export declare enum UserRole {
5
5
  viewer = "Viewer",
6
6
  billing = "Billing"
7
7
  }
8
+ export type UserRoleWithoutOwner = Exclude<UserRole, UserRole.owner>;
@@ -1,4 +1,4 @@
1
- export declare enum WorkspaceSubscriptionProduct {
1
+ export declare enum WorkspaceSubscriptionProductCode {
2
2
  /** The workspace is on free tier */
3
3
  free = "free",
4
4
  /** The workspace is on team tier */
@@ -1,18 +1,10 @@
1
1
  export declare enum WorkspaceSubscriptionStatus {
2
- /** The subscription is in trial period */
3
- trialing = "trialing",
4
2
  /** The subscription is active */
5
3
  active = "active",
6
- /** The subscription is past due */
7
- pastDue = "past_due",
8
- /** The subscription is canceled */
9
- canceled = "canceled",
10
- /** The subscription is unpaid */
11
- unpaid = "unpaid",
12
- /** The subscription is incomplete expired */
13
- incompleteExpired = "incomplete_expired",
14
- /** The subscription is incomplete */
15
- incomplete = "incomplete",
16
- /** The subscription status is unknown */
17
- unknown = "unknown"
4
+ /** The subscription is on a grace period */
5
+ gracePeriod = "gracePeriod",
6
+ /** The subscription is cancelled */
7
+ cancelled = "cancelled",
8
+ /** The subscription is suspended */
9
+ suspended = "suspended"
18
10
  }
@@ -0,0 +1,9 @@
1
+ import { CodegenAccountRemoteModel } from "./remote/SDKRemoteCodegenAccountModel";
2
+ export declare class CodegenAccount {
3
+ id: string;
4
+ accountType: "User" | "Organization";
5
+ handle: string;
6
+ installationUrl: string;
7
+ description?: string;
8
+ constructor(data: CodegenAccountRemoteModel);
9
+ }
@@ -0,0 +1,7 @@
1
+ import { CodegenAzureBranchRemoteModel } from "./remote/SDKRemoteAzureCodegenBranchModel";
2
+ export declare class CodegenAzureBranch {
3
+ name: string;
4
+ lastCommitId: string;
5
+ repositoryId: string;
6
+ constructor(data: CodegenAzureBranchRemoteModel);
7
+ }
@@ -0,0 +1,7 @@
1
+ import { CodegenAzureOrganizationRemoteModel } from "./remote/SDKRemoteAzureCodegenOrganizationModel";
2
+ export declare class CodegenAzureOrganization {
3
+ id: number;
4
+ name: string;
5
+ uri: string;
6
+ constructor(data: CodegenAzureOrganizationRemoteModel);
7
+ }
@@ -0,0 +1,7 @@
1
+ import { CodegenAzureProjectRemoteModel } from "./remote/SDKRemoteAzureCodegenProjectModel";
2
+ export declare class CodegenAzureProject {
3
+ id: number;
4
+ name: string;
5
+ organizationId: string;
6
+ constructor(data: CodegenAzureProjectRemoteModel);
7
+ }
@@ -0,0 +1,11 @@
1
+ import { CodegenAzureRepositoryRemoteModel } from "./remote/SDKRemoteAzureCodegenRepositoryModel";
2
+ export declare class CodegenAzureRepository {
3
+ id: string;
4
+ name: string;
5
+ projectId: string;
6
+ forked: boolean;
7
+ defaultBranch?: string;
8
+ required: boolean;
9
+ url: string;
10
+ constructor(data: CodegenAzureRepositoryRemoteModel);
11
+ }
@@ -0,0 +1,7 @@
1
+ import { CodegenBitbucketBranchRemoteModel } from "./remote/SDKRemoteBitbucketCodegenBranchModel";
2
+ export declare class CodegenBitbucketBranch {
3
+ name: string;
4
+ lastCommitId: string;
5
+ repoSlug: string;
6
+ constructor(data: CodegenBitbucketBranchRemoteModel);
7
+ }
@@ -0,0 +1,6 @@
1
+ import { CodegenBitbucketProjectRemoteModel } from "./remote/SDKRemoteBitbucketCodegenProjectModel";
2
+ export declare class CodegenBitbucketProject {
3
+ key: string;
4
+ name: string;
5
+ constructor(data: CodegenBitbucketProjectRemoteModel);
6
+ }
@@ -0,0 +1,8 @@
1
+ import { CodegenBitbucketRepositoryRemoteModel } from "./remote/SDKRemoteBitbucketCodegenRepositoryModel";
2
+ export declare class CodegenBitbucketRepository {
3
+ slug: string;
4
+ name: string;
5
+ projectKey: string;
6
+ url: string;
7
+ constructor(data: CodegenBitbucketRepositoryRemoteModel);
8
+ }
@@ -0,0 +1,6 @@
1
+ import { CodegenBitbucketWorkspaceRemoteModel } from "./remote/SDKRemoteBitbucketCodegenWorkspaceModel";
2
+ export declare class CodegenBitbucketWorkspace {
3
+ slug: string;
4
+ name: string;
5
+ constructor(data: CodegenBitbucketWorkspaceRemoteModel);
6
+ }
@@ -0,0 +1,8 @@
1
+ import { CodegenBranchRemoteModel } from "./remote/SDKRemoteCodegenBranchModel";
2
+ export declare class CodegenBranch {
3
+ repository: string;
4
+ name: string;
5
+ lastCommitId: string;
6
+ protected: boolean;
7
+ constructor(data: CodegenBranchRemoteModel);
8
+ }
@@ -0,0 +1,10 @@
1
+ import { CodegenConnectionRemoteModel } from "./remote/SDKRemoteCodegenConnectionModel";
2
+ export declare class CodegenConnection {
3
+ id: string;
4
+ ownerId: string;
5
+ customUrl: string;
6
+ name: string;
7
+ authType: string;
8
+ service: string;
9
+ constructor(data: CodegenConnectionRemoteModel);
10
+ }
@@ -0,0 +1,7 @@
1
+ import { CodegenGitlabBranchRemoteModel } from "./remote/SDKRemoteGitlabCodegenBranchModel";
2
+ export declare class CodegenGitlabBranch {
3
+ name: string;
4
+ lastCommitId: string;
5
+ repositoryId: string;
6
+ constructor(data: CodegenGitlabBranchRemoteModel);
7
+ }
@@ -0,0 +1,6 @@
1
+ import { CodegenGitlabGroupRemoteModel } from "./remote/SDKRemoteGitlabCodegenGroupModel";
2
+ export declare class CodegenGitlabGroup {
3
+ id: number;
4
+ name: string;
5
+ constructor(data: CodegenGitlabGroupRemoteModel);
6
+ }
@@ -0,0 +1,9 @@
1
+ import { CodegenGitlabRepositoryRemoteModel } from "./remote/SDKRemoteGitlabCodegenRepositoryModel";
2
+ export declare class CodegenGitlabRepository {
3
+ id: number;
4
+ name: string;
5
+ defaultBranch: string;
6
+ url: string;
7
+ cloneUrl: string;
8
+ constructor(data: CodegenGitlabRepositoryRemoteModel);
9
+ }
@@ -0,0 +1,15 @@
1
+ import { CodegenRepositoryRemoteModel } from "./remote/SDKRemoteCodegenRepositoryModel";
2
+ export declare class CodegenRepository {
3
+ id: number;
4
+ owner: string;
5
+ name: string;
6
+ fullName: string;
7
+ url: string;
8
+ description: string;
9
+ archived: boolean;
10
+ disabled: boolean;
11
+ forked: boolean;
12
+ private: boolean;
13
+ defaultBranch: string;
14
+ constructor(data: CodegenRepositoryRemoteModel);
15
+ }
@@ -0,0 +1,8 @@
1
+ export type PersonalAccessTokenConnectionPayload = {
2
+ customUrl?: string | undefined;
3
+ token: string;
4
+ name: string;
5
+ };
6
+ export type AzurePersonalAccessTokenConnectionPayload = PersonalAccessTokenConnectionPayload & {
7
+ organization: string;
8
+ };
@@ -7,6 +7,7 @@ export type ExporterModel = {
7
7
  isPrivate: boolean;
8
8
  isDefaultDocumentationExporter: boolean;
9
9
  usesBrands: boolean;
10
+ usesThemes?: boolean;
10
11
  name: string;
11
12
  description: string;
12
13
  version: string;
@@ -16,12 +17,14 @@ export type ExporterModel = {
16
17
  readme: string;
17
18
  iconURL?: string;
18
19
  tags: Array<string>;
19
- githubUrl: string;
20
- githubBranch?: string;
21
- githubDirectory?: string;
20
+ gitProvider: "github" | "gitlab" | "bitbucket" | "azure";
21
+ gitUrl: string;
22
+ gitBranch: string;
23
+ gitDirectory: string;
22
24
  blockVariants?: object;
23
25
  configurationProperties?: Array<ExporterConfigurationPropertyModel>;
24
26
  customBlocks?: Array<ExporterCustomBlockModel>;
27
+ exporterType: "code" | "documentation";
25
28
  };
26
29
  export declare class Exporter {
27
30
  /** Unique exporter installation id. This id is used to referenced exporter within Supernova system (for example, in ds.documentationExporterId) */
@@ -34,6 +37,8 @@ export declare class Exporter {
34
37
  isDefaultDocumentationExporter: boolean;
35
38
  /** If true, this exporter uses branding functionality */
36
39
  usesBrands: boolean;
40
+ /** If true, this exporter uses branding functionality */
41
+ usesThemes: boolean | null;
37
42
  /** Exporter human-readable name */
38
43
  name: string;
39
44
  /** Exporter human-readable description */
@@ -52,15 +57,14 @@ export declare class Exporter {
52
57
  iconURL: string | null;
53
58
  /** Exporter feature tags, such as iOS, React, token, styles, components etc. */
54
59
  tags: Array<string>;
55
- /** Original location of the package, usually a github repository */
56
- origin: {
57
- /** URL of the repository containing the exporter package */
58
- repositoryUrl: string;
59
- /** Branch of the repository containing the exporter package. If not provided, exporter is located at the default branch */
60
- repositoryBranch: string | null;
61
- /** Root directory in the repository containing the exporter package. If not provided, exporter is located at the root directory */
62
- repositoryDirectory: string | null;
63
- };
60
+ exporterType: "code" | "documentation";
61
+ gitProvider: "github" | "gitlab" | "bitbucket" | "azure";
62
+ /** URL of the repository containing the exporter package */
63
+ gitUrl: string;
64
+ /** Branch of the repository containing the exporter package. If not provided, exporter is located at the default branch */
65
+ gitBranch: string | null;
66
+ /** Root directory in the repository containing the exporter package. If not provided, exporter is located at the root directory */
67
+ gitDirectory: string | null;
64
68
  /** Contribution of this exporter to the Supernova system */
65
69
  contributes: {
66
70
  /** DocumentationLegacy block variants */
@@ -0,0 +1,113 @@
1
+ import { ExportBuild } from "./exporter_builds/SDKExportBuild";
2
+ import { PipelineRemoteModel } from "./remote/SDKRemotePipelineModel";
3
+ export type GithubDestinationPayload = {
4
+ connectionId: string;
5
+ branch: string;
6
+ relativePath: string;
7
+ url: string;
8
+ };
9
+ export type AzureDestinationPayload = {
10
+ connectionId: string;
11
+ organizationId: string;
12
+ projectId: string;
13
+ repositoryId: string;
14
+ branch: string;
15
+ relativePath: string;
16
+ };
17
+ export type BitbucketDestinationPayload = {
18
+ connectionId: string;
19
+ workspaceSlug: string;
20
+ projectKey: string;
21
+ repoSlug: string;
22
+ branch: string;
23
+ relativePath: string;
24
+ };
25
+ export type GitlabDestinationPayload = {
26
+ connectionId: string;
27
+ projectId: string;
28
+ branch: string;
29
+ relativePath: string;
30
+ };
31
+ export type DocumentationDestinationPayload = {
32
+ environment: "Live" | "Preview";
33
+ };
34
+ export type NewPipelinePayload = {
35
+ brandId?: string;
36
+ themeId?: string;
37
+ designSystemId: string;
38
+ destinations: {
39
+ azure: AzureDestinationPayload | null;
40
+ bitbucket: BitbucketDestinationPayload | null;
41
+ documentation: DocumentationDestinationPayload | null;
42
+ github: GithubDestinationPayload | null;
43
+ gitlab: GitlabDestinationPayload | null;
44
+ s3: Record<string, any>;
45
+ webhookUrl: null;
46
+ };
47
+ eventType: "OnHeadChanged" | "OnSourceUpdated" | "OnVersionReleased" | "None";
48
+ exporterId: string;
49
+ isEnabled: boolean;
50
+ name: string;
51
+ };
52
+ export type PipelineUpdateModel = Omit<PipelineRemoteModel, "latestJobs" | "workspaceId" | "designSystem">;
53
+ export declare class Pipeline {
54
+ id: string;
55
+ workspaceId: string;
56
+ designSystem: {
57
+ id: string;
58
+ meta: {
59
+ name: string;
60
+ description: string;
61
+ };
62
+ };
63
+ name: string;
64
+ isEnabled: boolean;
65
+ eventType: "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
66
+ exporterId: string;
67
+ destinations: {
68
+ webhookUrl: string | null;
69
+ documentation: {
70
+ environment: "Live" | "Preview";
71
+ } | null;
72
+ s3: Record<any, any> | null;
73
+ github: {
74
+ connectionId: string;
75
+ url: string;
76
+ branch: string;
77
+ relativePath: string;
78
+ } | null;
79
+ azure: {
80
+ connectionId: string;
81
+ organizationId: string;
82
+ projectId: string;
83
+ repositoryId: string;
84
+ branch: string;
85
+ relativePath: string;
86
+ url: string;
87
+ } | null;
88
+ gitlab: {
89
+ connectionId: string;
90
+ projectId: string;
91
+ branch: string;
92
+ relativePath: string;
93
+ url: string;
94
+ } | null;
95
+ bitbucket: {
96
+ connectionId: string;
97
+ workspaceSlug: string;
98
+ projectKey: string;
99
+ repoSlug: string;
100
+ branch: string;
101
+ relativePath: string;
102
+ url: string;
103
+ } | null;
104
+ };
105
+ brandId: string | null;
106
+ themeId: string | null;
107
+ latestJobs: Array<ExportBuild>;
108
+ constructor(data: PipelineRemoteModel);
109
+ get isBuildOnly(): boolean;
110
+ get gitProviderType(): "github" | "bitbucket" | "gitlab" | "azure" | null;
111
+ get toRemoteModel(): PipelineRemoteModel;
112
+ get isRunning(): boolean;
113
+ }
@@ -0,0 +1,104 @@
1
+ import { ExportBuildResult } from "./SDKExportBuildResults";
2
+ import { ExportDestinations } from "./SDKExportDestinations";
3
+ export type ExportBuildCreatedByModel = {
4
+ userId: string;
5
+ userName: string | null;
6
+ };
7
+ export declare class ExportBuildCreatedBy {
8
+ userId: string;
9
+ userName: string | null;
10
+ constructor(data: ExportBuildCreatedByModel);
11
+ }
12
+ /**
13
+ * The enum representing possible statuses of an export build.
14
+ * @enum {string}
15
+ */
16
+ export declare enum ExportBuildStatus {
17
+ InProgress = "InProgress",
18
+ Success = "Success",
19
+ Failed = "Failed",
20
+ Timeout = "Timeout"
21
+ }
22
+ export type ExportBuildModel = {
23
+ index: number | null;
24
+ id: string;
25
+ createdAt: string;
26
+ finishedAt: string | null;
27
+ designSystem: {
28
+ id: string;
29
+ meta: {
30
+ name: string;
31
+ description: string;
32
+ };
33
+ };
34
+ designSystemVersion: {
35
+ id: string;
36
+ meta: {
37
+ name: string;
38
+ description: string;
39
+ };
40
+ version: string;
41
+ isReadonly: boolean;
42
+ };
43
+ result: ExportBuildResult | null;
44
+ status: ExportBuildStatus;
45
+ estimatedExecutionTime: number | null;
46
+ createdBy: ExportBuildCreatedBy | null;
47
+ destinations: ExportDestinations;
48
+ scheduleId: string | null;
49
+ exporterId: string;
50
+ };
51
+ /** Build run entry */
52
+ export declare class ExportBuild {
53
+ /** The index of the export build, or null if not provided */
54
+ index: number | null;
55
+ /** The unique identifier for the export build */
56
+ id: string;
57
+ /** The date and time when the export build was created */
58
+ createdAt: Date;
59
+ /** The date and time when the export build was finished, or null if not finished yet */
60
+ finishedAt: Date | null;
61
+ /** The design system associated with the export build */
62
+ designSystem: {
63
+ id: string;
64
+ meta: {
65
+ name: string;
66
+ description: string;
67
+ };
68
+ };
69
+ /** The version of the design system used in the export build */
70
+ designSystemVersion: {
71
+ id: string;
72
+ meta: {
73
+ name: string;
74
+ description: string;
75
+ };
76
+ version: string;
77
+ isReadonly: boolean;
78
+ };
79
+ /** The result of the export build, or null if not available */
80
+ result: ExportBuildResult | null;
81
+ /** The status of the export build */
82
+ status: ExportBuildStatus;
83
+ /** The estimated execution time for the export build, or null if not available */
84
+ estimatedExecutionTime: number | null;
85
+ /** The user who created the export build, or null if not available */
86
+ createdBy: ExportBuildCreatedBy | null;
87
+ /** The destinations associated with the export build */
88
+ destinations: ExportDestinations;
89
+ /** The identifier of the hook associated with the export build, or null if not available */
90
+ scheduleId: string | null;
91
+ /** The identifier of the exporter associated with the export build */
92
+ exporterId: string;
93
+ constructor(data: ExportBuildModel);
94
+ /**
95
+ * Gets the URL for downloading the code generated by the export build.
96
+ * @returns {string|null} - The URL for downloading the code, or null if not available.
97
+ */
98
+ get downloadCodeUrl(): string | null;
99
+ /**
100
+ * Gets the URL for the pull request associated with the export build.
101
+ * @returns {string|null} - The URL for the pull request, or null if not available.
102
+ */
103
+ get pullRequestUrl(): string | null;
104
+ }
@@ -0,0 +1,72 @@
1
+ export type S3ExportBuildResultModel = {
2
+ urls: Array<string>;
3
+ url: string;
4
+ };
5
+ /** The type definition for the data model of an S3 export build result. */
6
+ export declare class S3ExportBuildResult {
7
+ /** An array of URLs associated with the export build result */
8
+ urls: Array<string>;
9
+ /** A URL associated with the export build result */
10
+ url: string;
11
+ constructor(data: S3ExportBuildResultModel);
12
+ }
13
+ export type ExportBuildPullRequestResultModel = {
14
+ pullRequestUrl: string;
15
+ };
16
+ /** The type definition for the data model of an export build pull request result. */
17
+ export declare class ExportBuildPullRequestResult {
18
+ /** The URL of the pull request associated with the export build result. */
19
+ pullRequestUrl: string;
20
+ constructor(data: ExportBuildPullRequestResultModel);
21
+ }
22
+ /**
23
+ * The enum representing possible types of export build result logs.
24
+ * @enum {string}
25
+ */
26
+ export declare enum ExportBuildResultLogType {
27
+ success = "success",
28
+ info = "info",
29
+ warning = "warning",
30
+ user = "user",
31
+ error = "error"
32
+ }
33
+ export type ExportBuildResultLogModel = {
34
+ time: string;
35
+ type: ExportBuildResultLogType;
36
+ message: string;
37
+ };
38
+ export declare class ExportBuildResultLog {
39
+ /** The time when the log entry was created */
40
+ time: Date;
41
+ /** The type of the log entry */
42
+ type: ExportBuildResultLogType;
43
+ /** The message of the log entry */
44
+ message: string;
45
+ constructor(data: ExportBuildResultLogModel);
46
+ }
47
+ export type ExportBuildResultModel = {
48
+ logs: Array<ExportBuildResultLog>;
49
+ s3: S3ExportBuildResult | null;
50
+ azure: ExportBuildPullRequestResult | null;
51
+ bitbucket: ExportBuildPullRequestResult | null;
52
+ github: ExportBuildPullRequestResult | null;
53
+ gitlab: ExportBuildPullRequestResult | null;
54
+ error: string | null;
55
+ };
56
+ export declare class ExportBuildResult {
57
+ /** An array of log entries associated with the export build result */
58
+ logs: Array<ExportBuildResultLog>;
59
+ /** The S3 export build result, or null if not available */
60
+ s3: S3ExportBuildResult | null;
61
+ /** The Azure export build pull request result, or null if not available */
62
+ azure: ExportBuildPullRequestResult | null;
63
+ /** The Bitbucket export build pull request result, or null if not available */
64
+ bitbucket: ExportBuildPullRequestResult | null;
65
+ /** The GitHub export build pull request result, or null if not available */
66
+ github: ExportBuildPullRequestResult | null;
67
+ /** The GitLab export build pull request result, or null if not available */
68
+ gitlab: ExportBuildPullRequestResult | null;
69
+ /** The error message, or null if not available */
70
+ error: string | null;
71
+ constructor(data: ExportBuildResultModel);
72
+ }
@@ -0,0 +1,111 @@
1
+ export type S3ExportDestinationModel = {
2
+ url: string | null;
3
+ };
4
+ /**
5
+ * Type definition for the data model of an S3 export destination.
6
+ * @typedef {Object} S3ExportDestinationModel
7
+ * @property {string|null} url - The URL of the S3 export destination or null.
8
+ */
9
+ export declare class S3ExportDestination {
10
+ url: string | null;
11
+ constructor(data: S3ExportDestinationModel);
12
+ }
13
+ export type AzureExportDestinationModel = {
14
+ connectionId: string | null;
15
+ organizationId: string;
16
+ projectId: string;
17
+ repositoryId: string;
18
+ branch: string;
19
+ relativePath: string;
20
+ url: string | null;
21
+ };
22
+ export declare class AzureExportDestination {
23
+ connectionId: string | null;
24
+ organizationId: string;
25
+ projectId: string;
26
+ repositoryId: string;
27
+ branch: string;
28
+ relativePath: string;
29
+ url: string | null;
30
+ constructor(data: AzureExportDestinationModel);
31
+ }
32
+ export type BitbucketExportDestinationModel = {
33
+ connectionId: string | null;
34
+ workspaceSlug: string;
35
+ projectKey: string;
36
+ repoSlug: string;
37
+ branch: string;
38
+ relativePath: string;
39
+ url: string | null;
40
+ };
41
+ export declare class BitbucketExportDestination {
42
+ connectionId: string | null;
43
+ workspaceSlug: string;
44
+ projectKey: string;
45
+ repoSlug: string;
46
+ branch: string;
47
+ relativePath: string;
48
+ url: string | null;
49
+ constructor(data: BitbucketExportDestinationModel);
50
+ }
51
+ export type GithubExportDestinationModel = {
52
+ connectionId: string | null;
53
+ url: string;
54
+ branch: string;
55
+ relativePath: string;
56
+ };
57
+ export declare class GithubExportDestination {
58
+ connectionId: string | null;
59
+ url: string;
60
+ branch: string;
61
+ relativePath: string;
62
+ constructor(data: GithubExportDestinationModel);
63
+ }
64
+ export type GitlabExportDestinationModel = {
65
+ connectionId: string | null;
66
+ repositoryId: string;
67
+ branch: string;
68
+ relativePath: string;
69
+ url: string | null;
70
+ };
71
+ export declare class GitlabExportDestination {
72
+ connectionId: string | null;
73
+ repositoryId: string;
74
+ branch: string;
75
+ relativePath: string;
76
+ url: string | null;
77
+ constructor(data: GitlabExportDestinationModel);
78
+ }
79
+ export type ExportDestinationsModel = {
80
+ s3: S3ExportDestination | null;
81
+ azure: AzureExportDestination | null;
82
+ bitbucket: BitbucketExportDestination | null;
83
+ github: GithubExportDestination | null;
84
+ gitlab: GitlabExportDestination | null;
85
+ webhookUrl: string | null;
86
+ };
87
+ /**
88
+ * Type definition for the data model of export destinations.
89
+ * @typedef {Object} ExportDestinationsModel
90
+ * @property {S3ExportDestination|null} s3 - The S3 export destination, or null if not available.
91
+ * @property {AzureExportDestination|null} azure - The Azure export destination, or null if not available.
92
+ * @property {BitbucketExportDestination|null} bitbucket - The Bitbucket export destination, or null if not available.
93
+ * @property {GithubExportDestination|null} github - The Github export destination, or null if not available.
94
+ * @property {GitlabExportDestination|null} gitlab - The Gitlab export destination, or null if not available.
95
+ * // @property {any|null} documentation - The documentation associated with the export destinations, or null if not available. Uncomment if documentation model is provided.
96
+ * @property {string|null} webhookUrl - The webhook URL associated with the export destinations, or null if not available.
97
+ */
98
+ export declare class ExportDestinations {
99
+ s3: S3ExportDestination | null;
100
+ azure: AzureExportDestination | null;
101
+ bitbucket: BitbucketExportDestination | null;
102
+ github: GithubExportDestination | null;
103
+ gitlab: GitlabExportDestination | null;
104
+ webhookUrl: string | null;
105
+ constructor(data: ExportDestinationsModel);
106
+ /**
107
+ * Determines whether there is a pull request (PR) destination available.
108
+ * @returns {boolean} - Returns true if any of the export destinations (azure, bitbucket, github, gitlab) is available.
109
+ */
110
+ get hasPRDestination(): boolean;
111
+ }
@@ -0,0 +1,5 @@
1
+ export type CodegenAzureBranchRemoteModel = {
2
+ name: string;
3
+ lastCommitId: string;
4
+ repositoryId: string;
5
+ };
@@ -0,0 +1,5 @@
1
+ export type CodegenAzureOrganizationRemoteModel = {
2
+ id: number;
3
+ name: string;
4
+ uri: string;
5
+ };