@supernova-studio/supernova-sdk-beta 2.0.32 → 2.0.36

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 (63) hide show
  1. package/build/sdk-typescript/src/core/SDKSupernova.d.ts +10 -0
  2. package/build/sdk-typescript/src/core/areas/SDKAreaAI.d.ts +34 -0
  3. package/build/sdk-typescript/src/core/areas/SDKAreaAssets.d.ts +7 -4
  4. package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +26 -7
  5. package/build/sdk-typescript/src/core/areas/SDKAreaDesignSystems.d.ts +19 -1
  6. package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +11 -8
  7. package/build/sdk-typescript/src/core/areas/SDKAreaImport.d.ts +16 -0
  8. package/build/sdk-typescript/src/core/areas/SDKAreaRawData.d.ts +84 -0
  9. package/build/sdk-typescript/src/core/areas/SDKAreaResources.d.ts +6 -1
  10. package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +52 -10
  11. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreAIRequests.d.ts +15 -0
  12. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +19 -2
  13. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +416 -9
  14. package/build/sdk-typescript/src/core/resolvers/SDKDesignComponentGroupResolver.d.ts +5 -0
  15. package/build/sdk-typescript/src/core/resolvers/SDKDocsEntityItemResolver.d.ts +212 -0
  16. package/build/sdk-typescript/src/exports.d.ts +21 -2
  17. package/build/sdk-typescript/src/model/assets/SDKAsset.d.ts +24 -1
  18. package/build/sdk-typescript/src/model/base/SDKBrand.d.ts +1 -2
  19. package/build/sdk-typescript/src/model/base/SDKDesignSystemVersionStats.d.ts +11 -0
  20. package/build/sdk-typescript/src/model/components/SDKDesignComponent.d.ts +1 -0
  21. package/build/sdk-typescript/src/model/components/SDKDesignComponentVariant.d.ts +1 -0
  22. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntity.d.ts +6 -5
  23. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityApprovalState.d.ts +2 -2
  24. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityGroup.d.ts +8 -16
  25. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityPage.d.ts +10 -9
  26. package/build/sdk-typescript/src/model/elements/SDKElementProperty.d.ts +4 -0
  27. package/build/sdk-typescript/src/model/elements/SDKElementPropertyOption.d.ts +1 -1
  28. package/build/sdk-typescript/src/model/exporters/SDKExporter.d.ts +15 -0
  29. package/build/sdk-typescript/src/model/exporters/SDKExporterJobDestination.d.ts +36 -0
  30. package/build/sdk-typescript/src/model/exporters/SDKPipeline.d.ts +3 -54
  31. package/build/sdk-typescript/src/model/exporters/custom_properties/SDKExporterPropertyBase.d.ts +11 -0
  32. package/build/sdk-typescript/src/model/exporters/custom_properties/SDKExporterPropertyBoolean.d.ts +7 -0
  33. package/build/sdk-typescript/src/model/exporters/custom_properties/SDKExporterPropertyDefinition.d.ts +6 -0
  34. package/build/sdk-typescript/src/model/exporters/custom_properties/SDKExporterPropertyEnum.d.ts +14 -0
  35. package/build/sdk-typescript/src/model/exporters/custom_properties/SDKExporterPropertyNumber.d.ts +7 -0
  36. package/build/sdk-typescript/src/model/exporters/custom_properties/SDKExporterPropertyObject.d.ts +12 -0
  37. package/build/sdk-typescript/src/model/exporters/custom_properties/SDKExporterPropertyString.d.ts +7 -0
  38. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuildResults.d.ts +2 -2
  39. package/build/sdk-typescript/src/model/groups/SDKAssetGroup.d.ts +4 -0
  40. package/build/sdk-typescript/src/model/groups/SDKDesignComponentGroup.d.ts +7 -0
  41. package/build/sdk-typescript/src/model/support/SDKDesignComponentOrigin.d.ts +15 -1
  42. package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenModel.d.ts +1 -0
  43. package/build/sdk-typescript/src/model/users/SDKUser.d.ts +5 -1
  44. package/build/sdk-typescript/src/model/users/SDKUserProfile.d.ts +17 -0
  45. package/build/sdk-typescript/src/tests/helpers.d.ts +2 -5
  46. package/build/sdk-typescript/src/tests/validators.d.ts +24 -23
  47. package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewSegmentGenerator.d.ts +26 -1
  48. package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewTypes.d.ts +2 -0
  49. package/build/sdk-typescript/src/tools/token-transform/SDKToolsTokenTransform.d.ts +2 -0
  50. package/build/sdk-typescript/src/utils/TokenUtils.d.ts +5 -0
  51. package/build/sdk-typescript/vitest.config-ci.d.ts +2 -0
  52. package/build/sdk-typescript/vitest.config-token-studio.d.ts +2 -0
  53. package/build/sdk-typescript/vitest.config.d.ts +2 -0
  54. package/build/supernova-sdk-typescript.js +1 -1
  55. package/build/supernova-sdk-typescript.js.map +1 -1
  56. package/package.json +3 -3
  57. package/build/sdk-typescript/src/core/resolvers/SDKDocsEntityMultiplayerItemResolver.d.ts +0 -7
  58. package/build/sdk-typescript/src/tests/Tooling/ReadTokens.spec.d.ts +0 -1
  59. package/build/sdk-typescript/src/tests/Tooling/TokensModel.spec.d.ts +0 -1
  60. package/build/sdk-typescript/src/tests/Tooling/ToolDocSearch.spec.d.ts +0 -1
  61. package/build/sdk-typescript/src/tests/Tooling/ToolMarkdownTransform.spec.d.ts +0 -1
  62. /package/build/sdk-typescript/src/tests/Areas/{AreaAssets.spec.d.ts → AreaImport.spec.d.ts} +0 -0
  63. /package/build/sdk-typescript/src/tests/Tooling/{PluginFigmaTokens.spec.d.ts → TokensModel.spec.token-studio.d.ts} +0 -0
@@ -0,0 +1,212 @@
1
+ import { DTODocumentationHierarchyV2 } from "@supernova-studio/client";
2
+ import { DocsEntityGroup } from "../../model/docs/entities/SDKDocsEntityGroup";
3
+ import { DocsEntityPage } from "../../model/docs/entities/SDKDocsEntityPage";
4
+ export declare class DocsEntityItemResolver {
5
+ hashedItems: Map<string, {
6
+ type: "Group";
7
+ id: string;
8
+ persistentId: string;
9
+ designSystemVersionId: string;
10
+ createdAt: Date;
11
+ updatedAt: Date;
12
+ shortPersistentId: string;
13
+ title: string;
14
+ isRoot: boolean;
15
+ childrenIds: string[];
16
+ groupBehavior: "Group" | "Tabs";
17
+ configuration: {
18
+ showSidebar: boolean;
19
+ isPrivate: boolean;
20
+ isHidden: boolean;
21
+ header: {
22
+ description: string;
23
+ alignment: "Center" | "Left";
24
+ backgroundImageScaleType: "AspectFill" | "AspectFit";
25
+ showBackgroundOverlay: boolean;
26
+ showCoverText: boolean;
27
+ backgroundColor?: {
28
+ value: string;
29
+ referencedTokenId?: string | undefined;
30
+ } | null | undefined;
31
+ foregroundColor?: {
32
+ value: string;
33
+ referencedTokenId?: string | undefined;
34
+ } | null | undefined;
35
+ backgroundImageAsset?: {
36
+ type: "FigmaNode" | "Resource";
37
+ resource?: {
38
+ url: string;
39
+ resourceId: string;
40
+ } | undefined;
41
+ figmaNode?: {
42
+ sourceId: string;
43
+ frameReferenceId: string;
44
+ } | undefined;
45
+ } | null | undefined;
46
+ minHeight?: number | null | undefined;
47
+ };
48
+ };
49
+ slug?: string | undefined;
50
+ userSlug?: string | undefined;
51
+ approvalState?: {
52
+ persistentId: string;
53
+ designSystemVersionId: string;
54
+ groupPersistentId: string;
55
+ approvalState: "ReadyForReview" | "ChangesRequested" | "Approved";
56
+ } | undefined;
57
+ draftState?: {
58
+ changeType: "Created";
59
+ } | {
60
+ changeType: "Updated";
61
+ changes: {
62
+ previousTitle?: string | undefined;
63
+ previousConfiguration?: {
64
+ showSidebar: boolean;
65
+ isPrivate: boolean;
66
+ isHidden: boolean;
67
+ header: {
68
+ description: string;
69
+ alignment: "Center" | "Left";
70
+ backgroundImageScaleType: "AspectFill" | "AspectFit";
71
+ showBackgroundOverlay: boolean;
72
+ showCoverText: boolean;
73
+ backgroundColor?: {
74
+ value: string;
75
+ referencedTokenId?: string | undefined;
76
+ } | null | undefined;
77
+ foregroundColor?: {
78
+ value: string;
79
+ referencedTokenId?: string | undefined;
80
+ } | null | undefined;
81
+ backgroundImageAsset?: {
82
+ type: "FigmaNode" | "Resource";
83
+ resource?: {
84
+ url: string;
85
+ resourceId: string;
86
+ } | undefined;
87
+ figmaNode?: {
88
+ sourceId: string;
89
+ frameReferenceId: string;
90
+ } | undefined;
91
+ } | null | undefined;
92
+ minHeight?: number | null | undefined;
93
+ };
94
+ } | undefined;
95
+ previousContentHash?: string | undefined;
96
+ };
97
+ } | {
98
+ changeType: "Deleted";
99
+ deletedAt: Date;
100
+ deletedByUserId: string;
101
+ } | undefined;
102
+ publishMetadata?: {
103
+ lastPublishedByUserId: string;
104
+ lastPublishedAt: Date;
105
+ } | undefined;
106
+ } | {
107
+ path: string;
108
+ type: "Page";
109
+ id: string;
110
+ persistentId: string;
111
+ designSystemVersionId: string;
112
+ createdAt: Date;
113
+ updatedAt: Date;
114
+ shortPersistentId: string;
115
+ title: string;
116
+ configuration: {
117
+ showSidebar: boolean;
118
+ isPrivate: boolean;
119
+ isHidden: boolean;
120
+ header: {
121
+ description: string;
122
+ alignment: "Center" | "Left";
123
+ backgroundImageScaleType: "AspectFill" | "AspectFit";
124
+ showBackgroundOverlay: boolean;
125
+ showCoverText: boolean;
126
+ backgroundColor?: {
127
+ value: string;
128
+ referencedTokenId?: string | undefined;
129
+ } | null | undefined;
130
+ foregroundColor?: {
131
+ value: string;
132
+ referencedTokenId?: string | undefined;
133
+ } | null | undefined;
134
+ backgroundImageAsset?: {
135
+ type: "FigmaNode" | "Resource";
136
+ resource?: {
137
+ url: string;
138
+ resourceId: string;
139
+ } | undefined;
140
+ figmaNode?: {
141
+ sourceId: string;
142
+ frameReferenceId: string;
143
+ } | undefined;
144
+ } | null | undefined;
145
+ minHeight?: number | null | undefined;
146
+ };
147
+ };
148
+ slug?: string | undefined;
149
+ userSlug?: string | undefined;
150
+ approvalState?: {
151
+ designSystemVersionId: string;
152
+ createdAt: Date;
153
+ updatedAt: Date;
154
+ pagePersistentId: string;
155
+ approvalState: "ReadyForReview" | "ChangesRequested" | "Approved";
156
+ updatedByUserId: string;
157
+ } | undefined;
158
+ draftState?: {
159
+ changeType: "Created";
160
+ } | {
161
+ changeType: "Updated";
162
+ changes: {
163
+ previousTitle?: string | undefined;
164
+ previousConfiguration?: {
165
+ showSidebar: boolean;
166
+ isPrivate: boolean;
167
+ isHidden: boolean;
168
+ header: {
169
+ description: string;
170
+ alignment: "Center" | "Left";
171
+ backgroundImageScaleType: "AspectFill" | "AspectFit";
172
+ showBackgroundOverlay: boolean;
173
+ showCoverText: boolean;
174
+ backgroundColor?: {
175
+ value: string;
176
+ referencedTokenId?: string | undefined;
177
+ } | null | undefined;
178
+ foregroundColor?: {
179
+ value: string;
180
+ referencedTokenId?: string | undefined;
181
+ } | null | undefined;
182
+ backgroundImageAsset?: {
183
+ type: "FigmaNode" | "Resource";
184
+ resource?: {
185
+ url: string;
186
+ resourceId: string;
187
+ } | undefined;
188
+ figmaNode?: {
189
+ sourceId: string;
190
+ frameReferenceId: string;
191
+ } | undefined;
192
+ } | null | undefined;
193
+ minHeight?: number | null | undefined;
194
+ };
195
+ } | undefined;
196
+ previousContentHash?: string | undefined;
197
+ };
198
+ } | {
199
+ changeType: "Deleted";
200
+ deletedAt: Date;
201
+ deletedByUserId: string;
202
+ } | undefined;
203
+ publishMetadata?: {
204
+ lastPublishedByUserId: string;
205
+ lastPublishedAt: Date;
206
+ } | undefined;
207
+ liveblocksRoomId?: string | undefined;
208
+ }>;
209
+ resolvedItems: Map<string, DocsEntityGroup | DocsEntityPage>;
210
+ resolveMultiplayerItems(pageDetails: Array<DTODocumentationHierarchyV2["pages"][number]>, groupDetails: Array<DTODocumentationHierarchyV2["groups"][number]>): Array<DocsEntityGroup | DocsEntityPage>;
211
+ private resolveItemsForGroup;
212
+ }
@@ -24,6 +24,7 @@ export type { WorkspaceInvitationUpdateModel } from "./model/workspaces/SDKWorks
24
24
  export { WorkspaceInvoice } from "./model/workspaces/SDKWorkspaceInvoice";
25
25
  export { WorkspaceProduct } from "./model/workspaces/SDKWorkspaceProduct";
26
26
  export { User } from "./model/users/SDKUser";
27
+ export type { UserProfileUpdateModel, UserTheme, } from "./model/users/SDKUserProfile";
27
28
  export { UserProfile, UserOnboardingDepartments, UserOnboardingJobLevels, UserOnboardingCompanySizes, UserOnboardingDesignSystemTeamSizes, type UserOnboardingDepartment, type UserOnboardingJobLevel, type UserOnboardingCompanySize, type UserOnboardingDesignSystemTeamSize, type UserOnboardingDefaultDestination, } from "./model/users/SDKUserProfile";
28
29
  export { UserMembership } from "./model/users/SDKUserMembership";
29
30
  export { Acl } from "./model/acl/SDKAcl";
@@ -40,8 +41,14 @@ export { DesignSystemVersion } from "./model/base/SDKDesignSystemVersion";
40
41
  export type { DesignSystemVersionCreate, DesignSystemVersionUpdateModel, DesignSystemVersionCreationJob, } from "./model/base/SDKDesignSystemVersion";
41
42
  export { Membership } from "./model/membership/SDKMembership";
42
43
  export { Exporter, type NewExporterPayload, type ExporterProvider, } from "./model/exporters/SDKExporter";
44
+ export type { ExporterPropertyDefinition } from "./model/exporters/custom_properties/SDKExporterPropertyDefinition";
45
+ export { ExporterPropertyDefinitionBoolean } from "./model/exporters/custom_properties/SDKExporterPropertyBoolean";
46
+ export { ExporterPropertyDefinitionEnum } from "./model/exporters/custom_properties/SDKExporterPropertyEnum";
47
+ export { ExporterPropertyDefinitionNumber } from "./model/exporters/custom_properties/SDKExporterPropertyNumber";
48
+ export { ExporterPropertyDefinitionObject } from "./model/exporters/custom_properties/SDKExporterPropertyObject";
49
+ export { ExporterPropertyDefinitionString } from "./model/exporters/custom_properties/SDKExporterPropertyString";
43
50
  export { Pipeline } from "./model/exporters/SDKPipeline";
44
- export type { NewPipelinePayload, PipelineUpdateModel, AzureDestinationPayload, GithubDestinationPayload, BitbucketDestinationPayload, GitlabDestinationPayload, DocumentationDestinationPayload, } from "./model/exporters/SDKPipeline";
51
+ export type { AzureDestinationPayload, GithubDestinationPayload, BitbucketDestinationPayload, GitlabDestinationPayload, DocumentationDestinationPayload, ExporterJobDestination, } from "./model/exporters/SDKExporterJobDestination";
45
52
  export type { PersonalAccessTokenConnectionPayload, AzurePersonalAccessTokenConnectionPayload, } from "./model/exporters/SDKConnections";
46
53
  export type { ConnectionRemoteModel } from "./model/exporters/remote/SDKRemoteConnectionsModel";
47
54
  export { ExporterCustomBlock, ExporterCustomBlockMode, } from "./model/exporters/custom_blocks/SDKExporterCustomBlock";
@@ -66,8 +73,9 @@ export { DocsBlockLayout } from "./model/docs/blocks/definition/SDKDocsBlockLayo
66
73
  export { DocsBlockOnboarding } from "./model/docs/blocks/definition/SDKDocsBlockOnboarding";
67
74
  export { DocsBlockVariant } from "./model/docs/blocks/definition/SDKDocsBlockVariant";
68
75
  export { DocsBlockMode } from "./model/enums/SDKDocBlockMode";
69
- export { DocsEntityMultiplayerItemResolver } from "./core/resolvers/SDKDocsEntityMultiplayerItemResolver";
76
+ export { DocsEntityItemResolver } from "./core/resolvers/SDKDocsEntityItemResolver";
70
77
  export { DocsEntity } from "./model/docs/entities/SDKDocsEntity";
78
+ export { DocsEntityGroupBehavior } from "./model/enums/SDKDocsEntityGroupBehavior";
71
79
  export { DocsEntityConfiguration } from "./model/docs/entities/SDKDocsEntityConfiguration";
72
80
  export { DocsEntityDraftChangeType, DocsEntityDraftState, } from "./model/docs/entities/SDKDocsEntityDraftState";
73
81
  export { DocsEntityApprovalState, DocsEntityApprovalStateType, } from "./model/docs/entities/SDKDocsEntityApprovalState";
@@ -189,6 +197,7 @@ export { RichTextSpanAttribute } from "./model/documentation/SDKDocumentationLeg
189
197
  export { AssetGroup } from "./model/groups/SDKAssetGroup";
190
198
  export { DesignComponentGroup } from "./model/groups/SDKDesignComponentGroup";
191
199
  export { TokenGroup } from "./model/groups/SDKTokenGroup";
200
+ export { DesignSystemCollection } from "./model/base/SDKDesignSystemCollection";
192
201
  export { Alignment } from "./model/enums/SDKAlignment";
193
202
  export { AssetFormat } from "./model/enums/SDKAssetFormat";
194
203
  export { AssetScale } from "./model/enums/SDKAssetScale";
@@ -300,3 +309,13 @@ export type { TokenUtilPreviewReferenceInfo, TokenUtilPreviewReferenceInfoPiece,
300
309
  export type { OutputBinaryFile, OutputTextFile, OutputCopyRemoteURLFile, AnyOutputFile, PulsarContext, } from "./pulsar-interfaces";
301
310
  export { OutputFileType, PulsarExecutor } from "./pulsar-interfaces";
302
311
  export { docsImageRefToUrl } from "./model/docs/blocks/support/SDKDocsImageRef";
312
+ export type { SourceRemoteModel } from "./model/support/SDKSource";
313
+ export type { ComponentRemoteModel } from "./model/components/SDKComponent";
314
+ export type { TokenRemoteModel } from "./model/tokens/remote/SDKRemoteTokenModel";
315
+ export type { ComponentGroupRemoteModel } from "./model/groups/SDKComponentGroup";
316
+ export type { TokenGroupRemoteModel } from "./model/groups/SDKTokenGroup";
317
+ export type { DesignComponentRemoteModel } from "./model/components/SDKDesignComponent";
318
+ export type { DesignComponentGroupRemoteModel } from "./model/groups/SDKDesignComponentGroup";
319
+ export type { ElementPropertyRemoteModel } from "./model/elements/SDKElementProperty";
320
+ export type { ElementPropertyValueRemoteModel } from "./model/elements/values/SDKElementPropertyValue";
321
+ export type { ElementDataViewRemoteModel } from "./model/elements/SDKElementDataView";
@@ -1,9 +1,27 @@
1
1
  import { DesignComponentRemoteModel } from "../components/SDKDesignComponent";
2
- import { DesignComponentOrigin } from "../support/SDKDesignComponentOrigin";
2
+ import { DesignComponentOrigin, DesignComponentOriginTransportModel } from "../support/SDKDesignComponentOrigin";
3
3
  import { Source } from "../support/SDKSource";
4
+ export type AssetTransportModel = {
5
+ id: string;
6
+ brandId: string;
7
+ designSystemVersionId: string;
8
+ thumbnailUrl: string | null;
9
+ svgUrl: string | null;
10
+ name: string;
11
+ description: string;
12
+ componentId: string | null;
13
+ previouslyDuplicatedNames: number;
14
+ origin: DesignComponentOriginTransportModel | null;
15
+ createdAt: string;
16
+ updatedAt: string;
17
+ exportProperties: {
18
+ isAsset: boolean;
19
+ };
20
+ };
4
21
  export declare class Asset {
5
22
  id: string;
6
23
  brandId: string;
24
+ designSystemVersionId: string;
7
25
  thumbnailUrl: string | null;
8
26
  svgUrl: string | null;
9
27
  name: string;
@@ -13,5 +31,10 @@ export declare class Asset {
13
31
  origin: DesignComponentOrigin | null;
14
32
  createdAt: Date | null;
15
33
  updatedAt: Date | null;
34
+ isAsset: boolean;
16
35
  constructor(model: DesignComponentRemoteModel, duplicates: number, sources: Array<Source>);
36
+ /** Constructs representation that can be used to transport the instantiated object as JSON */
37
+ toTransport(): AssetTransportModel;
38
+ /** Reconstructs class from the transport model */
39
+ static fromTransport(model: AssetTransportModel): Asset;
17
40
  }
@@ -11,7 +11,7 @@ export type BrandUpdateModel = {
11
11
  name: string;
12
12
  description?: string;
13
13
  };
14
- type BrandTransportModel = Pick<Brand, "idInVersion" | "id" | "designSystemVersionId" | "name" | "description">;
14
+ export type BrandTransportModel = Pick<Brand, "idInVersion" | "id" | "designSystemVersionId" | "name" | "description">;
15
15
  export declare class Brand {
16
16
  /** Unique identifier of the brand in this specific version */
17
17
  idInVersion: string;
@@ -31,4 +31,3 @@ export declare class Brand {
31
31
  /** Reconstructs class from the transport model */
32
32
  static fromTransport(model: BrandTransportModel): Brand;
33
33
  }
34
- export {};
@@ -0,0 +1,11 @@
1
+ import { DTODesignSystemVersionStats } from "@supernova-studio/client";
2
+ export declare class DesignSystemVersionStats {
3
+ tokens: number;
4
+ designSystemComponents: number;
5
+ assets: number;
6
+ documentationPages: number;
7
+ figmaComponents: number;
8
+ constructor(model: DTODesignSystemVersionStats);
9
+ /** Constructs representation that can be used to write full object to remote */
10
+ toRemote(): DTODesignSystemVersionStats;
11
+ }
@@ -8,5 +8,6 @@ export declare class DesignComponent extends DesignComponentBase {
8
8
  componentPropertyDefinitions: DesignComponentPropertyDefinition[] | null;
9
9
  childrenPersistentIds: Array<string> | null;
10
10
  children: Array<DesignComponentVariant> | null;
11
+ isAsset: boolean | null;
11
12
  constructor(model: DesignComponentRemoteModel, sources: Array<Source>);
12
13
  }
@@ -5,5 +5,6 @@ export type DesignComponentRemoteModel = DTOFigmaComponent;
5
5
  export declare class DesignComponentVariant extends DesignComponentBase {
6
6
  variantPropertyValues: Record<string, string> | null;
7
7
  parentComponentPersistentId: string | null;
8
+ isAsset: boolean | null;
8
9
  constructor(model: DesignComponentRemoteModel, sources: Array<Source>);
9
10
  }
@@ -1,8 +1,9 @@
1
- import { DTODocumentationDraftState, DTODocumentationItemConfigurationV2, DTODocumentationPageApprovalState, DTODocumentationPublishMetadata } from "@supernova-studio/client";
1
+ import { DTODocumentationDraftState, DTODocumentationHierarchyV2, DTODocumentationItemConfigurationV2, DTODocumentationPageApprovalState, DTODocumentationPublishMetadata } from "@supernova-studio/client";
2
2
  import { DocsEntityType } from "../../enums/SDKDocsEntityType";
3
3
  import { DocsEntityApprovalState } from "./SDKDocsEntityApprovalState";
4
4
  import { DocsEntityConfiguration } from "./SDKDocsEntityConfiguration";
5
5
  import { DocsEntityDraftState } from "./SDKDocsEntityDraftState";
6
+ import { DocsEntityGroup } from "./SDKDocsEntityGroup";
6
7
  export type DocsEntityModel = {
7
8
  persistentId: string;
8
9
  shortPersistentId: string;
@@ -13,7 +14,7 @@ export type DocsEntityModel = {
13
14
  slug: string;
14
15
  userSlug?: string;
15
16
  path?: string;
16
- configuration: DTODocumentationItemConfigurationV2;
17
+ configuration?: DTODocumentationItemConfigurationV2;
17
18
  createdAt?: string;
18
19
  updatedAt?: string;
19
20
  draftState?: DTODocumentationDraftState;
@@ -29,16 +30,16 @@ export declare class DocsEntity {
29
30
  persistentId: string;
30
31
  type: DocsEntityType;
31
32
  title: string;
32
- configuration: DocsEntityConfiguration;
33
+ configuration: DocsEntityConfiguration | null;
33
34
  slug: string;
34
35
  userSlug: string | null;
35
- relativeUrl: string | null;
36
36
  createdAt: Date | null;
37
+ parent: DocsEntityGroup | null;
37
38
  updatedAt: Date | null;
38
39
  draftState: DocsEntityDraftState | null;
39
40
  isPrivate: boolean;
40
41
  isHidden: boolean;
41
42
  publishMetadata: DocsEntityPublishMetadata | null;
42
43
  approvalState: DocsEntityApprovalState | null;
43
- constructor(model: DocsEntityModel);
44
+ constructor(model: DTODocumentationHierarchyV2["groups"][number] | DTODocumentationHierarchyV2["pages"][number]);
44
45
  }
@@ -1,4 +1,4 @@
1
- import { DTODocumentationPageApprovalState } from "@supernova-studio/client";
1
+ import { DTODocumentationGroupApprovalState, DTODocumentationPageApprovalState } from "@supernova-studio/client";
2
2
  import { DocsEntityDraftState } from "./SDKDocsEntityDraftState";
3
3
  export declare enum DocsEntityApprovalStateType {
4
4
  Draft = "Draft",
@@ -10,5 +10,5 @@ export declare enum DocsEntityApprovalStateType {
10
10
  export declare class DocsEntityApprovalState {
11
11
  state: DocsEntityApprovalStateType;
12
12
  updatedByUserId: string | null;
13
- constructor(model: DTODocumentationPageApprovalState | null, draftState: DocsEntityDraftState | null);
13
+ constructor(model: DTODocumentationPageApprovalState | DTODocumentationGroupApprovalState | null, draftState: DocsEntityDraftState | null);
14
14
  }
@@ -1,15 +1,12 @@
1
+ import { DTODocumentationHierarchyV2 } from "@supernova-studio/client";
1
2
  import { DocsEntityGroupBehavior } from "../../enums/SDKDocsEntityGroupBehavior";
2
3
  import { DocsEntityType } from "../../enums/SDKDocsEntityType";
3
- import { DocsEntity, DocsEntityModel, DocsEntityPublishMetadata } from "./SDKDocsEntity";
4
+ import { DocsEntity, DocsEntityPublishMetadata } from "./SDKDocsEntity";
4
5
  import { DocsEntityApprovalState } from "./SDKDocsEntityApprovalState";
6
+ import { DocsEntityConfiguration } from "./SDKDocsEntityConfiguration";
5
7
  import { DocsEntityDraftState } from "./SDKDocsEntityDraftState";
6
- import { DocsEntityMultiplayerPage, DocsEntityPage } from "./SDKDocsEntityPage";
7
- export type DocsEntityGroupModel = {
8
- isRoot: boolean;
9
- childrenIds: Array<string>;
10
- parentId: string | null;
11
- groupBehavior: DocsEntityGroupBehavior;
12
- } & DocsEntityModel;
8
+ import { DocsEntityPage } from "./SDKDocsEntityPage";
9
+ export type DocsEntityGroupModel = DTODocumentationHierarchyV2["groups"][number];
13
10
  export declare class DocsEntityGroup extends DocsEntity {
14
11
  /** If true, this is unique within documentation (just one) that contains all top-level objects and is root of the docs tree (root > groups > items > blocks ...) */
15
12
  isRoot: boolean;
@@ -34,8 +31,7 @@ export declare class DocsEntityGroup extends DocsEntity {
34
31
  deployedDocsPageUrl(): string | null;
35
32
  }
36
33
  /** Lightweight page representation used in multiplayer context type-validated against the full version */
37
- export declare class DocsEntityMultiplayerGroup implements Pick<DocsEntityGroup, "id" | "persistentId" | "type" | "title" | "groupBehavior" | "childrenIds" | "isRoot" | "isPrivate" | "isHidden" | "draftState" | "publishMetadata" | "approvalState"> {
38
- id: string;
34
+ export declare class DocsEntityMultiplayerGroup {
39
35
  persistentId: string;
40
36
  type: DocsEntityType.group;
41
37
  title: string;
@@ -43,16 +39,12 @@ export declare class DocsEntityMultiplayerGroup implements Pick<DocsEntityGroup,
43
39
  childrenIds: Array<string>;
44
40
  isRoot: boolean;
45
41
  parent: DocsEntityMultiplayerGroup | null;
46
- children: Array<DocsEntityMultiplayerGroup | DocsEntityMultiplayerPage>;
47
42
  draftState: DocsEntityDraftState | null;
48
43
  isPrivate: boolean;
49
44
  isHidden: boolean;
50
45
  publishMetadata: DocsEntityPublishMetadata | null;
51
46
  approvalState: DocsEntityApprovalState;
52
- /** Children filtered to be only groups */
53
- get subgroups(): Array<DocsEntityMultiplayerGroup>;
54
- /** Children filtered to be only pages */
55
- get pages(): Array<DocsEntityMultiplayerPage>;
47
+ configuration: DocsEntityConfiguration;
56
48
  parentId: string | null;
57
- constructor(model: DocsEntityGroupModel);
49
+ constructor(model: DTODocumentationHierarchyV2["groups"][number]);
58
50
  }
@@ -1,11 +1,11 @@
1
+ import { DTODocumentationHierarchyV2 } from "@supernova-studio/client";
1
2
  import { DocsEntityType } from "../../enums/SDKDocsEntityType";
2
- import { DocsEntity, DocsEntityModel, DocsEntityPublishMetadata } from "./SDKDocsEntity";
3
+ import { DocsEntity, DocsEntityPublishMetadata } from "./SDKDocsEntity";
3
4
  import { DocsEntityApprovalState } from "./SDKDocsEntityApprovalState";
5
+ import { DocsEntityConfiguration } from "./SDKDocsEntityConfiguration";
4
6
  import { DocsEntityDraftState } from "./SDKDocsEntityDraftState";
5
7
  import { DocsEntityMultiplayerGroup } from "./SDKDocsEntityGroup";
6
- export type DocsEntityPageModel = {
7
- childrenIds: Array<string>;
8
- } & DocsEntityModel;
8
+ export type DocsEntityPageModel = DTODocumentationHierarchyV2["pages"][number];
9
9
  export declare class DocsEntityPage extends DocsEntity {
10
10
  /** Containing group. Can either be true group (abstract), or tab group */
11
11
  parentId: string;
@@ -15,8 +15,7 @@ export declare class DocsEntityPage extends DocsEntity {
15
15
  relativeUrl: string | null;
16
16
  /** Internal */
17
17
  editorUrl: string | null;
18
- /** IDs of items belonging to the documentation group. Can be blocks and sections */
19
- childrenIds: Array<string>;
18
+ roomId: string | null;
20
19
  constructor(model: DocsEntityPageModel);
21
20
  /** Internal: Modifies object with new paths. Don't use outside SDK environment as it doesn't propagate the data back to source */
22
21
  internalOverridePaths(deployed: string | null, editor: string | null, relative: string | null): void;
@@ -28,8 +27,7 @@ export declare class DocsEntityPage extends DocsEntity {
28
27
  relativePageUrl(): string | null;
29
28
  }
30
29
  /** Lightweight page representation used in multiplayer context type-validated against the full version */
31
- export declare class DocsEntityMultiplayerPage implements Pick<DocsEntityPage, "id" | "persistentId" | "type" | "title" | "relativeUrl" | "createdAt" | "isPrivate" | "isHidden" | "draftState" | "publishMetadata" | "approvalState"> {
32
- id: string;
30
+ export declare class DocsEntityMultiplayerPage {
33
31
  persistentId: string;
34
32
  parentId: string | null;
35
33
  parent: DocsEntityMultiplayerGroup | null;
@@ -42,5 +40,8 @@ export declare class DocsEntityMultiplayerPage implements Pick<DocsEntityPage, "
42
40
  draftState: DocsEntityDraftState | null;
43
41
  publishMetadata: DocsEntityPublishMetadata | null;
44
42
  approvalState: DocsEntityApprovalState;
45
- constructor(model: DocsEntityPageModel);
43
+ configuration: DocsEntityConfiguration | null;
44
+ roomId: string | null;
45
+ isTab: boolean | null;
46
+ constructor(model: DTODocumentationHierarchyV2["pages"][number]);
46
47
  }
@@ -26,6 +26,7 @@ export type ElementPropertyRemoteModel = {
26
26
  description: string;
27
27
  };
28
28
  codeName: string;
29
+ isImmutable: boolean;
29
30
  type: ElementPropertyType;
30
31
  targetElementType: ElementPropertyTargetElementType;
31
32
  linkElementType?: ElementPropertyLinkElementType;
@@ -59,6 +60,9 @@ export declare class ElementProperty {
59
60
  codeName: string;
60
61
  /** Property description */
61
62
  description: string | null;
63
+ /** Whether anything about this definition can be modified.
64
+ * Its respective column can still be re-ordered and resized */
65
+ isImmutable: boolean;
62
66
  /** Base type */
63
67
  propertyType: ElementPropertyType;
64
68
  /** Type of design system object this property is contained in - for example, if this property was configured for DS components, this will be of type `component` */
@@ -4,7 +4,7 @@ declare const badgeColorValues: {
4
4
  readonly fuchsia: "#FCF0FF";
5
5
  readonly green: "#EBFEF6";
6
6
  readonly grey: "#EDEFF3";
7
- readonly "light-grey": "#F6F7F9";
7
+ readonly lightGrey: "#F6F7F9";
8
8
  readonly orange: "#FFF2E1";
9
9
  readonly pink: "#FDF0F7";
10
10
  readonly purple: "#F5F2FD";
@@ -1,6 +1,8 @@
1
+ import { DTOExporterPropertyDefinition } from "@supernova-studio/client";
1
2
  import { ExporterCustomBlock, ExporterCustomBlockModel } from "./custom_blocks/SDKExporterCustomBlock";
2
3
  import { ExporterCustomBlockVariant } from "./custom_blocks/SDKExporterCustomBlockVariant";
3
4
  import { ExporterConfigurationProperty, ExporterConfigurationPropertyModel } from "./custom_properties/SDKExporterConfigurationProperty";
5
+ import { ExporterPropertyDefinition } from "./custom_properties/SDKExporterPropertyDefinition";
4
6
  export type ExporterProvider = "github" | "gitlab" | "bitbucket" | "azure";
5
7
  export type ExporterModel = {
6
8
  id: string;
@@ -24,9 +26,13 @@ export type ExporterModel = {
24
26
  gitBranch: string;
25
27
  gitDirectory: string;
26
28
  blockVariants?: object;
29
+ properties?: Array<DTOExporterPropertyDefinition>;
27
30
  configurationProperties?: Array<ExporterConfigurationPropertyModel>;
28
31
  customBlocks?: Array<ExporterCustomBlockModel>;
29
32
  exporterType: "code" | "documentation";
33
+ isDeprecated: boolean;
34
+ deprecationNote?: string;
35
+ replacementExporterId?: string;
30
36
  };
31
37
  export type NewExporterPayload = {
32
38
  url?: string;
@@ -78,14 +84,23 @@ export declare class Exporter {
78
84
  gitDirectory: string | null;
79
85
  /** If the workspace is owner of an exporter */
80
86
  isOwner?: boolean;
87
+ /** Flag that shows if the exporter shouldn't be used for creating new pipelines */
88
+ isDeprecated: boolean;
89
+ /** Message that explains why the exporter is deprecated */
90
+ deprecationNote: string | null;
91
+ /** Id of the exporter that should be used instead of this one, when it's deprecated */
92
+ replacementExporterId: string | null;
81
93
  /** Contribution of this exporter to the Supernova system */
82
94
  contributes: {
83
95
  /** DocumentationLegacy block variants */
84
96
  blockVariants: Array<ExporterCustomBlockVariant>;
85
97
  /** DocumentationLegacy blocks */
86
98
  blocks: Array<ExporterCustomBlock>;
99
+ /** Configuration properties for the v2 exporters */
100
+ properties: Array<ExporterPropertyDefinition>;
87
101
  /** Exporter configuration */
88
102
  configuration: Array<ExporterConfigurationProperty>;
89
103
  };
90
104
  constructor(data: ExporterModel);
105
+ get usesConfiguration(): boolean;
91
106
  }
@@ -0,0 +1,36 @@
1
+ export type GithubDestinationPayload = {
2
+ branch: string;
3
+ relativePath: string;
4
+ url: string;
5
+ };
6
+ export type AzureDestinationPayload = {
7
+ organizationId: string;
8
+ projectId: string;
9
+ repositoryId: string;
10
+ branch: string;
11
+ relativePath: string;
12
+ };
13
+ export type BitbucketDestinationPayload = {
14
+ workspaceSlug: string;
15
+ projectKey: string;
16
+ repoSlug: string;
17
+ branch: string;
18
+ relativePath: string;
19
+ };
20
+ export type GitlabDestinationPayload = {
21
+ projectId: string;
22
+ branch: string;
23
+ relativePath: string;
24
+ };
25
+ export type DocumentationDestinationPayload = {
26
+ environment: "Live" | "Preview";
27
+ };
28
+ export type ExporterJobDestination = {
29
+ azure: AzureDestinationPayload | null | undefined;
30
+ bitbucket: BitbucketDestinationPayload | null | undefined;
31
+ documentation: DocumentationDestinationPayload | null | undefined;
32
+ github: GithubDestinationPayload | null | undefined;
33
+ gitlab: GitlabDestinationPayload | null | undefined;
34
+ s3: Record<string, any> | undefined;
35
+ webhookUrl: null | undefined;
36
+ };