@supernova-studio/supernova-sdk-beta 2.0.28 → 2.0.30

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 (27) hide show
  1. package/build/sdk-typescript/src/core/areas/SDKAreaDesignSystems.d.ts +6 -0
  2. package/build/sdk-typescript/src/core/areas/SDKAreaTokens.d.ts +6 -0
  3. package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +4 -10
  4. package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +11 -10
  5. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +3 -3
  6. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +4 -5
  7. package/build/sdk-typescript/src/exports.d.ts +1 -1
  8. package/build/sdk-typescript/src/model/base/SDKDesignSystemCollection.d.ts +13 -0
  9. package/build/sdk-typescript/src/model/base/SDKDesignSystemContactList.d.ts +17 -0
  10. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts +5 -0
  11. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockFigmaComponentProperty.d.ts +2 -0
  12. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockFigmaNodeProperty.d.ts +2 -0
  13. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockImageProperty.d.ts +4 -0
  14. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +7 -0
  15. package/build/sdk-typescript/src/model/enums/SDKDocsBlockTokenNameFormat.d.ts +10 -0
  16. package/build/sdk-typescript/src/model/enums/SDKUserRole.d.ts +0 -1
  17. package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +3 -0
  18. package/build/sdk-typescript/src/model/tokens/SDKToken.d.ts +1 -0
  19. package/build/sdk-typescript/src/model/tokens/SDKTokenValue.d.ts +1 -0
  20. package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenModel.d.ts +1 -0
  21. package/build/sdk-typescript/src/model/users/SDKInspectableUser.d.ts +17 -0
  22. package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceInvitation.d.ts +2 -2
  23. package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProfile.d.ts +0 -4
  24. package/build/sdk-typescript/src/utils/TokenUtils.d.ts +1 -0
  25. package/build/supernova-sdk-typescript.js +1 -1
  26. package/build/supernova-sdk-typescript.js.map +1 -1
  27. package/package.json +3 -3
@@ -1,6 +1,7 @@
1
1
  import { DTODocumentationLinkPreviewRequest, DTODocumentationPageApprovalStateChangeInput } from "@supernova-studio/client";
2
2
  import { DesignSystemInvite, DesignSystemInviteUpdate, DesignSystemMemberUpdate, DesignSystemPendingMemberInvite, DesignSystemUserInvitation } from "@supernova-studio/model";
3
3
  import { DesignSystem, DesignSystemAccessMode, DesignSystemSwitcher } from "../../model/base/SDKDesignSystem";
4
+ import { DesignSystemContactList } from "../../model/base/SDKDesignSystemContactList";
4
5
  import { DesignSystemMemberList } from "../../model/base/SDKDesignSystemMemberList";
5
6
  import { CustomDomain } from "../../model/support/SDKCustomDomain";
6
7
  import { DataCore } from "../data/SDKDataCore";
@@ -28,6 +29,11 @@ export declare class AreaDesignSystems {
28
29
  * @returns Design system's memberships
29
30
  */
30
31
  designSystemMemberList(designSystemId: string): Promise<DesignSystemMemberList>;
32
+ /** Fetches specific design system's contacts
33
+ * @param designSystemId - Design system's identifier
34
+ * @returns Design system's contacts
35
+ */
36
+ designSystemContactList(designSystemId: string): Promise<DesignSystemContactList>;
31
37
  /** Creates a new design system and retrieves the newly created DS object
32
38
  * @param workspaceId - Workspace to create the design system in
33
39
  * @param name - Name of the design system
@@ -1,4 +1,5 @@
1
1
  import { AnyToken } from "../../exports";
2
+ import { DesignSystemCollection } from "../../model/base/SDKDesignSystemCollection";
2
3
  import { ElementDataView } from "../../model/elements/SDKElementDataView";
3
4
  import { ElementDataViewColumn } from "../../model/elements/SDKElementDataViewColumn";
4
5
  import { ElementProperty, ElementPropertyCreationModel, ElementPropertyUpdateModel } from "../../model/elements/SDKElementProperty";
@@ -69,6 +70,11 @@ export declare class AreaTokens {
69
70
  * @returns All property views in the specified version
70
71
  */
71
72
  getTokenDataViews(from: RemoteVersionIdentifier): Promise<Array<ElementDataView>>;
73
+ /** Retrieves all token collections
74
+ * @param from - Remote version to fetch from
75
+ * @returns All token collections in the specified version
76
+ */
77
+ getTokenCollections(from: RemoteVersionIdentifier): Promise<Array<DesignSystemCollection>>;
72
78
  /** Creates remote token. This method can only be used once per token and will assign persistent id to the token. Calling this version on token that already has id assigned will result in error
73
79
  * @param to - Remote version to write to
74
80
  * @param token - Token to create
@@ -1,5 +1,5 @@
1
1
  import { Acl } from "../../model/acl/SDKAcl";
2
- import { UserRoleWithoutOwner } from "../../model/enums/SDKUserRole";
2
+ import { UserRole } from "../../model/enums/SDKUserRole";
3
3
  import { Membership } from "../../model/membership/SDKMembership";
4
4
  import { UserMembership } from "../../model/users/SDKUserMembership";
5
5
  import { UserWorkspaceNotificationSettings, UserWorkspaceNotificationSettingsUpdateModel } from "../../model/users/SDKUserWorkspaceNotificationSettings";
@@ -52,11 +52,6 @@ export declare class AreaWorkspaces {
52
52
  */
53
53
  workspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeatures>;
54
54
  acls(): Promise<Acl>;
55
- /** Validates if the handle is available for use
56
- * @param handle - Handle to validate
57
- * @returns True if the handle is available (not occupied by any other workspace), false otherwise
58
- */
59
- validateIsWorkspaceHandleAvailable(handle: string): Promise<boolean>;
60
55
  /** Fetches workspace onboarding status
61
56
  * @param workspaceId - ID of the workspace
62
57
  * @returns Workspace onboarding status
@@ -104,10 +99,9 @@ export declare class AreaWorkspaces {
104
99
  workspaceAvailableProducts(workspaceId: string): Promise<Array<WorkspaceProduct>>;
105
100
  /** Creates new workspace and retrieves the newly created workspace object. The user who creates the workspace becomes its owner
106
101
  * @param name - Name of the workspace
107
- * @param handle - Handle of the workspace to create. Use `validateIsWorkspaceHandleAvailable` to check if the handle is available
108
102
  * @returns Newly created workspace object
109
103
  */
110
- createWorkspace(name: string, handle?: string): Promise<Workspace>;
104
+ createWorkspace(name: string): Promise<Workspace>;
111
105
  /** Updates workspace profile for a specific workspace
112
106
  * @param workspaceId - ID of the workspace
113
107
  * @param update - New profile data
@@ -171,14 +165,14 @@ export declare class AreaWorkspaces {
171
165
  * @param newRole - New role of the user
172
166
  * @returns Nothing
173
167
  */
174
- updateWorkspaceMemberRole(workspaceId: string, userId: string, newRole: UserRoleWithoutOwner): Promise<void>;
168
+ updateWorkspaceMemberRole(workspaceId: string, userId: string, newRole: UserRole): Promise<void>;
175
169
  /** Updates a role of an invitation.
176
170
  * @param workspaceId - ID of the workspace
177
171
  * @param invitationId - ID of the invitation
178
172
  * @param newRole - New role
179
173
  * @returns Nothing
180
174
  */
181
- updateWorkspaceInvitationRole(workspaceId: string, invitationId: string, newRole: UserRoleWithoutOwner): Promise<void>;
175
+ updateWorkspaceInvitationRole(workspaceId: string, invitationId: string, newRole: UserRole): Promise<void>;
182
176
  /** Invites new members to the workspace
183
177
  * @param workspaceId - ID of the workspace
184
178
  * @param invitations - array of invitations
@@ -1,13 +1,14 @@
1
- import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignElementsDataDiffResponse, DTODocumentationLinkPreviewRequest, DTODocumentationPageAnchor, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOFigmaNode, // TODO? DTODeleteDocumentationTabGroupInput,
2
- DTOFigmaNodeRenderInput, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
1
+ import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignElementsDataDiffResponse, DTODocumentationLinkPreviewRequest, DTODocumentationPageAnchor, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOFigmaNode, DTOFigmaNodeRenderInput, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
3
2
  import { DesignSystemInvite, DesignSystemInviteUpdate, DesignSystemMemberUpdate, DesignSystemPendingMemberInvite, DesignSystemUserInvitation } from "@supernova-studio/model";
4
- import { DesignSystemAccessMode, DocsBlockDefinition, ExportBuildStatus, ResourceFont, TokenThemeOverrideTranserObject } from "../../exports";
3
+ import { DesignSystemAccessMode, DocsBlockDefinition, ExportBuildStatus, ResourceFont, TokenThemeOverrideTranserObject, UserRole } from "../../exports";
5
4
  import { Acl } from "../../model/acl/SDKAcl";
6
5
  import { Asset } from "../../model/assets/SDKAsset";
7
6
  import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
8
7
  import { BootstrapData } from "../../model/base/SDKBootstrapData";
9
8
  import { Brand, BrandUpdateModel } from "../../model/base/SDKBrand";
10
9
  import { DesignSystem, DesignSystemSwitcher } from "../../model/base/SDKDesignSystem";
10
+ import { DesignSystemCollection } from "../../model/base/SDKDesignSystemCollection";
11
+ import { DesignSystemContactList } from "../../model/base/SDKDesignSystemContactList";
11
12
  import { DesignSystemMemberList } from "../../model/base/SDKDesignSystemMemberList";
12
13
  import { DesignSystemVersion, DesignSystemVersionCreate, DesignSystemVersionCreationJob, DesignSystemVersionUpdateModel } from "../../model/base/SDKDesignSystemVersion";
13
14
  import { DocumentationLegacy, DocumentationLegacyModel } from "../../model/base/SDKDocumentationLegacy";
@@ -22,7 +23,6 @@ import { ElementPropertyValue } from "../../model/elements/values/SDKElementProp
22
23
  import { ConnectionProviders } from "../../model/enums/SDKConnectionProviders";
23
24
  import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
24
25
  import { TokenType } from "../../model/enums/SDKTokenType";
25
- import { UserRoleWithoutOwner } from "../../model/enums/SDKUserRole";
26
26
  import { AzurePersonalAccessTokenConnectionPayload, PersonalAccessTokenConnectionPayload } from "../../model/exporters/SDKConnections";
27
27
  import { Exporter, ExporterProvider, NewExporterPayload } from "../../model/exporters/SDKExporter";
28
28
  import { NewPipelinePayload, Pipeline, PipelineUpdateModel } from "../../model/exporters/SDKPipeline";
@@ -51,7 +51,7 @@ import { UserProfileUpdateModel } from "../../model/users/SDKUserProfile";
51
51
  import { UserWorkspaceNotificationSettings, UserWorkspaceNotificationSettingsUpdateModel } from "../../model/users/SDKUserWorkspaceNotificationSettings";
52
52
  import { Workspace } from "../../model/workspaces/SDKWorkspace";
53
53
  import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
54
- import { WorkspaceIntegrationType, WorkspaceIntegrations, WorkspaceIntegrationsRemoteModel } from "../../model/workspaces/SDKWorkspaceIntegration";
54
+ import { WorkspaceIntegrations, WorkspaceIntegrationsRemoteModel, WorkspaceIntegrationType } from "../../model/workspaces/SDKWorkspaceIntegration";
55
55
  import { WorkspaceIntegrationAccessTokenPayload } from "../../model/workspaces/SDKWorkspaceIntegrationAccessToken";
56
56
  import { WorkspaceIntegrationGetGitProvidersInput } from "../../model/workspaces/SDKWorkspaceIntegrationGetGitProviders";
57
57
  import { OAuth2IntegrationTypes, WorkspaceIntegrationOauthRequestRemoteModel } from "../../model/workspaces/SDKWorkspaceIntegrationOauthRequest";
@@ -121,6 +121,7 @@ export declare class DataCore {
121
121
  elementPropertyValues(designSystemId: string, versionId: string): Promise<Array<ElementPropertyValue>>;
122
122
  /** Download all necessary data for element views and retrieve them resolved */
123
123
  elementViews(designSystemId: string, versionId: string, type: ElementPropertyTargetElementType): Promise<Array<ElementDataView>>;
124
+ tokenCollections(designSystemId: string, versionId: string): Promise<Array<DesignSystemCollection>>;
124
125
  /** Download all necessary data for tokens and retrieve them resolved */
125
126
  tokens(designSystemId: string, versionId: string, filter?: {
126
127
  type?: TokenType;
@@ -417,7 +418,7 @@ export declare class DataCore {
417
418
  integrationId: string;
418
419
  params?: WorkspaceIntegrationGetGitProvidersInput;
419
420
  }): Promise<GitProvidersBranches>;
420
- createWorkspace(name: string, handle?: string): Promise<Workspace>;
421
+ createWorkspace(name: string): Promise<Workspace>;
421
422
  createVersion(designSystemId: string, model: DesignSystemVersionUpdateModel): Promise<DesignSystemVersionCreate>;
422
423
  editVersion(designSystemId: string, versionId: string, model: DesignSystemVersionUpdateModel): Promise<void>;
423
424
  deleteVersion(designSystemId: string, versionId: string): Promise<void>;
@@ -427,8 +428,6 @@ export declare class DataCore {
427
428
  deleteCustomDomain(designSystemId: string): Promise<void>;
428
429
  updateCustomDomain(designSystemId: string, customerDomain: string): Promise<CustomDomain>;
429
430
  startSslGenerationForCustomDomain(designSystemId: string): Promise<void>;
430
- /** Validate that workspace handle is available */
431
- validateIsWorkspaceHandleAvailable(handle: string): Promise<boolean>;
432
431
  workspaceOnboarding(workspaceId: string): Promise<WorkspaceOnboarding>;
433
432
  workspaceIPWhitelistSettings(workspaceId: string): Promise<WorkspaceIPWhitelistSettings | null>;
434
433
  workspaceNPMRegistrySettings(workspaceId: string): Promise<WorkspaceNPMRegistrySettings | null>;
@@ -449,8 +448,8 @@ export declare class DataCore {
449
448
  updateWorkspaceNPMRegistrySettings(workspaceId: string, npmRegistrySettings: WorkspaceNPMRegistrySettingsUpdateModel): Promise<void>;
450
449
  updateUserWorkspaceNotificationSettings(userId: string, workspaceId: string, notificationSettings: UserWorkspaceNotificationSettingsUpdateModel): Promise<void>;
451
450
  updateWorkspaceOwnership(workspaceId: string, newOwnerUserId: string): Promise<void>;
452
- updateWorkspaceMemberRole(workspaceId: string, userId: string, newRole: UserRoleWithoutOwner): Promise<void>;
453
- updateWorkspaceInvitationRole(workspaceId: string, invitationId: string, newRole: UserRoleWithoutOwner): Promise<void>;
451
+ updateWorkspaceMemberRole(workspaceId: string, userId: string, newRole: UserRole): Promise<void>;
452
+ updateWorkspaceInvitationRole(workspaceId: string, invitationId: string, newRole: UserRole): Promise<void>;
454
453
  addWorkspaceInvitations(workspaceId: string, invitations: Array<WorkspaceInvitationUpdateModel>, designSystemId: string | undefined): Promise<void>;
455
454
  deleteWorkspace(workspaceId: string): Promise<void>;
456
455
  deleteWorkspaceAvatar(workspaceId: string): Promise<void>;
@@ -510,6 +509,8 @@ export declare class DataCore {
510
509
  designSystemSources(designSystemId: string): Promise<Array<Source>>;
511
510
  /** Download information about all design system members */
512
511
  designSystemMemberList(designSystemId: string): Promise<DesignSystemMemberList>;
512
+ /** Download information about design system's contacts */
513
+ designSystemContacts(designSystemId: string): Promise<DesignSystemContactList>;
513
514
  getFigmaNodeStructures(designSystemId: string, versionId: string): Promise<Array<FigmaStructure>>;
514
515
  getFigmaNodeStructureDetail(designSystemId: string, versionId: string, figmaStructureId: string): Promise<FigmaStructureDetail>;
515
516
  deleteFigmaSource(designSystemId: string, sourceId: string): Promise<void>;
@@ -1,4 +1,4 @@
1
- import { DTODesignElementsDataDiffResponse, DTODesignSystem, DTODesignSystemMemberListResponse, DTODocumentationLinkPreviewRequest, DTOFigmaNode, DTOGetDocumentationPageAnchorsResponse, DTOPipeline } from "@supernova-studio/client";
1
+ import { DTODesignElementsDataDiffResponse, DTODesignSystem, DTODesignSystemContactsResponse, DTODesignSystemMemberListResponse, DTODocumentationLinkPreviewRequest, DTOFigmaNode, DTOGetDocumentationPageAnchorsResponse, DTOPipeline, DTOTokenCollection } from "@supernova-studio/client";
2
2
  import { AclRemoteModel } from "../../../model/acl/SDKAcl";
3
3
  import { BootstrapDataRemoteModel } from "../../../model/base/SDKBootstrapData";
4
4
  import { BrandRemoteModel } from "../../../model/base/SDKBrand";
@@ -89,8 +89,6 @@ export declare class DataCoreReadRequests {
89
89
  operation: GitProviderValues;
90
90
  params?: WorkspaceIntegrationGetGitProvidersInput;
91
91
  }): Promise<unknown>;
92
- /** Remote: Validate can use workspace handle */
93
- getRemoteIsWorkspaceHandleAvailable(handle: string): Promise<boolean>;
94
92
  /** Remote: Get all users memberships */
95
93
  getRemoteUserMemberships(workspaceId: string): Promise<Array<UserMembershipRemoteModel>>;
96
94
  /** Remote: Get information about the state of workspace onboarding, what was completed and what not */
@@ -120,6 +118,7 @@ export declare class DataCoreReadRequests {
120
118
  getFigmaNodeStructureDetail(designSystemId: string, versionId: string, figmaStructureId: string): Promise<FigmaStructureDetailModel>;
121
119
  /** Remote: Get information about design system's members */
122
120
  getRemoteDesignSystemMemberList(designSystemId: string): Promise<DTODesignSystemMemberListResponse>;
121
+ getRemoteContacts(designSystemId: string): Promise<DTODesignSystemContactsResponse>;
123
122
  /** Remote: Get design system documentation url */
124
123
  getRemoteDocumentationUrl(designSystemId: string, versionId: string): Promise<string | null>;
125
124
  /** Remote: Get documentation metadata */
@@ -214,6 +213,7 @@ export declare class DataCoreReadRequests {
214
213
  /** Remote: Get all property values that were set by the user for each elemen */
215
214
  getRemoteElementPropertyValues(designSystemId: string, versionId: string): Promise<ElementPropertyValueRemoteModel[]>;
216
215
  getRemoteFigmaFrames(designSystemId: string, versionId: string): Promise<Array<DTOFigmaNode>>;
216
+ getRemoteTokenCollections(designSystemId: string, versionId: string): Promise<Array<DTOTokenCollection>>;
217
217
  getRemotePipelines(workspaceId: string, designSystemId?: string): Promise<DTOPipeline[]>;
218
218
  getRemoteBuild(workspaceId: string, buildId: string): Promise<ExportBuildModel>;
219
219
  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>>;
@@ -1,6 +1,6 @@
1
1
  import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignSystem, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOFigmaNode, DTOFigmaNodeRenderInput, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
2
2
  import { DesignSystemInvite, DesignSystemInviteUpdate, DesignSystemMemberUpdate, DesignSystemPendingMemberInvite, DesignSystemUserInvitation } from "@supernova-studio/model";
3
- import { DesignSystemAccessMode, TokenThemeOverrideTranserObject } from "../../../exports";
3
+ import { DesignSystemAccessMode, TokenThemeOverrideTranserObject, UserRole } from "../../../exports";
4
4
  import { Brand, BrandRemoteModel, BrandUpdateModel } from "../../../model/base/SDKBrand";
5
5
  import { DesignSystem, DesignSystemSwitcher } from "../../../model/base/SDKDesignSystem";
6
6
  import { DesignSystemVersionCreateRemoteModel, DesignSystemVersionUpdateModel } from "../../../model/base/SDKDesignSystemVersion";
@@ -10,7 +10,6 @@ import { ElementDataViewColumnType } from "../../../model/elements/SDKElementDat
10
10
  import { ElementPropertyRemoteModel } from "../../../model/elements/SDKElementProperty";
11
11
  import { ConnectionProviders } from "../../../model/enums/SDKConnectionProviders";
12
12
  import { DocumentationEnvironment } from "../../../model/enums/SDKDocumentationEnvironment";
13
- import { UserRoleWithoutOwner } from "../../../model/enums/SDKUserRole";
14
13
  import { AuthenticationTokenPayload, AzurePersonalAccessTokenConnectionPayload, CreateAuthenticationTokenPayload, PersonalAccessTokenConnectionPayload } from "../../../model/exporters/SDKConnections";
15
14
  import { ExporterProvider, NewExporterPayload } from "../../../model/exporters/SDKExporter";
16
15
  import { NewPipelinePayload, PipelineUpdateModel } from "../../../model/exporters/SDKPipeline";
@@ -55,7 +54,7 @@ export declare class DataCoreWriteRequests {
55
54
  /** Remote: Logs out user. Can only really logout its own user */
56
55
  logoutRemoteCurrentUser(): Promise<void>;
57
56
  /** Remote: Creates a new workspace */
58
- createRemoteWorkspace(name: string, handle?: string): Promise<WorkspaceRemoteModel>;
57
+ createRemoteWorkspace(name: string): Promise<WorkspaceRemoteModel>;
59
58
  /** Remote: Creates a new version */
60
59
  createRemoteVersion(designSystemId: string, model: DesignSystemVersionUpdateModel): Promise<DesignSystemVersionCreateRemoteModel>;
61
60
  /** Remote: Updates a version */
@@ -93,9 +92,9 @@ export declare class DataCoreWriteRequests {
93
92
  /** Remote: Updates a workspace ownership */
94
93
  updateRemoteWorkspaceOwnership(workspaceId: string, newOwnerUserId: string): Promise<void>;
95
94
  /** Remote: Updates a member role */
96
- updateRemoteWorkspaceMemberRole(workspaceId: string, userId: string, newRole: UserRoleWithoutOwner): Promise<void>;
95
+ updateRemoteWorkspaceMemberRole(workspaceId: string, userId: string, newRole: UserRole): Promise<void>;
97
96
  /** Remote: Updates an invitation role */
98
- updateRemoteWorkspaceInvitationRole(workspaceId: string, invitationId: string, newRole: UserRoleWithoutOwner): Promise<void>;
97
+ updateRemoteWorkspaceInvitationRole(workspaceId: string, invitationId: string, newRole: UserRole): Promise<void>;
99
98
  /** Remote: Add new invitations */
100
99
  addRemoteWorkspaceInvitations(workspaceId: string, invitations: Array<WorkspaceInvitationUpdateModel>, designSystemId: string | undefined): Promise<void>;
101
100
  /** Remote: Deletes a workspace */
@@ -218,6 +218,7 @@ export { DocsBlockOptionRenderingStyle } from "./model/enums/SDKDocsBlockOptionR
218
218
  export { DocsBlockRichTextPropertyStyle } from "./model/enums/SDKDocsBlockRichTextPropertyStyle";
219
219
  export { DocsBlockTextPropertyStyle } from "./model/enums/SDKDocsBlockTextPropertyStyle";
220
220
  export { DocsBlockTextPropertyColor } from "./model/enums/SDKDocsBlockTextPropertyColor";
221
+ export { DocsBlockTokenNameFormat } from "./model/enums/SDKDocsBlockTokenNameFormat";
221
222
  export { DocsBlockOptionColor } from "./model/enums/SDKDocsBlockOptionColor";
222
223
  export { DocsEntityType } from "./model/enums/SDKDocsEntityType";
223
224
  export { DocsSectionType } from "./model/enums/SDKDocsSectionType";
@@ -236,7 +237,6 @@ export { TextDecoration } from "./model/enums/SDKTextDecoration";
236
237
  export { TokenType } from "./model/enums/SDKTokenType";
237
238
  export { Unit } from "./model/enums/SDKUnit";
238
239
  export { UserRole } from "./model/enums/SDKUserRole";
239
- export type { UserRoleWithoutOwner } from "./model/enums/SDKUserRole";
240
240
  export { VisibilityType } from "./model/enums/SDKVisibilityType";
241
241
  export { WorkspaceSubscriptionPlanInterval } from "./model/enums/SDKWorkspaceSubscriptionPlanInterval";
242
242
  export { WorkspaceSubscriptionProductCode } from "./model/enums/SDKWorkspaceSubscriptionProduct";
@@ -0,0 +1,13 @@
1
+ import { DTOTokenCollection } from "@supernova-studio/client";
2
+ export declare class DesignSystemCollection {
3
+ id: string;
4
+ designSystemVersionId: string;
5
+ persistentId: string;
6
+ name: string;
7
+ description: string;
8
+ createdAt: Date | null;
9
+ updatedAt: Date | null;
10
+ originId: string | null;
11
+ originSourceId: string | null;
12
+ constructor(model: DTOTokenCollection);
13
+ }
@@ -0,0 +1,17 @@
1
+ import { DTODesignSystemContactsResponse } from "@supernova-studio/client";
2
+ import { InspectableUser } from "../users/SDKInspectableUser";
3
+ export declare class DesignSystemContactList {
4
+ /** List of users that have managing permissions on the workspace-level. */
5
+ workspace: Array<InspectableUser>;
6
+ /** List of users that have managing permissions on the design system-level. */
7
+ designSystem: Array<InspectableUser>;
8
+ constructor(model: DTODesignSystemContactsResponse);
9
+ /**
10
+ * Get the list of emails that have managing permissions on the workspace-level.
11
+ */
12
+ getWorkspaceEmails(): Array<string>;
13
+ /**
14
+ * Get the list of emails that have managing permissions on the design system-level.
15
+ */
16
+ getDesignSystemEmails(): Array<string>;
17
+ }
@@ -12,14 +12,19 @@ export type DocsBlockAssetPropertyData = DocsBlockPropertyData<Array<{
12
12
  title?: string;
13
13
  description?: string;
14
14
  backgroundColor?: DocsColorRef | null;
15
+ showNestedGroups?: boolean;
15
16
  };
16
17
  }>> & {
17
18
  /** Selected asset ids */
18
19
  selectedPropertyIds?: Array<string>;
19
20
  /** If enabled, search is visible */
20
21
  showSearch?: boolean;
22
+ /** If enabled, description is visible */
23
+ showAssetDescription?: boolean;
21
24
  /** Preview container size */
22
25
  previewContainerSize?: DocsBlockContainerSize.centered | DocsBlockContainerSize.naturalHeight;
26
+ /** Preview container height */
27
+ previewContainerHeight?: number;
23
28
  };
24
29
  /** Asset property - Definition model */
25
30
  export type DocsBlockAssetPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockAssetPropertyOptions;
@@ -23,6 +23,8 @@ export type DocsBlockFigmaComponentPropertyData = DocsBlockPropertyData<Array<{
23
23
  }>> & {
24
24
  /** Preview container size */
25
25
  previewContainerSize?: DocsBlockContainerSize.centered | DocsBlockContainerSize.naturalHeight;
26
+ /** Preview container height */
27
+ previewContainerHeight?: number;
26
28
  /** If enabled, the component title will be visible in the block */
27
29
  showComponentName?: boolean;
28
30
  /** If enabled, the component description list will be visible in the block */
@@ -15,6 +15,8 @@ export type DocsBlockFigmaNodePropertyData = DocsBlockPropertyData<Array<{
15
15
  }>> & {
16
16
  /** Behavior of container size */
17
17
  previewContainerSize?: DocsBlockContainerSize.centered | DocsBlockContainerSize.naturalHeight;
18
+ /** Preview container height */
19
+ previewContainerHeight?: number;
18
20
  /** If enabled, search is visible */
19
21
  showSearch?: boolean;
20
22
  /** Number of columns */
@@ -9,6 +9,8 @@ export type DocsBlockImagePropertyOptions = {
9
9
  width?: DocsBlockImagePropertyWidth;
10
10
  aspectRatio?: DocsBlockImagePropertyAspectRatio;
11
11
  allowCaption?: boolean;
12
+ allowLightbox?: boolean;
13
+ allowBorder?: boolean;
12
14
  recommendation?: string;
13
15
  };
14
16
  /** Image property - Data */
@@ -16,6 +18,8 @@ export type DocsBlockImagePropertyData = DocsBlockPropertyData<DocsImageRef | un
16
18
  alt: string;
17
19
  caption?: string;
18
20
  alignment?: Alignment;
21
+ openLightbox?: boolean;
22
+ isBordered?: boolean;
19
23
  };
20
24
  /** Image property - Definition model */
21
25
  export type DocsBlockImagePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockImagePropertyOptions;
@@ -1,4 +1,5 @@
1
1
  import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
2
+ import { DocsBlockTokenNameFormat } from "../../../enums/SDKDocsBlockTokenNameFormat";
2
3
  import { TokenType } from "../../../enums/SDKTokenType";
3
4
  import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
4
5
  /** Token property - Additional non-value options */
@@ -11,6 +12,8 @@ export type DocsBlockTokenPropertyOptions = {
11
12
  allowPropertySelection?: boolean;
12
13
  /** Whether to allow selecting themes. True by default */
13
14
  allowThemeSelection?: boolean;
15
+ /** Whether to allow selecting token name format. False by default */
16
+ allowNameFormatSelection?: boolean;
14
17
  };
15
18
  /** Token property - Data */
16
19
  export type DocsBlockTokenPropertyData = DocsBlockPropertyData<Array<{
@@ -27,6 +30,10 @@ export type DocsBlockTokenPropertyData = DocsBlockPropertyData<Array<{
27
30
  id: string;
28
31
  selectedThemeIds: Array<string>;
29
32
  }>;
33
+ /** Format of the token name */
34
+ tokenNameFormat?: DocsBlockTokenNameFormat;
35
+ /** Custom property id for token name format, only if tokenNameFormat is "CustomProperty" */
36
+ tokenNameCustomPropertyId?: string;
30
37
  /**
31
38
  * Selected theme ids
32
39
  * @deprecated Swatches will be used instead
@@ -0,0 +1,10 @@
1
+ export declare enum DocsBlockTokenNameFormat {
2
+ /** Token name */
3
+ name = "Name",
4
+ /** Group and token name */
5
+ groupAndName = "GroupAndName",
6
+ /** Full path */
7
+ fullPath = "FullPath",
8
+ /** Custom property */
9
+ customProperty = "CustomProperty"
10
+ }
@@ -11,4 +11,3 @@ export declare enum UserRole {
11
11
  viewer = "Viewer"
12
12
  }
13
13
  export declare const convertRemoteToUserRole: (remoteRole: DTOWorkspaceRole) => UserRole;
14
- export type UserRoleWithoutOwner = Exclude<UserRole, UserRole.owner>;
@@ -18,6 +18,9 @@ export declare class TokenOrigin {
18
18
  sourceType?: SourceType | null;
19
19
  referenceOriginId?: string | null;
20
20
  referencePersistentId?: string | null;
21
+ /**
22
+ * @deprecated Use TokenUtils.isReferenceResolutionFailed instead.
23
+ */
21
24
  referenceResolutionFailed?: boolean | null;
22
25
  referenceOriginRemote?: boolean | null;
23
26
  referenceOriginName?: string | null;
@@ -13,6 +13,7 @@ export declare class Token implements TokenValue {
13
13
  brandId: string;
14
14
  themeId: string | null;
15
15
  designSystemVersionId: string;
16
+ collectionId: string | null;
16
17
  name: string;
17
18
  description: string;
18
19
  tokenType: TokenType;
@@ -36,6 +36,7 @@ export type ColorValue = {
36
36
  b: number;
37
37
  referencedTokenId: string | null;
38
38
  };
39
+ export type TypographyTokenValueTypes = FontFamilyTokenValue | FontWeightTokenValue | FontSizeTokenValue | TextDecorationTokenValue | TextCaseTokenValue | LetterSpacingTokenValue | LineHeightTokenValue | ParagraphSpacingTokenValue;
39
40
  export type TypographyTokenValue = {
40
41
  fontFamily: FontFamilyTokenValue;
41
42
  fontWeight: FontWeightTokenValue;
@@ -5,6 +5,7 @@ export type TokenRemoteModel = {
5
5
  brandId: string;
6
6
  designSystemVersionId: string;
7
7
  persistentId: string;
8
+ collectionId?: string;
8
9
  type: TokenType;
9
10
  meta: {
10
11
  name: string;
@@ -0,0 +1,17 @@
1
+ import { DTOUser } from "@supernova-studio/client";
2
+ /** Model that describes a user that can be inspected by others.
3
+ * It has only public properties and no sensitive data.
4
+ */
5
+ export declare class InspectableUser {
6
+ /** Unique user identifier */
7
+ id: string;
8
+ /** Unique user email */
9
+ email: string;
10
+ /** User name */
11
+ name: string;
12
+ /** User nickname */
13
+ nickname: string | null;
14
+ /** Avatar */
15
+ avatar: string | null;
16
+ constructor(model: DTOUser);
17
+ }
@@ -1,4 +1,4 @@
1
- import { UserRole, UserRoleWithoutOwner } from "../enums/SDKUserRole";
1
+ import { UserRole } from "../enums/SDKUserRole";
2
2
  export type WorkspaceInvitationRemoteModel = {
3
3
  id: string;
4
4
  email: string;
@@ -11,7 +11,7 @@ export type WorkspaceInvitationRemoteModel = {
11
11
  export type WorkspaceInvitationTransportModel = WorkspaceInvitationRemoteModel;
12
12
  export type WorkspaceInvitationUpdateModel = {
13
13
  email: string;
14
- role: UserRoleWithoutOwner;
14
+ role: UserRole;
15
15
  };
16
16
  export declare class WorkspaceInvitation {
17
17
  /** Unique identifier of the invitation */
@@ -1,6 +1,5 @@
1
1
  export type WorkspaceProfileRemoteModel = {
2
2
  name: string;
3
- handle: string;
4
3
  color: string;
5
4
  billingDetails?: WorkspaceProfileBillingDetailsRemoteModel;
6
5
  avatar?: string;
@@ -26,14 +25,11 @@ export type WorkspaceProfileAddressRemoteModel = {
26
25
  export type WorkspaceProfileTransportModel = WorkspaceProfileRemoteModel;
27
26
  export type WorkspaceProfileUpdateModel = {
28
27
  name: string;
29
- handle: string;
30
28
  color: string;
31
29
  };
32
30
  export declare class WorkspaceProfile {
33
31
  /** Workspace name, doesn't have to be unique across workspace pool */
34
32
  name: string;
35
- /** Workspace handle, unique across entire workspace pool */
36
- handle: string;
37
33
  /** Workspace primary color */
38
34
  color: string;
39
35
  /** Workspace avatar URL */
@@ -87,6 +87,7 @@ type ValueOutOfRangeValidationResult = {
87
87
  export declare class TokenUtils {
88
88
  /** Map tokens for lookup */
89
89
  static tokensToReferenceMap(tokens: Array<Token>): Map<string, Token>;
90
+ static isReferenceResolutionFailed(token: Token): boolean;
90
91
  /** Map token groups for lookup */
91
92
  static tokenGroupsToReferenceMap(groups: Array<TokenGroup>): Map<string, TokenGroup>;
92
93
  static lookupReference<T extends Token>(id: string | undefined | null, tokens: Map<string, Token>): T | undefined;