@supernova-studio/supernova-sdk-beta 2.0.18 → 2.0.20
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.
- package/build/sdk-typescript/src/core/areas/SDKAreaAssets.d.ts +2 -5
- package/build/sdk-typescript/src/core/areas/SDKAreaDesignSystems.d.ts +36 -4
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +14 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaTokens.d.ts +1 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +2 -2
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +24 -8
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +11 -7
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +17 -7
- package/build/sdk-typescript/src/core/resolvers/SDKDocsEntityMultiplayerItemResolver.d.ts +1 -1
- package/build/sdk-typescript/src/exports-pulsar.d.ts +2 -0
- package/build/sdk-typescript/src/exports.d.ts +6 -1
- package/build/sdk-typescript/src/model/base/SDKDesignSystem.d.ts +8 -17
- package/build/sdk-typescript/src/model/base/SDKDesignSystemMemberList.d.ts +9 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockBehavior.d.ts +2 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockDefinition.d.ts +2 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/do-dont-guidelines/SDKDocsBlockActualDoDontGuidelines.d.ts +8 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts +2 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextEditorProperty.d.ts +19 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts +9 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +2 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +13 -6
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntity.d.ts +10 -1
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityApprovalState.d.ts +14 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityDraftState.d.ts +0 -2
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityGroup.d.ts +5 -2
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityHeader.d.ts +3 -3
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityPage.d.ts +5 -2
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyItem.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +3 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockOptionColor.d.ts +14 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockOptionRenderStyle.d.ts +1 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockRichTextEditorPropertyStyle.d.ts +16 -0
- package/build/sdk-typescript/src/model/enums/SDKIconSet.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts +1 -1
- package/build/sdk-typescript/src/model/enums/SDKUserRole.d.ts +1 -0
- package/build/sdk-typescript/src/model/exporters/SDKExporter.d.ts +8 -0
- package/build/sdk-typescript/src/model/exporters/SDKPipeline.d.ts +2 -2
- package/build/sdk-typescript/src/model/support/SDKSource.d.ts +3 -1
- package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +4 -0
- package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenModel.d.ts +2 -0
- package/build/sdk-typescript/src/model/users/SDKUserProfile.d.ts +4 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceSSOSettings.d.ts +2 -0
- package/build/sdk-typescript/src/pulsar-interfaces.d.ts +5 -0
- package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +21 -4
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewTypes.d.ts +4 -0
- package/build/sdk-typescript/src/utils/TokenUtils.d.ts +1 -1
- package/build/sdk-typescript/src/utils/tokenDefaultValues.d.ts +31 -0
- package/build/supernova-sdk-typescript.js +1 -1
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +3 -3
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DTOFigmaNode } from "@supernova-studio/client";
|
|
1
|
+
import { DTOFigmaNode, DTOFigmaNodeRenderInput } from "@supernova-studio/client";
|
|
2
2
|
import { Asset } from "../../model/assets/SDKAsset";
|
|
3
3
|
import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
|
|
4
4
|
import { AssetFormat } from "../../model/enums/SDKAssetFormat";
|
|
@@ -37,10 +37,7 @@ export declare class AreaAssets {
|
|
|
37
37
|
*
|
|
38
38
|
* @returns Rendered Figma frames
|
|
39
39
|
*/
|
|
40
|
-
getRenderedFigmaFrames(from: RemoteVersionIdentifier, framesToRender: Array<
|
|
41
|
-
sourceId: string;
|
|
42
|
-
figmaFileNodeId: string;
|
|
43
|
-
}>): Promise<Array<DTOFigmaNode>>;
|
|
40
|
+
getRenderedFigmaFrames(from: RemoteVersionIdentifier, framesToRender: Array<DTOFigmaNodeRenderInput>): Promise<Array<DTOFigmaNode>>;
|
|
44
41
|
/** Passes data through Supernova CORS proxy to prevent issues with accessing foreign data from browser */
|
|
45
42
|
dataThroughCorsProxy(urlToRelay: string): Promise<ArrayBuffer | undefined>;
|
|
46
43
|
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import { DTODocumentationLinkPreviewRequest } from "@supernova-studio/client";
|
|
2
|
-
import { DesignSystem, DesignSystemSwitcher } from "../../model/base/SDKDesignSystem";
|
|
1
|
+
import { DTODocumentationLinkPreviewRequest, DTODocumentationPageApprovalStateChangeInput } from "@supernova-studio/client";
|
|
2
|
+
import { DesignSystem, DesignSystemAccessMode, DesignSystemSwitcher } from "../../model/base/SDKDesignSystem";
|
|
3
|
+
import { DesignSystemMemberList } from "../../model/base/SDKDesignSystemMemberList";
|
|
3
4
|
import { CustomDomain } from "../../model/support/SDKCustomDomain";
|
|
4
5
|
import { DataCore } from "../data/SDKDataCore";
|
|
5
6
|
export declare class AreaDesignSystems {
|
|
@@ -21,18 +22,26 @@ export declare class AreaDesignSystems {
|
|
|
21
22
|
* @returns custom domain information
|
|
22
23
|
*/
|
|
23
24
|
designSystemCustomDomain(designSystemId: string): Promise<CustomDomain>;
|
|
25
|
+
/** Fetches specific design system's memberships
|
|
26
|
+
* @param designSystemId - Design system's identifier
|
|
27
|
+
* @returns Design system's memberships
|
|
28
|
+
*/
|
|
29
|
+
designSystemMemberList(designSystemId: string): Promise<DesignSystemMemberList>;
|
|
24
30
|
/** Creates a new design system and retrieves the newly created DS object
|
|
31
|
+
* @param workspaceId - Workspace to create the design system in
|
|
25
32
|
* @param name - Name of the design system
|
|
33
|
+
* @param description - Description of the design system
|
|
34
|
+
* @param accessMode - Defines who can access the design system
|
|
26
35
|
* @returns Newly created design system object
|
|
27
36
|
*/
|
|
28
|
-
createDesignSystem(workspaceId: string, name: string, description?: string): Promise<DesignSystem>;
|
|
37
|
+
createDesignSystem(workspaceId: string, name: string, description?: string, accessMode?: DesignSystemAccessMode): Promise<DesignSystem>;
|
|
29
38
|
getBlockDefinitions(designSystemId: string, versionId: string): Promise<import("../..").DocsBlockDefinition[]>;
|
|
30
39
|
getUrlPreview(designSystemId: string, versionId: string, request: DTODocumentationLinkPreviewRequest): Promise<{
|
|
31
40
|
linkPreview: {
|
|
32
41
|
description?: string | undefined;
|
|
33
42
|
title?: string | undefined;
|
|
34
43
|
thumbnail?: {
|
|
35
|
-
type: "
|
|
44
|
+
type: "FigmaNode" | "Resource";
|
|
36
45
|
resource?: {
|
|
37
46
|
url: string;
|
|
38
47
|
resourceId: string;
|
|
@@ -57,6 +66,22 @@ export declare class AreaDesignSystems {
|
|
|
57
66
|
* @returns Nothing
|
|
58
67
|
*/
|
|
59
68
|
updateDesignSystemIsMultibrand(designSystem: DesignSystem, isMultibrand: boolean): Promise<void>;
|
|
69
|
+
/** Updates a design system approval feature
|
|
70
|
+
* @param designSystemId - design system to update
|
|
71
|
+
* @param payload - Approvals feature data
|
|
72
|
+
* @returns Nothing
|
|
73
|
+
*/
|
|
74
|
+
updateDesignSystemIsApprovalFeatureEnabled(designSystemId: string, payload: {
|
|
75
|
+
isApprovalFeatureEnabled?: boolean;
|
|
76
|
+
approvalRequiredForPublishing?: boolean;
|
|
77
|
+
}): Promise<void>;
|
|
78
|
+
/** Updates approval state of a page
|
|
79
|
+
* @param designSystemId - design system of the page
|
|
80
|
+
* @param versionId - version of the page
|
|
81
|
+
* @param payload - approval state info
|
|
82
|
+
* @returns Nothing
|
|
83
|
+
*/
|
|
84
|
+
updateApprovalState(designSystemId: string, versionId: string, payload: DTODocumentationPageApprovalStateChangeInput): Promise<string>;
|
|
60
85
|
/** Enabled or disables multibrand functionality for a specific design system
|
|
61
86
|
* @param designSystem - design system to update
|
|
62
87
|
* @param designSystemSwitcher - Design system switcher options
|
|
@@ -81,6 +106,13 @@ export declare class AreaDesignSystems {
|
|
|
81
106
|
* @returns nothing
|
|
82
107
|
*/
|
|
83
108
|
updateDesignSystemCustomDomain(designSystemId: string, newDomain: string): Promise<CustomDomain>;
|
|
109
|
+
/** Updates design system's member list
|
|
110
|
+
* @param designSystemId - ID of the design system
|
|
111
|
+
* @param inviteUserIds - User IDs to invite
|
|
112
|
+
* @param removeUserIds - User IDs to remove
|
|
113
|
+
* @returns nothing
|
|
114
|
+
*/
|
|
115
|
+
updateDesignSystemMemberList(designSystemId: string, inviteUserIds: Array<string>, removeUserIds: Array<string>): Promise<void>;
|
|
84
116
|
/** Deletes a design system. This action is irreversible, all data will be lost, and can only be performed by the admins of the workspace
|
|
85
117
|
* @param designSystemId - ID of the design system
|
|
86
118
|
* @returns Nothing. RIP design system.
|
|
@@ -117,6 +117,20 @@ export declare class AreaDocumentation {
|
|
|
117
117
|
* @returns nothing
|
|
118
118
|
*/
|
|
119
119
|
deleteDocumentationPage(from: RemoteWorkspaceVersionIdentifier, id: string): Promise<void>;
|
|
120
|
+
/** Restores a documentation page
|
|
121
|
+
* @param from - Remote version to fetch from
|
|
122
|
+
* @param persistentId - persistentId of a page to restore
|
|
123
|
+
* @param snapshotId - Identifier of a snapshot of a page we want to restore to.
|
|
124
|
+
* @returns nothing
|
|
125
|
+
*/
|
|
126
|
+
restoreDocumentationPage(from: RemoteWorkspaceVersionIdentifier, persistentId: string, snapshotId?: string): Promise<void>;
|
|
127
|
+
/** Restores a documentation group
|
|
128
|
+
* @param from - Remote version to fetch from
|
|
129
|
+
* @param persistentId - persistentId of a group to restore
|
|
130
|
+
* @param snapshotId - Identifier of a snapshot of a group we want to restore to.
|
|
131
|
+
* @returns nothing
|
|
132
|
+
*/
|
|
133
|
+
restoreDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, persistentId: string, snapshotId?: string): Promise<void>;
|
|
120
134
|
/** Deletes a documentation tab group
|
|
121
135
|
* @param from - Remote version to fetch from
|
|
122
136
|
* @param page - Page to delete
|
|
@@ -213,7 +213,7 @@ export declare class AreaTokens {
|
|
|
213
213
|
/** Warning: INTERNAL, DO NOT USE YET, NOT STABLE INTERFACE. Write theme in bulk */
|
|
214
214
|
writeTheme(to: RemoteVersionIdentifier, theme: TokenTheme): Promise<void>;
|
|
215
215
|
/** Resolves tokens by applying themes to them and retrieves new token set where values correctly correspond to that theme */
|
|
216
|
-
computeTokensByApplyingThemes(tokens: Array<Token>, themes: Array<TokenTheme>):
|
|
216
|
+
computeTokensByApplyingThemes(tokens: Array<Token>, themes: Array<TokenTheme>): Array<Token>;
|
|
217
217
|
/** Separates groups by types */
|
|
218
218
|
computeGroupTrees(groups: Array<TokenGroup>): Promise<Map<TokenType, Array<TokenGroup>>>;
|
|
219
219
|
/** Get determistic mocked token data. Must be used with mocked token groups */
|
|
@@ -184,7 +184,7 @@ export declare class AreaWorkspaces {
|
|
|
184
184
|
* @param invitations - array of invitations
|
|
185
185
|
* @returns Nothing
|
|
186
186
|
*/
|
|
187
|
-
addWorkspaceInvitations(workspaceId: string, invitations: Array<WorkspaceInvitationUpdateModel
|
|
187
|
+
addWorkspaceInvitations(workspaceId: string, invitations: Array<WorkspaceInvitationUpdateModel>, designSystemId: string | undefined): Promise<void>;
|
|
188
188
|
/** Creates a new Stripe checkout session.
|
|
189
189
|
* @param workspaceId - ID of the workspace
|
|
190
190
|
* @param priceId - ID of the Stripe price to be applied to the workspace
|
|
@@ -207,7 +207,7 @@ export declare class AreaWorkspaces {
|
|
|
207
207
|
* @param invitationId - ID of the invitation
|
|
208
208
|
* @returns Nothing
|
|
209
209
|
*/
|
|
210
|
-
resendWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
210
|
+
resendWorkspaceInvitation(workspaceId: string, invitationId: string, designSystemId: string | undefined): Promise<void>;
|
|
211
211
|
/** Restore a cancelled workspace subscription.
|
|
212
212
|
* @param workspaceId - ID of the workspace
|
|
213
213
|
* @returns Nothing
|
|
@@ -1,11 +1,12 @@
|
|
|
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
|
-
import { DocsBlockDefinition, ExportBuildStatus, ResourceFont, TokenThemeOverrideTranserObject } from "../../exports";
|
|
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";
|
|
3
|
+
import { DesignSystemAccessMode, DocsBlockDefinition, ExportBuildStatus, ResourceFont, TokenThemeOverrideTranserObject } 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";
|
|
7
7
|
import { Brand, BrandUpdateModel } from "../../model/base/SDKBrand";
|
|
8
8
|
import { DesignSystem, DesignSystemSwitcher } from "../../model/base/SDKDesignSystem";
|
|
9
|
+
import { DesignSystemMemberList } from "../../model/base/SDKDesignSystemMemberList";
|
|
9
10
|
import { DesignSystemVersion, DesignSystemVersionCreate, DesignSystemVersionCreationJob, DesignSystemVersionUpdateModel } from "../../model/base/SDKDesignSystemVersion";
|
|
10
11
|
import { DocumentationLegacy, DocumentationLegacyModel } from "../../model/base/SDKDocumentationLegacy";
|
|
11
12
|
import { Component } from "../../model/components/SDKComponent";
|
|
@@ -183,6 +184,10 @@ export declare class DataCore {
|
|
|
183
184
|
}>;
|
|
184
185
|
/** Create a page within documentation */
|
|
185
186
|
createDocumentationPage(designSystemId: string, versionId: string, payload: Omit<DTOCreateDocumentationPageInputV2, "persistentId">): Promise<string>;
|
|
187
|
+
/** Update page approval state */
|
|
188
|
+
updateApprovalState(designSystemId: string, versionId: string, payload: DTODocumentationPageApprovalStateChangeInput): Promise<string>;
|
|
189
|
+
/** Update design system's member list */
|
|
190
|
+
updateDesignSystemMemberList(designSystemId: string, inviteUserIds: Array<string>, removeUserIds: Array<string>): Promise<void>;
|
|
186
191
|
/** Create a group within documentation */
|
|
187
192
|
createDocumentationGroup(designSystemId: string, versionId: string, payload: Omit<DTOCreateDocumentationGroupInput, "persistentId">): Promise<string>;
|
|
188
193
|
/** Create a tab group within documentation */
|
|
@@ -209,6 +214,10 @@ export declare class DataCore {
|
|
|
209
214
|
deleteDocumentationGroup(designSystemId: string, versionId: string, payload: DTODeleteDocumentationGroupInput): Promise<void>;
|
|
210
215
|
/** Delete a documentation group and tree inside it */
|
|
211
216
|
deleteDocumentationGroupAndTree(designSystemId: string, versionId: string, id: string): Promise<void>;
|
|
217
|
+
/** Restore a documentation group */
|
|
218
|
+
restoreDocumentationGroup(designSystemId: string, versionId: string, payload: DTORestoreDocumentationGroupInput): Promise<void>;
|
|
219
|
+
/** Restore a documentation page */
|
|
220
|
+
restoreDocumentationPage(designSystemId: string, versionId: string, payload: DTORestoreDocumentationPageInput): Promise<void>;
|
|
212
221
|
/** Create a custom property in remote */
|
|
213
222
|
updateTokenProperty(designSystemId: string, versionId: string, propertyIdInVersion: string, model: ElementPropertyUpdateModel): Promise<void>;
|
|
214
223
|
/** Delete a custom property in remote */
|
|
@@ -437,7 +446,7 @@ export declare class DataCore {
|
|
|
437
446
|
updateWorkspaceOwnership(workspaceId: string, newOwnerUserId: string): Promise<void>;
|
|
438
447
|
updateWorkspaceMemberRole(workspaceId: string, userId: string, newRole: UserRoleWithoutOwner): Promise<void>;
|
|
439
448
|
updateWorkspaceInvitationRole(workspaceId: string, invitationId: string, newRole: UserRoleWithoutOwner): Promise<void>;
|
|
440
|
-
addWorkspaceInvitations(workspaceId: string, invitations: Array<WorkspaceInvitationUpdateModel
|
|
449
|
+
addWorkspaceInvitations(workspaceId: string, invitations: Array<WorkspaceInvitationUpdateModel>, designSystemId: string | undefined): Promise<void>;
|
|
441
450
|
deleteWorkspace(workspaceId: string): Promise<void>;
|
|
442
451
|
deleteWorkspaceAvatar(workspaceId: string): Promise<void>;
|
|
443
452
|
deleteWorkspaceNPMRegistrySettings(workspaceId: string): Promise<void>;
|
|
@@ -445,21 +454,21 @@ export declare class DataCore {
|
|
|
445
454
|
deleteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
446
455
|
createCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity?: number | null): Promise<string>;
|
|
447
456
|
createPortalSession(workspaceId: string, returnUrl: string, update?: WorkspaceSubscriptionUpdateModel | null, cancel?: boolean | null): Promise<string>;
|
|
448
|
-
resendWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
457
|
+
resendWorkspaceInvitation(workspaceId: string, invitationId: string, designSystemId: string | undefined): Promise<void>;
|
|
449
458
|
restoreWorkspaceSubscription(workspaceId: string): Promise<void>;
|
|
450
459
|
/** Download information about a single design system and retrieve it resolved */
|
|
451
460
|
designSystem(designSystemId: string): Promise<DesignSystem>;
|
|
452
461
|
/** Download information about design systems that user has access to under a single workspace and retrieve it resolved */
|
|
453
462
|
designSystems(workspaceId: any): Promise<Array<DesignSystem>>;
|
|
454
463
|
/** Creates a design system */
|
|
455
|
-
createDesignSystem(workspaceId: string, name: string, description?: string): Promise<DesignSystem>;
|
|
464
|
+
createDesignSystem(workspaceId: string, name: string, description?: string, accessMode?: DesignSystemAccessMode): Promise<DesignSystem>;
|
|
456
465
|
getBlockDefinitions(designSystemId: string, versionId: string): Promise<Array<DocsBlockDefinition>>;
|
|
457
466
|
getUrlPreview(designSystemId: string, versionId: string, request: DTODocumentationLinkPreviewRequest): Promise<{
|
|
458
467
|
linkPreview: {
|
|
459
468
|
description?: string | undefined;
|
|
460
469
|
title?: string | undefined;
|
|
461
470
|
thumbnail?: {
|
|
462
|
-
type: "
|
|
471
|
+
type: "FigmaNode" | "Resource";
|
|
463
472
|
resource?: {
|
|
464
473
|
url: string;
|
|
465
474
|
resourceId: string;
|
|
@@ -475,6 +484,11 @@ export declare class DataCore {
|
|
|
475
484
|
updateDesignSystemMetadata(designSystemId: string, name: string, description?: string): Promise<void>;
|
|
476
485
|
/** Updates a design system multibrand option */
|
|
477
486
|
updateDesignSystemIsMultibrand(designSystem: DesignSystem, isMultibrand: boolean): Promise<void>;
|
|
487
|
+
/** Updates a design system approval feature */
|
|
488
|
+
updateDesignSystemApprovalsFeature(designSystemId: string, payload: {
|
|
489
|
+
isApprovalFeatureEnabled?: boolean;
|
|
490
|
+
approvalRequiredForPublishing?: boolean;
|
|
491
|
+
}): Promise<void>;
|
|
478
492
|
/** Updates a design system switcher */
|
|
479
493
|
updateDesignSystemSwitcher(designSystem: DesignSystem, designSystemSwitcher: DesignSystemSwitcher): Promise<void>;
|
|
480
494
|
/** Updates design system doc exporter id */
|
|
@@ -487,8 +501,10 @@ export declare class DataCore {
|
|
|
487
501
|
designSystemCustomDomain(designSystemId: string): Promise<CustomDomain>;
|
|
488
502
|
/** Download information about a desing system source within a design system design and retrieve it resolved */
|
|
489
503
|
designSystemSource(designSystemId: string, sourceId: string): Promise<Source>;
|
|
490
|
-
/** Download information about all
|
|
504
|
+
/** Download information about all design system sources within a design system design and retrieve it resolved */
|
|
491
505
|
designSystemSources(designSystemId: string): Promise<Array<Source>>;
|
|
506
|
+
/** Download information about all design system members */
|
|
507
|
+
designSystemMemberList(designSystemId: string): Promise<DesignSystemMemberList>;
|
|
492
508
|
getFigmaNodeStructures(designSystemId: string, versionId: string): Promise<Array<FigmaStructure>>;
|
|
493
509
|
getFigmaNodeStructureDetail(designSystemId: string, versionId: string, figmaStructureId: string): Promise<FigmaStructureDetail>;
|
|
494
510
|
deleteFigmaSource(designSystemId: string, sourceId: string): Promise<void>;
|
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
import { DTODesignElementsDataDiffResponse, DTODocumentationLinkPreviewRequest, DTOFigmaNode, DTOGetDocumentationPageAnchorsResponse, DTOPipeline } from "@supernova-studio/client";
|
|
1
|
+
import { DTODesignElementsDataDiffResponse, DTODesignSystem, DTODesignSystemMemberListResponse, 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
|
-
import { DesignSystemRemoteModel } from "../../../model/base/SDKDesignSystem";
|
|
5
4
|
import { DesignSystemVersionCreationJobRemoteModel, DesignSystemVersionRemoteModel } from "../../../model/base/SDKDesignSystemVersion";
|
|
6
5
|
import { DocumentationLegacyModel } from "../../../model/base/SDKDocumentationLegacy";
|
|
7
6
|
import { ComponentRemoteModel } from "../../../model/components/SDKComponent";
|
|
@@ -16,7 +15,7 @@ import { ElementPropertyValueRemoteModel } from "../../../model/elements/values/
|
|
|
16
15
|
import { DocumentationEnvironment } from "../../../model/enums/SDKDocumentationEnvironment";
|
|
17
16
|
import { TokenType } from "../../../model/enums/SDKTokenType";
|
|
18
17
|
import { AuthenticationTokens } from "../../../model/exporters/SDKConnections";
|
|
19
|
-
import { ExporterModel, ExporterProvider } from "../../../model/exporters/SDKExporter";
|
|
18
|
+
import { ExporterMembershipModel, ExporterModel, ExporterProvider } from "../../../model/exporters/SDKExporter";
|
|
20
19
|
import { ExporterCustomBlockModel } from "../../../model/exporters/custom_blocks/SDKExporterCustomBlock";
|
|
21
20
|
import { ExportBuildModel, ExportBuildStatus } from "../../../model/exporters/exporter_builds/SDKExportBuild";
|
|
22
21
|
import { ExportBuildResultLogModel } from "../../../model/exporters/exporter_builds/SDKExportBuildResults";
|
|
@@ -104,9 +103,9 @@ export declare class DataCoreReadRequests {
|
|
|
104
103
|
getRemoteWorkspaceSubscription(workspaceId: string): Promise<WorkspaceSubscriptionRemoteModel>;
|
|
105
104
|
getRemoteWorkspaceAvailableProducts(workspaceId: string): Promise<Array<WorkspaceProductRemoteModel>>;
|
|
106
105
|
/** Remote: Get information about one specific design system */
|
|
107
|
-
getRemoteDesignSystem(designSystemId: string): Promise<
|
|
106
|
+
getRemoteDesignSystem(designSystemId: string): Promise<DTODesignSystem>;
|
|
108
107
|
/** Remote: Get information about all design systems under specific workspace */
|
|
109
|
-
getRemoteDesignSystems(workspaceId: string): Promise<Array<
|
|
108
|
+
getRemoteDesignSystems(workspaceId: string): Promise<Array<DTODesignSystem>>;
|
|
110
109
|
/** Remote: Get custom domain */
|
|
111
110
|
getRemoteCustomDomain(designSystemId: string): Promise<CustomDomainRemoteModel>;
|
|
112
111
|
/** Remote: Get a single design source */
|
|
@@ -117,6 +116,8 @@ export declare class DataCoreReadRequests {
|
|
|
117
116
|
getFigmaNodeStructures(designSystemId: string, versionId: string): Promise<Array<FigmaStructureModel>>;
|
|
118
117
|
/** Remote: Get figma node detail */
|
|
119
118
|
getFigmaNodeStructureDetail(designSystemId: string, versionId: string, figmaStructureId: string): Promise<FigmaStructureDetailModel>;
|
|
119
|
+
/** Remote: Get information about design system's members */
|
|
120
|
+
getRemoteDesignSystemMemberList(designSystemId: string): Promise<DTODesignSystemMemberListResponse>;
|
|
120
121
|
/** Remote: Get design system documentation url */
|
|
121
122
|
getRemoteDocumentationUrl(designSystemId: string, versionId: string): Promise<string | null>;
|
|
122
123
|
/** Remote: Get documentation metadata */
|
|
@@ -145,7 +146,7 @@ export declare class DataCoreReadRequests {
|
|
|
145
146
|
description?: string | undefined;
|
|
146
147
|
title?: string | undefined;
|
|
147
148
|
thumbnail?: {
|
|
148
|
-
type: "
|
|
149
|
+
type: "FigmaNode" | "Resource";
|
|
149
150
|
resource?: {
|
|
150
151
|
url: string;
|
|
151
152
|
resourceId: string;
|
|
@@ -162,7 +163,10 @@ export declare class DataCoreReadRequests {
|
|
|
162
163
|
/** Remote: Get structural details and metadata about all exporters */
|
|
163
164
|
getRemoteExporters(workspaceId: string, filter?: {
|
|
164
165
|
installedOnly?: boolean;
|
|
165
|
-
}): Promise<
|
|
166
|
+
}): Promise<{
|
|
167
|
+
exporters: Array<ExporterModel>;
|
|
168
|
+
membership: Array<ExporterMembershipModel>;
|
|
169
|
+
}>;
|
|
166
170
|
/** Remote: Get all asset resources */
|
|
167
171
|
getRemoteAssetResources(designSystemId: string, versionId: string): Promise<Array<ResourceAssetModel>>;
|
|
168
172
|
/** Remote: Get all font resources */
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOFigmaNode, DTOFigmaNodeRenderInput, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPublishDocumentationRequest, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
|
|
2
|
-
import { TokenThemeOverrideTranserObject } from "../../../exports";
|
|
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
|
+
import { DesignSystemAccessMode, TokenThemeOverrideTranserObject } from "../../../exports";
|
|
3
3
|
import { Brand, BrandRemoteModel, BrandUpdateModel } from "../../../model/base/SDKBrand";
|
|
4
|
-
import { DesignSystem,
|
|
4
|
+
import { DesignSystem, DesignSystemSwitcher } from "../../../model/base/SDKDesignSystem";
|
|
5
5
|
import { DesignSystemVersionCreateRemoteModel, DesignSystemVersionUpdateModel } from "../../../model/base/SDKDesignSystemVersion";
|
|
6
6
|
import { DocumentationLegacyModel } from "../../../model/base/SDKDocumentationLegacy";
|
|
7
7
|
import { Component, ComponentRemoteModel, ComponentUpdateRemoteModel } from "../../../model/components/SDKComponent";
|
|
@@ -29,7 +29,7 @@ import { UserProfileUpdateModel } from "../../../model/users/SDKUserProfile";
|
|
|
29
29
|
import { UserWorkspaceNotificationSettingsUpdateModel } from "../../../model/users/SDKUserWorkspaceNotificationSettings";
|
|
30
30
|
import { WorkspaceRemoteModel } from "../../../model/workspaces/SDKWorkspace";
|
|
31
31
|
import { WorkspaceIPWhitelistSettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
32
|
-
import {
|
|
32
|
+
import { WorkspaceIntegrationsRemoteModel, WorkspaceIntegrationType } from "../../../model/workspaces/SDKWorkspaceIntegration";
|
|
33
33
|
import { WorkspaceIntegrationAccessTokenPayload } from "../../../model/workspaces/SDKWorkspaceIntegrationAccessToken";
|
|
34
34
|
import { WorkspaceInvitationUpdateModel } from "../../../model/workspaces/SDKWorkspaceInvitation";
|
|
35
35
|
import { WorkspaceNPMRegistrySettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
|
|
@@ -96,7 +96,7 @@ export declare class DataCoreWriteRequests {
|
|
|
96
96
|
/** Remote: Updates an invitation role */
|
|
97
97
|
updateRemoteWorkspaceInvitationRole(workspaceId: string, invitationId: string, newRole: UserRoleWithoutOwner): Promise<void>;
|
|
98
98
|
/** Remote: Add new invitations */
|
|
99
|
-
addRemoteWorkspaceInvitations(workspaceId: string, invitations: Array<WorkspaceInvitationUpdateModel
|
|
99
|
+
addRemoteWorkspaceInvitations(workspaceId: string, invitations: Array<WorkspaceInvitationUpdateModel>, designSystemId: string | undefined): Promise<void>;
|
|
100
100
|
/** Remote: Deletes a workspace */
|
|
101
101
|
deleteRemoteWorkspace(workspaceId: string): Promise<void>;
|
|
102
102
|
/** Remote: Deletes a workspace avatar */
|
|
@@ -112,15 +112,20 @@ export declare class DataCoreWriteRequests {
|
|
|
112
112
|
/** Remote: create Customer portal session */
|
|
113
113
|
createRemotePortalSession(workspaceId: string, returnUrl: string, update?: WorkspaceSubscriptionUpdateModel | null, cancel?: boolean | null): Promise<string>;
|
|
114
114
|
/** Remote: Resend the invitation */
|
|
115
|
-
resendRemoteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
115
|
+
resendRemoteWorkspaceInvitation(workspaceId: string, invitationId: string, designSystemId: string | undefined): Promise<void>;
|
|
116
116
|
/** Remote: Restore the cancelled subscription */
|
|
117
117
|
restoreRemoteWorkspaceSubscription(workspaceId: string): Promise<void>;
|
|
118
118
|
/** Remote: Creates a new design system */
|
|
119
|
-
createRemoteDesignSystem(workspaceId: string, name: string, description?: string): Promise<
|
|
119
|
+
createRemoteDesignSystem(workspaceId: string, name: string, description?: string, accessMode?: DesignSystemAccessMode): Promise<DTODesignSystem>;
|
|
120
120
|
/** Remote: Updates a design system metadata */
|
|
121
121
|
updateRemoteDesignSystemMetadata(designSystemId: string, name: string, description?: string): Promise<void>;
|
|
122
122
|
/** Remote: Updates a design system multibrand capabilities */
|
|
123
123
|
updateRemoteDesignSystemIsMultibrand(designSystem: DesignSystem, isMultibrand: boolean): Promise<void>;
|
|
124
|
+
/** Remote: Updates a design system approval feature */
|
|
125
|
+
updateRemoteDesignSystemApprovalsFeature(designSystemId: string, payload: {
|
|
126
|
+
isApprovalFeatureEnabled?: boolean;
|
|
127
|
+
approvalRequiredForPublishing?: boolean;
|
|
128
|
+
}): Promise<void>;
|
|
124
129
|
/** Remote: Updates a design system switcher */
|
|
125
130
|
updateRemoteDesignSystemSwitcher(designSystem: DesignSystem, designSystemSwitcher: DesignSystemSwitcher): Promise<void>;
|
|
126
131
|
/** Remote: Updates design system doc exporter id */
|
|
@@ -131,8 +136,11 @@ export declare class DataCoreWriteRequests {
|
|
|
131
136
|
updateRemoteDesignSystemDocumentationSlug(designSystem: DesignSystem, docUserSlug: string): Promise<void>;
|
|
132
137
|
/** Remote: Deletes a design system */
|
|
133
138
|
deleteDesignSystem(designSystemId: string): Promise<void>;
|
|
139
|
+
/** Remote: Updates a design system's member list */
|
|
140
|
+
updateRemoteDesignSystemMemberList(designSystemId: string, inviteUserIds: Array<string>, removeUserIds: Array<string>): Promise<void>;
|
|
134
141
|
private elementAction;
|
|
135
142
|
createRemoteDocumentationPage(designSystemId: string, versionId: string, data: DTOCreateDocumentationPageInputV2): Promise<any>;
|
|
143
|
+
updateApprovalState(designSystemId: string, versionId: string, data: DTODocumentationPageApprovalStateChangeInput): Promise<any>;
|
|
136
144
|
/** Remote: create a group within documentation */
|
|
137
145
|
createRemoteDocumentationGroup(designSystemId: string, versionId: string, data: DTOCreateDocumentationGroupInput): Promise<any>;
|
|
138
146
|
/** Remote: create a group within documentation */
|
|
@@ -153,6 +161,8 @@ export declare class DataCoreWriteRequests {
|
|
|
153
161
|
deleteRemoteDocumentationPage(designSystemId: string, versionId: string, data: DTODeleteDocumentationPageInputV2): Promise<any>;
|
|
154
162
|
/** Remote: deletes a documentation tab group */
|
|
155
163
|
deleteRemoteDocumentationTabGroup(designSystemId: string, versionId: string, data: DTODeleteDocumentationTabGroupInput): Promise<any>;
|
|
164
|
+
restoreRemoteDocumentationGroup(designSystemId: string, versionId: string, data: DTORestoreDocumentationGroupInput): Promise<any>;
|
|
165
|
+
restoreRemoteDocumentationPage(designSystemId: string, versionId: string, data: DTORestoreDocumentationPageInput): Promise<any>;
|
|
156
166
|
/** Remote: Deletes a documentation group */
|
|
157
167
|
deleteRemoteDocumentationGroup(designSystemId: string, versionId: string, data: DTODeleteDocumentationGroupInput): Promise<any>;
|
|
158
168
|
publishDocumentation(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<ExportBuildModel>;
|
|
@@ -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
|
|
5
|
+
resolveMultiplayerItems(pageDetails: Array<DocsEntityPageModel>, groupDetails: Array<DocsEntityGroupModel>): Array<DocsEntityMultiplayerGroup | DocsEntityMultiplayerPage>;
|
|
6
6
|
private resolveItemsForGroup;
|
|
7
7
|
}
|
|
@@ -198,6 +198,7 @@ export { DocsBlockItemPropertyType } from "./model/enums/SDKDocsBlockItemPropert
|
|
|
198
198
|
export { DocsBlockItemVariantLayoutType } from "./model/enums/SDKDocsBlockItemVariantLayoutType";
|
|
199
199
|
export { DocsBlockItemVariantLayoutWidth } from "./model/enums/SDKDocsBlockItemVariantLayoutWidth";
|
|
200
200
|
export { DocsBlockOptionRenderingStyle } from "./model/enums/SDKDocsBlockOptionRenderStyle";
|
|
201
|
+
export { DocsBlockOptionColor } from "./model/enums/SDKDocsBlockOptionColor";
|
|
201
202
|
export { DocsBlockRichTextPropertyStyle } from "./model/enums/SDKDocsBlockRichTextPropertyStyle";
|
|
202
203
|
export { DocsBlockTextPropertyStyle } from "./model/enums/SDKDocsBlockTextPropertyStyle";
|
|
203
204
|
export { DocsEntityGroupBehavior } from "./model/enums/SDKDocsEntityGroupBehavior";
|
|
@@ -206,6 +207,7 @@ export { DocsSectionType } from "./model/enums/SDKDocsSectionType";
|
|
|
206
207
|
export { DocsLinkRefType } from "./model/docs/blocks/support/SDKDocsLinkRef";
|
|
207
208
|
export { DocsImageRefType } from "./model/docs/blocks/support/SDKDocsImageRef";
|
|
208
209
|
export { SourceType } from "./model/enums/SDKSourceType";
|
|
210
|
+
export { IconSet } from "./model/enums/SDKIconSet";
|
|
209
211
|
export { FrameAlignment } from "./model/enums/SDKFrameAlignment";
|
|
210
212
|
export { FrameLayout } from "./model/enums/SDKFrameLayout";
|
|
211
213
|
export { GradientType } from "./model/enums/SDKGradientType";
|
|
@@ -34,6 +34,7 @@ export type { FeaturePermissionResolution } from "./model/workspaces/SDKWorkspac
|
|
|
34
34
|
export { Brand } from "./model/base/SDKBrand";
|
|
35
35
|
export type { BrandUpdateModel } from "./model/base/SDKBrand";
|
|
36
36
|
export { DesignSystem } from "./model/base/SDKDesignSystem";
|
|
37
|
+
export type { DesignSystemAccessMode } from "./model/base/SDKDesignSystem";
|
|
37
38
|
export { DesignSystemVersion } from "./model/base/SDKDesignSystemVersion";
|
|
38
39
|
export type { DesignSystemVersionCreate, DesignSystemVersionUpdateModel, DesignSystemVersionCreationJob, } from "./model/base/SDKDesignSystemVersion";
|
|
39
40
|
export { Membership } from "./model/membership/SDKMembership";
|
|
@@ -66,6 +67,7 @@ export { DocsEntityMultiplayerItemResolver } from "./core/resolvers/SDKDocsEntit
|
|
|
66
67
|
export { DocsEntity } from "./model/docs/entities/SDKDocsEntity";
|
|
67
68
|
export { DocsEntityConfiguration } from "./model/docs/entities/SDKDocsEntityConfiguration";
|
|
68
69
|
export { DocsEntityDraftChangeType, DocsEntityDraftState, } from "./model/docs/entities/SDKDocsEntityDraftState";
|
|
70
|
+
export { DocsEntityApprovalState, DocsEntityApprovalStateType, } from "./model/docs/entities/SDKDocsEntityApprovalState";
|
|
69
71
|
export type { DocsEntityGroupModel } from "./model/docs/entities/SDKDocsEntityGroup";
|
|
70
72
|
export { DocsEntityGroup, DocsEntityMultiplayerGroup, } from "./model/docs/entities/SDKDocsEntityGroup";
|
|
71
73
|
export type { DocsEntityPageModel } from "./model/docs/entities/SDKDocsEntityPage";
|
|
@@ -102,6 +104,8 @@ export { DocsBlockRichTextPropertyDefinition } from "./model/docs/blocks/propert
|
|
|
102
104
|
export type { DocsBlockRichTextPropertyData, DocsBlockRichTextPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockRichTextProperty";
|
|
103
105
|
export { DocsBlockMultiRichTextPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty";
|
|
104
106
|
export type { DocsBlockMultiRichTextPropertyData, DocsBlockMultiRichTextPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty";
|
|
107
|
+
export { DocsBlockRichTextEditorPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockRichTextEditorProperty";
|
|
108
|
+
export type { DocsBlockRichTextEditorPropertyData, DocsBlockRichTextEditorPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockRichTextEditorProperty";
|
|
105
109
|
export { DocsBlockSingleSelectPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty";
|
|
106
110
|
export type { DocsBlockSingleSelectPropertyData, DocsBlockSingleSelectPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty";
|
|
107
111
|
export { DocsBlockTablePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTableProperty";
|
|
@@ -211,10 +215,11 @@ export { DocsBlockOptionRenderingStyle } from "./model/enums/SDKDocsBlockOptionR
|
|
|
211
215
|
export { DocsBlockRichTextPropertyStyle } from "./model/enums/SDKDocsBlockRichTextPropertyStyle";
|
|
212
216
|
export { DocsBlockTextPropertyStyle } from "./model/enums/SDKDocsBlockTextPropertyStyle";
|
|
213
217
|
export { DocsBlockTextPropertyColor } from "./model/enums/SDKDocsBlockTextPropertyColor";
|
|
214
|
-
export {
|
|
218
|
+
export { DocsBlockOptionColor } from "./model/enums/SDKDocsBlockOptionColor";
|
|
215
219
|
export { DocsEntityType } from "./model/enums/SDKDocsEntityType";
|
|
216
220
|
export { DocsSectionType } from "./model/enums/SDKDocsSectionType";
|
|
217
221
|
export { SourceType } from "./model/enums/SDKSourceType";
|
|
222
|
+
export { IconSet } from "./model/enums/SDKIconSet";
|
|
218
223
|
export { DocsBlockImagePropertyWidth } from "./model/enums/SDKDocsBlockImagePropertyWidth";
|
|
219
224
|
export { DocsPublishStatus } from "./model/enums/SDKDocsPublishStatus";
|
|
220
225
|
export { DocumentationEnvironment } from "./model/enums/SDKDocumentationEnvironment";
|
|
@@ -1,21 +1,9 @@
|
|
|
1
|
+
import { DTODesignSystem } from "@supernova-studio/client";
|
|
1
2
|
export type DesignSystemSwitcher = {
|
|
2
3
|
isEnabled: boolean;
|
|
3
4
|
designSystemIds: Array<string>;
|
|
4
5
|
};
|
|
5
|
-
export type
|
|
6
|
-
id: string;
|
|
7
|
-
meta: {
|
|
8
|
-
name: string;
|
|
9
|
-
description: string;
|
|
10
|
-
};
|
|
11
|
-
workspaceId: string;
|
|
12
|
-
isPublic: boolean;
|
|
13
|
-
isMultibrand: boolean;
|
|
14
|
-
docSlug: string;
|
|
15
|
-
docUserSlug?: string;
|
|
16
|
-
docExporterId: string;
|
|
17
|
-
designSystemSwitcher: DesignSystemSwitcher;
|
|
18
|
-
};
|
|
6
|
+
export type DesignSystemAccessMode = "Open" | "InviteOnly";
|
|
19
7
|
export type DesignSystemTransportModel = Pick<DesignSystem, "id" | "name" | "description" | "isPublic" | "isMultiBrand" | "documentationSlug" | "documentationUserSlug" | "documentationExporterId" | "designSystemSwitcher" | "workspaceId">;
|
|
20
8
|
export declare class DesignSystem {
|
|
21
9
|
/** Unique identifier of design system */
|
|
@@ -30,6 +18,10 @@ export declare class DesignSystem {
|
|
|
30
18
|
isPublic: boolean;
|
|
31
19
|
/** If set, signals that multibrand functionality is enabled for this design system */
|
|
32
20
|
isMultiBrand: boolean;
|
|
21
|
+
/** If set, signals that approval feature is enabled */
|
|
22
|
+
isApprovalFeatureEnabled: boolean;
|
|
23
|
+
/** If set, restricts publishing to only pages with ready to publish state */
|
|
24
|
+
approvalRequiredForPublishing: boolean;
|
|
33
25
|
/** Unique identifier of exporter package used for the documentation */
|
|
34
26
|
documentationExporterId: string;
|
|
35
27
|
/** DocumentationLegacy URL slug */
|
|
@@ -38,9 +30,8 @@ export declare class DesignSystem {
|
|
|
38
30
|
documentationUserSlug: string | null;
|
|
39
31
|
/** Binding multiple design systems together */
|
|
40
32
|
designSystemSwitcher: DesignSystemSwitcher;
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
toRemote(): DesignSystemRemoteModel;
|
|
33
|
+
accessMode: DesignSystemAccessMode;
|
|
34
|
+
constructor(model: DTODesignSystem);
|
|
44
35
|
/** Constructs representation that can be used to transport the instantiated object as JSON, for example for SSR <> Client use-cases. Reconstruct to class instance using `fromTransport` */
|
|
45
36
|
toTransport(): DesignSystemTransportModel;
|
|
46
37
|
/** Reconstructs class from the transport model */
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { DTODesignSystemMemberListResponse } from "@supernova-studio/client";
|
|
2
|
+
export type DesignSystemMembership = {
|
|
3
|
+
userId: string;
|
|
4
|
+
};
|
|
5
|
+
export declare class DesignSystemMemberList {
|
|
6
|
+
/** List of members that belong to the design system */
|
|
7
|
+
members: Array<DesignSystemMembership>;
|
|
8
|
+
constructor(model: DTODesignSystemMemberListResponse);
|
|
9
|
+
}
|
|
@@ -16,6 +16,8 @@ export declare class DocsBlockBehavior {
|
|
|
16
16
|
numberOfItems: number;
|
|
17
17
|
/** When enabled, each item can additionally link to page/url * */
|
|
18
18
|
allowLinks: boolean;
|
|
19
|
+
/** A label for a new item, used for multi-item blocks. If null, it takes the default one like "Add new item" */
|
|
20
|
+
newItemLabel: string | null;
|
|
19
21
|
} | null;
|
|
20
22
|
/** This property only goes into effect when dataType !== "Item" */
|
|
21
23
|
entities: {
|
|
@@ -27,6 +27,8 @@ export declare class DocsBlockDefinition {
|
|
|
27
27
|
editorOptions: {
|
|
28
28
|
/** When provided, the first time block is used (for every user individually), onboarding layer will show up for that block, explaining what it is. */
|
|
29
29
|
onboarding: DocsBlockOnboarding | null;
|
|
30
|
+
/** When provided, it will be used for adding a new item to the block */
|
|
31
|
+
newItemLabel: string | null;
|
|
30
32
|
};
|
|
31
33
|
/** All appearance options for top-level block wrapper */
|
|
32
34
|
appearance: {
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts
CHANGED
|
@@ -14,6 +14,8 @@ export type DocsBlockComponentPropertyData = DocsBlockPropertyData<Array<{
|
|
|
14
14
|
}>> & {
|
|
15
15
|
/** Selected component ids */
|
|
16
16
|
selectedPropertyIds?: Array<string>;
|
|
17
|
+
/** Brand id */
|
|
18
|
+
selectedBrandId?: string;
|
|
17
19
|
};
|
|
18
20
|
/** Component property - Definition model */
|
|
19
21
|
export type DocsBlockComponentPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockComponentPropertyOptions;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { PageBlockItemRichTextEditorValue } from "@supernova-studio/model";
|
|
2
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
|
+
import { DocsBlockRichTextEditorPropertyStyle } from "../../../enums/SDKDocsBlockRichTextEditorPropertyStyle";
|
|
4
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
5
|
+
/** RichTextEditor property - Additional non-value options */
|
|
6
|
+
export type DocsBlockRichTextEditorPropertyOptions = {
|
|
7
|
+
/** Placeholder to show when rich text area is empty */
|
|
8
|
+
placeholder?: string;
|
|
9
|
+
/** Allowed styles for the rich text editor */
|
|
10
|
+
allowedInlineStyles?: Array<DocsBlockRichTextEditorPropertyStyle>;
|
|
11
|
+
};
|
|
12
|
+
/** RichTextEditor property - Data */
|
|
13
|
+
export type DocsBlockRichTextEditorPropertyData = DocsBlockPropertyData<PageBlockItemRichTextEditorValue["value"]>;
|
|
14
|
+
/** RichTextEditor property - Definition model */
|
|
15
|
+
export type DocsBlockRichTextEditorPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockRichTextEditorPropertyOptions;
|
|
16
|
+
/** RichTextEditor property - Definition */
|
|
17
|
+
export declare class DocsBlockRichTextEditorPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockRichTextEditorPropertyOptions, DocsBlockRichTextEditorPropertyData> {
|
|
18
|
+
type: DocsBlockItemPropertyType.richTextEditor;
|
|
19
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockOptionColor } from "../../../enums/SDKDocsBlockOptionColor";
|
|
2
3
|
import { DocsBlockOptionRenderingStyle } from "../../../enums/SDKDocsBlockOptionRenderStyle";
|
|
4
|
+
import { IconSet } from "../../../enums/SDKIconSet";
|
|
3
5
|
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
6
|
/** SingleSelect property - Additional non-value options */
|
|
5
7
|
export type DocsBlockSingleSelectPropertyOptions = {
|
|
@@ -11,10 +13,14 @@ export type DocsBlockSingleSelectPropertyOptions = {
|
|
|
11
13
|
value: string;
|
|
12
14
|
/** Option name */
|
|
13
15
|
name: string;
|
|
14
|
-
/** Option icon
|
|
15
|
-
icon?:
|
|
16
|
+
/** Option icon (from our set) */
|
|
17
|
+
icon?: IconSet;
|
|
18
|
+
/** Option icon (from URL), gets preference over an icon if defined */
|
|
19
|
+
customIconUrl?: string;
|
|
20
|
+
/** Option color */
|
|
21
|
+
color?: DocsBlockOptionColor;
|
|
16
22
|
}>;
|
|
17
|
-
/** Visual representation of the property */
|
|
23
|
+
/** Visual representation of the property in the property panel */
|
|
18
24
|
singleSelectStyle?: DocsBlockOptionRenderingStyle;
|
|
19
25
|
};
|
|
20
26
|
/** SingleSelect property - Data */
|
|
@@ -12,6 +12,8 @@ export type DocsBlockTextPropertyOptions = {
|
|
|
12
12
|
textStyle?: DocsBlockTextPropertyStyle;
|
|
13
13
|
/** Text color */
|
|
14
14
|
color?: DocsBlockTextPropertyColor;
|
|
15
|
+
/** Allow line breaks (todo: should render as growing textarea in property panel if true) */
|
|
16
|
+
allowLineBreaks?: boolean;
|
|
15
17
|
};
|
|
16
18
|
/** Text property - Data */
|
|
17
19
|
export type DocsBlockTextPropertyData = DocsBlockPropertyData<string> & Record<string, never>;
|