@supernova-studio/supernova-sdk-beta 1.6.31 → 1.6.32

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 (81) hide show
  1. package/build/sdk-typescript/.eslintrc.d.cts +41 -0
  2. package/build/sdk-typescript/src/core/SDKSupernova.d.ts +4 -0
  3. package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +1 -14
  4. package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +34 -1
  5. package/build/sdk-typescript/src/core/areas/SDKAreaMultiplayer.d.ts +10 -0
  6. package/build/sdk-typescript/src/core/areas/SDKAreaResources.d.ts +6 -2
  7. package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +4 -1
  8. package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +18 -19
  9. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +7 -7
  10. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +9 -8
  11. package/build/sdk-typescript/src/core/resolvers/SDKAssetGroupResolver.d.ts +4 -0
  12. package/build/sdk-typescript/src/core/resolvers/SDKTokenResolver.d.ts +1 -1
  13. package/build/sdk-typescript/src/exports.d.ts +9 -1
  14. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockBehavior.d.ts +2 -11
  15. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockDefinition.d.ts +5 -21
  16. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockItemDefinition.d.ts +3 -10
  17. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockLayout.d.ts +2 -7
  18. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockVariant.d.ts +2 -15
  19. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts +1 -1
  20. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts +1 -1
  21. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts +2 -2
  22. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockColorProperty.d.ts +13 -0
  23. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts +2 -2
  24. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty.d.ts +19 -0
  25. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty.d.ts +1 -1
  26. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockProperty.d.ts +2 -10
  27. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts +3 -3
  28. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts +1 -1
  29. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +10 -1
  30. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTableProperty.d.ts +23 -2
  31. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +1 -1
  32. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +2 -2
  33. package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsImageRef.d.ts +5 -2
  34. package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsLinkRef.d.ts +10 -7
  35. package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlock.d.ts +7 -20
  36. package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlockItem.d.ts +2 -7
  37. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityHeader.d.ts +3 -0
  38. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageAsset.d.ts +1 -1
  39. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockRenderCode.d.ts +1 -1
  40. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +5 -1
  41. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutAlign.d.ts +3 -3
  42. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutColumnResizing.d.ts +2 -2
  43. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutGap.d.ts +4 -4
  44. package/build/sdk-typescript/src/model/enums/SDKDocsBlockMultiRichTextPropertyStyle.d.ts +8 -0
  45. package/build/sdk-typescript/src/model/enums/SDKDocsBlockRichTextPropertyStyle.d.ts +0 -4
  46. package/build/sdk-typescript/src/model/enums/SDKDocsPublishStatus.d.ts +4 -0
  47. package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts +19 -19
  48. package/build/sdk-typescript/src/model/enums/SDKUserRole.d.ts +2 -2
  49. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuild.d.ts +6 -0
  50. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuildResults.d.ts +12 -0
  51. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportDestinations.d.ts +16 -1
  52. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteConnectionsModel.d.ts +1 -1
  53. package/build/sdk-typescript/src/model/groups/SDKAssetGroup.d.ts +4 -0
  54. package/build/sdk-typescript/src/model/resources/SDKResourceFont.d.ts +2 -2
  55. package/build/sdk-typescript/src/model/support/SDKFigmaFrame.d.ts +2 -0
  56. package/build/sdk-typescript/src/model/support/SDKSource.d.ts +10 -4
  57. package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +1 -1
  58. package/build/sdk-typescript/src/model/themes/SDKTokenTheme.d.ts +6 -6
  59. package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +6 -6
  60. package/build/sdk-typescript/src/model/tokens/SDKColorToken.d.ts +1 -0
  61. package/build/sdk-typescript/src/model/tokens/SDKDimensionToken.d.ts +1 -1
  62. package/build/sdk-typescript/src/model/tokens/SDKStringToken.d.ts +1 -1
  63. package/build/sdk-typescript/src/model/tokens/SDKTextCaseToken.d.ts +1 -1
  64. package/build/sdk-typescript/src/model/tokens/SDKTextDecorationToken.d.ts +1 -1
  65. package/build/sdk-typescript/src/model/tokens/SDKTokenValue.d.ts +2 -2
  66. package/build/sdk-typescript/src/tests/FigmaTokensDataLoader.d.ts +3 -3
  67. package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +2 -1
  68. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONParser.d.ts +1 -1
  69. package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTGroupTree.d.ts +1 -1
  70. package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +11 -0
  71. package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementFigmaTokensTransformer.d.ts +1 -1
  72. package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementTransformer.d.ts +1 -1
  73. package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewGenerator.d.ts +4 -1
  74. package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewStyleGenerator.d.ts +4 -1
  75. package/build/sdk-typescript/src/utils/CommonUtils.d.ts +5 -0
  76. package/build/sdk-typescript/src/utils/TokenUtils.d.ts +3 -3
  77. package/build/sdk-typescript/src/utils/deepPartial.d.ts +3 -0
  78. package/build/supernova-sdk-typescript.js +1 -1
  79. package/build/supernova-sdk-typescript.js.LICENSE.txt +0 -14
  80. package/build/supernova-sdk-typescript.js.map +1 -1
  81. package/package.json +118 -118
@@ -0,0 +1,13 @@
1
+ import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
2
+ import { ColorTokenValue } from "../../../tokens/SDKTokenValue";
3
+ import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
4
+ /** Color property - Additional non-value options */
5
+ export type DocsBlockColorPropertyOptions = Record<string, never>;
6
+ /** Color property - Data */
7
+ export type DocsBlockColorPropertyData = DocsBlockPropertyData<ColorTokenValue> & Record<string, never>;
8
+ /** Color property - Definition model */
9
+ export type DocsBlockColorPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockColorPropertyOptions;
10
+ /** Color property - Definition */
11
+ export declare class DocsBlockColorPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockColorPropertyOptions, DocsBlockColorPropertyData> {
12
+ type: DocsBlockItemPropertyType.color;
13
+ }
@@ -3,14 +3,14 @@ import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDe
3
3
  /** Component property - Additional non-value options */
4
4
  export type DocsBlockComponentPropertyOptions = {
5
5
  /** How should the tokens be rendered in editor */
6
- renderLayoutAs?: "list" | "table";
6
+ renderLayoutAs?: "List" | "Table";
7
7
  /** Whether to allow selecting component custom properties. True by default */
8
8
  allowPropertySelection?: boolean;
9
9
  };
10
10
  /** Component property - Data */
11
11
  export type DocsBlockComponentPropertyData = DocsBlockPropertyData<Array<{
12
12
  entityId: string;
13
- entityType: "component" | "componentGroup";
13
+ entityType: "Component" | "ComponentGroup";
14
14
  }>> & {
15
15
  /** Selected component ids */
16
16
  selectedPropertyIds?: Array<string>;
@@ -0,0 +1,19 @@
1
+ import { DocumentationLegacyRichTextModel } from "../../../documentation/SDKDocumentationLegacyRichText";
2
+ import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
3
+ import { DocsBlockMultiRichTextPropertyStyle } from "../../../enums/SDKDocsBlockMultiRichTextPropertyStyle";
4
+ import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
5
+ /** RichText property - Additional non-value options */
6
+ export type DocsBlockMultiRichTextPropertyOptions = {
7
+ /** Placeholder to show when rich text area is empty */
8
+ placeholder?: string;
9
+ /** Visual style of the rich text property */
10
+ multiRichTextStyle?: DocsBlockMultiRichTextPropertyStyle;
11
+ };
12
+ /** RichText property - Data */
13
+ export type DocsBlockMultiRichTextPropertyData = DocsBlockPropertyData<Array<DocumentationLegacyRichTextModel>>;
14
+ /** RichText property - Definition model */
15
+ export type DocsBlockRichTextPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockMultiRichTextPropertyOptions;
16
+ /** RichText property - Definition */
17
+ export declare class DocsBlockMultiRichTextPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockMultiRichTextPropertyOptions, DocsBlockMultiRichTextPropertyData> {
18
+ type: DocsBlockItemPropertyType.multiRichText;
19
+ }
@@ -9,7 +9,7 @@ export type DocsBlockMultiSelectPropertyOptions = {
9
9
  name: string;
10
10
  icon?: string;
11
11
  }>;
12
- style?: Exclude<DocsBlockOptionRenderingStyle, DocsBlockOptionRenderingStyle.toggleButton>;
12
+ multiSelectStyle?: Exclude<DocsBlockOptionRenderingStyle, DocsBlockOptionRenderingStyle.toggleButton>;
13
13
  };
14
14
  /** MultiSelect property - Data */
15
15
  export type DocsBlockMultiSelectPropertyData = DocsBlockPropertyData<Array<string>> & Record<string, never>;
@@ -1,14 +1,6 @@
1
+ import { PageBlockDefinitionProperty } from "@supernova-studio/model";
1
2
  import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
2
- export type DocsBlockPropertyDefinitionModel = {
3
- id: string;
4
- name: string;
5
- type: DocsBlockItemPropertyType;
6
- description?: string;
7
- options?: object | Record<string, never>;
8
- variantOptions?: {
9
- [key: string]: object | Record<string, never>;
10
- };
11
- };
3
+ export type DocsBlockPropertyDefinitionModel = PageBlockDefinitionProperty;
12
4
  export type DocsBlockPropertyData<T> = {
13
5
  value: T;
14
6
  };
@@ -1,4 +1,4 @@
1
- import { RichTextSpan } from "../../../documentation/SDKDocumentationLegacyRichTextSpan";
1
+ import { DocumentationLegacyRichTextModel } from "../../../documentation/SDKDocumentationLegacyRichText";
2
2
  import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
3
3
  import { DocsBlockRichTextPropertyStyle } from "../../../enums/SDKDocsBlockRichTextPropertyStyle";
4
4
  import { DocumentationLegacyCalloutType } from "../../../enums/SDKDocumentationLegacyCalloutType";
@@ -8,10 +8,10 @@ export type DocsBlockRichTextPropertyOptions = {
8
8
  /** Placeholder to show when rich text area is empty */
9
9
  placeholder?: string;
10
10
  /** Visual style of the rich text property */
11
- style?: DocsBlockRichTextPropertyStyle;
11
+ richTextStyle?: DocsBlockRichTextPropertyStyle;
12
12
  };
13
13
  /** RichText property - Data */
14
- export type DocsBlockRichTextPropertyData = DocsBlockPropertyData<Array<RichTextSpan>> & {
14
+ export type DocsBlockRichTextPropertyData = DocsBlockPropertyData<DocumentationLegacyRichTextModel> & {
15
15
  /** Selected token ids */
16
16
  calloutType?: DocumentationLegacyCalloutType;
17
17
  };
@@ -15,7 +15,7 @@ export type DocsBlockSingleSelectPropertyOptions = {
15
15
  icon?: string;
16
16
  }>;
17
17
  /** Visual representation of the property */
18
- style?: DocsBlockOptionRenderingStyle;
18
+ singleSelectStyle?: DocsBlockOptionRenderingStyle;
19
19
  };
20
20
  /** SingleSelect property - Data */
21
21
  export type DocsBlockSingleSelectPropertyData = DocsBlockPropertyData<string> & Record<string, never>;
@@ -1,6 +1,15 @@
1
1
  import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
2
2
  /** Storybook property - Additional non-value options */
3
- export type DocsBlockStorybookPropertyOptions = Record<string, never>;
3
+ export type DocsBlockStorybookPropertyOptions = {
4
+ /** Defines what should be the default height of the embed */
5
+ defaultHeight: number;
6
+ /** If enabled, additional text can be provided for the embed property */
7
+ allowCaption?: boolean;
8
+ /** If enabled, the embed can be resized */
9
+ allowResize?: boolean;
10
+ /** Defined how to validate the embed URL */
11
+ urlValidationRegex?: string;
12
+ };
4
13
  /** Storybook property - Data */
5
14
  export type DocsBlockStorybookPropertyData = DocsBlockPropertyData<string> & {
6
15
  caption?: string;
@@ -1,13 +1,34 @@
1
+ import { DocumentationLegacyRichTextModel } from "../../../documentation/SDKDocumentationLegacyRichText";
1
2
  import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
3
+ import { DocsImageRef } from "../support/SDKDocsImageRef";
2
4
  import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
3
5
  /** Table property - Additional non-value options */
4
6
  export type DocsBlockTablePropertyOptions = Record<string, never>;
7
+ export type DocsBlockTableRichTextNode = {
8
+ type: "RichText";
9
+ value: DocumentationLegacyRichTextModel;
10
+ };
11
+ export type DocsBlockTableImageNode = {
12
+ type: "Image";
13
+ value: DocsImageRef;
14
+ };
15
+ export type DocsBlockTableMultiRichTextNode = {
16
+ type: "MultiRichText";
17
+ value: Array<DocumentationLegacyRichTextModel>;
18
+ };
19
+ export type DocsBlockTableNode = DocsBlockTableRichTextNode | DocsBlockTableImageNode | DocsBlockTableMultiRichTextNode;
5
20
  /** Table property - Data */
6
- export type DocsBlockTablePropertyData = DocsBlockPropertyData<any> & {
21
+ export type DocsBlockTablePropertyData = DocsBlockPropertyData<Array<{
22
+ cells: {
23
+ id: string;
24
+ alignment: "Left" | "Center" | "Right";
25
+ columnWidth: number;
26
+ nodes: Array<DocsBlockTableNode>;
27
+ };
28
+ }>> & {
7
29
  highlightHeaderColumn?: boolean;
8
30
  highlightHeaderRow?: boolean;
9
31
  showBorder?: boolean;
10
- width?: number;
11
32
  };
12
33
  /** Table property - Definition model */
13
34
  export type DocsBlockTablePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockTablePropertyOptions;
@@ -9,7 +9,7 @@ export type DocsBlockTextPropertyOptions = {
9
9
  /** Default value to set when block is created */
10
10
  defaultValue?: string;
11
11
  /** Visual style of the text property */
12
- style: DocsBlockTextPropertyStyle;
12
+ textStyle: DocsBlockTextPropertyStyle;
13
13
  /** Text color */
14
14
  color?: DocsBlockTextPropertyColor;
15
15
  };
@@ -6,7 +6,7 @@ export type DocsBlockTokenPropertyOptions = {
6
6
  /** Token types that are allowed to be selected. All types allowed if nothing is provided */
7
7
  allowedTypes?: Array<TokenType>;
8
8
  /** How should the tokens be rendered in editor */
9
- renderLayoutAs?: "grid" | "list";
9
+ renderLayoutAs?: "Grid" | "List";
10
10
  /** Whether to allow selecting token custom properties. True by default */
11
11
  allowPropertySelection?: boolean;
12
12
  /** Whether to allow selecting themes. True by default */
@@ -15,7 +15,7 @@ export type DocsBlockTokenPropertyOptions = {
15
15
  /** Token property - Data */
16
16
  export type DocsBlockTokenPropertyData = DocsBlockPropertyData<Array<{
17
17
  entityId: string;
18
- entityType: "token" | "tokenGroup";
18
+ entityType: "Token" | "TokenGroup";
19
19
  }>> & {
20
20
  /** Selected token ids */
21
21
  selectedPropertyIds?: Array<string>;
@@ -6,8 +6,11 @@ export type DocsImageRef = {
6
6
  url: string;
7
7
  /** Referenced asset, if any */
8
8
  assetId?: string;
9
- /** Referenced frame, if any */
10
- frameId?: string;
9
+ /** Referenced Figma file, if any */
10
+ figmaFile?: {
11
+ sourceId: string;
12
+ frameId: string;
13
+ };
11
14
  /** Image size, if known */
12
15
  size?: {
13
16
  width?: number;
@@ -3,19 +3,22 @@ export type DocsLinkRef = {
3
3
  /** Ref type */
4
4
  type: DocsLinkRefType;
5
5
  /** Referenced page */
6
- pageId?: string;
6
+ documentationItemId?: string;
7
7
  /** Referenced page block - heading */
8
8
  pageHeadingId?: string;
9
- /** Referenced page group */
10
- groupId?: string;
11
9
  /** Referenced URL */
12
10
  url?: string;
13
11
  /** Open in other tab */
14
12
  openInNewTab?: boolean;
15
13
  };
16
14
  export declare enum DocsLinkRefType {
17
- page = "Page",
18
- pageHeading = "pageHeading",
19
- group = "Group",
20
- url = "url"
15
+ documentationItem = "DocumentationItem",
16
+ pageHeading = "PageHeading",
17
+ url = "Url"
21
18
  }
19
+ export declare function docsLinkToUrl(link: DocsLinkRef): string | undefined;
20
+ export declare function docsLinkToLinkAttributes(link: DocsLinkRef): {
21
+ href: string;
22
+ target: string;
23
+ } | undefined;
24
+ export declare function linkAttributeToDocsLink(href: string | null | undefined, target: string | null | undefined): DocsLinkRef | undefined;
@@ -1,23 +1,8 @@
1
+ import { PageBlockEditorModel } from "@supernova-studio/client";
1
2
  import { DocsColorRef } from "../support/SDKDocsColorRef";
2
3
  import { DocsLinkRef } from "../support/SDKDocsLinkRef";
3
4
  import { DocsBlockItem } from "./SDKDocsBlockItem";
4
- export type DocsBlockModel = {
5
- id: string;
6
- packageId: string;
7
- variantId?: string;
8
- indentLevel: number;
9
- appearance?: {
10
- itemBackgroundColor?: DocsColorRef;
11
- };
12
- data?: Array<DocsBlockItemDefinitionModel>;
13
- };
14
- export type DocsBlockItemDefinitionModel = {
15
- id: string;
16
- props: {
17
- [key: string]: object;
18
- };
19
- linksTo?: DocsLinkRef;
20
- };
5
+ export type DocsBlockModel = PageBlockEditorModel;
21
6
  export declare class DocsBlock {
22
7
  /** Unique identifier of the block */
23
8
  id: string;
@@ -31,6 +16,8 @@ export declare class DocsBlock {
31
16
  appearance: {
32
17
  /** Background color of all items of the block. Can be further overriden on every item */
33
18
  itemBackgroundColor: DocsColorRef | null;
19
+ /** Number of columns */
20
+ numberOfColumns?: number;
34
21
  };
35
22
  /** Data of all items of the block */
36
23
  data: Array<DocsBlockItem>;
@@ -52,9 +39,9 @@ export declare class DocsBlock {
52
39
  /** Update data for property of specific key and index */
53
40
  updatePropertyDataForSingleItem(propertyId: string, data: object): void;
54
41
  /** Update link for item at specific index */
55
- updateLinkForItemAtIndex(index: number, link: DocsLinkRef | null): void;
42
+ updateLinkForItemAtIndex(index: number, link: DocsLinkRef | undefined): void;
56
43
  /** Update link for item at specific index */
57
- updateLinkForSingleItem(link: DocsLinkRef | null): void;
44
+ updateLinkForSingleItem(link: DocsLinkRef | undefined): void;
58
45
  /** Constructs representation that can be used to write full object to remote */
59
- toRemote(): DocsBlockModel;
46
+ toRemote(): PageBlockEditorModel;
60
47
  }
@@ -1,11 +1,6 @@
1
+ import { PageBlockItemV2 } from "@supernova-studio/model";
1
2
  import { DocsLinkRef } from "../support/SDKDocsLinkRef";
2
- export type DocsBlockItemModel = {
3
- id: string;
4
- props: {
5
- [key: string]: object;
6
- };
7
- linksTo?: DocsLinkRef;
8
- };
3
+ export type DocsBlockItemModel = PageBlockItemV2;
9
4
  export declare class DocsBlockItem {
10
5
  /** Unique identifier of the block item */
11
6
  id: string;
@@ -1,11 +1,13 @@
1
1
  import { Alignment } from "../../enums/SDKAlignment";
2
2
  import { AssetScaleType } from "../../enums/SDKAssetScaleType";
3
3
  import { DocsColorRef } from "../blocks/support/SDKDocsColorRef";
4
+ import { DocsImageRef } from "../blocks/support/SDKDocsImageRef";
4
5
  export type DocsEntityHeaderModel = {
5
6
  description: string;
6
7
  alignment: Alignment;
7
8
  foregroundColor?: DocsColorRef;
8
9
  backgroundColor?: DocsColorRef;
10
+ backgroundImageAsset?: DocsImageRef;
9
11
  backgroundImageScaleType: AssetScaleType;
10
12
  showBackgroundOverlay: boolean;
11
13
  showCoverText: boolean;
@@ -16,6 +18,7 @@ export declare class DocsEntityHeader {
16
18
  alignment: Alignment;
17
19
  foregroundColor: DocsColorRef | null;
18
20
  backgroundColor: DocsColorRef | null;
21
+ backgroundImage: DocsImageRef | null;
19
22
  showBackgroundOverlay: boolean;
20
23
  showCoverText: boolean;
21
24
  minHeight: number | null;
@@ -10,7 +10,7 @@ export type DocumentationLegacyPageAssetModel = {
10
10
  figmaFrame?: DocumentationLegacyPageBlockFrameModel;
11
11
  };
12
12
  export declare class DocumentationLegacyPageAsset {
13
- id: string;
13
+ id?: string;
14
14
  persistentId: string | null;
15
15
  sourceId: string | null;
16
16
  sourceFrameId: string | null;
@@ -27,7 +27,7 @@ export declare class DocumentationLegacyPageBlockRenderCode extends Documentatio
27
27
  sandboxType: DocumentationLegacyPageBlockRenderCodeEnvironmentType;
28
28
  constructor(model: DocumentationLegacyPageBlockRenderCodeModel, children: Array<DocumentationLegacyPageBlock>, configuration: DocumentationLegacyConfiguration);
29
29
  private encodeSandboxData;
30
- btoaUnicode(str: any): string;
30
+ btoaUnicode(str: any): string | null;
31
31
  atobUnicode(str: any): string;
32
32
  }
33
33
  export {};
@@ -1,6 +1,8 @@
1
1
  export declare enum DocsBlockItemPropertyType {
2
2
  /** Rich text property allows user to input rich text (with additional attributes like bold, links etc.) */
3
3
  richText = "RichText",
4
+ /** Rich text property allows user to input multiple paragraphs of rich text (with additional attributes like bold, links etc.) */
5
+ multiRichText = "MultiRichText",
4
6
  /** Text property allows user to input plain text */
5
7
  text = "Text",
6
8
  /** Boolean property allows user to input true/false value */
@@ -45,5 +47,7 @@ export declare enum DocsBlockItemPropertyType {
45
47
  /** Divider property that puts visual divider into the block. It has no user input */
46
48
  divider = "Divider",
47
49
  /** Storybook property allows user to add Storybook story to render */
48
- storybook = "Storybook"
50
+ storybook = "Storybook",
51
+ /** Color property allows users to select color for further use */
52
+ color = "Color"
49
53
  }
@@ -1,8 +1,8 @@
1
1
  export declare enum DocsBlockItemVariantLayoutAlign {
2
2
  /** Vertically on top */
3
- start = "start",
3
+ start = "Start",
4
4
  /** Vertically centered */
5
- center = "center",
5
+ center = "Center",
6
6
  /** Vertically on the bottom */
7
- end = "end"
7
+ end = "End"
8
8
  }
@@ -1,6 +1,6 @@
1
1
  export declare enum DocsBlockItemVariantLayoutColumnResizing {
2
2
  /** Will fill all available space for the column */
3
- fill = "fill",
3
+ fill = "Fill",
4
4
  /** Will hug content inside the column */
5
- hug = "hug"
5
+ hug = "Hug"
6
6
  }
@@ -1,10 +1,10 @@
1
1
  export declare enum DocsBlockItemVariantLayoutGap {
2
2
  /** small gap between columns/row */
3
- small = "small",
3
+ small = "Small",
4
4
  /** medium gap between columns/row */
5
- medium = "medium",
5
+ medium = "Medium",
6
6
  /** large gap between columns/row */
7
- large = "large",
7
+ large = "Large",
8
8
  /** no gap between columns/row */
9
- none = "none"
9
+ none = "None"
10
10
  }
@@ -0,0 +1,8 @@
1
+ export declare enum DocsBlockMultiRichTextPropertyStyle {
2
+ /** Ordered list */
3
+ ol = "OL",
4
+ /** Unordered list */
5
+ ul = "UL",
6
+ /** Default option */
7
+ default = "Default"
8
+ }
@@ -13,10 +13,6 @@ export declare enum DocsBlockRichTextPropertyStyle {
13
13
  quote = "Quote",
14
14
  /** Callout */
15
15
  callout = "Callout",
16
- /** Ordered list */
17
- ol = "OL",
18
- /** Unordered list */
19
- ul = "UL",
20
16
  /** Default option */
21
17
  default = "Default"
22
18
  }
@@ -0,0 +1,4 @@
1
+ export declare enum DocsPublishStatus {
2
+ idle = 0,
3
+ inProgress = 1
4
+ }
@@ -1,29 +1,29 @@
1
1
  export declare enum TokenType {
2
2
  color = "Color",
3
3
  typography = "Typography",
4
- dimension = "Dimension",
5
- size = "Size",
6
- space = "Space",
7
- opacity = "Opacity",
4
+ shadow = "Shadow",
5
+ border = "Border",
6
+ gradient = "Gradient",
7
+ blur = "Blur",
8
+ radius = "BorderRadius",
9
+ borderWidth = "BorderWidth",
10
+ duration = "Duration",
8
11
  fontSize = "FontSize",
9
- lineHeight = "LineHeight",
12
+ dimension = "Dimension",
10
13
  letterSpacing = "LetterSpacing",
14
+ lineHeight = "LineHeight",
15
+ opacity = "Opacity",
11
16
  paragraphSpacing = "ParagraphSpacing",
12
- borderWidth = "BorderWidth",
13
- radius = "BorderRadius",
14
- duration = "Duration",
17
+ size = "Size",
18
+ space = "Space",
15
19
  zIndex = "ZIndex",
16
- shadow = "Shadow",
17
- border = "Border",
18
- gradient = "Gradient",
19
- string = "String",
20
- productCopy = "ProductCopy",
21
- fontFamily = "FontFamily",
22
- fontWeight = "FontWeight",
23
- textCase = "TextCase",
24
20
  textDecoration = "TextDecoration",
21
+ textCase = "TextCase",
25
22
  visibility = "Visibility",
26
- blur = "Blur"
23
+ fontFamily = "FontFamily",
24
+ fontWeight = "FontWeight",
25
+ string = "String",
26
+ productCopy = "ProductCopy"
27
27
  }
28
28
  export declare const STRING_TOKEN_TYPES: readonly [TokenType.string, TokenType.productCopy, TokenType.fontFamily, TokenType.fontWeight];
29
29
  export type StringTokenType = (typeof STRING_TOKEN_TYPES)[number];
@@ -37,13 +37,13 @@ export declare const ALL_TOKEN_TYPES: readonly [TokenType.dimension, TokenType.s
37
37
  export declare const PURE_TOKEN_TYPES: readonly [TokenType.dimension, TokenType.size, TokenType.space, TokenType.opacity, TokenType.fontSize, TokenType.lineHeight, TokenType.letterSpacing, TokenType.paragraphSpacing, TokenType.borderWidth, TokenType.radius, TokenType.duration, TokenType.zIndex, TokenType.string, TokenType.productCopy, TokenType.fontFamily, TokenType.fontWeight, TokenType.textCase, TokenType.textDecoration, TokenType.visibility];
38
38
  export type PureTokenType = (typeof PURE_TOKEN_TYPES)[number];
39
39
  export type NonPureTokenType = Exclude<TokenType, PureTokenType>;
40
- export declare const tokenTypeIsPure: (tokenType: TokenType) => tokenType is TokenType.dimension | TokenType.size | TokenType.space | TokenType.opacity | TokenType.fontSize | TokenType.lineHeight | TokenType.letterSpacing | TokenType.paragraphSpacing | TokenType.borderWidth | TokenType.radius | TokenType.duration | TokenType.zIndex | TokenType.string | TokenType.productCopy | TokenType.fontFamily | TokenType.fontWeight | TokenType.textCase | TokenType.textDecoration | TokenType.visibility;
40
+ export declare const tokenTypeIsPure: (tokenType: TokenType) => tokenType is 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.visibility | TokenType.fontFamily | TokenType.fontWeight | TokenType.string | TokenType.productCopy;
41
41
  export declare const tokenTypeIsNonPure: (tokenType: TokenType) => tokenType is NonPureTokenType;
42
42
  export declare const REPLACABLE_TOKEN_TYPES: readonly [TokenType.color, TokenType.dimension, TokenType.size, TokenType.space, TokenType.opacity, TokenType.fontSize, TokenType.lineHeight, TokenType.letterSpacing, TokenType.paragraphSpacing, TokenType.borderWidth, TokenType.radius, TokenType.duration, TokenType.zIndex, TokenType.string, TokenType.productCopy, TokenType.fontFamily, TokenType.fontWeight, TokenType.textCase, TokenType.textDecoration, TokenType.visibility];
43
43
  export type ReplacableTokenType = (typeof REPLACABLE_TOKEN_TYPES)[number];
44
44
  export declare const REFERENCABLE_TOKEN_TYPES: readonly [TokenType.color, 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];
45
45
  export type ReferencableTokenType = (typeof REFERENCABLE_TOKEN_TYPES)[number];
46
- export declare const tokenTypeIsReferencable: (tokenType: TokenType) => tokenType is TokenType.color | 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;
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
49
  export type DTOriginalTokenType = "color" | "borderRadius" | "boxShadow" | "gradient" | "typography" | "border" | "borderWidth" | "sizing" | "opacity" | "spacing" | "fontSizes" | "paragraphSpacing" | "letterSpacing" | "lineHeights" | "other" | "dimension" | "fontFamilies" | "fontWeights" | "textCase" | "textDecoration";
@@ -2,7 +2,7 @@ export declare enum UserRole {
2
2
  owner = "Owner",
3
3
  admin = "Admin",
4
4
  creator = "Creator",
5
- viewer = "Viewer",
6
- billing = "Billing"
5
+ billing = "Billing",
6
+ viewer = "Viewer"
7
7
  }
8
8
  export type UserRoleWithoutOwner = Exclude<UserRole, UserRole.owner>;
@@ -47,6 +47,8 @@ export type ExportBuildModel = {
47
47
  destinations: ExportDestinations;
48
48
  scheduleId: string | null;
49
49
  exporterId: string;
50
+ brandId: string | null;
51
+ themeId: string | null;
50
52
  };
51
53
  /** Build run entry */
52
54
  export declare class ExportBuild {
@@ -90,6 +92,10 @@ export declare class ExportBuild {
90
92
  scheduleId: string | null;
91
93
  /** The identifier of the exporter associated with the export build */
92
94
  exporterId: string;
95
+ /** The identifier of the brand used for this build */
96
+ brandId: string | null;
97
+ /** The identifier of the theme used for this build */
98
+ themeId: string | null;
93
99
  constructor(data: ExportBuildModel);
94
100
  /**
95
101
  * Gets the URL for downloading the code generated by the export build.
@@ -19,6 +19,15 @@ export declare class ExportBuildPullRequestResult {
19
19
  pullRequestUrl: string;
20
20
  constructor(data: ExportBuildPullRequestResultModel);
21
21
  }
22
+ export type ExportBuildDocumentationResultModel = {
23
+ url: string;
24
+ };
25
+ /** The type definition for documentation build's result. */
26
+ export declare class ExportBuildDocumentationResult {
27
+ /** The URL of documentation's website associated with the export build result. */
28
+ url: string;
29
+ constructor(data: ExportBuildDocumentationResultModel);
30
+ }
22
31
  /**
23
32
  * The enum representing possible types of export build result logs.
24
33
  * @enum {string}
@@ -51,6 +60,7 @@ export type ExportBuildResultModel = {
51
60
  bitbucket: ExportBuildPullRequestResult | null;
52
61
  github: ExportBuildPullRequestResult | null;
53
62
  gitlab: ExportBuildPullRequestResult | null;
63
+ documentation: ExportBuildDocumentationResult | null;
54
64
  error: string | null;
55
65
  };
56
66
  export declare class ExportBuildResult {
@@ -66,6 +76,8 @@ export declare class ExportBuildResult {
66
76
  github: ExportBuildPullRequestResult | null;
67
77
  /** The GitLab export build pull request result, or null if not available */
68
78
  gitlab: ExportBuildPullRequestResult | null;
79
+ /** The documentation build result, or null if not available */
80
+ documentation: ExportBuildDocumentationResult | null;
69
81
  /** The error message, or null if not available */
70
82
  error: string | null;
71
83
  constructor(data: ExportBuildResultModel);
@@ -1,3 +1,4 @@
1
+ import { DocumentationEnvironment } from "../../enums/SDKDocumentationEnvironment";
1
2
  export type S3ExportDestinationModel = {
2
3
  url: string | null;
3
4
  };
@@ -76,12 +77,25 @@ export declare class GitlabExportDestination {
76
77
  url: string | null;
77
78
  constructor(data: GitlabExportDestinationModel);
78
79
  }
80
+ export type DocsExportDestinationModel = {
81
+ environment: DocumentationEnvironment;
82
+ };
83
+ /**
84
+ * Type definition for the data model of a documentation export destination.
85
+ * @typedef {Object} DocsExportDestinationModel
86
+ * @property {DocumentationEnvironment|null} environment - The environment of the docs export build.
87
+ */
88
+ export declare class DocsExportDestination {
89
+ environment: DocumentationEnvironment;
90
+ constructor(data: DocsExportDestinationModel);
91
+ }
79
92
  export type ExportDestinationsModel = {
80
93
  s3: S3ExportDestination | null;
81
94
  azure: AzureExportDestination | null;
82
95
  bitbucket: BitbucketExportDestination | null;
83
96
  github: GithubExportDestination | null;
84
97
  gitlab: GitlabExportDestination | null;
98
+ documentation: DocsExportDestination | null;
85
99
  webhookUrl: string | null;
86
100
  };
87
101
  /**
@@ -92,7 +106,7 @@ export type ExportDestinationsModel = {
92
106
  * @property {BitbucketExportDestination|null} bitbucket - The Bitbucket export destination, or null if not available.
93
107
  * @property {GithubExportDestination|null} github - The Github export destination, or null if not available.
94
108
  * @property {GitlabExportDestination|null} gitlab - The Gitlab export destination, or null if not available.
95
- * // @property {any|null} documentation - The documentation associated with the export destinations, or null if not available. Uncomment if documentation model is provided.
109
+ * @property {DocsExportDestination|null} documentation - The documentation associated with the export destinations, or null if not available.
96
110
  * @property {string|null} webhookUrl - The webhook URL associated with the export destinations, or null if not available.
97
111
  */
98
112
  export declare class ExportDestinations {
@@ -101,6 +115,7 @@ export declare class ExportDestinations {
101
115
  bitbucket: BitbucketExportDestination | null;
102
116
  github: GithubExportDestination | null;
103
117
  gitlab: GitlabExportDestination | null;
118
+ documentation: DocsExportDestination | null;
104
119
  webhookUrl: string | null;
105
120
  constructor(data: ExportDestinationsModel);
106
121
  /**
@@ -1,4 +1,4 @@
1
- import { ConnectionProviders } from "../../../model/enums/SDKConnectionProviders";
1
+ import { ConnectionProviders } from "../../enums/SDKConnectionProviders";
2
2
  export type ConnectionRemoteModel = {
3
3
  id: string;
4
4
  ownerId: string;