@supernova-studio/supernova-sdk-beta 1.6.30 → 1.6.32
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/sdk-typescript/.eslintrc.d.cts +41 -0
- package/build/sdk-typescript/src/core/SDKSupernova.d.ts +7 -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 +28 -0
- package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +4 -1
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +27 -16
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +13 -7
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +16 -7
- 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-pulsar.d.ts +1 -1
- package/build/sdk-typescript/src/exports.d.ts +21 -2
- 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 +7 -23
- package/build/sdk-typescript/src/model/docs/blocks/definition/{SDKDocsBlockItem.d.ts → SDKDocsBlockItemDefinition.d.ts} +5 -12
- 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 +4 -14
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/assets/SDKDocsBlockActualAssets.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/code/SDKDocsBlockActualCode.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/code-react/SDKDocsBlockActualCodeReact.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/component-checklist/SDKDocsBlockActualComponentChecklist.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/component-checklist-all/SDKDocsBlockActualComponentChecklistAll.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/component-health/SDKDocsBlockActualComponentHealth.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/figma-frames/SDKDocsBlockActualFigmaFrames.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/link/SDKDocsBlockActualLink.d.ts +8 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/omni-multi-item/SDKDocsBlockActualOmniMultiItem.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/omni-single-item/SDKDocsBlockActualOmniSingleItem.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/release-notes/SDKDocsBlockActualReleaseNotes.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts +8 -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 +5 -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 +7 -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/SDKDocsBlockNumberProperty.d.ts +2 -0
- 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 +7 -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 +2 -2
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +2 -2
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockUrlProperty.d.ts +14 -0
- 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 +11 -30
- package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlockItem.d.ts +16 -0
- 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/SDKDocsBlockAssetPropertyPreviewContainerSize.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockBehaviorDataType.d.ts +3 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockImagePropertyAspectRatio.d.ts +4 -2
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockImagePropertyWidth.d.ts +2 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +7 -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/SDKSourceType.d.ts +2 -1
- 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/SDKResource.d.ts +26 -0
- package/build/sdk-typescript/src/model/resources/SDKResourceAsset.d.ts +6 -0
- package/build/sdk-typescript/src/model/resources/SDKResourceFont.d.ts +15 -0
- package/build/sdk-typescript/src/model/support/SDKFigmaFrame.d.ts +2 -0
- package/build/sdk-typescript/src/model/support/SDKSource.d.ts +20 -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/model/users/SDKUserProfile.d.ts +10 -4
- 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 +40 -6
- 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 +118 -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,7 +8,9 @@ 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";
|
|
13
|
+
import { AreaResources } from "./areas/SDKAreaResources";
|
|
12
14
|
import { AreaStorage } from "./areas/SDKAreaStorage";
|
|
13
15
|
import { AreaTokens } from "./areas/SDKAreaTokens";
|
|
14
16
|
import { AreaUsers } from "./areas/SDKAreaUsers";
|
|
@@ -36,6 +38,8 @@ export declare class Supernova {
|
|
|
36
38
|
components: AreaComponents;
|
|
37
39
|
/** Get, create, update, manipulate or delete assets */
|
|
38
40
|
assets: AreaAssets;
|
|
41
|
+
/** Get, create, update, manipulate or delete resources */
|
|
42
|
+
resources: AreaResources;
|
|
39
43
|
/** Get, create, update, manipulate or delete documentation items */
|
|
40
44
|
documentation: AreaDocumentation;
|
|
41
45
|
/** Get, create, update, manipulate or delete pipelines and automation jobs */
|
|
@@ -54,6 +58,8 @@ export declare class Supernova {
|
|
|
54
58
|
storage: AreaStorage;
|
|
55
59
|
/** Get access to network in exporter packages */
|
|
56
60
|
network: AreaNetwork;
|
|
61
|
+
/** Get access to multiplayer capabilities */
|
|
62
|
+
multiplayer: AreaMultiplayer;
|
|
57
63
|
/**
|
|
58
64
|
* Create new Supernova.io SDK object.
|
|
59
65
|
* @param apiKey API key to use for authentication
|
|
@@ -66,5 +72,6 @@ export declare class Supernova {
|
|
|
66
72
|
apiUrl?: string;
|
|
67
73
|
requestHook?: DataBridgeRequestHook;
|
|
68
74
|
bypassEnvFetch?: boolean;
|
|
75
|
+
proxyUrl?: string;
|
|
69
76
|
});
|
|
70
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
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { ResourceAsset, ResourceFont } from "../../exports";
|
|
2
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
3
|
+
import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
4
|
+
export declare class AreaResources {
|
|
5
|
+
/** Internal: Engine */
|
|
6
|
+
private dataCore;
|
|
7
|
+
constructor(dataCore: DataCore);
|
|
8
|
+
/** Fetches all remote asset resources in the version
|
|
9
|
+
* @param from - Remote version to fetch from
|
|
10
|
+
* @returns All image resources in the specified version
|
|
11
|
+
*/
|
|
12
|
+
getAssetResources(from: RemoteVersionIdentifier): Promise<Array<ResourceAsset>>;
|
|
13
|
+
/** Fetches all remote font resources in the version
|
|
14
|
+
* @param from - Remote version to fetch from
|
|
15
|
+
* @returns All font resources in the specified version
|
|
16
|
+
*/
|
|
17
|
+
getFontResources(from: RemoteVersionIdentifier): Promise<Array<ResourceFont>>;
|
|
18
|
+
/** Uploads new asset resource */
|
|
19
|
+
uploadAssetResource(from: RemoteVersionIdentifier, asset: File): Promise<ResourceAsset>;
|
|
20
|
+
/** Uploads new font resource */
|
|
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 */
|
|
25
|
+
deleteResource(from: RemoteVersionIdentifier, resourceId: string): Promise<void>;
|
|
26
|
+
/** Deletes multiple resource of any type */
|
|
27
|
+
deleteResources(from: RemoteVersionIdentifier, resourceIds: string[]): Promise<void>;
|
|
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,3 +1,4 @@
|
|
|
1
|
+
import { ExportBuildStatus, ResourceFont } from "../../exports";
|
|
1
2
|
import { Acl } from "../../model/acl/SDKAcl";
|
|
2
3
|
import { Asset } from "../../model/assets/SDKAsset";
|
|
3
4
|
import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
|
|
@@ -48,6 +49,7 @@ import { DesignComponentGroup } from "../../model/groups/SDKDesignComponentGroup
|
|
|
48
49
|
import { TokenGroup } from "../../model/groups/SDKTokenGroup";
|
|
49
50
|
import { ImportJob } from "../../model/jobs/SDKImportJob";
|
|
50
51
|
import { Membership } from "../../model/membership/SDKMembership";
|
|
52
|
+
import { ResourceAsset } from "../../model/resources/SDKResourceAsset";
|
|
51
53
|
import { CustomDomain } from "../../model/support/SDKCustomDomain";
|
|
52
54
|
import { FigmaStructure } from "../../model/support/SDKFigmaStructure";
|
|
53
55
|
import { FigmaStructureDetail } from "../../model/support/SDKFigmaStructureDetail";
|
|
@@ -68,13 +70,11 @@ import { SubscriptionProductFeatures } from "../../model/workspaces/SDKWorkspace
|
|
|
68
70
|
import { WorkspaceProfileUpdateModel } from "../../model/workspaces/SDKWorkspaceProfile";
|
|
69
71
|
import { WorkspaceSSOSettings, WorkspaceSSOSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
70
72
|
import { WorkspaceSubscription, WorkspaceSubscriptionUpdateModel } from "../../model/workspaces/SDKWorkspaceSubscription";
|
|
73
|
+
import { DeepPartial } from "../../utils/deepPartial";
|
|
71
74
|
import { ComponentUpdateTransactionData, TokenUpdateTransactionData } from "../areas/SDKAreaBulkOperations";
|
|
72
75
|
import { RenderedAssetRequestSettings } from "./requests/SDKDataCoreRenderRequests";
|
|
73
76
|
import { DataBridge } from "./SDKDataBridge";
|
|
74
77
|
import { RequestInfo, RequestInit, Response } from "node-fetch";
|
|
75
|
-
export type DeepPartial<T> = T extends object ? {
|
|
76
|
-
[P in keyof T]?: DeepPartial<T[P]>;
|
|
77
|
-
} : T;
|
|
78
78
|
export declare class DataCore {
|
|
79
79
|
/** Read part of the network calls */
|
|
80
80
|
private read;
|
|
@@ -86,6 +86,10 @@ export declare class DataCore {
|
|
|
86
86
|
private bridge;
|
|
87
87
|
constructor(bridge: DataBridge);
|
|
88
88
|
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
89
|
+
/** Remote: Get single-use multiplayer token */
|
|
90
|
+
multiplayerToken(room: string): Promise<{
|
|
91
|
+
token: string;
|
|
92
|
+
}>;
|
|
89
93
|
/** Remote: Get information about currently logged in user */
|
|
90
94
|
currentUser(): Promise<User>;
|
|
91
95
|
/** Remote: Get information about a specific user */
|
|
@@ -264,11 +268,21 @@ export declare class DataCore {
|
|
|
264
268
|
/** Retrieve currently deployed documentation url */
|
|
265
269
|
documentationDomain(designSystemId: string, versionId: string): Promise<string | null>;
|
|
266
270
|
/** Publish the documentation */
|
|
267
|
-
documentationPublish(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
271
|
+
documentationPublish(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<ExportBuild>;
|
|
272
|
+
/** Retrieve all asset resources */
|
|
273
|
+
assetResources(designSystemId: string, versionId: string): Promise<Array<ResourceAsset>>;
|
|
274
|
+
/** Retrieve all font resources */
|
|
275
|
+
fontResources(designSystemId: string, versionId: string): Promise<Array<ResourceFont>>;
|
|
276
|
+
/** Upload asset resource */
|
|
277
|
+
uploadAssetResource(designSystemId: string, versionId: string, asset: File): Promise<ResourceAsset>;
|
|
278
|
+
/** Upload font resource */
|
|
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
|
+
deleteResource(designSystemId: string, versionId: string, resourceId: string): Promise<void>;
|
|
284
|
+
/** Delete any multiple resources */
|
|
285
|
+
deleteResources(designSystemId: string, versionId: string, resourceIds: string[]): Promise<void>;
|
|
272
286
|
pipelines(workspaceId: string, designSystemId?: string): Promise<Array<Pipeline>>;
|
|
273
287
|
githubConnections(): Promise<Array<CodegenConnection>>;
|
|
274
288
|
githubAccounts(githubConnectionId: string): Promise<Array<CodegenAccount>>;
|
|
@@ -317,13 +331,10 @@ export declare class DataCore {
|
|
|
317
331
|
deleteExporter(workspaceId: string, exporterId: string): Promise<void>;
|
|
318
332
|
/** Pull updates for exporter */
|
|
319
333
|
pullLatestExporter(workspaceId: string, exporterId: string): Promise<Exporter>;
|
|
320
|
-
exportBuilds(workspaceId: string,
|
|
334
|
+
exportBuilds(workspaceId: string, versionId: string): Promise<Array<ExportBuild>>;
|
|
335
|
+
documentationBuild(workspaceId: string, buildId: string): Promise<ExportBuild>;
|
|
321
336
|
/** Download information about documentation builds and retrieve it resolved */
|
|
322
|
-
documentationBuilds(workspaceId: string,
|
|
323
|
-
status: "InProgress" | "Success" | "Failed";
|
|
324
|
-
id: string | null;
|
|
325
|
-
exporterId: string | null;
|
|
326
|
-
}>>;
|
|
337
|
+
documentationBuilds(workspaceId: string, versionId: string, environment: DocumentationEnvironment, status?: ExportBuildStatus, createdByUserId?: string, limit?: number): Promise<Array<ExportBuild>>;
|
|
327
338
|
buildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLog>>;
|
|
328
339
|
workspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeatures>;
|
|
329
340
|
/** Download information about a single workspace and retrieve it resolved */
|
|
@@ -365,8 +376,8 @@ export declare class DataCore {
|
|
|
365
376
|
deleteWorkspaceNPMRegistrySettings(workspaceId: string): Promise<void>;
|
|
366
377
|
deleteWorkspaceMember(workspaceId: string, userId: string): Promise<void>;
|
|
367
378
|
deleteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
368
|
-
createCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity
|
|
369
|
-
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>;
|
|
370
381
|
resendWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
371
382
|
restoreWorkspaceSubscription(workspaceId: string): Promise<void>;
|
|
372
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";
|
|
@@ -37,6 +37,8 @@ import { DesignComponentGroupRemoteModel } from "../../../model/groups/SDKDesign
|
|
|
37
37
|
import { TokenGroupRemoteModel } from "../../../model/groups/SDKTokenGroup";
|
|
38
38
|
import { ImportJobRemoteModel } from "../../../model/jobs/SDKImportJob";
|
|
39
39
|
import { MembershipRemoteModel } from "../../../model/membership/SDKMembership";
|
|
40
|
+
import { ResourceAssetModel } from "../../../model/resources/SDKResourceAsset";
|
|
41
|
+
import { ResourceFontModel } from "../../../model/resources/SDKResourceFont";
|
|
40
42
|
import { CustomDomainRemoteModel } from "../../../model/support/SDKCustomDomain";
|
|
41
43
|
import { FigmaStructureModel } from "../../../model/support/SDKFigmaStructure";
|
|
42
44
|
import { FigmaStructureDetailModel } from "../../../model/support/SDKFigmaStructureDetail";
|
|
@@ -60,6 +62,10 @@ export declare class DataCoreReadRequests {
|
|
|
60
62
|
private bridge;
|
|
61
63
|
constructor(bridge: DataBridge);
|
|
62
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 */
|
|
63
69
|
getRemoteCurrentUser(): Promise<UserRemoteModel>;
|
|
64
70
|
/** Remote: Get information about a specific user */
|
|
65
71
|
getRemoteUser(userId: any): Promise<UserRemoteModel>;
|
|
@@ -121,6 +127,10 @@ export declare class DataCoreReadRequests {
|
|
|
121
127
|
getRemoteExporters(workspaceId: string, filter?: {
|
|
122
128
|
installedOnly?: boolean;
|
|
123
129
|
}): Promise<Array<ExporterModel>>;
|
|
130
|
+
/** Remote: Get all asset resources */
|
|
131
|
+
getRemoteAssetResources(designSystemId: string, versionId: string): Promise<Array<ResourceAssetModel>>;
|
|
132
|
+
/** Remote: Get all font resources */
|
|
133
|
+
getRemoteFontResources(designSystemId: string, versionId: string): Promise<Array<ResourceFontModel>>;
|
|
124
134
|
/** Remote: Get all tokens from all categories */
|
|
125
135
|
getRemoteTokens(designSystemId: string, versionId: string, filter?: {
|
|
126
136
|
type?: TokenType;
|
|
@@ -174,12 +184,8 @@ export declare class DataCoreReadRequests {
|
|
|
174
184
|
getRemoteBitbucketProjects(connectionId: string, worksapceId: string): Promise<CodegenBitbucketProject[]>;
|
|
175
185
|
getRemoteBitbucketRepositories(connectionId: string, workspaceId: string, projectKey?: string): Promise<CodegenBitbucketRepositoryRemoteModel[]>;
|
|
176
186
|
getRemoteBitbucketBranches(connectionId: string, workspaceId: string, projectId: string, repositoryId: string): Promise<CodegenBitbucketBranchRemoteModel[]>;
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
status: "InProgress" | "Success" | "Failed";
|
|
180
|
-
id: string | null;
|
|
181
|
-
exporterId: string | null;
|
|
182
|
-
}>>;
|
|
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>>;
|
|
183
189
|
getRemoteBuildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLogModel>>;
|
|
184
190
|
getBrands(designSystemId: string, versionId: string): Promise<Array<BrandRemoteModel>>;
|
|
185
191
|
getBrand(designSystemId: string, versionId: string, brandId: string): Promise<BrandRemoteModel>;
|
|
@@ -11,11 +11,15 @@ 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";
|
|
18
20
|
import { ImportJobRemoteModel } from "../../../model/jobs/SDKImportJob";
|
|
21
|
+
import { ResourceAssetModel } from "../../../model/resources/SDKResourceAsset";
|
|
22
|
+
import { ResourceFontModel } from "../../../model/resources/SDKResourceFont";
|
|
19
23
|
import { CustomDomainRemoteModel } from "../../../model/support/SDKCustomDomain";
|
|
20
24
|
import { SourceRemoteModel } from "../../../model/support/SDKSource";
|
|
21
25
|
import { TokenThemeRemoteModel } from "../../../model/themes/SDKTokenTheme";
|
|
@@ -31,7 +35,6 @@ import { WorkspaceProfileUpdateModel } from "../../../model/workspaces/SDKWorksp
|
|
|
31
35
|
import { WorkspaceSSOSettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
32
36
|
import { WorkspaceSubscriptionUpdateModel } from "../../../model/workspaces/SDKWorkspaceSubscription";
|
|
33
37
|
import { DataBridge } from "../SDKDataBridge";
|
|
34
|
-
import { ExporterProvider, NewExporterPayload } from "model/exporters/SDKExporter";
|
|
35
38
|
export declare class DataCoreWriteRequests {
|
|
36
39
|
private bridge;
|
|
37
40
|
constructor(bridge: DataBridge);
|
|
@@ -101,7 +104,7 @@ export declare class DataCoreWriteRequests {
|
|
|
101
104
|
/** Remote: create Checkout session */
|
|
102
105
|
createRemoteCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity?: number | null): Promise<string>;
|
|
103
106
|
/** Remote: create Customer portal session */
|
|
104
|
-
createRemotePortalSession(workspaceId: string, returnUrl: string, update
|
|
107
|
+
createRemotePortalSession(workspaceId: string, returnUrl: string, update?: WorkspaceSubscriptionUpdateModel | null, cancel?: boolean | null): Promise<string>;
|
|
105
108
|
/** Remote: Resend the invitation */
|
|
106
109
|
resendRemoteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
107
110
|
/** Remote: Restore the cancelled subscription */
|
|
@@ -170,11 +173,7 @@ export declare class DataCoreWriteRequests {
|
|
|
170
173
|
deleteRemoteDocumentationGroup(designSystemId: string, versionId: string, group: DocumentationLegacyGroup): Promise<void>;
|
|
171
174
|
/** Remote: Deletes a documentation group and its contents */
|
|
172
175
|
deleteRemoteDocumentationGroupAndTree(designSystemId: string, versionId: string, group: DocumentationLegacyGroup): Promise<void>;
|
|
173
|
-
publishDocumentation(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<
|
|
174
|
-
status: "Queued" | "InProgress" | "Failure";
|
|
175
|
-
jobId: string;
|
|
176
|
-
exporterId: string;
|
|
177
|
-
}>;
|
|
176
|
+
publishDocumentation(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<ExportBuildModel>;
|
|
178
177
|
createRemoteToken(designSystemId: string, versionId: string, token: TokenRemoteModel): Promise<TokenRemoteModel>;
|
|
179
178
|
updateRemoteToken(designSystemId: string, versionId: string, token: TokenRemoteModel): Promise<TokenRemoteModel>;
|
|
180
179
|
createRemoteTokenGroup(designSystemId: string, versionId: string, group: TokenGroupRemoteModel): Promise<TokenGroupRemoteModel>;
|
|
@@ -193,6 +192,16 @@ export declare class DataCoreWriteRequests {
|
|
|
193
192
|
deleteTokenProperty(designSystemId: string, versionId: string, propertyId: string): Promise<void>;
|
|
194
193
|
updateReorderTokenColumn(designSystemId: string, versionId: string, viewId: string, columnId: string, newIndex: number): Promise<void>;
|
|
195
194
|
updateResizeTokenColumn(designSystemId: string, versionId: string, viewId: string, columnType: ElementDataViewColumnType, columnId: string, columnThemeId: string | undefined, columnBasePropertyType: string | undefined, columnPropertyDefinitionId: string | undefined, newWidth: number): Promise<void>;
|
|
195
|
+
/** Remote: Upload a new asset resource */
|
|
196
|
+
uploadAssetResource(designSystemId: string, versionId: string, asset: File): Promise<ResourceAssetModel>;
|
|
197
|
+
/** Remote: Upload a new font resource */
|
|
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[]>;
|
|
201
|
+
/** Remote: Delete a resource */
|
|
202
|
+
deleteResource(designSystemId: string, versionId: string, resourceId: string): Promise<void>;
|
|
203
|
+
/** Remote: Delete resources */
|
|
204
|
+
deleteResources(designSystemId: string, versionId: string, resourceIds: string[]): Promise<void>;
|
|
196
205
|
createRemoteComponent(designSystemId: string, versionId: string, component: ComponentRemoteModel): Promise<ComponentRemoteModel>;
|
|
197
206
|
updateRemoteComponent(designSystemId: string, versionId: string, component: ComponentUpdateRemoteModel): Promise<ComponentRemoteModel>;
|
|
198
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;
|
|
@@ -39,7 +39,7 @@ export type { ElementDataViewColumn } from "./model/elements/SDKElementDataViewC
|
|
|
39
39
|
export type { DesignComponent } from "./model/components/SDKDesignComponent";
|
|
40
40
|
export type { DocsBlockBehavior } from "./model/docs/blocks/definition/SDKDocsBlockBehavior";
|
|
41
41
|
export type { DocsBlockDefinition } from "./model/docs/blocks/definition/SDKDocsBlockDefinition";
|
|
42
|
-
export type {
|
|
42
|
+
export type { DocsBlockItemDefinition } from "./model/docs/blocks/definition/SDKDocsBlockItemDefinition";
|
|
43
43
|
export type { DocsBlockLayout } from "./model/docs/blocks/definition/SDKDocsBlockLayout";
|
|
44
44
|
export type { DocsBlockOnboarding } from "./model/docs/blocks/definition/SDKDocsBlockOnboarding";
|
|
45
45
|
export type { DocsBlockVariant } from "./model/docs/blocks/definition/SDKDocsBlockVariant";
|
|
@@ -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";
|
|
@@ -55,10 +57,11 @@ export { ElementDataViewColumn, ElementDataViewColumnBasePropertyType, ElementDa
|
|
|
55
57
|
export { DesignComponent } from "./model/components/SDKDesignComponent";
|
|
56
58
|
export { DocsBlockBehavior } from "./model/docs/blocks/definition/SDKDocsBlockBehavior";
|
|
57
59
|
export { DocsBlockDefinition } from "./model/docs/blocks/definition/SDKDocsBlockDefinition";
|
|
58
|
-
export {
|
|
60
|
+
export { DocsBlockItemDefinition } from "./model/docs/blocks/definition/SDKDocsBlockItemDefinition";
|
|
59
61
|
export { DocsBlockLayout } from "./model/docs/blocks/definition/SDKDocsBlockLayout";
|
|
60
62
|
export { DocsBlockOnboarding } from "./model/docs/blocks/definition/SDKDocsBlockOnboarding";
|
|
61
63
|
export { DocsBlockVariant } from "./model/docs/blocks/definition/SDKDocsBlockVariant";
|
|
64
|
+
export { DocsBlockMode } from "./model/enums/SDKDocBlockMode";
|
|
62
65
|
export { DocsEntity } from "./model/docs/entities/SDKDocsEntity";
|
|
63
66
|
export { DocsEntityGroup } from "./model/docs/entities/SDKDocsEntityGroup";
|
|
64
67
|
export { DocsEntityPage } from "./model/docs/entities/SDKDocsEntityPage";
|
|
@@ -90,11 +93,15 @@ export { DocsBlockNumberPropertyDefinition } from "./model/docs/blocks/propertie
|
|
|
90
93
|
export type { DocsBlockNumberPropertyData, DocsBlockNumberPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockNumberProperty";
|
|
91
94
|
export { DocsBlockRichTextPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockRichTextProperty";
|
|
92
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";
|
|
93
98
|
export { DocsBlockSingleSelectPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty";
|
|
94
99
|
export type { DocsBlockSingleSelectPropertyData, DocsBlockSingleSelectPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty";
|
|
95
100
|
export { DocsBlockTablePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTableProperty";
|
|
96
101
|
export type { DocsBlockTablePropertyData, DocsBlockTablePropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockTableProperty";
|
|
97
102
|
export { DocsBlockTextPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTextProperty";
|
|
103
|
+
export type { DocsBlockUrlPropertyData, DocsBlockUrlPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockUrlProperty";
|
|
104
|
+
export { DocsBlockUrlPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockUrlProperty";
|
|
98
105
|
export type { DocsBlockTextPropertyData, DocsBlockTextPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockTextProperty";
|
|
99
106
|
export { DocsBlockTokenPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTokenProperty";
|
|
100
107
|
export type { DocsBlockTokenPropertyData, DocsBlockTokenPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockTokenProperty";
|
|
@@ -103,7 +110,10 @@ export type { DocsBlockTokenPropertyPropertyData, DocsBlockTokenPropertyProperty
|
|
|
103
110
|
export { DocsBlockTokenTypePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty";
|
|
104
111
|
export type { DocsBlockTokenTypePropertyData, DocsBlockTokenTypePropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty";
|
|
105
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";
|
|
106
115
|
export type { DocsBlockDividerPropertyData, DocsBlockDividerPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockDividerProperty";
|
|
116
|
+
export { DocsBlockStorybookPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockStorybookProperty";
|
|
107
117
|
export type { DocsBlockStorybookPropertyData, DocsBlockStorybookPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockStorybookProperty";
|
|
108
118
|
export type { DocsColorRef } from "./model/docs/blocks/support/SDKDocsColorRef";
|
|
109
119
|
export { DocsImageRefType } from "./model/docs/blocks/support/SDKDocsImageRef";
|
|
@@ -112,6 +122,7 @@ export { DocsLinkRefType } from "./model/docs/blocks/support/SDKDocsLinkRef";
|
|
|
112
122
|
export type { DocsLinkRef } from "./model/docs/blocks/support/SDKDocsLinkRef";
|
|
113
123
|
export type { DocsSizeRef } from "./model/docs/blocks/support/SDKDocsSizeRef";
|
|
114
124
|
export { DocsBlock } from "./model/docs/blocks/usage/SDKDocsBlock";
|
|
125
|
+
export { DocsBlockItem } from "./model/docs/blocks/usage/SDKDocsBlockItem";
|
|
115
126
|
export { DocumentationLegacy } from "./model/base/SDKDocumentationLegacy";
|
|
116
127
|
export { DocumentationLegacyPageBlockAsset } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockAsset";
|
|
117
128
|
export { DocumentationLegacyPageBlockAssets } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockAssets";
|
|
@@ -175,6 +186,7 @@ export { DocumentationLegacyPageAssetType } from "./model/enums/SDKDocumentation
|
|
|
175
186
|
export { DocumentationLegacyPageBlockType } from "./model/enums/SDKDocumentationLegacyPageBlockType";
|
|
176
187
|
export { DocumentationLegacyPageBlockThemeType } from "./model/enums/SDKDocumentationLegacyPageBlockThemeType";
|
|
177
188
|
export { DocsBlockBehaviorDataType } from "./model/enums/SDKDocsBlockBehaviorDataType";
|
|
189
|
+
export { DocsBlockAssetPropertyPreviewContainerSize } from "./model/enums/SDKDocsBlockAssetPropertyPreviewContainerSize";
|
|
178
190
|
export { DocsBlockBehaviorSelectionType } from "./model/enums/SDKDocsBlockBehaviorSelectionType";
|
|
179
191
|
export { DocsBlockImagePropertyAspectRatio } from "./model/enums/SDKDocsBlockImagePropertyAspectRatio";
|
|
180
192
|
export { DocsBlockItemEntityType } from "./model/enums/SDKDocsBlockItemEntityType";
|
|
@@ -187,10 +199,14 @@ export { DocsBlockItemVariantLayoutWidth } from "./model/enums/SDKDocsBlockItemV
|
|
|
187
199
|
export { DocsBlockOptionRenderingStyle } from "./model/enums/SDKDocsBlockOptionRenderStyle";
|
|
188
200
|
export { DocsBlockRichTextPropertyStyle } from "./model/enums/SDKDocsBlockRichTextPropertyStyle";
|
|
189
201
|
export { DocsBlockTextPropertyStyle } from "./model/enums/SDKDocsBlockTextPropertyStyle";
|
|
202
|
+
export { DocsBlockTextPropertyColor } from "./model/enums/SDKDocsBlockTextPropertyColor";
|
|
190
203
|
export { DocsEntityGroupBehavior } from "./model/enums/SDKDocsEntityGroupBehavior";
|
|
191
204
|
export { DocsEntityType } from "./model/enums/SDKDocsEntityType";
|
|
192
205
|
export { DocsSectionType } from "./model/enums/SDKDocsSectionType";
|
|
193
206
|
export { SourceType } from "./model/enums/SDKSourceType";
|
|
207
|
+
export { DocsBlockImagePropertyWidth } from "./model/enums/SDKDocsBlockImagePropertyWidth";
|
|
208
|
+
export { DocsPublishStatus } from "./model/enums/SDKDocsPublishStatus";
|
|
209
|
+
export { DocumentationEnvironment } from "./model/enums/SDKDocumentationEnvironment";
|
|
194
210
|
export { FrameAlignment } from "./model/enums/SDKFrameAlignment";
|
|
195
211
|
export { FrameLayout } from "./model/enums/SDKFrameLayout";
|
|
196
212
|
export { GradientType } from "./model/enums/SDKGradientType";
|
|
@@ -224,6 +240,9 @@ export { FigmaFrame, FrameType } from "./model/support/SDKFigmaFrame";
|
|
|
224
240
|
export { ExportBuild } from "./model/exporters/exporter_builds/SDKExportBuild";
|
|
225
241
|
export { ExportBuildStatus } from "./model/exporters/exporter_builds/SDKExportBuild";
|
|
226
242
|
export { ExportBuildResultLog } from "./model/exporters/exporter_builds/SDKExportBuildResults";
|
|
243
|
+
export type { ResourceType } from "./model/resources/SDKResource";
|
|
244
|
+
export { ResourceAsset } from "./model/resources/SDKResourceAsset";
|
|
245
|
+
export { ResourceFont } from "./model/resources/SDKResourceFont";
|
|
227
246
|
export { BlurToken } from "./model/tokens/SDKBlurToken";
|
|
228
247
|
export { BorderToken } from "./model/tokens/SDKBorderToken";
|
|
229
248
|
export { ColorToken } from "./model/tokens/SDKColorToken";
|
|
@@ -238,7 +257,7 @@ export { TextCaseToken } from "./model/tokens/SDKTextCaseToken";
|
|
|
238
257
|
export { TextDecorationToken } from "./model/tokens/SDKTextDecorationToken";
|
|
239
258
|
export { VisibilityToken } from "./model/tokens/SDKVisibilityToken";
|
|
240
259
|
export { Token } from "./model/tokens/SDKToken";
|
|
241
|
-
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";
|
|
242
261
|
export { TokenTheme } from "./model/themes/SDKTokenTheme";
|
|
243
262
|
export { TokenThemeOverride } from "./model/themes/SDKTokenThemeOverride";
|
|
244
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;
|