@supernova-studio/supernova-sdk-beta 1.6.33 → 1.6.35

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 (82) hide show
  1. package/build/sdk-typescript/src/core/SDKSupernova.d.ts +0 -4
  2. package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +14 -1
  3. package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +1 -34
  4. package/build/sdk-typescript/src/core/areas/SDKAreaResources.d.ts +2 -6
  5. package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +1 -4
  6. package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +19 -18
  7. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +7 -7
  8. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +8 -9
  9. package/build/sdk-typescript/src/core/resolvers/SDKAssetGroupResolver.d.ts +0 -4
  10. package/build/sdk-typescript/src/core/resolvers/SDKTokenResolver.d.ts +1 -1
  11. package/build/sdk-typescript/src/exports.d.ts +1 -9
  12. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockBehavior.d.ts +11 -2
  13. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockDefinition.d.ts +21 -5
  14. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockItemDefinition.d.ts +10 -3
  15. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockLayout.d.ts +7 -2
  16. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockVariant.d.ts +15 -2
  17. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts +1 -1
  18. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts +1 -1
  19. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts +2 -2
  20. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts +2 -2
  21. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty.d.ts +1 -1
  22. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockProperty.d.ts +10 -2
  23. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts +3 -3
  24. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts +1 -1
  25. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +1 -10
  26. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTableProperty.d.ts +2 -23
  27. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +1 -1
  28. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +2 -2
  29. package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsImageRef.d.ts +2 -5
  30. package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsLinkRef.d.ts +7 -10
  31. package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlock.d.ts +20 -7
  32. package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlockItem.d.ts +7 -2
  33. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityHeader.d.ts +0 -3
  34. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageAsset.d.ts +1 -1
  35. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockRenderCode.d.ts +1 -1
  36. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +1 -5
  37. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutAlign.d.ts +3 -3
  38. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutColumnResizing.d.ts +2 -2
  39. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutGap.d.ts +4 -4
  40. package/build/sdk-typescript/src/model/enums/SDKDocsBlockRichTextPropertyStyle.d.ts +4 -0
  41. package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts +19 -19
  42. package/build/sdk-typescript/src/model/enums/SDKUserRole.d.ts +2 -2
  43. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuild.d.ts +0 -6
  44. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuildResults.d.ts +0 -12
  45. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportDestinations.d.ts +1 -16
  46. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteConnectionsModel.d.ts +1 -1
  47. package/build/sdk-typescript/src/model/groups/SDKAssetGroup.d.ts +0 -4
  48. package/build/sdk-typescript/src/model/resources/SDKResourceFont.d.ts +2 -2
  49. package/build/sdk-typescript/src/model/support/SDKFigmaFrame.d.ts +0 -2
  50. package/build/sdk-typescript/src/model/support/SDKSource.d.ts +4 -10
  51. package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +1 -1
  52. package/build/sdk-typescript/src/model/themes/SDKTokenTheme.d.ts +6 -6
  53. package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +6 -6
  54. package/build/sdk-typescript/src/model/tokens/SDKColorToken.d.ts +0 -1
  55. package/build/sdk-typescript/src/model/tokens/SDKDimensionToken.d.ts +1 -1
  56. package/build/sdk-typescript/src/model/tokens/SDKStringToken.d.ts +1 -1
  57. package/build/sdk-typescript/src/model/tokens/SDKTextCaseToken.d.ts +1 -1
  58. package/build/sdk-typescript/src/model/tokens/SDKTextDecorationToken.d.ts +1 -1
  59. package/build/sdk-typescript/src/model/tokens/SDKTokenValue.d.ts +2 -2
  60. package/build/sdk-typescript/src/tests/Enterprise/PluginFigmaTokens.spec.d.ts +1 -0
  61. package/build/sdk-typescript/src/tests/FigmaTokensDataLoader.d.ts +3 -3
  62. package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +1 -2
  63. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONParser.d.ts +1 -1
  64. package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTGroupTree.d.ts +1 -1
  65. package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +0 -11
  66. package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementFigmaTokensTransformer.d.ts +1 -1
  67. package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementTransformer.d.ts +1 -1
  68. package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewGenerator.d.ts +1 -4
  69. package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewStyleGenerator.d.ts +1 -4
  70. package/build/sdk-typescript/src/utils/TokenUtils.d.ts +3 -3
  71. package/build/supernova-sdk-typescript.js +1 -1
  72. package/build/supernova-sdk-typescript.js.LICENSE.txt +14 -0
  73. package/build/supernova-sdk-typescript.js.map +1 -1
  74. package/package.json +118 -122
  75. package/build/sdk-typescript/.eslintrc.d.cts +0 -41
  76. package/build/sdk-typescript/src/core/areas/SDKAreaMultiplayer.d.ts +0 -10
  77. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockColorProperty.d.ts +0 -13
  78. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty.d.ts +0 -19
  79. package/build/sdk-typescript/src/model/enums/SDKDocsBlockMultiRichTextPropertyStyle.d.ts +0 -8
  80. package/build/sdk-typescript/src/model/enums/SDKDocsPublishStatus.d.ts +0 -4
  81. package/build/sdk-typescript/src/utils/CommonUtils.d.ts +0 -5
  82. package/build/sdk-typescript/src/utils/deepPartial.d.ts +0 -3
@@ -1,4 +1,4 @@
1
- import { DocumentationLegacyRichTextModel } from "../../../documentation/SDKDocumentationLegacyRichText";
1
+ import { RichTextSpan } from "../../../documentation/SDKDocumentationLegacyRichTextSpan";
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
- richTextStyle?: DocsBlockRichTextPropertyStyle;
11
+ style?: DocsBlockRichTextPropertyStyle;
12
12
  };
13
13
  /** RichText property - Data */
14
- export type DocsBlockRichTextPropertyData = DocsBlockPropertyData<DocumentationLegacyRichTextModel> & {
14
+ export type DocsBlockRichTextPropertyData = DocsBlockPropertyData<Array<RichTextSpan>> & {
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
- singleSelectStyle?: DocsBlockOptionRenderingStyle;
18
+ style?: DocsBlockOptionRenderingStyle;
19
19
  };
20
20
  /** SingleSelect property - Data */
21
21
  export type DocsBlockSingleSelectPropertyData = DocsBlockPropertyData<string> & Record<string, never>;
@@ -1,15 +1,6 @@
1
1
  import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
2
2
  /** Storybook property - Additional non-value options */
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
- };
3
+ export type DocsBlockStorybookPropertyOptions = Record<string, never>;
13
4
  /** Storybook property - Data */
14
5
  export type DocsBlockStorybookPropertyData = DocsBlockPropertyData<string> & {
15
6
  caption?: string;
@@ -1,34 +1,13 @@
1
- import { DocumentationLegacyRichTextModel } from "../../../documentation/SDKDocumentationLegacyRichText";
2
1
  import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
3
- import { DocsImageRef } from "../support/SDKDocsImageRef";
4
2
  import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
5
3
  /** Table property - Additional non-value options */
6
4
  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;
20
5
  /** Table property - Data */
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
- }>> & {
6
+ export type DocsBlockTablePropertyData = DocsBlockPropertyData<any> & {
29
7
  highlightHeaderColumn?: boolean;
30
8
  highlightHeaderRow?: boolean;
31
9
  showBorder?: boolean;
10
+ width?: number;
32
11
  };
33
12
  /** Table property - Definition model */
34
13
  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
- textStyle: DocsBlockTextPropertyStyle;
12
+ style: 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,11 +6,8 @@ export type DocsImageRef = {
6
6
  url: string;
7
7
  /** Referenced asset, if any */
8
8
  assetId?: string;
9
- /** Referenced Figma file, if any */
10
- figmaFile?: {
11
- sourceId: string;
12
- frameId: string;
13
- };
9
+ /** Referenced frame, if any */
10
+ frameId?: string;
14
11
  /** Image size, if known */
15
12
  size?: {
16
13
  width?: number;
@@ -3,22 +3,19 @@ export type DocsLinkRef = {
3
3
  /** Ref type */
4
4
  type: DocsLinkRefType;
5
5
  /** Referenced page */
6
- documentationItemId?: string;
6
+ pageId?: string;
7
7
  /** Referenced page block - heading */
8
8
  pageHeadingId?: string;
9
+ /** Referenced page group */
10
+ groupId?: string;
9
11
  /** Referenced URL */
10
12
  url?: string;
11
13
  /** Open in other tab */
12
14
  openInNewTab?: boolean;
13
15
  };
14
16
  export declare enum DocsLinkRefType {
15
- documentationItem = "DocumentationItem",
16
- pageHeading = "PageHeading",
17
- url = "Url"
17
+ page = "Page",
18
+ pageHeading = "pageHeading",
19
+ group = "Group",
20
+ url = "url"
18
21
  }
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,8 +1,23 @@
1
- import { PageBlockEditorModel } from "@supernova-studio/client";
2
1
  import { DocsColorRef } from "../support/SDKDocsColorRef";
3
2
  import { DocsLinkRef } from "../support/SDKDocsLinkRef";
4
3
  import { DocsBlockItem } from "./SDKDocsBlockItem";
5
- export type DocsBlockModel = PageBlockEditorModel;
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
+ };
6
21
  export declare class DocsBlock {
7
22
  /** Unique identifier of the block */
8
23
  id: string;
@@ -16,8 +31,6 @@ export declare class DocsBlock {
16
31
  appearance: {
17
32
  /** Background color of all items of the block. Can be further overriden on every item */
18
33
  itemBackgroundColor: DocsColorRef | null;
19
- /** Number of columns */
20
- numberOfColumns?: number;
21
34
  };
22
35
  /** Data of all items of the block */
23
36
  data: Array<DocsBlockItem>;
@@ -39,9 +52,9 @@ export declare class DocsBlock {
39
52
  /** Update data for property of specific key and index */
40
53
  updatePropertyDataForSingleItem(propertyId: string, data: object): void;
41
54
  /** Update link for item at specific index */
42
- updateLinkForItemAtIndex(index: number, link: DocsLinkRef | undefined): void;
55
+ updateLinkForItemAtIndex(index: number, link: DocsLinkRef | null): void;
43
56
  /** Update link for item at specific index */
44
- updateLinkForSingleItem(link: DocsLinkRef | undefined): void;
57
+ updateLinkForSingleItem(link: DocsLinkRef | null): void;
45
58
  /** Constructs representation that can be used to write full object to remote */
46
- toRemote(): PageBlockEditorModel;
59
+ toRemote(): DocsBlockModel;
47
60
  }
@@ -1,6 +1,11 @@
1
- import { PageBlockItemV2 } from "@supernova-studio/model";
2
1
  import { DocsLinkRef } from "../support/SDKDocsLinkRef";
3
- export type DocsBlockItemModel = PageBlockItemV2;
2
+ export type DocsBlockItemModel = {
3
+ id: string;
4
+ props: {
5
+ [key: string]: object;
6
+ };
7
+ linksTo?: DocsLinkRef;
8
+ };
4
9
  export declare class DocsBlockItem {
5
10
  /** Unique identifier of the block item */
6
11
  id: string;
@@ -1,13 +1,11 @@
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";
5
4
  export type DocsEntityHeaderModel = {
6
5
  description: string;
7
6
  alignment: Alignment;
8
7
  foregroundColor?: DocsColorRef;
9
8
  backgroundColor?: DocsColorRef;
10
- backgroundImageAsset?: DocsImageRef;
11
9
  backgroundImageScaleType: AssetScaleType;
12
10
  showBackgroundOverlay: boolean;
13
11
  showCoverText: boolean;
@@ -18,7 +16,6 @@ export declare class DocsEntityHeader {
18
16
  alignment: Alignment;
19
17
  foregroundColor: DocsColorRef | null;
20
18
  backgroundColor: DocsColorRef | null;
21
- backgroundImage: DocsImageRef | null;
22
19
  showBackgroundOverlay: boolean;
23
20
  showCoverText: boolean;
24
21
  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 | null;
30
+ btoaUnicode(str: any): string;
31
31
  atobUnicode(str: any): string;
32
32
  }
33
33
  export {};
@@ -1,8 +1,6 @@
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",
6
4
  /** Text property allows user to input plain text */
7
5
  text = "Text",
8
6
  /** Boolean property allows user to input true/false value */
@@ -47,7 +45,5 @@ export declare enum DocsBlockItemPropertyType {
47
45
  /** Divider property that puts visual divider into the block. It has no user input */
48
46
  divider = "Divider",
49
47
  /** Storybook property allows user to add Storybook story to render */
50
- storybook = "Storybook",
51
- /** Color property allows users to select color for further use */
52
- color = "Color"
48
+ storybook = "Storybook"
53
49
  }
@@ -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
  }
@@ -13,6 +13,10 @@ 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",
16
20
  /** Default option */
17
21
  default = "Default"
18
22
  }
@@ -1,29 +1,29 @@
1
1
  export declare enum TokenType {
2
2
  color = "Color",
3
3
  typography = "Typography",
4
- shadow = "Shadow",
5
- border = "Border",
6
- gradient = "Gradient",
7
- blur = "Blur",
8
- radius = "BorderRadius",
9
- borderWidth = "BorderWidth",
10
- duration = "Duration",
11
- fontSize = "FontSize",
12
4
  dimension = "Dimension",
13
- letterSpacing = "LetterSpacing",
14
- lineHeight = "LineHeight",
15
- opacity = "Opacity",
16
- paragraphSpacing = "ParagraphSpacing",
17
5
  size = "Size",
18
6
  space = "Space",
7
+ opacity = "Opacity",
8
+ fontSize = "FontSize",
9
+ lineHeight = "LineHeight",
10
+ letterSpacing = "LetterSpacing",
11
+ paragraphSpacing = "ParagraphSpacing",
12
+ borderWidth = "BorderWidth",
13
+ radius = "BorderRadius",
14
+ duration = "Duration",
19
15
  zIndex = "ZIndex",
20
- textDecoration = "TextDecoration",
21
- textCase = "TextCase",
22
- visibility = "Visibility",
16
+ shadow = "Shadow",
17
+ border = "Border",
18
+ gradient = "Gradient",
19
+ string = "String",
20
+ productCopy = "ProductCopy",
23
21
  fontFamily = "FontFamily",
24
22
  fontWeight = "FontWeight",
25
- string = "String",
26
- productCopy = "ProductCopy"
23
+ textCase = "TextCase",
24
+ textDecoration = "TextDecoration",
25
+ visibility = "Visibility",
26
+ blur = "Blur"
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.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;
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;
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.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;
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;
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
- billing = "Billing",
6
- viewer = "Viewer"
5
+ viewer = "Viewer",
6
+ billing = "Billing"
7
7
  }
8
8
  export type UserRoleWithoutOwner = Exclude<UserRole, UserRole.owner>;
@@ -47,8 +47,6 @@ export type ExportBuildModel = {
47
47
  destinations: ExportDestinations;
48
48
  scheduleId: string | null;
49
49
  exporterId: string;
50
- brandId: string | null;
51
- themeId: string | null;
52
50
  };
53
51
  /** Build run entry */
54
52
  export declare class ExportBuild {
@@ -92,10 +90,6 @@ export declare class ExportBuild {
92
90
  scheduleId: string | null;
93
91
  /** The identifier of the exporter associated with the export build */
94
92
  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;
99
93
  constructor(data: ExportBuildModel);
100
94
  /**
101
95
  * Gets the URL for downloading the code generated by the export build.
@@ -19,15 +19,6 @@ 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
- }
31
22
  /**
32
23
  * The enum representing possible types of export build result logs.
33
24
  * @enum {string}
@@ -60,7 +51,6 @@ export type ExportBuildResultModel = {
60
51
  bitbucket: ExportBuildPullRequestResult | null;
61
52
  github: ExportBuildPullRequestResult | null;
62
53
  gitlab: ExportBuildPullRequestResult | null;
63
- documentation: ExportBuildDocumentationResult | null;
64
54
  error: string | null;
65
55
  };
66
56
  export declare class ExportBuildResult {
@@ -76,8 +66,6 @@ export declare class ExportBuildResult {
76
66
  github: ExportBuildPullRequestResult | null;
77
67
  /** The GitLab export build pull request result, or null if not available */
78
68
  gitlab: ExportBuildPullRequestResult | null;
79
- /** The documentation build result, or null if not available */
80
- documentation: ExportBuildDocumentationResult | null;
81
69
  /** The error message, or null if not available */
82
70
  error: string | null;
83
71
  constructor(data: ExportBuildResultModel);
@@ -1,4 +1,3 @@
1
- import { DocumentationEnvironment } from "../../enums/SDKDocumentationEnvironment";
2
1
  export type S3ExportDestinationModel = {
3
2
  url: string | null;
4
3
  };
@@ -77,25 +76,12 @@ export declare class GitlabExportDestination {
77
76
  url: string | null;
78
77
  constructor(data: GitlabExportDestinationModel);
79
78
  }
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
- }
92
79
  export type ExportDestinationsModel = {
93
80
  s3: S3ExportDestination | null;
94
81
  azure: AzureExportDestination | null;
95
82
  bitbucket: BitbucketExportDestination | null;
96
83
  github: GithubExportDestination | null;
97
84
  gitlab: GitlabExportDestination | null;
98
- documentation: DocsExportDestination | null;
99
85
  webhookUrl: string | null;
100
86
  };
101
87
  /**
@@ -106,7 +92,7 @@ export type ExportDestinationsModel = {
106
92
  * @property {BitbucketExportDestination|null} bitbucket - The Bitbucket export destination, or null if not available.
107
93
  * @property {GithubExportDestination|null} github - The Github export destination, or null if not available.
108
94
  * @property {GitlabExportDestination|null} gitlab - The Gitlab export destination, or null if not available.
109
- * @property {DocsExportDestination|null} documentation - The documentation associated with the export destinations, 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.
110
96
  * @property {string|null} webhookUrl - The webhook URL associated with the export destinations, or null if not available.
111
97
  */
112
98
  export declare class ExportDestinations {
@@ -115,7 +101,6 @@ export declare class ExportDestinations {
115
101
  bitbucket: BitbucketExportDestination | null;
116
102
  github: GithubExportDestination | null;
117
103
  gitlab: GitlabExportDestination | null;
118
- documentation: DocsExportDestination | null;
119
104
  webhookUrl: string | null;
120
105
  constructor(data: ExportDestinationsModel);
121
106
  /**
@@ -1,4 +1,4 @@
1
- import { ConnectionProviders } from "../../enums/SDKConnectionProviders";
1
+ import { ConnectionProviders } from "../../../model/enums/SDKConnectionProviders";
2
2
  export type ConnectionRemoteModel = {
3
3
  id: string;
4
4
  ownerId: string;
@@ -1,7 +1,6 @@
1
1
  import { DesignComponentGroupRemoteModel } from "./SDKDesignComponentGroup";
2
2
  export declare class AssetGroup {
3
3
  id: string;
4
- persistentId: string;
5
4
  brandId: string;
6
5
  name: string;
7
6
  description: string;
@@ -13,9 +12,6 @@ export declare class AssetGroup {
13
12
  parentGroupId: string | null;
14
13
  createdAt: Date | null;
15
14
  updatedAt: Date | null;
16
- isAssetGroup: boolean;
17
- sourceId: string | null;
18
- sourceName: string | null;
19
15
  constructor(model: DesignComponentGroupRemoteModel);
20
16
  addChild(groupId: string): void;
21
17
  addChildren(groupsIds: Array<string>): void;
@@ -1,9 +1,9 @@
1
1
  import { Resource, ResourceModel, ResourceType } from "./SDKResource";
2
2
  export type ResourceFontModel = ResourceModel & {
3
- fontProperties?: Array<{
3
+ fontProperties?: {
4
4
  family?: string;
5
5
  subfamily?: string;
6
- }>;
6
+ };
7
7
  };
8
8
  export declare class ResourceFont extends Resource {
9
9
  type: ResourceType;
@@ -2,9 +2,7 @@ export declare enum FrameType {
2
2
  DOCUMENT = "DOCUMENT",
3
3
  CANVAS = "CANVAS",
4
4
  COMPONENT_SET = "COMPONENT_SET",
5
- COMPONENT_VARIANT = "COMPONENT_VARIANT",
6
5
  COMPONENT = "COMPONENT",
7
- SECTION = "SECTION",
8
6
  FRAME = "FRAME"
9
7
  }
10
8
  export type FigmaFrameModel = {
@@ -1,15 +1,10 @@
1
1
  import { ImportWarningType } from "../enums/SDKCloudWarningType";
2
2
  import { SourceType } from "../enums/SDKSourceType";
3
- declare enum SourceRemoteType {
4
- figma = "Figma",
5
- tokenStudio = "TokenStudio",
6
- figmaVariablesPlugin = "FigmaVariablesPlugin",
7
- upload = "Upload"
8
- }
9
3
  export type SourceRemoteModel = {
10
- type: SourceRemoteType;
4
+ type: SourceType;
11
5
  id: string;
12
6
  fileName?: string;
7
+ linkType: "Design" | "Frames";
13
8
  brandId?: string;
14
9
  plugin?: {
15
10
  fileId: string;
@@ -105,7 +100,6 @@ export type SourceRemoteModelTokensStudio = {
105
100
  export type SourceRemoteModelFigmaVariablesPlugin = {
106
101
  fileId: string;
107
102
  lastImportedAt?: string;
108
- lastImportMetadata?: Record<string, any>;
109
103
  };
110
104
  export type SourceModelTokenStudio = Omit<SourceRemoteModelTokensStudio, "lastUpdatesCheckedAt" | "lastImportedAt"> & {
111
105
  lastUpdatesCheckedAt?: Date;
@@ -118,13 +112,14 @@ export type SourceModelCloud = Omit<SourceRemoteModelCloud, "lastUpdatesCheckedA
118
112
  export type SourceModelFigmaVariablesPlugin = Omit<SourceRemoteModelFigmaVariablesPlugin, "lastImportedAt"> & {
119
113
  lastImportedAt?: Date;
120
114
  };
121
- export type SourceTransportModel = Pick<Source, "type" | "id" | "fileName" | "brandId" | "scope"> & {
115
+ export type SourceTransportModel = Pick<Source, "type" | "id" | "fileName" | "linkType" | "brandId" | "scope"> & {
122
116
  cloud?: SourceRemoteModelCloud | null;
123
117
  };
124
118
  export declare class Source {
125
119
  type: SourceType;
126
120
  id: string;
127
121
  fileName: string | null;
122
+ linkType: "Design" | "Frames";
128
123
  brandId: string | null;
129
124
  cloud: SourceModelCloud | null;
130
125
  tokenStudio?: SourceModelTokenStudio | null;
@@ -144,4 +139,3 @@ export declare class Source {
144
139
  /** Reconstructs class from the transport model */
145
140
  static fromTransport(model: SourceTransportModel): SourceRemoteModel;
146
141
  }
147
- export {};
@@ -1,4 +1,4 @@
1
- import { SourceType } from "../enums/SDKSourceType";
1
+ import { SourceType } from "../../model/enums/SDKSourceType";
2
2
  export type TokenOriginModel = {
3
3
  id?: string;
4
4
  name?: string;