@supernova-studio/supernova-sdk-beta 1.6.27 → 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.
Files changed (62) hide show
  1. package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +25 -3
  2. package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +6 -0
  3. package/build/sdk-typescript/src/core/areas/SDKAreaIntegrations.d.ts +1 -1
  4. package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +32 -4
  5. package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +22 -8
  6. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +6 -4
  7. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +20 -4
  8. package/build/sdk-typescript/src/core/resolvers/SDKTokenResolver.d.ts +3 -3
  9. package/build/sdk-typescript/src/exports-pulsar.d.ts +1 -1
  10. package/build/sdk-typescript/src/exports.d.ts +26 -3
  11. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockDefinition.d.ts +2 -0
  12. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/token-detail/SDKDocsBlockActualTokenDetail.d.ts +6 -0
  13. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/token-group/SDKDocsBlockActualTokenGroup.d.ts +6 -0
  14. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/token-list/SDKDocsBlockActualTokenList.d.ts +6 -0
  15. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts +15 -3
  16. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetPropertyProperty.d.ts +9 -3
  17. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts +9 -3
  18. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeProperty.d.ts +13 -3
  19. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts +13 -3
  20. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts +15 -3
  21. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentPropertyProperty.d.ts +9 -3
  22. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockDividerProperty.d.ts +9 -3
  23. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts +12 -3
  24. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockImageProperty.d.ts +15 -5
  25. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMarkdownProperty.d.ts +10 -9
  26. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty.d.ts +10 -9
  27. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockNumberProperty.d.ts +9 -3
  28. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockProperty.d.ts +6 -2
  29. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts +11 -10
  30. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts +10 -9
  31. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +12 -4
  32. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTableProperty.d.ts +14 -8
  33. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +10 -9
  34. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +23 -8
  35. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenPropertyProperty.d.ts +10 -9
  36. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty.d.ts +13 -9
  37. package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlock.d.ts +33 -24
  38. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyGroup.d.ts +3 -3
  39. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageAsset.d.ts +1 -1
  40. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockFrame.d.ts +1 -1
  41. package/build/sdk-typescript/src/model/enums/SDKCodeLanguage.d.ts +33 -0
  42. package/build/sdk-typescript/src/model/enums/SDKDocBlockMode.d.ts +8 -0
  43. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +0 -3
  44. package/build/sdk-typescript/src/model/exporters/SDKExporter.d.ts +7 -2
  45. package/build/sdk-typescript/src/model/membership/SDKMembership.d.ts +5 -5
  46. package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +1 -1
  47. package/build/sdk-typescript/src/model/tokens/SDKStringToken.d.ts +2 -2
  48. package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceSSOSettings.d.ts +2 -0
  49. package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceSubscription.d.ts +4 -0
  50. package/build/sdk-typescript/src/tests/helpers.d.ts +1 -1
  51. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONConverter.d.ts +1 -1
  52. package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +0 -11
  53. package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformBlock.d.ts +2 -2
  54. package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformUtil.d.ts +1 -1
  55. package/build/sdk-typescript/src/tools/token-transform/SDKToolsTokenTransform.d.ts +1 -1
  56. package/build/sdk-typescript/src/utils/TokenUtils.d.ts +6 -6
  57. package/build/supernova-sdk-typescript.js +1 -1
  58. package/build/supernova-sdk-typescript.js.map +1 -1
  59. package/package.json +1 -1
  60. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedFrameProperty.d.ts +0 -9
  61. package/build/sdk-typescript/src/tests/Enterprise/PluginFigmaTokens.spec.d.ts +0 -1
  62. package/build/sdk-typescript/src/utils/DocumentationUtils.d.ts +0 -2
@@ -1,6 +1,16 @@
1
- import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
1
+ import { CodeLanguage } from "../../../enums/SDKCodeLanguage";
2
+ import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
3
+ import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
4
+ /** Code property - Additional non-value options */
2
5
  export type DocsBlockCodePropertyOptions = Record<string, never>;
6
+ /** Code property - Data */
7
+ export type DocsBlockCodePropertyData = DocsBlockPropertyData<string> & {
8
+ format?: CodeLanguage;
9
+ caption?: string;
10
+ };
11
+ /** Code property - Definition model */
3
12
  export type DocsBlockCodePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockCodePropertyOptions;
4
- /** Code property */
5
- export declare class DocsBlockCodePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockCodePropertyOptions> {
13
+ /** Code property - Definition */
14
+ export declare class DocsBlockCodePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockCodePropertyOptions, DocsBlockCodePropertyData> {
15
+ type: DocsBlockItemPropertyType.code;
6
16
  }
@@ -1,6 +1,16 @@
1
- import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
1
+ import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
2
+ import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
3
+ /** Code Sandbox property - Additional non-value options */
2
4
  export type DocsBlockCodeSandboxPropertyOptions = Record<string, never>;
5
+ /** Code Sandbox property - Data */
6
+ export type DocsBlockCodeSandboxPropertyData = DocsBlockPropertyData<string> & {
7
+ showCode?: boolean;
8
+ backgroundColor?: string;
9
+ alignPreview?: "left" | "center";
10
+ };
11
+ /** Code Sandbox property - Definition model */
3
12
  export type DocsBlockCodeSandboxPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockCodeSandboxPropertyOptions;
4
- /** CodeSandbox property */
5
- export declare class DocsBlockCodeSandboxPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockCodeSandboxPropertyOptions> {
13
+ /** Code Sandbox property - Definition */
14
+ export declare class DocsBlockCodeSandboxPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockCodeSandboxPropertyOptions, DocsBlockCodeSandboxPropertyData> {
15
+ type: DocsBlockItemPropertyType.codeSandbox;
6
16
  }
@@ -1,6 +1,18 @@
1
- import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
1
+ import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
2
+ import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
3
+ /** Component property - Additional non-value options */
2
4
  export type DocsBlockComponentPropertyOptions = Record<string, never>;
5
+ /** Component property - Data */
6
+ export type DocsBlockComponentPropertyData = DocsBlockPropertyData<Array<{
7
+ entityId: string;
8
+ entityType: "component" | "componentGroup";
9
+ }>> & {
10
+ /** Selected component ids */
11
+ selectedPropertyIds?: Array<string>;
12
+ };
13
+ /** Component property - Definition model */
3
14
  export type DocsBlockComponentPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockComponentPropertyOptions;
4
- /** Component property */
5
- export declare class DocsBlockComponentPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockComponentPropertyOptions> {
15
+ /** Component property - Definition */
16
+ export declare class DocsBlockComponentPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockComponentPropertyOptions, DocsBlockComponentPropertyData> {
17
+ type: DocsBlockItemPropertyType.component;
6
18
  }
@@ -1,6 +1,12 @@
1
- import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
1
+ import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
2
+ import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
3
+ /** ComponentProperty property - Additional non-value options */
2
4
  export type DocsBlockComponentPropertyPropertyOptions = Record<string, never>;
5
+ /** ComponentProperty property - Data */
6
+ export type DocsBlockComponentPropertyPropertyData = DocsBlockPropertyData<string> & Record<string, never>;
7
+ /** ComponentProperty property - Definition model */
3
8
  export type DocsBlockComponentPropertyPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockComponentPropertyPropertyOptions;
4
- /** ComponentProperty property */
5
- export declare class DocsBlockComponentPropertyPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockComponentPropertyPropertyOptions> {
9
+ /** ComponentProperty property - Definition */
10
+ export declare class DocsBlockComponentPropertyPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockComponentPropertyPropertyOptions, DocsBlockComponentPropertyPropertyData> {
11
+ type: DocsBlockItemPropertyType.componentProperty;
6
12
  }
@@ -1,6 +1,12 @@
1
- import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
1
+ import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
2
+ import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
3
+ /** Divider property - Additional non-value options */
2
4
  export type DocsBlockDividerPropertyOptions = Record<string, never>;
5
+ /** Divider property - Data */
6
+ export type DocsBlockDividerPropertyData = DocsBlockPropertyData<never> & Record<string, never>;
7
+ /** Divider property - Definition model */
3
8
  export type DocsBlockDividerPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockDividerPropertyOptions;
4
- /** Divider property */
5
- export declare class DocsBlockDividerPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockDividerPropertyOptions> {
9
+ /** Divider property - Definition */
10
+ export declare class DocsBlockDividerPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockDividerPropertyOptions, DocsBlockDividerPropertyData> {
11
+ type: DocsBlockItemPropertyType.divider;
6
12
  }
@@ -1,4 +1,6 @@
1
- import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
1
+ import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
2
+ import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
3
+ /** EmbedUrl property - Additional non-value options */
2
4
  export type DocsBlockEmbedUrlPropertyOptions = {
3
5
  /** Defines what should be the default height of the embed */
4
6
  defaultHeight: number;
@@ -9,7 +11,14 @@ export type DocsBlockEmbedUrlPropertyOptions = {
9
11
  /** Defined how to validate the embed URL */
10
12
  urlValidationRegex?: string;
11
13
  };
14
+ /** EmbedUrl property - Data */
15
+ export type DocsBlockEmbedUrlPropertyData = DocsBlockPropertyData<string> & {
16
+ caption?: string;
17
+ height?: number;
18
+ };
19
+ /** EmbedUrl property - Definition model */
12
20
  export type DocsBlockEmbedUrlPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockEmbedUrlPropertyOptions;
13
- /** EmbedUrl property */
14
- export declare class DocsBlockEmbedUrlPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockEmbedUrlPropertyOptions> {
21
+ /** EmbedUrl property - Definition */
22
+ export declare class DocsBlockEmbedUrlPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockEmbedUrlPropertyOptions, DocsBlockEmbedUrlPropertyData> {
23
+ type: DocsBlockItemPropertyType.embedURL;
15
24
  }
@@ -1,15 +1,25 @@
1
+ import { Alignment } from "../../../enums/SDKAlignment";
1
2
  import { DocsBlockImagePropertyAspectRatio } from "../../../enums/SDKDocsBlockImagePropertyAspectRatio";
2
3
  import { DocsBlockImagePropertyWidth } from "../../../enums/SDKDocsBlockImagePropertyWidth";
3
- import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
4
+ import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
5
+ import { DocsImageRef } from "../support/SDKDocsImageRef";
6
+ import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
7
+ /** Image property - Additional non-value options */
4
8
  export type DocsBlockImagePropertyOptions = {
5
9
  width?: DocsBlockImagePropertyWidth;
6
10
  aspectRatio?: DocsBlockImagePropertyAspectRatio;
7
11
  allowCaption?: boolean;
8
12
  recommendation?: string;
9
13
  };
10
- export type DocsBlockImagePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
11
- options: DocsBlockImagePropertyOptions;
14
+ /** Image property - Data */
15
+ export type DocsBlockImagePropertyData = DocsBlockPropertyData<DocsImageRef | undefined> & {
16
+ alt: string;
17
+ caption?: string;
18
+ alignment?: Alignment;
12
19
  };
13
- /** Image property */
14
- export declare class DocsBlockImagePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockImagePropertyOptions> {
20
+ /** Image property - Definition model */
21
+ export type DocsBlockImagePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockImagePropertyOptions;
22
+ /** Image property - Definition */
23
+ export declare class DocsBlockImagePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockImagePropertyOptions, DocsBlockImagePropertyData> {
24
+ type: DocsBlockItemPropertyType.image;
15
25
  }
@@ -1,11 +1,12 @@
1
- import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
1
+ import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
2
+ import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
3
+ /** Markdown property - Additional non-value options */
2
4
  export type DocsBlockMarkdownPropertyOptions = Record<string, never>;
3
- export type DocsBlockMarkdownPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
4
- options: DocsBlockMarkdownPropertyOptions;
5
- variantOptions?: {
6
- [key: string]: DocsBlockMarkdownPropertyOptions;
7
- };
8
- };
9
- /** Markdown property */
10
- export declare class DocsBlockMarkdownPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockMarkdownPropertyOptions> {
5
+ /** Markdown property - Data */
6
+ export type DocsBlockMarkdownPropertyData = DocsBlockPropertyData<string> & Record<string, never>;
7
+ /** Markdown property - Definition model */
8
+ export type DocsBlockMarkdownPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockMarkdownPropertyOptions;
9
+ /** Markdown property - Definition */
10
+ export declare class DocsBlockMarkdownPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockMarkdownPropertyOptions, DocsBlockMarkdownPropertyData> {
11
+ type: DocsBlockItemPropertyType.markdown;
11
12
  }
@@ -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
- export type DocsBlockMultiSelectPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
13
- options: DocsBlockMultiSelectPropertyOptions;
14
- variantOptions?: {
15
- [key: string]: DocsBlockMultiSelectPropertyOptions;
16
- };
17
- };
18
- /** MultiSelect property */
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
  }
@@ -1,4 +1,6 @@
1
- import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
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
  }
@@ -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
- export type DocsBlockRichTextPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
11
- options: DocsBlockRichTextPropertyOptions;
12
- variantOptions?: {
13
- [key: string]: DocsBlockRichTextPropertyOptions;
14
- };
15
- };
16
- /** RichText property */
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
  }
@@ -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
- export type DocsBlockSingleSelectPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
19
- options: DocsBlockSingleSelectPropertyOptions;
20
- variantOptions?: {
21
- [key: string]: DocsBlockSingleSelectPropertyOptions;
22
- };
23
- };
24
- /** SingleSelect property */
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
  }
@@ -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
- export type DocsBlockEmbedUrlPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockStorybookPropertyOptions;
4
- /** EmbedUrl property */
5
- export declare class DocsBlockStorybookPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockStorybookPropertyOptions> {
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
  }
@@ -1,11 +1,17 @@
1
- import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
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
- export type DocsBlockTablePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
4
- options: DocsBlockTablePropertyOptions;
5
- variantOptions?: {
6
- [key: string]: DocsBlockTablePropertyOptions;
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 declare class DocsBlockTablePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTablePropertyOptions> {
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
- export type DocsBlockTextPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
15
- options: DocsBlockTextPropertyOptions;
16
- variantOptions?: {
17
- [key: string]: DocsBlockTextPropertyOptions;
18
- };
19
- };
20
- /** Text property */
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
  }
@@ -1,15 +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";
10
+ /** Whether to allow selecting token custom properties. True by default */
11
+ allowPropertySelection?: boolean;
12
+ /** Whether to allow selecting themes. True by default */
13
+ allowThemeSelection?: boolean;
6
14
  };
7
- export type DocsBlockTokenPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
8
- options: DocsBlockTokenPropertyOptions;
9
- variantOptions?: {
10
- [key: string]: DocsBlockTokenPropertyOptions;
11
- };
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>;
12
24
  };
13
- /** Token property */
14
- export declare class DocsBlockTokenPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTokenPropertyOptions> {
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;
15
30
  }
@@ -1,11 +1,12 @@
1
- import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
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
- export type DocsBlockTokenPropertyPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
4
- options: DocsBlockTokenPropertyPropertyOptions;
5
- variantOptions?: {
6
- [key: string]: DocsBlockTokenPropertyPropertyOptions;
7
- };
8
- };
9
- /** TokenProperty property */
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
  }
@@ -1,11 +1,15 @@
1
- import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
2
- export type DocsBlockTokenTypePropertyOptions = Record<string, never>;
3
- export type DocsBlockTokenTypePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & {
4
- options: DocsBlockTokenTypePropertyOptions;
5
- variantOptions?: {
6
- [key: string]: DocsBlockTokenTypePropertyOptions;
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
- /** Token type property */
10
- export declare class DocsBlockTokenTypePropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockTokenTypePropertyOptions> {
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
- layoutId?: string;
6
+ variantId?: string;
9
7
  indentLevel: number;
10
8
  appearance?: {
11
9
  itemBackgroundColor?: DocsColorRef;
12
10
  };
13
- staticData?: Array<{
14
- [key: string]: DocsBlockStaticDataValue;
15
- link?: DocsLinkRef;
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 layout variant */
29
- layoutId: string | null;
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
- staticData: Array<{
37
+ data: Array<{
43
38
  /** Dynamic key coming from property.id block definition */
44
- [key: string]: DocsBlockStaticDataValue;
39
+ props: {
40
+ [key: string]: object;
41
+ };
45
42
  /** Link where the item points to, if any. Must be enabled in behaviors */
46
- link?: DocsLinkRef;
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
  }
@@ -13,7 +13,7 @@ export declare class DocumentationLegacyGroup extends DocumentationLegacyItem {
13
13
  /** IDs of items belonging to the documentation group. Can be page or group */
14
14
  childrenIds: Array<string>;
15
15
  /** Items belonging to the documentation group. Can be page or group */
16
- children: Array<DocumentationLegacyItem>;
16
+ children: Array<DocumentationLegacyGroup | DocumentationLegacyPage>;
17
17
  type: DocumentationLegacyItemType.group;
18
18
  /** Parent group reference */
19
19
  parent: DocumentationLegacyGroup | null;
@@ -28,8 +28,8 @@ export declare class DocumentationLegacyGroup extends DocumentationLegacyItem {
28
28
  /** Internal */
29
29
  deployedFirstPageUrl: string | null;
30
30
  constructor(model: DocumentationLegacyGroupModel);
31
- addChild(item: DocumentationLegacyItem): void;
32
- addChildren(groups: Array<DocumentationLegacyItem>): void;
31
+ addChild(item: DocumentationLegacyGroup | DocumentationLegacyPage): void;
32
+ addChildren(groups: Array<DocumentationLegacyGroup | DocumentationLegacyPage>): void;
33
33
  setParent(parent: DocumentationLegacyGroup | null): void;
34
34
  /** Internal: Modifies object with new paths. Don't use outside SDK environment as it doesn't propagate the data back to source */
35
35
  internalOverridePaths(relative: string | null, deployed: string | null): void;
@@ -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: string;
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: string;
4
+ id?: string;
5
5
  sourceId: string;
6
6
  sourceFrameId: string;
7
7
  title?: string;