@supernova-studio/supernova-sdk-beta 1.6.23 → 1.6.25

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 (59) hide show
  1. package/build/sdk-typescript/src/tests/Enterprise/PluginFigmaTokens.spec.d.ts +1 -0
  2. package/build/sdk-typescript/src/tests/FigmaTokensDataLoader.d.ts +1 -1
  3. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTMapLoader.d.ts +2 -2
  4. package/build/supernova-sdk-typescript.js +70428 -2
  5. package/build/supernova-sdk-typescript.js.map +1 -1
  6. package/package.json +2 -2
  7. package/build/sdk-typescript/src/model/base/SDKDocumentation.d.ts +0 -10
  8. package/build/sdk-typescript/src/model/documentation/SDKDocumentationConfiguration.d.ts +0 -13
  9. package/build/sdk-typescript/src/model/documentation/SDKDocumentationGroup.d.ts +0 -38
  10. package/build/sdk-typescript/src/model/documentation/SDKDocumentationItem.d.ts +0 -28
  11. package/build/sdk-typescript/src/model/documentation/SDKDocumentationPage.d.ts +0 -32
  12. package/build/sdk-typescript/src/model/documentation/SDKDocumentationPageAsset.d.ts +0 -15
  13. package/build/sdk-typescript/src/model/documentation/SDKDocumentationPageBlock.d.ts +0 -30
  14. package/build/sdk-typescript/src/model/documentation/SDKDocumentationRichText.d.ts +0 -10
  15. package/build/sdk-typescript/src/model/documentation/SDKDocumentationRichTextSpan.d.ts +0 -10
  16. package/build/sdk-typescript/src/model/documentation/SDKDocumentationRichTextSpanAttribute.d.ts +0 -14
  17. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockAsset.d.ts +0 -15
  18. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockAssets.d.ts +0 -22
  19. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockCallout.d.ts +0 -10
  20. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockCode.d.ts +0 -11
  21. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockColumn.d.ts +0 -4
  22. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockColumnItem.d.ts +0 -9
  23. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockCustom.d.ts +0 -15
  24. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockDivider.d.ts +0 -4
  25. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedFigma.d.ts +0 -4
  26. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedGeneric.d.ts +0 -13
  27. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedLink.d.ts +0 -15
  28. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedStorybook.d.ts +0 -4
  29. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedYoutube.d.ts +0 -4
  30. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockFrame.d.ts +0 -18
  31. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockFrames.d.ts +0 -24
  32. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockHeading.d.ts +0 -10
  33. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockImage.d.ts +0 -16
  34. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockOrderedList.d.ts +0 -4
  35. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockQuote.d.ts +0 -4
  36. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockRenderCode.d.ts +0 -33
  37. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockShortcut.d.ts +0 -35
  38. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockShortcuts.d.ts +0 -9
  39. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTab.d.ts +0 -4
  40. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTabItem.d.ts +0 -8
  41. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTable.d.ts +0 -21
  42. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTableCell.d.ts +0 -11
  43. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTableColumn.d.ts +0 -10
  44. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTableRow.d.ts +0 -4
  45. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockText.d.ts +0 -11
  46. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockToken.d.ts +0 -8
  47. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTokenGroup.d.ts +0 -10
  48. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTokenList.d.ts +0 -8
  49. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockUnorderedList.d.ts +0 -4
  50. package/build/sdk-typescript/src/model/documentation/builder/SDKDocumentationBlockBuilder.d.ts +0 -6
  51. package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationItemConfiguration.d.ts +0 -10
  52. package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationItemHeader.d.ts +0 -30
  53. package/build/sdk-typescript/src/model/enums/SDKDocumentationCalloutType.d.ts +0 -6
  54. package/build/sdk-typescript/src/model/enums/SDKDocumentationGroupBehavior.d.ts +0 -4
  55. package/build/sdk-typescript/src/model/enums/SDKDocumentationHeadingType.d.ts +0 -5
  56. package/build/sdk-typescript/src/model/enums/SDKDocumentationItemType.d.ts +0 -4
  57. package/build/sdk-typescript/src/model/enums/SDKDocumentationPageAssetType.d.ts +0 -4
  58. package/build/sdk-typescript/src/model/enums/SDKDocumentationPageBlockThemeType.d.ts +0 -4
  59. package/build/sdk-typescript/src/model/enums/SDKDocumentationPageBlockType.d.ts +0 -31
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@supernova-studio/supernova-sdk-beta",
3
- "version": "1.6.23",
3
+ "version": "1.6.25",
4
4
  "description": "Supernova.io Developer SDK",
5
5
  "main": "./build/supernova-sdk-typescript.js",
6
6
  "types": "./build/sdk-typescript/src/index.d.ts",
@@ -39,7 +39,7 @@
39
39
  "typecheck": "tsc --noEmit -p ./tsconfig.json",
40
40
  "clean": "trash build test",
41
41
  "prepare-release": "run-s reset test cov:check doc:html version doc:publish",
42
- "publish-package-dry": "npm run build:production && npm publish --access=restricted --tag=beta --dry-run",
42
+ "publish-package": "npm run build:production && npm publish --access public",
43
43
  "publish-package-debug": "npm run build:main && npm publish --access=restricted --tag=beta"
44
44
  },
45
45
  "scripts-info": {
@@ -1,10 +0,0 @@
1
- import { DocumentationConfiguration, DocumentationConfigurationModel } from "../documentation/SDKDocumentationConfiguration";
2
- import { WorkspaceNPMRegistrySettings } from "../workspaces/SDKWorkspaceNPMRegistrySettings";
3
- export type DocumentationModel = {
4
- settings: DocumentationConfigurationModel;
5
- };
6
- export declare class Documentation {
7
- /** Documentation settings */
8
- settings: DocumentationConfiguration;
9
- constructor(model: DocumentationModel, registry: WorkspaceNPMRegistrySettings | null);
10
- }
@@ -1,13 +0,0 @@
1
- import { WorkspaceNPMRegistrySettings } from "../workspaces/SDKWorkspaceNPMRegistrySettings";
2
- export type DocumentationConfigurationModel = {
3
- tabbed: boolean;
4
- storybookEmbedErrorMessage?: string;
5
- renderCodePackageJson?: string;
6
- };
7
- export declare class DocumentationConfiguration {
8
- tabbedNavigation: boolean;
9
- storybookError: string | null;
10
- packageJson: string | null;
11
- npmRegistry: WorkspaceNPMRegistrySettings | null;
12
- constructor(model: DocumentationConfigurationModel, registry: WorkspaceNPMRegistrySettings | null);
13
- }
@@ -1,38 +0,0 @@
1
- import { DocumentationGroupBehavior } from "../enums/SDKDocumentationGroupBehavior";
2
- import { DocumentationItem, DocumentationItemModel } from "./SDKDocumentationItem";
3
- import { DocumentationPage } from "./SDKDocumentationPage";
4
- export type DocumentationGroupModel = {
5
- isRoot: boolean;
6
- childrenIds: Array<string>;
7
- groupBehavior: DocumentationGroupBehavior;
8
- } & DocumentationItemModel;
9
- export declare class DocumentationGroup extends DocumentationItem {
10
- /** If true, this is unique within documentation (just one) that contains all top-level objects and is root of the docs tree (root > groups > items > blocks ...) */
11
- isRoot: boolean;
12
- /** IDs of items belonging to the documentation group. Can be page or group */
13
- childrenIds: Array<string>;
14
- /** Items belonging to the documentation group. Can be page or group */
15
- children: Array<DocumentationItem>;
16
- /** Parent group reference */
17
- parent: DocumentationGroup | null;
18
- /** Signifies how the group should behave. If set to "tabs", group behaves as "page", but contains multiple tabbed pages inside it. "Group" signifies virtual group used for content structuring */
19
- groupBehavior: DocumentationGroupBehavior;
20
- /** Children filtered to be only groups */
21
- get subgroups(): Array<DocumentationGroup>;
22
- /** Children filtered to be only pages */
23
- get pages(): Array<DocumentationPage>;
24
- /** Internal */
25
- relativeFirstPageUrl: string | null;
26
- /** Internal */
27
- deployedFirstPageUrl: string | null;
28
- constructor(model: DocumentationGroupModel);
29
- addChild(item: DocumentationItem): void;
30
- addChildren(groups: Array<DocumentationItem>): void;
31
- setParent(parent: DocumentationGroup | null): void;
32
- /** Internal: Modifies object with new paths. Don't use outside SDK environment as it doesn't propagate the data back to source */
33
- internalOverridePaths(relative: string | null, deployed: string | null): void;
34
- /** Retrieve relative page path without the associated domain for the first page in the group. Will work even when documentation was not yet deployed */
35
- relativeDocsPageUrl(): string | null;
36
- /** Retrieve page url for the first page in the group, if the documentation was already deployed (either default or custom domain) */
37
- deployedDocsPageUrl(): string | null;
38
- }
@@ -1,28 +0,0 @@
1
- import { DocumentationItemType } from "../enums/SDKDocumentationItemType";
2
- import { DocumentationItemConfiguration, DocumentationItemConfigurationModel } from "./configuration/SDKDocumentationItemConfiguration";
3
- export type DocumentationItemModel = {
4
- persistentId: string;
5
- shortPersistentId: string;
6
- id: string;
7
- designSystemVersionId: string;
8
- title: string;
9
- type: DocumentationItemType;
10
- slug: string;
11
- userSlug?: string;
12
- configuration: DocumentationItemConfigurationModel;
13
- createdAt?: string;
14
- updatedAt?: string;
15
- };
16
- export declare class DocumentationItem {
17
- id: string;
18
- persistentId: string;
19
- shortPersistentId: string;
20
- type: DocumentationItemType;
21
- title: string;
22
- configuration: DocumentationItemConfiguration;
23
- slug: string;
24
- userSlug: string | null;
25
- createdAt: Date | null;
26
- updatedAt: Date | null;
27
- constructor(model: DocumentationItemModel);
28
- }
@@ -1,32 +0,0 @@
1
- import { ExporterCustomBlock } from "../exporters/custom_blocks/SDKExporterCustomBlock";
2
- import { DocumentationConfiguration } from "./SDKDocumentationConfiguration";
3
- import { DocumentationGroup } from "./SDKDocumentationGroup";
4
- import { DocumentationItem, DocumentationItemModel } from "./SDKDocumentationItem";
5
- import { DocumentationPageBlock, DocumentationPageBlockModel } from "./SDKDocumentationPageBlock";
6
- export type DocumentationPageModel = {
7
- path: string;
8
- blocks?: Array<DocumentationPageBlockModel>;
9
- } & DocumentationItemModel;
10
- export declare class DocumentationPage extends DocumentationItem {
11
- /** All blocks that were defined on the top level of the page */
12
- blocks: Array<DocumentationPageBlock>;
13
- /** Containing group. Can either be true group (abstract), or tab group */
14
- parent: DocumentationGroup;
15
- /** Internal */
16
- deployedUrl: string | null;
17
- /** Internal */
18
- relativeUrl: string;
19
- /** Internal */
20
- editorUrl: string | null;
21
- constructor(model: DocumentationPageModel, customBlocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration);
22
- /** Internal: Modifies object with new paths. Don't use outside SDK environment as it doesn't propagate the data back to source */
23
- internalOverridePaths(deployed: string | null, editor: string | null): void;
24
- /** Internal: Sets new parent. Used when manipulating with object internally. Don't use outside SDK environment */
25
- setParent(parent: DocumentationGroup): void;
26
- /** Retrieve editor page URL that can be opened */
27
- editorPageUrl(): string | null;
28
- /** Retrieve documentation page URL, if the documentation was already deployed (either default or custom domain) */
29
- deployedPageUrl(): string | null;
30
- /** Retrieve relative page path without the associated domain. Will work even when documentation was not yet deployed */
31
- relativePageUrl(): string | null;
32
- }
@@ -1,15 +0,0 @@
1
- import { DocumentationPageAssetType } from "../enums/SDKDocumentationPageAssetType";
2
- import { DocumentationPageBlockFrame, DocumentationPageBlockFrameModel } from "./blocks/SDKDocumentationPageBlockFrame";
3
- export type DocumentationPageAssetModel = {
4
- id: string;
5
- url?: string;
6
- type: DocumentationPageAssetType;
7
- figmaFrame?: DocumentationPageBlockFrameModel;
8
- };
9
- export declare class DocumentationPageAsset {
10
- id: string;
11
- url: string | null;
12
- type: DocumentationPageAssetType;
13
- frame: DocumentationPageBlockFrame | null;
14
- constructor(model: DocumentationPageAssetModel);
15
- }
@@ -1,30 +0,0 @@
1
- import { DocumentationPageBlockThemeType } from "../enums/SDKDocumentationPageBlockThemeType";
2
- import { DocumentationPageBlockType } from "../enums/SDKDocumentationPageBlockType";
3
- export type DocumentationPageBlockModel = {
4
- persistentId: string;
5
- designObjectId: string;
6
- type: DocumentationPageBlockType;
7
- children: Array<DocumentationPageBlockModel>;
8
- variantKey?: string;
9
- theme?: {
10
- themeIds: Array<string>;
11
- type: DocumentationPageBlockThemeType;
12
- };
13
- blacklistedElementProperties?: Array<string>;
14
- userMetadata?: string;
15
- };
16
- export declare class DocumentationPageBlock {
17
- id: string;
18
- children: Array<DocumentationPageBlock>;
19
- type: DocumentationPageBlockType;
20
- beginsTypeChain: boolean;
21
- endsTypeChain: boolean;
22
- variantKey: string | null;
23
- theme: {
24
- themeIds: Array<string>;
25
- type: DocumentationPageBlockThemeType;
26
- } | null;
27
- blacklistedElementProperties: Array<string> | null;
28
- userMetadata: object | Array<any> | null;
29
- constructor(model: DocumentationPageBlockModel, children: Array<DocumentationPageBlock>);
30
- }
@@ -1,10 +0,0 @@
1
- import { RichTextSpan, RichTextSpanModel } from "./SDKDocumentationRichTextSpan";
2
- export type DocumentationRichTextModel = {
3
- spans: Array<RichTextSpanModel>;
4
- };
5
- export declare class DocumentationRichText {
6
- spans: Array<RichTextSpan>;
7
- constructor(model: DocumentationRichTextModel);
8
- /** Convert rich text into plain text, omitting any formatting */
9
- asPlainText(): string;
10
- }
@@ -1,10 +0,0 @@
1
- import { RichTextSpanAttribute, RichTextSpanAttributeModel } from "./SDKDocumentationRichTextSpanAttribute";
2
- export type RichTextSpanModel = {
3
- text: string;
4
- attributes: Array<RichTextSpanAttributeModel>;
5
- };
6
- export declare class RichTextSpan {
7
- text: string;
8
- attributes: Array<RichTextSpanAttribute>;
9
- constructor(model: RichTextSpanModel);
10
- }
@@ -1,14 +0,0 @@
1
- import { RichTextSpanAttributeType } from "../enums/SDKRichTextSpanAttributeType";
2
- export type RichTextSpanAttributeModel = {
3
- type: RichTextSpanAttributeType;
4
- link?: string;
5
- documentationItemId?: string;
6
- openInNewWindow: boolean;
7
- };
8
- export declare class RichTextSpanAttribute {
9
- type: RichTextSpanAttributeType;
10
- link: string | null;
11
- openInNewWindow: boolean;
12
- documentationItemId: string | null;
13
- constructor(model: RichTextSpanAttributeModel);
14
- }
@@ -1,15 +0,0 @@
1
- import { ColorTokenRemoteData } from "../../tokens/remote/SDKRemoteTokenData";
2
- export type DocumentationPageBlockAssetModel = {
3
- componentAssetId: string;
4
- title?: string;
5
- description?: string;
6
- backgroundColor?: ColorTokenRemoteData;
7
- };
8
- export declare class DocumentationPageBlockAsset {
9
- assetId: string;
10
- title: string | null;
11
- description: string | null;
12
- previewUrl: string | null;
13
- backgroundColor: ColorTokenRemoteData | null;
14
- constructor(model: DocumentationPageBlockAssetModel, blockBackgroundColor: ColorTokenRemoteData | null);
15
- }
@@ -1,22 +0,0 @@
1
- import { FrameAlignment } from "../../enums/SDKFrameAlignment";
2
- import { FrameLayout } from "../../enums/SDKFrameLayout";
3
- import { ColorTokenRemoteData } from "../../tokens/remote/SDKRemoteTokenData";
4
- import { DocumentationPageBlock, DocumentationPageBlockModel } from "../SDKDocumentationPageBlock";
5
- import { DocumentationPageBlockAsset, DocumentationPageBlockAssetModel } from "./SDKDocumentationPageBlockAsset";
6
- export type DocumentationPageBlockAssetsModel = {
7
- componentAssets: Array<DocumentationPageBlockAssetModel>;
8
- figmaFrameProperties: {
9
- alignment: FrameAlignment;
10
- color?: ColorTokenRemoteData;
11
- layout: FrameLayout;
12
- };
13
- } & DocumentationPageBlockModel;
14
- export declare class DocumentationPageBlockAssets extends DocumentationPageBlock {
15
- assets: Array<DocumentationPageBlockAsset>;
16
- properties: {
17
- backgroundColor: ColorTokenRemoteData | null;
18
- alignment: FrameAlignment;
19
- layout: FrameLayout;
20
- };
21
- constructor(model: DocumentationPageBlockAssetsModel, children: Array<DocumentationPageBlock>);
22
- }
@@ -1,10 +0,0 @@
1
- import { DocumentationCalloutType } from "../../enums/SDKDocumentationCalloutType";
2
- import { DocumentationPageBlock } from "../SDKDocumentationPageBlock";
3
- import { DocumentationPageBlockText, DocumentationPageBlockTextModel } from "./SDKDocumentationPageBlockText";
4
- export type DocumentationPageBlockCalloutModel = {
5
- calloutType: DocumentationCalloutType;
6
- } & DocumentationPageBlockTextModel;
7
- export declare class DocumentationPageBlockCallout extends DocumentationPageBlockText {
8
- calloutType: DocumentationCalloutType;
9
- constructor(model: DocumentationPageBlockCalloutModel, children: Array<DocumentationPageBlock>);
10
- }
@@ -1,11 +0,0 @@
1
- import { DocumentationPageBlock } from "../SDKDocumentationPageBlock";
2
- import { DocumentationPageBlockText, DocumentationPageBlockTextModel } from "./SDKDocumentationPageBlockText";
3
- export type DocumentationPageBlockCodeModel = {
4
- codeLanguage?: string;
5
- caption?: string;
6
- } & DocumentationPageBlockTextModel;
7
- export declare class DocumentationPageBlockCode extends DocumentationPageBlockText {
8
- codeLanguage: string | null;
9
- caption: string | null;
10
- constructor(model: DocumentationPageBlockCodeModel, children: Array<DocumentationPageBlock>);
11
- }
@@ -1,4 +0,0 @@
1
- import { DocumentationPageBlock, DocumentationPageBlockModel } from "../SDKDocumentationPageBlock";
2
- export type DocumentationPageBlockColumnModel = DocumentationPageBlockModel;
3
- export declare class DocumentationPageBlockColumn extends DocumentationPageBlock {
4
- }
@@ -1,9 +0,0 @@
1
- import { DimensionTokenRemoteData } from "../../tokens/remote/SDKRemoteTokenData";
2
- import { DocumentationPageBlock, DocumentationPageBlockModel } from "../SDKDocumentationPageBlock";
3
- export type DocumentationPageBlockColumnItemModel = {
4
- width: DimensionTokenRemoteData;
5
- } & DocumentationPageBlockModel;
6
- export declare class DocumentationPageBlockColumnItem extends DocumentationPageBlock {
7
- width: DimensionTokenRemoteData;
8
- constructor(model: DocumentationPageBlockColumnItemModel, children: Array<DocumentationPageBlock>);
9
- }
@@ -1,15 +0,0 @@
1
- import { ExporterCustomBlock } from "../../exporters/custom_blocks/SDKExporterCustomBlock";
2
- import { DocumentationPageBlock, DocumentationPageBlockModel } from "../SDKDocumentationPageBlock";
3
- export type DocumentationPageBlockCustomModel = {
4
- customBlockKey: string;
5
- customBlockProperties?: Array<{
6
- key: string;
7
- value: any;
8
- }>;
9
- } & DocumentationPageBlockModel;
10
- export declare class DocumentationPageBlockCustom extends DocumentationPageBlock {
11
- key: string;
12
- properties: object;
13
- block: ExporterCustomBlock | null;
14
- constructor(model: DocumentationPageBlockCustomModel, children: Array<DocumentationPageBlock>, customBlocks: Array<ExporterCustomBlock>);
15
- }
@@ -1,4 +0,0 @@
1
- import { DocumentationPageBlock, DocumentationPageBlockModel } from "../SDKDocumentationPageBlock";
2
- export type DocumentationPageBlockDividerModel = DocumentationPageBlockModel;
3
- export declare class DocumentationPageBlockDivider extends DocumentationPageBlock {
4
- }
@@ -1,4 +0,0 @@
1
- import { DocumentationPageBlockEmbedGeneric, DocumentationPageBlockEmbedGenericModel } from "./SDKDocumentationPageBlockEmbedGeneric";
2
- export type DocumentationPageBlockEmbedFigmaModel = DocumentationPageBlockEmbedGenericModel;
3
- export declare class DocumentationPageBlockEmbedFigma extends DocumentationPageBlockEmbedGeneric {
4
- }
@@ -1,13 +0,0 @@
1
- import { Size, SizeModel } from "../../support/SDKSize";
2
- import { DocumentationPageBlock, DocumentationPageBlockModel } from "../SDKDocumentationPageBlock";
3
- export type DocumentationPageBlockEmbedGenericModel = {
4
- url?: string;
5
- size?: SizeModel;
6
- caption?: string;
7
- } & DocumentationPageBlockModel;
8
- export declare class DocumentationPageBlockEmbedGeneric extends DocumentationPageBlock {
9
- url: string | null;
10
- size: Size | null;
11
- caption: string | null;
12
- constructor(model: DocumentationPageBlockEmbedGenericModel, children: Array<DocumentationPageBlock>);
13
- }
@@ -1,15 +0,0 @@
1
- import { DocumentationPageBlock } from "../SDKDocumentationPageBlock";
2
- import { DocumentationPageBlockEmbedGeneric, DocumentationPageBlockEmbedGenericModel } from "./SDKDocumentationPageBlockEmbedGeneric";
3
- export type DocumentationPageBlockEmbedLinkModel = {
4
- urlPreview?: {
5
- title?: string;
6
- description?: string;
7
- thumbnailUrl?: string;
8
- };
9
- } & DocumentationPageBlockEmbedGenericModel;
10
- export declare class DocumentationPageBlockEmbedLink extends DocumentationPageBlockEmbedGeneric {
11
- title: string | null;
12
- description: string | null;
13
- thumbnailUrl: string | null;
14
- constructor(model: DocumentationPageBlockEmbedLinkModel, children: Array<DocumentationPageBlock>);
15
- }
@@ -1,4 +0,0 @@
1
- import { DocumentationPageBlockEmbedGeneric, DocumentationPageBlockEmbedGenericModel } from "./SDKDocumentationPageBlockEmbedGeneric";
2
- export type DocumentationPageBlockEmbedStorybookModel = DocumentationPageBlockEmbedGenericModel;
3
- export declare class DocumentationPageBlockEmbedStorybook extends DocumentationPageBlockEmbedGeneric {
4
- }
@@ -1,4 +0,0 @@
1
- import { DocumentationPageBlockEmbedGeneric, DocumentationPageBlockEmbedGenericModel } from "./SDKDocumentationPageBlockEmbedGeneric";
2
- export type DocumentationPageBlockEmbedYoutubeModel = DocumentationPageBlockEmbedGenericModel;
3
- export declare class DocumentationPageBlockEmbedYoutube extends DocumentationPageBlockEmbedGeneric {
4
- }
@@ -1,18 +0,0 @@
1
- import { FrameOrigin, FrameOriginModel } from "../../support/SDKFrameOrigin";
2
- import { ColorTokenRemoteData } from "../../tokens/remote/SDKRemoteTokenData";
3
- export type DocumentationPageBlockFrameModel = {
4
- sourceId: string;
5
- sourceFrameId: string;
6
- title?: string;
7
- description?: string;
8
- backgroundColor?: ColorTokenRemoteData;
9
- origin: FrameOriginModel;
10
- };
11
- export declare class DocumentationPageBlockFrame {
12
- title: string | null;
13
- description: string | null;
14
- previewUrl: string;
15
- backgroundColor: ColorTokenRemoteData | null;
16
- origin: FrameOrigin | null;
17
- constructor(model: DocumentationPageBlockFrameModel, blockBackgroundColor: ColorTokenRemoteData | null);
18
- }
@@ -1,24 +0,0 @@
1
- import { FrameAlignment } from "../../enums/SDKFrameAlignment";
2
- import { FrameLayout } from "../../enums/SDKFrameLayout";
3
- import { ColorTokenRemoteData } from "../../tokens/remote/SDKRemoteTokenData";
4
- import { DocumentationPageBlock, DocumentationPageBlockModel } from "../SDKDocumentationPageBlock";
5
- import { DocumentationPageBlockFrame, DocumentationPageBlockFrameModel } from "./SDKDocumentationPageBlockFrame";
6
- export type DocumentationPageBlockFramesModel = {
7
- figmaFrames: Array<DocumentationPageBlockFrameModel>;
8
- figmaFrameProperties: {
9
- alignment: FrameAlignment;
10
- color?: ColorTokenRemoteData;
11
- layout: FrameLayout;
12
- showTitles: boolean;
13
- };
14
- } & DocumentationPageBlockModel;
15
- export declare class DocumentationPageBlockFrames extends DocumentationPageBlock {
16
- frames: Array<DocumentationPageBlockFrame>;
17
- properties: {
18
- backgroundColor: ColorTokenRemoteData | null;
19
- alignment: FrameAlignment;
20
- layout: FrameLayout;
21
- showTitles: boolean;
22
- };
23
- constructor(model: DocumentationPageBlockFramesModel, children: Array<DocumentationPageBlock>);
24
- }
@@ -1,10 +0,0 @@
1
- import { DocumentationHeadingType } from "../../enums/SDKDocumentationHeadingType";
2
- import { DocumentationPageBlock } from "../SDKDocumentationPageBlock";
3
- import { DocumentationPageBlockText, DocumentationPageBlockTextModel } from "./SDKDocumentationPageBlockText";
4
- export type DocumentationPageBlockHeadingModel = {
5
- headingType: DocumentationHeadingType;
6
- } & DocumentationPageBlockTextModel;
7
- export declare class DocumentationPageBlockHeading extends DocumentationPageBlockText {
8
- headingType: DocumentationHeadingType;
9
- constructor(model: DocumentationPageBlockHeadingModel, children: Array<DocumentationPageBlock>);
10
- }
@@ -1,16 +0,0 @@
1
- import { Alignment } from "../../enums/SDKAlignment";
2
- import { DocumentationPageAsset, DocumentationPageAssetModel } from "../SDKDocumentationPageAsset";
3
- import { DocumentationPageBlock, DocumentationPageBlockModel } from "../SDKDocumentationPageBlock";
4
- export type DocumentationPageBlockImageModel = {
5
- asset?: DocumentationPageAssetModel;
6
- assetUrl?: string;
7
- caption?: string;
8
- alignment: Alignment;
9
- } & DocumentationPageBlockModel;
10
- export declare class DocumentationPageBlockImage extends DocumentationPageBlock {
11
- url: string | null;
12
- asset: DocumentationPageAsset;
13
- caption: string | null;
14
- alignment: Alignment;
15
- constructor(model: DocumentationPageBlockImageModel, children: Array<DocumentationPageBlock>);
16
- }
@@ -1,4 +0,0 @@
1
- import { DocumentationPageBlockText, DocumentationPageBlockTextModel } from "./SDKDocumentationPageBlockText";
2
- export type DocumentationPageOrderedListModel = DocumentationPageBlockTextModel;
3
- export declare class DocumentationPageOrderedList extends DocumentationPageBlockText {
4
- }
@@ -1,4 +0,0 @@
1
- import { DocumentationPageBlockText, DocumentationPageBlockTextModel } from "./SDKDocumentationPageBlockText";
2
- export type DocumentationPageBlockQuoteModel = DocumentationPageBlockTextModel;
3
- export declare class DocumentationPageBlockQuote extends DocumentationPageBlockText {
4
- }
@@ -1,33 +0,0 @@
1
- import { Alignment } from "../../enums/SDKAlignment";
2
- import { Size } from "../../support/SDKSize";
3
- import { DocumentationConfiguration } from "../SDKDocumentationConfiguration";
4
- import { DocumentationPageBlock } from "../SDKDocumentationPageBlock";
5
- import { DocumentationPageBlockTextModel } from "./SDKDocumentationPageBlockText";
6
- export type DocumentationPageBlockRenderCodeModel = {
7
- alignment: Alignment;
8
- renderCodeProperties: {
9
- showCode: boolean;
10
- };
11
- backgroundColor?: {
12
- value?: string;
13
- };
14
- size?: Size;
15
- } & DocumentationPageBlockTextModel;
16
- declare enum DocumentationPageBlockRenderCodeEnvironmentType {
17
- react = "react"
18
- }
19
- export declare class DocumentationPageBlockRenderCode extends DocumentationPageBlock {
20
- alignment: Alignment;
21
- backgroundColor: string | null;
22
- showCode: boolean;
23
- code: string;
24
- packageJSON: string;
25
- height: number | null;
26
- sandboxData: string;
27
- sandboxType: DocumentationPageBlockRenderCodeEnvironmentType;
28
- constructor(model: DocumentationPageBlockRenderCodeModel, children: Array<DocumentationPageBlock>, configuration: DocumentationConfiguration);
29
- private encodeSandboxData;
30
- btoaUnicode(str: any): string;
31
- atobUnicode(str: any): string;
32
- }
33
- export {};
@@ -1,35 +0,0 @@
1
- import { DocumentationPageAssetModel } from "../SDKDocumentationPageAsset";
2
- export type DocumentationPageBlockShortcutModel = {
3
- title?: string;
4
- description?: string;
5
- asset?: DocumentationPageAssetModel;
6
- assetId?: string;
7
- assetUrl?: string;
8
- documentationItemId?: string;
9
- url?: string;
10
- urlPreview?: {
11
- title?: string;
12
- description?: string;
13
- thumbnailUrl?: string;
14
- };
15
- documentationItemPreview?: {
16
- title?: string;
17
- valid?: boolean;
18
- };
19
- };
20
- export declare enum DocumentationPageBlockShortcutType {
21
- external = "External",
22
- internal = "Internal"
23
- }
24
- export declare class DocumentationPageBlockShortcut {
25
- title: string | null;
26
- description: string | null;
27
- previewUrl: string | null;
28
- externalUrl: string | null;
29
- internalId: string | null;
30
- type: DocumentationPageBlockShortcutType;
31
- constructor(model: DocumentationPageBlockShortcutModel);
32
- shortcutTitleFromModel(model: DocumentationPageBlockShortcutModel, type: DocumentationPageBlockShortcutType): string | null;
33
- shortcutDescriptionFromModel(model: DocumentationPageBlockShortcutModel, type: DocumentationPageBlockShortcutType): string | null;
34
- shortcutPreviewUrlFromModel(model: DocumentationPageBlockShortcutModel): string | null;
35
- }
@@ -1,9 +0,0 @@
1
- import { DocumentationPageBlock, DocumentationPageBlockModel } from "../SDKDocumentationPageBlock";
2
- import { DocumentationPageBlockShortcut, DocumentationPageBlockShortcutModel } from "./SDKDocumentationPageBlockShortcut";
3
- export type DocumentationPageBlockShortcutsModel = {
4
- shortcuts: Array<DocumentationPageBlockShortcutModel>;
5
- } & DocumentationPageBlockModel;
6
- export declare class DocumentationPageBlockShortcuts extends DocumentationPageBlock {
7
- shortcuts: Array<DocumentationPageBlockShortcut>;
8
- constructor(model: DocumentationPageBlockShortcutsModel, children: Array<DocumentationPageBlock>);
9
- }
@@ -1,4 +0,0 @@
1
- import { DocumentationPageBlock, DocumentationPageBlockModel } from "../SDKDocumentationPageBlock";
2
- export type DocumentationPageBlockTabModel = DocumentationPageBlockModel;
3
- export declare class DocumentationPageBlockTab extends DocumentationPageBlock {
4
- }
@@ -1,8 +0,0 @@
1
- import { DocumentationPageBlock, DocumentationPageBlockModel } from "../SDKDocumentationPageBlock";
2
- export type DocumentationPageBlockTabItemModel = {
3
- caption: string;
4
- } & DocumentationPageBlockModel;
5
- export declare class DocumentationPageBlockTabItem extends DocumentationPageBlock {
6
- caption: string;
7
- constructor(model: DocumentationPageBlockTabItemModel, children: Array<DocumentationPageBlock>);
8
- }
@@ -1,21 +0,0 @@
1
- import { DocumentationPageBlock, DocumentationPageBlockModel } from "../SDKDocumentationPageBlock";
2
- import { DocumentationPageBlockTableColumn, DocumentationPageBlockTableColumnModel } from "./SDKDocumentationPageBlockTableColumn";
3
- import { DocumentationPageBlockTableRowModel } from "./SDKDocumentationPageBlockTableRow";
4
- export type DocumentationPageBlockTableModel = {
5
- tableProperties: {
6
- showBorders: boolean;
7
- showHeaderRow: boolean;
8
- showHeaderColumn: boolean;
9
- columns: Array<DocumentationPageBlockTableColumnModel>;
10
- };
11
- rows: Array<DocumentationPageBlockTableRowModel>;
12
- } & DocumentationPageBlockModel;
13
- export declare class DocumentationPageBlockTable extends DocumentationPageBlock {
14
- tableProperties: {
15
- showBorders: boolean;
16
- showHeaderRow: boolean;
17
- showHeaderColumn: boolean;
18
- columns: Array<DocumentationPageBlockTableColumn>;
19
- };
20
- constructor(model: DocumentationPageBlockTableModel, children: Array<DocumentationPageBlock>);
21
- }
@@ -1,11 +0,0 @@
1
- import { Alignment } from "../../enums/SDKAlignment";
2
- import { DocumentationPageBlock, DocumentationPageBlockModel } from "../SDKDocumentationPageBlock";
3
- export type DocumentationPageBlockTableCellModel = {
4
- columnId: string;
5
- alignment: Alignment;
6
- } & DocumentationPageBlockModel;
7
- export declare class DocumentationPageBlockTableCell extends DocumentationPageBlock {
8
- columnId: string;
9
- alignment: Alignment;
10
- constructor(model: DocumentationPageBlockTableCellModel, children: Array<DocumentationPageBlock>);
11
- }
@@ -1,10 +0,0 @@
1
- import { DimensionTokenRemoteData } from "../../tokens/remote/SDKRemoteTokenData";
2
- export type DocumentationPageBlockTableColumnModel = {
3
- id: string;
4
- width: DimensionTokenRemoteData;
5
- };
6
- export declare class DocumentationPageBlockTableColumn {
7
- id: string;
8
- width: DimensionTokenRemoteData;
9
- constructor(model: DocumentationPageBlockTableColumnModel);
10
- }
@@ -1,4 +0,0 @@
1
- import { DocumentationPageBlock, DocumentationPageBlockModel } from "../SDKDocumentationPageBlock";
2
- export type DocumentationPageBlockTableRowModel = DocumentationPageBlockModel;
3
- export declare class DocumentationPageBlockTableRow extends DocumentationPageBlock {
4
- }