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

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 (23) hide show
  1. package/build/sdk-typescript/src/core/SDKSupernova.d.ts +2 -3
  2. package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +5 -6
  3. package/build/sdk-typescript/src/core/areas/SDKAreaImport.d.ts +1 -11
  4. package/build/sdk-typescript/src/core/areas/SDKAreaRawData.d.ts +4 -4
  5. package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +4 -0
  6. package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +3 -8
  7. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +26 -11
  8. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +64 -19
  9. package/build/sdk-typescript/src/model/components/SDKDesignComponentPropertyDefinition.d.ts +1 -0
  10. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockFigmaComponentProperty.d.ts +1 -0
  11. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityConfiguration.d.ts +1 -0
  12. package/build/sdk-typescript/src/model/exporters/SDKPipeline.d.ts +24 -0
  13. package/build/sdk-typescript/src/model/support/SDKFigmaFrame.d.ts +2 -7
  14. package/build/sdk-typescript/src/model/support/SDKFigmaStructure.d.ts +11 -11
  15. package/build/sdk-typescript/src/model/support/SDKFigmaStructureDetail.d.ts +6 -29
  16. package/build/sdk-typescript/src/pulsar-interfaces.d.ts +1 -0
  17. package/build/sdk-typescript/src/tests/Tooling/PluginFigmaTokens.spec.token-studio.d.ts +1 -0
  18. package/build/sdk-typescript/src/tests/Tooling/ReadTokens.spec.token-studio.d.ts +1 -0
  19. package/build/sdk-typescript/src/tests/helpers.d.ts +1 -1
  20. package/build/sdk-typescript/src/tests/validators.d.ts +1 -1
  21. package/build/supernova-sdk-typescript.js +1 -1
  22. package/build/supernova-sdk-typescript.js.map +1 -1
  23. package/package.json +10 -11
@@ -7,7 +7,6 @@ import { AreaComponents } from "./areas/SDKAreaComponents";
7
7
  import { AreaDataSources } from "./areas/SDKAreaDataSources";
8
8
  import { AreaDesignSystems } from "./areas/SDKAreaDesignSystems";
9
9
  import { AreaDocumentation } from "./areas/SDKAreaDocumentation";
10
- import { AreaImport } from "./areas/SDKAreaImport";
11
10
  import { AreaIntegrations } from "./areas/SDKAreaIntegrations";
12
11
  import { AreaMe } from "./areas/SDKAreaMe";
13
12
  import { AreaMultiplayer } from "./areas/SDKAreaMultiplayer";
@@ -60,8 +59,6 @@ export declare class Supernova {
60
59
  dataSources: AreaDataSources;
61
60
  /** Get, create, update, manipulate or delete data from Supernova en masse */
62
61
  bulkOperations: AreaBulkOperations;
63
- /** Import data to Supernova directly */
64
- import: AreaImport;
65
62
  /** Read and write data using Supernova key-value storage */
66
63
  storage: AreaStorage;
67
64
  /** Get access to network in exporter packages */
@@ -85,6 +82,8 @@ export declare class Supernova {
85
82
  requestHook?: DataBridgeRequestHook;
86
83
  bypassEnvFetch?: boolean;
87
84
  proxyUrl?: string;
85
+ isPreview?: boolean;
86
+ jobId?: string;
88
87
  });
89
88
  get apiKeySet(): boolean;
90
89
  }
@@ -1,10 +1,12 @@
1
1
  import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTODeleteDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOMoveDocumentationGroupInput, DTOCreateDocumentationTabInput, DTODocumentationPageAnchor, DTODesignElementsDataDiffResponse, DTOPublishDocumentationRequest, DTOElementActionInput, DTOElementActionOutput } from "@supernova-studio/client";
2
2
  import { DocumentationLegacy, DocumentationLegacyModel } from "../../model/base/SDKDocumentationLegacy";
3
3
  import { DocsBlockDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockDefinition";
4
+ import { DocsBlock } from "../../model/docs/blocks/usage/SDKDocsBlock";
5
+ import { DocsEntity } from "../../model/docs/entities/SDKDocsEntity";
4
6
  import { DocsEntityGroupModel } from "../../model/docs/entities/SDKDocsEntityGroup";
5
7
  import { DocsEntityPageModel } from "../../model/docs/entities/SDKDocsEntityPage";
8
+ import { DocsSection } from "../../model/docs/sections/SDKDocsSection";
6
9
  import { DocumentationLegacyGroup } from "../../model/documentation/SDKDocumentationLegacyGroup";
7
- import { DocumentationLegacyPage } from "../../model/documentation/SDKDocumentationLegacyPage";
8
10
  import { DocsPublishStatus } from "../../model/enums/SDKDocsPublishStatus";
9
11
  import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
10
12
  import { ExportBuild, ExportBuildStatus } from "../../model/exporters/exporter_builds/SDKExportBuild";
@@ -207,10 +209,7 @@ export declare class AreaDocumentation {
207
209
  * */
208
210
  publishDrafts(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment, changes: DTOPublishDocumentationRequest["changes"], isForcing?: boolean): Promise<ExportBuild>;
209
211
  getDocumentationPageAnchors(from: RemoteWorkspaceVersionIdentifier, pageId: string): Promise<Array<DTODocumentationPageAnchor>>;
212
+ getDocumentationMockedStructure(): Array<DocsEntity>;
213
+ getDocumentationMockedPageContent(pageId: string): Array<DocsBlock | DocsSection>;
210
214
  getDocumentationMockedEditorBlockDefinitions(): Array<DocsBlockDefinition>;
211
- /** Fetches all documentation pages with content
212
- * @param from - Remote version to fetch from
213
- * @returns Array of documentation pages (legacy, non-multiplayer model)
214
- */
215
- getDocumentationPagesWithContentLegacy(from: RemoteWorkspaceVersionIdentifier): Promise<Array<DocumentationLegacyPage>>;
216
215
  }
@@ -1,16 +1,6 @@
1
- import { DTODocumentationPageUpdateDocumentActionInputV2 } from "@supernova-studio/client";
2
1
  import { DataCore } from "../data/SDKDataCore";
3
- import { RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
4
- export type DocumentationPageContent = DTODocumentationPageUpdateDocumentActionInputV2["input"]["documentItems"];
5
- export declare class AreaImport {
2
+ export declare class SDKAreaImport {
6
3
  /** Internal: Engine */
7
4
  private dataCore;
8
5
  constructor(dataCore: DataCore);
9
- /** Imports documentation page content
10
- * @param from - Remote version to import to
11
- * @param pageId - ID of the page to import content into
12
- * @param content - Content to import
13
- * @returns nothing
14
- */
15
- importDocumentationPage(from: RemoteWorkspaceVersionIdentifier, pageId: string, content: DocumentationPageContent): Promise<void>;
16
6
  }
@@ -1,7 +1,7 @@
1
+ import { DTODesignSystem } from "@supernova-studio/client";
1
2
  import { Asset } from "../../model/assets/SDKAsset";
2
3
  import { Brand, BrandRemoteModel } from "../../model/base/SDKBrand";
3
- import { DesignSystem, // @ts-expect-error TS(2305): Module '"../../model/base/SDKDesignSystem"' has no exported member named 'DesignSystemRemoteModel'.
4
- DesignSystemRemoteModel } from "../../model/base/SDKDesignSystem";
4
+ import { DesignSystem } from "../../model/base/SDKDesignSystem";
5
5
  import { DesignSystemVersion, DesignSystemVersionRemoteModel } from "../../model/base/SDKDesignSystemVersion";
6
6
  import { Component, ComponentRemoteModel } from "../../model/components/SDKComponent";
7
7
  import { DesignComponentRemoteModel } from "../../model/components/SDKDesignComponent";
@@ -44,7 +44,7 @@ export declare class AreaRawData {
44
44
  /** Fetches raw membership */
45
45
  getRawMembershipModelData(userId: string): Promise<Array<MembershipRemoteModel>>;
46
46
  /** Fetches raw design systems */
47
- getRawDesignSystemModelData(workspaceId: string): Promise<Array<DesignSystemRemoteModel>>;
47
+ getRawDesignSystemModelData(workspaceId: string): Promise<Array<DTODesignSystem>>;
48
48
  /** Fetches raw versions */
49
49
  getRawVersionModelData(designSystemId: string): Promise<Array<DesignSystemVersionRemoteModel>>;
50
50
  /** Fetches raw brands */
@@ -76,7 +76,7 @@ export declare class AreaRawData {
76
76
  /** Builds memberships */
77
77
  buildMembershipsFromRaw(rawData: Array<MembershipRemoteModel>): Array<Membership>;
78
78
  /** Builds design systems */
79
- buildDesignSystemsFromRaw(rawData: Array<DesignSystemRemoteModel>): Array<DesignSystem>;
79
+ buildDesignSystemsFromRaw(rawData: Array<DTODesignSystem>): Array<DesignSystem>;
80
80
  /** Builds versions */
81
81
  buildVersionsFromRaw(rawData: Array<DesignSystemVersionRemoteModel>): Array<DesignSystemVersion>;
82
82
  /** Builds brands */
@@ -23,6 +23,8 @@ export type DataBridgeConfiguration = {
23
23
  debugRequestObserver?: DebugRequestObserver | null;
24
24
  debugResponseObserver?: DebugResponseObserver | null;
25
25
  proxyUrl?: string | null;
26
+ jobId?: string | null;
27
+ isPreview?: boolean;
26
28
  };
27
29
  export declare class DataBridge {
28
30
  authToken: string;
@@ -30,6 +32,8 @@ export declare class DataBridge {
30
32
  apiVersion: string;
31
33
  target: string | null;
32
34
  bypassEnvFetch: boolean;
35
+ isPreview: boolean;
36
+ jobId: string | null;
33
37
  proxyUrl: string | undefined;
34
38
  requestHook: DataBridgeRequestHook | null;
35
39
  debugRequestObserver: DebugRequestObserver | null;
@@ -1,6 +1,6 @@
1
1
  import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignElementsDataDiffResponse, DTODocumentationLinkPreviewRequest, DTODocumentationPageAnchor, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOElementActionInput, DTOExporterPropertyValueMap, DTOFigmaNode, DTOFigmaNodeRenderIdInput, DTOFigmaNodeRenderInput, DTOFigmaNodeV2, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPageRedirectCreateBody, DTOPageRedirectUpdateBody, DTOPipelineCreateBody, DTOPipelineUpdateBody, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
2
2
  import { DesignSystemInvite, DesignSystemInviteUpdate, DesignSystemMemberUpdate, DesignSystemPendingMemberInvite, DesignSystemUserInvitation } from "@supernova-studio/model";
3
- import { DesignSystemAccessMode, DocsBlockDefinition, DocumentationLegacyPage, ExportBuildStatus, ExporterJobDestination, RemoteWorkspaceVersionIdentifier, ResourceFont, TokenThemeOverrideTranserObject, UserRole } from "../../exports";
3
+ import { DesignSystemAccessMode, DocsBlockDefinition, ExportBuildStatus, ExporterJobDestination, ResourceFont, TokenThemeOverrideTranserObject, UserRole } from "../../exports";
4
4
  import { Acl } from "../../model/acl/SDKAcl";
5
5
  import { Asset } from "../../model/assets/SDKAsset";
6
6
  import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
@@ -71,7 +71,6 @@ import { GitProvidersOrganizations } from "../../model/workspaces/integrations/G
71
71
  import { GitProvidersProjects } from "../../model/workspaces/integrations/GitProvidersProjects";
72
72
  import { GitProvidersRepositories } from "../../model/workspaces/integrations/GitProvidersRepositories";
73
73
  import { ComponentUpdateTransactionData, TokenUpdateTransactionData } from "../areas/SDKAreaBulkOperations";
74
- import { DocumentationPageContent } from "../areas/SDKAreaImport";
75
74
  import { DataCoreReadRequests } from "./requests/SDKDataCoreReadRequests";
76
75
  import { RenderedAssetRequestSettings } from "./requests/SDKDataCoreRenderRequests";
77
76
  import { DataBridge } from "./SDKDataBridge";
@@ -538,8 +537,8 @@ export declare class DataCore {
538
537
  designSystemMemberList(designSystemId: string): Promise<DesignSystemMemberList>;
539
538
  /** Download information about design system's contacts */
540
539
  designSystemContacts(designSystemId: string): Promise<DesignSystemContactList>;
541
- getFigmaNodeStructures(designSystemId: string, versionId: string): Promise<Array<FigmaStructure>>;
542
- getFigmaNodeStructureDetail(designSystemId: string, versionId: string, figmaStructureId: string): Promise<FigmaStructureDetail>;
540
+ getFigmaNodeStructures(designSystemId: string): Promise<Array<FigmaStructure>>;
541
+ getFigmaNodeStructureDetail(designSystemId: string, figmaStructureId: string): Promise<FigmaStructureDetail>;
543
542
  deleteFigmaSource(designSystemId: string, sourceId: string): Promise<void>;
544
543
  linkFigmaSource(designSystemId: string, brandId: string, url: string, options: {
545
544
  scopes: {
@@ -596,8 +595,4 @@ export declare class DataCore {
596
595
  createPageRedirect(designSystemId: string, body: DTOPageRedirectCreateBody): Promise<void>;
597
596
  updatePageRedirect(designSystemId: string, redirectId: string, body: DTOPageRedirectUpdateBody): Promise<void>;
598
597
  deletePageRedirect(designSystemId: string, redirectId: string): Promise<void>;
599
- /** Import content into a documentation page */
600
- importDocumentationPage(designSystemId: string, versionId: string, pageId: string, content: DocumentationPageContent): Promise<void>;
601
- /** All pages created within documentation presented as flat structure. Each page contains all data neccessary to render it pre-fetched and resolved for convenience */
602
- getDocumentationPagesWithContent(from: RemoteWorkspaceVersionIdentifier): Promise<Array<DocumentationLegacyPage>>;
603
598
  }
@@ -1,5 +1,4 @@
1
1
  import { DTODesignElementsDataDiffResponse, DTODesignSystem, DTODesignSystemContactsResponse, DTODesignSystemMemberListResponse, DTODesignSystemVersionStats, DTODocumentationLinkPreviewRequest, DTOFigmaNode, DTOFigmaNodeV2, DTOGetDocumentationPageAnchorsResponse, DTOPipeline, DTOTokenCollection } from "@supernova-studio/client";
2
- import { DocumentationLegacyGroupModel } from "../../../exports";
3
2
  import { AclRemoteModel } from "../../../model/acl/SDKAcl";
4
3
  import { BootstrapDataRemoteModel } from "../../../model/base/SDKBootstrapData";
5
4
  import { BrandRemoteModel } from "../../../model/base/SDKBrand";
@@ -29,8 +28,6 @@ import { MembershipRemoteModel } from "../../../model/membership/SDKMembership";
29
28
  import { ResourceAssetModel } from "../../../model/resources/SDKResourceAsset";
30
29
  import { ResourceFontModel } from "../../../model/resources/SDKResourceFont";
31
30
  import { CustomDomainRemoteModel } from "../../../model/support/SDKCustomDomain";
32
- import { FigmaStructureModel } from "../../../model/support/SDKFigmaStructure";
33
- import { FigmaStructureDetailModel } from "../../../model/support/SDKFigmaStructureDetail";
34
31
  import { SourceRemoteModel } from "../../../model/support/SDKSource";
35
32
  import { TokenThemeRemoteModel } from "../../../model/themes/SDKTokenTheme";
36
33
  import { TokenRemoteModel } from "../../../model/tokens/remote/SDKRemoteTokenModel";
@@ -51,7 +48,6 @@ import { WorkspaceProductRemoteModel } from "../../../model/workspaces/SDKWorksp
51
48
  import { SubscriptionProductFeaturesRemoteModel } from "../../../model/workspaces/SDKWorkspaceProductFeatures";
52
49
  import { WorkspaceSSOSettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceSSOSettings";
53
50
  import { WorkspaceSubscriptionRemoteModel } from "../../../model/workspaces/SDKWorkspaceSubscription";
54
- import { RemoteWorkspaceVersionIdentifier } from "../../areas/SDKRemoteIdentifiers";
55
51
  import { DataBridge } from "../SDKDataBridge";
56
52
  export declare class DataCoreReadRequests {
57
53
  private bridge;
@@ -116,9 +112,33 @@ export declare class DataCoreReadRequests {
116
112
  /** Remote: Get all design sources of a single design system */
117
113
  getRemoteSources(designSystemId: string): Promise<Array<SourceRemoteModel>>;
118
114
  /** Remote: Get all figma node structures */
119
- getFigmaNodeStructures(designSystemId: string, versionId: string): Promise<Array<FigmaStructureModel>>;
115
+ getFigmaNodeStructures(designSystemId: string): Promise<{
116
+ id: string;
117
+ createdAt: Date;
118
+ updatedAt: Date;
119
+ sourceId: string;
120
+ importState: "Success" | "InProgress" | "Failed";
121
+ }[]>;
120
122
  /** Remote: Get figma node detail */
121
- getFigmaNodeStructureDetail(designSystemId: string, versionId: string, figmaStructureId: string): Promise<FigmaStructureDetailModel>;
123
+ getFigmaNodeStructureDetail(designSystemId: string, figmaStructureId: string): Promise<{
124
+ id: string;
125
+ createdAt: Date;
126
+ updatedAt: Date;
127
+ sourceId: string;
128
+ importState: "Success" | "InProgress" | "Failed";
129
+ rootNode: {
130
+ type: "DOCUMENT" | "CANVAS" | "COMPONENT_SET" | "COMPONENT" | "FRAME";
131
+ id: string;
132
+ name: string;
133
+ size?: {
134
+ width: number;
135
+ height: number;
136
+ } | undefined;
137
+ parentComponentSetId?: string | undefined;
138
+ } & {
139
+ children: import("@supernova-studio/model").FigmaFileStructureNode[];
140
+ };
141
+ }>;
122
142
  /** Remote: Get information about design system's members */
123
143
  getRemoteDesignSystemMemberList(designSystemId: string): Promise<DTODesignSystemMemberListResponse>;
124
144
  getRemoteContacts(designSystemId: string): Promise<DTODesignSystemContactsResponse>;
@@ -242,9 +262,4 @@ export declare class DataCoreReadRequests {
242
262
  designSystemId: string;
243
263
  pagePersistentId: string;
244
264
  }[]>;
245
- /** All pages created within documentation presented as flat structure. Each page contains all data neccessary to render it pre-fetched and resolved for convenience */
246
- getDocumentationPagesWithContent(from: RemoteWorkspaceVersionIdentifier): Promise<{
247
- pageDetails: Array<DocumentationLegacyPageModel>;
248
- groupDetails: Array<DocumentationLegacyGroupModel>;
249
- }>;
250
265
  }
@@ -37,7 +37,6 @@ import { WorkspaceProfileUpdateModel } from "../../../model/workspaces/SDKWorksp
37
37
  import { WorkspaceSSOSettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceSSOSettings";
38
38
  import { WorkspaceSubscriptionUpdateModel } from "../../../model/workspaces/SDKWorkspaceSubscription";
39
39
  import { DataBridge } from "../SDKDataBridge";
40
- import { DocumentationPageContent } from "../../areas/SDKAreaImport";
41
40
  export declare class DataCoreWriteRequests {
42
41
  private bridge;
43
42
  constructor(bridge: DataBridge);
@@ -262,11 +261,14 @@ export declare class DataCoreWriteRequests {
262
261
  repositoryId: string;
263
262
  url?: string | undefined;
264
263
  userId?: number | undefined;
265
- credentialId?: string | undefined;
266
264
  relativePath?: string | undefined;
267
265
  purgeDirectory?: boolean | undefined;
268
266
  commitAuthorName?: string | undefined;
269
267
  commitAuthorEmail?: string | undefined;
268
+ commitMessage?: string | undefined;
269
+ pullRequestTitle?: string | undefined;
270
+ pullRequestDescription?: string | undefined;
271
+ credentialId?: string | undefined;
270
272
  connectionId?: string | undefined;
271
273
  } | undefined;
272
274
  bitbucket?: {
@@ -275,22 +277,28 @@ export declare class DataCoreWriteRequests {
275
277
  projectKey: string;
276
278
  repoSlug: string;
277
279
  userId?: number | undefined;
278
- credentialId?: string | undefined;
279
280
  relativePath?: string | undefined;
280
281
  purgeDirectory?: boolean | undefined;
281
282
  commitAuthorName?: string | undefined;
282
283
  commitAuthorEmail?: string | undefined;
284
+ commitMessage?: string | undefined;
285
+ pullRequestTitle?: string | undefined;
286
+ pullRequestDescription?: string | undefined;
287
+ credentialId?: string | undefined;
283
288
  connectionId?: string | undefined;
284
289
  } | undefined;
285
290
  github?: {
286
291
  url: string;
287
292
  branch: string;
288
293
  userId?: number | undefined;
289
- credentialId?: string | undefined;
290
294
  relativePath?: string | undefined;
291
295
  purgeDirectory?: boolean | undefined;
292
296
  commitAuthorName?: string | undefined;
293
297
  commitAuthorEmail?: string | undefined;
298
+ commitMessage?: string | undefined;
299
+ pullRequestTitle?: string | undefined;
300
+ pullRequestDescription?: string | undefined;
301
+ credentialId?: string | undefined;
294
302
  connectionId?: string | undefined;
295
303
  } | undefined;
296
304
  gitlab?: {
@@ -298,11 +306,14 @@ export declare class DataCoreWriteRequests {
298
306
  projectId: string;
299
307
  url?: string | undefined;
300
308
  userId?: number | undefined;
301
- credentialId?: string | undefined;
302
309
  relativePath?: string | undefined;
303
310
  purgeDirectory?: boolean | undefined;
304
311
  commitAuthorName?: string | undefined;
305
312
  commitAuthorEmail?: string | undefined;
313
+ commitMessage?: string | undefined;
314
+ pullRequestTitle?: string | undefined;
315
+ pullRequestDescription?: string | undefined;
316
+ credentialId?: string | undefined;
306
317
  connectionId?: string | undefined;
307
318
  } | undefined;
308
319
  documentation?: {
@@ -386,11 +397,14 @@ export declare class DataCoreWriteRequests {
386
397
  url: string;
387
398
  branch: string;
388
399
  userId?: number | undefined;
389
- credentialId?: string | undefined;
390
400
  relativePath?: string | undefined;
391
401
  purgeDirectory?: boolean | undefined;
392
402
  commitAuthorName?: string | undefined;
393
403
  commitAuthorEmail?: string | undefined;
404
+ commitMessage?: string | undefined;
405
+ pullRequestTitle?: string | undefined;
406
+ pullRequestDescription?: string | undefined;
407
+ credentialId?: string | undefined;
394
408
  connectionId?: string | undefined;
395
409
  } | undefined;
396
410
  destinationAzure?: {
@@ -400,11 +414,14 @@ export declare class DataCoreWriteRequests {
400
414
  repositoryId: string;
401
415
  url?: string | undefined;
402
416
  userId?: number | undefined;
403
- credentialId?: string | undefined;
404
417
  relativePath?: string | undefined;
405
418
  purgeDirectory?: boolean | undefined;
406
419
  commitAuthorName?: string | undefined;
407
420
  commitAuthorEmail?: string | undefined;
421
+ commitMessage?: string | undefined;
422
+ pullRequestTitle?: string | undefined;
423
+ pullRequestDescription?: string | undefined;
424
+ credentialId?: string | undefined;
408
425
  connectionId?: string | undefined;
409
426
  } | undefined;
410
427
  destinationGitlab?: {
@@ -412,11 +429,14 @@ export declare class DataCoreWriteRequests {
412
429
  projectId: string;
413
430
  url?: string | undefined;
414
431
  userId?: number | undefined;
415
- credentialId?: string | undefined;
416
432
  relativePath?: string | undefined;
417
433
  purgeDirectory?: boolean | undefined;
418
434
  commitAuthorName?: string | undefined;
419
435
  commitAuthorEmail?: string | undefined;
436
+ commitMessage?: string | undefined;
437
+ pullRequestTitle?: string | undefined;
438
+ pullRequestDescription?: string | undefined;
439
+ credentialId?: string | undefined;
420
440
  connectionId?: string | undefined;
421
441
  } | undefined;
422
442
  destinationBitbucket?: {
@@ -425,11 +445,14 @@ export declare class DataCoreWriteRequests {
425
445
  projectKey: string;
426
446
  repoSlug: string;
427
447
  userId?: number | undefined;
428
- credentialId?: string | undefined;
429
448
  relativePath?: string | undefined;
430
449
  purgeDirectory?: boolean | undefined;
431
450
  commitAuthorName?: string | undefined;
432
451
  commitAuthorEmail?: string | undefined;
452
+ commitMessage?: string | undefined;
453
+ pullRequestTitle?: string | undefined;
454
+ pullRequestDescription?: string | undefined;
455
+ credentialId?: string | undefined;
433
456
  connectionId?: string | undefined;
434
457
  } | undefined;
435
458
  }>;
@@ -463,11 +486,14 @@ export declare class DataCoreWriteRequests {
463
486
  repositoryId: string;
464
487
  url?: string | undefined;
465
488
  userId?: number | undefined;
466
- credentialId?: string | undefined;
467
489
  relativePath?: string | undefined;
468
490
  purgeDirectory?: boolean | undefined;
469
491
  commitAuthorName?: string | undefined;
470
492
  commitAuthorEmail?: string | undefined;
493
+ commitMessage?: string | undefined;
494
+ pullRequestTitle?: string | undefined;
495
+ pullRequestDescription?: string | undefined;
496
+ credentialId?: string | undefined;
471
497
  connectionId?: string | undefined;
472
498
  } | undefined;
473
499
  bitbucket?: {
@@ -476,22 +502,28 @@ export declare class DataCoreWriteRequests {
476
502
  projectKey: string;
477
503
  repoSlug: string;
478
504
  userId?: number | undefined;
479
- credentialId?: string | undefined;
480
505
  relativePath?: string | undefined;
481
506
  purgeDirectory?: boolean | undefined;
482
507
  commitAuthorName?: string | undefined;
483
508
  commitAuthorEmail?: string | undefined;
509
+ commitMessage?: string | undefined;
510
+ pullRequestTitle?: string | undefined;
511
+ pullRequestDescription?: string | undefined;
512
+ credentialId?: string | undefined;
484
513
  connectionId?: string | undefined;
485
514
  } | undefined;
486
515
  github?: {
487
516
  url: string;
488
517
  branch: string;
489
518
  userId?: number | undefined;
490
- credentialId?: string | undefined;
491
519
  relativePath?: string | undefined;
492
520
  purgeDirectory?: boolean | undefined;
493
521
  commitAuthorName?: string | undefined;
494
522
  commitAuthorEmail?: string | undefined;
523
+ commitMessage?: string | undefined;
524
+ pullRequestTitle?: string | undefined;
525
+ pullRequestDescription?: string | undefined;
526
+ credentialId?: string | undefined;
495
527
  connectionId?: string | undefined;
496
528
  } | undefined;
497
529
  gitlab?: {
@@ -499,11 +531,14 @@ export declare class DataCoreWriteRequests {
499
531
  projectId: string;
500
532
  url?: string | undefined;
501
533
  userId?: number | undefined;
502
- credentialId?: string | undefined;
503
534
  relativePath?: string | undefined;
504
535
  purgeDirectory?: boolean | undefined;
505
536
  commitAuthorName?: string | undefined;
506
537
  commitAuthorEmail?: string | undefined;
538
+ commitMessage?: string | undefined;
539
+ pullRequestTitle?: string | undefined;
540
+ pullRequestDescription?: string | undefined;
541
+ credentialId?: string | undefined;
507
542
  connectionId?: string | undefined;
508
543
  } | undefined;
509
544
  documentation?: {
@@ -587,11 +622,14 @@ export declare class DataCoreWriteRequests {
587
622
  url: string;
588
623
  branch: string;
589
624
  userId?: number | undefined;
590
- credentialId?: string | undefined;
591
625
  relativePath?: string | undefined;
592
626
  purgeDirectory?: boolean | undefined;
593
627
  commitAuthorName?: string | undefined;
594
628
  commitAuthorEmail?: string | undefined;
629
+ commitMessage?: string | undefined;
630
+ pullRequestTitle?: string | undefined;
631
+ pullRequestDescription?: string | undefined;
632
+ credentialId?: string | undefined;
595
633
  connectionId?: string | undefined;
596
634
  } | undefined;
597
635
  destinationAzure?: {
@@ -601,11 +639,14 @@ export declare class DataCoreWriteRequests {
601
639
  repositoryId: string;
602
640
  url?: string | undefined;
603
641
  userId?: number | undefined;
604
- credentialId?: string | undefined;
605
642
  relativePath?: string | undefined;
606
643
  purgeDirectory?: boolean | undefined;
607
644
  commitAuthorName?: string | undefined;
608
645
  commitAuthorEmail?: string | undefined;
646
+ commitMessage?: string | undefined;
647
+ pullRequestTitle?: string | undefined;
648
+ pullRequestDescription?: string | undefined;
649
+ credentialId?: string | undefined;
609
650
  connectionId?: string | undefined;
610
651
  } | undefined;
611
652
  destinationGitlab?: {
@@ -613,11 +654,14 @@ export declare class DataCoreWriteRequests {
613
654
  projectId: string;
614
655
  url?: string | undefined;
615
656
  userId?: number | undefined;
616
- credentialId?: string | undefined;
617
657
  relativePath?: string | undefined;
618
658
  purgeDirectory?: boolean | undefined;
619
659
  commitAuthorName?: string | undefined;
620
660
  commitAuthorEmail?: string | undefined;
661
+ commitMessage?: string | undefined;
662
+ pullRequestTitle?: string | undefined;
663
+ pullRequestDescription?: string | undefined;
664
+ credentialId?: string | undefined;
621
665
  connectionId?: string | undefined;
622
666
  } | undefined;
623
667
  destinationBitbucket?: {
@@ -626,11 +670,14 @@ export declare class DataCoreWriteRequests {
626
670
  projectKey: string;
627
671
  repoSlug: string;
628
672
  userId?: number | undefined;
629
- credentialId?: string | undefined;
630
673
  relativePath?: string | undefined;
631
674
  purgeDirectory?: boolean | undefined;
632
675
  commitAuthorName?: string | undefined;
633
676
  commitAuthorEmail?: string | undefined;
677
+ commitMessage?: string | undefined;
678
+ pullRequestTitle?: string | undefined;
679
+ pullRequestDescription?: string | undefined;
680
+ credentialId?: string | undefined;
634
681
  connectionId?: string | undefined;
635
682
  } | undefined;
636
683
  }>;
@@ -662,6 +709,4 @@ export declare class DataCoreWriteRequests {
662
709
  createPageRedirect(designSystemId: string, body: DTOPageRedirectCreateBody): Promise<void>;
663
710
  updatePageRedirect(designSystemId: string, redirectId: string, body: DTOPageRedirectUpdateBody): Promise<void>;
664
711
  deletePageRedirect(designSystemId: string, redirectId: string): Promise<void>;
665
- /** Remote: imports content into a documentation page */
666
- importRemoteDocumentationPage(designSystemId: string, versionId: string, pageId: string, content: DocumentationPageContent): Promise<any>;
667
712
  }
@@ -11,6 +11,7 @@ export declare abstract class DesignComponentPropertyDefinition {
11
11
  abstract type: DesignComponentPropertyType;
12
12
  abstract defaultValue: string | boolean;
13
13
  name: string;
14
+ options: string[] | null;
14
15
  constructor(model: DesignComponentPropertyDefinitionRemoteType);
15
16
  }
16
17
  export declare class DesignComponentPropertyBoolean extends DesignComponentPropertyDefinition {
@@ -19,6 +19,7 @@ export type DocsBlockFigmaComponentPropertyData = DocsBlockPropertyData<Array<{
19
19
  entityType: "FigmaComponent";
20
20
  entityMeta?: {
21
21
  selectedComponentProperties?: Array<string>;
22
+ selectedComponentVariants?: Record<string, Array<string>>;
22
23
  };
23
24
  }>> & {
24
25
  /** Preview container size */
@@ -13,5 +13,6 @@ export declare class DocsEntityConfiguration {
13
13
  constructor(model: DTODocumentationItemConfigurationV2, title: string);
14
14
  /** Constructs representation that can be used to write full object to remote */
15
15
  toRemote(): DTODocumentationItemConfigurationV2;
16
+ clone(): DocsEntityConfiguration;
16
17
  static default(): DocsEntityConfiguration;
17
18
  }
@@ -21,6 +21,12 @@ export declare class Pipeline {
21
21
  url: string;
22
22
  branch: string;
23
23
  relativePath?: string;
24
+ purgeDirectory?: boolean;
25
+ commitAuthorName?: string;
26
+ commitAuthorEmail?: string;
27
+ commitMessage?: string;
28
+ pullRequestTitle?: string;
29
+ pullRequestDescription?: string;
24
30
  };
25
31
  azure?: {
26
32
  organizationId: string;
@@ -29,12 +35,24 @@ export declare class Pipeline {
29
35
  branch: string;
30
36
  relativePath?: string;
31
37
  url?: string;
38
+ purgeDirectory?: boolean;
39
+ commitAuthorName?: string;
40
+ commitAuthorEmail?: string;
41
+ commitMessage?: string;
42
+ pullRequestTitle?: string;
43
+ pullRequestDescription?: string;
32
44
  };
33
45
  gitlab?: {
34
46
  projectId: string;
35
47
  branch: string;
36
48
  relativePath?: string;
37
49
  url?: string;
50
+ purgeDirectory?: boolean;
51
+ commitAuthorName?: string;
52
+ commitAuthorEmail?: string;
53
+ commitMessage?: string;
54
+ pullRequestTitle?: string;
55
+ pullRequestDescription?: string;
38
56
  };
39
57
  bitbucket?: {
40
58
  workspaceSlug: string;
@@ -43,6 +61,12 @@ export declare class Pipeline {
43
61
  branch: string;
44
62
  relativePath?: string;
45
63
  url?: string;
64
+ purgeDirectory?: boolean;
65
+ commitAuthorName?: string;
66
+ commitAuthorEmail?: string;
67
+ commitMessage?: string;
68
+ pullRequestTitle?: string;
69
+ pullRequestDescription?: string;
46
70
  };
47
71
  };
48
72
  brandPersistentId?: string;
@@ -1,3 +1,4 @@
1
+ import { DTOFigmaNodeStructureDetail } from "@supernova-studio/client";
1
2
  export declare enum FrameType {
2
3
  DOCUMENT = "DOCUMENT",
3
4
  CANVAS = "CANVAS",
@@ -7,16 +8,10 @@ export declare enum FrameType {
7
8
  SECTION = "SECTION",
8
9
  FRAME = "FRAME"
9
10
  }
10
- export type FigmaFrameModel = {
11
- id: string;
12
- name: string;
13
- type: FrameType;
14
- children: Array<FigmaFrameModel>;
15
- };
16
11
  export declare class FigmaFrame {
17
12
  id: string;
18
13
  name: string;
19
14
  type: FrameType;
20
15
  children: Array<FigmaFrame>;
21
- constructor(model: FigmaFrameModel);
16
+ constructor(model: DTOFigmaNodeStructureDetail["rootNode"]);
22
17
  }
@@ -1,3 +1,4 @@
1
+ import { DTOFigmaNodeStructure } from "@supernova-studio/client";
1
2
  export type FigmaStructureModel = {
2
3
  assetsInFile: {
3
4
  componentSets: number;
@@ -11,17 +12,16 @@ export type FigmaStructureModel = {
11
12
  };
12
13
  persistentId: string;
13
14
  };
15
+ export declare enum FigmaStructureImportState {
16
+ failed = "Failed",
17
+ inProgress = "InProgress",
18
+ success = "Success"
19
+ }
14
20
  export declare class FigmaStructure {
15
- assetsInFile: {
16
- componentSets: number;
17
- components: number;
18
- frames: number;
19
- };
20
- designSystemVersionId: string;
21
21
  id: string;
22
- origin: {
23
- sourceId: string;
24
- };
25
- persistentId: string;
26
- constructor(model: FigmaStructureModel);
22
+ sourceId: string;
23
+ createdAt: Date;
24
+ updatedAt: Date;
25
+ state: FigmaStructureImportState;
26
+ constructor(model: DTOFigmaNodeStructure);
27
27
  }