@supernova-studio/supernova-sdk-beta 2.0.17 → 2.0.19
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 +18 -2
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +14 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +2 -2
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +16 -5
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +6 -3
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +11 -3
- 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 +5 -1
- package/build/sdk-typescript/src/model/base/SDKDesignSystem.d.ts +6 -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/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/exporters/SDKExporter.d.ts +8 -0
- 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/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,4 +1,4 @@
|
|
|
1
|
-
import { DTODocumentationLinkPreviewRequest } from "@supernova-studio/client";
|
|
1
|
+
import { DTODocumentationLinkPreviewRequest, DTODocumentationPageApprovalStateChangeInput } from "@supernova-studio/client";
|
|
2
2
|
import { DesignSystem, DesignSystemSwitcher } from "../../model/base/SDKDesignSystem";
|
|
3
3
|
import { CustomDomain } from "../../model/support/SDKCustomDomain";
|
|
4
4
|
import { DataCore } from "../data/SDKDataCore";
|
|
@@ -32,7 +32,7 @@ export declare class AreaDesignSystems {
|
|
|
32
32
|
description?: string | undefined;
|
|
33
33
|
title?: string | undefined;
|
|
34
34
|
thumbnail?: {
|
|
35
|
-
type: "
|
|
35
|
+
type: "FigmaNode" | "Resource";
|
|
36
36
|
resource?: {
|
|
37
37
|
url: string;
|
|
38
38
|
resourceId: string;
|
|
@@ -57,6 +57,22 @@ export declare class AreaDesignSystems {
|
|
|
57
57
|
* @returns Nothing
|
|
58
58
|
*/
|
|
59
59
|
updateDesignSystemIsMultibrand(designSystem: DesignSystem, isMultibrand: boolean): Promise<void>;
|
|
60
|
+
/** Updates a design system approval feature
|
|
61
|
+
* @param designSystemId - design system to update
|
|
62
|
+
* @param payload - Approvals feature data
|
|
63
|
+
* @returns Nothing
|
|
64
|
+
*/
|
|
65
|
+
updateDesignSystemIsApprovalFeatureEnabled(designSystemId: string, payload: {
|
|
66
|
+
isApprovalFeatureEnabled?: boolean;
|
|
67
|
+
approvalRequiredForPublishing?: boolean;
|
|
68
|
+
}): Promise<void>;
|
|
69
|
+
/** Updates approval state of a page
|
|
70
|
+
* @param designSystemId - design system of the page
|
|
71
|
+
* @param versionId - version of the page
|
|
72
|
+
* @param payload - approval state info
|
|
73
|
+
* @returns Nothing
|
|
74
|
+
*/
|
|
75
|
+
updateApprovalState(designSystemId: string, versionId: string, payload: DTODocumentationPageApprovalStateChangeInput): Promise<string>;
|
|
60
76
|
/** Enabled or disables multibrand functionality for a specific design system
|
|
61
77
|
* @param designSystem - design system to update
|
|
62
78
|
* @param designSystemSwitcher - Design system switcher options
|
|
@@ -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
|
|
@@ -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,5 +1,5 @@
|
|
|
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";
|
|
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
3
|
import { DocsBlockDefinition, ExportBuildStatus, ResourceFont, TokenThemeOverrideTranserObject } from "../../exports";
|
|
4
4
|
import { Acl } from "../../model/acl/SDKAcl";
|
|
5
5
|
import { Asset } from "../../model/assets/SDKAsset";
|
|
@@ -183,6 +183,8 @@ export declare class DataCore {
|
|
|
183
183
|
}>;
|
|
184
184
|
/** Create a page within documentation */
|
|
185
185
|
createDocumentationPage(designSystemId: string, versionId: string, payload: Omit<DTOCreateDocumentationPageInputV2, "persistentId">): Promise<string>;
|
|
186
|
+
/** Update page approval state */
|
|
187
|
+
updateApprovalState(designSystemId: string, versionId: string, payload: DTODocumentationPageApprovalStateChangeInput): Promise<string>;
|
|
186
188
|
/** Create a group within documentation */
|
|
187
189
|
createDocumentationGroup(designSystemId: string, versionId: string, payload: Omit<DTOCreateDocumentationGroupInput, "persistentId">): Promise<string>;
|
|
188
190
|
/** Create a tab group within documentation */
|
|
@@ -209,6 +211,10 @@ export declare class DataCore {
|
|
|
209
211
|
deleteDocumentationGroup(designSystemId: string, versionId: string, payload: DTODeleteDocumentationGroupInput): Promise<void>;
|
|
210
212
|
/** Delete a documentation group and tree inside it */
|
|
211
213
|
deleteDocumentationGroupAndTree(designSystemId: string, versionId: string, id: string): Promise<void>;
|
|
214
|
+
/** Restore a documentation group */
|
|
215
|
+
restoreDocumentationGroup(designSystemId: string, versionId: string, payload: DTORestoreDocumentationGroupInput): Promise<void>;
|
|
216
|
+
/** Restore a documentation page */
|
|
217
|
+
restoreDocumentationPage(designSystemId: string, versionId: string, payload: DTORestoreDocumentationPageInput): Promise<void>;
|
|
212
218
|
/** Create a custom property in remote */
|
|
213
219
|
updateTokenProperty(designSystemId: string, versionId: string, propertyIdInVersion: string, model: ElementPropertyUpdateModel): Promise<void>;
|
|
214
220
|
/** Delete a custom property in remote */
|
|
@@ -437,7 +443,7 @@ export declare class DataCore {
|
|
|
437
443
|
updateWorkspaceOwnership(workspaceId: string, newOwnerUserId: string): Promise<void>;
|
|
438
444
|
updateWorkspaceMemberRole(workspaceId: string, userId: string, newRole: UserRoleWithoutOwner): Promise<void>;
|
|
439
445
|
updateWorkspaceInvitationRole(workspaceId: string, invitationId: string, newRole: UserRoleWithoutOwner): Promise<void>;
|
|
440
|
-
addWorkspaceInvitations(workspaceId: string, invitations: Array<WorkspaceInvitationUpdateModel
|
|
446
|
+
addWorkspaceInvitations(workspaceId: string, invitations: Array<WorkspaceInvitationUpdateModel>, designSystemId: string | undefined): Promise<void>;
|
|
441
447
|
deleteWorkspace(workspaceId: string): Promise<void>;
|
|
442
448
|
deleteWorkspaceAvatar(workspaceId: string): Promise<void>;
|
|
443
449
|
deleteWorkspaceNPMRegistrySettings(workspaceId: string): Promise<void>;
|
|
@@ -445,7 +451,7 @@ export declare class DataCore {
|
|
|
445
451
|
deleteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
446
452
|
createCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity?: number | null): Promise<string>;
|
|
447
453
|
createPortalSession(workspaceId: string, returnUrl: string, update?: WorkspaceSubscriptionUpdateModel | null, cancel?: boolean | null): Promise<string>;
|
|
448
|
-
resendWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
454
|
+
resendWorkspaceInvitation(workspaceId: string, invitationId: string, designSystemId: string | undefined): Promise<void>;
|
|
449
455
|
restoreWorkspaceSubscription(workspaceId: string): Promise<void>;
|
|
450
456
|
/** Download information about a single design system and retrieve it resolved */
|
|
451
457
|
designSystem(designSystemId: string): Promise<DesignSystem>;
|
|
@@ -459,7 +465,7 @@ export declare class DataCore {
|
|
|
459
465
|
description?: string | undefined;
|
|
460
466
|
title?: string | undefined;
|
|
461
467
|
thumbnail?: {
|
|
462
|
-
type: "
|
|
468
|
+
type: "FigmaNode" | "Resource";
|
|
463
469
|
resource?: {
|
|
464
470
|
url: string;
|
|
465
471
|
resourceId: string;
|
|
@@ -475,6 +481,11 @@ export declare class DataCore {
|
|
|
475
481
|
updateDesignSystemMetadata(designSystemId: string, name: string, description?: string): Promise<void>;
|
|
476
482
|
/** Updates a design system multibrand option */
|
|
477
483
|
updateDesignSystemIsMultibrand(designSystem: DesignSystem, isMultibrand: boolean): Promise<void>;
|
|
484
|
+
/** Updates a design system approval feature */
|
|
485
|
+
updateDesignSystemApprovalsFeature(designSystemId: string, payload: {
|
|
486
|
+
isApprovalFeatureEnabled?: boolean;
|
|
487
|
+
approvalRequiredForPublishing?: boolean;
|
|
488
|
+
}): Promise<void>;
|
|
478
489
|
/** Updates a design system switcher */
|
|
479
490
|
updateDesignSystemSwitcher(designSystem: DesignSystem, designSystemSwitcher: DesignSystemSwitcher): Promise<void>;
|
|
480
491
|
/** Updates design system doc exporter id */
|
|
@@ -16,7 +16,7 @@ import { ElementPropertyValueRemoteModel } from "../../../model/elements/values/
|
|
|
16
16
|
import { DocumentationEnvironment } from "../../../model/enums/SDKDocumentationEnvironment";
|
|
17
17
|
import { TokenType } from "../../../model/enums/SDKTokenType";
|
|
18
18
|
import { AuthenticationTokens } from "../../../model/exporters/SDKConnections";
|
|
19
|
-
import { ExporterModel, ExporterProvider } from "../../../model/exporters/SDKExporter";
|
|
19
|
+
import { ExporterMembershipModel, ExporterModel, ExporterProvider } from "../../../model/exporters/SDKExporter";
|
|
20
20
|
import { ExporterCustomBlockModel } from "../../../model/exporters/custom_blocks/SDKExporterCustomBlock";
|
|
21
21
|
import { ExportBuildModel, ExportBuildStatus } from "../../../model/exporters/exporter_builds/SDKExportBuild";
|
|
22
22
|
import { ExportBuildResultLogModel } from "../../../model/exporters/exporter_builds/SDKExportBuildResults";
|
|
@@ -145,7 +145,7 @@ export declare class DataCoreReadRequests {
|
|
|
145
145
|
description?: string | undefined;
|
|
146
146
|
title?: string | undefined;
|
|
147
147
|
thumbnail?: {
|
|
148
|
-
type: "
|
|
148
|
+
type: "FigmaNode" | "Resource";
|
|
149
149
|
resource?: {
|
|
150
150
|
url: string;
|
|
151
151
|
resourceId: string;
|
|
@@ -162,7 +162,10 @@ export declare class DataCoreReadRequests {
|
|
|
162
162
|
/** Remote: Get structural details and metadata about all exporters */
|
|
163
163
|
getRemoteExporters(workspaceId: string, filter?: {
|
|
164
164
|
installedOnly?: boolean;
|
|
165
|
-
}): Promise<
|
|
165
|
+
}): Promise<{
|
|
166
|
+
exporters: Array<ExporterModel>;
|
|
167
|
+
membership: Array<ExporterMembershipModel>;
|
|
168
|
+
}>;
|
|
166
169
|
/** Remote: Get all asset resources */
|
|
167
170
|
getRemoteAssetResources(designSystemId: string, versionId: string): Promise<Array<ResourceAssetModel>>;
|
|
168
171
|
/** Remote: Get all font resources */
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOFigmaNode, DTOFigmaNodeRenderInput, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPublishDocumentationRequest, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
|
|
1
|
+
import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOFigmaNode, DTOFigmaNodeRenderInput, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, 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";
|
|
@@ -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,7 +112,7 @@ 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 */
|
|
@@ -121,6 +121,11 @@ export declare class DataCoreWriteRequests {
|
|
|
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 */
|
|
@@ -133,6 +138,7 @@ export declare class DataCoreWriteRequests {
|
|
|
133
138
|
deleteDesignSystem(designSystemId: string): Promise<void>;
|
|
134
139
|
private elementAction;
|
|
135
140
|
createRemoteDocumentationPage(designSystemId: string, versionId: string, data: DTOCreateDocumentationPageInputV2): Promise<any>;
|
|
141
|
+
updateApprovalState(designSystemId: string, versionId: string, data: DTODocumentationPageApprovalStateChangeInput): Promise<any>;
|
|
136
142
|
/** Remote: create a group within documentation */
|
|
137
143
|
createRemoteDocumentationGroup(designSystemId: string, versionId: string, data: DTOCreateDocumentationGroupInput): Promise<any>;
|
|
138
144
|
/** Remote: create a group within documentation */
|
|
@@ -153,6 +159,8 @@ export declare class DataCoreWriteRequests {
|
|
|
153
159
|
deleteRemoteDocumentationPage(designSystemId: string, versionId: string, data: DTODeleteDocumentationPageInputV2): Promise<any>;
|
|
154
160
|
/** Remote: deletes a documentation tab group */
|
|
155
161
|
deleteRemoteDocumentationTabGroup(designSystemId: string, versionId: string, data: DTODeleteDocumentationTabGroupInput): Promise<any>;
|
|
162
|
+
restoreRemoteDocumentationGroup(designSystemId: string, versionId: string, data: DTORestoreDocumentationGroupInput): Promise<any>;
|
|
163
|
+
restoreRemoteDocumentationPage(designSystemId: string, versionId: string, data: DTORestoreDocumentationPageInput): Promise<any>;
|
|
156
164
|
/** Remote: Deletes a documentation group */
|
|
157
165
|
deleteRemoteDocumentationGroup(designSystemId: string, versionId: string, data: DTODeleteDocumentationGroupInput): Promise<any>;
|
|
158
166
|
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";
|
|
@@ -66,6 +66,7 @@ export { DocsEntityMultiplayerItemResolver } from "./core/resolvers/SDKDocsEntit
|
|
|
66
66
|
export { DocsEntity } from "./model/docs/entities/SDKDocsEntity";
|
|
67
67
|
export { DocsEntityConfiguration } from "./model/docs/entities/SDKDocsEntityConfiguration";
|
|
68
68
|
export { DocsEntityDraftChangeType, DocsEntityDraftState, } from "./model/docs/entities/SDKDocsEntityDraftState";
|
|
69
|
+
export { DocsEntityApprovalState, DocsEntityApprovalStateType, } from "./model/docs/entities/SDKDocsEntityApprovalState";
|
|
69
70
|
export type { DocsEntityGroupModel } from "./model/docs/entities/SDKDocsEntityGroup";
|
|
70
71
|
export { DocsEntityGroup, DocsEntityMultiplayerGroup, } from "./model/docs/entities/SDKDocsEntityGroup";
|
|
71
72
|
export type { DocsEntityPageModel } from "./model/docs/entities/SDKDocsEntityPage";
|
|
@@ -102,6 +103,8 @@ export { DocsBlockRichTextPropertyDefinition } from "./model/docs/blocks/propert
|
|
|
102
103
|
export type { DocsBlockRichTextPropertyData, DocsBlockRichTextPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockRichTextProperty";
|
|
103
104
|
export { DocsBlockMultiRichTextPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty";
|
|
104
105
|
export type { DocsBlockMultiRichTextPropertyData, DocsBlockMultiRichTextPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty";
|
|
106
|
+
export { DocsBlockRichTextEditorPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockRichTextEditorProperty";
|
|
107
|
+
export type { DocsBlockRichTextEditorPropertyData, DocsBlockRichTextEditorPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockRichTextEditorProperty";
|
|
105
108
|
export { DocsBlockSingleSelectPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty";
|
|
106
109
|
export type { DocsBlockSingleSelectPropertyData, DocsBlockSingleSelectPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty";
|
|
107
110
|
export { DocsBlockTablePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTableProperty";
|
|
@@ -211,10 +214,11 @@ export { DocsBlockOptionRenderingStyle } from "./model/enums/SDKDocsBlockOptionR
|
|
|
211
214
|
export { DocsBlockRichTextPropertyStyle } from "./model/enums/SDKDocsBlockRichTextPropertyStyle";
|
|
212
215
|
export { DocsBlockTextPropertyStyle } from "./model/enums/SDKDocsBlockTextPropertyStyle";
|
|
213
216
|
export { DocsBlockTextPropertyColor } from "./model/enums/SDKDocsBlockTextPropertyColor";
|
|
214
|
-
export {
|
|
217
|
+
export { DocsBlockOptionColor } from "./model/enums/SDKDocsBlockOptionColor";
|
|
215
218
|
export { DocsEntityType } from "./model/enums/SDKDocsEntityType";
|
|
216
219
|
export { DocsSectionType } from "./model/enums/SDKDocsSectionType";
|
|
217
220
|
export { SourceType } from "./model/enums/SDKSourceType";
|
|
221
|
+
export { IconSet } from "./model/enums/SDKIconSet";
|
|
218
222
|
export { DocsBlockImagePropertyWidth } from "./model/enums/SDKDocsBlockImagePropertyWidth";
|
|
219
223
|
export { DocsPublishStatus } from "./model/enums/SDKDocsPublishStatus";
|
|
220
224
|
export { DocumentationEnvironment } from "./model/enums/SDKDocumentationEnvironment";
|
|
@@ -11,6 +11,8 @@ export type DesignSystemRemoteModel = {
|
|
|
11
11
|
workspaceId: string;
|
|
12
12
|
isPublic: boolean;
|
|
13
13
|
isMultibrand: boolean;
|
|
14
|
+
isApprovalFeatureEnabled: boolean;
|
|
15
|
+
approvalRequiredForPublishing: boolean;
|
|
14
16
|
docSlug: string;
|
|
15
17
|
docUserSlug?: string;
|
|
16
18
|
docExporterId: string;
|
|
@@ -30,6 +32,10 @@ export declare class DesignSystem {
|
|
|
30
32
|
isPublic: boolean;
|
|
31
33
|
/** If set, signals that multibrand functionality is enabled for this design system */
|
|
32
34
|
isMultiBrand: boolean;
|
|
35
|
+
/** If set, signals that approval feature is enabled */
|
|
36
|
+
isApprovalFeatureEnabled: boolean;
|
|
37
|
+
/** If set, restricts publishing to only pages with ready to publish state */
|
|
38
|
+
approvalRequiredForPublishing: boolean;
|
|
33
39
|
/** Unique identifier of exporter package used for the documentation */
|
|
34
40
|
documentationExporterId: string;
|
|
35
41
|
/** DocumentationLegacy URL slug */
|
|
@@ -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>;
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import { DTODocumentationDraftState, DTODocumentationItemConfigurationV2 } from "@supernova-studio/client";
|
|
1
|
+
import { DTODocumentationDraftState, DTODocumentationItemConfigurationV2, DTODocumentationPageApprovalState, DTODocumentationPublishMetadata } from "@supernova-studio/client";
|
|
2
2
|
import { DocsEntityType } from "../../enums/SDKDocsEntityType";
|
|
3
|
+
import { DocsEntityApprovalState } from "./SDKDocsEntityApprovalState";
|
|
3
4
|
import { DocsEntityConfiguration } from "./SDKDocsEntityConfiguration";
|
|
4
5
|
import { DocsEntityDraftState } from "./SDKDocsEntityDraftState";
|
|
5
6
|
export type DocsEntityModel = {
|
|
@@ -16,6 +17,12 @@ export type DocsEntityModel = {
|
|
|
16
17
|
createdAt?: string;
|
|
17
18
|
updatedAt?: string;
|
|
18
19
|
draftState?: DTODocumentationDraftState;
|
|
20
|
+
publishMetadata?: DTODocumentationPublishMetadata;
|
|
21
|
+
approvalState?: DTODocumentationPageApprovalState;
|
|
22
|
+
};
|
|
23
|
+
export type DocsEntityPublishMetadata = {
|
|
24
|
+
lastPublishedByUserId: string;
|
|
25
|
+
lastPublishedAt: Date;
|
|
19
26
|
};
|
|
20
27
|
export declare class DocsEntity {
|
|
21
28
|
id: string;
|
|
@@ -31,5 +38,7 @@ export declare class DocsEntity {
|
|
|
31
38
|
draftState: DocsEntityDraftState | null;
|
|
32
39
|
isPrivate: boolean;
|
|
33
40
|
isHidden: boolean;
|
|
41
|
+
publishMetadata: DocsEntityPublishMetadata | null;
|
|
42
|
+
approvalState: DocsEntityApprovalState | null;
|
|
34
43
|
constructor(model: DocsEntityModel);
|
|
35
44
|
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { DTODocumentationPageApprovalState } from "@supernova-studio/client";
|
|
2
|
+
import { DocsEntityDraftState } from "./SDKDocsEntityDraftState";
|
|
3
|
+
export declare enum DocsEntityApprovalStateType {
|
|
4
|
+
Draft = "Draft",
|
|
5
|
+
ReadyForReview = "ReadyForReview",
|
|
6
|
+
ChangesRequested = "ChangesRequested",
|
|
7
|
+
ReadyForPublish = "ReadyForPublish",
|
|
8
|
+
Published = "Published"
|
|
9
|
+
}
|
|
10
|
+
export declare class DocsEntityApprovalState {
|
|
11
|
+
state: DocsEntityApprovalStateType;
|
|
12
|
+
updatedByUserId: string | null;
|
|
13
|
+
constructor(model: DTODocumentationPageApprovalState | null, draftState: DocsEntityDraftState | null);
|
|
14
|
+
}
|
|
@@ -11,6 +11,4 @@ export declare class DocsEntityDraftState {
|
|
|
11
11
|
previousConfiguration: DocsEntityConfiguration | null;
|
|
12
12
|
previousContentHash: string | null;
|
|
13
13
|
constructor(model: DTODocumentationDraftState);
|
|
14
|
-
/** Constructs representation that can be used to write full object to remote */
|
|
15
|
-
toRemote(): DTODocumentationDraftState;
|
|
16
14
|
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { DocsEntityGroupBehavior } from "../../enums/SDKDocsEntityGroupBehavior";
|
|
2
2
|
import { DocsEntityType } from "../../enums/SDKDocsEntityType";
|
|
3
|
-
import { DocsEntity, DocsEntityModel } from "./SDKDocsEntity";
|
|
3
|
+
import { DocsEntity, DocsEntityModel, DocsEntityPublishMetadata } from "./SDKDocsEntity";
|
|
4
|
+
import { DocsEntityApprovalState } from "./SDKDocsEntityApprovalState";
|
|
4
5
|
import { DocsEntityDraftState } from "./SDKDocsEntityDraftState";
|
|
5
6
|
import { DocsEntityMultiplayerPage, DocsEntityPage } from "./SDKDocsEntityPage";
|
|
6
7
|
export type DocsEntityGroupModel = {
|
|
@@ -33,7 +34,7 @@ export declare class DocsEntityGroup extends DocsEntity {
|
|
|
33
34
|
deployedDocsPageUrl(): string | null;
|
|
34
35
|
}
|
|
35
36
|
/** Lightweight page representation used in multiplayer context type-validated against the full version */
|
|
36
|
-
export declare class DocsEntityMultiplayerGroup implements Pick<DocsEntityGroup, "id" | "persistentId" | "type" | "title" | "groupBehavior" | "childrenIds" | "isRoot" | "isPrivate" | "isHidden" | "draftState"> {
|
|
37
|
+
export declare class DocsEntityMultiplayerGroup implements Pick<DocsEntityGroup, "id" | "persistentId" | "type" | "title" | "groupBehavior" | "childrenIds" | "isRoot" | "isPrivate" | "isHidden" | "draftState" | "publishMetadata" | "approvalState"> {
|
|
37
38
|
id: string;
|
|
38
39
|
persistentId: string;
|
|
39
40
|
type: DocsEntityType.group;
|
|
@@ -46,6 +47,8 @@ export declare class DocsEntityMultiplayerGroup implements Pick<DocsEntityGroup,
|
|
|
46
47
|
draftState: DocsEntityDraftState | null;
|
|
47
48
|
isPrivate: boolean;
|
|
48
49
|
isHidden: boolean;
|
|
50
|
+
publishMetadata: DocsEntityPublishMetadata | null;
|
|
51
|
+
approvalState: DocsEntityApprovalState;
|
|
49
52
|
/** Children filtered to be only groups */
|
|
50
53
|
get subgroups(): Array<DocsEntityMultiplayerGroup>;
|
|
51
54
|
/** Children filtered to be only pages */
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DTODocumentationItemHeaderV2 } from "@supernova-studio/client";
|
|
2
2
|
import { Alignment } from "../../enums/SDKAlignment";
|
|
3
3
|
import { AssetScaleType } from "../../enums/SDKAssetScaleType";
|
|
4
4
|
import { DocsColorRef } from "../blocks/support/SDKDocsColorRef";
|
|
@@ -24,6 +24,6 @@ export declare class DocsEntityHeader {
|
|
|
24
24
|
showCoverText: boolean;
|
|
25
25
|
minHeight: number | null;
|
|
26
26
|
backgroundImageScale: "AspectFill" | "AspectFit";
|
|
27
|
-
constructor(model:
|
|
28
|
-
toRemote():
|
|
27
|
+
constructor(model: DTODocumentationItemHeaderV2);
|
|
28
|
+
toRemote(): DTODocumentationItemHeaderV2;
|
|
29
29
|
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { DocsEntityType } from "../../enums/SDKDocsEntityType";
|
|
2
|
-
import { DocsEntity, DocsEntityModel } from "./SDKDocsEntity";
|
|
2
|
+
import { DocsEntity, DocsEntityModel, DocsEntityPublishMetadata } from "./SDKDocsEntity";
|
|
3
|
+
import { DocsEntityApprovalState } from "./SDKDocsEntityApprovalState";
|
|
3
4
|
import { DocsEntityDraftState } from "./SDKDocsEntityDraftState";
|
|
4
5
|
import { DocsEntityMultiplayerGroup } from "./SDKDocsEntityGroup";
|
|
5
6
|
export type DocsEntityPageModel = {
|
|
@@ -27,7 +28,7 @@ export declare class DocsEntityPage extends DocsEntity {
|
|
|
27
28
|
relativePageUrl(): string | null;
|
|
28
29
|
}
|
|
29
30
|
/** Lightweight page representation used in multiplayer context type-validated against the full version */
|
|
30
|
-
export declare class DocsEntityMultiplayerPage implements Pick<DocsEntityPage, "id" | "persistentId" | "type" | "title" | "relativeUrl" | "createdAt" | "isPrivate" | "isHidden" | "draftState"> {
|
|
31
|
+
export declare class DocsEntityMultiplayerPage implements Pick<DocsEntityPage, "id" | "persistentId" | "type" | "title" | "relativeUrl" | "createdAt" | "isPrivate" | "isHidden" | "draftState" | "publishMetadata" | "approvalState"> {
|
|
31
32
|
id: string;
|
|
32
33
|
persistentId: string;
|
|
33
34
|
parentId: string | null;
|
|
@@ -39,5 +40,7 @@ export declare class DocsEntityMultiplayerPage implements Pick<DocsEntityPage, "
|
|
|
39
40
|
isPrivate: boolean;
|
|
40
41
|
isHidden: boolean;
|
|
41
42
|
draftState: DocsEntityDraftState | null;
|
|
43
|
+
publishMetadata: DocsEntityPublishMetadata | null;
|
|
44
|
+
approvalState: DocsEntityApprovalState;
|
|
42
45
|
constructor(model: DocsEntityPageModel);
|
|
43
46
|
}
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import type { DocsEntityPublishMetadata } from "../docs/entities/SDKDocsEntity";
|
|
2
|
+
import { DocsEntityApprovalState } from "../docs/entities/SDKDocsEntityApprovalState";
|
|
1
3
|
import { DocsEntityDraftState } from "../docs/entities/SDKDocsEntityDraftState";
|
|
2
4
|
import { DocumentationLegacyItemType } from "../enums/SDKDocumentationLegacyItemType";
|
|
3
5
|
import { DocumentationLegacyItemConfiguration, DocumentationLegacyItemConfigurationModel } from "./configuration/SDKDocumentationLegacyItemConfiguration";
|
|
@@ -26,5 +28,7 @@ export declare class DocumentationLegacyItem {
|
|
|
26
28
|
isPrivate: boolean;
|
|
27
29
|
isHidden: boolean;
|
|
28
30
|
draftState: DocsEntityDraftState | null;
|
|
31
|
+
publishMetadata: DocsEntityPublishMetadata | null;
|
|
32
|
+
approvalState: DocsEntityApprovalState;
|
|
29
33
|
constructor(model: DocumentationLegacyItemModel);
|
|
30
34
|
}
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
export declare enum DocsBlockItemPropertyType {
|
|
2
|
-
/** Rich text property
|
|
2
|
+
/** Rich text property used for core rich text blocks */
|
|
3
3
|
richText = "RichText",
|
|
4
4
|
/** Rich text property allows user to input multiple paragraphs of rich text (with additional attributes like bold, links etc.) */
|
|
5
5
|
multiRichText = "MultiRichText",
|
|
6
6
|
/** Text property allows user to input plain text */
|
|
7
7
|
text = "Text",
|
|
8
|
+
/** Rich text property to be used in custom blocks to input rich text (with additional attributes like bold, links etc.) */
|
|
9
|
+
richTextEditor = "RichTextEditor",
|
|
8
10
|
/** Boolean property allows user to input true/false value */
|
|
9
11
|
boolean = "Boolean",
|
|
10
12
|
/** Number property allows user to input number */
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export declare enum DocsBlockOptionColor {
|
|
2
|
+
green = "Green",
|
|
3
|
+
red = "Red",
|
|
4
|
+
yellow = "Yellow",
|
|
5
|
+
blue = "Blue",
|
|
6
|
+
purple = "Purple",
|
|
7
|
+
orange = "Orange",
|
|
8
|
+
pink = "Pink",
|
|
9
|
+
teal = "Teal",
|
|
10
|
+
grey = "Grey",
|
|
11
|
+
lightGrey = "LightGrey",
|
|
12
|
+
cyan = "Cyan",
|
|
13
|
+
fuchsia = "Fuchsia"
|
|
14
|
+
}
|
|
@@ -5,6 +5,6 @@ export declare enum DocsBlockOptionRenderingStyle {
|
|
|
5
5
|
toggleButton = "ToggleButton",
|
|
6
6
|
/** Option will be rendered as a select */
|
|
7
7
|
select = "Select",
|
|
8
|
-
/** Option will be rendered as
|
|
8
|
+
/** Option will be rendered as checkboxes/radios */
|
|
9
9
|
checkbox = "Checkbox"
|
|
10
10
|
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
export declare enum DocsBlockRichTextEditorPropertyStyle {
|
|
2
|
+
/** Ordered list */
|
|
3
|
+
ol = "OL",
|
|
4
|
+
/** Unordered list */
|
|
5
|
+
ul = "UL",
|
|
6
|
+
/** Bold text */
|
|
7
|
+
bold = "Bold",
|
|
8
|
+
/** Italic text */
|
|
9
|
+
italic = "Italic",
|
|
10
|
+
/** Hyperlink */
|
|
11
|
+
link = "Link",
|
|
12
|
+
/** Strikethrough text */
|
|
13
|
+
strikethrough = "Strikethrough",
|
|
14
|
+
/** Inline code (mark) */
|
|
15
|
+
inlineCode = "InlineCode"
|
|
16
|
+
}
|