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

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 (38) hide show
  1. package/build/sdk-typescript/src/core/SDKSupernova.d.ts +5 -3
  2. package/build/sdk-typescript/src/core/areas/SDKAreaBulkOperations.d.ts +9 -0
  3. package/build/sdk-typescript/src/core/areas/SDKAreaCodeComponents.d.ts +13 -0
  4. package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +5 -6
  5. package/build/sdk-typescript/src/core/areas/SDKAreaImport.d.ts +1 -11
  6. package/build/sdk-typescript/src/core/areas/SDKAreaRawData.d.ts +9 -4
  7. package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +4 -0
  8. package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +9 -9
  9. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +29 -11
  10. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +70 -20
  11. package/build/sdk-typescript/src/exports.d.ts +6 -0
  12. package/build/sdk-typescript/src/model/code-components/SDKCodeComponent.d.ts +15 -0
  13. package/build/sdk-typescript/src/model/code-components/SDKCodeComponentPropertyControlDefinition.d.ts +17 -0
  14. package/build/sdk-typescript/src/model/code-components/SDKCodeComponentPropertyDefinition.d.ts +12 -0
  15. package/build/sdk-typescript/src/model/components/SDKDesignComponentPropertyDefinition.d.ts +1 -0
  16. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockFigmaComponentProperty.d.ts +1 -0
  17. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +2 -0
  18. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityConfiguration.d.ts +1 -0
  19. package/build/sdk-typescript/src/model/elements/SDKElementPropertyOption.d.ts +24 -12
  20. package/build/sdk-typescript/src/model/exporters/SDKPipeline.d.ts +24 -0
  21. package/build/sdk-typescript/src/model/exporters/custom_properties/SDKExporterPropertyArray.d.ts +7 -0
  22. package/build/sdk-typescript/src/model/exporters/custom_properties/SDKExporterPropertyBase.d.ts +1 -1
  23. package/build/sdk-typescript/src/model/exporters/custom_properties/SDKExporterPropertyCode.d.ts +8 -0
  24. package/build/sdk-typescript/src/model/exporters/custom_properties/SDKExporterPropertyDefinition.d.ts +3 -1
  25. package/build/sdk-typescript/src/model/exporters/custom_properties/SDKExporterPropertyObject.d.ts +1 -1
  26. package/build/sdk-typescript/src/model/exporters/custom_properties/SDKExporterPropertyString.d.ts +1 -0
  27. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuildResults.d.ts +0 -6
  28. package/build/sdk-typescript/src/model/support/SDKFigmaFrame.d.ts +2 -7
  29. package/build/sdk-typescript/src/model/support/SDKFigmaStructure.d.ts +11 -11
  30. package/build/sdk-typescript/src/model/support/SDKFigmaStructureDetail.d.ts +6 -29
  31. package/build/sdk-typescript/src/pulsar-interfaces.d.ts +1 -0
  32. package/build/sdk-typescript/src/tests/Tooling/PluginFigmaTokens.spec.token-studio.d.ts +1 -0
  33. package/build/sdk-typescript/src/tests/Tooling/ReadTokens.spec.token-studio.d.ts +1 -0
  34. package/build/sdk-typescript/src/tests/helpers.d.ts +1 -1
  35. package/build/sdk-typescript/src/tests/validators.d.ts +1 -1
  36. package/build/supernova-sdk-typescript.js +1 -1
  37. package/build/supernova-sdk-typescript.js.map +1 -1
  38. package/package.json +12 -13
@@ -3,11 +3,11 @@ import { AreaAssets } from "./areas/SDKAreaAssets";
3
3
  import { AreaAutomation } from "./areas/SDKAreaAutomation";
4
4
  import { AreaBrands } from "./areas/SDKAreaBrands";
5
5
  import { AreaBulkOperations } from "./areas/SDKAreaBulkOperations";
6
+ import { AreaCodeComponents } from "./areas/SDKAreaCodeComponents";
6
7
  import { AreaComponents } from "./areas/SDKAreaComponents";
7
8
  import { AreaDataSources } from "./areas/SDKAreaDataSources";
8
9
  import { AreaDesignSystems } from "./areas/SDKAreaDesignSystems";
9
10
  import { AreaDocumentation } from "./areas/SDKAreaDocumentation";
10
- import { AreaImport } from "./areas/SDKAreaImport";
11
11
  import { AreaIntegrations } from "./areas/SDKAreaIntegrations";
12
12
  import { AreaMe } from "./areas/SDKAreaMe";
13
13
  import { AreaMultiplayer } from "./areas/SDKAreaMultiplayer";
@@ -40,6 +40,8 @@ export declare class Supernova {
40
40
  tokens: AreaTokens;
41
41
  /** Get, create, update, manipulate or delete components */
42
42
  components: AreaComponents;
43
+ /** Get, create, update, manipulate or delete code components */
44
+ codeComponents: AreaCodeComponents;
43
45
  /** Get, create, update, manipulate or delete assets */
44
46
  assets: AreaAssets;
45
47
  /** Get, create, update, manipulate or delete resources */
@@ -60,8 +62,6 @@ export declare class Supernova {
60
62
  dataSources: AreaDataSources;
61
63
  /** Get, create, update, manipulate or delete data from Supernova en masse */
62
64
  bulkOperations: AreaBulkOperations;
63
- /** Import data to Supernova directly */
64
- import: AreaImport;
65
65
  /** Read and write data using Supernova key-value storage */
66
66
  storage: AreaStorage;
67
67
  /** Get access to network in exporter packages */
@@ -85,6 +85,8 @@ export declare class Supernova {
85
85
  requestHook?: DataBridgeRequestHook;
86
86
  bypassEnvFetch?: boolean;
87
87
  proxyUrl?: string;
88
+ isPreview?: boolean;
89
+ jobId?: string;
88
90
  });
89
91
  get apiKeySet(): boolean;
90
92
  }
@@ -1,3 +1,4 @@
1
+ import { DTOElementPropertyValuesEditActionInput } from "@supernova-studio/client";
1
2
  import { BootstrapData } from "../../model/base/SDKBootstrapData";
2
3
  import { Component } from "../../model/components/SDKComponent";
3
4
  import { ElementProperty } from "../../model/elements/SDKElementProperty";
@@ -58,6 +59,14 @@ export declare class AreaBulkOperations {
58
59
  * @returns Nothing
59
60
  */
60
61
  updateTokenData(to: RemoteVersionIdentifier, data: TokenUpdateTransactionData): Promise<void>;
62
+ /** Batch updates element properties into Supernova at once. Use this method to perform bulk change instead of chaining single update operations. Batch routine runs everything in a single transaction, so either all updates succeed or all fail.
63
+ *
64
+ * @param to - Remote version to write to
65
+ * @param data - Update information. All keys except component and its parent are optional and any combination of optional properties is allowed.
66
+ * @returns Nothing
67
+ */
68
+ /** Bulk update properties */
69
+ updateElementProperties(to: RemoteVersionIdentifier, data: DTOElementPropertyValuesEditActionInput["values"]): Promise<any>;
61
70
  /** Batch updates, creates or deletes component data from Supernova at once. Use this method to perform multiple operations at once instead of chaining single update operations. Batch routine runs everything in a single transaction, so either all operations succeed or all fail.
62
71
  *
63
72
  * WARNING: This method is not yet complete and only supports limited set of operations. Also, doesn't work as transation just yet.
@@ -0,0 +1,13 @@
1
+ import { CodeComponent } from "../../model/code-components/SDKCodeComponent";
2
+ import { DataCore } from "../data/SDKDataCore";
3
+ import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
4
+ export declare class AreaCodeComponents {
5
+ /** Internal: Engine */
6
+ private dataCore;
7
+ constructor(dataCore: DataCore);
8
+ /** Fetches all remote code components in the version
9
+ * @param from - Remote version to fetch from
10
+ * @returns All components in the specified version
11
+ */
12
+ getCodeComponents(from: RemoteVersionIdentifier): Promise<Array<CodeComponent>>;
13
+ }
@@ -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";
@@ -13,6 +13,7 @@ import { ComponentGroup, ComponentGroupRemoteModel } from "../../model/groups/SD
13
13
  import { DesignComponentGroupRemoteModel } from "../../model/groups/SDKDesignComponentGroup";
14
14
  import { TokenGroup, TokenGroupRemoteModel } from "../../model/groups/SDKTokenGroup";
15
15
  import { Membership, MembershipRemoteModel } from "../../model/membership/SDKMembership";
16
+ import { ResourceFont, ResourceFontModel } from "../../model/resources/SDKResourceFont";
16
17
  import { Source, SourceRemoteModel } from "../../model/support/SDKSource";
17
18
  import { Token } from "../../model/tokens/SDKToken";
18
19
  import { TokenRemoteModel } from "../../model/tokens/remote/SDKRemoteTokenModel";
@@ -41,10 +42,12 @@ export declare class AreaRawData {
41
42
  }>;
42
43
  /** Fetches raw source data */
43
44
  getRawSourceModelData(designSystemId: string): Promise<Array<SourceRemoteModel>>;
45
+ /** Fetches raw font resources data */
46
+ getRawFontResourcesModelData(designSystemId: string, versionId: string): Promise<Array<ResourceFontModel>>;
44
47
  /** Fetches raw membership */
45
48
  getRawMembershipModelData(userId: string): Promise<Array<MembershipRemoteModel>>;
46
49
  /** Fetches raw design systems */
47
- getRawDesignSystemModelData(workspaceId: string): Promise<Array<DesignSystemRemoteModel>>;
50
+ getRawDesignSystemModelData(workspaceId: string): Promise<Array<DTODesignSystem>>;
48
51
  /** Fetches raw versions */
49
52
  getRawVersionModelData(designSystemId: string): Promise<Array<DesignSystemVersionRemoteModel>>;
50
53
  /** Fetches raw brands */
@@ -73,10 +76,12 @@ export declare class AreaRawData {
73
76
  };
74
77
  /** Build sources */
75
78
  buildSourcesFromRaw(rawData: Array<SourceRemoteModel>): Array<Source>;
79
+ /** Build font resources */
80
+ buildFontResourcesFromRaw(rawData: Array<ResourceFontModel>): Array<ResourceFont>;
76
81
  /** Builds memberships */
77
82
  buildMembershipsFromRaw(rawData: Array<MembershipRemoteModel>): Array<Membership>;
78
83
  /** Builds design systems */
79
- buildDesignSystemsFromRaw(rawData: Array<DesignSystemRemoteModel>): Array<DesignSystem>;
84
+ buildDesignSystemsFromRaw(rawData: Array<DTODesignSystem>): Array<DesignSystem>;
80
85
  /** Builds versions */
81
86
  buildVersionsFromRaw(rawData: Array<DesignSystemVersionRemoteModel>): Array<DesignSystemVersion>;
82
87
  /** 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
- 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";
1
+ import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignElementsDataDiffResponse, DTODocumentationLinkPreviewRequest, DTODocumentationPageAnchor, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOElementActionInput, DTOElementPropertyValuesEditActionInput, 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";
@@ -13,6 +13,7 @@ import { DesignSystemMemberList } from "../../model/base/SDKDesignSystemMemberLi
13
13
  import { DesignSystemVersion, DesignSystemVersionCreate, DesignSystemVersionCreationJob, DesignSystemVersionUpdateModel } from "../../model/base/SDKDesignSystemVersion";
14
14
  import { DesignSystemVersionStats } from "../../model/base/SDKDesignSystemVersionStats";
15
15
  import { DocumentationLegacy, DocumentationLegacyModel } from "../../model/base/SDKDocumentationLegacy";
16
+ import { CodeComponent } from "../../model/code-components/SDKCodeComponent";
16
17
  import { Component } from "../../model/components/SDKComponent";
17
18
  import { DesignComponent } from "../../model/components/SDKDesignComponent";
18
19
  import { DocsEntityGroupModel } from "../../model/docs/entities/SDKDocsEntityGroup";
@@ -71,7 +72,6 @@ import { GitProvidersOrganizations } from "../../model/workspaces/integrations/G
71
72
  import { GitProvidersProjects } from "../../model/workspaces/integrations/GitProvidersProjects";
72
73
  import { GitProvidersRepositories } from "../../model/workspaces/integrations/GitProvidersRepositories";
73
74
  import { ComponentUpdateTransactionData, TokenUpdateTransactionData } from "../areas/SDKAreaBulkOperations";
74
- import { DocumentationPageContent } from "../areas/SDKAreaImport";
75
75
  import { DataCoreReadRequests } from "./requests/SDKDataCoreReadRequests";
76
76
  import { RenderedAssetRequestSettings } from "./requests/SDKDataCoreRenderRequests";
77
77
  import { DataBridge } from "./SDKDataBridge";
@@ -204,6 +204,8 @@ export declare class DataCore {
204
204
  createDocumentationPage(designSystemId: string, versionId: string, payload: Omit<DTOCreateDocumentationPageInputV2, "persistentId">): Promise<string>;
205
205
  /** General element action */
206
206
  elementAction(designSystemId: string, versionId: string, data: DTOElementActionInput): Promise<any>;
207
+ /** Bulk update properties */
208
+ updateElementProperties(designSystemId: string, versionId: string, data: DTOElementPropertyValuesEditActionInput): Promise<any>;
207
209
  /** Update page approval state */
208
210
  updateApprovalState(designSystemId: string, versionId: string, payload: DTODocumentationPageApprovalStateChangeInput): Promise<string>;
209
211
  /** Update design system's access mode and, if switching to invite-only, also the member list */
@@ -301,6 +303,8 @@ export declare class DataCore {
301
303
  deleteComponentGroup(designSystemId: string, versionId: string, componentGroupToDelete: ComponentGroup, components: Array<Component>, componentGroups: Array<ComponentGroup>): Promise<void>;
302
304
  /** Write the component to remote */
303
305
  writeComponentData(designSystemId: string, versionId: string, components: Array<Component>, groups: Array<ComponentGroup>, deleteComponents: Array<Component>, deleteGroups: Array<ComponentGroup>): Promise<void>;
306
+ /** Download all necessary data for code components and retrieve them resolved */
307
+ codeComponents(designSystemId: string, versionId: string): Promise<Array<CodeComponent>>;
304
308
  /** Download all necessary data for assets and retrieve them resolved */
305
309
  assets(designSystemId: string, versionId: string): Promise<Array<Asset>>;
306
310
  /** Download all necessary data for asset groups and retrieve them resolved */
@@ -538,8 +542,8 @@ export declare class DataCore {
538
542
  designSystemMemberList(designSystemId: string): Promise<DesignSystemMemberList>;
539
543
  /** Download information about design system's contacts */
540
544
  designSystemContacts(designSystemId: string): Promise<DesignSystemContactList>;
541
- getFigmaNodeStructures(designSystemId: string, versionId: string): Promise<Array<FigmaStructure>>;
542
- getFigmaNodeStructureDetail(designSystemId: string, versionId: string, figmaStructureId: string): Promise<FigmaStructureDetail>;
545
+ getFigmaNodeStructures(designSystemId: string): Promise<Array<FigmaStructure>>;
546
+ getFigmaNodeStructureDetail(designSystemId: string, figmaStructureId: string): Promise<FigmaStructureDetail>;
543
547
  deleteFigmaSource(designSystemId: string, sourceId: string): Promise<void>;
544
548
  linkFigmaSource(designSystemId: string, brandId: string, url: string, options: {
545
549
  scopes: {
@@ -596,8 +600,4 @@ export declare class DataCore {
596
600
  createPageRedirect(designSystemId: string, body: DTOPageRedirectCreateBody): Promise<void>;
597
601
  updatePageRedirect(designSystemId: string, redirectId: string, body: DTOPageRedirectUpdateBody): Promise<void>;
598
602
  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
603
  }
@@ -1,10 +1,10 @@
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";
6
5
  import { DesignSystemVersionCreationJobRemoteModel, DesignSystemVersionRemoteModel } from "../../../model/base/SDKDesignSystemVersion";
7
6
  import { DocumentationLegacyModel } from "../../../model/base/SDKDocumentationLegacy";
7
+ import { CodeComponentRemoteModel } from "../../../model/code-components/SDKCodeComponent";
8
8
  import { ComponentRemoteModel } from "../../../model/components/SDKComponent";
9
9
  import { DesignComponentRemoteModel } from "../../../model/components/SDKDesignComponent";
10
10
  import { DocsBlockDefinitionModel } from "../../../model/docs/blocks/definition/SDKDocsBlockDefinition";
@@ -29,8 +29,6 @@ import { MembershipRemoteModel } from "../../../model/membership/SDKMembership";
29
29
  import { ResourceAssetModel } from "../../../model/resources/SDKResourceAsset";
30
30
  import { ResourceFontModel } from "../../../model/resources/SDKResourceFont";
31
31
  import { CustomDomainRemoteModel } from "../../../model/support/SDKCustomDomain";
32
- import { FigmaStructureModel } from "../../../model/support/SDKFigmaStructure";
33
- import { FigmaStructureDetailModel } from "../../../model/support/SDKFigmaStructureDetail";
34
32
  import { SourceRemoteModel } from "../../../model/support/SDKSource";
35
33
  import { TokenThemeRemoteModel } from "../../../model/themes/SDKTokenTheme";
36
34
  import { TokenRemoteModel } from "../../../model/tokens/remote/SDKRemoteTokenModel";
@@ -51,7 +49,6 @@ import { WorkspaceProductRemoteModel } from "../../../model/workspaces/SDKWorksp
51
49
  import { SubscriptionProductFeaturesRemoteModel } from "../../../model/workspaces/SDKWorkspaceProductFeatures";
52
50
  import { WorkspaceSSOSettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceSSOSettings";
53
51
  import { WorkspaceSubscriptionRemoteModel } from "../../../model/workspaces/SDKWorkspaceSubscription";
54
- import { RemoteWorkspaceVersionIdentifier } from "../../areas/SDKRemoteIdentifiers";
55
52
  import { DataBridge } from "../SDKDataBridge";
56
53
  export declare class DataCoreReadRequests {
57
54
  private bridge;
@@ -116,9 +113,33 @@ export declare class DataCoreReadRequests {
116
113
  /** Remote: Get all design sources of a single design system */
117
114
  getRemoteSources(designSystemId: string): Promise<Array<SourceRemoteModel>>;
118
115
  /** Remote: Get all figma node structures */
119
- getFigmaNodeStructures(designSystemId: string, versionId: string): Promise<Array<FigmaStructureModel>>;
116
+ getFigmaNodeStructures(designSystemId: string): Promise<{
117
+ id: string;
118
+ createdAt: Date;
119
+ updatedAt: Date;
120
+ sourceId: string;
121
+ importState: "Success" | "InProgress" | "Failed";
122
+ }[]>;
120
123
  /** Remote: Get figma node detail */
121
- getFigmaNodeStructureDetail(designSystemId: string, versionId: string, figmaStructureId: string): Promise<FigmaStructureDetailModel>;
124
+ getFigmaNodeStructureDetail(designSystemId: string, figmaStructureId: string): Promise<{
125
+ id: string;
126
+ createdAt: Date;
127
+ updatedAt: Date;
128
+ sourceId: string;
129
+ importState: "Success" | "InProgress" | "Failed";
130
+ rootNode: {
131
+ type: "DOCUMENT" | "CANVAS" | "COMPONENT_SET" | "COMPONENT" | "FRAME";
132
+ id: string;
133
+ name: string;
134
+ size?: {
135
+ width: number;
136
+ height: number;
137
+ } | undefined;
138
+ parentComponentSetId?: string | undefined;
139
+ } & {
140
+ children: import("@supernova-studio/model").FigmaFileStructureNode[];
141
+ };
142
+ }>;
122
143
  /** Remote: Get information about design system's members */
123
144
  getRemoteDesignSystemMemberList(designSystemId: string): Promise<DTODesignSystemMemberListResponse>;
124
145
  getRemoteContacts(designSystemId: string): Promise<DTODesignSystemContactsResponse>;
@@ -206,6 +227,8 @@ export declare class DataCoreReadRequests {
206
227
  getRemoteDesignComponentGroups(designSystemId: string, versionId: string, filter?: {
207
228
  brandId?: string;
208
229
  }): Promise<Array<DesignComponentGroupRemoteModel>>;
230
+ /** Remote: Get code components */
231
+ getRemoteCodeComponents(designSystemId: string, versionId: string): Promise<Array<CodeComponentRemoteModel>>;
209
232
  /** Remote: Get assets (right now, those are only components coming from Figma, but this will change in the future) */
210
233
  getRemoteAssets(designSystemId: string, versionId: string): Promise<Array<DesignComponentRemoteModel>>;
211
234
  /** Remote: Get design component groups (right now, those are only components coming from Figma, but this will change in the future) */
@@ -242,9 +265,4 @@ export declare class DataCoreReadRequests {
242
265
  designSystemId: string;
243
266
  pagePersistentId: string;
244
267
  }[]>;
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
268
  }
@@ -1,4 +1,4 @@
1
- import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignSystem, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOElementActionInput, DTOExporterPropertyValueMap, DTOFigmaNode, DTOFigmaNodeRenderIdInput, DTOFigmaNodeRenderInput, DTOFigmaNodeV2, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPageRedirectCreateBody, DTOPageRedirectUpdateBody, DTOPipelineCreateBody, DTOPipelineUpdateBody, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
1
+ import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignSystem, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOElementActionInput, DTOElementPropertyValuesEditActionInput, 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
3
  import { DesignSystemAccessMode, ExporterJobDestination, TokenThemeOverrideTranserObject, UserRole } from "../../../exports";
4
4
  import { Brand, BrandRemoteModel, BrandUpdateModel } from "../../../model/base/SDKBrand";
@@ -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);
@@ -141,6 +140,7 @@ export declare class DataCoreWriteRequests {
141
140
  /** Remote: Deletes a design system */
142
141
  deleteDesignSystem(designSystemId: string): Promise<void>;
143
142
  elementAction(designSystemId: string, versionId: string, data: DTOElementActionInput): Promise<any>;
143
+ updateElementProperties(designSystemId: string, versionId: string, data: DTOElementPropertyValuesEditActionInput): Promise<any>;
144
144
  createRemoteDocumentationPage(designSystemId: string, versionId: string, data: DTOCreateDocumentationPageInputV2): Promise<any>;
145
145
  updateApprovalState(designSystemId: string, versionId: string, data: DTODocumentationPageApprovalStateChangeInput): Promise<any>;
146
146
  /** Remote: create a group within documentation */
@@ -262,11 +262,14 @@ export declare class DataCoreWriteRequests {
262
262
  repositoryId: string;
263
263
  url?: string | undefined;
264
264
  userId?: number | undefined;
265
- credentialId?: string | undefined;
266
265
  relativePath?: string | undefined;
267
266
  purgeDirectory?: boolean | undefined;
268
267
  commitAuthorName?: string | undefined;
269
268
  commitAuthorEmail?: string | undefined;
269
+ commitMessage?: string | undefined;
270
+ pullRequestTitle?: string | undefined;
271
+ pullRequestDescription?: string | undefined;
272
+ credentialId?: string | undefined;
270
273
  connectionId?: string | undefined;
271
274
  } | undefined;
272
275
  bitbucket?: {
@@ -274,23 +277,30 @@ export declare class DataCoreWriteRequests {
274
277
  workspaceSlug: string;
275
278
  projectKey: string;
276
279
  repoSlug: string;
280
+ url?: string | undefined;
277
281
  userId?: number | undefined;
278
- credentialId?: string | undefined;
279
282
  relativePath?: string | undefined;
280
283
  purgeDirectory?: boolean | undefined;
281
284
  commitAuthorName?: string | undefined;
282
285
  commitAuthorEmail?: string | undefined;
286
+ commitMessage?: string | undefined;
287
+ pullRequestTitle?: string | undefined;
288
+ pullRequestDescription?: string | undefined;
289
+ credentialId?: string | undefined;
283
290
  connectionId?: string | undefined;
284
291
  } | undefined;
285
292
  github?: {
286
293
  url: string;
287
294
  branch: string;
288
295
  userId?: number | undefined;
289
- credentialId?: string | undefined;
290
296
  relativePath?: string | undefined;
291
297
  purgeDirectory?: boolean | undefined;
292
298
  commitAuthorName?: string | undefined;
293
299
  commitAuthorEmail?: string | undefined;
300
+ commitMessage?: string | undefined;
301
+ pullRequestTitle?: string | undefined;
302
+ pullRequestDescription?: string | undefined;
303
+ credentialId?: string | undefined;
294
304
  connectionId?: string | undefined;
295
305
  } | undefined;
296
306
  gitlab?: {
@@ -298,11 +308,14 @@ export declare class DataCoreWriteRequests {
298
308
  projectId: string;
299
309
  url?: string | undefined;
300
310
  userId?: number | undefined;
301
- credentialId?: string | undefined;
302
311
  relativePath?: string | undefined;
303
312
  purgeDirectory?: boolean | undefined;
304
313
  commitAuthorName?: string | undefined;
305
314
  commitAuthorEmail?: string | undefined;
315
+ commitMessage?: string | undefined;
316
+ pullRequestTitle?: string | undefined;
317
+ pullRequestDescription?: string | undefined;
318
+ credentialId?: string | undefined;
306
319
  connectionId?: string | undefined;
307
320
  } | undefined;
308
321
  documentation?: {
@@ -386,11 +399,14 @@ export declare class DataCoreWriteRequests {
386
399
  url: string;
387
400
  branch: string;
388
401
  userId?: number | undefined;
389
- credentialId?: string | undefined;
390
402
  relativePath?: string | undefined;
391
403
  purgeDirectory?: boolean | undefined;
392
404
  commitAuthorName?: string | undefined;
393
405
  commitAuthorEmail?: string | undefined;
406
+ commitMessage?: string | undefined;
407
+ pullRequestTitle?: string | undefined;
408
+ pullRequestDescription?: string | undefined;
409
+ credentialId?: string | undefined;
394
410
  connectionId?: string | undefined;
395
411
  } | undefined;
396
412
  destinationAzure?: {
@@ -400,11 +416,14 @@ export declare class DataCoreWriteRequests {
400
416
  repositoryId: string;
401
417
  url?: string | undefined;
402
418
  userId?: number | undefined;
403
- credentialId?: string | undefined;
404
419
  relativePath?: string | undefined;
405
420
  purgeDirectory?: boolean | undefined;
406
421
  commitAuthorName?: string | undefined;
407
422
  commitAuthorEmail?: string | undefined;
423
+ commitMessage?: string | undefined;
424
+ pullRequestTitle?: string | undefined;
425
+ pullRequestDescription?: string | undefined;
426
+ credentialId?: string | undefined;
408
427
  connectionId?: string | undefined;
409
428
  } | undefined;
410
429
  destinationGitlab?: {
@@ -412,11 +431,14 @@ export declare class DataCoreWriteRequests {
412
431
  projectId: string;
413
432
  url?: string | undefined;
414
433
  userId?: number | undefined;
415
- credentialId?: string | undefined;
416
434
  relativePath?: string | undefined;
417
435
  purgeDirectory?: boolean | undefined;
418
436
  commitAuthorName?: string | undefined;
419
437
  commitAuthorEmail?: string | undefined;
438
+ commitMessage?: string | undefined;
439
+ pullRequestTitle?: string | undefined;
440
+ pullRequestDescription?: string | undefined;
441
+ credentialId?: string | undefined;
420
442
  connectionId?: string | undefined;
421
443
  } | undefined;
422
444
  destinationBitbucket?: {
@@ -424,12 +446,16 @@ export declare class DataCoreWriteRequests {
424
446
  workspaceSlug: string;
425
447
  projectKey: string;
426
448
  repoSlug: string;
449
+ url?: string | undefined;
427
450
  userId?: number | undefined;
428
- credentialId?: string | undefined;
429
451
  relativePath?: string | undefined;
430
452
  purgeDirectory?: boolean | undefined;
431
453
  commitAuthorName?: string | undefined;
432
454
  commitAuthorEmail?: string | undefined;
455
+ commitMessage?: string | undefined;
456
+ pullRequestTitle?: string | undefined;
457
+ pullRequestDescription?: string | undefined;
458
+ credentialId?: string | undefined;
433
459
  connectionId?: string | undefined;
434
460
  } | undefined;
435
461
  }>;
@@ -463,11 +489,14 @@ export declare class DataCoreWriteRequests {
463
489
  repositoryId: string;
464
490
  url?: string | undefined;
465
491
  userId?: number | undefined;
466
- credentialId?: string | undefined;
467
492
  relativePath?: string | undefined;
468
493
  purgeDirectory?: boolean | undefined;
469
494
  commitAuthorName?: string | undefined;
470
495
  commitAuthorEmail?: string | undefined;
496
+ commitMessage?: string | undefined;
497
+ pullRequestTitle?: string | undefined;
498
+ pullRequestDescription?: string | undefined;
499
+ credentialId?: string | undefined;
471
500
  connectionId?: string | undefined;
472
501
  } | undefined;
473
502
  bitbucket?: {
@@ -475,23 +504,30 @@ export declare class DataCoreWriteRequests {
475
504
  workspaceSlug: string;
476
505
  projectKey: string;
477
506
  repoSlug: string;
507
+ url?: string | undefined;
478
508
  userId?: number | undefined;
479
- credentialId?: string | undefined;
480
509
  relativePath?: string | undefined;
481
510
  purgeDirectory?: boolean | undefined;
482
511
  commitAuthorName?: string | undefined;
483
512
  commitAuthorEmail?: string | undefined;
513
+ commitMessage?: string | undefined;
514
+ pullRequestTitle?: string | undefined;
515
+ pullRequestDescription?: string | undefined;
516
+ credentialId?: string | undefined;
484
517
  connectionId?: string | undefined;
485
518
  } | undefined;
486
519
  github?: {
487
520
  url: string;
488
521
  branch: string;
489
522
  userId?: number | undefined;
490
- credentialId?: string | undefined;
491
523
  relativePath?: string | undefined;
492
524
  purgeDirectory?: boolean | undefined;
493
525
  commitAuthorName?: string | undefined;
494
526
  commitAuthorEmail?: string | undefined;
527
+ commitMessage?: string | undefined;
528
+ pullRequestTitle?: string | undefined;
529
+ pullRequestDescription?: string | undefined;
530
+ credentialId?: string | undefined;
495
531
  connectionId?: string | undefined;
496
532
  } | undefined;
497
533
  gitlab?: {
@@ -499,11 +535,14 @@ export declare class DataCoreWriteRequests {
499
535
  projectId: string;
500
536
  url?: string | undefined;
501
537
  userId?: number | undefined;
502
- credentialId?: string | undefined;
503
538
  relativePath?: string | undefined;
504
539
  purgeDirectory?: boolean | undefined;
505
540
  commitAuthorName?: string | undefined;
506
541
  commitAuthorEmail?: string | undefined;
542
+ commitMessage?: string | undefined;
543
+ pullRequestTitle?: string | undefined;
544
+ pullRequestDescription?: string | undefined;
545
+ credentialId?: string | undefined;
507
546
  connectionId?: string | undefined;
508
547
  } | undefined;
509
548
  documentation?: {
@@ -587,11 +626,14 @@ export declare class DataCoreWriteRequests {
587
626
  url: string;
588
627
  branch: string;
589
628
  userId?: number | undefined;
590
- credentialId?: string | undefined;
591
629
  relativePath?: string | undefined;
592
630
  purgeDirectory?: boolean | undefined;
593
631
  commitAuthorName?: string | undefined;
594
632
  commitAuthorEmail?: string | undefined;
633
+ commitMessage?: string | undefined;
634
+ pullRequestTitle?: string | undefined;
635
+ pullRequestDescription?: string | undefined;
636
+ credentialId?: string | undefined;
595
637
  connectionId?: string | undefined;
596
638
  } | undefined;
597
639
  destinationAzure?: {
@@ -601,11 +643,14 @@ export declare class DataCoreWriteRequests {
601
643
  repositoryId: string;
602
644
  url?: string | undefined;
603
645
  userId?: number | undefined;
604
- credentialId?: string | undefined;
605
646
  relativePath?: string | undefined;
606
647
  purgeDirectory?: boolean | undefined;
607
648
  commitAuthorName?: string | undefined;
608
649
  commitAuthorEmail?: string | undefined;
650
+ commitMessage?: string | undefined;
651
+ pullRequestTitle?: string | undefined;
652
+ pullRequestDescription?: string | undefined;
653
+ credentialId?: string | undefined;
609
654
  connectionId?: string | undefined;
610
655
  } | undefined;
611
656
  destinationGitlab?: {
@@ -613,11 +658,14 @@ export declare class DataCoreWriteRequests {
613
658
  projectId: string;
614
659
  url?: string | undefined;
615
660
  userId?: number | undefined;
616
- credentialId?: string | undefined;
617
661
  relativePath?: string | undefined;
618
662
  purgeDirectory?: boolean | undefined;
619
663
  commitAuthorName?: string | undefined;
620
664
  commitAuthorEmail?: string | undefined;
665
+ commitMessage?: string | undefined;
666
+ pullRequestTitle?: string | undefined;
667
+ pullRequestDescription?: string | undefined;
668
+ credentialId?: string | undefined;
621
669
  connectionId?: string | undefined;
622
670
  } | undefined;
623
671
  destinationBitbucket?: {
@@ -625,12 +673,16 @@ export declare class DataCoreWriteRequests {
625
673
  workspaceSlug: string;
626
674
  projectKey: string;
627
675
  repoSlug: string;
676
+ url?: string | undefined;
628
677
  userId?: number | undefined;
629
- credentialId?: string | undefined;
630
678
  relativePath?: string | undefined;
631
679
  purgeDirectory?: boolean | undefined;
632
680
  commitAuthorName?: string | undefined;
633
681
  commitAuthorEmail?: string | undefined;
682
+ commitMessage?: string | undefined;
683
+ pullRequestTitle?: string | undefined;
684
+ pullRequestDescription?: string | undefined;
685
+ credentialId?: string | undefined;
634
686
  connectionId?: string | undefined;
635
687
  } | undefined;
636
688
  }>;
@@ -662,6 +714,4 @@ export declare class DataCoreWriteRequests {
662
714
  createPageRedirect(designSystemId: string, body: DTOPageRedirectCreateBody): Promise<void>;
663
715
  updatePageRedirect(designSystemId: string, redirectId: string, body: DTOPageRedirectUpdateBody): Promise<void>;
664
716
  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
717
  }