@supernova-studio/supernova-sdk-beta 1.6.28 → 1.6.29
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/SDKAreaAutomation.d.ts +23 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +6 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +9 -2
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +16 -5
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +4 -2
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +12 -3
- package/build/sdk-typescript/src/exports-pulsar.d.ts +1 -1
- package/build/sdk-typescript/src/exports.d.ts +26 -3
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockDefinition.d.ts +2 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts +15 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetPropertyProperty.d.ts +9 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts +9 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeProperty.d.ts +13 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts +13 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts +15 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentPropertyProperty.d.ts +9 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockDividerProperty.d.ts +9 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts +12 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockImageProperty.d.ts +15 -5
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMarkdownProperty.d.ts +10 -9
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty.d.ts +10 -9
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockNumberProperty.d.ts +9 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockProperty.d.ts +6 -2
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts +11 -10
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts +10 -9
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +12 -4
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTableProperty.d.ts +14 -8
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +10 -9
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +21 -10
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenPropertyProperty.d.ts +10 -9
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty.d.ts +13 -9
- package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlock.d.ts +33 -24
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageAsset.d.ts +1 -1
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockFrame.d.ts +1 -1
- package/build/sdk-typescript/src/model/enums/SDKCodeLanguage.d.ts +33 -0
- package/build/sdk-typescript/src/model/enums/SDKDocBlockMode.d.ts +8 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +0 -3
- package/build/sdk-typescript/src/model/exporters/SDKExporter.d.ts +7 -2
- package/build/sdk-typescript/src/model/membership/SDKMembership.d.ts +5 -5
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceSubscription.d.ts +0 -1
- package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +0 -11
- package/build/supernova-sdk-typescript.js +1 -1
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedFrameProperty.d.ts +0 -9
- package/build/sdk-typescript/src/utils/DocumentationUtils.d.ts +0 -2
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty.d.ts
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
1
2
|
import { DocsBlockOptionRenderingStyle } from "../../../enums/SDKDocsBlockOptionRenderStyle";
|
|
2
|
-
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
|
+
/** MultiSelect property - Additional non-value options */
|
|
3
5
|
export type DocsBlockMultiSelectPropertyOptions = {
|
|
4
6
|
defaultChoices: Array<string>;
|
|
5
7
|
choices: Array<{
|
|
@@ -9,12 +11,11 @@ export type DocsBlockMultiSelectPropertyOptions = {
|
|
|
9
11
|
}>;
|
|
10
12
|
style?: Exclude<DocsBlockOptionRenderingStyle, DocsBlockOptionRenderingStyle.toggleButton>;
|
|
11
13
|
};
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
export declare class DocsBlockMultiSelectPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockMultiSelectPropertyOptions> {
|
|
14
|
+
/** MultiSelect property - Data */
|
|
15
|
+
export type DocsBlockMultiSelectPropertyData = DocsBlockPropertyData<Array<string>> & Record<string, never>;
|
|
16
|
+
/** MultiSelect property - Definition model */
|
|
17
|
+
export type DocsBlockMultiSelectPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockMultiSelectPropertyOptions;
|
|
18
|
+
/** MultiSelect property - Definition */
|
|
19
|
+
export declare class DocsBlockMultiSelectPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockMultiSelectPropertyOptions, DocsBlockMultiSelectPropertyData> {
|
|
20
|
+
type: DocsBlockItemPropertyType.multiSelect;
|
|
20
21
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockNumberProperty.d.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** Number property - Additional non-value options */
|
|
2
4
|
export type DocsBlockNumberPropertyOptions = {
|
|
3
5
|
/** Default value to set when block is created */
|
|
4
6
|
defaultValue: number;
|
|
@@ -9,7 +11,11 @@ export type DocsBlockNumberPropertyOptions = {
|
|
|
9
11
|
/** Step value */
|
|
10
12
|
step: number;
|
|
11
13
|
};
|
|
14
|
+
/** Number property - Data */
|
|
15
|
+
export type DocsBlockNumberPropertyData = DocsBlockPropertyData<number> & Record<string, never>;
|
|
16
|
+
/** Number property - Definition model */
|
|
12
17
|
export type DocsBlockNumberPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockNumberPropertyOptions;
|
|
13
|
-
/** Number property */
|
|
14
|
-
export declare class DocsBlockNumberPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockNumberPropertyOptions> {
|
|
18
|
+
/** Number property - Definition */
|
|
19
|
+
export declare class DocsBlockNumberPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockNumberPropertyOptions, DocsBlockNumberPropertyData> {
|
|
20
|
+
type: DocsBlockItemPropertyType.number;
|
|
15
21
|
}
|
|
@@ -9,9 +9,12 @@ export type DocsBlockPropertyDefinitionModel = {
|
|
|
9
9
|
[key: string]: object | Record<string, never>;
|
|
10
10
|
};
|
|
11
11
|
};
|
|
12
|
+
export type DocsBlockPropertyData<T> = {
|
|
13
|
+
value: T;
|
|
14
|
+
};
|
|
12
15
|
/** Generic property definition for when we don't care about specific types in options, just want to use the property high-level data */
|
|
13
|
-
export type DocsBlockItemPropertyAnyDefinition = DocsBlockPropertyDefinition<any
|
|
14
|
-
export declare class DocsBlockPropertyDefinition<T extends object
|
|
16
|
+
export type DocsBlockItemPropertyAnyDefinition = DocsBlockPropertyDefinition<any, DocsBlockPropertyData<any>>;
|
|
17
|
+
export declare class DocsBlockPropertyDefinition<T extends object, D extends DocsBlockPropertyData<any>> {
|
|
15
18
|
/** Property id, validated to be unique within a block, but not necessarily unique across all blocks */
|
|
16
19
|
id: string;
|
|
17
20
|
/** Human readable name that will show in the editor */
|
|
@@ -31,4 +34,5 @@ export declare class DocsBlockPropertyDefinition<T extends object> {
|
|
|
31
34
|
[key: string]: T;
|
|
32
35
|
} | null;
|
|
33
36
|
constructor(model: DocsBlockPropertyDefinitionModel);
|
|
37
|
+
defaultData(): D;
|
|
34
38
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts
CHANGED
|
@@ -1,18 +1,19 @@
|
|
|
1
|
+
import { RichTextSpan } from "../../../documentation/SDKDocumentationLegacyRichTextSpan";
|
|
2
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
1
3
|
import { DocsBlockRichTextPropertyStyle } from "../../../enums/SDKDocsBlockRichTextPropertyStyle";
|
|
2
|
-
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
-
/** RichText property options */
|
|
4
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
5
|
+
/** RichText property - Additional non-value options */
|
|
4
6
|
export type DocsBlockRichTextPropertyOptions = {
|
|
5
7
|
/** Placeholder to show when rich text area is empty */
|
|
6
8
|
placeholder?: string;
|
|
7
9
|
/** Visual style of the rich text property */
|
|
8
10
|
style?: DocsBlockRichTextPropertyStyle;
|
|
9
11
|
};
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
export declare class DocsBlockRichTextPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockRichTextPropertyOptions> {
|
|
12
|
+
/** RichText property - Data */
|
|
13
|
+
export type DocsBlockRichTextPropertyData = DocsBlockPropertyData<Array<RichTextSpan>> & Record<string, never>;
|
|
14
|
+
/** RichText property - Definition model */
|
|
15
|
+
export type DocsBlockRichTextPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockRichTextPropertyOptions;
|
|
16
|
+
/** RichText property - Definition */
|
|
17
|
+
export declare class DocsBlockRichTextPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockRichTextPropertyOptions, DocsBlockRichTextPropertyData> {
|
|
18
|
+
type: DocsBlockItemPropertyType.richText;
|
|
18
19
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
1
2
|
import { DocsBlockOptionRenderingStyle } from "../../../enums/SDKDocsBlockOptionRenderStyle";
|
|
2
|
-
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
|
+
/** SingleSelect property - Additional non-value options */
|
|
3
5
|
export type DocsBlockSingleSelectPropertyOptions = {
|
|
4
6
|
/** Default choices to set when block is created */
|
|
5
7
|
defaultChoice: string;
|
|
@@ -15,12 +17,11 @@ export type DocsBlockSingleSelectPropertyOptions = {
|
|
|
15
17
|
/** Visual representation of the property */
|
|
16
18
|
style?: DocsBlockOptionRenderingStyle;
|
|
17
19
|
};
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
export declare class DocsBlockSingleSelectPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockSingleSelectPropertyOptions> {
|
|
20
|
+
/** SingleSelect property - Data */
|
|
21
|
+
export type DocsBlockSingleSelectPropertyData = DocsBlockPropertyData<string> & Record<string, never>;
|
|
22
|
+
/** SingleSelect property - Definition model */
|
|
23
|
+
export type DocsBlockSingleSelectPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockSingleSelectPropertyOptions;
|
|
24
|
+
/** SingleSelect property - Definition */
|
|
25
|
+
export declare class DocsBlockSingleSelectPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockSingleSelectPropertyOptions, DocsBlockSingleSelectPropertyData> {
|
|
26
|
+
type: DocsBlockItemPropertyType.singleSelect;
|
|
26
27
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts
CHANGED
|
@@ -1,6 +1,14 @@
|
|
|
1
|
-
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
1
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
|
|
2
|
+
/** Storybook property - Additional non-value options */
|
|
2
3
|
export type DocsBlockStorybookPropertyOptions = Record<string, never>;
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
4
|
+
/** Storybook property - Data */
|
|
5
|
+
export type DocsBlockStorybookPropertyData = DocsBlockPropertyData<string> & {
|
|
6
|
+
caption?: string;
|
|
7
|
+
height?: number;
|
|
8
|
+
showAddons?: boolean;
|
|
9
|
+
};
|
|
10
|
+
/** Storybook property - Definition model */
|
|
11
|
+
export type DocsBlockStorybookPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockStorybookPropertyOptions;
|
|
12
|
+
/** Storybook property - Definition */
|
|
13
|
+
export declare class DocsBlockStorybookPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockStorybookPropertyOptions, DocsBlockStorybookPropertyData> {
|
|
6
14
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTableProperty.d.ts
CHANGED
|
@@ -1,11 +1,17 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** Table property - Additional non-value options */
|
|
2
4
|
export type DocsBlockTablePropertyOptions = Record<string, never>;
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
/** Table property - Data */
|
|
6
|
+
export type DocsBlockTablePropertyData = DocsBlockPropertyData<any> & {
|
|
7
|
+
highlightHeaderColumn?: boolean;
|
|
8
|
+
highlightHeaderRow?: boolean;
|
|
9
|
+
showBorder?: boolean;
|
|
10
|
+
width?: number;
|
|
8
11
|
};
|
|
9
|
-
/** Table property */
|
|
10
|
-
export
|
|
12
|
+
/** Table property - Definition model */
|
|
13
|
+
export type DocsBlockTablePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockTablePropertyOptions;
|
|
14
|
+
/** Table property - Definition */
|
|
15
|
+
export declare class DocsBlockTablePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTablePropertyOptions, DocsBlockTablePropertyData> {
|
|
16
|
+
type: DocsBlockItemPropertyType.table;
|
|
11
17
|
}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
1
2
|
import { DocsBlockTextPropertyColor } from "../../../enums/SDKDocsBlockTextPropertyColor";
|
|
2
3
|
import { DocsBlockTextPropertyStyle } from "../../../enums/SDKDocsBlockTextPropertyStyle";
|
|
3
|
-
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
5
|
+
/** Text property - Additional non-value options */
|
|
4
6
|
export type DocsBlockTextPropertyOptions = {
|
|
5
7
|
/** Placeholder to show when textfield is empty */
|
|
6
8
|
placeholder?: string;
|
|
@@ -11,12 +13,11 @@ export type DocsBlockTextPropertyOptions = {
|
|
|
11
13
|
/** Text color */
|
|
12
14
|
color?: DocsBlockTextPropertyColor;
|
|
13
15
|
};
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
export declare class DocsBlockTextPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTextPropertyOptions> {
|
|
16
|
+
/** Text property - Data */
|
|
17
|
+
export type DocsBlockTextPropertyData = DocsBlockPropertyData<string> & Record<string, never>;
|
|
18
|
+
/** Text property - Definition model */
|
|
19
|
+
export type DocsBlockTextPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockTextPropertyOptions;
|
|
20
|
+
/** Text property - Definition */
|
|
21
|
+
export declare class DocsBlockTextPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTextPropertyOptions, DocsBlockTextPropertyData> {
|
|
22
|
+
type: DocsBlockItemPropertyType.text;
|
|
22
23
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts
CHANGED
|
@@ -1,19 +1,30 @@
|
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
1
2
|
import { TokenType } from "../../../enums/SDKTokenType";
|
|
2
|
-
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
|
+
/** Token property - Additional non-value options */
|
|
3
5
|
export type DocsBlockTokenPropertyOptions = {
|
|
4
6
|
/** Token types that are allowed to be selected. All types allowed if nothing is provided */
|
|
5
7
|
allowedTypes?: Array<TokenType>;
|
|
8
|
+
/** How should the tokens be rendered in editor */
|
|
9
|
+
renderLayoutAs?: "grid" | "list";
|
|
6
10
|
/** Whether to allow selecting token custom properties. True by default */
|
|
7
|
-
|
|
11
|
+
allowPropertySelection?: boolean;
|
|
8
12
|
/** Whether to allow selecting themes. True by default */
|
|
9
|
-
|
|
13
|
+
allowThemeSelection?: boolean;
|
|
10
14
|
};
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
15
|
+
/** Token property - Data */
|
|
16
|
+
export type DocsBlockTokenPropertyData = DocsBlockPropertyData<Array<{
|
|
17
|
+
entityId: string;
|
|
18
|
+
entityType: "token" | "tokenGroup";
|
|
19
|
+
}>> & {
|
|
20
|
+
/** Selected token ids */
|
|
21
|
+
selectedPropertyIds?: Array<string>;
|
|
22
|
+
/** Selected theme ids */
|
|
23
|
+
selectedThemeIds?: Array<string>;
|
|
16
24
|
};
|
|
17
|
-
/** Token property */
|
|
18
|
-
export
|
|
25
|
+
/** Token property - Definition model */
|
|
26
|
+
export type DocsBlockTokenPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockTokenPropertyOptions;
|
|
27
|
+
/** Token property - Definition */
|
|
28
|
+
export declare class DocsBlockTokenPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTokenPropertyOptions, DocsBlockTokenPropertyData> {
|
|
29
|
+
type: DocsBlockItemPropertyType.token;
|
|
19
30
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenPropertyProperty.d.ts
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
/** TokenProperty property - Additional non-value options */
|
|
2
4
|
export type DocsBlockTokenPropertyPropertyOptions = Record<string, never>;
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
export declare class DocsBlockTokenPropertyPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTokenPropertyPropertyOptions> {
|
|
5
|
+
/** TokenProperty property - Data */
|
|
6
|
+
export type DocsBlockTokenPropertyPropertyData = DocsBlockPropertyData<Array<string>> & Record<string, never>;
|
|
7
|
+
/** TokenProperty property - Definition model */
|
|
8
|
+
export type DocsBlockTokenPropertyPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockTokenPropertyPropertyOptions;
|
|
9
|
+
/** TokenProperty property - Definition */
|
|
10
|
+
export declare class DocsBlockTokenPropertyPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTokenPropertyPropertyOptions, DocsBlockTokenPropertyPropertyData> {
|
|
11
|
+
type: DocsBlockItemPropertyType.tokenProperty;
|
|
11
12
|
}
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty.d.ts
CHANGED
|
@@ -1,11 +1,15 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
};
|
|
1
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
+
import { TokenType } from "../../../enums/SDKTokenType";
|
|
3
|
+
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
|
+
/** TokenType property - Additional non-value options */
|
|
5
|
+
export type DocsBlockTokenTypePropertyOptions = {
|
|
6
|
+
allowMultiSelect?: boolean;
|
|
8
7
|
};
|
|
9
|
-
/**
|
|
10
|
-
export
|
|
8
|
+
/** TokenType property - Data */
|
|
9
|
+
export type DocsBlockTokenTypePropertyData = DocsBlockPropertyData<Array<TokenType>> & Record<string, never>;
|
|
10
|
+
/** TokenType property - Definition model */
|
|
11
|
+
export type DocsBlockTokenTypePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockTokenTypePropertyOptions;
|
|
12
|
+
/** TokenType property - Definition */
|
|
13
|
+
export declare class DocsBlockTokenTypePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTokenTypePropertyOptions, DocsBlockTokenTypePropertyData> {
|
|
14
|
+
type: DocsBlockItemPropertyType.tokenType;
|
|
11
15
|
}
|
|
@@ -1,32 +1,27 @@
|
|
|
1
|
-
import { DocsBlockItemEntityType } from "../../../enums/SDKDocsBlockItemEntityType";
|
|
2
1
|
import { DocsColorRef } from "../support/SDKDocsColorRef";
|
|
3
2
|
import { DocsLinkRef } from "../support/SDKDocsLinkRef";
|
|
4
|
-
export type DocsBlockStaticDataValue = string | number | boolean | object | Array<string | number | boolean | object>;
|
|
5
3
|
export type DocsBlockModel = {
|
|
6
4
|
id: string;
|
|
7
5
|
packageId: string;
|
|
8
|
-
|
|
6
|
+
variantId?: string;
|
|
9
7
|
indentLevel: number;
|
|
10
8
|
appearance?: {
|
|
11
9
|
itemBackgroundColor?: DocsColorRef;
|
|
12
10
|
};
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
11
|
+
data?: Array<{
|
|
12
|
+
props: {
|
|
13
|
+
[key: string]: object;
|
|
14
|
+
};
|
|
15
|
+
linksTo?: DocsLinkRef;
|
|
16
16
|
}>;
|
|
17
|
-
dynamicData?: Array<{
|
|
18
|
-
entityId: string;
|
|
19
|
-
entityType: DocsBlockItemEntityType;
|
|
20
|
-
}>;
|
|
21
|
-
dynamicDataOrder: Array<string>;
|
|
22
17
|
};
|
|
23
18
|
export declare class DocsBlock {
|
|
24
19
|
/** Unique identifier of the block */
|
|
25
20
|
id: string;
|
|
26
21
|
/** Unique identifier of the block package */
|
|
27
22
|
packageId: string;
|
|
28
|
-
/** Unique identifier of the
|
|
29
|
-
|
|
23
|
+
/** Unique identifier of the selected variant */
|
|
24
|
+
variantId: string | null;
|
|
30
25
|
/** Indentation of the block in levels (0, 1, 2), not pixels */
|
|
31
26
|
indentLevel: number;
|
|
32
27
|
/** Block appearance - Properties that are natively available for all blocks, such as background color */
|
|
@@ -39,19 +34,33 @@ export declare class DocsBlock {
|
|
|
39
34
|
* Property resolution:
|
|
40
35
|
* data > default (in block property definition) > not set
|
|
41
36
|
*/
|
|
42
|
-
|
|
37
|
+
data: Array<{
|
|
43
38
|
/** Dynamic key coming from property.id block definition */
|
|
44
|
-
|
|
39
|
+
props: {
|
|
40
|
+
[key: string]: object;
|
|
41
|
+
};
|
|
45
42
|
/** Link where the item points to, if any. Must be enabled in behaviors */
|
|
46
|
-
|
|
47
|
-
}>;
|
|
48
|
-
/** Dynamic data represents data for items that reference entities in Supernova - an example of this would be a token block.
|
|
49
|
-
* This is an array, because multiple entities can be selected at once */
|
|
50
|
-
dynamicData: Array<{
|
|
51
|
-
entityId: string;
|
|
52
|
-
entityType: DocsBlockItemEntityType;
|
|
43
|
+
linksTo?: DocsLinkRef;
|
|
53
44
|
}>;
|
|
54
|
-
/** If user re-ordered items that are pulled dynamically, order from this field should take precedent over default ordering */
|
|
55
|
-
dynamicDataOrder: Array<string>;
|
|
56
45
|
constructor(model: DocsBlockModel);
|
|
46
|
+
/** Returns stored data of all properties. This will retrieve properties for item on the first position, ideal for single-item blocks */
|
|
47
|
+
allPropertyDataForSingleItem(): Record<string, object> | null;
|
|
48
|
+
/** Returns stored data of all properties. This will retrieve properties for item at any position */
|
|
49
|
+
allPropertyDataForItemAtIndex(index: number): Record<string, object> | null;
|
|
50
|
+
/** Returns stored data of a single property. This will retrieve property for item on the first position, ideal for single-item blocks */
|
|
51
|
+
propertyDataForSingleItem(propertyId: string): object | null;
|
|
52
|
+
/** Returns stored data of a single property. This will retrieve property for item at any position */
|
|
53
|
+
propertyDataForItemAtIndex(index: number, propertyId: string): object | null;
|
|
54
|
+
/** Returns stored link, if any. This will retrieve link for item on the first position, ideal for single-item blocks */
|
|
55
|
+
linkForSingleItem(): DocsLinkRef | null;
|
|
56
|
+
/** Returns stored link, if any. This will retrieve link for item at any position */
|
|
57
|
+
linkForItemAtIndex(index: number): DocsLinkRef | null;
|
|
58
|
+
/** Update data for property of specific key and index */
|
|
59
|
+
updatePropertyDataForItemAtIndex(index: number, propertyId: string, data: object): void;
|
|
60
|
+
/** Update data for property of specific key and index */
|
|
61
|
+
updatePropertyDataForSingleItem(propertyId: string, data: object): void;
|
|
62
|
+
/** Update link for item at specific index */
|
|
63
|
+
updateLinkForItemAtIndex(index: number, link: DocsLinkRef | null): void;
|
|
64
|
+
/** Update link for item at specific index */
|
|
65
|
+
updateLinkForSingleItem(link: DocsLinkRef | null): void;
|
|
57
66
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { DocumentationLegacyPageAssetType } from "../enums/SDKDocumentationLegacyPageAssetType";
|
|
2
2
|
import { DocumentationLegacyPageBlockFrame, DocumentationLegacyPageBlockFrameModel } from "./blocks/SDKDocumentationLegacyPageBlockFrame";
|
|
3
3
|
export type DocumentationLegacyPageAssetModel = {
|
|
4
|
-
id
|
|
4
|
+
id?: string;
|
|
5
5
|
persistentId?: string;
|
|
6
6
|
sourceId?: string;
|
|
7
7
|
sourceFrameId?: string;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { FrameOrigin, FrameOriginModel } from "../../support/SDKFrameOrigin";
|
|
2
2
|
import { ColorTokenRemoteData } from "../../tokens/remote/SDKRemoteTokenData";
|
|
3
3
|
export type DocumentationLegacyPageBlockFrameModel = {
|
|
4
|
-
id
|
|
4
|
+
id?: string;
|
|
5
5
|
sourceId: string;
|
|
6
6
|
sourceFrameId: string;
|
|
7
7
|
title?: string;
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
export declare enum CodeLanguage {
|
|
2
|
+
angular = "Angular",
|
|
3
|
+
bash = "Bash",
|
|
4
|
+
c = "C",
|
|
5
|
+
cpp = "Cpp",
|
|
6
|
+
csharp = "Csharp",
|
|
7
|
+
dart = "Dart",
|
|
8
|
+
handlebars = "Handlebars",
|
|
9
|
+
html = "Html",
|
|
10
|
+
java = "Java",
|
|
11
|
+
javascript = "Javascript",
|
|
12
|
+
json = "Json",
|
|
13
|
+
reactJsx = "ReactJsx",
|
|
14
|
+
reactTsx = "ReactTsx",
|
|
15
|
+
kotlin = "Kotlin",
|
|
16
|
+
lua = "Lua",
|
|
17
|
+
markdown = "Markdown",
|
|
18
|
+
objectiveC = "ObjectiveC",
|
|
19
|
+
php = "Php",
|
|
20
|
+
plain = "Plain",
|
|
21
|
+
python = "Python",
|
|
22
|
+
ruby = "Ruby",
|
|
23
|
+
rust = "Rust",
|
|
24
|
+
sass = "Sass",
|
|
25
|
+
scss = "Scss",
|
|
26
|
+
svelte = "Svelte",
|
|
27
|
+
swift = "Swift",
|
|
28
|
+
twig = "Twig",
|
|
29
|
+
typescript = "Typescript",
|
|
30
|
+
vue = "Vue",
|
|
31
|
+
xml = "Xml",
|
|
32
|
+
yaml = "Yaml"
|
|
33
|
+
}
|
|
@@ -28,13 +28,10 @@ export declare enum DocsBlockItemPropertyType {
|
|
|
28
28
|
/** Asset property allows selection of custom asset properties (columns) */
|
|
29
29
|
assetProperty = "AssetProperty",
|
|
30
30
|
/** Page type allows data access to the pages defined in design system */
|
|
31
|
-
page = "Page",
|
|
32
31
|
/** Page property allows selection of custom page properties (columns) */
|
|
33
|
-
pageProperty = "PageProperty",
|
|
34
32
|
/** Embed property allows user to input page to be embedded via URL */
|
|
35
33
|
embedURL = "EmbedURL",
|
|
36
34
|
/** Embed property allows user to input page to be embedded via iframe */
|
|
37
|
-
embedFrame = "EmbedFrame",
|
|
38
35
|
/** Markdown property allows user to add markdown to render */
|
|
39
36
|
markdown = "Markdown",
|
|
40
37
|
/** Code property allows user to add code to render */
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { ExporterCustomBlock, ExporterCustomBlockModel } from "./custom_blocks/SDKExporterCustomBlock";
|
|
2
2
|
import { ExporterCustomBlockVariant } from "./custom_blocks/SDKExporterCustomBlockVariant";
|
|
3
3
|
import { ExporterConfigurationProperty, ExporterConfigurationPropertyModel } from "./custom_properties/SDKExporterConfigurationProperty";
|
|
4
|
+
export type ExporterProvider = "github" | "gitlab" | "bitbucket" | "azure";
|
|
4
5
|
export type ExporterModel = {
|
|
5
6
|
id: string;
|
|
6
7
|
packageId: string;
|
|
@@ -17,7 +18,7 @@ export type ExporterModel = {
|
|
|
17
18
|
readme: string;
|
|
18
19
|
iconURL?: string;
|
|
19
20
|
tags: Array<string>;
|
|
20
|
-
gitProvider:
|
|
21
|
+
gitProvider: ExporterProvider;
|
|
21
22
|
gitUrl: string;
|
|
22
23
|
gitBranch: string;
|
|
23
24
|
gitDirectory: string;
|
|
@@ -26,6 +27,10 @@ export type ExporterModel = {
|
|
|
26
27
|
customBlocks?: Array<ExporterCustomBlockModel>;
|
|
27
28
|
exporterType: "code" | "documentation";
|
|
28
29
|
};
|
|
30
|
+
export type NewExporterPayload = {
|
|
31
|
+
url?: string;
|
|
32
|
+
provider?: ExporterProvider;
|
|
33
|
+
};
|
|
29
34
|
export declare class Exporter {
|
|
30
35
|
/** Unique exporter installation id. This id is used to referenced exporter within Supernova system (for example, in ds.documentationExporterId) */
|
|
31
36
|
id: string;
|
|
@@ -58,7 +63,7 @@ export declare class Exporter {
|
|
|
58
63
|
/** Exporter feature tags, such as iOS, React, token, styles, components etc. */
|
|
59
64
|
tags: Array<string>;
|
|
60
65
|
exporterType: "code" | "documentation";
|
|
61
|
-
gitProvider:
|
|
66
|
+
gitProvider: ExporterProvider;
|
|
62
67
|
/** URL of the repository containing the exporter package */
|
|
63
68
|
gitUrl: string;
|
|
64
69
|
/** Branch of the repository containing the exporter package. If not provided, exporter is located at the default branch */
|
|
@@ -3,14 +3,14 @@ import { Workspace, WorkspaceRemoteModel } from "../workspaces/SDKWorkspace";
|
|
|
3
3
|
export type MembershipRemoteModel = {
|
|
4
4
|
workspace: WorkspaceRemoteModel;
|
|
5
5
|
role: UserRole;
|
|
6
|
-
|
|
6
|
+
effectiveRole: UserRole;
|
|
7
7
|
};
|
|
8
8
|
export declare class Membership {
|
|
9
|
-
/**
|
|
9
|
+
/** Workspace of this membership. */
|
|
10
10
|
workspace: Workspace;
|
|
11
|
-
/**
|
|
11
|
+
/** Selected role of the user. */
|
|
12
12
|
role: UserRole;
|
|
13
|
-
/**
|
|
14
|
-
|
|
13
|
+
/** Actual role of the user. */
|
|
14
|
+
effectiveRole: UserRole;
|
|
15
15
|
constructor(model: MembershipRemoteModel);
|
|
16
16
|
}
|
|
@@ -31,7 +31,6 @@ export type WorkspaceSubscriptionCardRemoteModel = {
|
|
|
31
31
|
};
|
|
32
32
|
export type WorkspaceSubscriptionTransportModel = WorkspaceSubscriptionRemoteModel;
|
|
33
33
|
export type WorkspaceSubscriptionUpdateModel = {
|
|
34
|
-
subscriptionId: string;
|
|
35
34
|
priceId: string;
|
|
36
35
|
numberOfSeats: number;
|
|
37
36
|
};
|
|
@@ -11,7 +11,6 @@ import { DocsBlockCodeSandboxPropertyDefinition, DocsBlockCodeSandboxPropertyOpt
|
|
|
11
11
|
import { DocsBlockComponentPropertyDefinition, DocsBlockComponentPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockComponentProperty";
|
|
12
12
|
import { DocsBlockComponentPropertyPropertyDefinition, DocsBlockComponentPropertyPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockComponentPropertyProperty";
|
|
13
13
|
import { DocsBlockDividerPropertyDefinition, DocsBlockDividerPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockDividerProperty";
|
|
14
|
-
import { DocsBlockEmbedFramePropertyDefinition, DocsBlockEmbedFramePropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockEmbedFrameProperty";
|
|
15
14
|
import { DocsBlockEmbedUrlPropertyDefinition, DocsBlockEmbedUrlPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty";
|
|
16
15
|
import { DocsBlockImagePropertyDefinition, DocsBlockImagePropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockImageProperty";
|
|
17
16
|
import { DocsBlockMarkdownPropertyDefinition, DocsBlockMarkdownPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockMarkdownProperty";
|
|
@@ -283,16 +282,6 @@ export declare class DocsBlockBuilder {
|
|
|
283
282
|
[key: string]: DocsBlockEmbedUrlPropertyOptions;
|
|
284
283
|
};
|
|
285
284
|
}): DocsBlockEmbedUrlPropertyDefinition;
|
|
286
|
-
/** Create a block property with type .embedFrame and its specific options */
|
|
287
|
-
embedFrameProperty(configuration: {
|
|
288
|
-
id: string;
|
|
289
|
-
name: string;
|
|
290
|
-
description?: string;
|
|
291
|
-
options: DocsBlockEmbedFramePropertyOptions;
|
|
292
|
-
variants?: {
|
|
293
|
-
[key: string]: DocsBlockEmbedFramePropertyOptions;
|
|
294
|
-
};
|
|
295
|
-
}): DocsBlockEmbedFramePropertyDefinition;
|
|
296
285
|
/** Create a block property with type .markdown and its specific options */
|
|
297
286
|
markdownProperty(configuration: {
|
|
298
287
|
id: string;
|