@supernova-studio/supernova-sdk-beta 1.6.49 → 2.0.18

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 (81) hide show
  1. package/README.md +19 -0
  2. package/build/sdk-typescript/src/core/SDKSupernova.d.ts +3 -0
  3. package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +2 -131
  4. package/build/sdk-typescript/src/core/areas/SDKAreaDataSources.d.ts +1 -1
  5. package/build/sdk-typescript/src/core/areas/SDKAreaDesignSystems.d.ts +1 -1
  6. package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +15 -1
  7. package/build/sdk-typescript/src/core/areas/SDKAreaIntegrations.d.ts +1 -73
  8. package/build/sdk-typescript/src/core/areas/SDKAreaTokens.d.ts +1 -1
  9. package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaceIntegrations.d.ts +99 -0
  10. package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +13 -44
  11. package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +6 -2
  12. package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +40 -39
  13. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +19 -37
  14. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +5 -2
  15. package/build/sdk-typescript/src/core/resolvers/SDKDocsEntityMultiplayerItemResolver.d.ts +1 -1
  16. package/build/sdk-typescript/src/exports.d.ts +4 -1
  17. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/figma-component/SDKDocsBlockActualFigmaComponent.d.ts +6 -0
  18. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/figma-component-propstable/SDKDocsBlockActualFigmaComponentPropsTable.d.ts +6 -0
  19. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockFigmaComponentProperty.d.ts +40 -0
  20. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +3 -0
  21. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntity.d.ts +4 -1
  22. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityDraftState.d.ts +16 -0
  23. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityGroup.d.ts +3 -1
  24. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityPage.d.ts +3 -1
  25. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyItem.d.ts +2 -0
  26. package/build/sdk-typescript/src/model/enums/SDKCloudWarningType.d.ts +2 -1
  27. package/build/sdk-typescript/src/model/enums/SDKDocsBlockBehaviorDataType.d.ts +3 -1
  28. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +3 -1
  29. package/build/sdk-typescript/src/model/exporters/SDKPipeline.d.ts +38 -43
  30. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuild.d.ts +7 -7
  31. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuildResults.d.ts +21 -18
  32. package/build/sdk-typescript/src/model/exporters/remote/SDKRemotePipelineModel.d.ts +9 -15
  33. package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +4 -0
  34. package/build/sdk-typescript/src/model/themes/SDKTokenTheme.d.ts +2 -2
  35. package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +2 -2
  36. package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenModel.d.ts +2 -0
  37. package/build/sdk-typescript/src/model/users/SDKUser.d.ts +5 -1
  38. package/build/sdk-typescript/src/model/users/SDKUserProfile.d.ts +23 -12
  39. package/build/sdk-typescript/src/model/users/SDKUserWorkspaceNotificationSettings.d.ts +16 -0
  40. package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceIntegration.d.ts +8 -24
  41. package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceIntegrationGetGitProviders.d.ts +15 -0
  42. package/build/sdk-typescript/src/model/workspaces/integrations/GitProvidersBranches.d.ts +13 -0
  43. package/build/sdk-typescript/src/model/workspaces/integrations/GitProvidersOrganizations.d.ts +15 -0
  44. package/build/sdk-typescript/src/model/workspaces/integrations/GitProvidersProjects.d.ts +15 -0
  45. package/build/sdk-typescript/src/model/workspaces/integrations/GitProvidersRepositories.d.ts +16 -0
  46. package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +11 -0
  47. package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewTypes.d.ts +2 -0
  48. package/build/supernova-sdk-typescript.js +1 -1
  49. package/build/supernova-sdk-typescript.js.map +1 -1
  50. package/package.json +3 -3
  51. package/build/sdk-typescript/src/browser-bundle.d.ts +0 -1
  52. package/build/sdk-typescript/src/model/exporters/CodegenAccount.d.ts +0 -9
  53. package/build/sdk-typescript/src/model/exporters/CodegenAzureBranch.d.ts +0 -7
  54. package/build/sdk-typescript/src/model/exporters/CodegenAzureOrganization.d.ts +0 -7
  55. package/build/sdk-typescript/src/model/exporters/CodegenAzureProject.d.ts +0 -7
  56. package/build/sdk-typescript/src/model/exporters/CodegenAzureRepository.d.ts +0 -11
  57. package/build/sdk-typescript/src/model/exporters/CodegenBitbucketBranch.d.ts +0 -7
  58. package/build/sdk-typescript/src/model/exporters/CodegenBitbucketProject.d.ts +0 -6
  59. package/build/sdk-typescript/src/model/exporters/CodegenBitbucketRepository.d.ts +0 -8
  60. package/build/sdk-typescript/src/model/exporters/CodegenBitbucketWorkspace.d.ts +0 -6
  61. package/build/sdk-typescript/src/model/exporters/CodegenBranch.d.ts +0 -8
  62. package/build/sdk-typescript/src/model/exporters/CodegenConnection.d.ts +0 -10
  63. package/build/sdk-typescript/src/model/exporters/CodegenGitlabBranch.d.ts +0 -7
  64. package/build/sdk-typescript/src/model/exporters/CodegenGitlabGroup.d.ts +0 -6
  65. package/build/sdk-typescript/src/model/exporters/CodegenGitlabRepository.d.ts +0 -9
  66. package/build/sdk-typescript/src/model/exporters/CodegenRepository.d.ts +0 -15
  67. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenBranchModel.d.ts +0 -5
  68. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenOrganizationModel.d.ts +0 -5
  69. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenProjectModel.d.ts +0 -5
  70. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenRepositoryModel.d.ts +0 -9
  71. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenBranchModel.d.ts +0 -5
  72. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenProjectModel.d.ts +0 -4
  73. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenRepositoryModel.d.ts +0 -6
  74. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenWorkspaceModel.d.ts +0 -4
  75. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenAccountModel.d.ts +0 -7
  76. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenBranchModel.d.ts +0 -6
  77. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenConnectionModel.d.ts +0 -8
  78. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenRepositoryModel.d.ts +0 -17
  79. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenBranchModel.d.ts +0 -5
  80. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenGroupModel.d.ts +0 -4
  81. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenRepositoryModel.d.ts +0 -7
@@ -1,5 +1,5 @@
1
- import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODocumentationLinkPreviewRequest, DTODocumentationPageAnchor, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOFigmaNode, // TODO? DTODeleteDocumentationTabGroupInput,
2
- DTOFigmaNodeRenderInput, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
1
+ import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignElementsDataDiffResponse, DTODocumentationLinkPreviewRequest, DTODocumentationPageAnchor, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOFigmaNode, // TODO? DTODeleteDocumentationTabGroupInput,
2
+ DTOFigmaNodeRenderInput, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPublishDocumentationRequest, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
3
3
  import { DocsBlockDefinition, ExportBuildStatus, ResourceFont, TokenThemeOverrideTranserObject } from "../../exports";
4
4
  import { Acl } from "../../model/acl/SDKAcl";
5
5
  import { Asset } from "../../model/assets/SDKAsset";
@@ -20,21 +20,6 @@ import { ConnectionProviders } from "../../model/enums/SDKConnectionProviders";
20
20
  import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
21
21
  import { TokenType } from "../../model/enums/SDKTokenType";
22
22
  import { UserRoleWithoutOwner } from "../../model/enums/SDKUserRole";
23
- import { CodegenAccount } from "../../model/exporters/CodegenAccount";
24
- import { CodegenAzureBranch } from "../../model/exporters/CodegenAzureBranch";
25
- import { CodegenAzureOrganization } from "../../model/exporters/CodegenAzureOrganization";
26
- import { CodegenAzureProject } from "../../model/exporters/CodegenAzureProject";
27
- import { CodegenAzureRepository } from "../../model/exporters/CodegenAzureRepository";
28
- import { CodegenBitbucketBranch } from "../../model/exporters/CodegenBitbucketBranch";
29
- import { CodegenBitbucketProject } from "../../model/exporters/CodegenBitbucketProject";
30
- import { CodegenBitbucketRepository } from "../../model/exporters/CodegenBitbucketRepository";
31
- import { CodegenBitbucketWorkspace } from "../../model/exporters/CodegenBitbucketWorkspace";
32
- import { CodegenBranch } from "../../model/exporters/CodegenBranch";
33
- import { CodegenConnection } from "../../model/exporters/CodegenConnection";
34
- import { CodegenGitlabBranch } from "../../model/exporters/CodegenGitlabBranch";
35
- import { CodegenGitlabGroup } from "../../model/exporters/CodegenGitlabGroup";
36
- import { CodegenGitlabRepository } from "../../model/exporters/CodegenGitlabRepository";
37
- import { CodegenRepository } from "../../model/exporters/CodegenRepository";
38
23
  import { AzurePersonalAccessTokenConnectionPayload, PersonalAccessTokenConnectionPayload } from "../../model/exporters/SDKConnections";
39
24
  import { Exporter, ExporterProvider, NewExporterPayload } from "../../model/exporters/SDKExporter";
40
25
  import { NewPipelinePayload, Pipeline, PipelineUpdateModel } from "../../model/exporters/SDKPipeline";
@@ -60,10 +45,12 @@ import { Token } from "../../model/tokens/SDKToken";
60
45
  import { User } from "../../model/users/SDKUser";
61
46
  import { UserMembership } from "../../model/users/SDKUserMembership";
62
47
  import { UserProfileUpdateModel } from "../../model/users/SDKUserProfile";
48
+ import { UserWorkspaceNotificationSettings, UserWorkspaceNotificationSettingsUpdateModel } from "../../model/users/SDKUserWorkspaceNotificationSettings";
63
49
  import { Workspace } from "../../model/workspaces/SDKWorkspace";
64
50
  import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
65
51
  import { WorkspaceIntegrationType, WorkspaceIntegrations, WorkspaceIntegrationsRemoteModel } from "../../model/workspaces/SDKWorkspaceIntegration";
66
52
  import { WorkspaceIntegrationAccessTokenPayload } from "../../model/workspaces/SDKWorkspaceIntegrationAccessToken";
53
+ import { WorkspaceIntegrationGetGitProvidersInput } from "../../model/workspaces/SDKWorkspaceIntegrationGetGitProviders";
67
54
  import { OAuth2IntegrationTypes, WorkspaceIntegrationOauthRequestRemoteModel } from "../../model/workspaces/SDKWorkspaceIntegrationOauthRequest";
68
55
  import { WorkspaceInvitation, WorkspaceInvitationUpdateModel } from "../../model/workspaces/SDKWorkspaceInvitation";
69
56
  import { WorkspaceInvoice } from "../../model/workspaces/SDKWorkspaceInvoice";
@@ -75,6 +62,10 @@ import { SubscriptionProductFeatures } from "../../model/workspaces/SDKWorkspace
75
62
  import { WorkspaceProfileUpdateModel } from "../../model/workspaces/SDKWorkspaceProfile";
76
63
  import { WorkspaceSSOSettings, WorkspaceSSOSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceSSOSettings";
77
64
  import { WorkspaceSubscription, WorkspaceSubscriptionUpdateModel } from "../../model/workspaces/SDKWorkspaceSubscription";
65
+ import { GitProvidersBranches } from "../../model/workspaces/integrations/GitProvidersBranches";
66
+ import { GitProvidersOrganizations } from "../../model/workspaces/integrations/GitProvidersOrganizations";
67
+ import { GitProvidersProjects } from "../../model/workspaces/integrations/GitProvidersProjects";
68
+ import { GitProvidersRepositories } from "../../model/workspaces/integrations/GitProvidersRepositories";
78
69
  import { ComponentUpdateTransactionData, TokenUpdateTransactionData } from "../areas/SDKAreaBulkOperations";
79
70
  import { RenderedAssetRequestSettings } from "./requests/SDKDataCoreRenderRequests";
80
71
  import { DataBridge } from "./SDKDataBridge";
@@ -105,6 +96,8 @@ export declare class DataCore {
105
96
  memberships(userId: string): Promise<Array<Membership>>;
106
97
  /** Remote: Get information about all workspaces user has access to, including which role they play */
107
98
  userMemberships(workspaceId: string): Promise<Array<UserMembership>>;
99
+ /** Remote: Get information about user workspace notification settings */
100
+ userWorkspaceNotificationSettings(userId: string, workspaceId: string): Promise<UserWorkspaceNotificationSettings>;
108
101
  acls(): Promise<Acl>;
109
102
  /** Deletes the user by id. Can only really delete its own user */
110
103
  deleteUser(userId: string): Promise<void>;
@@ -293,6 +286,7 @@ export declare class DataCore {
293
286
  /** Retrieve the main documentation object through which all docs data can be accessed */
294
287
  documentation(workspaceId: string, designSystemId: string, versionId: string): Promise<DocumentationLegacy>;
295
288
  getDocumentationStructure(designSystemId: string, versionId: string): Promise<(DocsEntityPageModel | DocsEntityGroupModel)[]>;
289
+ getDocumentationElementsDiff(designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<DTODesignElementsDataDiffResponse>;
296
290
  updateDocumentationStructure(designSystemId: string, versionId: string, model: DocumentationLegacyModel): Promise<void>;
297
291
  /** Get ID of the multiplayer room for a given documentation page */
298
292
  getDocumentationPageRoomId(designSystemId: string, versionId: string, pageId: string): Promise<string>;
@@ -304,6 +298,8 @@ export declare class DataCore {
304
298
  documentationDomain(designSystemId: string, versionId: string): Promise<string | null>;
305
299
  /** Publish the documentation */
306
300
  documentationPublish(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<ExportBuild>;
301
+ /** Publish the documentation drafts */
302
+ documentationPublishDrafts(designSystemId: string, versionId: string, environment: DocumentationEnvironment, changes: DTOPublishDocumentationRequest["changes"]): Promise<ExportBuild>;
307
303
  getDocumentationPageAnchors(designSystemId: string, versionId: string, pageId: string): Promise<Array<DTODocumentationPageAnchor>>;
308
304
  /** Retrieve all asset resources */
309
305
  assetResources(designSystemId: string, versionId: string): Promise<Array<ResourceAsset>>;
@@ -320,27 +316,9 @@ export declare class DataCore {
320
316
  /** Delete any multiple resources */
321
317
  deleteResources(designSystemId: string, versionId: string, resourceIds: string[]): Promise<void>;
322
318
  pipelines(workspaceId: string, designSystemId?: string): Promise<Array<Pipeline>>;
323
- githubConnections(): Promise<Array<CodegenConnection>>;
324
- githubAccounts(githubConnectionId: string): Promise<Array<CodegenAccount>>;
325
- githubRepositories(githubConnectionId: string, handle: string): Promise<Array<CodegenRepository>>;
326
- githubBranches(githubConnectionId: string, handle: string, repoName: string): Promise<Array<CodegenBranch>>;
327
- gitlabConnections(): Promise<Array<CodegenConnection>>;
328
- gitlabGroups(connectionId: string): Promise<Array<CodegenGitlabGroup>>;
329
- gitlabRepositories(connectionId: string, groupId: string): Promise<Array<CodegenGitlabRepository>>;
330
- gitlabBranches(connectionId: string, repoId: string): Promise<Array<CodegenGitlabBranch>>;
331
- azureConnections(): Promise<Array<CodegenConnection>>;
332
- azureOrganizations(connectionId: string): Promise<Array<CodegenAzureOrganization>>;
333
- azureProjects(connectionId: string, organizationId: string): Promise<Array<CodegenAzureProject>>;
334
- azureRepositories(connectionId: string, organizationId: string, projectId: string): Promise<Array<CodegenAzureRepository>>;
335
- azureBranches(connectionId: string, organizationId: string, projectId: string, repositoryId: string): Promise<Array<CodegenAzureBranch>>;
336
- bitbucketConnections(): Promise<Array<CodegenConnection>>;
337
- bitbucketWorkspaces(connectionId: string): Promise<Array<CodegenBitbucketWorkspace>>;
338
- bitbucketProjects(connectionId: string, workspaceId: string): Promise<Array<CodegenBitbucketProject>>;
339
- bitbucketRepositories(connectionId: string, workspaceId: string, projectKey?: string): Promise<Array<CodegenBitbucketRepository>>;
340
- bitbucketBranches(connectionId: string, workspaceId: string, projectId: string, repositoryId: string): Promise<Array<CodegenBitbucketBranch>>;
341
319
  createPipeline(workspaceId: string, pipeline: NewPipelinePayload): Promise<Pipeline>;
342
- updatePipeline(workspaceId: string, pipelineUpdateModel: PipelineUpdateModel): Promise<Pipeline>;
343
- runPipeline(workspaceId: string, designSystemVersionId: string, pipelineId: string): Promise<Pipeline>;
320
+ updatePipeline(workspaceId: string, pipelineUpdateModel: PipelineUpdateModel): Promise<void>;
321
+ runPipeline(workspaceId: string, designSystemVersionId: string, pipelineId: string): Promise<void>;
344
322
  deletePipeline(workspaceId: string, pipelineId: string): Promise<void>;
345
323
  /** Download information about current exporter custom blocks and retrieve them resolved */
346
324
  documentationExporterCustomBlocks(designSystemId: string, versionId: string): Promise<Array<ExporterCustomBlock>>;
@@ -402,6 +380,29 @@ export declare class DataCore {
402
380
  workspaceId: string;
403
381
  integrationId: string;
404
382
  }): Promise<WorkspaceIntegrationType>;
383
+ /** Fetch git providers's organization */
384
+ fetchGitProvidersOrganization({ workspaceId, integrationId, }: {
385
+ workspaceId: string;
386
+ integrationId: string;
387
+ }): Promise<GitProvidersOrganizations>;
388
+ /** Fetch git providers's projects */
389
+ fetchGitProviderProjects({ workspaceId, integrationId, params, }: {
390
+ workspaceId: string;
391
+ integrationId: string;
392
+ params?: WorkspaceIntegrationGetGitProvidersInput;
393
+ }): Promise<GitProvidersProjects>;
394
+ /** Fetch git providers's repositories */
395
+ fetchGitProviderRepositories({ workspaceId, integrationId, params, }: {
396
+ workspaceId: string;
397
+ integrationId: string;
398
+ params?: WorkspaceIntegrationGetGitProvidersInput;
399
+ }): Promise<GitProvidersRepositories>;
400
+ /** Fetch git providers's branches */
401
+ fetchGitProviderBranches({ workspaceId, integrationId, params, }: {
402
+ workspaceId: string;
403
+ integrationId: string;
404
+ params?: WorkspaceIntegrationGetGitProvidersInput;
405
+ }): Promise<GitProvidersBranches>;
405
406
  createWorkspace(name: string, handle?: string): Promise<Workspace>;
406
407
  createVersion(designSystemId: string, model: DesignSystemVersionUpdateModel): Promise<DesignSystemVersionCreate>;
407
408
  editVersion(designSystemId: string, versionId: string, model: DesignSystemVersionUpdateModel): Promise<void>;
@@ -432,6 +433,7 @@ export declare class DataCore {
432
433
  updateWorkspaceSSOSettings(workspaceId: string, ssoSettings: WorkspaceSSOSettingsUpdateModel): Promise<void>;
433
434
  updateWorkspaceIPWhitelistSettings(workspaceId: string, ipWhitelistSettings: WorkspaceIPWhitelistSettingsUpdateModel): Promise<void>;
434
435
  updateWorkspaceNPMRegistrySettings(workspaceId: string, npmRegistrySettings: WorkspaceNPMRegistrySettingsUpdateModel): Promise<void>;
436
+ updateUserWorkspaceNotificationSettings(userId: string, workspaceId: string, notificationSettings: UserWorkspaceNotificationSettingsUpdateModel): Promise<void>;
435
437
  updateWorkspaceOwnership(workspaceId: string, newOwnerUserId: string): Promise<void>;
436
438
  updateWorkspaceMemberRole(workspaceId: string, userId: string, newRole: UserRoleWithoutOwner): Promise<void>;
437
439
  updateWorkspaceInvitationRole(workspaceId: string, invitationId: string, newRole: UserRoleWithoutOwner): Promise<void>;
@@ -454,8 +456,8 @@ export declare class DataCore {
454
456
  getBlockDefinitions(designSystemId: string, versionId: string): Promise<Array<DocsBlockDefinition>>;
455
457
  getUrlPreview(designSystemId: string, versionId: string, request: DTODocumentationLinkPreviewRequest): Promise<{
456
458
  linkPreview: {
457
- title?: string | undefined;
458
459
  description?: string | undefined;
460
+ title?: string | undefined;
459
461
  thumbnail?: {
460
462
  type: "Resource" | "FigmaNode";
461
463
  resource?: {
@@ -511,7 +513,6 @@ export declare class DataCore {
511
513
  autoImport?: SourceRemoteModelCloud["autoImportMode"];
512
514
  themeId?: string | null;
513
515
  }): Promise<Source>;
514
- updateFigmaSourceClaimOwnership(designSystemId: string, sourceId: string): Promise<Source>;
515
516
  versions(designSystemId: string): Promise<Array<DesignSystemVersion>>;
516
517
  version(designSystemId: string, versionId: string): Promise<DesignSystemVersion>;
517
518
  versionCreationJob(designSystemId: string, jobId: string): Promise<DesignSystemVersionCreationJob>;
@@ -1,4 +1,4 @@
1
- import { DTODocumentationLinkPreviewRequest, DTOFigmaNode, DTOGetDocumentationPageAnchorsResponse } from "@supernova-studio/client";
1
+ import { DTODesignElementsDataDiffResponse, DTODocumentationLinkPreviewRequest, DTOFigmaNode, DTOGetDocumentationPageAnchorsResponse, DTOPipeline } from "@supernova-studio/client";
2
2
  import { AclRemoteModel } from "../../../model/acl/SDKAcl";
3
3
  import { BrandRemoteModel } from "../../../model/base/SDKBrand";
4
4
  import { DesignSystemRemoteModel } from "../../../model/base/SDKDesignSystem";
@@ -15,27 +15,11 @@ import { ElementPropertyRemoteModel } from "../../../model/elements/SDKElementPr
15
15
  import { ElementPropertyValueRemoteModel } from "../../../model/elements/values/SDKElementPropertyValue";
16
16
  import { DocumentationEnvironment } from "../../../model/enums/SDKDocumentationEnvironment";
17
17
  import { TokenType } from "../../../model/enums/SDKTokenType";
18
- import { CodegenBitbucketProject } from "../../../model/exporters/CodegenBitbucketProject";
19
18
  import { AuthenticationTokens } from "../../../model/exporters/SDKConnections";
20
19
  import { ExporterModel, ExporterProvider } from "../../../model/exporters/SDKExporter";
21
20
  import { ExporterCustomBlockModel } from "../../../model/exporters/custom_blocks/SDKExporterCustomBlock";
22
21
  import { ExportBuildModel, ExportBuildStatus } from "../../../model/exporters/exporter_builds/SDKExportBuild";
23
22
  import { ExportBuildResultLogModel } from "../../../model/exporters/exporter_builds/SDKExportBuildResults";
24
- import { CodegenAzureBranchRemoteModel } from "../../../model/exporters/remote/SDKRemoteAzureCodegenBranchModel";
25
- import { CodegenAzureOrganizationRemoteModel } from "../../../model/exporters/remote/SDKRemoteAzureCodegenOrganizationModel";
26
- import { CodegenAzureProjectRemoteModel } from "../../../model/exporters/remote/SDKRemoteAzureCodegenProjectModel";
27
- import { CodegenAzureRepositoryRemoteModel } from "../../../model/exporters/remote/SDKRemoteAzureCodegenRepositoryModel";
28
- import { CodegenBitbucketBranchRemoteModel } from "../../../model/exporters/remote/SDKRemoteBitbucketCodegenBranchModel";
29
- import { CodegenBitbucketRepositoryRemoteModel } from "../../../model/exporters/remote/SDKRemoteBitbucketCodegenRepositoryModel";
30
- import { CodegenBitbucketWorkspaceRemoteModel } from "../../../model/exporters/remote/SDKRemoteBitbucketCodegenWorkspaceModel";
31
- import { CodegenAccountRemoteModel } from "../../../model/exporters/remote/SDKRemoteCodegenAccountModel";
32
- import { CodegenBranchRemoteModel } from "../../../model/exporters/remote/SDKRemoteCodegenBranchModel";
33
- import { CodegenConnectionRemoteModel } from "../../../model/exporters/remote/SDKRemoteCodegenConnectionModel";
34
- import { CodegenRepositoryRemoteModel } from "../../../model/exporters/remote/SDKRemoteCodegenRepositoryModel";
35
- import { CodegenGitlabBranchRemoteModel } from "../../../model/exporters/remote/SDKRemoteGitlabCodegenBranchModel";
36
- import { CodegenGitlabGroupRemoteModel } from "../../../model/exporters/remote/SDKRemoteGitlabCodegenGroupModel";
37
- import { CodegenGitlabRepositoryRemoteModel } from "../../../model/exporters/remote/SDKRemoteGitlabCodegenRepositoryModel";
38
- import { PipelineRemoteModel } from "../../../model/exporters/remote/SDKRemotePipelineModel";
39
23
  import { ComponentGroupRemoteModel } from "../../../model/groups/SDKComponentGroup";
40
24
  import { DesignComponentGroupRemoteModel } from "../../../model/groups/SDKDesignComponentGroup";
41
25
  import { TokenGroupRemoteModel } from "../../../model/groups/SDKTokenGroup";
@@ -51,9 +35,11 @@ import { TokenThemeRemoteModel } from "../../../model/themes/SDKTokenTheme";
51
35
  import { TokenRemoteModel } from "../../../model/tokens/remote/SDKRemoteTokenModel";
52
36
  import { UserRemoteModel } from "../../../model/users/SDKUser";
53
37
  import { UserMembershipRemoteModel } from "../../../model/users/SDKUserMembership";
38
+ import { UserWorkspaceNotificationSettingsRemoteModel } from "../../../model/users/SDKUserWorkspaceNotificationSettings";
54
39
  import { WorkspaceRemoteModel } from "../../../model/workspaces/SDKWorkspace";
55
40
  import { WorkspaceIPWhitelistSettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
56
41
  import { WorkspaceIntegrationsRemoteModel } from "../../../model/workspaces/SDKWorkspaceIntegration";
42
+ import { GitProviderValues, WorkspaceIntegrationGetGitProvidersInput } from "../../../model/workspaces/SDKWorkspaceIntegrationGetGitProviders";
57
43
  import { OAuth2IntegrationTypes, WorkspaceIntegrationOauthRequestRemoteModel } from "../../../model/workspaces/SDKWorkspaceIntegrationOauthRequest";
58
44
  import { WorkspaceInvitationRemoteModel } from "../../../model/workspaces/SDKWorkspaceInvitation";
59
45
  import { WorkspaceInvoiceRemoteModel } from "../../../model/workspaces/SDKWorkspaceInvoice";
@@ -79,6 +65,8 @@ export declare class DataCoreReadRequests {
79
65
  getRemoteUser(userId: any): Promise<UserRemoteModel>;
80
66
  /** Remote: Get information about all workspaces user can access */
81
67
  getRemoteMemberships(userId: string): Promise<Array<MembershipRemoteModel>>;
68
+ /** Remote: Get user workspace notification settings */
69
+ getRemoteUserWorkspaceNotificationSettings(userId: string, wsId: string): Promise<UserWorkspaceNotificationSettingsRemoteModel>;
82
70
  getRemoteAcls(): Promise<AclRemoteModel>;
83
71
  getRemoteWorkspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeaturesRemoteModel>;
84
72
  /** Remote: Get information about a specific workspace */
@@ -90,6 +78,16 @@ export declare class DataCoreReadRequests {
90
78
  workspaceId: string;
91
79
  type: OAuth2IntegrationTypes;
92
80
  }): Promise<WorkspaceIntegrationOauthRequestRemoteModel>;
81
+ /** Remote: Get workspace's integration git providers data based on the opration
82
+ * * Request Organizations, Repositories, Branches, etc.
83
+ * * This is generic method for all git providers
84
+ */
85
+ getRemoteWorkspaceIntegrationGitProvidersData({ workspaceId, integrationId, operation, params, }: {
86
+ workspaceId: string;
87
+ integrationId: string;
88
+ operation: GitProviderValues;
89
+ params?: WorkspaceIntegrationGetGitProvidersInput;
90
+ }): Promise<unknown>;
93
91
  /** Remote: Validate can use workspace handle */
94
92
  getRemoteIsWorkspaceHandleAvailable(handle: string): Promise<boolean>;
95
93
  /** Remote: Get all users memberships */
@@ -123,6 +121,8 @@ export declare class DataCoreReadRequests {
123
121
  getRemoteDocumentationUrl(designSystemId: string, versionId: string): Promise<string | null>;
124
122
  /** Remote: Get documentation metadata */
125
123
  getRemoteDocumentationStructure(designSystemId: string, versionId: string): Promise<DocumentationLegacyModel>;
124
+ /** Remote: Get documentation elements diff */
125
+ getRemoteDocumentationElementsDiff(designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<DTODesignElementsDataDiffResponse>;
126
126
  /** Remote: Get documentation metadata */
127
127
  getRemoteRealDocumentationStructure(designSystemId: string, versionId: string): Promise<(DocsEntityPageModel | DocsEntityGroupModel)[]>;
128
128
  /** Remote: Get id of the room for a specific page */
@@ -142,8 +142,8 @@ export declare class DataCoreReadRequests {
142
142
  getBlockDefinitions(designSystemId: string, versionId: string): Promise<Array<DocsBlockDefinitionModel>>;
143
143
  getUrlPreview(designSystemId: string, versionId: string, request: DTODocumentationLinkPreviewRequest): Promise<{
144
144
  linkPreview: {
145
- title?: string | undefined;
146
145
  description?: string | undefined;
146
+ title?: string | undefined;
147
147
  thumbnail?: {
148
148
  type: "Resource" | "FigmaNode";
149
149
  resource?: {
@@ -208,25 +208,7 @@ export declare class DataCoreReadRequests {
208
208
  /** Remote: Get all property values that were set by the user for each elemen */
209
209
  getRemoteElementPropertyValues(designSystemId: string, versionId: string): Promise<ElementPropertyValueRemoteModel[]>;
210
210
  getRemoteFigmaFrames(designSystemId: string, versionId: string): Promise<Array<DTOFigmaNode>>;
211
- getRemotePipelines(workspaceId: string, designSystemId?: string): Promise<PipelineRemoteModel[]>;
212
- getRemoteGithubConnections(): Promise<CodegenConnectionRemoteModel[]>;
213
- getRemoteGithubAccounts(githubConnectId: string): Promise<CodegenAccountRemoteModel[]>;
214
- getRemoteGithubRepositories(githubConnectId: string, handle: string): Promise<CodegenRepositoryRemoteModel[]>;
215
- getRemoteGithubBranches(githubConnectId: string, handle: string, repoName: string): Promise<CodegenBranchRemoteModel[]>;
216
- getRemoteGitlabConnections(): Promise<CodegenConnectionRemoteModel[]>;
217
- getRemoteGitlabGroups(connectionId: string): Promise<CodegenGitlabGroupRemoteModel[]>;
218
- getRemoteGitlabRepositories(connectionId: string, groupId: string): Promise<CodegenGitlabRepositoryRemoteModel[]>;
219
- getRemoteGitlabBranches(connectionId: string, repoId: string): Promise<CodegenGitlabBranchRemoteModel[]>;
220
- getRemoteAzureConnections(): Promise<CodegenConnectionRemoteModel[]>;
221
- getRemoteAzureOrganizations(connectionId: string): Promise<CodegenAzureOrganizationRemoteModel[]>;
222
- getRemoteAzureProjects(connectionId: string, organizationId: string): Promise<CodegenAzureProjectRemoteModel[]>;
223
- getRemoteAzureRepositories(connectionId: string, organizationId: string, projectId: string): Promise<CodegenAzureRepositoryRemoteModel[]>;
224
- getRemoteAzureBranches(connectionId: string, organizationId: string, projectId: string, repositoryId: string): Promise<CodegenAzureBranchRemoteModel[]>;
225
- getRemoteBitbucketConnections(): Promise<CodegenConnectionRemoteModel[]>;
226
- getRemoteBitbucketWorkspaces(connectionId: string): Promise<CodegenBitbucketWorkspaceRemoteModel[]>;
227
- getRemoteBitbucketProjects(connectionId: string, worksapceId: string): Promise<CodegenBitbucketProject[]>;
228
- getRemoteBitbucketRepositories(connectionId: string, workspaceId: string, projectKey?: string): Promise<CodegenBitbucketRepositoryRemoteModel[]>;
229
- getRemoteBitbucketBranches(connectionId: string, workspaceId: string, projectId: string, repositoryId: string): Promise<CodegenBitbucketBranchRemoteModel[]>;
211
+ getRemotePipelines(workspaceId: string, designSystemId?: string): Promise<DTOPipeline[]>;
230
212
  getRemoteBuild(workspaceId: string, buildId: string): Promise<ExportBuildModel>;
231
213
  getRemoteBuilds(workspaceId: string, versionId: string, docsEnvironment?: DocumentationEnvironment, limit?: number, offset?: number, scheduleId?: string, exporterId?: string, destinations?: Array<"s3" | "webhook" | "github" | "documentation" | "azure" | "gitlab">, createdByUserId?: string, status?: ExportBuildStatus): Promise<Array<ExportBuildModel>>;
232
214
  getRemoteBuildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLogModel>>;
@@ -1,4 +1,4 @@
1
- import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOFigmaNode, DTOFigmaNodeRenderInput, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
1
+ import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOFigmaNode, DTOFigmaNodeRenderInput, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPublishDocumentationRequest, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
2
2
  import { TokenThemeOverrideTranserObject } from "../../../exports";
3
3
  import { Brand, BrandRemoteModel, BrandUpdateModel } from "../../../model/base/SDKBrand";
4
4
  import { DesignSystem, DesignSystemRemoteModel, DesignSystemSwitcher } from "../../../model/base/SDKDesignSystem";
@@ -26,6 +26,7 @@ import { TokenThemeRemoteModel } from "../../../model/themes/SDKTokenTheme";
26
26
  import { Token } from "../../../model/tokens/SDKToken";
27
27
  import { TokenRemoteModel } from "../../../model/tokens/remote/SDKRemoteTokenModel";
28
28
  import { UserProfileUpdateModel } from "../../../model/users/SDKUserProfile";
29
+ import { UserWorkspaceNotificationSettingsUpdateModel } from "../../../model/users/SDKUserWorkspaceNotificationSettings";
29
30
  import { WorkspaceRemoteModel } from "../../../model/workspaces/SDKWorkspace";
30
31
  import { WorkspaceIPWhitelistSettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
31
32
  import { WorkspaceIntegrationType, WorkspaceIntegrationsRemoteModel } from "../../../model/workspaces/SDKWorkspaceIntegration";
@@ -86,6 +87,8 @@ export declare class DataCoreWriteRequests {
86
87
  updateRemoteWorkspaceIPWhitelistSettings(workspaceId: string, ipWhitelistSettings: WorkspaceIPWhitelistSettingsUpdateModel): Promise<void>;
87
88
  /** Remote: Updates a workspace NPM registry settings */
88
89
  updateRemoteWorkspaceNPMRegistrySettings(workspaceId: string, npmRegistrySettings: WorkspaceNPMRegistrySettingsUpdateModel): Promise<void>;
90
+ /** Remote: Updates a notification settings */
91
+ updateUserWorkspaceNotificationSettings(userId: string, workspaceId: string, notificationSettings: UserWorkspaceNotificationSettingsUpdateModel): Promise<void>;
89
92
  /** Remote: Updates a workspace ownership */
90
93
  updateRemoteWorkspaceOwnership(workspaceId: string, newOwnerUserId: string): Promise<void>;
91
94
  /** Remote: Updates a member role */
@@ -153,6 +156,7 @@ export declare class DataCoreWriteRequests {
153
156
  /** Remote: Deletes a documentation group */
154
157
  deleteRemoteDocumentationGroup(designSystemId: string, versionId: string, data: DTODeleteDocumentationGroupInput): Promise<any>;
155
158
  publishDocumentation(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<ExportBuildModel>;
159
+ publishDocumentationDrafts(designSystemId: string, versionId: string, environment: DocumentationEnvironment, changes: DTOPublishDocumentationRequest["changes"]): Promise<ExportBuildModel>;
156
160
  /** Remote: Render specific figma frames */
157
161
  renderFigmaFrames(designSystemId: string, versionId: string, data: Array<DTOFigmaNodeRenderInput>): Promise<Array<DTOFigmaNode>>;
158
162
  createRemoteToken(designSystemId: string, versionId: string, token: TokenRemoteModel): Promise<TokenRemoteModel>;
@@ -238,7 +242,6 @@ export declare class DataCoreWriteRequests {
238
242
  deleteRemoteSource(designSystemId: string, sourceId: string): Promise<void>;
239
243
  linkFigmaSource(designSystemId: string, data: object): Promise<SourceRemoteModel>;
240
244
  updateFigmaSource(designSystemId: string, sourceId: string, data: object): Promise<SourceRemoteModel>;
241
- updateFigmaSourceClaimOwnership(designSystemId: string, sourceId: string): Promise<SourceRemoteModel>;
242
245
  writeTokenStudioJSONData(designSystemId: string, versionId: string, data: object): Promise<object>;
243
246
  importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", importType: "Upload", payload: any): Promise<ImportJobRemoteModel>;
244
247
  setKeyValueStorageData(designSystemId: string, kvData: object): Promise<void>;
@@ -2,6 +2,6 @@ import { DocsEntityGroupModel, DocsEntityMultiplayerGroup, DocsEntityMultiplayer
2
2
  export declare class DocsEntityMultiplayerItemResolver {
3
3
  hashedItems: Map<string, DocsEntityGroupModel | DocsEntityPageModel>;
4
4
  resolvedItems: Map<string, DocsEntityMultiplayerGroup | DocsEntityMultiplayerPage>;
5
- resolveMultiplayerItems(pageDetails: Array<DocsEntityPageModel>, groupDetails: Array<DocsEntityGroupModel>): Array<DocsEntityMultiplayerGroup | DocsEntityMultiplayerPage>;
5
+ resolveMultiplayerItems(pageDetails: Array<DocsEntityPageModel>, groupDetails: Array<DocsEntityGroupModel>, isPartial?: boolean): Array<DocsEntityMultiplayerGroup | DocsEntityMultiplayerPage>;
6
6
  private resolveItemsForGroup;
7
7
  }
@@ -24,7 +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 { UserProfile } from "./model/users/SDKUserProfile";
27
+ export { UserProfile, UserOnboardingDepartments, UserOnboardingJobLevels, UserOnboardingCompanySizes, UserOnboardingDesignSystemTeamSizes, type UserOnboardingDepartment, type UserOnboardingJobLevel, type UserOnboardingCompanySize, type UserOnboardingDesignSystemTeamSize, type UserOnboardingDefaultDestination, } from "./model/users/SDKUserProfile";
28
28
  export { UserMembership } from "./model/users/SDKUserMembership";
29
29
  export { Acl } from "./model/acl/SDKAcl";
30
30
  export type { AclPermissionResolution } from "./model/acl/SDKAcl";
@@ -65,6 +65,7 @@ export { DocsBlockMode } from "./model/enums/SDKDocBlockMode";
65
65
  export { DocsEntityMultiplayerItemResolver } from "./core/resolvers/SDKDocsEntityMultiplayerItemResolver";
66
66
  export { DocsEntity } from "./model/docs/entities/SDKDocsEntity";
67
67
  export { DocsEntityConfiguration } from "./model/docs/entities/SDKDocsEntityConfiguration";
68
+ export { DocsEntityDraftChangeType, DocsEntityDraftState, } from "./model/docs/entities/SDKDocsEntityDraftState";
68
69
  export type { DocsEntityGroupModel } from "./model/docs/entities/SDKDocsEntityGroup";
69
70
  export { DocsEntityGroup, DocsEntityMultiplayerGroup, } from "./model/docs/entities/SDKDocsEntityGroup";
70
71
  export type { DocsEntityPageModel } from "./model/docs/entities/SDKDocsEntityPage";
@@ -121,6 +122,8 @@ export { DocsBlockColorPropertyDefinition } from "./model/docs/blocks/properties
121
122
  export type { DocsBlockDividerPropertyData, DocsBlockDividerPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockDividerProperty";
122
123
  export { DocsBlockStorybookPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockStorybookProperty";
123
124
  export type { DocsBlockStorybookPropertyData, DocsBlockStorybookPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockStorybookProperty";
125
+ export { DocsBlockFigmaComponentPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockFigmaComponentProperty";
126
+ export type { DocsBlockFigmaComponentPropertyData, DocsBlockFigmaComponentPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockFigmaComponentProperty";
124
127
  export type { DocsColorRef } from "./model/docs/blocks/support/SDKDocsColorRef";
125
128
  export { DocsImageRefType } from "./model/docs/blocks/support/SDKDocsImageRef";
126
129
  export type { DocsImageRef } from "./model/docs/blocks/support/SDKDocsImageRef";
@@ -0,0 +1,6 @@
1
+ /**
2
+ * 5. Block definition
3
+ */
4
+ declare const block: import("../../SDKDocsBlockDefinition").DocsBlockDefinition;
5
+ /** 6. Block export */
6
+ export { block as FigmaComponents };
@@ -0,0 +1,6 @@
1
+ /**
2
+ * 5. Block definition
3
+ */
4
+ declare const block: import("../../SDKDocsBlockDefinition").DocsBlockDefinition;
5
+ /** 6. Block export */
6
+ export { block as FigmaComponentPropsTable };
@@ -0,0 +1,40 @@
1
+ import { DocsBlockContainerSize } from "../../../enums/SDKDocsBlockContainerSize";
2
+ import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
3
+ import { DocsColorRef } from "../support/SDKDocsColorRef";
4
+ import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
5
+ /** Figma Component property - Additional non-value options */
6
+ export type DocsBlockFigmaComponentPropertyOptions = {
7
+ /** How should the Figma component data be rendered in editor.
8
+ * Grid: it should also show additional options it Display options (preview, configuration booleans, etc.)
9
+ * PropsTable: a simple table with the list of all properties
10
+ * Canvas: similar as grid, but all the variant previews are rendered in a canvas
11
+ * Playground: a playground where the user can switch between different variants of the component
12
+ * */
13
+ renderLayoutAs?: "Grid" | "PropsTable" | "Canvas" | "Playground";
14
+ };
15
+ /** Figma Component property - Data */
16
+ export type DocsBlockFigmaComponentPropertyData = DocsBlockPropertyData<Array<{
17
+ entityId: string;
18
+ entityType: "FigmaComponent";
19
+ entityMeta?: {
20
+ title?: string;
21
+ description?: string;
22
+ backgroundColor?: DocsColorRef | null;
23
+ selectedComponentProperties?: Array<string>;
24
+ };
25
+ }>> & {
26
+ /** Preview container size */
27
+ previewContainerSize?: DocsBlockContainerSize.centered | DocsBlockContainerSize.naturalHeight;
28
+ /** If enabled, the component title will be visible in the block */
29
+ showComponentName?: boolean;
30
+ /** If enabled, the component description list will be visible in the block */
31
+ showComponentDescription?: boolean;
32
+ /** If enabled, the list of properties list will be visible in the block */
33
+ showPropertyList?: boolean;
34
+ };
35
+ /** Figma Component property - Definition model */
36
+ export type DocsBlockFigmaComponentPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockFigmaComponentPropertyOptions;
37
+ /** Figma Component property - Definition */
38
+ export declare class DocsBlockFigmaComponentPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockFigmaComponentPropertyOptions, DocsBlockFigmaComponentPropertyData> {
39
+ type: DocsBlockItemPropertyType.figmaComponent;
40
+ }
@@ -20,6 +20,9 @@ export type DocsBlockTokenPropertyOptions = {
20
20
  export type DocsBlockTokenPropertyData = DocsBlockPropertyData<Array<{
21
21
  entityId: string;
22
22
  entityType: "Token" | "TokenGroup";
23
+ entityMeta?: {
24
+ showNestedGroups?: boolean;
25
+ };
23
26
  }>> & {
24
27
  /** Selected token ids */
25
28
  selectedPropertyIds?: Array<string>;
@@ -1,6 +1,7 @@
1
- import { DTODocumentationItemConfigurationV2 } from "@supernova-studio/client";
1
+ import { DTODocumentationDraftState, DTODocumentationItemConfigurationV2 } from "@supernova-studio/client";
2
2
  import { DocsEntityType } from "../../enums/SDKDocsEntityType";
3
3
  import { DocsEntityConfiguration } from "./SDKDocsEntityConfiguration";
4
+ import { DocsEntityDraftState } from "./SDKDocsEntityDraftState";
4
5
  export type DocsEntityModel = {
5
6
  persistentId: string;
6
7
  shortPersistentId: string;
@@ -14,6 +15,7 @@ export type DocsEntityModel = {
14
15
  configuration: DTODocumentationItemConfigurationV2;
15
16
  createdAt?: string;
16
17
  updatedAt?: string;
18
+ draftState?: DTODocumentationDraftState;
17
19
  };
18
20
  export declare class DocsEntity {
19
21
  id: string;
@@ -26,6 +28,7 @@ export declare class DocsEntity {
26
28
  relativeUrl: string | null;
27
29
  createdAt: Date | null;
28
30
  updatedAt: Date | null;
31
+ draftState: DocsEntityDraftState | null;
29
32
  isPrivate: boolean;
30
33
  isHidden: boolean;
31
34
  constructor(model: DocsEntityModel);
@@ -0,0 +1,16 @@
1
+ import { DTODocumentationDraftState } from "@supernova-studio/client";
2
+ import { DocsEntityConfiguration } from "./SDKDocsEntityConfiguration";
3
+ export declare enum DocsEntityDraftChangeType {
4
+ Updated = "Updated",
5
+ Created = "Created",
6
+ Deleted = "Deleted"
7
+ }
8
+ export declare class DocsEntityDraftState {
9
+ changeType: DocsEntityDraftChangeType;
10
+ previousTitle: string | null;
11
+ previousConfiguration: DocsEntityConfiguration | null;
12
+ previousContentHash: string | null;
13
+ constructor(model: DTODocumentationDraftState);
14
+ /** Constructs representation that can be used to write full object to remote */
15
+ toRemote(): DTODocumentationDraftState;
16
+ }
@@ -1,6 +1,7 @@
1
1
  import { DocsEntityGroupBehavior } from "../../enums/SDKDocsEntityGroupBehavior";
2
2
  import { DocsEntityType } from "../../enums/SDKDocsEntityType";
3
3
  import { DocsEntity, DocsEntityModel } from "./SDKDocsEntity";
4
+ import { DocsEntityDraftState } from "./SDKDocsEntityDraftState";
4
5
  import { DocsEntityMultiplayerPage, DocsEntityPage } from "./SDKDocsEntityPage";
5
6
  export type DocsEntityGroupModel = {
6
7
  isRoot: boolean;
@@ -32,7 +33,7 @@ export declare class DocsEntityGroup extends DocsEntity {
32
33
  deployedDocsPageUrl(): string | null;
33
34
  }
34
35
  /** Lightweight page representation used in multiplayer context type-validated against the full version */
35
- export declare class DocsEntityMultiplayerGroup implements Pick<DocsEntityGroup, "id" | "persistentId" | "type" | "title" | "groupBehavior" | "childrenIds" | "isRoot" | "isPrivate" | "isHidden"> {
36
+ export declare class DocsEntityMultiplayerGroup implements Pick<DocsEntityGroup, "id" | "persistentId" | "type" | "title" | "groupBehavior" | "childrenIds" | "isRoot" | "isPrivate" | "isHidden" | "draftState"> {
36
37
  id: string;
37
38
  persistentId: string;
38
39
  type: DocsEntityType.group;
@@ -42,6 +43,7 @@ export declare class DocsEntityMultiplayerGroup implements Pick<DocsEntityGroup,
42
43
  isRoot: boolean;
43
44
  parent: DocsEntityMultiplayerGroup | null;
44
45
  children: Array<DocsEntityMultiplayerGroup | DocsEntityMultiplayerPage>;
46
+ draftState: DocsEntityDraftState | null;
45
47
  isPrivate: boolean;
46
48
  isHidden: boolean;
47
49
  /** Children filtered to be only groups */
@@ -1,5 +1,6 @@
1
1
  import { DocsEntityType } from "../../enums/SDKDocsEntityType";
2
2
  import { DocsEntity, DocsEntityModel } from "./SDKDocsEntity";
3
+ import { DocsEntityDraftState } from "./SDKDocsEntityDraftState";
3
4
  import { DocsEntityMultiplayerGroup } from "./SDKDocsEntityGroup";
4
5
  export type DocsEntityPageModel = {
5
6
  childrenIds: Array<string>;
@@ -26,7 +27,7 @@ export declare class DocsEntityPage extends DocsEntity {
26
27
  relativePageUrl(): string | null;
27
28
  }
28
29
  /** Lightweight page representation used in multiplayer context type-validated against the full version */
29
- export declare class DocsEntityMultiplayerPage implements Pick<DocsEntityPage, "id" | "persistentId" | "type" | "title" | "relativeUrl" | "createdAt" | "isPrivate" | "isHidden"> {
30
+ export declare class DocsEntityMultiplayerPage implements Pick<DocsEntityPage, "id" | "persistentId" | "type" | "title" | "relativeUrl" | "createdAt" | "isPrivate" | "isHidden" | "draftState"> {
30
31
  id: string;
31
32
  persistentId: string;
32
33
  parentId: string | null;
@@ -37,5 +38,6 @@ export declare class DocsEntityMultiplayerPage implements Pick<DocsEntityPage, "
37
38
  createdAt: Date | null;
38
39
  isPrivate: boolean;
39
40
  isHidden: boolean;
41
+ draftState: DocsEntityDraftState | null;
40
42
  constructor(model: DocsEntityPageModel);
41
43
  }
@@ -1,3 +1,4 @@
1
+ import { DocsEntityDraftState } from "../docs/entities/SDKDocsEntityDraftState";
1
2
  import { DocumentationLegacyItemType } from "../enums/SDKDocumentationLegacyItemType";
2
3
  import { DocumentationLegacyItemConfiguration, DocumentationLegacyItemConfigurationModel } from "./configuration/SDKDocumentationLegacyItemConfiguration";
3
4
  export type DocumentationLegacyItemModel = {
@@ -24,5 +25,6 @@ export declare class DocumentationLegacyItem {
24
25
  updatedAt: Date | null;
25
26
  isPrivate: boolean;
26
27
  isHidden: boolean;
28
+ draftState: DocsEntityDraftState | null;
27
29
  constructor(model: DocumentationLegacyItemModel);
28
30
  }
@@ -10,5 +10,6 @@ export declare enum ImportWarningType {
10
10
  ComponentHasNoThumbnail = "ComponentHasNoThumbnail",
11
11
  DuplicateImportedStyleId = "DuplicateImportedStyleId",
12
12
  DuplicateImportedStylePath = "DuplicateImportedStylePath",
13
- NoPublishedElements = "NoPublishedElements"
13
+ NoPublishedElements = "NoPublishedElements",
14
+ NoUnpublishedStyles = "NoUnpublishedStyles"
14
15
  }
@@ -8,5 +8,7 @@ export declare enum DocsBlockBehaviorDataType {
8
8
  /** Component type allows selection of asset entity and associated groups * */
9
9
  component = "Component",
10
10
  /** Figma frame type allows selection of any frame coming from Figma * */
11
- figmaNode = "FigmaNode"
11
+ figmaNode = "FigmaNode",
12
+ /** Figma Component type allows selection of any component coming from Figma * */
13
+ figmaComponent = "FigmaComponent"
12
14
  }
@@ -51,5 +51,7 @@ export declare enum DocsBlockItemPropertyType {
51
51
  /** Color property allows users to select color for further use */
52
52
  color = "Color",
53
53
  /** Figma node property (frames, sections, etc.) */
54
- figmaNode = "FigmaNode"
54
+ figmaNode = "FigmaNode",
55
+ /** Figma component property (Figma components, variants, properties, etc.) */
56
+ figmaComponent = "FigmaComponent"
55
57
  }