@supernova-studio/supernova-sdk-beta 1.6.25 → 1.6.27
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 +3 -3
- package/build/sdk-typescript/src/core/SDKSupernova.d.ts +19 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +167 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaBulkOperations.d.ts +12 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDataSources.d.ts +14 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDesignSystems.d.ts +37 -2
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +94 -4
- package/build/sdk-typescript/src/core/areas/SDKAreaIntegrations.d.ts +27 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaNetwork.d.ts +9 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaStorage.d.ts +23 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaVersions.d.ts +1 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +69 -1
- package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +3 -1
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +120 -5
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +61 -2
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +99 -5
- package/build/sdk-typescript/src/core/resolvers/SDKTokenResolver.d.ts +2 -1
- package/build/sdk-typescript/src/exports-pulsar.d.ts +228 -0
- package/build/sdk-typescript/src/exports.d.ts +63 -25
- package/build/sdk-typescript/src/index.d.ts +4 -0
- package/build/sdk-typescript/src/model/assets/SDKAsset.d.ts +1 -0
- package/build/sdk-typescript/src/model/base/SDKDesignSystem.d.ts +6 -8
- package/build/sdk-typescript/src/model/components/SDKDesignComponent.d.ts +2 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockLayout.d.ts +13 -5
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockVariant.d.ts +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{h1/SDKDocsBlockActualH1.d.ts → embed/SDKDocsBlockActualEmbed.d.ts} +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed-figma/SDKDocsBlockActualEmbedFigma.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed-lottie/SDKDocsBlockActualEmbedLottie.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/embed-youtube/SDKDocsBlockActualEmbedYoutube.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/markdown/SDKDocsBlockActualMarkdown.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{links/SDKDocsBlockActualLinks.d.ts → shortcut-links/SDKDocsBlockActualShortcutLinks.d.ts} +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/storybook/SDKDocsBlockActualStorybook.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{h2/SDKDocsBlockActualH2.d.ts → table/SDKDocsBlockActualTable.d.ts} +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{h3/SDKDocsBlockActualH3.d.ts → title1/SDKDocsBlockActualTitle1.d.ts} +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{h4/SDKDocsBlockActualH4.d.ts → title2/SDKDocsBlockActualTitle2.d.ts} +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/title3/SDKDocsBlockActualTitle3.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/title4/SDKDocsBlockActualTitle4.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/title5/SDKDocsBlockActualTitle5.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockImageProperty.d.ts +2 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +3 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityGroup.d.ts +2 -2
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityHeader.d.ts +2 -2
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyConfiguration.d.ts +9 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyGroup.d.ts +2 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPage.d.ts +3 -1
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageAsset.d.ts +6 -0
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockFrame.d.ts +4 -1
- package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationLegacyItemConfiguration.d.ts +1 -0
- package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationLegacyItemHeader.d.ts +8 -2
- package/build/sdk-typescript/src/model/enums/SDKBorderPosition.d.ts +1 -0
- package/build/sdk-typescript/src/model/enums/SDKBorderStyle.d.ts +1 -0
- package/build/sdk-typescript/src/model/enums/SDKCloudWarningType.d.ts +14 -0
- package/build/sdk-typescript/src/model/enums/SDKConnectionProviders.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKCustomDomainErrorCode.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKCustomDomainState.d.ts +9 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockCategory.d.ts +15 -9
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockImagePropertyWidth.d.ts +12 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +4 -2
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutAlign.d.ts +8 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutColumnResizing.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutGap.d.ts +10 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockTextPropertyColor.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockTextPropertyStyle.d.ts +20 -4
- package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts +3 -3
- package/build/sdk-typescript/src/model/enums/SDKUserRole.d.ts +1 -0
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionProduct.d.ts +1 -1
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionStatus.d.ts +6 -14
- package/build/sdk-typescript/src/model/exporters/CodegenAccount.d.ts +9 -0
- package/build/sdk-typescript/src/model/exporters/CodegenAzureBranch.d.ts +7 -0
- package/build/sdk-typescript/src/model/exporters/CodegenAzureOrganization.d.ts +7 -0
- package/build/sdk-typescript/src/model/exporters/CodegenAzureProject.d.ts +7 -0
- package/build/sdk-typescript/src/model/exporters/CodegenAzureRepository.d.ts +11 -0
- package/build/sdk-typescript/src/model/exporters/CodegenBitbucketBranch.d.ts +7 -0
- package/build/sdk-typescript/src/model/exporters/CodegenBitbucketProject.d.ts +6 -0
- package/build/sdk-typescript/src/model/exporters/CodegenBitbucketRepository.d.ts +8 -0
- package/build/sdk-typescript/src/model/exporters/CodegenBitbucketWorkspace.d.ts +6 -0
- package/build/sdk-typescript/src/model/exporters/CodegenBranch.d.ts +8 -0
- package/build/sdk-typescript/src/model/exporters/CodegenConnection.d.ts +10 -0
- package/build/sdk-typescript/src/model/exporters/CodegenGitlabBranch.d.ts +7 -0
- package/build/sdk-typescript/src/model/exporters/CodegenGitlabGroup.d.ts +6 -0
- package/build/sdk-typescript/src/model/exporters/CodegenGitlabRepository.d.ts +9 -0
- package/build/sdk-typescript/src/model/exporters/CodegenRepository.d.ts +15 -0
- package/build/sdk-typescript/src/model/exporters/SDKConnections.d.ts +8 -0
- package/build/sdk-typescript/src/model/exporters/SDKExporter.d.ts +16 -12
- package/build/sdk-typescript/src/model/exporters/SDKPipeline.d.ts +113 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuild.d.ts +104 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuildResults.d.ts +72 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportDestinations.d.ts +111 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenBranchModel.d.ts +5 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenOrganizationModel.d.ts +5 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenProjectModel.d.ts +5 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteAzureCodegenRepositoryModel.d.ts +9 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenBranchModel.d.ts +5 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenProjectModel.d.ts +4 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenRepositoryModel.d.ts +6 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteBitbucketCodegenWorkspaceModel.d.ts +4 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenAccountModel.d.ts +7 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenBranchModel.d.ts +6 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenConnectionModel.d.ts +8 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteCodegenRepositoryModel.d.ts +17 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteConnectionsModel.d.ts +9 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenBranchModel.d.ts +5 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenGroupModel.d.ts +4 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteGitlabCodegenRepositoryModel.d.ts +7 -0
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemotePipelineModel.d.ts +57 -0
- package/build/sdk-typescript/src/model/jobs/SDKImportJob.d.ts +2 -7
- package/build/sdk-typescript/src/model/support/SDKCustomDomain.d.ts +21 -0
- package/build/sdk-typescript/src/model/support/SDKFigmaFrame.d.ts +20 -0
- package/build/sdk-typescript/src/model/support/SDKFigmaStructure.d.ts +27 -0
- package/build/sdk-typescript/src/model/support/SDKFigmaStructureDetail.d.ts +30 -0
- package/build/sdk-typescript/src/model/support/SDKLogger.d.ts +4 -0
- package/build/sdk-typescript/src/model/support/SDKSource.d.ts +20 -8
- package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +3 -0
- package/build/sdk-typescript/src/model/tokens/SDKDimensionToken.d.ts +1 -1
- package/build/sdk-typescript/src/model/users/SDKUser.d.ts +6 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspace.d.ts +0 -5
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceInvitation.d.ts +35 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceInvoice.d.ts +38 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProduct.d.ts +21 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProductFeatures.d.ts +3 -1
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProductPrice.d.ts +40 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceSubscription.d.ts +34 -35
- package/build/sdk-typescript/src/pulsar-interfaces.d.ts +40 -0
- package/build/sdk-typescript/src/tests/Areas/AreaStorage.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +7 -3
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONParser.d.ts +3 -1
- package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +25 -4
- package/build/supernova-sdk-typescript.js +2 -70428
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +17 -15
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/h5/SDKDocsBlockActualH5.d.ts +0 -6
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionStatusInternal.d.ts +0 -8
- package/build/sdk-typescript/src/tests/Areas/AreaTokenValues.d.ts +0 -0
|
@@ -1,4 +1,8 @@
|
|
|
1
1
|
import { Source, SourceRemoteModel, SourceTransportModel } from "../support/SDKSource";
|
|
2
|
+
export type DesignSystemSwitcher = {
|
|
3
|
+
isEnabled: boolean;
|
|
4
|
+
designSystemIds: Array<string>;
|
|
5
|
+
};
|
|
2
6
|
export type DesignSystemRemoteModel = {
|
|
3
7
|
id: string;
|
|
4
8
|
meta: {
|
|
@@ -12,10 +16,7 @@ export type DesignSystemRemoteModel = {
|
|
|
12
16
|
docSlug: string;
|
|
13
17
|
docUserSlug?: string;
|
|
14
18
|
docExporterId: string;
|
|
15
|
-
designSystemSwitcher:
|
|
16
|
-
isEnabled: boolean;
|
|
17
|
-
designSystemIds: Array<string>;
|
|
18
|
-
};
|
|
19
|
+
designSystemSwitcher: DesignSystemSwitcher;
|
|
19
20
|
};
|
|
20
21
|
export type DesignSystemTransportModel = Pick<DesignSystem, "id" | "name" | "description" | "isPublic" | "isMultiBrand" | "documentationSlug" | "documentationUserSlug" | "documentationExporterId" | "designSystemSwitcher" | "workspaceId"> & {
|
|
21
22
|
sources: Array<SourceTransportModel>;
|
|
@@ -40,10 +41,7 @@ export declare class DesignSystem {
|
|
|
40
41
|
/** DocumentationLegacy URL slug - user override */
|
|
41
42
|
documentationUserSlug: string | null;
|
|
42
43
|
/** Binding multiple design systems together */
|
|
43
|
-
designSystemSwitcher:
|
|
44
|
-
isEnabled: boolean;
|
|
45
|
-
designSystemIds: Array<string>;
|
|
46
|
-
};
|
|
44
|
+
designSystemSwitcher: DesignSystemSwitcher;
|
|
47
45
|
/** Data sources linked with this design system */
|
|
48
46
|
sources: Array<Source>;
|
|
49
47
|
constructor(model: DesignSystemRemoteModel);
|
|
@@ -6,6 +6,7 @@ export type DesignComponentRemoteModel = {
|
|
|
6
6
|
designSystemVersionId: string;
|
|
7
7
|
brandId: string;
|
|
8
8
|
thumbnailUrl?: string;
|
|
9
|
+
svgUrl?: string;
|
|
9
10
|
exportProperties: {
|
|
10
11
|
isAsset: boolean;
|
|
11
12
|
};
|
|
@@ -23,6 +24,7 @@ export declare class DesignComponent {
|
|
|
23
24
|
id: string;
|
|
24
25
|
brandId: string;
|
|
25
26
|
thumbnailUrl: string | null;
|
|
27
|
+
svgUrl: string | null;
|
|
26
28
|
name: string;
|
|
27
29
|
description: string;
|
|
28
30
|
origin: DesignComponentOrigin | null;
|
|
@@ -1,16 +1,24 @@
|
|
|
1
|
+
import { DocsBlockItemVariantLayoutAlign } from "../../../enums/SDKDocsBlockItemVariantLayoutAlign";
|
|
2
|
+
import { DocsBlockItemVariantLayoutColumnResizing } from "../../../enums/SDKDocsBlockItemVariantLayoutColumnResizing";
|
|
3
|
+
import { DocsBlockItemVariantLayoutGap } from "../../../enums/SDKDocsBlockItemVariantLayoutGap";
|
|
1
4
|
import { DocsBlockItemVariantLayoutType } from "../../../enums/SDKDocsBlockItemVariantLayoutType";
|
|
2
|
-
import { DocsBlockItemVariantLayoutWidth } from "../../../enums/SDKDocsBlockItemVariantLayoutWidth";
|
|
3
5
|
export type DocsBlockLayoutModel = {
|
|
4
6
|
type: DocsBlockItemVariantLayoutType;
|
|
5
7
|
children: Array<DocsBlockLayoutModel | string>;
|
|
6
|
-
|
|
8
|
+
gap?: DocsBlockItemVariantLayoutGap;
|
|
9
|
+
columnAlign?: DocsBlockItemVariantLayoutAlign;
|
|
10
|
+
columnResizing?: DocsBlockItemVariantLayoutColumnResizing;
|
|
7
11
|
};
|
|
8
12
|
export declare class DocsBlockLayout {
|
|
9
|
-
/** Type of a single node of the layout, either column for stacking
|
|
13
|
+
/** Type of a single node of the layout, either column for stacking vertically, or row for stacking horizontally */
|
|
10
14
|
type: DocsBlockItemVariantLayoutType;
|
|
11
15
|
/** Children of the layout for building nesting layouts or for declaring what all properties should show in a single node, or combination of both */
|
|
12
16
|
children: Array<DocsBlockLayout | string>;
|
|
13
|
-
/**
|
|
14
|
-
|
|
17
|
+
/** Gap between children in the column/row */
|
|
18
|
+
gap?: DocsBlockItemVariantLayoutGap;
|
|
19
|
+
/** Alignment of the column (rows ignore this property) */
|
|
20
|
+
columnAlign?: DocsBlockItemVariantLayoutAlign;
|
|
21
|
+
/** Resizing of the column (rows ignore this property) */
|
|
22
|
+
columnResizing?: DocsBlockItemVariantLayoutColumnResizing;
|
|
15
23
|
constructor(model: DocsBlockLayoutModel);
|
|
16
24
|
}
|
|
@@ -19,7 +19,7 @@ export declare class DocsBlockVariant {
|
|
|
19
19
|
/** Variant name that will show in the interface */
|
|
20
20
|
name: string;
|
|
21
21
|
/** Variant image filename */
|
|
22
|
-
image: string;
|
|
22
|
+
image: string | null;
|
|
23
23
|
/** Variant description that will show in the interface */
|
|
24
24
|
description: string | null;
|
|
25
25
|
/** Link to documentation or resource explaining the behavior of the block and its options */
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts
CHANGED
|
@@ -1,7 +1,13 @@
|
|
|
1
1
|
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
2
2
|
export type DocsBlockEmbedUrlPropertyOptions = {
|
|
3
|
+
/** Defines what should be the default height of the embed */
|
|
4
|
+
defaultHeight: number;
|
|
3
5
|
/** If enabled, additional text can be provided for the embed property */
|
|
4
6
|
allowCaption?: boolean;
|
|
7
|
+
/** If enabled, the embed can be resized */
|
|
8
|
+
allowResize?: boolean;
|
|
9
|
+
/** Defined how to validate the embed URL */
|
|
10
|
+
urlValidationRegex?: string;
|
|
5
11
|
};
|
|
6
12
|
export type DocsBlockEmbedUrlPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockEmbedUrlPropertyOptions;
|
|
7
13
|
/** EmbedUrl property */
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockImageProperty.d.ts
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { DocsBlockImagePropertyAspectRatio } from "../../../enums/SDKDocsBlockImagePropertyAspectRatio";
|
|
2
|
+
import { DocsBlockImagePropertyWidth } from "../../../enums/SDKDocsBlockImagePropertyWidth";
|
|
2
3
|
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
4
|
export type DocsBlockImagePropertyOptions = {
|
|
5
|
+
width?: DocsBlockImagePropertyWidth;
|
|
4
6
|
aspectRatio?: DocsBlockImagePropertyAspectRatio;
|
|
5
7
|
allowCaption?: boolean;
|
|
6
8
|
recommendation?: string;
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
2
|
+
export type DocsBlockStorybookPropertyOptions = Record<string, never>;
|
|
3
|
+
export type DocsBlockEmbedUrlPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockStorybookPropertyOptions;
|
|
4
|
+
/** EmbedUrl property */
|
|
5
|
+
export declare class DocsBlockStorybookPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockStorybookPropertyOptions> {
|
|
6
|
+
}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { DocsBlockTextPropertyColor } from "../../../enums/SDKDocsBlockTextPropertyColor";
|
|
1
2
|
import { DocsBlockTextPropertyStyle } from "../../../enums/SDKDocsBlockTextPropertyStyle";
|
|
2
3
|
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
4
|
export type DocsBlockTextPropertyOptions = {
|
|
@@ -7,6 +8,8 @@ export type DocsBlockTextPropertyOptions = {
|
|
|
7
8
|
defaultValue?: string;
|
|
8
9
|
/** Visual style of the text property */
|
|
9
10
|
style: DocsBlockTextPropertyStyle;
|
|
11
|
+
/** Text color */
|
|
12
|
+
color?: DocsBlockTextPropertyColor;
|
|
10
13
|
};
|
|
11
14
|
export type DocsBlockTextPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
|
|
12
15
|
options: DocsBlockTextPropertyOptions;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { DocsEntityGroupBehavior } from "../../enums/SDKDocsEntityGroupBehavior";
|
|
2
2
|
import { DocsEntity, DocsEntityModel } from "./SDKDocsEntity";
|
|
3
|
-
export type
|
|
3
|
+
export type DocumentationEntityGroupModel = {
|
|
4
4
|
isRoot: boolean;
|
|
5
5
|
childrenIds: Array<string>;
|
|
6
6
|
parentId: string | null;
|
|
@@ -19,7 +19,7 @@ export declare class DocsEntityGroup extends DocsEntity {
|
|
|
19
19
|
relativeFirstPageUrl: string | null;
|
|
20
20
|
/** Internal */
|
|
21
21
|
deployedFirstPageUrl: string | null;
|
|
22
|
-
constructor(model:
|
|
22
|
+
constructor(model: DocumentationEntityGroupModel);
|
|
23
23
|
/** Internal: Modifies object with new paths. Don't use outside SDK environment as it doesn't propagate the data back to source */
|
|
24
24
|
internalOverridePaths(relative: string | null, deployed: string | null): void;
|
|
25
25
|
/** Retrieve relative page path without the associated domain for the first page in the group. Will work even when documentation was not yet deployed */
|
|
@@ -9,7 +9,7 @@ export type DocsEntityHeaderModel = {
|
|
|
9
9
|
backgroundImageScaleType: AssetScaleType;
|
|
10
10
|
showBackgroundOverlay: boolean;
|
|
11
11
|
showCoverText: boolean;
|
|
12
|
-
minHeight: number;
|
|
12
|
+
minHeight: number | null;
|
|
13
13
|
};
|
|
14
14
|
export declare class DocsEntityHeader {
|
|
15
15
|
description: string;
|
|
@@ -18,6 +18,6 @@ export declare class DocsEntityHeader {
|
|
|
18
18
|
backgroundColor: DocsColorRef | null;
|
|
19
19
|
showBackgroundOverlay: boolean;
|
|
20
20
|
showCoverText: boolean;
|
|
21
|
-
minHeight: number;
|
|
21
|
+
minHeight: number | null;
|
|
22
22
|
constructor(model: DocsEntityHeaderModel);
|
|
23
23
|
}
|
package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyConfiguration.d.ts
CHANGED
|
@@ -3,11 +3,20 @@ export type DocumentationLegacyConfigurationModel = {
|
|
|
3
3
|
tabbed: boolean;
|
|
4
4
|
storybookEmbedErrorMessage?: string;
|
|
5
5
|
renderCodePackageJson?: string;
|
|
6
|
+
isPublic: boolean;
|
|
7
|
+
serveDefaultVersionOnly: boolean;
|
|
8
|
+
selectedBrandId: string;
|
|
9
|
+
host: string;
|
|
6
10
|
};
|
|
7
11
|
export declare class DocumentationLegacyConfiguration {
|
|
8
12
|
tabbedNavigation: boolean;
|
|
13
|
+
isPublic: boolean;
|
|
14
|
+
serveDefaultVersionOnly: boolean;
|
|
15
|
+
selectedBrandId: string;
|
|
16
|
+
host: string;
|
|
9
17
|
storybookError: string | null;
|
|
10
18
|
packageJson: string | null;
|
|
11
19
|
npmRegistry: WorkspaceNPMRegistrySettings | null;
|
|
12
20
|
constructor(model: DocumentationLegacyConfigurationModel, registry: WorkspaceNPMRegistrySettings | null);
|
|
21
|
+
toConfigurationModelWriteObject(): DocumentationLegacyConfigurationModel;
|
|
13
22
|
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { DocumentationLegacyGroupBehavior } from "../enums/SDKDocumentationLegacyGroupBehavior";
|
|
2
|
+
import { DocumentationLegacyItemType } from "../enums/SDKDocumentationLegacyItemType";
|
|
2
3
|
import { DocumentationLegacyItem, DocumentationLegacyItemModel } from "./SDKDocumentationLegacyItem";
|
|
3
4
|
import { DocumentationLegacyPage } from "./SDKDocumentationLegacyPage";
|
|
4
5
|
export type DocumentationLegacyGroupModel = {
|
|
@@ -13,6 +14,7 @@ export declare class DocumentationLegacyGroup extends DocumentationLegacyItem {
|
|
|
13
14
|
childrenIds: Array<string>;
|
|
14
15
|
/** Items belonging to the documentation group. Can be page or group */
|
|
15
16
|
children: Array<DocumentationLegacyItem>;
|
|
17
|
+
type: DocumentationLegacyItemType.group;
|
|
16
18
|
/** Parent group reference */
|
|
17
19
|
parent: DocumentationLegacyGroup | null;
|
|
18
20
|
/** Signifies how the group should behave. If set to "tabs", group behaves as "page", but contains multiple tabbed pages inside it. "Group" signifies virtual group used for content structuring */
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { DocumentationLegacyItemType } from "../enums/SDKDocumentationLegacyItemType";
|
|
1
2
|
import { ExporterCustomBlock } from "../exporters/custom_blocks/SDKExporterCustomBlock";
|
|
2
3
|
import { DocumentationLegacyConfiguration } from "./SDKDocumentationLegacyConfiguration";
|
|
3
4
|
import { DocumentationLegacyGroup } from "./SDKDocumentationLegacyGroup";
|
|
@@ -16,9 +17,10 @@ export declare class DocumentationLegacyPage extends DocumentationLegacyItem {
|
|
|
16
17
|
deployedUrl: string | null;
|
|
17
18
|
/** Internal */
|
|
18
19
|
relativeUrl: string;
|
|
20
|
+
type: DocumentationLegacyItemType.page;
|
|
19
21
|
/** Internal */
|
|
20
22
|
editorUrl: string | null;
|
|
21
|
-
constructor(model: DocumentationLegacyPageModel, customBlocks
|
|
23
|
+
constructor(model: DocumentationLegacyPageModel, customBlocks?: Array<ExporterCustomBlock>, configuration?: DocumentationLegacyConfiguration);
|
|
22
24
|
/** Internal: Modifies object with new paths. Don't use outside SDK environment as it doesn't propagate the data back to source */
|
|
23
25
|
internalOverridePaths(deployed: string | null, editor: string | null): void;
|
|
24
26
|
/** Internal: Sets new parent. Used when manipulating with object internally. Don't use outside SDK environment */
|
|
@@ -2,12 +2,18 @@ import { DocumentationLegacyPageAssetType } from "../enums/SDKDocumentationLegac
|
|
|
2
2
|
import { DocumentationLegacyPageBlockFrame, DocumentationLegacyPageBlockFrameModel } from "./blocks/SDKDocumentationLegacyPageBlockFrame";
|
|
3
3
|
export type DocumentationLegacyPageAssetModel = {
|
|
4
4
|
id: string;
|
|
5
|
+
persistentId?: string;
|
|
6
|
+
sourceId?: string;
|
|
7
|
+
sourceFrameId?: string;
|
|
5
8
|
url?: string;
|
|
6
9
|
type: DocumentationLegacyPageAssetType;
|
|
7
10
|
figmaFrame?: DocumentationLegacyPageBlockFrameModel;
|
|
8
11
|
};
|
|
9
12
|
export declare class DocumentationLegacyPageAsset {
|
|
10
13
|
id: string;
|
|
14
|
+
persistentId: string | null;
|
|
15
|
+
sourceId: string | null;
|
|
16
|
+
sourceFrameId: string | null;
|
|
11
17
|
url: string | null;
|
|
12
18
|
type: DocumentationLegacyPageAssetType;
|
|
13
19
|
frame: DocumentationLegacyPageBlockFrame | null;
|
|
@@ -1,17 +1,20 @@
|
|
|
1
1
|
import { FrameOrigin, FrameOriginModel } from "../../support/SDKFrameOrigin";
|
|
2
2
|
import { ColorTokenRemoteData } from "../../tokens/remote/SDKRemoteTokenData";
|
|
3
3
|
export type DocumentationLegacyPageBlockFrameModel = {
|
|
4
|
+
id: string;
|
|
4
5
|
sourceId: string;
|
|
5
6
|
sourceFrameId: string;
|
|
6
7
|
title?: string;
|
|
7
8
|
description?: string;
|
|
9
|
+
persistentId?: string;
|
|
8
10
|
backgroundColor?: ColorTokenRemoteData;
|
|
9
|
-
origin
|
|
11
|
+
origin?: FrameOriginModel;
|
|
10
12
|
};
|
|
11
13
|
export declare class DocumentationLegacyPageBlockFrame {
|
|
12
14
|
title: string | null;
|
|
13
15
|
description: string | null;
|
|
14
16
|
previewUrl: string;
|
|
17
|
+
persistentId: string | null;
|
|
15
18
|
backgroundColor: ColorTokenRemoteData | null;
|
|
16
19
|
origin: FrameOrigin | null;
|
|
17
20
|
constructor(model: DocumentationLegacyPageBlockFrameModel, blockBackgroundColor: ColorTokenRemoteData | null);
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { Alignment } from "../../enums/SDKAlignment";
|
|
2
2
|
import { AssetScaleType } from "../../enums/SDKAssetScaleType";
|
|
3
|
+
import { DocumentationLegacyPageAssetType } from "../../enums/SDKDocumentationLegacyPageAssetType";
|
|
3
4
|
import { ColorTokenRemoteData } from "../../tokens/remote/SDKRemoteTokenData";
|
|
4
5
|
import { DocumentationLegacyPageAssetModel } from "../SDKDocumentationLegacyPageAsset";
|
|
5
6
|
export type DocumentationLegacyItemHeaderModel = {
|
|
@@ -13,11 +14,15 @@ export type DocumentationLegacyItemHeaderModel = {
|
|
|
13
14
|
backgroundImageScaleType: AssetScaleType;
|
|
14
15
|
showBackgroundOverlay: boolean;
|
|
15
16
|
showCoverText: boolean;
|
|
16
|
-
minHeight: number;
|
|
17
|
+
minHeight: number | null;
|
|
17
18
|
};
|
|
18
19
|
export declare class DocumentationLegacyItemHeader {
|
|
19
20
|
backgroundImageAssetUrl: string | null;
|
|
20
21
|
backgroundImageAssetId: string | null;
|
|
22
|
+
backgroundImageAssetType: DocumentationLegacyPageAssetType | null;
|
|
23
|
+
backgroundImageSourceId: string | null;
|
|
24
|
+
backgroundImagePersistentId: string | null;
|
|
25
|
+
backgroundImageSourceFrameId: string | null;
|
|
21
26
|
backgroundImageScaleType: AssetScaleType;
|
|
22
27
|
description: string;
|
|
23
28
|
alignment: Alignment;
|
|
@@ -25,6 +30,7 @@ export declare class DocumentationLegacyItemHeader {
|
|
|
25
30
|
backgroundColor: ColorTokenRemoteData | null;
|
|
26
31
|
showBackgroundOverlay: boolean;
|
|
27
32
|
showCoverText: boolean;
|
|
28
|
-
minHeight: number;
|
|
33
|
+
minHeight: number | null;
|
|
29
34
|
constructor(model: DocumentationLegacyItemHeaderModel);
|
|
35
|
+
toWriteModel(): DocumentationLegacyItemHeaderModel;
|
|
30
36
|
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export declare enum ImportWarningType {
|
|
2
|
+
UnsupportedFill = "UnsupportedFill",
|
|
3
|
+
UnsupportedStroke = "UnsupportedStroke",
|
|
4
|
+
UnsupportedEffect = "UnsupportedEffect",
|
|
5
|
+
StyleNotApplied = "StyleNotApplied",
|
|
6
|
+
NoPublishedStyles = "NoPublishedStyles",
|
|
7
|
+
NoPublishedComponents = "NoPublishedComponents",
|
|
8
|
+
NoPublishedAssets = "NoPublishedAssets",
|
|
9
|
+
NoVersionFound = "NoVersionFound",
|
|
10
|
+
ComponentHasNoThumbnail = "ComponentHasNoThumbnail",
|
|
11
|
+
DuplicateImportedStyleId = "DuplicateImportedStyleId",
|
|
12
|
+
DuplicateImportedStylePath = "DuplicateImportedStylePath",
|
|
13
|
+
NoPublishedElements = "NoPublishedElements"
|
|
14
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export declare enum CustomDomainState {
|
|
2
|
+
initial = "Initial",
|
|
3
|
+
domainSetupInProgress = "DomainSetupInProgress",
|
|
4
|
+
domainSetupFailed = "DomainSetupFailed",
|
|
5
|
+
domainSetupsSucces = "DomainSetupSuccess",
|
|
6
|
+
sslSetupInProgress = "SSLSetupInProgress",
|
|
7
|
+
sslSetupFailed = "SSLSetupFailed",
|
|
8
|
+
sslSetupSuccess = "SSLSetupSuccess"
|
|
9
|
+
}
|
|
@@ -1,20 +1,26 @@
|
|
|
1
1
|
export declare enum DocsBlockCategory {
|
|
2
2
|
/** Shows as a "Text Blocks" */
|
|
3
3
|
text = "Text",
|
|
4
|
-
/**
|
|
4
|
+
/** Show as "Layout blocks" */
|
|
5
|
+
layout = "Layout",
|
|
6
|
+
/** Show as "Media blocks" */
|
|
5
7
|
media = "Media",
|
|
6
|
-
/**
|
|
8
|
+
/** Show as "Embed blocks" */
|
|
9
|
+
embed = "Embed",
|
|
10
|
+
/** Show as "Figma blocks" */
|
|
7
11
|
figma = "Figma",
|
|
8
|
-
/**
|
|
12
|
+
/** Show as "Code blocks" */
|
|
9
13
|
code = "Code",
|
|
10
|
-
/**
|
|
14
|
+
/** Show as "Guidelines blocks" */
|
|
15
|
+
guidelines = "Guidelines",
|
|
16
|
+
/** Show as "Token blocks" */
|
|
11
17
|
token = "Tokens",
|
|
12
|
-
/**
|
|
18
|
+
/** Show as "Component blocks" */
|
|
13
19
|
component = "Components",
|
|
14
|
-
/** Shows as
|
|
20
|
+
/** Shows as "Asset blocks" */
|
|
15
21
|
asset = "Assets",
|
|
16
|
-
/**
|
|
22
|
+
/** Show as "Data blocks" */
|
|
17
23
|
data = "Data",
|
|
18
|
-
/** Shows as
|
|
19
|
-
|
|
24
|
+
/** Shows as "Other blocks" */
|
|
25
|
+
other = "Other"
|
|
20
26
|
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export declare enum DocsBlockImagePropertyWidth {
|
|
2
|
+
/** width: 48px */
|
|
3
|
+
icon = "Icon",
|
|
4
|
+
/** width: 120px */
|
|
5
|
+
small = "Small",
|
|
6
|
+
/** width: 180px */
|
|
7
|
+
medium = "Medium",
|
|
8
|
+
/** width: 360px */
|
|
9
|
+
large = "Large",
|
|
10
|
+
/** width: 480px */
|
|
11
|
+
poster = "Poster"
|
|
12
|
+
}
|
|
@@ -9,7 +9,7 @@ export declare enum DocsBlockItemPropertyType {
|
|
|
9
9
|
number = "Number",
|
|
10
10
|
/** Single-select property allows user to select one of the options */
|
|
11
11
|
singleSelect = "SingleSelect",
|
|
12
|
-
/**
|
|
12
|
+
/** Multi-select property allows user to select multiple of the options */
|
|
13
13
|
multiSelect = "MultiSelect",
|
|
14
14
|
/** Image property allows user to select or upload image */
|
|
15
15
|
image = "Image",
|
|
@@ -44,5 +44,7 @@ export declare enum DocsBlockItemPropertyType {
|
|
|
44
44
|
/** Table property allows user to add table to render */
|
|
45
45
|
table = "Table",
|
|
46
46
|
/** Divider property that puts visual divider into the block. It has no user input */
|
|
47
|
-
divider = "Divider"
|
|
47
|
+
divider = "Divider",
|
|
48
|
+
/** Storybook property allows user to add Storybook story to render */
|
|
49
|
+
storybook = "Storybook"
|
|
48
50
|
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export declare enum DocsBlockItemVariantLayoutGap {
|
|
2
|
+
/** small gap between columns/row */
|
|
3
|
+
small = "small",
|
|
4
|
+
/** medium gap between columns/row */
|
|
5
|
+
medium = "medium",
|
|
6
|
+
/** large gap between columns/row */
|
|
7
|
+
large = "large",
|
|
8
|
+
/** no gap between columns/row */
|
|
9
|
+
none = "none"
|
|
10
|
+
}
|
|
@@ -1,8 +1,24 @@
|
|
|
1
1
|
export declare enum DocsBlockTextPropertyStyle {
|
|
2
|
+
/** Title type 1, roughly equivalent of h2 in size */
|
|
3
|
+
title1 = "Title1",
|
|
4
|
+
/** Title type 2, roughly equivalent of h3 in size */
|
|
5
|
+
title2 = "Title2",
|
|
6
|
+
/** Title type 3, roughly equivalent of h4 in size */
|
|
7
|
+
title3 = "Title3",
|
|
8
|
+
/** Title type 4, roughly equivalent of h5 in size */
|
|
9
|
+
title4 = "Title4",
|
|
10
|
+
/** Title type 5, roughly equivalent of h6 in size */
|
|
11
|
+
title5 = "Title5",
|
|
12
|
+
/** Default text, equals regular */
|
|
13
|
+
default = "Default",
|
|
14
|
+
/** Bold text */
|
|
15
|
+
defaultBold = "DefaultBold",
|
|
16
|
+
/** Semibold text */
|
|
17
|
+
defaultSemibold = "DefaultSemibold",
|
|
2
18
|
/** Small text */
|
|
3
19
|
small = "Small",
|
|
4
|
-
/**
|
|
5
|
-
|
|
6
|
-
/**
|
|
7
|
-
|
|
20
|
+
/** Small bold text */
|
|
21
|
+
smallBold = "SmallBold",
|
|
22
|
+
/** Small semibold text */
|
|
23
|
+
smallSemibold = "SmallSemibold"
|
|
8
24
|
}
|
|
@@ -31,9 +31,9 @@ export declare const OPTION_TOKEN_TYPES: readonly [TokenType.textCase, TokenType
|
|
|
31
31
|
export type OptionTokenType = (typeof OPTION_TOKEN_TYPES)[number];
|
|
32
32
|
export declare const DIMENSION_TOKEN_TYPES: readonly [TokenType.dimension, TokenType.size, TokenType.space, TokenType.opacity, TokenType.fontSize, TokenType.lineHeight, TokenType.letterSpacing, TokenType.paragraphSpacing, TokenType.borderWidth, TokenType.radius, TokenType.duration, TokenType.zIndex];
|
|
33
33
|
export type DimensionTokenType = (typeof DIMENSION_TOKEN_TYPES)[number];
|
|
34
|
-
export declare const RAW_DIMENSION_TOKEN_TYPES: TokenType
|
|
35
|
-
export declare const MS_DIMENSION_TOKEN_TYPES: TokenType
|
|
36
|
-
export declare const ALL_TOKEN_TYPES: TokenType
|
|
34
|
+
export declare const RAW_DIMENSION_TOKEN_TYPES: readonly [TokenType.opacity, TokenType.zIndex];
|
|
35
|
+
export declare const MS_DIMENSION_TOKEN_TYPES: readonly [TokenType.duration];
|
|
36
|
+
export declare const ALL_TOKEN_TYPES: readonly [TokenType.dimension, TokenType.size, TokenType.space, TokenType.opacity, TokenType.fontSize, TokenType.lineHeight, TokenType.letterSpacing, TokenType.paragraphSpacing, TokenType.borderWidth, TokenType.radius, TokenType.duration, TokenType.zIndex, TokenType.string, TokenType.productCopy, TokenType.fontFamily, TokenType.fontWeight, TokenType.textCase, TokenType.textDecoration, TokenType.visibility, TokenType.color, TokenType.gradient, TokenType.border, TokenType.radius, TokenType.shadow, TokenType.typography, TokenType.blur];
|
|
37
37
|
export declare const PURE_TOKEN_TYPES: readonly [TokenType.dimension, TokenType.size, TokenType.space, TokenType.opacity, TokenType.fontSize, TokenType.lineHeight, TokenType.letterSpacing, TokenType.paragraphSpacing, TokenType.borderWidth, TokenType.radius, TokenType.duration, TokenType.zIndex, TokenType.string, TokenType.productCopy, TokenType.fontFamily, TokenType.fontWeight, TokenType.textCase, TokenType.textDecoration, TokenType.visibility];
|
|
38
38
|
export type PureTokenType = (typeof PURE_TOKEN_TYPES)[number];
|
|
39
39
|
export type NonPureTokenType = Exclude<TokenType, PureTokenType>;
|