@supernova-studio/supernova-sdk-beta 1.6.42 → 1.6.45
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 +6 -6
- package/build/sdk-typescript/src/core/areas/SDKAreaDataSources.d.ts +1 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +7 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaMultiplayer.d.ts +1 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaVersions.d.ts +6 -2
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +44 -0
- package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +4 -0
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +38 -6
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +17 -3
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +11 -3
- package/build/sdk-typescript/src/exports.d.ts +1 -1
- package/build/sdk-typescript/src/model/base/SDKDesignSystemVersion.d.ts +54 -0
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntity.d.ts +4 -2
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityConfiguration.d.ts +5 -3
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityGroup.d.ts +3 -1
- package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityPage.d.ts +3 -1
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyConfiguration.d.ts +4 -0
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyItem.d.ts +2 -0
- package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationLegacyItemConfiguration.d.ts +4 -0
- package/build/sdk-typescript/src/model/support/SDKSource.d.ts +4 -1
- package/build/sdk-typescript/src/model/tokens/SDKDimensionToken.d.ts +1 -27
- package/build/sdk-typescript/src/model/tokens/SDKStringToken.d.ts +1 -27
- package/build/sdk-typescript/src/model/tokens/SDKTypographyToken.d.ts +2 -2
- package/build/sdk-typescript/src/model/users/SDKUserProfile.d.ts +4 -2
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceIntegration.d.ts +75 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceIntegrationAccessToken.d.ts +12 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceIntegrationOauthRequest.d.ts +9 -0
- package/build/sdk-typescript/src/tests/helpers.d.ts +5 -0
- package/build/sdk-typescript/src/tests/validators.d.ts +3 -3
- package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +3 -3
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTMapLoader.d.ts +14 -2
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTThemeMerger.d.ts +6 -1
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenMerger.d.ts +1 -0
- package/build/sdk-typescript/src/tools/design-tokens/utilities/collection/SDKDTTokenCollection.d.ts +1 -1
- package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementTransformer.d.ts +1 -1
- package/build/sdk-typescript/src/utils/TokenUtils.d.ts +1 -0
- package/build/supernova-sdk-typescript.js +1 -1
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +112 -125
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
declare
|
|
1
|
+
declare let _extends: string[];
|
|
2
2
|
export { _extends as extends };
|
|
3
|
-
export declare
|
|
4
|
-
export declare
|
|
3
|
+
export declare let root: boolean;
|
|
4
|
+
export declare let overrides: {
|
|
5
5
|
files: string[];
|
|
6
6
|
plugins: string[];
|
|
7
7
|
rules: {
|
|
@@ -10,10 +10,10 @@ export declare const overrides: {
|
|
|
10
10
|
};
|
|
11
11
|
}[];
|
|
12
12
|
export declare namespace parserOptions {
|
|
13
|
-
|
|
14
|
-
|
|
13
|
+
let tsconfigRootDir: string;
|
|
14
|
+
let project: string[];
|
|
15
15
|
}
|
|
16
|
-
export declare
|
|
16
|
+
export declare let rules: {
|
|
17
17
|
"@typescript-eslint/no-unsafe-assignment": string;
|
|
18
18
|
"@typescript-eslint/no-unsafe-member-access": string;
|
|
19
19
|
"@typescript-eslint/unbound-method": string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTODeleteDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOMoveDocumentationGroupInput, DTOCreateDocumentationTabInput } from "@supernova-studio/client";
|
|
1
|
+
import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTODeleteDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOMoveDocumentationGroupInput, DTOCreateDocumentationTabInput, DTODocumentationPageAnchor } from "@supernova-studio/client";
|
|
2
2
|
import { DocumentationLegacy, DocumentationLegacyModel } from "../../model/base/SDKDocumentationLegacy";
|
|
3
3
|
import { DocsBlockDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockDefinition";
|
|
4
4
|
import { DocsBlock } from "../../model/docs/blocks/usage/SDKDocsBlock";
|
|
@@ -166,6 +166,11 @@ export declare class AreaDocumentation {
|
|
|
166
166
|
* @returns Room ID that can be immediately used to join the multiplayer room
|
|
167
167
|
*/
|
|
168
168
|
getDocumentationVersionRoomId(from: RemoteWorkspaceVersionIdentifier): Promise<string>;
|
|
169
|
+
/** Get id of the room for a specific workspace. This rooms contains comments.
|
|
170
|
+
* @param from - Remote version to fetch from
|
|
171
|
+
* @returns Room ID that can be immediately used to join the multiplayer room
|
|
172
|
+
*/
|
|
173
|
+
getDocumentationWorkspaceRoomId(from: Pick<RemoteWorkspaceVersionIdentifier, "workspaceId">): Promise<string>;
|
|
169
174
|
/** Publish documentation. This queues a build on Supernova's server that will be processed by the asynchronous CI/CD pipeline.
|
|
170
175
|
* You can request status of the build with associated `isPublishing` method.
|
|
171
176
|
* @param to - Remote version where the build should be created
|
|
@@ -173,6 +178,7 @@ export declare class AreaDocumentation {
|
|
|
173
178
|
* @param isForcing - If true, a new build will be created regardless if an in-progress build already exists.
|
|
174
179
|
* */
|
|
175
180
|
publish(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment, isForcing?: boolean): Promise<ExportBuild>;
|
|
181
|
+
getDocumentationPageAnchors(from: RemoteWorkspaceVersionIdentifier, pageId: string): Promise<Array<DTODocumentationPageAnchor>>;
|
|
176
182
|
getDocumentationMockedStructure(): Array<DocsEntity>;
|
|
177
183
|
getDocumentationMockedPageContent(pageId: string): Array<DocsBlock | DocsSection>;
|
|
178
184
|
getDocumentationMockedEditorBlockDefinitions(): Array<DocsBlockDefinition>;
|
|
@@ -4,7 +4,7 @@ export declare class AreaMultiplayer {
|
|
|
4
4
|
private dataCore;
|
|
5
5
|
constructor(dataCore: DataCore);
|
|
6
6
|
/** Return multiplayer access token for specific room. */
|
|
7
|
-
getMultiplayerToken(room: string): Promise<{
|
|
7
|
+
getMultiplayerToken(room: string | undefined): Promise<{
|
|
8
8
|
token: string;
|
|
9
9
|
}>;
|
|
10
10
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DesignSystemVersion, DesignSystemVersionUpdateModel } from "../../model/base/SDKDesignSystemVersion";
|
|
1
|
+
import { DesignSystemVersion, DesignSystemVersionCreate, DesignSystemVersionCreationJob, DesignSystemVersionUpdateModel } from "../../model/base/SDKDesignSystemVersion";
|
|
2
2
|
import { DataCore } from "../data/SDKDataCore";
|
|
3
3
|
import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
4
4
|
export declare class AreaVersions {
|
|
@@ -12,7 +12,7 @@ export declare class AreaVersions {
|
|
|
12
12
|
* @param model - new version model
|
|
13
13
|
* @returns Newly created version object
|
|
14
14
|
*/
|
|
15
|
-
createVersion(designSystemId: string, model: DesignSystemVersionUpdateModel): Promise<
|
|
15
|
+
createVersion(designSystemId: string, model: DesignSystemVersionUpdateModel): Promise<DesignSystemVersionCreate>;
|
|
16
16
|
/** Edits version
|
|
17
17
|
* @param designSystemId - ID of the design system
|
|
18
18
|
* @param versionId - ID of version
|
|
@@ -30,6 +30,10 @@ export declare class AreaVersions {
|
|
|
30
30
|
getVersions(designSystemId: string): Promise<Array<DesignSystemVersion>>;
|
|
31
31
|
/** Fetches design system version by id */
|
|
32
32
|
getVersion(from: RemoteVersionIdentifier): Promise<DesignSystemVersion>;
|
|
33
|
+
/** Fetches version creation job */
|
|
34
|
+
getVersionCreationJob(designSystemId: string, jobId: string): Promise<DesignSystemVersionCreationJob>;
|
|
35
|
+
/** Fetches all version creation jobs */
|
|
36
|
+
getVersionCreationJobs(designSystemId: string): Promise<DesignSystemVersionCreationJob[]>;
|
|
33
37
|
getTokenStudioData(from: RemoteVersionIdentifier): Promise<object>;
|
|
34
38
|
writeTokenStudioData(from: RemoteVersionIdentifier, data: object): Promise<object>;
|
|
35
39
|
}
|
|
@@ -4,6 +4,9 @@ import { Membership } from "../../model/membership/SDKMembership";
|
|
|
4
4
|
import { UserMembership } from "../../model/users/SDKUserMembership";
|
|
5
5
|
import { Workspace } from "../../model/workspaces/SDKWorkspace";
|
|
6
6
|
import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
7
|
+
import { WorkspaceIntegrationType, WorkspaceIntegrations } from "../../model/workspaces/SDKWorkspaceIntegration";
|
|
8
|
+
import { WorkspaceIntegrationAccessTokenPayload } from "../../model/workspaces/SDKWorkspaceIntegrationAccessToken";
|
|
9
|
+
import { OAuth2IntegrationTypes, WorkspaceIntegrationOauthRequest } from "../../model/workspaces/SDKWorkspaceIntegrationOauthRequest";
|
|
7
10
|
import { WorkspaceInvitation, WorkspaceInvitationUpdateModel } from "../../model/workspaces/SDKWorkspaceInvitation";
|
|
8
11
|
import { WorkspaceInvoice } from "../../model/workspaces/SDKWorkspaceInvoice";
|
|
9
12
|
import { WorkspaceNPMRegistryAccessTokenRemoteModel } from "../../model/workspaces/SDKWorkspaceNPMRegistryAccessToken";
|
|
@@ -24,6 +27,47 @@ export declare class AreaWorkspaces {
|
|
|
24
27
|
* @returns Full workspace object
|
|
25
28
|
*/
|
|
26
29
|
workspace(workspaceId: string): Promise<Workspace>;
|
|
30
|
+
/** Fetches integrations of one specific workspace by provided id
|
|
31
|
+
* @param workspaceId - ID of the workspace
|
|
32
|
+
* @returns Object with integrations of given workspace
|
|
33
|
+
*/
|
|
34
|
+
workspaceIntegrations(workspaceId: string): Promise<WorkspaceIntegrations>;
|
|
35
|
+
/** Fetches redirect url for oauth of one specific workspace integration by workspace id and integration type
|
|
36
|
+
* @param workspaceId - ID of the workspace
|
|
37
|
+
* @returns Object with redirect url
|
|
38
|
+
*/
|
|
39
|
+
workspaceIntegrationRedirectUrl({ workspaceId, type, }: {
|
|
40
|
+
workspaceId: string;
|
|
41
|
+
type: OAuth2IntegrationTypes;
|
|
42
|
+
}): Promise<WorkspaceIntegrationOauthRequest>;
|
|
43
|
+
/** Creates a new workspace integration via PAT by workspace id and PAT input
|
|
44
|
+
* @param workspaceId - ID of the workspace
|
|
45
|
+
* @returns Workspace integrations with updated integration
|
|
46
|
+
*/
|
|
47
|
+
createWorkspaceIntegrationAccessToken({ workspaceId, payload, }: {
|
|
48
|
+
workspaceId: string;
|
|
49
|
+
payload: WorkspaceIntegrationAccessTokenPayload;
|
|
50
|
+
}): Promise<WorkspaceIntegrations>;
|
|
51
|
+
/** Delete workspace integration's connection
|
|
52
|
+
* @param workspaceId - ID of the workspace
|
|
53
|
+
* @param integrationId - ID of the integration
|
|
54
|
+
* @param credentialId - ID of the credential
|
|
55
|
+
* @returns Workspace integrations with updated integration
|
|
56
|
+
*/
|
|
57
|
+
deleteWorkspaceIntegrationCredential(data: {
|
|
58
|
+
workspaceId: string;
|
|
59
|
+
integrationId: string;
|
|
60
|
+
credentialId: string;
|
|
61
|
+
}): Promise<WorkspaceIntegrationType>;
|
|
62
|
+
/** Delete workspace integration
|
|
63
|
+
* @param workspaceId - ID of the workspace
|
|
64
|
+
* @param integrationId - ID of the integration
|
|
65
|
+
* @returns Workspace integrations with updated integration
|
|
66
|
+
*/
|
|
67
|
+
deleteWorkspaceIntegration(data: {
|
|
68
|
+
workspaceId: string;
|
|
69
|
+
integrationId: string;
|
|
70
|
+
}): Promise<WorkspaceIntegrationType>;
|
|
27
71
|
/** Fetches all workspaces user has access to. Use `memberships` instead if you want to also know which role the current user has in which workspace
|
|
28
72
|
* @param userId - ID of the user
|
|
29
73
|
* @returns All workspaces user is part of
|
|
@@ -49,7 +49,11 @@ export declare class DataBridge {
|
|
|
49
49
|
getAclEndpoint(resource?: string): string;
|
|
50
50
|
getUserEndpoint(userId: string, fragment: string | null): string;
|
|
51
51
|
getWorkspaceEndpoint(wsId: string, fragment: string | null): string;
|
|
52
|
+
getWorkspaceIntegrationCredentialEndpoint(wsId: string, integrationId: string, credentialId: string): string;
|
|
53
|
+
getWorkspaceIntegrationEndpoint(wsId: string, integrationId: string): string;
|
|
52
54
|
getDesignSystemEndpoint(dsId: string, fragment: string | null): string;
|
|
53
55
|
getVersionEndpoint(dsId: string, dsVersionId: string, fragment: string | null): string;
|
|
56
|
+
getVersionCreationJobEndpoint(dsId: string, jobId: string): string;
|
|
57
|
+
getVersionCreationJobsEndpoint(dsId: string): string;
|
|
54
58
|
}
|
|
55
59
|
export {};
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2,
|
|
2
|
-
DTOFigmaNodeRenderInput,
|
|
3
|
-
import { ExportBuildStatus, ResourceFont, TokenThemeOverrideTranserObject
|
|
1
|
+
import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODocumentationLinkPreviewRequest, DTODocumentationPageAnchor, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOFigmaNode, // TODO? DTODeleteDocumentationTabGroupInput,
|
|
2
|
+
DTOFigmaNodeRenderInput, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
|
|
3
|
+
import { DocsBlockDefinition, ExportBuildStatus, ResourceFont, TokenThemeOverrideTranserObject } from "../../exports";
|
|
4
4
|
import { Acl } from "../../model/acl/SDKAcl";
|
|
5
5
|
import { Asset } from "../../model/assets/SDKAsset";
|
|
6
6
|
import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
|
|
7
7
|
import { Brand, BrandUpdateModel } from "../../model/base/SDKBrand";
|
|
8
8
|
import { DesignSystem, DesignSystemSwitcher } from "../../model/base/SDKDesignSystem";
|
|
9
|
-
import { DesignSystemVersion, DesignSystemVersionUpdateModel } from "../../model/base/SDKDesignSystemVersion";
|
|
9
|
+
import { DesignSystemVersion, DesignSystemVersionCreate, DesignSystemVersionCreationJob, DesignSystemVersionUpdateModel } from "../../model/base/SDKDesignSystemVersion";
|
|
10
10
|
import { DocumentationLegacy, DocumentationLegacyModel } from "../../model/base/SDKDocumentationLegacy";
|
|
11
11
|
import { Component } from "../../model/components/SDKComponent";
|
|
12
12
|
import { DesignComponent } from "../../model/components/SDKDesignComponent";
|
|
@@ -62,6 +62,9 @@ import { UserMembership } from "../../model/users/SDKUserMembership";
|
|
|
62
62
|
import { UserProfileUpdateModel } from "../../model/users/SDKUserProfile";
|
|
63
63
|
import { Workspace } from "../../model/workspaces/SDKWorkspace";
|
|
64
64
|
import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
65
|
+
import { WorkspaceIntegrationType, WorkspaceIntegrations, WorkspaceIntegrationsRemoteModel } from "../../model/workspaces/SDKWorkspaceIntegration";
|
|
66
|
+
import { WorkspaceIntegrationAccessTokenPayload } from "../../model/workspaces/SDKWorkspaceIntegrationAccessToken";
|
|
67
|
+
import { OAuth2IntegrationTypes, WorkspaceIntegrationOauthRequestRemoteModel } from "../../model/workspaces/SDKWorkspaceIntegrationOauthRequest";
|
|
65
68
|
import { WorkspaceInvitation, WorkspaceInvitationUpdateModel } from "../../model/workspaces/SDKWorkspaceInvitation";
|
|
66
69
|
import { WorkspaceInvoice } from "../../model/workspaces/SDKWorkspaceInvoice";
|
|
67
70
|
import { WorkspaceNPMRegistryAccessTokenRemoteModel } from "../../model/workspaces/SDKWorkspaceNPMRegistryAccessToken";
|
|
@@ -91,7 +94,7 @@ export declare class DataCore {
|
|
|
91
94
|
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
92
95
|
dataThroughCorsProxy(urlToRalay: string): Promise<ArrayBuffer | undefined>;
|
|
93
96
|
/** Remote: Get single-use multiplayer token */
|
|
94
|
-
multiplayerToken(room: string): Promise<{
|
|
97
|
+
multiplayerToken(room: string | undefined): Promise<{
|
|
95
98
|
token: string;
|
|
96
99
|
}>;
|
|
97
100
|
/** Remote: Get information about currently logged in user */
|
|
@@ -295,10 +298,13 @@ export declare class DataCore {
|
|
|
295
298
|
getDocumentationPageRoomId(designSystemId: string, versionId: string, pageId: string): Promise<string>;
|
|
296
299
|
/** Remote: Get id of the room for a specific design system and version. This room contains doc structure */
|
|
297
300
|
getDocumentationVersionRoomId(designSystemId: string, versionId: string): Promise<string>;
|
|
301
|
+
/** Remote: Get id of the room for a specific Workspace. This room contains comments */
|
|
302
|
+
getDocumentationWorkspaceRoomId(workspaceId: string): Promise<string>;
|
|
298
303
|
/** Retrieve currently deployed documentation url */
|
|
299
304
|
documentationDomain(designSystemId: string, versionId: string): Promise<string | null>;
|
|
300
305
|
/** Publish the documentation */
|
|
301
306
|
documentationPublish(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<ExportBuild>;
|
|
307
|
+
getDocumentationPageAnchors(designSystemId: string, versionId: string, pageId: string): Promise<Array<DTODocumentationPageAnchor>>;
|
|
302
308
|
/** Retrieve all asset resources */
|
|
303
309
|
assetResources(designSystemId: string, versionId: string): Promise<Array<ResourceAsset>>;
|
|
304
310
|
/** Retrieve all font resources */
|
|
@@ -373,8 +379,31 @@ export declare class DataCore {
|
|
|
373
379
|
workspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeatures>;
|
|
374
380
|
/** Download information about a single workspace and retrieve it resolved */
|
|
375
381
|
workspace(workspaceId: string): Promise<Workspace>;
|
|
382
|
+
/** Download information about a single workspace's integrations' */
|
|
383
|
+
workspaceIntegrations(workspaceId: string): Promise<WorkspaceIntegrations>;
|
|
384
|
+
/** Download redirect url for oauth of specific workspace integration */
|
|
385
|
+
workspaceIntegrationRedirectUrl({ workspaceId, type, }: {
|
|
386
|
+
workspaceId: string;
|
|
387
|
+
type: OAuth2IntegrationTypes;
|
|
388
|
+
}): Promise<WorkspaceIntegrationOauthRequestRemoteModel>;
|
|
389
|
+
/** Creates a new credential for a workspace integration via PAT */
|
|
390
|
+
createWorkspaceIntegrationAccessToken({ workspaceId, payload, }: {
|
|
391
|
+
workspaceId: string;
|
|
392
|
+
payload: WorkspaceIntegrationAccessTokenPayload;
|
|
393
|
+
}): Promise<WorkspaceIntegrationsRemoteModel>;
|
|
394
|
+
/** Delete workspace credential's integration connection */
|
|
395
|
+
deleteWorkspaceIntegrationCredential({ workspaceId, integrationId, credentialId, }: {
|
|
396
|
+
workspaceId: string;
|
|
397
|
+
integrationId: string;
|
|
398
|
+
credentialId: string;
|
|
399
|
+
}): Promise<WorkspaceIntegrationType>;
|
|
400
|
+
/** Delete workspace integration */
|
|
401
|
+
deleteWorkspaceIntegration({ workspaceId, integrationId, }: {
|
|
402
|
+
workspaceId: string;
|
|
403
|
+
integrationId: string;
|
|
404
|
+
}): Promise<WorkspaceIntegrationType>;
|
|
376
405
|
createWorkspace(name: string, handle?: string): Promise<Workspace>;
|
|
377
|
-
createVersion(designSystemId: string, model: DesignSystemVersionUpdateModel): Promise<
|
|
406
|
+
createVersion(designSystemId: string, model: DesignSystemVersionUpdateModel): Promise<DesignSystemVersionCreate>;
|
|
378
407
|
editVersion(designSystemId: string, versionId: string, model: DesignSystemVersionUpdateModel): Promise<void>;
|
|
379
408
|
deleteVersion(designSystemId: string, versionId: string): Promise<void>;
|
|
380
409
|
createBrand(designSystemId: string, versionId: any, model: BrandUpdateModel): Promise<Brand>;
|
|
@@ -467,6 +496,7 @@ export declare class DataCore {
|
|
|
467
496
|
components: boolean;
|
|
468
497
|
assets: boolean;
|
|
469
498
|
documentationFrames: boolean;
|
|
499
|
+
isUnpublishedContentFallbackEnabled: boolean;
|
|
470
500
|
};
|
|
471
501
|
autoImport: SourceRemoteModelCloud["autoImportMode"];
|
|
472
502
|
themeId: string | null;
|
|
@@ -484,6 +514,8 @@ export declare class DataCore {
|
|
|
484
514
|
updateFigmaSourceClaimOwnership(designSystemId: string, sourceId: string): Promise<Source>;
|
|
485
515
|
versions(designSystemId: string): Promise<Array<DesignSystemVersion>>;
|
|
486
516
|
version(designSystemId: string, versionId: string): Promise<DesignSystemVersion>;
|
|
517
|
+
versionCreationJob(designSystemId: string, jobId: string): Promise<DesignSystemVersionCreationJob>;
|
|
518
|
+
versionCreationJobs(designSystemId: string): Promise<DesignSystemVersionCreationJob[]>;
|
|
487
519
|
getBrands(designSystemId: string, versionId: string): Promise<Array<Brand>>;
|
|
488
520
|
getBrand(designSystemId: string, versionId: string, brandId: string): Promise<Brand>;
|
|
489
521
|
getAuthenticationTokens(): Promise<import("../../model/exporters/SDKConnections").AuthenticationTokens>;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { DTODocumentationLinkPreviewRequest, DTOFigmaNode } from "@supernova-studio/client";
|
|
1
|
+
import { DTODocumentationLinkPreviewRequest, DTOFigmaNode, DTOGetDocumentationPageAnchorsResponse } from "@supernova-studio/client";
|
|
2
2
|
import { AclRemoteModel } from "../../../model/acl/SDKAcl";
|
|
3
3
|
import { BrandRemoteModel } from "../../../model/base/SDKBrand";
|
|
4
4
|
import { DesignSystemRemoteModel } from "../../../model/base/SDKDesignSystem";
|
|
5
|
-
import { DesignSystemVersionRemoteModel } from "../../../model/base/SDKDesignSystemVersion";
|
|
5
|
+
import { DesignSystemVersionCreationJobRemoteModel, DesignSystemVersionRemoteModel } from "../../../model/base/SDKDesignSystemVersion";
|
|
6
6
|
import { DocumentationLegacyModel } from "../../../model/base/SDKDocumentationLegacy";
|
|
7
7
|
import { ComponentRemoteModel } from "../../../model/components/SDKComponent";
|
|
8
8
|
import { DesignComponentRemoteModel } from "../../../model/components/SDKDesignComponent";
|
|
@@ -53,6 +53,8 @@ import { UserRemoteModel } from "../../../model/users/SDKUser";
|
|
|
53
53
|
import { UserMembershipRemoteModel } from "../../../model/users/SDKUserMembership";
|
|
54
54
|
import { WorkspaceRemoteModel } from "../../../model/workspaces/SDKWorkspace";
|
|
55
55
|
import { WorkspaceIPWhitelistSettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
56
|
+
import { WorkspaceIntegrationsRemoteModel } from "../../../model/workspaces/SDKWorkspaceIntegration";
|
|
57
|
+
import { OAuth2IntegrationTypes, WorkspaceIntegrationOauthRequestRemoteModel } from "../../../model/workspaces/SDKWorkspaceIntegrationOauthRequest";
|
|
56
58
|
import { WorkspaceInvitationRemoteModel } from "../../../model/workspaces/SDKWorkspaceInvitation";
|
|
57
59
|
import { WorkspaceInvoiceRemoteModel } from "../../../model/workspaces/SDKWorkspaceInvoice";
|
|
58
60
|
import { WorkspaceNPMRegistryAccessTokenRemoteModel } from "../../../model/workspaces/SDKWorkspaceNPMRegistryAccessToken";
|
|
@@ -68,7 +70,7 @@ export declare class DataCoreReadRequests {
|
|
|
68
70
|
constructor(bridge: DataBridge);
|
|
69
71
|
getDataThroughCorsProxy(url: string): Promise<ArrayBuffer | undefined>;
|
|
70
72
|
/** Remote: Get information about currently logged in user */
|
|
71
|
-
getRemoteMultiplayerToken(room: string): Promise<{
|
|
73
|
+
getRemoteMultiplayerToken(room: string | undefined): Promise<{
|
|
72
74
|
token: string;
|
|
73
75
|
}>;
|
|
74
76
|
/** Remote: Get information about currently logged in user */
|
|
@@ -81,6 +83,13 @@ export declare class DataCoreReadRequests {
|
|
|
81
83
|
getRemoteWorkspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeaturesRemoteModel>;
|
|
82
84
|
/** Remote: Get information about a specific workspace */
|
|
83
85
|
getRemoteWorkspaceDetail(workspaceId: string): Promise<WorkspaceRemoteModel>;
|
|
86
|
+
/** Remote: Get integrations of a specific workspace */
|
|
87
|
+
getRemoteWorkspaceIntegrations(workspaceId: string): Promise<WorkspaceIntegrationsRemoteModel>;
|
|
88
|
+
/** Remote: Get redirect url for oauth of given workspace integration */
|
|
89
|
+
getRemoteWorkspaceIntegrationRedirectUrl({ workspaceId, type, }: {
|
|
90
|
+
workspaceId: string;
|
|
91
|
+
type: OAuth2IntegrationTypes;
|
|
92
|
+
}): Promise<WorkspaceIntegrationOauthRequestRemoteModel>;
|
|
84
93
|
/** Remote: Validate can use workspace handle */
|
|
85
94
|
getRemoteIsWorkspaceHandleAvailable(handle: string): Promise<boolean>;
|
|
86
95
|
/** Remote: Get all users memberships */
|
|
@@ -120,6 +129,9 @@ export declare class DataCoreReadRequests {
|
|
|
120
129
|
getRemoteDocumentationPageRoomId(designSystemId: string, versionId: string, pageId: string): Promise<string>;
|
|
121
130
|
/** Remote: Get id of the room for a specific design system and version. This room contains doc structure */
|
|
122
131
|
getRemoteDocumentationVersionRoomId(designSystemId: string, versionId: string): Promise<string>;
|
|
132
|
+
/** Remote: Get id of the room for a specific workspace. */
|
|
133
|
+
getRemoteDocumentationWorkspaceRoomId(workspaceId: string): Promise<string>;
|
|
134
|
+
getRemoteDocumentationPageAnchors(designSystemId: string, versionId: string, pageId: string): Promise<DTOGetDocumentationPageAnchorsResponse>;
|
|
123
135
|
/** Remote: Get custom blocks for currently installed documentation exporter under specific ds */
|
|
124
136
|
getRemoteExporterCustomBlocks(designSystemId: string, versionId: string): Promise<Array<ExporterCustomBlockModel>>;
|
|
125
137
|
/** Remote: Get user configuration of specific installed exporter */
|
|
@@ -224,6 +236,8 @@ export declare class DataCoreReadRequests {
|
|
|
224
236
|
getOAuthURL(service: "figma" | ExporterProvider): Promise<string>;
|
|
225
237
|
getVersion(designSystemId: string, versionId: string): Promise<DesignSystemVersionRemoteModel>;
|
|
226
238
|
getVersions(designSystemId: string): Promise<Array<DesignSystemVersionRemoteModel>>;
|
|
239
|
+
getVersionCreationJob(designSystemId: string, jobId: string): Promise<DesignSystemVersionCreationJobRemoteModel>;
|
|
240
|
+
getVersionCreationJobs(designSystemId: string): Promise<DesignSystemVersionCreationJobRemoteModel[]>;
|
|
227
241
|
getImportJobs(designSystemId: string, versionId: string): Promise<Array<ImportJobRemoteModel>>;
|
|
228
242
|
getImportJob(designSystemId: string, versionId: string, jobId: string): Promise<ImportJobRemoteModel>;
|
|
229
243
|
getKeyValueStorageData(designSystemId: string, keys: Array<string>): Promise<Record<string, string>>;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2,
|
|
1
|
+
import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOFigmaNode, DTOFigmaNodeRenderInput, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
|
|
2
2
|
import { TokenThemeOverrideTranserObject } from "../../../exports";
|
|
3
3
|
import { Brand, BrandRemoteModel, BrandUpdateModel } from "../../../model/base/SDKBrand";
|
|
4
4
|
import { DesignSystem, DesignSystemRemoteModel, DesignSystemSwitcher } from "../../../model/base/SDKDesignSystem";
|
|
5
|
-
import {
|
|
5
|
+
import { DesignSystemVersionCreateRemoteModel, DesignSystemVersionUpdateModel } from "../../../model/base/SDKDesignSystemVersion";
|
|
6
6
|
import { DocumentationLegacyModel } from "../../../model/base/SDKDocumentationLegacy";
|
|
7
7
|
import { Component, ComponentRemoteModel, ComponentUpdateRemoteModel } from "../../../model/components/SDKComponent";
|
|
8
8
|
import { ElementDataViewColumnType } from "../../../model/elements/SDKElementDataViewColumn";
|
|
@@ -28,6 +28,8 @@ import { TokenRemoteModel } from "../../../model/tokens/remote/SDKRemoteTokenMod
|
|
|
28
28
|
import { UserProfileUpdateModel } from "../../../model/users/SDKUserProfile";
|
|
29
29
|
import { WorkspaceRemoteModel } from "../../../model/workspaces/SDKWorkspace";
|
|
30
30
|
import { WorkspaceIPWhitelistSettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
|
|
31
|
+
import { WorkspaceIntegrationType, WorkspaceIntegrationsRemoteModel } from "../../../model/workspaces/SDKWorkspaceIntegration";
|
|
32
|
+
import { WorkspaceIntegrationAccessTokenPayload } from "../../../model/workspaces/SDKWorkspaceIntegrationAccessToken";
|
|
31
33
|
import { WorkspaceInvitationUpdateModel } from "../../../model/workspaces/SDKWorkspaceInvitation";
|
|
32
34
|
import { WorkspaceNPMRegistrySettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
|
|
33
35
|
import { WorkspaceOnboardingUpdateModel } from "../../../model/workspaces/SDKWorkspaceOnboarding";
|
|
@@ -53,7 +55,7 @@ export declare class DataCoreWriteRequests {
|
|
|
53
55
|
/** Remote: Creates a new workspace */
|
|
54
56
|
createRemoteWorkspace(name: string, handle?: string): Promise<WorkspaceRemoteModel>;
|
|
55
57
|
/** Remote: Creates a new version */
|
|
56
|
-
createRemoteVersion(designSystemId: string, model: DesignSystemVersionUpdateModel): Promise<
|
|
58
|
+
createRemoteVersion(designSystemId: string, model: DesignSystemVersionUpdateModel): Promise<DesignSystemVersionCreateRemoteModel>;
|
|
57
59
|
/** Remote: Updates a version */
|
|
58
60
|
updateRemoteVersion(designSystemId: string, versionId: string, model: DesignSystemVersionUpdateModel): Promise<void>;
|
|
59
61
|
/** Remote: Deletes a version */
|
|
@@ -206,6 +208,12 @@ export declare class DataCoreWriteRequests {
|
|
|
206
208
|
deleteAuthenticationToken(id: string): Promise<AuthenticationTokenPayload>;
|
|
207
209
|
/** Remote: Create Personal Access token connection */
|
|
208
210
|
createPersonalAccessTokenConnection(service: ConnectionProviders, connection: PersonalAccessTokenConnectionPayload | AzurePersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
|
|
211
|
+
/** Remote: Create Personal Access token credential for a workspace integration */
|
|
212
|
+
createRemoteWorkspaceIntegrationAccessToken(workspaceId: string, data: WorkspaceIntegrationAccessTokenPayload): Promise<WorkspaceIntegrationsRemoteModel>;
|
|
213
|
+
/** Remote: Delete credential integration connection from workspace */
|
|
214
|
+
deleteRemoteWorkspaceIntegrationCredential(workspaceId: string, integrationId: string, credentialId: string): Promise<WorkspaceIntegrationType>;
|
|
215
|
+
/** Remote: Delete a workspace integration */
|
|
216
|
+
deleteRemoteWorkspaceIntegration(workspaceId: string, integrationId: string): Promise<WorkspaceIntegrationType>;
|
|
209
217
|
/** Remote: Create pipeline */
|
|
210
218
|
createRemotePipeline(workspaceId: string, pipeline: NewPipelinePayload): Promise<any>;
|
|
211
219
|
/** Remote: Create pipeline */
|
|
@@ -35,7 +35,7 @@ export { Brand } from "./model/base/SDKBrand";
|
|
|
35
35
|
export type { BrandUpdateModel } from "./model/base/SDKBrand";
|
|
36
36
|
export { DesignSystem } from "./model/base/SDKDesignSystem";
|
|
37
37
|
export { DesignSystemVersion } from "./model/base/SDKDesignSystemVersion";
|
|
38
|
-
export type { DesignSystemVersionUpdateModel } from "./model/base/SDKDesignSystemVersion";
|
|
38
|
+
export type { DesignSystemVersionCreate, DesignSystemVersionUpdateModel, DesignSystemVersionCreationJob, } from "./model/base/SDKDesignSystemVersion";
|
|
39
39
|
export { Membership } from "./model/membership/SDKMembership";
|
|
40
40
|
export { Exporter, type NewExporterPayload, type ExporterProvider, } from "./model/exporters/SDKExporter";
|
|
41
41
|
export { Pipeline } from "./model/exporters/SDKPipeline";
|
|
@@ -10,14 +10,53 @@ export type DesignSystemVersionRemoteModel = {
|
|
|
10
10
|
createdAt: string;
|
|
11
11
|
changeLog: string;
|
|
12
12
|
};
|
|
13
|
+
export type DesignSystemVersionCreateRemoteModel = Omit<DesignSystemVersionRemoteModel, "id" | "createdAt"> & {
|
|
14
|
+
jobId: string;
|
|
15
|
+
};
|
|
16
|
+
type DesignSystemVersionCreationJobStatus = "Success" | "Error" | "InProgress";
|
|
17
|
+
export type DesignSystemVersionCreationJobRemoteModel = {
|
|
18
|
+
id: string;
|
|
19
|
+
version: string;
|
|
20
|
+
designSystemId: string;
|
|
21
|
+
designSystemVersionId?: string;
|
|
22
|
+
status: DesignSystemVersionCreationJobStatus;
|
|
23
|
+
message?: string;
|
|
24
|
+
};
|
|
13
25
|
export type DesignSystemVersionUpdateModel = {
|
|
14
26
|
version: string;
|
|
15
27
|
name?: string;
|
|
16
28
|
description?: string;
|
|
29
|
+
changeLog?: string;
|
|
17
30
|
};
|
|
18
31
|
export type DesignSystemVersionTransportModel = Pick<DesignSystemVersion, "id" | "designSystemId" | "isReadonly" | "name" | "description" | "version" | "changeLog"> & {
|
|
19
32
|
createdAt: string;
|
|
20
33
|
};
|
|
34
|
+
export type DesignSystemVersionCreateTransportModel = Pick<DesignSystemVersion, "designSystemId" | "isReadonly" | "name" | "description" | "version" | "changeLog"> & {
|
|
35
|
+
jobId: string;
|
|
36
|
+
};
|
|
37
|
+
export declare class DesignSystemVersionCreate {
|
|
38
|
+
/** Identifier of design system this version is created in */
|
|
39
|
+
designSystemId: string;
|
|
40
|
+
/** Design system version name */
|
|
41
|
+
name: string;
|
|
42
|
+
/** Design system version description */
|
|
43
|
+
description: string;
|
|
44
|
+
/** If version is in read-only mode, it can't be modified - only documentation that can be improved */
|
|
45
|
+
isReadonly: boolean;
|
|
46
|
+
/** Semantic name of version. Will be null if the version is in draft mode */
|
|
47
|
+
version: string | null;
|
|
48
|
+
/** Change log for the version. Will be null if the version is in draft mode */
|
|
49
|
+
changeLog: string | null;
|
|
50
|
+
/** ID of job creation. */
|
|
51
|
+
jobId: string;
|
|
52
|
+
constructor(model: DesignSystemVersionCreateRemoteModel);
|
|
53
|
+
/** Constructs representation that can be used to write full object to remote */
|
|
54
|
+
toRemote(): DesignSystemVersionCreateRemoteModel;
|
|
55
|
+
/** Constructs representation that can be used to transport the instantiated object as JSON, for example for SSR <> Client use-cases. Reconstruct to class instance using `fromTransport` */
|
|
56
|
+
toTransport(): DesignSystemVersionCreateTransportModel;
|
|
57
|
+
/** Reconstructs class from the transport model */
|
|
58
|
+
static fromTransport(model: DesignSystemVersionCreateTransportModel): DesignSystemVersionCreate;
|
|
59
|
+
}
|
|
21
60
|
export declare class DesignSystemVersion {
|
|
22
61
|
/** Unique identifier of design system version */
|
|
23
62
|
id: string;
|
|
@@ -43,3 +82,18 @@ export declare class DesignSystemVersion {
|
|
|
43
82
|
/** Reconstructs class from the transport model */
|
|
44
83
|
static fromTransport(model: DesignSystemVersionTransportModel): DesignSystemVersion;
|
|
45
84
|
}
|
|
85
|
+
export declare class DesignSystemVersionCreationJob {
|
|
86
|
+
id: string;
|
|
87
|
+
/** Semantic name of version. */
|
|
88
|
+
version: string;
|
|
89
|
+
/** Identifier of design system this version is created in */
|
|
90
|
+
designSystemId: string;
|
|
91
|
+
/** Identifier of version in design system. Filled only when status is equal to Success */
|
|
92
|
+
designSystemVersionId: string | null;
|
|
93
|
+
/** Status of current job */
|
|
94
|
+
status: DesignSystemVersionCreationJobStatus;
|
|
95
|
+
/** Mesage if job failed. Otherwise null */
|
|
96
|
+
message: string | null;
|
|
97
|
+
constructor(model: DesignSystemVersionCreationJobRemoteModel);
|
|
98
|
+
}
|
|
99
|
+
export {};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DTODocumentationItemConfigurationV2 } from "@supernova-studio/client";
|
|
2
2
|
import { DocsEntityType } from "../../enums/SDKDocsEntityType";
|
|
3
3
|
import { DocsEntityConfiguration } from "./SDKDocsEntityConfiguration";
|
|
4
4
|
export type DocsEntityModel = {
|
|
@@ -11,7 +11,7 @@ export type DocsEntityModel = {
|
|
|
11
11
|
slug: string;
|
|
12
12
|
userSlug?: string;
|
|
13
13
|
path?: string;
|
|
14
|
-
configuration:
|
|
14
|
+
configuration: DTODocumentationItemConfigurationV2;
|
|
15
15
|
createdAt?: string;
|
|
16
16
|
updatedAt?: string;
|
|
17
17
|
};
|
|
@@ -26,5 +26,7 @@ export declare class DocsEntity {
|
|
|
26
26
|
relativeUrl: string | null;
|
|
27
27
|
createdAt: Date | null;
|
|
28
28
|
updatedAt: Date | null;
|
|
29
|
+
isPrivate: boolean;
|
|
30
|
+
isHidden: boolean;
|
|
29
31
|
constructor(model: DocsEntityModel);
|
|
30
32
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DTODocumentationItemConfigurationV2 } from "@supernova-studio/client";
|
|
2
2
|
import { DocsEntityHeader, DocsEntityHeaderModel } from "./SDKDocsEntityHeader";
|
|
3
3
|
export type DocsEntityConfigurationModel = {
|
|
4
4
|
header: DocsEntityHeaderModel;
|
|
@@ -7,9 +7,11 @@ export type DocsEntityConfigurationModel = {
|
|
|
7
7
|
export declare class DocsEntityConfiguration {
|
|
8
8
|
header: DocsEntityHeader;
|
|
9
9
|
showSidebar: boolean;
|
|
10
|
+
isHidden: boolean;
|
|
11
|
+
isPrivate: boolean;
|
|
10
12
|
title: string;
|
|
11
|
-
constructor(model:
|
|
13
|
+
constructor(model: DTODocumentationItemConfigurationV2, title: string);
|
|
12
14
|
/** Constructs representation that can be used to write full object to remote */
|
|
13
|
-
toRemote():
|
|
15
|
+
toRemote(): DTODocumentationItemConfigurationV2;
|
|
14
16
|
static default(): DocsEntityConfiguration;
|
|
15
17
|
}
|
|
@@ -32,7 +32,7 @@ export declare class DocsEntityGroup extends DocsEntity {
|
|
|
32
32
|
deployedDocsPageUrl(): string | null;
|
|
33
33
|
}
|
|
34
34
|
/** Lightweight page representation used in multiplayer context type-validated against the full version */
|
|
35
|
-
export declare class DocsEntityMultiplayerGroup implements Pick<DocsEntityGroup, "id" | "persistentId" | "type" | "title" | "groupBehavior" | "childrenIds" | "isRoot"> {
|
|
35
|
+
export declare class DocsEntityMultiplayerGroup implements Pick<DocsEntityGroup, "id" | "persistentId" | "type" | "title" | "groupBehavior" | "childrenIds" | "isRoot" | "isPrivate" | "isHidden"> {
|
|
36
36
|
id: string;
|
|
37
37
|
persistentId: string;
|
|
38
38
|
type: DocsEntityType.group;
|
|
@@ -42,6 +42,8 @@ export declare class DocsEntityMultiplayerGroup implements Pick<DocsEntityGroup,
|
|
|
42
42
|
isRoot: boolean;
|
|
43
43
|
parent: DocsEntityMultiplayerGroup | null;
|
|
44
44
|
children: Array<DocsEntityMultiplayerGroup | DocsEntityMultiplayerPage>;
|
|
45
|
+
isPrivate: boolean;
|
|
46
|
+
isHidden: boolean;
|
|
45
47
|
/** Children filtered to be only groups */
|
|
46
48
|
get subgroups(): Array<DocsEntityMultiplayerGroup>;
|
|
47
49
|
/** Children filtered to be only pages */
|
|
@@ -26,7 +26,7 @@ export declare class DocsEntityPage extends DocsEntity {
|
|
|
26
26
|
relativePageUrl(): string | null;
|
|
27
27
|
}
|
|
28
28
|
/** Lightweight page representation used in multiplayer context type-validated against the full version */
|
|
29
|
-
export declare class DocsEntityMultiplayerPage implements Pick<DocsEntityPage, "id" | "persistentId" | "type" | "title" | "relativeUrl" | "createdAt"> {
|
|
29
|
+
export declare class DocsEntityMultiplayerPage implements Pick<DocsEntityPage, "id" | "persistentId" | "type" | "title" | "relativeUrl" | "createdAt" | "isPrivate" | "isHidden"> {
|
|
30
30
|
id: string;
|
|
31
31
|
persistentId: string;
|
|
32
32
|
parentId: string | null;
|
|
@@ -35,5 +35,7 @@ export declare class DocsEntityMultiplayerPage implements Pick<DocsEntityPage, "
|
|
|
35
35
|
title: string;
|
|
36
36
|
relativeUrl: string | null;
|
|
37
37
|
createdAt: Date | null;
|
|
38
|
+
isPrivate: boolean;
|
|
39
|
+
isHidden: boolean;
|
|
38
40
|
constructor(model: DocsEntityPageModel);
|
|
39
41
|
}
|
package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyConfiguration.d.ts
CHANGED
|
@@ -4,6 +4,8 @@ export type DocumentationLegacyConfigurationModel = {
|
|
|
4
4
|
storybookEmbedErrorMessage?: string;
|
|
5
5
|
renderCodePackageJson?: string;
|
|
6
6
|
isPublic: boolean;
|
|
7
|
+
isPrivate: boolean;
|
|
8
|
+
isHidden: boolean;
|
|
7
9
|
serveDefaultVersionOnly: boolean;
|
|
8
10
|
selectedBrandId: string;
|
|
9
11
|
host: string;
|
|
@@ -11,6 +13,8 @@ export type DocumentationLegacyConfigurationModel = {
|
|
|
11
13
|
export declare class DocumentationLegacyConfiguration {
|
|
12
14
|
tabbedNavigation: boolean;
|
|
13
15
|
isPublic: boolean;
|
|
16
|
+
isPrivate: boolean;
|
|
17
|
+
isHidden: boolean;
|
|
14
18
|
serveDefaultVersionOnly: boolean;
|
|
15
19
|
selectedBrandId: string;
|
|
16
20
|
host: string;
|
|
@@ -2,10 +2,14 @@ import { DocumentationLegacyItemHeader, DocumentationLegacyItemHeaderModel } fro
|
|
|
2
2
|
export type DocumentationLegacyItemConfigurationModel = {
|
|
3
3
|
header: DocumentationLegacyItemHeaderModel;
|
|
4
4
|
showSidebar: boolean;
|
|
5
|
+
isPrivate: boolean;
|
|
6
|
+
isHidden: boolean;
|
|
5
7
|
};
|
|
6
8
|
export declare class DocumentationLegacyItemConfiguration {
|
|
7
9
|
header: DocumentationLegacyItemHeader;
|
|
8
10
|
showSidebar: boolean;
|
|
11
|
+
isPrivate: boolean;
|
|
12
|
+
isHidden: boolean;
|
|
9
13
|
constructor(model: DocumentationLegacyItemConfigurationModel);
|
|
10
14
|
toWriteModel(): DocumentationLegacyItemConfigurationModel;
|
|
11
15
|
}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { DTPluginPreciseCopyStrategy, DTPluginThemeOverrideStrategy } from "../../tools/design-tokens/utilities/SDKDTMapLoader";
|
|
1
2
|
import { ImportWarningType } from "../enums/SDKCloudWarningType";
|
|
2
3
|
import { SourceType } from "../enums/SDKSourceType";
|
|
3
4
|
declare enum SourceRemoteType {
|
|
@@ -25,6 +26,7 @@ export type SourceScope = {
|
|
|
25
26
|
components: boolean;
|
|
26
27
|
assets: boolean;
|
|
27
28
|
documentationFrames: boolean;
|
|
29
|
+
isUnpublishedContentFallbackEnabled: boolean;
|
|
28
30
|
};
|
|
29
31
|
export type SourceRemoteModelCloud = {
|
|
30
32
|
fileId?: string;
|
|
@@ -88,7 +90,8 @@ export type SourceRemoteModelTokensStudio = {
|
|
|
88
90
|
settings?: {
|
|
89
91
|
dryRun?: boolean;
|
|
90
92
|
verbose?: boolean;
|
|
91
|
-
preciseCopy?: boolean;
|
|
93
|
+
preciseCopy?: boolean | DTPluginPreciseCopyStrategy;
|
|
94
|
+
themeOverridesStrategy?: DTPluginThemeOverrideStrategy;
|
|
92
95
|
};
|
|
93
96
|
lastImportedResults?: Array<{
|
|
94
97
|
mapping: {
|