@supernova-studio/supernova-sdk-beta 2.2.7 → 2.2.50
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/README.md +8 -12
- package/build/sdk-typescript/src/core/SDKSupernova.d.ts +18 -6
- package/build/sdk-typescript/src/core/areas/SDKAreaDataSources.d.ts +12 -14
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +3 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaMCP.d.ts +24 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaMe.d.ts +3 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaMessaging.d.ts +60 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaProjects.d.ts +2120 -64
- package/build/sdk-typescript/src/core/areas/SDKAreaRawData.d.ts +2049 -7
- package/build/sdk-typescript/src/core/areas/SDKAreaRelay.d.ts +61 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaResources.d.ts +83 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaThreads.d.ts +81 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaTokens.d.ts +3 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +71 -16
- package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +9 -5
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +2350 -73
- package/build/sdk-typescript/src/core/data/SDKDataCoreCached.d.ts +50 -0
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreAIRequests.d.ts +19 -27
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +1080 -36
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +2201 -37
- package/build/sdk-typescript/src/core/resolvers/SDKDocsEntityItemResolver.d.ts +9 -9
- package/build/sdk-typescript/src/exports-pulsar.d.ts +0 -2
- package/build/sdk-typescript/src/exports.d.ts +38 -6
- package/build/sdk-typescript/src/model/base/SDKDesignSystemVersionStats.d.ts +1 -0
- package/build/sdk-typescript/src/model/components/SDKDesignComponentBase.d.ts +1 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/do-dont-guidelines/SDKDocsBlockActualDoDontGuidelines.d.ts +18 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed/SDKDocsBlockActualEmbed.d.ts +10 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed-figma/SDKDocsBlockActualEmbedFigma.d.ts +10 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed-youtube/SDKDocsBlockActualEmbedYoutube.d.ts +10 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/files/SDKDocsBlockActualFiles.d.ts +16 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/image/SDKDocsBlockActualImage.d.ts +10 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/portal/SDKDocsBlockActualDoDontGuidelines.d.ts +8 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/portal/SDKDocsBlockActualEmbed.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/portal/SDKDocsBlockActualEmbedFigma.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/portal/SDKDocsBlockActualEmbedYoutube.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/portal/SDKDocsBlockActualFiles.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/portal/SDKDocsBlockActualImage.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/portal/SDKDocsBlockActualShortcutLinks.d.ts +8 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/shortcut-links/SDKDocsBlockActualShortcutLinks.d.ts +10 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeProperty.d.ts +3 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts +2 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockFileProperty.d.ts +22 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockImageProperty.d.ts +3 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +2 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockFigmaComponentPropsTable.d.ts +11 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockFigmaComponents.d.ts +11 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockFigmaComponentsConfig.d.ts +32 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockFiles.d.ts +22 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockGuideline.d.ts +25 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockGuidelines.d.ts +6 -0
- package/build/sdk-typescript/src/model/documentation/builder/SDKDocumentationLegacyBlockBuilder.d.ts +1 -1
- package/build/sdk-typescript/src/model/enums/SDKDesignSystemRole.d.ts +2 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockBehaviorDataType.d.ts +3 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +3 -1
- package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyCalloutType.d.ts +2 -1
- package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyHeadingType.d.ts +3 -1
- package/build/sdk-typescript/src/model/enums/SDKDocumentationLegacyPageBlockType.d.ts +6 -1
- package/build/sdk-typescript/src/model/enums/SDKFigmaComponentPreviewContainerSize.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts +3 -3
- package/build/sdk-typescript/src/model/enums/SDKUserRole.d.ts +1 -1
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceSeatType.d.ts +3 -0
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionProduct.d.ts +7 -0
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionStatus.d.ts +3 -1
- package/build/sdk-typescript/src/model/exporters/SDKPipeline.d.ts +1 -1
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportDestinations.d.ts +5 -0
- package/build/sdk-typescript/src/model/files/SDKFileUpload.d.ts +9 -0
- package/build/sdk-typescript/src/model/groups/SDKTokenGroup.d.ts +1 -0
- package/build/sdk-typescript/src/model/mcp/SDKMCPStream.d.ts +8 -0
- package/build/sdk-typescript/src/model/membership/SDKMembership.d.ts +10 -6
- package/build/sdk-typescript/src/model/messaging/SDKChatThread.d.ts +14 -0
- package/build/sdk-typescript/src/model/messaging/SDKChatThreadMessage.d.ts +48 -0
- package/build/sdk-typescript/src/model/projects/SDKForgeAgent.d.ts +8 -0
- package/build/sdk-typescript/src/model/projects/SDKForgeProject.d.ts +42 -0
- package/build/sdk-typescript/src/model/projects/SDKForgeProjectContext.d.ts +31 -0
- package/build/sdk-typescript/src/model/projects/SDKForgeProjectContextOverride.d.ts +20 -0
- package/build/sdk-typescript/src/model/projects/SDKForgeProjectDocument.d.ts +19 -0
- package/build/sdk-typescript/src/model/projects/SDKForgeProjectDocumentPreview.d.ts +13 -0
- package/build/sdk-typescript/src/model/projects/SDKForgeProjectFeature.d.ts +25 -0
- package/build/sdk-typescript/src/model/projects/SDKForgeProjectFeatureArtifact.d.ts +13 -0
- package/build/sdk-typescript/src/model/projects/SDKForgeProjectFeatureArtifactList.d.ts +7 -0
- package/build/sdk-typescript/src/model/projects/SDKForgeProjectFeatureIteration.d.ts +13 -0
- package/build/sdk-typescript/src/model/projects/SDKForgeProjectFeatureMessage.d.ts +26 -0
- package/build/sdk-typescript/src/model/projects/SDKForgeProjectFeatureMessageList.d.ts +10 -0
- package/build/sdk-typescript/src/model/projects/SDKForgeProjectFeatureMessageReaction.d.ts +9 -0
- package/build/sdk-typescript/src/model/projects/SDKForgeProjectFeaturePreview.d.ts +13 -0
- package/build/sdk-typescript/src/model/projects/SDKForgeProjectInvitation.d.ts +12 -0
- package/build/sdk-typescript/src/model/projects/SDKForgeProjectMembership.d.ts +14 -0
- package/build/sdk-typescript/src/model/projects/SDKForgeProjectRelation.d.ts +13 -0
- package/build/sdk-typescript/src/model/projects/sections/SDKForgeProjectDocumentSection.d.ts +6 -0
- package/build/sdk-typescript/src/model/projects/sections/SDKForgeProjectFeatureSection.d.ts +6 -0
- package/build/sdk-typescript/src/model/projects/sections/SDKForgeProjectSection.d.ts +12 -0
- package/build/sdk-typescript/src/model/storybook/SDKStorybookUpdate.d.ts +17 -0
- package/build/sdk-typescript/src/model/support/SDKSource.d.ts +8 -1
- package/build/sdk-typescript/src/model/themes/SDKTokenTheme.d.ts +1 -1
- package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +1 -1
- package/build/sdk-typescript/src/model/threads/SDKThreadMessage.d.ts +36 -0
- package/build/sdk-typescript/src/model/threads/SDKThreadMessageList.d.ts +10 -0
- package/build/sdk-typescript/src/model/threads/SDKThreadMessageReaction.d.ts +9 -0
- package/build/sdk-typescript/src/model/tokens/SDKDimensionToken.d.ts +1 -1
- package/build/sdk-typescript/src/model/tokens/SDKStringToken.d.ts +1 -1
- package/build/sdk-typescript/src/model/tokens/SDKToken.d.ts +1 -0
- package/build/sdk-typescript/src/model/trail-events/SDKTrailEvent.d.ts +17 -0
- package/build/sdk-typescript/src/model/users/SDKUser.d.ts +7 -0
- package/build/sdk-typescript/src/model/users/SDKUserMembership.d.ts +13 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspace.d.ts +22 -9
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceInvitation.d.ts +15 -9
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspacePortalSettings.d.ts +12 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProductFeatures.d.ts +2 -2
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProductPrice.d.ts +7 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProfile.d.ts +8 -26
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceSubscription.d.ts +72 -41
- package/build/sdk-typescript/src/tests/Areas/AreaRelay.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Areas/AreaThreads.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/helpers.d.ts +1 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTMapLoader.d.ts +1 -1
- package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +13 -2
- package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownLinkResolver.d.ts +39 -0
- package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransform.d.ts +2 -2
- package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformBlock.d.ts +33 -10
- package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformUtil.d.ts +8 -3
- package/build/sdk-typescript/src/utils/RawUtils.d.ts +59 -3
- package/build/supernova-sdk-typescript.js +1 -2
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +19 -29
- package/build/sdk-typescript/src/core/areas/SDKAreaAI.d.ts +0 -75
- package/build/sdk-typescript/src/model/acl/SDKAcl.d.ts +0 -51
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemotePipelineModel.d.ts +0 -51
- package/build/sdk-typescript/src/model/projects/SDKProject.d.ts +0 -39
- package/build/sdk-typescript/src/model/projects/SDKProjectContext.d.ts +0 -47
- package/build/supernova-sdk-typescript.js.LICENSE.txt +0 -8
- /package/build/sdk-typescript/src/tests/Areas/{AreaAI.spec.d.ts → AreaMessaging.spec.d.ts} +0 -0
|
@@ -3,19 +3,19 @@ import { DocsEntityGroup } from "../../model/docs/entities/SDKDocsEntityGroup";
|
|
|
3
3
|
import { DocsEntityPage } from "../../model/docs/entities/SDKDocsEntityPage";
|
|
4
4
|
export declare class DocsEntityItemResolver {
|
|
5
5
|
hashedItems: Map<string, {
|
|
6
|
-
type: "Group";
|
|
7
6
|
id: string;
|
|
7
|
+
createdAt: Date;
|
|
8
|
+
type: "Group";
|
|
8
9
|
designSystemVersionId: string;
|
|
9
10
|
persistentId: string;
|
|
10
|
-
createdAt: Date;
|
|
11
11
|
updatedAt: Date;
|
|
12
12
|
title: string;
|
|
13
13
|
isRoot: boolean;
|
|
14
14
|
childrenIds: string[];
|
|
15
15
|
configuration: {
|
|
16
|
+
isHidden: boolean;
|
|
16
17
|
showSidebar: boolean;
|
|
17
18
|
isPrivate: boolean;
|
|
18
|
-
isHidden: boolean;
|
|
19
19
|
header: {
|
|
20
20
|
description: string;
|
|
21
21
|
alignment: "Center" | "Left";
|
|
@@ -61,9 +61,9 @@ export declare class DocsEntityItemResolver {
|
|
|
61
61
|
changes: {
|
|
62
62
|
previousTitle?: string | undefined;
|
|
63
63
|
previousConfiguration?: {
|
|
64
|
+
isHidden: boolean;
|
|
64
65
|
showSidebar: boolean;
|
|
65
66
|
isPrivate: boolean;
|
|
66
|
-
isHidden: boolean;
|
|
67
67
|
header: {
|
|
68
68
|
description: string;
|
|
69
69
|
alignment: "Center" | "Left";
|
|
@@ -104,18 +104,18 @@ export declare class DocsEntityItemResolver {
|
|
|
104
104
|
lastPublishedAt: Date;
|
|
105
105
|
} | undefined;
|
|
106
106
|
} | {
|
|
107
|
+
id: string;
|
|
108
|
+
createdAt: Date;
|
|
107
109
|
path: string;
|
|
108
110
|
type: "Page";
|
|
109
|
-
id: string;
|
|
110
111
|
designSystemVersionId: string;
|
|
111
112
|
persistentId: string;
|
|
112
|
-
createdAt: Date;
|
|
113
113
|
updatedAt: Date;
|
|
114
114
|
title: string;
|
|
115
115
|
configuration: {
|
|
116
|
+
isHidden: boolean;
|
|
116
117
|
showSidebar: boolean;
|
|
117
118
|
isPrivate: boolean;
|
|
118
|
-
isHidden: boolean;
|
|
119
119
|
header: {
|
|
120
120
|
description: string;
|
|
121
121
|
alignment: "Center" | "Left";
|
|
@@ -147,8 +147,8 @@ export declare class DocsEntityItemResolver {
|
|
|
147
147
|
shortPersistentId: string;
|
|
148
148
|
slug?: string | undefined;
|
|
149
149
|
approvalState?: {
|
|
150
|
-
designSystemVersionId: string;
|
|
151
150
|
createdAt: Date;
|
|
151
|
+
designSystemVersionId: string;
|
|
152
152
|
updatedAt: Date;
|
|
153
153
|
pagePersistentId: string;
|
|
154
154
|
approvalState: "ReadyForReview" | "ChangesRequested" | "Approved";
|
|
@@ -162,9 +162,9 @@ export declare class DocsEntityItemResolver {
|
|
|
162
162
|
changes: {
|
|
163
163
|
previousTitle?: string | undefined;
|
|
164
164
|
previousConfiguration?: {
|
|
165
|
+
isHidden: boolean;
|
|
165
166
|
showSidebar: boolean;
|
|
166
167
|
isPrivate: boolean;
|
|
167
|
-
isHidden: boolean;
|
|
168
168
|
header: {
|
|
169
169
|
description: string;
|
|
170
170
|
alignment: "Center" | "Left";
|
|
@@ -14,8 +14,6 @@ export type { WorkspaceSSOSettings } from "./model/workspaces/SDKWorkspaceSSOSet
|
|
|
14
14
|
export type { WorkspaceNPMRegistrySettings } from "./model/workspaces/SDKWorkspaceNPMRegistrySettings";
|
|
15
15
|
export type { User } from "./model/users/SDKUser";
|
|
16
16
|
export type { UserProfile } from "./model/users/SDKUserProfile";
|
|
17
|
-
export type { Acl } from "./model/acl/SDKAcl";
|
|
18
|
-
export type { AclPermissionResolution } from "./model/acl/SDKAcl";
|
|
19
17
|
export type { SubscriptionProductFeatures } from "./model/workspaces/SDKWorkspaceProductFeatures";
|
|
20
18
|
export type { ProductFeature } from "./model/workspaces/SDKWorkspaceProductFeatures";
|
|
21
19
|
export type { FeaturePermissionResolution } from "./model/workspaces/SDKWorkspaceProductFeatures";
|
|
@@ -14,8 +14,10 @@ export { Workspace } from "./model/workspaces/SDKWorkspace";
|
|
|
14
14
|
export { WorkspaceProfile } from "./model/workspaces/SDKWorkspaceProfile";
|
|
15
15
|
export type { WorkspaceProfileUpdateModel } from "./model/workspaces/SDKWorkspaceProfile";
|
|
16
16
|
export { WorkspaceOnboarding } from "./model/workspaces/SDKWorkspaceOnboarding";
|
|
17
|
-
export {
|
|
18
|
-
export type {
|
|
17
|
+
export type { WorkspaceIntegrationsRemoteModel } from "./model/workspaces/SDKWorkspaceIntegration";
|
|
18
|
+
export type { SubscriptionProductFeaturesRemoteModel } from "./model/workspaces/SDKWorkspaceProductFeatures";
|
|
19
|
+
export { type WorkspaceSubscriptionRemoteModel, WorkspaceSubscription, } from "./model/workspaces/SDKWorkspaceSubscription";
|
|
20
|
+
export type { WorkspaceSubscriptionUpdateModel, WorkspaceSubscriptionUpdatePreviewModel, } from "./model/workspaces/SDKWorkspaceSubscription";
|
|
19
21
|
export { WorkspaceIPWhitelistSettings } from "./model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
20
22
|
export { WorkspaceSSOSettings } from "./model/workspaces/SDKWorkspaceSSOSettings";
|
|
21
23
|
export { WorkspaceNPMRegistrySettings } from "./model/workspaces/SDKWorkspaceNPMRegistrySettings";
|
|
@@ -23,12 +25,12 @@ export { WorkspaceInvitation } from "./model/workspaces/SDKWorkspaceInvitation";
|
|
|
23
25
|
export type { WorkspaceInvitationUpdateModel } from "./model/workspaces/SDKWorkspaceInvitation";
|
|
24
26
|
export { WorkspaceInvoice } from "./model/workspaces/SDKWorkspaceInvoice";
|
|
25
27
|
export { WorkspaceProduct } from "./model/workspaces/SDKWorkspaceProduct";
|
|
28
|
+
export { PortalSettings, type PortalSettingsRemoteModel, } from "./model/workspaces/SDKWorkspacePortalSettings";
|
|
26
29
|
export { User } from "./model/users/SDKUser";
|
|
30
|
+
export type { UserUpdateModel } from "./model/users/SDKUser";
|
|
27
31
|
export type { UserProfileUpdateModel, UserTheme, } from "./model/users/SDKUserProfile";
|
|
28
32
|
export { UserProfile, UserOnboardingDepartments, UserOnboardingJobLevels, UserOnboardingCompanySizes, UserOnboardingDesignSystemTeamSizes, type UserOnboardingDepartment, type UserOnboardingJobLevel, type UserOnboardingCompanySize, type UserOnboardingDesignSystemTeamSize, type UserOnboardingDefaultDestination, } from "./model/users/SDKUserProfile";
|
|
29
33
|
export { UserMembership } from "./model/users/SDKUserMembership";
|
|
30
|
-
export { Acl } from "./model/acl/SDKAcl";
|
|
31
|
-
export type { AclPermissionResolution } from "./model/acl/SDKAcl";
|
|
32
34
|
export { SubscriptionProductFeatures } from "./model/workspaces/SDKWorkspaceProductFeatures";
|
|
33
35
|
export type { ProductFeature } from "./model/workspaces/SDKWorkspaceProductFeatures";
|
|
34
36
|
export type { FeaturePermissionResolution } from "./model/workspaces/SDKWorkspaceProductFeatures";
|
|
@@ -69,6 +71,7 @@ export { DesignComponent } from "./model/components/SDKDesignComponent";
|
|
|
69
71
|
export { DesignComponentVariant } from "./model/components/SDKDesignComponentVariant";
|
|
70
72
|
export { DesignComponentPropertyBoolean, DesignComponentPropertyDefinition, DesignComponentPropertyInstanceSwap, DesignComponentPropertyText, DesignComponentPropertyVariant, DesignComponentPropertyType, } from "./model/components/SDKDesignComponentPropertyDefinition";
|
|
71
73
|
export { CodeComponent } from "./model/code-components/SDKCodeComponent";
|
|
74
|
+
export { CodeLanguage } from "./model/enums/SDKCodeLanguage";
|
|
72
75
|
export { CodeComponentPropertyControlType, CodeComponentPropertyControlDefinition, } from "./model/code-components/SDKCodeComponentPropertyControlDefinition";
|
|
73
76
|
export { CodeComponentPropertyDefinition } from "./model/code-components/SDKCodeComponentPropertyDefinition";
|
|
74
77
|
export { DocsAnalyticsVisitData } from "./model/docs_analytics/SDKDocsAnalyticsVisitData";
|
|
@@ -259,10 +262,12 @@ export { Unit } from "./model/enums/SDKUnit";
|
|
|
259
262
|
export { UserRole } from "./model/enums/SDKUserRole";
|
|
260
263
|
export { VisibilityType } from "./model/enums/SDKVisibilityType";
|
|
261
264
|
export { WorkspaceSubscriptionPlanInterval } from "./model/enums/SDKWorkspaceSubscriptionPlanInterval";
|
|
262
|
-
export { WorkspaceSubscriptionProductCode } from "./model/enums/SDKWorkspaceSubscriptionProduct";
|
|
265
|
+
export { WorkspaceSubscriptionProductCode, type SubscriptionCheckoutProductCode, subscriptionCheckoutProductCodes, } from "./model/enums/SDKWorkspaceSubscriptionProduct";
|
|
263
266
|
export { WorkspaceSubscriptionStatus } from "./model/enums/SDKWorkspaceSubscriptionStatus";
|
|
264
267
|
export { WorkspaceNPMRegistryAuthType } from "./model/enums/SDKWorkspaceNPMRegistryAuthType";
|
|
265
268
|
export { WorkspaceNPMRegistryType } from "./model/enums/SDKWorkspaceNPMRegistryType";
|
|
269
|
+
export type { WorkspaceSeatType } from "./model/enums/SDKWorkspaceSeatType";
|
|
270
|
+
export { allWorkspaceSeatTypes } from "./model/enums/SDKWorkspaceSeatType";
|
|
266
271
|
export { ImportWarningType } from "./model/enums/SDKCloudWarningType";
|
|
267
272
|
export { CustomDomainErrorCode } from "./model/enums/SDKCustomDomainErrorCode";
|
|
268
273
|
export { CustomDomainState } from "./model/enums/SDKCustomDomainState";
|
|
@@ -286,7 +291,7 @@ export { BlurToken } from "./model/tokens/SDKBlurToken";
|
|
|
286
291
|
export { BorderToken } from "./model/tokens/SDKBorderToken";
|
|
287
292
|
export { ColorToken } from "./model/tokens/SDKColorToken";
|
|
288
293
|
export { GradientToken } from "./model/tokens/SDKGradientToken";
|
|
289
|
-
export { DimensionToken, SizeToken, SpaceToken, OpacityToken, FontSizeToken, LineHeightToken, LetterSpacingToken, ParagraphSpacingToken, BorderWidthToken, RadiusToken, DurationToken, ZIndexToken, } from "./model/tokens/SDKDimensionToken";
|
|
294
|
+
export { DimensionToken, SizeToken, SpaceToken, OpacityToken, FontSizeToken, LineHeightToken, LetterSpacingToken, ParagraphSpacingToken, BorderWidthToken, RadiusToken, DurationToken, ZIndexToken, DimensionCategoryToken, } from "./model/tokens/SDKDimensionToken";
|
|
290
295
|
export type { TokenUtilPreviewResolvedStyle } from "./tools/token-preview/TokenUtilPreviewTypes";
|
|
291
296
|
export type { AnyDimensionToken } from "./model/tokens/SDKDimensionToken";
|
|
292
297
|
export { ShadowToken } from "./model/tokens/SDKShadowToken";
|
|
@@ -301,6 +306,9 @@ export type { AnyToken, AnyTokenValue, BlurTokenValue, BorderTokenValue, ColorTo
|
|
|
301
306
|
export { TokenTheme } from "./model/themes/SDKTokenTheme";
|
|
302
307
|
export { TokenThemeOverride } from "./model/themes/SDKTokenThemeOverride";
|
|
303
308
|
export type { TokenThemeOverrideTranserObject } from "./model/themes/SDKTokenThemeOverride";
|
|
309
|
+
export { ChatThread } from "./model/messaging/SDKChatThread";
|
|
310
|
+
export { ChatThreadMessage, ChatMessageUserScoreType, } from "./model/messaging/SDKChatThreadMessage";
|
|
311
|
+
export { MCPStream } from "./model/mcp/SDKMCPStream";
|
|
304
312
|
export { TokenUtilPreviewGenerator } from "./tools/token-preview/TokenUtilPreviewGenerator";
|
|
305
313
|
export { TokenJSONBuilder, JSONBuilderNamingOption, } from "./tools/json-builder/SDKToolsJSONBuilder";
|
|
306
314
|
export type { DTProcessedTokenNode } from "./tools/design-tokens/utilities/SDKDTJSONConverter";
|
|
@@ -333,3 +341,27 @@ export type { ElementPropertyValueRemoteModel } from "./model/elements/values/SD
|
|
|
333
341
|
export type { ElementDataViewRemoteModel } from "./model/elements/SDKElementDataView";
|
|
334
342
|
export { RawUtils } from "./utils/RawUtils";
|
|
335
343
|
export { StorybookEntry } from "./model/storybook/SDKStorybookEntry";
|
|
344
|
+
export type { RemoteStorybookEntry } from "./model/storybook/SDKStorybookEntry";
|
|
345
|
+
export type { RemoteFile } from "./model/files/SDKFileUpload";
|
|
346
|
+
export { ForgeProject, type ForgeProjectRemoteModel, } from "./model/projects/SDKForgeProject";
|
|
347
|
+
export { TrailEvent, type TrailEventRemoteModel, type TrailEventType, type TrailEventCreateInput, type TrailEventListInput, type TrailEventListResponse, } from "./model/trail-events/SDKTrailEvent";
|
|
348
|
+
export { ForgeProjectMembership } from "./model/projects/SDKForgeProjectMembership";
|
|
349
|
+
export type { ForgeProjectMembershipRole } from "./model/projects/SDKForgeProjectMembership";
|
|
350
|
+
export { ForgeProjectContext, type ForgeProjectContextRemoteModel, type ForgeProjectContextCreateInput, type ForgeProjectContextUpdateInput, type ForgeProjectTheme, type TokenThemeSet, } from "./model/projects/SDKForgeProjectContext";
|
|
351
|
+
export { ForgeAgent } from "./model/projects/SDKForgeAgent";
|
|
352
|
+
export { ForgeProjectDocument } from "./model/projects/SDKForgeProjectDocument";
|
|
353
|
+
export { ForgeProjectFeature } from "./model/projects/SDKForgeProjectFeature";
|
|
354
|
+
export { ForgeProjectDocumentSection } from "./model/projects/sections/SDKForgeProjectDocumentSection";
|
|
355
|
+
export { ForgeProjectFeatureSection } from "./model/projects/sections/SDKForgeProjectFeatureSection";
|
|
356
|
+
export type { ForgeProjectSection } from "./model/projects/sections/SDKForgeProjectSection";
|
|
357
|
+
export { ForgeProjectFeatureMessage } from "./model/projects/SDKForgeProjectFeatureMessage";
|
|
358
|
+
export { ForgeProjectFeatureMessageReaction } from "./model/projects/SDKForgeProjectFeatureMessageReaction";
|
|
359
|
+
export { ForgeProjectFeatureMessageList } from "./model/projects/SDKForgeProjectFeatureMessageList";
|
|
360
|
+
export { ForgeProjectFeatureArtifact } from "./model/projects/SDKForgeProjectFeatureArtifact";
|
|
361
|
+
export { ForgeProjectFeatureArtifactList } from "./model/projects/SDKForgeProjectFeatureArtifactList";
|
|
362
|
+
export { ForgeProjectFeatureIteration } from "./model/projects/SDKForgeProjectFeatureIteration";
|
|
363
|
+
export { ForgeProjectRelation } from "./model/projects/SDKForgeProjectRelation";
|
|
364
|
+
export type { ForgeProjectRelationItemType } from "./model/projects/SDKForgeProjectRelation";
|
|
365
|
+
export { ThreadMessage } from "./model/threads/SDKThreadMessage";
|
|
366
|
+
export { ThreadMessageReaction } from "./model/threads/SDKThreadMessageReaction";
|
|
367
|
+
export { ThreadMessageList } from "./model/threads/SDKThreadMessageList";
|
|
@@ -5,6 +5,7 @@ export declare class DesignSystemVersionStats {
|
|
|
5
5
|
assets: number;
|
|
6
6
|
documentationPages: number;
|
|
7
7
|
figmaComponents: number;
|
|
8
|
+
stories: number;
|
|
8
9
|
constructor(model: DTODesignSystemVersionStats);
|
|
9
10
|
/** Constructs representation that can be used to write full object to remote */
|
|
10
11
|
toRemote(): DTODesignSystemVersionStats;
|
|
@@ -3,6 +3,7 @@ import { DesignComponentOrigin } from "../support/SDKDesignComponentOrigin";
|
|
|
3
3
|
import { Source } from "../support/SDKSource";
|
|
4
4
|
export declare abstract class DesignComponentBase {
|
|
5
5
|
id: string;
|
|
6
|
+
idInVersion: string;
|
|
6
7
|
brandId: string;
|
|
7
8
|
thumbnailUrl: string | null;
|
|
8
9
|
svgUrl: string | null;
|
|
@@ -1,3 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 1. Block metadata
|
|
3
|
+
*/
|
|
4
|
+
export declare const id = "io.supernova.block.do-dont-guidelines";
|
|
5
|
+
export declare const name = "Guidelines";
|
|
6
|
+
export declare const icon = "https://cdn-assets.supernova.io/blocks/icons/guidelines.svg";
|
|
7
|
+
export declare const descriptionShort = "Document your Do's and Don'ts.";
|
|
8
|
+
export declare const keywords: string[];
|
|
9
|
+
export declare const helpText = "Use link block to document your Do/Don't guidelines for your components and patterns.";
|
|
10
|
+
export declare const docsUrl = "https://learn.supernova.io/latest/documentation/types-of-blocks/links/shortcuts/general-jVfNifo4";
|
|
11
|
+
/**
|
|
12
|
+
* 2. Block properties
|
|
13
|
+
*/
|
|
14
|
+
export declare const properties: {
|
|
15
|
+
image: import("../../../properties/SDKDocsBlockImageProperty").DocsBlockImagePropertyDefinition;
|
|
16
|
+
type: import("../../../properties/SDKDocsBlockSingleSelectProperty").DocsBlockSingleSelectPropertyDefinition;
|
|
17
|
+
description: import("../../../properties/SDKDocsBlockRichTextEditorProperty").DocsBlockRichTextEditorPropertyDefinition;
|
|
18
|
+
};
|
|
1
19
|
/**
|
|
2
20
|
* 5. Block definition
|
|
3
21
|
*/
|
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 1. Block metadata
|
|
3
|
+
*/
|
|
4
|
+
export declare const id = "io.supernova.block.embed";
|
|
5
|
+
export declare const name = "Embed";
|
|
6
|
+
export declare const icon = "https://cdn-assets.supernova.io/blocks/icons/embed.svg";
|
|
7
|
+
export declare const descriptionShort = "Embed a generic URL";
|
|
8
|
+
export declare const searchKeywords: string[];
|
|
9
|
+
export declare const helpText = "Embed any page to your documentation as an iframe.";
|
|
10
|
+
export declare const docsUrl = "https://learn.supernova.io/latest/documentation/types-of-blocks/media-and-assets/embed/public-url-2ZeRQ332";
|
|
1
11
|
/**
|
|
2
12
|
* 5. Block definition
|
|
3
13
|
*/
|
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 1. Block metadata
|
|
3
|
+
*/
|
|
4
|
+
export declare const id = "io.supernova.block.embed-figma";
|
|
5
|
+
export declare const name = "Figma embed";
|
|
6
|
+
export declare const icon = "https://cdn-assets.supernova.io/blocks/icons/embed-figma.svg";
|
|
7
|
+
export declare const descriptionShort = "Embed a Figma canvas or prototype";
|
|
8
|
+
export declare const searchKeywords: string[];
|
|
9
|
+
export declare const helpText = "Embed a Figma canvas or prototype to your documentation.";
|
|
10
|
+
export declare const docsUrl = "https://learn.supernova.io/latest/documentation/types-of-blocks/figma/embed-figma-GPNJsT8A";
|
|
1
11
|
/**
|
|
2
12
|
* 5. Block definition
|
|
3
13
|
*/
|
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 1. Block metadata
|
|
3
|
+
*/
|
|
4
|
+
export declare const id = "io.supernova.block.embed-youtube";
|
|
5
|
+
export declare const name = "YouTube";
|
|
6
|
+
export declare const icon = "https://cdn-assets.supernova.io/blocks/icons/embed-youtube.svg";
|
|
7
|
+
export declare const descriptionShort = "Embed a Youtube video";
|
|
8
|
+
export declare const searchKeywords: string[];
|
|
9
|
+
export declare const helpText = "Embed a YouTube video to your documentation.";
|
|
10
|
+
export declare const docsUrl = "https://learn.supernova.io/latest/documentation/types-of-blocks/media-and-assets/youtube-Gh8VUrSF";
|
|
1
11
|
/**
|
|
2
12
|
* 5. Block definition
|
|
3
13
|
*/
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 1. Block metadata
|
|
3
|
+
*/
|
|
4
|
+
export declare const id = "io.supernova.block.files";
|
|
5
|
+
export declare const name = "File upload";
|
|
6
|
+
export declare const icon = "https://cdn-assets.supernova.io/blocks/icons/files.svg";
|
|
7
|
+
export declare const descriptionShort = "Display attachments for download";
|
|
8
|
+
export declare const keywords: string[];
|
|
9
|
+
export declare const descriptionFull = "Display attachments for download";
|
|
10
|
+
export declare const docsUrl = "https://learn.supernova.io/file-upload-block";
|
|
11
|
+
/**
|
|
12
|
+
* 5. Block definition
|
|
13
|
+
*/
|
|
14
|
+
declare const block: import("../../SDKDocsBlockDefinition").DocsBlockDefinition;
|
|
15
|
+
/** 6. Block export */
|
|
16
|
+
export { block as Files };
|
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 1. Block metadata
|
|
3
|
+
*/
|
|
4
|
+
export declare const id = "io.supernova.block.image";
|
|
5
|
+
export declare const name = "Image";
|
|
6
|
+
export declare const icon = "https://cdn-assets.supernova.io/blocks/icons/v2/image.svg";
|
|
7
|
+
export declare const descriptionShort = "Display an image or Figma image";
|
|
8
|
+
export declare const searchKeywords: string[];
|
|
9
|
+
export declare const helpText = "Use to display an image or Figma image.";
|
|
10
|
+
export declare const docsUrl = "https://learn.supernova.io/latest/documentation/types-of-blocks/media-and-assets/image-Ue8VdT8B";
|
|
1
11
|
/**
|
|
2
12
|
* 5. Block definition
|
|
3
13
|
*/
|
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 1. Block metadata
|
|
3
|
+
*/
|
|
4
|
+
export declare const id = "io.supernova.block.shortcut-links";
|
|
5
|
+
export declare const name = "Shortcut links";
|
|
6
|
+
export declare const icon = "https://cdn-assets.supernova.io/blocks/icons/v2/shortcuts.svg";
|
|
7
|
+
export declare const descriptionShort = "Link to a page or external URL";
|
|
8
|
+
export declare const keywords: string[];
|
|
9
|
+
export declare const helpText = "Use link block to create single or multiple links to places in or out of your documentation.";
|
|
10
|
+
export declare const docsUrl = "https://learn.supernova.io/latest/documentation/types-of-blocks/links/shortcuts/general-jVfNifo4";
|
|
1
11
|
/**
|
|
2
12
|
* 5. Block definition
|
|
3
13
|
*/
|
|
@@ -2,7 +2,9 @@ import { CodeLanguage } from "../../../enums/SDKCodeLanguage";
|
|
|
2
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
3
|
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
|
|
4
4
|
/** Code property - Additional non-value options */
|
|
5
|
-
export type DocsBlockCodePropertyOptions =
|
|
5
|
+
export type DocsBlockCodePropertyOptions = {
|
|
6
|
+
shouldHideCodeSyntax?: boolean;
|
|
7
|
+
};
|
|
6
8
|
/** Code property - Data */
|
|
7
9
|
export type DocsBlockCodePropertyData = DocsBlockPropertyData<string> & {
|
|
8
10
|
format?: CodeLanguage;
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts
CHANGED
|
@@ -10,6 +10,8 @@ export type DocsBlockEmbedUrlPropertyOptions = {
|
|
|
10
10
|
allowResize?: boolean;
|
|
11
11
|
/** Defined how to validate the embed URL */
|
|
12
12
|
urlValidationRegex?: string;
|
|
13
|
+
/** If enabled, the embed is interactive */
|
|
14
|
+
isInteractive?: boolean;
|
|
13
15
|
};
|
|
14
16
|
/** EmbedUrl property - Data */
|
|
15
17
|
export type DocsBlockEmbedUrlPropertyData = DocsBlockPropertyData<string | undefined> & {
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** File property - Additional non-value options */
|
|
4
|
+
export type DocsBlockFilePropertyOptions = {
|
|
5
|
+
renderLayoutAs: "iconOnTop" | "iconOnLeft";
|
|
6
|
+
editorInteractivity?: "edit" | "viewOnly";
|
|
7
|
+
};
|
|
8
|
+
/** File property - Data */
|
|
9
|
+
export type DocsBlockFilePropertyValue = Array<{
|
|
10
|
+
entityId: string;
|
|
11
|
+
entityMeta?: {
|
|
12
|
+
title?: string;
|
|
13
|
+
description?: string;
|
|
14
|
+
};
|
|
15
|
+
}>;
|
|
16
|
+
export type DocsBlockFilePropertyData = DocsBlockPropertyData<DocsBlockFilePropertyValue>;
|
|
17
|
+
/** File property - Definition model */
|
|
18
|
+
export type DocsBlockFilePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockFilePropertyOptions;
|
|
19
|
+
/** File property - Definition */
|
|
20
|
+
export declare class DocsBlockFilePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockFilePropertyOptions, DocsBlockFilePropertyData> {
|
|
21
|
+
type: DocsBlockItemPropertyType.file;
|
|
22
|
+
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockImageProperty.d.ts
CHANGED
|
@@ -12,6 +12,9 @@ export type DocsBlockImagePropertyOptions = {
|
|
|
12
12
|
allowLightbox?: boolean;
|
|
13
13
|
allowBorder?: boolean;
|
|
14
14
|
recommendation?: string;
|
|
15
|
+
imageSources?: ("figmaDataSource" | "figmaStandalone" | "upload")[];
|
|
16
|
+
/** Editor interactivity */
|
|
17
|
+
editorInteractivity?: "edit" | "viewOnly";
|
|
15
18
|
};
|
|
16
19
|
/** Image property - Data */
|
|
17
20
|
export type DocsBlockImagePropertyData = DocsBlockPropertyData<DocsImageRef | undefined> & {
|
|
@@ -14,6 +14,8 @@ export type DocsBlockTextPropertyOptions = {
|
|
|
14
14
|
color?: DocsBlockTextPropertyColor;
|
|
15
15
|
/** Allow line breaks (todo: should render as growing textarea in property panel if true) */
|
|
16
16
|
allowLineBreaks?: boolean;
|
|
17
|
+
/** Editor interactivity */
|
|
18
|
+
editorInteractivity?: "edit" | "viewOnly";
|
|
17
19
|
};
|
|
18
20
|
/** Text property - Data */
|
|
19
21
|
export type DocsBlockTextPropertyData = DocsBlockPropertyData<string> & Record<string, never>;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { DocumentationLegacyPageBlockModel, DocumentationLegacyPageBlock } from "../SDKDocumentationLegacyPageBlock";
|
|
2
|
+
import { DocumentationLegacyPageBlockFigmaComponentsConfigModel, DocumentationLegacyPageBlockSelectedFigmaComponentModel, DocumentationLegacyPageBlockFigmaComponentsConfig, DocumentationLegacyPageBlockSelectedFigmaComponent } from "./SDKDocumentationLegacyPageBlockFigmaComponentsConfig";
|
|
3
|
+
export interface DocumentationLegacyPageBlockFigmaComponentPropsTableModel extends DocumentationLegacyPageBlockModel {
|
|
4
|
+
figmaComponentsBlockConfig: DocumentationLegacyPageBlockFigmaComponentsConfigModel;
|
|
5
|
+
selectedFigmaComponent?: DocumentationLegacyPageBlockSelectedFigmaComponentModel;
|
|
6
|
+
}
|
|
7
|
+
export declare class DocumentationLegacyPageBlockFigmaComponentPropsTable extends DocumentationLegacyPageBlock {
|
|
8
|
+
figmaComponentsBlockConfig: DocumentationLegacyPageBlockFigmaComponentsConfig;
|
|
9
|
+
selectedFigmaComponent: DocumentationLegacyPageBlockSelectedFigmaComponent | null;
|
|
10
|
+
constructor(model: DocumentationLegacyPageBlockFigmaComponentPropsTableModel, children: Array<DocumentationLegacyPageBlock>);
|
|
11
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { DocumentationLegacyPageBlockModel, DocumentationLegacyPageBlock } from "../SDKDocumentationLegacyPageBlock";
|
|
2
|
+
import { DocumentationLegacyPageBlockFigmaComponentsConfig, DocumentationLegacyPageBlockFigmaComponentsConfigModel, DocumentationLegacyPageBlockSelectedFigmaComponentModel } from "./SDKDocumentationLegacyPageBlockFigmaComponentsConfig";
|
|
3
|
+
export interface DocumentationLegacyPageBlockFigmaComponentsModel extends DocumentationLegacyPageBlockModel {
|
|
4
|
+
figmaComponentsBlockConfig: DocumentationLegacyPageBlockFigmaComponentsConfigModel;
|
|
5
|
+
selectedFigmaComponents: DocumentationLegacyPageBlockSelectedFigmaComponentModel[];
|
|
6
|
+
}
|
|
7
|
+
export declare class DocumentationLegacyPageBlockFigmaComponents extends DocumentationLegacyPageBlock {
|
|
8
|
+
figmaComponentsBlockConfig: DocumentationLegacyPageBlockFigmaComponentsConfig;
|
|
9
|
+
selectedFigmaComponents: DocumentationLegacyPageBlockSelectedFigmaComponentModel[];
|
|
10
|
+
constructor(model: DocumentationLegacyPageBlockFigmaComponentsModel, children: Array<DocumentationLegacyPageBlock>);
|
|
11
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { FigmaComponentPreviewContainerSize } from "../../enums/SDKFigmaComponentPreviewContainerSize";
|
|
2
|
+
import { ColorTokenRemoteData } from "../../tokens/remote/SDKRemoteTokenData";
|
|
3
|
+
export interface DocumentationLegacyPageBlockSelectedFigmaComponentModel {
|
|
4
|
+
figmaComponentId: string;
|
|
5
|
+
selectedComponentProperties?: string[];
|
|
6
|
+
selectedComponentVariants?: Record<string, string[]>;
|
|
7
|
+
}
|
|
8
|
+
export interface DocumentationLegacyPageBlockFigmaComponentsConfigModel {
|
|
9
|
+
showComponentName?: boolean;
|
|
10
|
+
showComponentDescription?: boolean;
|
|
11
|
+
showPropertyList?: boolean;
|
|
12
|
+
previewContainerSize?: "Centered" | "NaturalHeight";
|
|
13
|
+
previewContainerHeight?: number | null;
|
|
14
|
+
backgroundColor: ColorTokenRemoteData;
|
|
15
|
+
previewOrderIds?: Array<string>;
|
|
16
|
+
}
|
|
17
|
+
export declare class DocumentationLegacyPageBlockSelectedFigmaComponent {
|
|
18
|
+
figmaComponentId: string;
|
|
19
|
+
selectedComponentProperties: string[];
|
|
20
|
+
selectedComponentVariants: Record<string, string[]>;
|
|
21
|
+
constructor(model: DocumentationLegacyPageBlockSelectedFigmaComponentModel);
|
|
22
|
+
}
|
|
23
|
+
export declare class DocumentationLegacyPageBlockFigmaComponentsConfig {
|
|
24
|
+
showComponentName: boolean;
|
|
25
|
+
showComponentDescription: boolean;
|
|
26
|
+
showPropertyList: boolean;
|
|
27
|
+
previewContainerSize: FigmaComponentPreviewContainerSize;
|
|
28
|
+
backgroundColor: ColorTokenRemoteData;
|
|
29
|
+
previewOrderIds: Array<string>;
|
|
30
|
+
previewContainerHeight: number | null;
|
|
31
|
+
constructor(model: DocumentationLegacyPageBlockFigmaComponentsConfigModel);
|
|
32
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { DocumentationLegacyPageBlockModel, DocumentationLegacyPageBlock } from "../SDKDocumentationLegacyPageBlock";
|
|
2
|
+
export interface DocumentationLegacyPageBlockFileModel {
|
|
3
|
+
entityId: string;
|
|
4
|
+
entityMeta?: {
|
|
5
|
+
title?: string;
|
|
6
|
+
description?: string;
|
|
7
|
+
};
|
|
8
|
+
}
|
|
9
|
+
export interface DocumentationLegacyPageBlockFilesModel extends DocumentationLegacyPageBlockModel {
|
|
10
|
+
files?: DocumentationLegacyPageBlockFileModel[];
|
|
11
|
+
}
|
|
12
|
+
export interface DocumentationLegacyPageBlockFile {
|
|
13
|
+
entityId: string;
|
|
14
|
+
entityMeta: {
|
|
15
|
+
title: string | null;
|
|
16
|
+
description: string | null;
|
|
17
|
+
};
|
|
18
|
+
}
|
|
19
|
+
export declare class DocumentationLegacyPageBlockFiles extends DocumentationLegacyPageBlock {
|
|
20
|
+
files: DocumentationLegacyPageBlockFile[];
|
|
21
|
+
constructor(model: DocumentationLegacyPageBlockFilesModel, children: Array<DocumentationLegacyPageBlock>);
|
|
22
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { Alignment } from "../../enums/SDKAlignment";
|
|
2
|
+
import { DocumentationLegacyPageAsset, DocumentationLegacyPageAssetModel } from "../SDKDocumentationLegacyPageAsset";
|
|
3
|
+
import { DocumentationLegacyPageBlockModel, DocumentationLegacyPageBlock } from "../SDKDocumentationLegacyPageBlock";
|
|
4
|
+
interface DocumentationLegacyGuidelinePropsModel {
|
|
5
|
+
asset?: DocumentationLegacyPageAssetModel;
|
|
6
|
+
type?: string;
|
|
7
|
+
imageAlt?: string;
|
|
8
|
+
imageCaption?: string;
|
|
9
|
+
imageAlignment?: Alignment;
|
|
10
|
+
}
|
|
11
|
+
export interface DocumentationLegacyPageBlockGuidelineModel extends DocumentationLegacyPageBlockModel {
|
|
12
|
+
guideline: DocumentationLegacyGuidelinePropsModel;
|
|
13
|
+
}
|
|
14
|
+
export interface DocumentationLegacyGuidelineProps {
|
|
15
|
+
asset: DocumentationLegacyPageAsset | null;
|
|
16
|
+
type: string;
|
|
17
|
+
imageAlt: string | null;
|
|
18
|
+
imageCaption: string | null;
|
|
19
|
+
imageAlignment: Alignment | null;
|
|
20
|
+
}
|
|
21
|
+
export declare class DocumentationLegacyPageBlockGuideline extends DocumentationLegacyPageBlock {
|
|
22
|
+
guideline: DocumentationLegacyGuidelineProps;
|
|
23
|
+
constructor(model: DocumentationLegacyPageBlockGuidelineModel, children: Array<DocumentationLegacyPageBlock>);
|
|
24
|
+
}
|
|
25
|
+
export {};
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { DocumentationLegacyPageBlockModel, DocumentationLegacyPageBlock } from "../SDKDocumentationLegacyPageBlock";
|
|
2
|
+
export interface DocumentationLegacyPageBlockGuidelinesModel extends DocumentationLegacyPageBlockModel {
|
|
3
|
+
}
|
|
4
|
+
export declare class DocumentationLegacyPageBlockGuidelines extends DocumentationLegacyPageBlock {
|
|
5
|
+
constructor(model: DocumentationLegacyPageBlockGuidelinesModel, children: Array<DocumentationLegacyPageBlock>);
|
|
6
|
+
}
|
package/build/sdk-typescript/src/model/documentation/builder/SDKDocumentationLegacyBlockBuilder.d.ts
CHANGED
|
@@ -2,5 +2,5 @@ import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCu
|
|
|
2
2
|
import { DocumentationLegacyConfiguration } from "../SDKDocumentationLegacyConfiguration";
|
|
3
3
|
import { DocumentationLegacyPageBlock, DocumentationLegacyPageBlockModel } from "../SDKDocumentationLegacyPageBlock";
|
|
4
4
|
export declare class DocumentationLegacyBlockBuilder {
|
|
5
|
-
static fromGenericModel(model: DocumentationLegacyPageBlockModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationLegacyConfiguration): DocumentationLegacyPageBlock;
|
|
5
|
+
static fromGenericModel(model: DocumentationLegacyPageBlockModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationLegacyConfiguration): DocumentationLegacyPageBlock | undefined;
|
|
6
6
|
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { DTODesignSystemRole } from "@supernova-studio/client";
|
|
2
2
|
import { UserRole } from "./SDKUserRole";
|
|
3
|
+
import { WorkspaceSeatType } from "./SDKWorkspaceSeatType";
|
|
3
4
|
export type DesignSystemRole = Exclude<UserRole, UserRole.owner | UserRole.billing>;
|
|
4
5
|
export declare const convertRemoteToDesignSystemRole: (remoteRole: DTODesignSystemRole) => DesignSystemRole;
|
|
5
|
-
export declare const
|
|
6
|
+
export declare const resolveDesignSystemRoleFromSeatTypeAndWorkspaceRole: (seatType: WorkspaceSeatType, wsRole: UserRole) => DesignSystemRole;
|
|
@@ -10,5 +10,7 @@ export declare enum DocsBlockBehaviorDataType {
|
|
|
10
10
|
/** Figma frame type allows selection of any frame coming from Figma * */
|
|
11
11
|
figmaNode = "FigmaNode",
|
|
12
12
|
/** Figma Component type allows selection of any component coming from Figma * */
|
|
13
|
-
figmaComponent = "FigmaComponent"
|
|
13
|
+
figmaComponent = "FigmaComponent",
|
|
14
|
+
/** File type allows selection of files * */
|
|
15
|
+
file = "File"
|
|
14
16
|
}
|
|
@@ -55,5 +55,7 @@ export declare enum DocsBlockItemPropertyType {
|
|
|
55
55
|
/** Figma node property (frames, sections, etc.) */
|
|
56
56
|
figmaNode = "FigmaNode",
|
|
57
57
|
/** Figma component property (Figma components, variants, properties, etc.) */
|
|
58
|
-
figmaComponent = "FigmaComponent"
|
|
58
|
+
figmaComponent = "FigmaComponent",
|
|
59
|
+
/** File property allows user to add file to download */
|
|
60
|
+
file = "File"
|
|
59
61
|
}
|