@supernova-studio/supernova-sdk-beta 2.0.18 → 2.0.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/sdk-typescript/src/core/areas/SDKAreaAssets.d.ts +2 -5
- package/build/sdk-typescript/src/core/areas/SDKAreaDesignSystems.d.ts +36 -4
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +14 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaTokens.d.ts +1 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +2 -2
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +24 -8
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +11 -7
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +17 -7
- package/build/sdk-typescript/src/core/resolvers/SDKDocsEntityMultiplayerItemResolver.d.ts +1 -1
- package/build/sdk-typescript/src/exports-pulsar.d.ts +2 -0
- package/build/sdk-typescript/src/exports.d.ts +6 -1
- package/build/sdk-typescript/src/model/base/SDKDesignSystem.d.ts +8 -17
- package/build/sdk-typescript/src/model/base/SDKDesignSystemMemberList.d.ts +9 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockBehavior.d.ts +2 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockDefinition.d.ts +2 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/do-dont-guidelines/SDKDocsBlockActualDoDontGuidelines.d.ts +8 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts +2 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextEditorProperty.d.ts +19 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts +9 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +2 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +13 -6
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntity.d.ts +10 -1
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityApprovalState.d.ts +14 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityDraftState.d.ts +0 -2
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityGroup.d.ts +5 -2
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityHeader.d.ts +3 -3
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityPage.d.ts +5 -2
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyItem.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +3 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockOptionColor.d.ts +14 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockOptionRenderStyle.d.ts +1 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockRichTextEditorPropertyStyle.d.ts +16 -0
- package/build/sdk-typescript/src/model/enums/SDKIconSet.d.ts +5 -0
- package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts +1 -1
- package/build/sdk-typescript/src/model/enums/SDKUserRole.d.ts +1 -0
- package/build/sdk-typescript/src/model/exporters/SDKExporter.d.ts +8 -0
- package/build/sdk-typescript/src/model/exporters/SDKPipeline.d.ts +2 -2
- package/build/sdk-typescript/src/model/support/SDKSource.d.ts +3 -1
- package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +4 -0
- package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenModel.d.ts +2 -0
- package/build/sdk-typescript/src/model/users/SDKUserProfile.d.ts +4 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceSSOSettings.d.ts +2 -0
- package/build/sdk-typescript/src/pulsar-interfaces.d.ts +5 -0
- package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +21 -4
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewTypes.d.ts +4 -0
- package/build/sdk-typescript/src/utils/TokenUtils.d.ts +1 -1
- package/build/sdk-typescript/src/utils/tokenDefaultValues.d.ts +31 -0
- package/build/supernova-sdk-typescript.js +1 -1
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +3 -3
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts
CHANGED
|
@@ -3,10 +3,6 @@ import { TokenType } from "../../../enums/SDKTokenType";
|
|
|
3
3
|
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
4
|
/** Token property - Additional non-value options */
|
|
5
5
|
export type DocsBlockTokenPropertyOptions = {
|
|
6
|
-
/** Default theme to be chosen */
|
|
7
|
-
defaultTheme?: "none";
|
|
8
|
-
/** Default value preview */
|
|
9
|
-
defaultValuePreview?: "Split" | "Override";
|
|
10
6
|
/** Token types that are allowed to be selected. All types allowed if nothing is provided */
|
|
11
7
|
allowedTypes?: Array<TokenType>;
|
|
12
8
|
/** How should the tokens be rendered in editor */
|
|
@@ -26,9 +22,20 @@ export type DocsBlockTokenPropertyData = DocsBlockPropertyData<Array<{
|
|
|
26
22
|
}>> & {
|
|
27
23
|
/** Selected token ids */
|
|
28
24
|
selectedPropertyIds?: Array<string>;
|
|
29
|
-
/**
|
|
25
|
+
/** Swatches with selected theme ids */
|
|
26
|
+
swatches?: Array<{
|
|
27
|
+
id: string;
|
|
28
|
+
selectedThemeIds: Array<string>;
|
|
29
|
+
}>;
|
|
30
|
+
/**
|
|
31
|
+
* Selected theme ids
|
|
32
|
+
* @deprecated Swatches will be used instead
|
|
33
|
+
*/
|
|
30
34
|
selectedThemeIds?: Array<string>;
|
|
31
|
-
/**
|
|
35
|
+
/**
|
|
36
|
+
* Display mode of themes associated with the token property
|
|
37
|
+
* @deprecated Swatches will be used instead
|
|
38
|
+
*/
|
|
32
39
|
themeDisplayMode?: "Split" | "Override";
|
|
33
40
|
};
|
|
34
41
|
/** Token property - Definition model */
|
|
@@ -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
|
+
}
|
|
@@ -46,4 +46,4 @@ export type ReferencableTokenType = (typeof REFERENCABLE_TOKEN_TYPES)[number];
|
|
|
46
46
|
export declare const tokenTypeIsReferencable: (tokenType: TokenType) => tokenType is TokenType.color | TokenType.radius | TokenType.borderWidth | TokenType.duration | TokenType.fontSize | TokenType.dimension | TokenType.letterSpacing | TokenType.lineHeight | TokenType.opacity | TokenType.paragraphSpacing | TokenType.size | TokenType.space | TokenType.zIndex | TokenType.textDecoration | TokenType.textCase | TokenType.fontFamily | TokenType.fontWeight;
|
|
47
47
|
export declare const DT_TOKEN_TYPES: readonly [TokenType.color, TokenType.shadow, TokenType.gradient, TokenType.typography, TokenType.border, 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.fontFamily, TokenType.fontWeight, TokenType.textCase, TokenType.textDecoration, TokenType.visibility];
|
|
48
48
|
export type DTTokenType = (typeof DT_TOKEN_TYPES)[number];
|
|
49
|
-
export type DTOriginalTokenType = "color" | "borderRadius" | "boxShadow" | "gradient" | "typography" | "border" | "borderWidth" | "sizing" | "opacity" | "spacing" | "fontSizes" | "paragraphSpacing" | "letterSpacing" | "lineHeights" | "other" | "dimension" | "fontFamilies" | "fontWeights" | "textCase" | "textDecoration";
|
|
49
|
+
export type DTOriginalTokenType = "color" | "borderRadius" | "boxShadow" | "gradient" | "typography" | "border" | "borderWidth" | "sizing" | "opacity" | "spacing" | "fontSizes" | "paragraphSpacing" | "letterSpacing" | "lineHeights" | "other" | "dimension" | "fontFamilies" | "fontWeights" | "textCase" | "textDecoration" | "duration";
|
|
@@ -7,6 +7,7 @@ export type ExporterModel = {
|
|
|
7
7
|
packageId: string;
|
|
8
8
|
isPrivate: boolean;
|
|
9
9
|
isDefaultDocumentationExporter: boolean;
|
|
10
|
+
isOwner?: boolean;
|
|
10
11
|
usesBrands: boolean;
|
|
11
12
|
usesThemes?: boolean;
|
|
12
13
|
name: string;
|
|
@@ -31,6 +32,11 @@ export type NewExporterPayload = {
|
|
|
31
32
|
url?: string;
|
|
32
33
|
provider?: ExporterProvider;
|
|
33
34
|
};
|
|
35
|
+
export type ExporterMembershipModel = {
|
|
36
|
+
exporterId: string;
|
|
37
|
+
workspaceId: string;
|
|
38
|
+
role: "Owner" | "User";
|
|
39
|
+
};
|
|
34
40
|
export declare class Exporter {
|
|
35
41
|
/** Unique exporter installation id. This id is used to referenced exporter within Supernova system (for example, in ds.documentationExporterId) */
|
|
36
42
|
id: string;
|
|
@@ -70,6 +76,8 @@ export declare class Exporter {
|
|
|
70
76
|
gitBranch: string | null;
|
|
71
77
|
/** Root directory in the repository containing the exporter package. If not provided, exporter is located at the root directory */
|
|
72
78
|
gitDirectory: string | null;
|
|
79
|
+
/** If the workspace is owner of an exporter */
|
|
80
|
+
isOwner?: boolean;
|
|
73
81
|
/** Contribution of this exporter to the Supernova system */
|
|
74
82
|
contributes: {
|
|
75
83
|
/** DocumentationLegacy block variants */
|
|
@@ -35,7 +35,7 @@ export type GitObjectQuery = {
|
|
|
35
35
|
export type NewPipelinePayloadDestination = "Github" | "Gitlab" | "Bitbucket" | "Azure" | "WebhookUrl" | "S3" | "Documentation";
|
|
36
36
|
export type NewPipelinePayload = {
|
|
37
37
|
brandPersistentId?: string;
|
|
38
|
-
|
|
38
|
+
themePersistentIds?: string[];
|
|
39
39
|
designSystemId: string;
|
|
40
40
|
destinations: {
|
|
41
41
|
azure: AzureDestinationPayload | null;
|
|
@@ -97,7 +97,7 @@ export declare class Pipeline {
|
|
|
97
97
|
};
|
|
98
98
|
};
|
|
99
99
|
brandPersistentId?: string;
|
|
100
|
-
|
|
100
|
+
themePersistentIds?: string[];
|
|
101
101
|
latestJobs: Array<ExportBuild>;
|
|
102
102
|
constructor(data: DTOPipeline);
|
|
103
103
|
get isBuildOnly(): boolean;
|
|
@@ -12,6 +12,7 @@ export type SourceRemoteModel = {
|
|
|
12
12
|
id: string;
|
|
13
13
|
fileName?: string;
|
|
14
14
|
brandId?: string;
|
|
15
|
+
themeId?: string;
|
|
15
16
|
plugin?: {
|
|
16
17
|
fileId: string;
|
|
17
18
|
lastImportedAt?: string;
|
|
@@ -124,7 +125,7 @@ export type SourceModelCloud = Omit<SourceRemoteModelCloud, "lastUpdatesCheckedA
|
|
|
124
125
|
export type SourceModelFigmaVariablesPlugin = Omit<SourceRemoteModelFigmaVariablesPlugin, "lastImportedAt"> & {
|
|
125
126
|
lastImportedAt?: Date;
|
|
126
127
|
};
|
|
127
|
-
export type SourceTransportModel = Pick<Source, "type" | "id" | "fileName" | "brandId" | "scope"> & {
|
|
128
|
+
export type SourceTransportModel = Pick<Source, "type" | "id" | "fileName" | "brandId" | "themeId" | "scope"> & {
|
|
128
129
|
cloud?: SourceRemoteModelCloud | null;
|
|
129
130
|
};
|
|
130
131
|
export declare class Source {
|
|
@@ -132,6 +133,7 @@ export declare class Source {
|
|
|
132
133
|
id: string;
|
|
133
134
|
fileName: string | null;
|
|
134
135
|
brandId: string | null;
|
|
136
|
+
themeId: string | null;
|
|
135
137
|
cloud: SourceModelCloud | null;
|
|
136
138
|
tokenStudio?: SourceModelTokenStudio | null;
|
|
137
139
|
figmaVariablesPlugin?: SourceModelFigmaVariablesPlugin | null;
|
|
@@ -7,6 +7,8 @@ export type TokenOriginModel = {
|
|
|
7
7
|
referenceOriginId?: string;
|
|
8
8
|
referencePersistentId?: string;
|
|
9
9
|
referenceResolutionFailed?: boolean;
|
|
10
|
+
referenceOriginRemote?: boolean;
|
|
11
|
+
referenceOriginName?: string;
|
|
10
12
|
key?: string;
|
|
11
13
|
};
|
|
12
14
|
export declare class TokenOrigin {
|
|
@@ -17,6 +19,8 @@ export declare class TokenOrigin {
|
|
|
17
19
|
referenceOriginId?: string | null;
|
|
18
20
|
referencePersistentId?: string | null;
|
|
19
21
|
referenceResolutionFailed?: boolean | null;
|
|
22
|
+
referenceOriginRemote?: boolean | null;
|
|
23
|
+
referenceOriginName?: string | null;
|
|
20
24
|
key?: string | null;
|
|
21
25
|
constructor(model: TokenOriginModel);
|
|
22
26
|
}
|
|
@@ -25,6 +25,8 @@ export type UserProfileOnboardingRemoteModel = {
|
|
|
25
25
|
designSystemName?: string;
|
|
26
26
|
figmaUrl?: string;
|
|
27
27
|
defaultDestination?: UserOnboardingDefaultDestination;
|
|
28
|
+
isPageDraftOnboardingFinished?: boolean;
|
|
29
|
+
isApprovalsOnboardingFinished?: boolean;
|
|
28
30
|
};
|
|
29
31
|
export type UserProfileTransportModel = UserProfileRemoteModel;
|
|
30
32
|
export type UserProfileOnboardingUpdateModel = UserProfileOnboardingRemoteModel;
|
|
@@ -54,6 +56,8 @@ export declare class UserProfile {
|
|
|
54
56
|
designSystemName: string | null;
|
|
55
57
|
figmaUrl: string | null;
|
|
56
58
|
defaultDestination: UserOnboardingDefaultDestination | null;
|
|
59
|
+
isPageDraftOnboardingFinished: boolean | null;
|
|
60
|
+
isApprovalsOnboardingFinished: boolean | null;
|
|
57
61
|
} | null;
|
|
58
62
|
constructor(model: UserProfileRemoteModel);
|
|
59
63
|
/** Constructs directly manipulable update object for user profile */
|
|
@@ -3,6 +3,7 @@ export type WorkspaceSSOSettingsRemoteModel = {
|
|
|
3
3
|
defaultAutoInviteValue: boolean;
|
|
4
4
|
autoInviteDomains: Record<string, boolean>;
|
|
5
5
|
areInvitesDisabled: boolean;
|
|
6
|
+
skipDocsSupernovaLogin: boolean;
|
|
6
7
|
};
|
|
7
8
|
export type WorkspaceSSOSettingsUpdateModel = WorkspaceSSOSettingsRemoteModel;
|
|
8
9
|
export type WorkspaceSSOSettingsTransportModel = WorkspaceSSOSettingsRemoteModel;
|
|
@@ -11,6 +12,7 @@ export declare class WorkspaceSSOSettings {
|
|
|
11
12
|
defaultAutoInviteValue: boolean;
|
|
12
13
|
autoInviteDomains: Record<string, boolean>;
|
|
13
14
|
areInvitesDisabled: boolean;
|
|
15
|
+
skipDocsSupernovaLogin: boolean;
|
|
14
16
|
constructor(model: WorkspaceSSOSettingsRemoteModel);
|
|
15
17
|
toUpdateObject(): WorkspaceSSOSettingsUpdateModel;
|
|
16
18
|
toRemote(): WorkspaceSSOSettingsTransportModel;
|
|
@@ -32,7 +32,12 @@ export type PulsarContext = {
|
|
|
32
32
|
dsId: string;
|
|
33
33
|
versionId: string;
|
|
34
34
|
brandId: string | null;
|
|
35
|
+
/**
|
|
36
|
+
* @deprecated
|
|
37
|
+
* Use themeIds instead
|
|
38
|
+
*/
|
|
35
39
|
themeId: string | null;
|
|
40
|
+
themeIds: string[] | null;
|
|
36
41
|
};
|
|
37
42
|
export interface PulsarBridgingInterface {
|
|
38
43
|
export(fn: (sdk: Supernova, context: PulsarContext) => Promise<Array<AnyOutputFile>>): any;
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { DocsBlockFigmaNodePropertyOptions, DocsBlockMultiRichTextPropertyOptions } from "../../exports";
|
|
2
1
|
import { DocsBlockDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockDefinition";
|
|
3
2
|
import { DocsBlockItemDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockItemDefinition";
|
|
4
3
|
import { DocsBlockLayout } from "../../model/docs/blocks/definition/SDKDocsBlockLayout";
|
|
@@ -14,12 +13,14 @@ import { DocsBlockComponentPropertyPropertyDefinition, DocsBlockComponentPropert
|
|
|
14
13
|
import { DocsBlockDividerPropertyDefinition, DocsBlockDividerPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockDividerProperty";
|
|
15
14
|
import { DocsBlockEmbedUrlPropertyDefinition, DocsBlockEmbedUrlPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty";
|
|
16
15
|
import { DocsBlockFigmaComponentPropertyDefinition, DocsBlockFigmaComponentPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockFigmaComponentProperty";
|
|
17
|
-
import { DocsBlockFigmaNodePropertyDefinition } from "../../model/docs/blocks/properties/SDKDocsBlockFigmaNodeProperty";
|
|
16
|
+
import { DocsBlockFigmaNodePropertyDefinition, DocsBlockFigmaNodePropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockFigmaNodeProperty";
|
|
18
17
|
import { DocsBlockImagePropertyDefinition, DocsBlockImagePropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockImageProperty";
|
|
19
18
|
import { DocsBlockMarkdownPropertyDefinition, DocsBlockMarkdownPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockMarkdownProperty";
|
|
19
|
+
import { DocsBlockMultiRichTextPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty";
|
|
20
20
|
import { DocsBlockMultiSelectPropertyDefinition, DocsBlockMultiSelectPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty";
|
|
21
21
|
import { DocsBlockNumberPropertyDefinition, DocsBlockNumberPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockNumberProperty";
|
|
22
22
|
import { DocsBlockItemPropertyAnyDefinition } from "../../model/docs/blocks/properties/SDKDocsBlockProperty";
|
|
23
|
+
import { DocsBlockRichTextEditorPropertyDefinition, DocsBlockRichTextEditorPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockRichTextEditorProperty";
|
|
23
24
|
import { DocsBlockRichTextPropertyDefinition, DocsBlockRichTextPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockRichTextProperty";
|
|
24
25
|
import { DocsBlockSingleSelectPropertyDefinition, DocsBlockSingleSelectPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty";
|
|
25
26
|
import { DocsBlockStorybookPropertyDefinition, DocsBlockStorybookPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockStorybookProperty";
|
|
@@ -53,6 +54,7 @@ export declare class DocsBlockBuilder {
|
|
|
53
54
|
image: string;
|
|
54
55
|
layout: DocsBlockLayout;
|
|
55
56
|
description?: string;
|
|
57
|
+
defaultColumns?: number;
|
|
56
58
|
maxColumns?: number;
|
|
57
59
|
}): DocsBlockVariant;
|
|
58
60
|
/** Create and item variant to render the item with default layout (all properties will be stacked into a single column) */
|
|
@@ -63,6 +65,7 @@ export declare class DocsBlockBuilder {
|
|
|
63
65
|
properties: Array<DocsBlockItemPropertyAnyDefinition>;
|
|
64
66
|
description?: string;
|
|
65
67
|
maxColumns?: number;
|
|
68
|
+
defaultColumns?: number;
|
|
66
69
|
appearance?: {
|
|
67
70
|
isBordered?: boolean;
|
|
68
71
|
hasBackground?: boolean;
|
|
@@ -76,6 +79,7 @@ export declare class DocsBlockBuilder {
|
|
|
76
79
|
image?: string;
|
|
77
80
|
description?: string;
|
|
78
81
|
maxColumns?: number;
|
|
82
|
+
defaultColumns?: number;
|
|
79
83
|
appearance?: {
|
|
80
84
|
isBordered?: boolean;
|
|
81
85
|
hasBackground?: boolean;
|
|
@@ -131,7 +135,10 @@ export declare class DocsBlockBuilder {
|
|
|
131
135
|
item: DocsBlockItemDefinition;
|
|
132
136
|
maxItems?: number;
|
|
133
137
|
description?: string;
|
|
134
|
-
|
|
138
|
+
options?: {
|
|
139
|
+
linkable?: boolean;
|
|
140
|
+
newItemLabel?: string;
|
|
141
|
+
};
|
|
135
142
|
appearance?: {
|
|
136
143
|
isBordered?: boolean;
|
|
137
144
|
hasBackground?: boolean;
|
|
@@ -187,7 +194,7 @@ export declare class DocsBlockBuilder {
|
|
|
187
194
|
[key: string]: DocsBlockRichTextPropertyOptions;
|
|
188
195
|
};
|
|
189
196
|
}): DocsBlockRichTextPropertyDefinition;
|
|
190
|
-
/** Create a block property with type .
|
|
197
|
+
/** Create a block property with type .multiRichText and its specific options */
|
|
191
198
|
multiRichTextProperty(configuration: {
|
|
192
199
|
id: string;
|
|
193
200
|
name: string;
|
|
@@ -197,6 +204,16 @@ export declare class DocsBlockBuilder {
|
|
|
197
204
|
[key: string]: DocsBlockMultiRichTextPropertyOptions;
|
|
198
205
|
};
|
|
199
206
|
}): DocsBlockRichTextPropertyDefinition;
|
|
207
|
+
/** Create a block property with type .multiRichText and its specific options */
|
|
208
|
+
richTextEditorProperty(configuration: {
|
|
209
|
+
id: string;
|
|
210
|
+
name: string;
|
|
211
|
+
description?: string;
|
|
212
|
+
options: DocsBlockRichTextEditorPropertyOptions;
|
|
213
|
+
variants?: {
|
|
214
|
+
[key: string]: DocsBlockRichTextEditorPropertyOptions;
|
|
215
|
+
};
|
|
216
|
+
}): DocsBlockRichTextEditorPropertyDefinition;
|
|
200
217
|
/** Create a block property with type .boolean and its specific options */
|
|
201
218
|
booleanProperty(configuration: {
|
|
202
219
|
id: string;
|
|
@@ -3,12 +3,16 @@ export type TokenUtilPreviewTokenValueSegment = {
|
|
|
3
3
|
referencedName?: string;
|
|
4
4
|
prefersReferenceName?: boolean;
|
|
5
5
|
referenceResolutionFailed?: boolean;
|
|
6
|
+
referenceOriginRemote?: boolean;
|
|
7
|
+
referenceOriginName?: string;
|
|
6
8
|
};
|
|
7
9
|
export type TokenUtilPreviewTokenType = "blur" | "border" | "borderWidth" | "color" | "copy" | "fontFamily" | "fontSize" | "fontWeight" | "dimension" | "duration" | "gradient" | "lineHeight" | "letterSpacing" | "opacity" | "paragraphSpacing" | "radius" | "shadow" | "size" | "space" | "string" | "textCase" | "textDecoration" | "typography" | "visibility" | "zIndex";
|
|
8
10
|
export type TokenUtilPreviewMetadata = {
|
|
9
11
|
displayValue: string;
|
|
10
12
|
referencedTo?: string;
|
|
11
13
|
referenceResolutionFailed?: boolean;
|
|
14
|
+
referenceOriginRemote?: boolean;
|
|
15
|
+
referenceOriginName?: string;
|
|
12
16
|
tokenType: TokenUtilPreviewTokenType;
|
|
13
17
|
} & ({
|
|
14
18
|
meta?: null;
|
|
@@ -11,7 +11,7 @@ import { FontFamilyToken, FontWeightToken, ProductCopyToken, StringToken } from
|
|
|
11
11
|
import { TextCaseToken } from "../model/tokens/SDKTextCaseToken";
|
|
12
12
|
import { TextDecorationToken } from "../model/tokens/SDKTextDecorationToken";
|
|
13
13
|
import { Token } from "../model/tokens/SDKToken";
|
|
14
|
-
import {
|
|
14
|
+
import { AnyMultiLayerToken, AnySingleLayerToken, AnyTokenValue, BorderWidthTokenValue, ColorTokenValue, ColorValue, DimensionTokenValue, DurationTokenValue, FontFamilyTokenValue, FontSizeTokenValue, FontWeightTokenValue, LetterSpacingTokenValue, LineHeightTokenValue, OpacityTokenValue, ParagraphSpacingTokenValue, ProductCopyTokenValue, RadiusTokenValue, RawValue, SizeTokenValue, SpaceTokenValue, StringTokenValue, TextCaseTokenValue, TextDecorationTokenValue, VisibilityTokenValue, ZIndexTokenValue } from "../model/tokens/SDKTokenValue";
|
|
15
15
|
import { TypographyToken } from "../model/tokens/SDKTypographyToken";
|
|
16
16
|
import { VisibilityToken } from "../model/tokens/SDKVisibilityToken";
|
|
17
17
|
type TokenMapCompletenessTypeCheck<T extends {
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { DimensionTokenType } from "../model/enums/SDKTokenType";
|
|
2
|
+
export declare const typographyTokenDefaultValue: {
|
|
3
|
+
fontFamily: string;
|
|
4
|
+
fontWeight: string;
|
|
5
|
+
fontSize: number;
|
|
6
|
+
lineHeight: number;
|
|
7
|
+
letterSpacing: number;
|
|
8
|
+
paragraphIndent: number;
|
|
9
|
+
paragraphSpacing: number;
|
|
10
|
+
};
|
|
11
|
+
export declare const shadowTokenDefaultValue: {
|
|
12
|
+
x: number;
|
|
13
|
+
y: number;
|
|
14
|
+
blur: number;
|
|
15
|
+
spread: number;
|
|
16
|
+
color: string;
|
|
17
|
+
opacity: number;
|
|
18
|
+
type: string;
|
|
19
|
+
};
|
|
20
|
+
export declare const borderDefaultValue: {
|
|
21
|
+
color: string;
|
|
22
|
+
position: string;
|
|
23
|
+
style: string;
|
|
24
|
+
width: number;
|
|
25
|
+
};
|
|
26
|
+
export declare const blurDefaultValue: {
|
|
27
|
+
radius: number;
|
|
28
|
+
type: string;
|
|
29
|
+
};
|
|
30
|
+
export declare const opacityDefaultValue = 100;
|
|
31
|
+
export declare const dimensionDefaultValues: Record<DimensionTokenType, number | string>;
|