@supernova-studio/supernova-sdk-beta 1.6.31 → 1.6.33
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/sdk-typescript/.eslintrc.d.cts +41 -0
- package/build/sdk-typescript/src/core/SDKSupernova.d.ts +4 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +1 -14
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +34 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaMultiplayer.d.ts +10 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaResources.d.ts +6 -2
- package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +4 -1
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +18 -19
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +7 -7
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +9 -8
- package/build/sdk-typescript/src/core/resolvers/SDKAssetGroupResolver.d.ts +4 -0
- package/build/sdk-typescript/src/core/resolvers/SDKTokenResolver.d.ts +1 -1
- package/build/sdk-typescript/src/exports.d.ts +9 -1
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockBehavior.d.ts +2 -11
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockDefinition.d.ts +5 -21
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockItemDefinition.d.ts +3 -10
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockLayout.d.ts +2 -7
- package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockVariant.d.ts +2 -15
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts +2 -2
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockColorProperty.d.ts +13 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts +2 -2
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty.d.ts +19 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty.d.ts +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockProperty.d.ts +2 -10
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts +3 -3
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +10 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTableProperty.d.ts +23 -2
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +1 -1
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +2 -2
- package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsImageRef.d.ts +5 -2
- package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsLinkRef.d.ts +10 -7
- package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlock.d.ts +7 -20
- package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlockItem.d.ts +2 -7
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityHeader.d.ts +3 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageAsset.d.ts +1 -1
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockRenderCode.d.ts +1 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +5 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutAlign.d.ts +3 -3
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutColumnResizing.d.ts +2 -2
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutGap.d.ts +4 -4
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockMultiRichTextPropertyStyle.d.ts +8 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockRichTextPropertyStyle.d.ts +0 -4
- package/build/sdk-typescript/src/model/enums/SDKDocsPublishStatus.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts +19 -19
- package/build/sdk-typescript/src/model/enums/SDKUserRole.d.ts +2 -2
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuild.d.ts +6 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuildResults.d.ts +12 -0
- package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportDestinations.d.ts +16 -1
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteConnectionsModel.d.ts +1 -1
- package/build/sdk-typescript/src/model/groups/SDKAssetGroup.d.ts +4 -0
- package/build/sdk-typescript/src/model/resources/SDKResourceFont.d.ts +2 -2
- package/build/sdk-typescript/src/model/support/SDKFigmaFrame.d.ts +2 -0
- package/build/sdk-typescript/src/model/support/SDKSource.d.ts +10 -4
- package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +1 -1
- package/build/sdk-typescript/src/model/themes/SDKTokenTheme.d.ts +6 -6
- package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +6 -6
- package/build/sdk-typescript/src/model/tokens/SDKColorToken.d.ts +1 -0
- package/build/sdk-typescript/src/model/tokens/SDKDimensionToken.d.ts +1 -1
- package/build/sdk-typescript/src/model/tokens/SDKStringToken.d.ts +1 -1
- package/build/sdk-typescript/src/model/tokens/SDKTextCaseToken.d.ts +1 -1
- package/build/sdk-typescript/src/model/tokens/SDKTextDecorationToken.d.ts +1 -1
- package/build/sdk-typescript/src/model/tokens/SDKTokenValue.d.ts +2 -2
- package/build/sdk-typescript/src/tests/FigmaTokensDataLoader.d.ts +3 -3
- package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +2 -1
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONParser.d.ts +1 -1
- package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTGroupTree.d.ts +1 -1
- package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +11 -0
- package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementFigmaTokensTransformer.d.ts +1 -1
- package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementTransformer.d.ts +1 -1
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewGenerator.d.ts +4 -1
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewStyleGenerator.d.ts +4 -1
- package/build/sdk-typescript/src/utils/CommonUtils.d.ts +5 -0
- package/build/sdk-typescript/src/utils/TokenUtils.d.ts +3 -3
- package/build/sdk-typescript/src/utils/deepPartial.d.ts +3 -0
- package/build/supernova-sdk-typescript.js +1 -1
- package/build/supernova-sdk-typescript.js.LICENSE.txt +0 -14
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +122 -118
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
declare const _extends: string[];
|
|
2
|
+
export { _extends as extends };
|
|
3
|
+
export declare const root: boolean;
|
|
4
|
+
export declare const overrides: {
|
|
5
|
+
files: string[];
|
|
6
|
+
plugins: string[];
|
|
7
|
+
rules: {
|
|
8
|
+
"@typescript-eslint/unbound-method": string;
|
|
9
|
+
"jest/unbound-method": string;
|
|
10
|
+
};
|
|
11
|
+
}[];
|
|
12
|
+
export declare namespace parserOptions {
|
|
13
|
+
const tsconfigRootDir: string;
|
|
14
|
+
const project: string[];
|
|
15
|
+
}
|
|
16
|
+
export declare const rules: {
|
|
17
|
+
"@typescript-eslint/no-unsafe-assignment": string;
|
|
18
|
+
"@typescript-eslint/no-unsafe-member-access": string;
|
|
19
|
+
"@typescript-eslint/unbound-method": string;
|
|
20
|
+
"@typescript-eslint/no-unused-vars": string;
|
|
21
|
+
"no-restricted-syntax": string;
|
|
22
|
+
"fp/no-mutation": string;
|
|
23
|
+
"no-param-reassign": (string | {
|
|
24
|
+
props: boolean;
|
|
25
|
+
})[];
|
|
26
|
+
"@typescript-eslint/restrict-template-expressions": string;
|
|
27
|
+
"no-nested-ternary": string;
|
|
28
|
+
"no-prototype-builtins": string;
|
|
29
|
+
"prefer-destructuring": string;
|
|
30
|
+
"@typescript-eslint/no-unsafe-argument": string;
|
|
31
|
+
"@typescript-eslint/no-unsafe-return": string;
|
|
32
|
+
"@typescript-eslint/no-unsafe-call": string;
|
|
33
|
+
"@typescript-eslint/no-explicit-any": string;
|
|
34
|
+
"@typescript-eslint/no-var-requires": string;
|
|
35
|
+
"no-await-in-loop": string;
|
|
36
|
+
"no-continue": string;
|
|
37
|
+
"@typescript-eslint/no-useless-constructor": string;
|
|
38
|
+
"no-console": string;
|
|
39
|
+
"@typescript-eslint/require-await": string;
|
|
40
|
+
"max-classes-per-file": string;
|
|
41
|
+
};
|
|
@@ -8,6 +8,7 @@ import { AreaDesignSystems } from "./areas/SDKAreaDesignSystems";
|
|
|
8
8
|
import { AreaDocumentation } from "./areas/SDKAreaDocumentation";
|
|
9
9
|
import { AreaIntegrations } from "./areas/SDKAreaIntegrations";
|
|
10
10
|
import { AreaMe } from "./areas/SDKAreaMe";
|
|
11
|
+
import { AreaMultiplayer } from "./areas/SDKAreaMultiplayer";
|
|
11
12
|
import { AreaNetwork } from "./areas/SDKAreaNetwork";
|
|
12
13
|
import { AreaResources } from "./areas/SDKAreaResources";
|
|
13
14
|
import { AreaStorage } from "./areas/SDKAreaStorage";
|
|
@@ -57,6 +58,8 @@ export declare class Supernova {
|
|
|
57
58
|
storage: AreaStorage;
|
|
58
59
|
/** Get access to network in exporter packages */
|
|
59
60
|
network: AreaNetwork;
|
|
61
|
+
/** Get access to multiplayer capabilities */
|
|
62
|
+
multiplayer: AreaMultiplayer;
|
|
60
63
|
/**
|
|
61
64
|
* Create new Supernova.io SDK object.
|
|
62
65
|
* @param apiKey API key to use for authentication
|
|
@@ -69,5 +72,6 @@ export declare class Supernova {
|
|
|
69
72
|
apiUrl?: string;
|
|
70
73
|
requestHook?: DataBridgeRequestHook;
|
|
71
74
|
bypassEnvFetch?: boolean;
|
|
75
|
+
proxyUrl?: string;
|
|
72
76
|
});
|
|
73
77
|
}
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
|
|
2
1
|
import { CodegenAccount } from "../../model/exporters/CodegenAccount";
|
|
3
2
|
import { CodegenAzureOrganization } from "../../model/exporters/CodegenAzureOrganization";
|
|
4
3
|
import { CodegenAzureProject } from "../../model/exporters/CodegenAzureProject";
|
|
@@ -21,7 +20,7 @@ import { ExportBuild } from "../../model/exporters/exporter_builds/SDKExportBuil
|
|
|
21
20
|
import { ExportBuildResultLog } from "../../model/exporters/exporter_builds/SDKExportBuildResults";
|
|
22
21
|
import { ImportJob } from "../../model/jobs/SDKImportJob";
|
|
23
22
|
import { DataCore } from "../data/SDKDataCore";
|
|
24
|
-
import { RemoteVersionIdentifier
|
|
23
|
+
import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
25
24
|
export declare class AreaAutomation {
|
|
26
25
|
/** Internal: Engine */
|
|
27
26
|
private dataCore;
|
|
@@ -185,18 +184,6 @@ export declare class AreaAutomation {
|
|
|
185
184
|
* @returns All custom variants
|
|
186
185
|
*/
|
|
187
186
|
getExporterBlockVariants(workspaceId: string, exporterId: string): Promise<Array<ExporterCustomBlockVariant>>;
|
|
188
|
-
/** Publish documentation. This queues a build on Supernova's server that will be processed by the asynchronous CI/CD pipeline. You can request status of the build with associated `isBeingPublished` method. */
|
|
189
|
-
publish(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment): Promise<{
|
|
190
|
-
status: "Queued" | "InProgress" | "Failure";
|
|
191
|
-
jobId: string | null;
|
|
192
|
-
exporterId: string | null;
|
|
193
|
-
}>;
|
|
194
|
-
/** Publish documentation. This queues a build on Supernova's server that will be processed by the asynchronous CI/CD pipeline. You can request status of the build with associated `isBeingPublished` method. */
|
|
195
|
-
isPublishing(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment): Promise<{
|
|
196
|
-
status: "InProgress" | "Idle";
|
|
197
|
-
jobId: string | null;
|
|
198
|
-
exporterId: string | null;
|
|
199
|
-
}>;
|
|
200
187
|
/** Gets all import jobs that are currently in progress.
|
|
201
188
|
* @param userId - User id to delete integration for. Can only be invoked on user id that is currently authenticated.
|
|
202
189
|
* @returns Nothing
|
|
@@ -5,7 +5,11 @@ import { DocsEntity } from "../../model/docs/entities/SDKDocsEntity";
|
|
|
5
5
|
import { DocsSection } from "../../model/docs/sections/SDKDocsSection";
|
|
6
6
|
import { DocumentationLegacyGroup, DocumentationLegacyGroupModel } from "../../model/documentation/SDKDocumentationLegacyGroup";
|
|
7
7
|
import { DocumentationLegacyPage, DocumentationLegacyPageModel } from "../../model/documentation/SDKDocumentationLegacyPage";
|
|
8
|
-
import {
|
|
8
|
+
import { DocsPublishStatus } from "../../model/enums/SDKDocsPublishStatus";
|
|
9
|
+
import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
|
|
10
|
+
import { ExportBuild, ExportBuildStatus } from "../../model/exporters/exporter_builds/SDKExportBuild";
|
|
11
|
+
import { DeepPartial } from "../../utils/deepPartial";
|
|
12
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
9
13
|
import { RemoteVersionIdentifier, RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
10
14
|
export declare class AreaDocumentation {
|
|
11
15
|
/** Internal: Engine */
|
|
@@ -21,6 +25,28 @@ export declare class AreaDocumentation {
|
|
|
21
25
|
* @returns documentation url string
|
|
22
26
|
*/
|
|
23
27
|
getDocumentationUrl(from: RemoteVersionIdentifier): Promise<string>;
|
|
28
|
+
/** Retrieve information for an ongoing publishing build if any exists. */
|
|
29
|
+
isPublishing(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment): Promise<{
|
|
30
|
+
status: DocsPublishStatus.inProgress;
|
|
31
|
+
job: ExportBuild;
|
|
32
|
+
} | {
|
|
33
|
+
status: DocsPublishStatus.idle;
|
|
34
|
+
job: null;
|
|
35
|
+
}>;
|
|
36
|
+
/** Fetches a documentation build.
|
|
37
|
+
* @param workspaceId - Identifier of the workspace associated with the build.
|
|
38
|
+
* @param buildId - Identifier of the build.
|
|
39
|
+
*/
|
|
40
|
+
getDocumentationBuild(workspaceId: string, buildId: string): Promise<ExportBuild>;
|
|
41
|
+
/** Fetches documentation builds filtered according to the params.
|
|
42
|
+
* @param workspaceId - Identifier of the workspace associated with the builds.
|
|
43
|
+
* @param versionId - Identifier of the design system version associated with the builds.
|
|
44
|
+
* @param environment - Environment of the builds.
|
|
45
|
+
* @param status - Status of the builds.
|
|
46
|
+
* @param createdByUserId - Identifier of the user who created the builds.
|
|
47
|
+
* @param limit - Number of builds to return.
|
|
48
|
+
*/
|
|
49
|
+
getDocumentationBuilds(workspaceId: string, versionId: string, environment: DocumentationEnvironment, status?: ExportBuildStatus, createdByUserId?: string, limit?: number): Promise<Array<ExportBuild>>;
|
|
24
50
|
/** Updates documentation structure
|
|
25
51
|
* @param from - Remote version to fetch from
|
|
26
52
|
* @param model - documentation legacy model
|
|
@@ -132,6 +158,13 @@ export declare class AreaDocumentation {
|
|
|
132
158
|
* @returns Room ID that can be immediately used to join the multiplayer room
|
|
133
159
|
*/
|
|
134
160
|
getDocumentationPageRoomId(from: RemoteWorkspaceVersionIdentifier, pageId: string): Promise<string>;
|
|
161
|
+
/** Publish documentation. This queues a build on Supernova's server that will be processed by the asynchronous CI/CD pipeline.
|
|
162
|
+
* You can request status of the build with associated `isPublishing` method.
|
|
163
|
+
* @param to - Remote version where the build should be created
|
|
164
|
+
* @param environment - Environment to publish to
|
|
165
|
+
* @param isForcing - If true, a new build will be created regardless if an in-progress build already exists.
|
|
166
|
+
* */
|
|
167
|
+
publish(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment, isForcing?: boolean): Promise<ExportBuild>;
|
|
135
168
|
getDocumentationMockedStructure(): Array<DocsEntity>;
|
|
136
169
|
getDocumentationMockedPageContent(pageId: string): Array<DocsBlock | DocsSection>;
|
|
137
170
|
getDocumentationMockedEditorBlockDefinitions(): Array<DocsBlockDefinition>;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
2
|
+
export declare class AreaMultiplayer {
|
|
3
|
+
/** Internal: Engine */
|
|
4
|
+
private dataCore;
|
|
5
|
+
constructor(dataCore: DataCore);
|
|
6
|
+
/** Return multiplayer access token for specific room. */
|
|
7
|
+
getMultiplayerToken(room: string): Promise<{
|
|
8
|
+
token: string;
|
|
9
|
+
}>;
|
|
10
|
+
}
|
|
@@ -18,7 +18,11 @@ export declare class AreaResources {
|
|
|
18
18
|
/** Uploads new asset resource */
|
|
19
19
|
uploadAssetResource(from: RemoteVersionIdentifier, asset: File): Promise<ResourceAsset>;
|
|
20
20
|
/** Uploads new font resource */
|
|
21
|
-
uploadFontResource(from: RemoteVersionIdentifier, font: File): Promise<ResourceFont>;
|
|
22
|
-
/**
|
|
21
|
+
uploadFontResource(from: RemoteVersionIdentifier, font: File): Promise<ResourceFont | null>;
|
|
22
|
+
/** Uploads new font resources */
|
|
23
|
+
uploadFontResources(from: RemoteVersionIdentifier, fonts: FileList): Promise<ResourceFont[]>;
|
|
24
|
+
/** Deletes single resource of any type */
|
|
23
25
|
deleteResource(from: RemoteVersionIdentifier, resourceId: string): Promise<void>;
|
|
26
|
+
/** Deletes multiple resource of any type */
|
|
27
|
+
deleteResources(from: RemoteVersionIdentifier, resourceIds: string[]): Promise<void>;
|
|
24
28
|
}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { HttpsProxyAgent } from "https-proxy-agent";
|
|
1
2
|
type DataBridgeRequestHookResult = {
|
|
2
3
|
skipDefaultAuth?: boolean;
|
|
3
4
|
};
|
|
@@ -21,6 +22,7 @@ export type DataBridgeConfiguration = {
|
|
|
21
22
|
requestHook: DataBridgeRequestHook | null;
|
|
22
23
|
debugRequestObserver?: DebugRequestObserver | null;
|
|
23
24
|
debugResponseObserver?: DebugResponseObserver | null;
|
|
25
|
+
proxyUrl?: string | null;
|
|
24
26
|
};
|
|
25
27
|
export declare class DataBridge {
|
|
26
28
|
authToken: string;
|
|
@@ -28,6 +30,7 @@ export declare class DataBridge {
|
|
|
28
30
|
apiVersion: string;
|
|
29
31
|
target: string | null;
|
|
30
32
|
bypassEnvFetch: boolean;
|
|
33
|
+
proxyAgent: HttpsProxyAgent<string> | undefined;
|
|
31
34
|
requestHook: DataBridgeRequestHook | null;
|
|
32
35
|
debugRequestObserver: DebugRequestObserver | null;
|
|
33
36
|
debugResponseObserver: DebugResponseObserver | null;
|
|
@@ -36,7 +39,7 @@ export declare class DataBridge {
|
|
|
36
39
|
get(endpoint: string): Promise<any>;
|
|
37
40
|
put(endpoint: string, payload: any | null): Promise<any>;
|
|
38
41
|
post(endpoint: string, payload: any | null): Promise<any>;
|
|
39
|
-
upload(endpoint: string,
|
|
42
|
+
upload(endpoint: string, formData: FormData, method?: "PUT" | "POST"): Promise<any>;
|
|
40
43
|
private request;
|
|
41
44
|
private handleResponse;
|
|
42
45
|
private buildRequestConfig;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ResourceFont } from "../../exports";
|
|
1
|
+
import { ExportBuildStatus, ResourceFont } from "../../exports";
|
|
2
2
|
import { Acl } from "../../model/acl/SDKAcl";
|
|
3
3
|
import { Asset } from "../../model/assets/SDKAsset";
|
|
4
4
|
import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
|
|
@@ -70,13 +70,11 @@ import { SubscriptionProductFeatures } from "../../model/workspaces/SDKWorkspace
|
|
|
70
70
|
import { WorkspaceProfileUpdateModel } from "../../model/workspaces/SDKWorkspaceProfile";
|
|
71
71
|
import { WorkspaceSSOSettings, WorkspaceSSOSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
72
72
|
import { WorkspaceSubscription, WorkspaceSubscriptionUpdateModel } from "../../model/workspaces/SDKWorkspaceSubscription";
|
|
73
|
+
import { DeepPartial } from "../../utils/deepPartial";
|
|
73
74
|
import { ComponentUpdateTransactionData, TokenUpdateTransactionData } from "../areas/SDKAreaBulkOperations";
|
|
74
75
|
import { RenderedAssetRequestSettings } from "./requests/SDKDataCoreRenderRequests";
|
|
75
76
|
import { DataBridge } from "./SDKDataBridge";
|
|
76
77
|
import { RequestInfo, RequestInit, Response } from "node-fetch";
|
|
77
|
-
export type DeepPartial<T> = T extends object ? {
|
|
78
|
-
[P in keyof T]?: DeepPartial<T[P]>;
|
|
79
|
-
} : T;
|
|
80
78
|
export declare class DataCore {
|
|
81
79
|
/** Read part of the network calls */
|
|
82
80
|
private read;
|
|
@@ -88,6 +86,10 @@ export declare class DataCore {
|
|
|
88
86
|
private bridge;
|
|
89
87
|
constructor(bridge: DataBridge);
|
|
90
88
|
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
89
|
+
/** Remote: Get single-use multiplayer token */
|
|
90
|
+
multiplayerToken(room: string): Promise<{
|
|
91
|
+
token: string;
|
|
92
|
+
}>;
|
|
91
93
|
/** Remote: Get information about currently logged in user */
|
|
92
94
|
currentUser(): Promise<User>;
|
|
93
95
|
/** Remote: Get information about a specific user */
|
|
@@ -266,11 +268,7 @@ export declare class DataCore {
|
|
|
266
268
|
/** Retrieve currently deployed documentation url */
|
|
267
269
|
documentationDomain(designSystemId: string, versionId: string): Promise<string | null>;
|
|
268
270
|
/** Publish the documentation */
|
|
269
|
-
documentationPublish(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<
|
|
270
|
-
status: "Queued" | "InProgress" | "Failure";
|
|
271
|
-
jobId: string;
|
|
272
|
-
exporterId: string;
|
|
273
|
-
}>;
|
|
271
|
+
documentationPublish(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<ExportBuild>;
|
|
274
272
|
/** Retrieve all asset resources */
|
|
275
273
|
assetResources(designSystemId: string, versionId: string): Promise<Array<ResourceAsset>>;
|
|
276
274
|
/** Retrieve all font resources */
|
|
@@ -278,9 +276,13 @@ export declare class DataCore {
|
|
|
278
276
|
/** Upload asset resource */
|
|
279
277
|
uploadAssetResource(designSystemId: string, versionId: string, asset: File): Promise<ResourceAsset>;
|
|
280
278
|
/** Upload font resource */
|
|
281
|
-
uploadFontResource(designSystemId: string, versionId: string, font: File): Promise<ResourceFont>;
|
|
282
|
-
/**
|
|
279
|
+
uploadFontResource(designSystemId: string, versionId: string, font: File): Promise<ResourceFont | null>;
|
|
280
|
+
/** Upload font resources */
|
|
281
|
+
uploadFontResources(designSystemId: string, versionId: string, fonts: FileList): Promise<ResourceFont[]>;
|
|
282
|
+
/** Delete any single resource */
|
|
283
283
|
deleteResource(designSystemId: string, versionId: string, resourceId: string): Promise<void>;
|
|
284
|
+
/** Delete any multiple resources */
|
|
285
|
+
deleteResources(designSystemId: string, versionId: string, resourceIds: string[]): Promise<void>;
|
|
284
286
|
pipelines(workspaceId: string, designSystemId?: string): Promise<Array<Pipeline>>;
|
|
285
287
|
githubConnections(): Promise<Array<CodegenConnection>>;
|
|
286
288
|
githubAccounts(githubConnectionId: string): Promise<Array<CodegenAccount>>;
|
|
@@ -329,13 +331,10 @@ export declare class DataCore {
|
|
|
329
331
|
deleteExporter(workspaceId: string, exporterId: string): Promise<void>;
|
|
330
332
|
/** Pull updates for exporter */
|
|
331
333
|
pullLatestExporter(workspaceId: string, exporterId: string): Promise<Exporter>;
|
|
332
|
-
exportBuilds(workspaceId: string,
|
|
334
|
+
exportBuilds(workspaceId: string, versionId: string): Promise<Array<ExportBuild>>;
|
|
335
|
+
documentationBuild(workspaceId: string, buildId: string): Promise<ExportBuild>;
|
|
333
336
|
/** Download information about documentation builds and retrieve it resolved */
|
|
334
|
-
documentationBuilds(workspaceId: string,
|
|
335
|
-
status: "InProgress" | "Success" | "Failed";
|
|
336
|
-
id: string | null;
|
|
337
|
-
exporterId: string | null;
|
|
338
|
-
}>>;
|
|
337
|
+
documentationBuilds(workspaceId: string, versionId: string, environment: DocumentationEnvironment, status?: ExportBuildStatus, createdByUserId?: string, limit?: number): Promise<Array<ExportBuild>>;
|
|
339
338
|
buildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLog>>;
|
|
340
339
|
workspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeatures>;
|
|
341
340
|
/** Download information about a single workspace and retrieve it resolved */
|
|
@@ -377,8 +376,8 @@ export declare class DataCore {
|
|
|
377
376
|
deleteWorkspaceNPMRegistrySettings(workspaceId: string): Promise<void>;
|
|
378
377
|
deleteWorkspaceMember(workspaceId: string, userId: string): Promise<void>;
|
|
379
378
|
deleteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
380
|
-
createCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity
|
|
381
|
-
createPortalSession(workspaceId: string, returnUrl: string, update
|
|
379
|
+
createCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity?: number | null): Promise<string>;
|
|
380
|
+
createPortalSession(workspaceId: string, returnUrl: string, update?: WorkspaceSubscriptionUpdateModel | null, cancel?: boolean | null): Promise<string>;
|
|
382
381
|
resendWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
383
382
|
restoreWorkspaceSubscription(workspaceId: string): Promise<void>;
|
|
384
383
|
/** Download information about a single design system and retrieve it resolved */
|
|
@@ -15,7 +15,7 @@ import { TokenType } from "../../../model/enums/SDKTokenType";
|
|
|
15
15
|
import { CodegenBitbucketProject } from "../../../model/exporters/CodegenBitbucketProject";
|
|
16
16
|
import { ExporterModel, ExporterProvider } from "../../../model/exporters/SDKExporter";
|
|
17
17
|
import { ExporterCustomBlockModel } from "../../../model/exporters/custom_blocks/SDKExporterCustomBlock";
|
|
18
|
-
import { ExportBuildModel } from "../../../model/exporters/exporter_builds/SDKExportBuild";
|
|
18
|
+
import { ExportBuildModel, ExportBuildStatus } from "../../../model/exporters/exporter_builds/SDKExportBuild";
|
|
19
19
|
import { ExportBuildResultLogModel } from "../../../model/exporters/exporter_builds/SDKExportBuildResults";
|
|
20
20
|
import { CodegenAzureBranchRemoteModel } from "../../../model/exporters/remote/SDKRemoteAzureCodegenBranchModel";
|
|
21
21
|
import { CodegenAzureOrganizationRemoteModel } from "../../../model/exporters/remote/SDKRemoteAzureCodegenOrganizationModel";
|
|
@@ -62,6 +62,10 @@ export declare class DataCoreReadRequests {
|
|
|
62
62
|
private bridge;
|
|
63
63
|
constructor(bridge: DataBridge);
|
|
64
64
|
/** Remote: Get information about currently logged in user */
|
|
65
|
+
getRemoteMultiplayerToken(room: string): Promise<{
|
|
66
|
+
token: string;
|
|
67
|
+
}>;
|
|
68
|
+
/** Remote: Get information about currently logged in user */
|
|
65
69
|
getRemoteCurrentUser(): Promise<UserRemoteModel>;
|
|
66
70
|
/** Remote: Get information about a specific user */
|
|
67
71
|
getRemoteUser(userId: any): Promise<UserRemoteModel>;
|
|
@@ -180,12 +184,8 @@ export declare class DataCoreReadRequests {
|
|
|
180
184
|
getRemoteBitbucketProjects(connectionId: string, worksapceId: string): Promise<CodegenBitbucketProject[]>;
|
|
181
185
|
getRemoteBitbucketRepositories(connectionId: string, workspaceId: string, projectKey?: string): Promise<CodegenBitbucketRepositoryRemoteModel[]>;
|
|
182
186
|
getRemoteBitbucketBranches(connectionId: string, workspaceId: string, projectId: string, repositoryId: string): Promise<CodegenBitbucketBranchRemoteModel[]>;
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
status: "InProgress" | "Success" | "Failed";
|
|
186
|
-
id: string | null;
|
|
187
|
-
exporterId: string | null;
|
|
188
|
-
}>>;
|
|
187
|
+
getRemoteBuild(workspaceId: string, buildId: string): Promise<ExportBuildModel>;
|
|
188
|
+
getRemoteBuilds(workspaceId: string, versionId: string, docsEnvironment?: DocumentationEnvironment, limit?: number, offset?: number, scheduleId?: string, exporterId?: string, destinations?: Array<"s3" | "webhook" | "github" | "documentation" | "azure" | "gitlab">, createdByUserId?: string, status?: ExportBuildStatus): Promise<Array<ExportBuildModel>>;
|
|
189
189
|
getRemoteBuildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLogModel>>;
|
|
190
190
|
getBrands(designSystemId: string, versionId: string): Promise<Array<BrandRemoteModel>>;
|
|
191
191
|
getBrand(designSystemId: string, versionId: string, brandId: string): Promise<BrandRemoteModel>;
|
|
@@ -11,7 +11,9 @@ import { ConnectionProviders } from "../../../model/enums/SDKConnectionProviders
|
|
|
11
11
|
import { DocumentationEnvironment } from "../../../model/enums/SDKDocumentationEnvironment";
|
|
12
12
|
import { UserRoleWithoutOwner } from "../../../model/enums/SDKUserRole";
|
|
13
13
|
import { AzurePersonalAccessTokenConnectionPayload, PersonalAccessTokenConnectionPayload } from "../../../model/exporters/SDKConnections";
|
|
14
|
+
import { ExporterProvider, NewExporterPayload } from "../../../model/exporters/SDKExporter";
|
|
14
15
|
import { NewPipelinePayload, PipelineUpdateModel } from "../../../model/exporters/SDKPipeline";
|
|
16
|
+
import { ExportBuildModel } from "../../../model/exporters/exporter_builds/SDKExportBuild";
|
|
15
17
|
import { ConnectionRemoteModel } from "../../../model/exporters/remote/SDKRemoteConnectionsModel";
|
|
16
18
|
import { ComponentGroup, ComponentGroupRemoteModel } from "../../../model/groups/SDKComponentGroup";
|
|
17
19
|
import { TokenGroup, TokenGroupRemoteModel } from "../../../model/groups/SDKTokenGroup";
|
|
@@ -33,7 +35,6 @@ import { WorkspaceProfileUpdateModel } from "../../../model/workspaces/SDKWorksp
|
|
|
33
35
|
import { WorkspaceSSOSettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
34
36
|
import { WorkspaceSubscriptionUpdateModel } from "../../../model/workspaces/SDKWorkspaceSubscription";
|
|
35
37
|
import { DataBridge } from "../SDKDataBridge";
|
|
36
|
-
import { ExporterProvider, NewExporterPayload } from "model/exporters/SDKExporter";
|
|
37
38
|
export declare class DataCoreWriteRequests {
|
|
38
39
|
private bridge;
|
|
39
40
|
constructor(bridge: DataBridge);
|
|
@@ -103,7 +104,7 @@ export declare class DataCoreWriteRequests {
|
|
|
103
104
|
/** Remote: create Checkout session */
|
|
104
105
|
createRemoteCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity?: number | null): Promise<string>;
|
|
105
106
|
/** Remote: create Customer portal session */
|
|
106
|
-
createRemotePortalSession(workspaceId: string, returnUrl: string, update
|
|
107
|
+
createRemotePortalSession(workspaceId: string, returnUrl: string, update?: WorkspaceSubscriptionUpdateModel | null, cancel?: boolean | null): Promise<string>;
|
|
107
108
|
/** Remote: Resend the invitation */
|
|
108
109
|
resendRemoteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
109
110
|
/** Remote: Restore the cancelled subscription */
|
|
@@ -172,11 +173,7 @@ export declare class DataCoreWriteRequests {
|
|
|
172
173
|
deleteRemoteDocumentationGroup(designSystemId: string, versionId: string, group: DocumentationLegacyGroup): Promise<void>;
|
|
173
174
|
/** Remote: Deletes a documentation group and its contents */
|
|
174
175
|
deleteRemoteDocumentationGroupAndTree(designSystemId: string, versionId: string, group: DocumentationLegacyGroup): Promise<void>;
|
|
175
|
-
publishDocumentation(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<
|
|
176
|
-
status: "Queued" | "InProgress" | "Failure";
|
|
177
|
-
jobId: string;
|
|
178
|
-
exporterId: string;
|
|
179
|
-
}>;
|
|
176
|
+
publishDocumentation(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<ExportBuildModel>;
|
|
180
177
|
createRemoteToken(designSystemId: string, versionId: string, token: TokenRemoteModel): Promise<TokenRemoteModel>;
|
|
181
178
|
updateRemoteToken(designSystemId: string, versionId: string, token: TokenRemoteModel): Promise<TokenRemoteModel>;
|
|
182
179
|
createRemoteTokenGroup(designSystemId: string, versionId: string, group: TokenGroupRemoteModel): Promise<TokenGroupRemoteModel>;
|
|
@@ -198,9 +195,13 @@ export declare class DataCoreWriteRequests {
|
|
|
198
195
|
/** Remote: Upload a new asset resource */
|
|
199
196
|
uploadAssetResource(designSystemId: string, versionId: string, asset: File): Promise<ResourceAssetModel>;
|
|
200
197
|
/** Remote: Upload a new font resource */
|
|
201
|
-
uploadFontResource(designSystemId: string, versionId: string, font: File): Promise<ResourceFontModel>;
|
|
198
|
+
uploadFontResource(designSystemId: string, versionId: string, font: File): Promise<ResourceFontModel | null>;
|
|
199
|
+
/** Remote: Upload a new font resources */
|
|
200
|
+
uploadFontResources(designSystemId: string, versionId: string, fonts: FileList): Promise<ResourceFontModel[]>;
|
|
202
201
|
/** Remote: Delete a resource */
|
|
203
202
|
deleteResource(designSystemId: string, versionId: string, resourceId: string): Promise<void>;
|
|
203
|
+
/** Remote: Delete resources */
|
|
204
|
+
deleteResources(designSystemId: string, versionId: string, resourceIds: string[]): Promise<void>;
|
|
204
205
|
createRemoteComponent(designSystemId: string, versionId: string, component: ComponentRemoteModel): Promise<ComponentRemoteModel>;
|
|
205
206
|
updateRemoteComponent(designSystemId: string, versionId: string, component: ComponentUpdateRemoteModel): Promise<ComponentRemoteModel>;
|
|
206
207
|
createRemoteComponentGroup(designSystemId: string, versionId: string, group: ComponentGroupRemoteModel): Promise<ComponentGroupRemoteModel>;
|
|
@@ -5,6 +5,10 @@ export declare class AssetGroupResolver {
|
|
|
5
5
|
assets: Array<Asset>;
|
|
6
6
|
constructor(assets: Array<Asset>);
|
|
7
7
|
resolveGroupData(data: Array<DesignComponentGroupRemoteModel>): Array<AssetGroup>;
|
|
8
|
+
private markAssetGroups;
|
|
9
|
+
private markAssetAncestors;
|
|
10
|
+
private assignSourceDataToGroups;
|
|
11
|
+
private propagateSourceDataToAncestors;
|
|
8
12
|
private recomputePaths;
|
|
9
13
|
private recomputePathsFromRoot;
|
|
10
14
|
private reorderGroupsByRoots;
|
|
@@ -40,7 +40,7 @@ export declare class TokenResolver {
|
|
|
40
40
|
fixMultilayerGradientTokens(tokens: Array<GradientToken>, groups: Array<TokenGroup>): void;
|
|
41
41
|
fixMultilayerBlurTokens(tokens: Array<BlurToken>, groups: Array<TokenGroup>): void;
|
|
42
42
|
findAssociatedTokens<T extends Token>(token: T, tokens: Array<T>, groups: Array<TokenGroup>): Array<T>;
|
|
43
|
-
actualOriginTokenId(id: string | null): string;
|
|
43
|
+
actualOriginTokenId(id: string | null): string | null | undefined;
|
|
44
44
|
constructReferencedToken(rawData: TokenRemoteModel, properties: Array<ElementProperty>, values: Array<ElementPropertyValue>): Token;
|
|
45
45
|
constructReferencedThemedToken(rawData: TokenThemeOverrideRemoteModel, themeId: string): Token;
|
|
46
46
|
constructResolvedThemedToken(rawData: TokenThemeOverrideRemoteModel, referencedToken: Token, themeId: string): Token;
|
|
@@ -32,8 +32,10 @@ export { SubscriptionProductFeatures } from "./model/workspaces/SDKWorkspaceProd
|
|
|
32
32
|
export type { ProductFeature } from "./model/workspaces/SDKWorkspaceProductFeatures";
|
|
33
33
|
export type { FeaturePermissionResolution } from "./model/workspaces/SDKWorkspaceProductFeatures";
|
|
34
34
|
export { Brand } from "./model/base/SDKBrand";
|
|
35
|
+
export type { BrandUpdateModel } from "./model/base/SDKBrand";
|
|
35
36
|
export { DesignSystem } from "./model/base/SDKDesignSystem";
|
|
36
37
|
export { DesignSystemVersion } from "./model/base/SDKDesignSystemVersion";
|
|
38
|
+
export type { DesignSystemVersionUpdateModel } from "./model/base/SDKDesignSystemVersion";
|
|
37
39
|
export { Membership } from "./model/membership/SDKMembership";
|
|
38
40
|
export { Exporter, type NewExporterPayload, type ExporterProvider, } from "./model/exporters/SDKExporter";
|
|
39
41
|
export { Pipeline } from "./model/exporters/SDKPipeline";
|
|
@@ -91,6 +93,8 @@ export { DocsBlockNumberPropertyDefinition } from "./model/docs/blocks/propertie
|
|
|
91
93
|
export type { DocsBlockNumberPropertyData, DocsBlockNumberPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockNumberProperty";
|
|
92
94
|
export { DocsBlockRichTextPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockRichTextProperty";
|
|
93
95
|
export type { DocsBlockRichTextPropertyData, DocsBlockRichTextPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockRichTextProperty";
|
|
96
|
+
export { DocsBlockMultiRichTextPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty";
|
|
97
|
+
export type { DocsBlockMultiRichTextPropertyData, DocsBlockMultiRichTextPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty";
|
|
94
98
|
export { DocsBlockSingleSelectPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty";
|
|
95
99
|
export type { DocsBlockSingleSelectPropertyData, DocsBlockSingleSelectPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty";
|
|
96
100
|
export { DocsBlockTablePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTableProperty";
|
|
@@ -106,6 +110,8 @@ export type { DocsBlockTokenPropertyPropertyData, DocsBlockTokenPropertyProperty
|
|
|
106
110
|
export { DocsBlockTokenTypePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty";
|
|
107
111
|
export type { DocsBlockTokenTypePropertyData, DocsBlockTokenTypePropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty";
|
|
108
112
|
export { DocsBlockDividerPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockDividerProperty";
|
|
113
|
+
export type { DocsBlockColorPropertyData, DocsBlockColorPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockColorProperty";
|
|
114
|
+
export { DocsBlockColorPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockColorProperty";
|
|
109
115
|
export type { DocsBlockDividerPropertyData, DocsBlockDividerPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockDividerProperty";
|
|
110
116
|
export { DocsBlockStorybookPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockStorybookProperty";
|
|
111
117
|
export type { DocsBlockStorybookPropertyData, DocsBlockStorybookPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockStorybookProperty";
|
|
@@ -199,6 +205,8 @@ export { DocsEntityType } from "./model/enums/SDKDocsEntityType";
|
|
|
199
205
|
export { DocsSectionType } from "./model/enums/SDKDocsSectionType";
|
|
200
206
|
export { SourceType } from "./model/enums/SDKSourceType";
|
|
201
207
|
export { DocsBlockImagePropertyWidth } from "./model/enums/SDKDocsBlockImagePropertyWidth";
|
|
208
|
+
export { DocsPublishStatus } from "./model/enums/SDKDocsPublishStatus";
|
|
209
|
+
export { DocumentationEnvironment } from "./model/enums/SDKDocumentationEnvironment";
|
|
202
210
|
export { FrameAlignment } from "./model/enums/SDKFrameAlignment";
|
|
203
211
|
export { FrameLayout } from "./model/enums/SDKFrameLayout";
|
|
204
212
|
export { GradientType } from "./model/enums/SDKGradientType";
|
|
@@ -249,7 +257,7 @@ export { TextCaseToken } from "./model/tokens/SDKTextCaseToken";
|
|
|
249
257
|
export { TextDecorationToken } from "./model/tokens/SDKTextDecorationToken";
|
|
250
258
|
export { VisibilityToken } from "./model/tokens/SDKVisibilityToken";
|
|
251
259
|
export { Token } from "./model/tokens/SDKToken";
|
|
252
|
-
export type { AnyToken, AnyTokenValue, BlurTokenValue, BorderTokenValue, ColorTokenValue, GradientStopValue, GradientTokenValue, ShadowTokenValue, StringTokenValue, ProductCopyTokenValue, AnyStringTokenValue, TokenValue, TextCaseTokenValue, TextDecorationTokenValue, VisibilityTokenValue, TypographyTokenValue, DimensionTokenValue, SizeTokenValue, SpaceTokenValue, OpacityTokenValue, FontSizeTokenValue, LineHeightTokenValue, LetterSpacingTokenValue, ParagraphSpacingTokenValue, BorderWidthTokenValue, RadiusTokenValue, DurationTokenValue, ZIndexTokenValue, AnyDimensionTokenValue, } from "./model/tokens/SDKTokenValue";
|
|
260
|
+
export type { AnyToken, AnyTokenValue, BlurTokenValue, BorderTokenValue, ColorTokenValue, GradientStopValue, GradientTokenValue, ShadowTokenValue, StringTokenValue, ProductCopyTokenValue, AnyStringTokenValue, TokenValue, TextCaseTokenValue, TextDecorationTokenValue, VisibilityTokenValue, TypographyTokenValue, FontFamilyTokenValue, FontWeightTokenValue, DimensionTokenValue, SizeTokenValue, SpaceTokenValue, OpacityTokenValue, FontSizeTokenValue, LineHeightTokenValue, LetterSpacingTokenValue, ParagraphSpacingTokenValue, BorderWidthTokenValue, RadiusTokenValue, DurationTokenValue, ZIndexTokenValue, AnyDimensionTokenValue, } from "./model/tokens/SDKTokenValue";
|
|
253
261
|
export { TokenTheme } from "./model/themes/SDKTokenTheme";
|
|
254
262
|
export { TokenThemeOverride } from "./model/themes/SDKTokenThemeOverride";
|
|
255
263
|
export { TokenUtilPreviewGenerator } from "./tools/token-preview/TokenUtilPreviewGenerator";
|
|
@@ -1,16 +1,7 @@
|
|
|
1
|
+
import { PageBlockDefinitionBehavior } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockBehaviorDataType } from "../../../enums/SDKDocsBlockBehaviorDataType";
|
|
2
3
|
import { DocsBlockBehaviorSelectionType } from "../../../enums/SDKDocsBlockBehaviorSelectionType";
|
|
3
|
-
export type DocsBlockBehaviorModel =
|
|
4
|
-
dataType: DocsBlockBehaviorDataType;
|
|
5
|
-
items?: {
|
|
6
|
-
numberOfItems?: number;
|
|
7
|
-
allowLinks?: boolean;
|
|
8
|
-
};
|
|
9
|
-
entities?: {
|
|
10
|
-
selectionType: DocsBlockBehaviorSelectionType;
|
|
11
|
-
maxSelected?: number;
|
|
12
|
-
};
|
|
13
|
-
};
|
|
4
|
+
export type DocsBlockBehaviorModel = PageBlockDefinitionBehavior;
|
|
14
5
|
export declare class DocsBlockBehavior {
|
|
15
6
|
/** Defines what data block uses, and generates */
|
|
16
7
|
dataType: DocsBlockBehaviorDataType;
|
|
@@ -1,27 +1,11 @@
|
|
|
1
|
+
import { PageBlockDefinition } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockMode } from "../../../enums/SDKDocBlockMode";
|
|
2
3
|
import { DocsBlockCategory } from "../../../enums/SDKDocsBlockCategory";
|
|
3
4
|
import { DocsImageRef } from "../support/SDKDocsImageRef";
|
|
4
|
-
import { DocsBlockBehavior
|
|
5
|
-
import { DocsBlockItemDefinition
|
|
6
|
-
import { DocsBlockOnboarding
|
|
7
|
-
export type DocsBlockDefinitionModel =
|
|
8
|
-
id: string;
|
|
9
|
-
name: string;
|
|
10
|
-
description: string;
|
|
11
|
-
category: DocsBlockCategory;
|
|
12
|
-
icon?: DocsImageRef;
|
|
13
|
-
documentationLink?: string;
|
|
14
|
-
searchKeywords?: Array<string>;
|
|
15
|
-
item: DocsBlockItemDefinitionModel;
|
|
16
|
-
behavior: DocsBlockBehaviorModel;
|
|
17
|
-
editorOptions?: {
|
|
18
|
-
onboarding?: DocsBlockOnboardingModel;
|
|
19
|
-
};
|
|
20
|
-
appearance?: {
|
|
21
|
-
isBordered?: boolean;
|
|
22
|
-
hasBackground?: boolean;
|
|
23
|
-
};
|
|
24
|
-
};
|
|
5
|
+
import { DocsBlockBehavior } from "./SDKDocsBlockBehavior";
|
|
6
|
+
import { DocsBlockItemDefinition } from "./SDKDocsBlockItemDefinition";
|
|
7
|
+
import { DocsBlockOnboarding } from "./SDKDocsBlockOnboarding";
|
|
8
|
+
export type DocsBlockDefinitionModel = PageBlockDefinition;
|
|
25
9
|
export declare class DocsBlockDefinition {
|
|
26
10
|
/** Unique id of the block. Block id must be unique across all blocks registered to Supernova in preparation for block store. Reserved ids will be created for all core blocks and they'll be installed by default to every exporter */
|
|
27
11
|
id: string;
|
package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockItemDefinition.d.ts
CHANGED
|
@@ -1,14 +1,7 @@
|
|
|
1
|
+
import { PageBlockDefinitionItem } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockItemPropertyAnyDefinition } from "../properties/SDKDocsBlockProperty";
|
|
2
|
-
import { DocsBlockVariant
|
|
3
|
-
export type DocsBlockItemDefinitionModel =
|
|
4
|
-
properties: Array<DocsBlockItemPropertyAnyDefinition>;
|
|
5
|
-
appearance?: {
|
|
6
|
-
isBordered?: boolean;
|
|
7
|
-
hasBackground?: boolean;
|
|
8
|
-
};
|
|
9
|
-
variants: Array<DocsBlockVariantModel>;
|
|
10
|
-
defaultVariantKey: string;
|
|
11
|
-
};
|
|
3
|
+
import { DocsBlockVariant } from "./SDKDocsBlockVariant";
|
|
4
|
+
export type DocsBlockItemDefinitionModel = PageBlockDefinitionItem;
|
|
12
5
|
export declare class DocsBlockItemDefinition {
|
|
13
6
|
/** All properties that user can potentially input via one block / item */
|
|
14
7
|
properties: Array<DocsBlockItemPropertyAnyDefinition>;
|
|
@@ -1,14 +1,9 @@
|
|
|
1
|
+
import { PageBlockDefinitionLayout } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockItemVariantLayoutAlign } from "../../../enums/SDKDocsBlockItemVariantLayoutAlign";
|
|
2
3
|
import { DocsBlockItemVariantLayoutColumnResizing } from "../../../enums/SDKDocsBlockItemVariantLayoutColumnResizing";
|
|
3
4
|
import { DocsBlockItemVariantLayoutGap } from "../../../enums/SDKDocsBlockItemVariantLayoutGap";
|
|
4
5
|
import { DocsBlockItemVariantLayoutType } from "../../../enums/SDKDocsBlockItemVariantLayoutType";
|
|
5
|
-
export type DocsBlockLayoutModel =
|
|
6
|
-
type: DocsBlockItemVariantLayoutType;
|
|
7
|
-
children: Array<DocsBlockLayoutModel | string>;
|
|
8
|
-
gap?: DocsBlockItemVariantLayoutGap;
|
|
9
|
-
columnAlign?: DocsBlockItemVariantLayoutAlign;
|
|
10
|
-
columnResizing?: DocsBlockItemVariantLayoutColumnResizing;
|
|
11
|
-
};
|
|
6
|
+
export type DocsBlockLayoutModel = PageBlockDefinitionLayout;
|
|
12
7
|
export declare class DocsBlockLayout {
|
|
13
8
|
/** Type of a single node of the layout, either column for stacking vertically, or row for stacking horizontally */
|
|
14
9
|
type: DocsBlockItemVariantLayoutType;
|
|
@@ -1,19 +1,6 @@
|
|
|
1
|
+
import { PageBlockDefinitionVariant } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockLayout } from "./SDKDocsBlockLayout";
|
|
2
|
-
export type DocsBlockVariantModel =
|
|
3
|
-
id: string;
|
|
4
|
-
name: string;
|
|
5
|
-
image: string;
|
|
6
|
-
description?: string;
|
|
7
|
-
documentationLink?: string;
|
|
8
|
-
layout: DocsBlockLayout;
|
|
9
|
-
maxColumns?: number;
|
|
10
|
-
defaultColumns?: number;
|
|
11
|
-
appearance?: {
|
|
12
|
-
isBordered?: boolean;
|
|
13
|
-
hasBackground?: boolean;
|
|
14
|
-
isEditorPresentationDifferent?: boolean;
|
|
15
|
-
};
|
|
16
|
-
};
|
|
3
|
+
export type DocsBlockVariantModel = PageBlockDefinitionVariant;
|
|
17
4
|
export declare class DocsBlockVariant {
|
|
18
5
|
/** Variant id, validated to be unique within a block, but not necessarily unique across all blocks */
|
|
19
6
|
id: string;
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ export type DocsBlockAssetPropertyOptions = Record<string, never>;
|
|
|
6
6
|
/** Asset property - Data */
|
|
7
7
|
export type DocsBlockAssetPropertyData = DocsBlockPropertyData<Array<{
|
|
8
8
|
entityId: string;
|
|
9
|
-
entityType: "
|
|
9
|
+
entityType: "Asset" | "AssetGroup";
|
|
10
10
|
}>> & {
|
|
11
11
|
/** Selected asset ids */
|
|
12
12
|
selectedPropertyIds?: Array<string>;
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ export type DocsBlockBooleanPropertyOptions = {
|
|
|
6
6
|
/** Default value to set when block is created */
|
|
7
7
|
defaultValue?: boolean;
|
|
8
8
|
/** Visual representation of the property */
|
|
9
|
-
|
|
9
|
+
booleanStyle?: Exclude<DocsBlockItemPropertyOptionRenderingStyle, DocsBlockItemPropertyOptionRenderingStyle.select>;
|
|
10
10
|
};
|
|
11
11
|
/** Boolean property - Data */
|
|
12
12
|
export type DocsBlockBooleanPropertyData = DocsBlockPropertyData<boolean> & Record<string, never>;
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts
CHANGED
|
@@ -3,13 +3,13 @@ import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBloc
|
|
|
3
3
|
/** Code Sandbox property - Additional non-value options */
|
|
4
4
|
export type DocsBlockCodeSandboxPropertyOptions = {
|
|
5
5
|
/** How should we render the code example in editor */
|
|
6
|
-
renderLayoutAs?: "
|
|
6
|
+
renderLayoutAs?: "PreviewOnTop" | "PreviewOnBottom" | "PreviewOnLeft" | "PreviewOnRight";
|
|
7
7
|
};
|
|
8
8
|
/** Code Sandbox property - Data */
|
|
9
9
|
export type DocsBlockCodeSandboxPropertyData = DocsBlockPropertyData<string> & {
|
|
10
10
|
showCode?: boolean;
|
|
11
11
|
backgroundColor?: string;
|
|
12
|
-
alignPreview?: "
|
|
12
|
+
alignPreview?: "Left" | "Center";
|
|
13
13
|
};
|
|
14
14
|
/** Code Sandbox property - Definition model */
|
|
15
15
|
export type DocsBlockCodeSandboxPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockCodeSandboxPropertyOptions;
|