@supernova-studio/supernova-sdk-beta 2.2.4 → 2.2.5
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/src/core/SDKSupernova.d.ts +0 -3
- package/build/sdk-typescript/src/core/areas/SDKAreaDataSources.d.ts +13 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +8 -7
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +0 -35
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +14 -42
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +18 -13
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +11 -7
- package/build/sdk-typescript/src/model/enums/SDKSourceType.d.ts +2 -1
- package/build/sdk-typescript/src/model/support/SDKSource.d.ts +20 -1
- package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +2 -2
- package/build/supernova-sdk-typescript.js +1 -1
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +3 -3
- package/build/sdk-typescript/src/core/areas/SDKAreaProjects.d.ts +0 -69
- package/build/sdk-typescript/src/model/projects/SDKProject.d.ts +0 -39
- package/build/sdk-typescript/src/model/projects/SDKProjectContext.d.ts +0 -47
|
@@ -13,7 +13,6 @@ import { AreaIntegrations } from "./areas/SDKAreaIntegrations";
|
|
|
13
13
|
import { AreaMe } from "./areas/SDKAreaMe";
|
|
14
14
|
import { AreaMultiplayer } from "./areas/SDKAreaMultiplayer";
|
|
15
15
|
import { AreaNetwork } from "./areas/SDKAreaNetwork";
|
|
16
|
-
import { AreaProjects } from "./areas/SDKAreaProjects";
|
|
17
16
|
import { AreaRawData } from "./areas/SDKAreaRawData";
|
|
18
17
|
import { AreaResources } from "./areas/SDKAreaResources";
|
|
19
18
|
import { AreaStorage } from "./areas/SDKAreaStorage";
|
|
@@ -75,8 +74,6 @@ export declare class Supernova {
|
|
|
75
74
|
multiplayer: AreaMultiplayer;
|
|
76
75
|
/** Get access to AI capabilities */
|
|
77
76
|
ai: AreaAI;
|
|
78
|
-
/** Get access to projects */
|
|
79
|
-
projects: AreaProjects;
|
|
80
77
|
/** Get access to raw data for local-only restoration of data */
|
|
81
78
|
raw: AreaRawData;
|
|
82
79
|
/**
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { DTODataSourceStorybookCreatePayload, DTOStorybookEntry, DTOStorybookImportPayload } from "@supernova-studio/client";
|
|
1
2
|
import { FigmaStructure } from "../../model/support/SDKFigmaStructure";
|
|
2
3
|
import { FigmaStructureDetail } from "../../model/support/SDKFigmaStructureDetail";
|
|
3
4
|
import { Source, SourceRemoteModelCloud } from "../../model/support/SDKSource";
|
|
@@ -29,6 +30,7 @@ export declare class AreaDataSources {
|
|
|
29
30
|
getFigmaNodeStructureDetail(from: RemoteVersionIdentifier & {
|
|
30
31
|
figmaStructureId: string;
|
|
31
32
|
}): Promise<FigmaStructureDetail>;
|
|
33
|
+
getStorybookEntries(from: RemoteVersionIdentifier): Promise<DTOStorybookEntry[]>;
|
|
32
34
|
linkFigmaSource(from: RemoteBrandIdentifier, url: string, options: {
|
|
33
35
|
scopes: {
|
|
34
36
|
tokens: boolean;
|
|
@@ -51,5 +53,16 @@ export declare class AreaDataSources {
|
|
|
51
53
|
autoImport?: SourceRemoteModelCloud["autoImportMode"];
|
|
52
54
|
themeId?: string | null;
|
|
53
55
|
}): Promise<Source>;
|
|
56
|
+
linkStorybookSource(from: RemoteVersionIdentifier, payload: DTODataSourceStorybookCreatePayload & {
|
|
57
|
+
isUsingVpn: boolean;
|
|
58
|
+
}): Promise<Source>;
|
|
59
|
+
updateStorybookSource(from: RemoteVersionIdentifier, payload: DTOStorybookImportPayload): Promise<{
|
|
60
|
+
isFailed: boolean;
|
|
61
|
+
docsCount: number;
|
|
62
|
+
storiesCount: number;
|
|
63
|
+
created: string[];
|
|
64
|
+
updated: string[];
|
|
65
|
+
deleted: string[];
|
|
66
|
+
}>;
|
|
54
67
|
deleteFigmaSource(from: RemoteVersionIdentifier, sourceId: string): Promise<void>;
|
|
55
68
|
}
|
|
@@ -7,7 +7,6 @@ import { DocsEntityGroupModel } from "../../model/docs/entities/SDKDocsEntityGro
|
|
|
7
7
|
import { DocsEntityPageModel } from "../../model/docs/entities/SDKDocsEntityPage";
|
|
8
8
|
import { DocsSection } from "../../model/docs/sections/SDKDocsSection";
|
|
9
9
|
import { DocumentationLegacyGroup } from "../../model/documentation/SDKDocumentationLegacyGroup";
|
|
10
|
-
import { DocumentationLegacyPage } from "../../model/documentation/SDKDocumentationLegacyPage";
|
|
11
10
|
import { DocsPublishStatus } from "../../model/enums/SDKDocsPublishStatus";
|
|
12
11
|
import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
|
|
13
12
|
import { ExportBuild, ExportBuildStatus } from "../../model/exporters/exporter_builds/SDKExportBuild";
|
|
@@ -167,15 +166,17 @@ export declare class AreaDocumentation {
|
|
|
167
166
|
* @returns nothing
|
|
168
167
|
*/
|
|
169
168
|
ungroupDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTODeleteDocumentationGroupInput): Promise<void>;
|
|
170
|
-
/** Fetches
|
|
169
|
+
/** Fetches object containing the structure of the docs - documentation pages and groups with metadata but without the page payloads
|
|
170
|
+
* Not implemented for now
|
|
171
|
+
* @param from - Remote version to fetch from
|
|
172
|
+
* @returnsDocumentationLegacy object
|
|
173
|
+
*/
|
|
174
|
+
getDocumentationStructureFromRoot(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacyGroup>;
|
|
175
|
+
/** Fetches entire documentation documentation structure, including all pages and groups and their payloads
|
|
171
176
|
* @param from - Remote version to fetch from
|
|
172
177
|
* @returns All documentation items
|
|
173
178
|
*/
|
|
174
|
-
|
|
175
|
-
rootGroup: DocumentationLegacyGroup;
|
|
176
|
-
allPages: Array<DocumentationLegacyPage>;
|
|
177
|
-
allGroups: Array<DocumentationLegacyGroup>;
|
|
178
|
-
}>;
|
|
179
|
+
getDocumentationFromRoot(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacyGroup>;
|
|
179
180
|
/** Get ID of the multiplayer room for a given documentation page
|
|
180
181
|
* @param from - Remote version to fetch from
|
|
181
182
|
* @param pageId - ID of the documentation page
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { DTOWorkspaceUntypedDataListResponse, DTOWorkspaceUntypedDataResponse } from "@supernova-studio/client";
|
|
2
1
|
import { Acl } from "../../model/acl/SDKAcl";
|
|
3
2
|
import { UserRole } from "../../model/enums/SDKUserRole";
|
|
4
3
|
import { Membership } from "../../model/membership/SDKMembership";
|
|
@@ -235,38 +234,4 @@ export declare class AreaWorkspaces {
|
|
|
235
234
|
* @returns Nothing
|
|
236
235
|
*/
|
|
237
236
|
deleteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
|
|
238
|
-
/**
|
|
239
|
-
* Lists all untyped data for a given workspace.
|
|
240
|
-
* @param workspaceId - The ID of the workspace.
|
|
241
|
-
* @returns A promise that resolves to the list of untyped data.
|
|
242
|
-
*/
|
|
243
|
-
listUntypedData(workspaceId: string): Promise<DTOWorkspaceUntypedDataListResponse>;
|
|
244
|
-
/**
|
|
245
|
-
* Creates new untyped data in the specified workspace.
|
|
246
|
-
* @param workspaceId - The ID of the workspace.
|
|
247
|
-
* @param data - The data to create. Must be a valid JSON object.
|
|
248
|
-
* @returns A promise that resolves to the created untyped data.
|
|
249
|
-
*/
|
|
250
|
-
createUntypedData(workspaceId: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
|
|
251
|
-
/**
|
|
252
|
-
* Deletes all untyped data in the specified workspace.
|
|
253
|
-
* @param workspaceId - The ID of the workspace.
|
|
254
|
-
* @returns A promise that resolves when the operation is complete.
|
|
255
|
-
*/
|
|
256
|
-
deleteAllUntypedData(workspaceId: string): Promise<void>;
|
|
257
|
-
/**
|
|
258
|
-
* Updates specific untyped data in the specified workspace.
|
|
259
|
-
* @param workspaceId - The ID of the workspace.
|
|
260
|
-
* @param id - The ID of the untyped data to update.
|
|
261
|
-
* @param data - The updated data. Must be a valid JSON object.
|
|
262
|
-
* @returns A promise that resolves to the updated untyped data.
|
|
263
|
-
*/
|
|
264
|
-
updateUntypedData(workspaceId: string, id: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
|
|
265
|
-
/**
|
|
266
|
-
* Deletes specific untyped data in the specified workspace.
|
|
267
|
-
* @param workspaceId - The ID of the workspace.
|
|
268
|
-
* @param id - The ID of the untyped data to delete.
|
|
269
|
-
* @returns A promise that resolves when the operation is complete.
|
|
270
|
-
*/
|
|
271
|
-
deleteUntypedData(workspaceId: string, id: string): Promise<void>;
|
|
272
237
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignElementsDataDiffResponse, DTODocumentationAnalyticsTimeFrame, DTODocumentationLinkPreviewRequest, DTODocumentationPageAnchor, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOElementActionInput, DTOElementPropertyValuesEditActionInput, DTOExporterPropertyValueMap, DTOFigmaNode, DTOFigmaNodeRenderIdInput, DTOFigmaNodeRenderInput, DTOFigmaNodeV2, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPageRedirectCreateBody, DTOPageRedirectUpdateBody, DTOPipelineCreateBody, DTOPipelineUpdateBody, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput,
|
|
1
|
+
import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODataSourceStorybookCreatePayload, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignElementsDataDiffResponse, DTODocumentationAnalyticsTimeFrame, DTODocumentationLinkPreviewRequest, DTODocumentationPageAnchor, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOElementActionInput, DTOElementPropertyValuesEditActionInput, DTOExporterPropertyValueMap, DTOFigmaNode, DTOFigmaNodeRenderIdInput, DTOFigmaNodeRenderInput, DTOFigmaNodeV2, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPageRedirectCreateBody, DTOPageRedirectUpdateBody, DTOPipelineCreateBody, DTOPipelineUpdateBody, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOStorybookEntry, DTOStorybookImportPayload, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
|
|
2
2
|
import { DesignSystemInvite, DesignSystemInviteUpdate, DesignSystemMemberUpdate, DesignSystemPendingMemberInvite, DesignSystemUserInvitation } from "@supernova-studio/model";
|
|
3
|
-
import { DesignSystemAccessMode, DocsBlockDefinition,
|
|
3
|
+
import { DesignSystemAccessMode, DocsBlockDefinition, ExportBuildStatus, ExporterJobDestination, ResourceFont, TokenThemeOverrideTranserObject, UserRole } 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";
|
|
@@ -263,12 +263,6 @@ export declare class DataCore {
|
|
|
263
263
|
restoreDocumentationGroup(designSystemId: string, versionId: string, payload: DTORestoreDocumentationGroupInput): Promise<void>;
|
|
264
264
|
/** Restore a documentation page */
|
|
265
265
|
restoreDocumentationPage(designSystemId: string, versionId: string, payload: DTORestoreDocumentationPageInput): Promise<void>;
|
|
266
|
-
/** Fetches entire documentation including content in the legacy format */
|
|
267
|
-
getFullDocumentationLegacyRepresentation(designSystemId: string, versionId: string, workspaceId: string): Promise<{
|
|
268
|
-
rootGroup: DocumentationLegacyGroup;
|
|
269
|
-
allPages: Array<DocumentationLegacyPage>;
|
|
270
|
-
allGroups: Array<DocumentationLegacyGroup>;
|
|
271
|
-
}>;
|
|
272
266
|
/** Create a custom property in remote */
|
|
273
267
|
updateTokenProperty(designSystemId: string, versionId: string, propertyIdInVersion: string, model: ElementPropertyUpdateModel): Promise<void>;
|
|
274
268
|
/** Delete a custom property in remote */
|
|
@@ -572,6 +566,7 @@ export declare class DataCore {
|
|
|
572
566
|
designSystemContacts(designSystemId: string): Promise<DesignSystemContactList>;
|
|
573
567
|
getFigmaNodeStructures(designSystemId: string): Promise<Array<FigmaStructure>>;
|
|
574
568
|
getFigmaNodeStructureDetail(designSystemId: string, figmaStructureId: string): Promise<FigmaStructureDetail>;
|
|
569
|
+
getStorybookEntries(designSystemId: string, versionId: string): Promise<DTOStorybookEntry[]>;
|
|
575
570
|
deleteFigmaSource(designSystemId: string, sourceId: string): Promise<void>;
|
|
576
571
|
linkFigmaSource(designSystemId: string, brandId: string, url: string, options: {
|
|
577
572
|
scopes: {
|
|
@@ -594,6 +589,17 @@ export declare class DataCore {
|
|
|
594
589
|
autoImport?: SourceRemoteModelCloud["autoImportMode"];
|
|
595
590
|
themeId?: string | null;
|
|
596
591
|
}): Promise<Source>;
|
|
592
|
+
linkStorybookSource(designSystemId: string, payload: DTODataSourceStorybookCreatePayload & {
|
|
593
|
+
isUsingVpn: boolean;
|
|
594
|
+
}): Promise<Source>;
|
|
595
|
+
updateStorybookSource(designSystemId: string, versionId: string, payload: DTOStorybookImportPayload): Promise<{
|
|
596
|
+
isFailed: boolean;
|
|
597
|
+
docsCount: number;
|
|
598
|
+
storiesCount: number;
|
|
599
|
+
created: string[];
|
|
600
|
+
updated: string[];
|
|
601
|
+
deleted: string[];
|
|
602
|
+
}>;
|
|
597
603
|
versions(designSystemId: string): Promise<Array<DesignSystemVersion>>;
|
|
598
604
|
version(designSystemId: string, versionId: string): Promise<DesignSystemVersion>;
|
|
599
605
|
versionCreationJob(designSystemId: string, jobId: string): Promise<DesignSystemVersionCreationJob>;
|
|
@@ -617,40 +623,6 @@ export declare class DataCore {
|
|
|
617
623
|
readKeyValueStorageData(designSystemId: string, key: string): Promise<string | object | undefined>;
|
|
618
624
|
setKeyValueStorageData(designSystemId: string, key: string, value: string | object): Promise<void>;
|
|
619
625
|
unsetKeyValueStorageData(designSystemId: string, key: string): Promise<void>;
|
|
620
|
-
/**
|
|
621
|
-
* Lists all untyped data for a given workspace.
|
|
622
|
-
* @param workspaceId - The ID of the workspace.
|
|
623
|
-
* @returns A promise that resolves to the list of untyped data.
|
|
624
|
-
*/
|
|
625
|
-
listUntypedData(workspaceId: string): Promise<DTOWorkspaceUntypedDataListResponse>;
|
|
626
|
-
/**
|
|
627
|
-
* Creates new untyped data in the specified workspace.
|
|
628
|
-
* @param workspaceId - The ID of the workspace.
|
|
629
|
-
* @param data - The data to create.
|
|
630
|
-
* @returns A promise that resolves to the created untyped data.
|
|
631
|
-
*/
|
|
632
|
-
createUntypedData(workspaceId: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
|
|
633
|
-
/**
|
|
634
|
-
* Deletes all untyped data in the specified workspace.
|
|
635
|
-
* @param workspaceId - The ID of the workspace.
|
|
636
|
-
* @returns A promise that resolves when the operation is complete.
|
|
637
|
-
*/
|
|
638
|
-
deleteAllUntypedData(workspaceId: string): Promise<void>;
|
|
639
|
-
/**
|
|
640
|
-
* Updates specific untyped data in the specified workspace.
|
|
641
|
-
* @param workspaceId - The ID of the workspace.
|
|
642
|
-
* @param id - The ID of the untyped data to update.
|
|
643
|
-
* @param data - The updated data.
|
|
644
|
-
* @returns A promise that resolves to the updated untyped data.
|
|
645
|
-
*/
|
|
646
|
-
updateUntypedData(workspaceId: string, id: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
|
|
647
|
-
/**
|
|
648
|
-
* Deletes specific untyped data in the specified workspace.
|
|
649
|
-
* @param workspaceId - The ID of the workspace.
|
|
650
|
-
* @param id - The ID of the untyped data to delete.
|
|
651
|
-
* @returns A promise that resolves when the operation is complete.
|
|
652
|
-
*/
|
|
653
|
-
deleteUntypedData(workspaceId: string, id: string): Promise<void>;
|
|
654
626
|
getPageRedirects(designSystemId: string): Promise<{
|
|
655
627
|
path: string;
|
|
656
628
|
id: string;
|
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
import { DTODesignElementsDataDiffResponse, DTODesignSystem, DTODesignSystemContactsResponse, DTODesignSystemMemberListResponse, DTODesignSystemVersionStats, DTODocumentationAnalyticsTimeFrame, DTODocumentationLinkPreviewRequest, DTOFigmaNode, DTOFigmaNodeV2, DTOGetDocumentationPageAnchorsResponse, DTOPipeline, DTOTokenCollection
|
|
2
|
-
import { DocumentationLegacyGroupModel } from "../../../exports";
|
|
1
|
+
import { DTODesignElementsDataDiffResponse, DTODesignSystem, DTODesignSystemContactsResponse, DTODesignSystemMemberListResponse, DTODesignSystemVersionStats, DTODocumentationAnalyticsTimeFrame, DTODocumentationLinkPreviewRequest, DTOFigmaNode, DTOFigmaNodeV2, DTOGetDocumentationPageAnchorsResponse, DTOPipeline, DTOTokenCollection } from "@supernova-studio/client";
|
|
3
2
|
import { AclRemoteModel } from "../../../model/acl/SDKAcl";
|
|
4
3
|
import { BootstrapDataRemoteModel } from "../../../model/base/SDKBootstrapData";
|
|
5
4
|
import { BrandRemoteModel } from "../../../model/base/SDKBrand";
|
|
@@ -144,15 +143,27 @@ export declare class DataCoreReadRequests {
|
|
|
144
143
|
/** Remote: Get information about design system's members */
|
|
145
144
|
getRemoteDesignSystemMemberList(designSystemId: string): Promise<DTODesignSystemMemberListResponse>;
|
|
146
145
|
getRemoteContacts(designSystemId: string): Promise<DTODesignSystemContactsResponse>;
|
|
146
|
+
getStorybookEntries(designSystemId: string, versionId: string): Promise<{
|
|
147
|
+
id: string;
|
|
148
|
+
url: string;
|
|
149
|
+
createdAt: Date;
|
|
150
|
+
updatedAt: Date;
|
|
151
|
+
sourceId: string;
|
|
152
|
+
designSystemId: string;
|
|
153
|
+
storyId: string;
|
|
154
|
+
origin: {
|
|
155
|
+
type: "docs" | "story";
|
|
156
|
+
name: string;
|
|
157
|
+
id: string;
|
|
158
|
+
title: string;
|
|
159
|
+
};
|
|
160
|
+
aliases?: string[] | undefined;
|
|
161
|
+
isDeleted?: boolean | undefined;
|
|
162
|
+
}[]>;
|
|
147
163
|
/** Remote: Get design system documentation url */
|
|
148
164
|
getRemoteDocumentationUrl(designSystemId: string, versionId: string): Promise<string | null>;
|
|
149
165
|
/** Remote: Get documentation metadata */
|
|
150
166
|
getRemoteDocumentationStructure(designSystemId: string, versionId: string): Promise<DocumentationLegacyModel>;
|
|
151
|
-
/** Remote: Get documentation metadata */
|
|
152
|
-
getRemoteDocumentationFullLegacyModel(designSystemId: string, versionId: string): Promise<{
|
|
153
|
-
pages: Array<DocumentationLegacyPageModel>;
|
|
154
|
-
groups: Array<DocumentationLegacyGroupModel>;
|
|
155
|
-
}>;
|
|
156
167
|
/** Remote: Get documentation elements diff */
|
|
157
168
|
getRemoteDocumentationElementsDiff(designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<DTODesignElementsDataDiffResponse>;
|
|
158
169
|
/** Remote: Get documentation metadata */
|
|
@@ -338,10 +349,4 @@ export declare class DataCoreReadRequests {
|
|
|
338
349
|
designSystemId: string;
|
|
339
350
|
pagePersistentId: string;
|
|
340
351
|
}[]>;
|
|
341
|
-
/**
|
|
342
|
-
* Fetches all untyped data for a given workspace.
|
|
343
|
-
* @param workspaceId - The ID of the workspace.
|
|
344
|
-
* @returns A promise that resolves to the list of untyped data.
|
|
345
|
-
*/
|
|
346
|
-
getRemoteUntypedDataList(workspaceId: string): Promise<DTOWorkspaceUntypedDataListResponse>;
|
|
347
352
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignSystem, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOElementActionInput, DTOElementPropertyValuesEditActionInput, DTOExporterPropertyValueMap, DTOFigmaNode, DTOFigmaNodeRenderIdInput, DTOFigmaNodeRenderInput, DTOFigmaNodeV2, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPageRedirectCreateBody, DTOPageRedirectUpdateBody, DTOPipelineCreateBody, DTOPipelineUpdateBody, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2
|
|
1
|
+
import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignSystem, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOElementActionInput, DTOElementPropertyValuesEditActionInput, DTOExporterPropertyValueMap, DTOFigmaNode, DTOFigmaNodeRenderIdInput, DTOFigmaNodeRenderInput, DTOFigmaNodeV2, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPageRedirectCreateBody, DTOPageRedirectUpdateBody, DTOPipelineCreateBody, DTOPipelineUpdateBody, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
|
|
2
2
|
import { DesignSystemInvite, DesignSystemInviteUpdate, DesignSystemMemberUpdate, DesignSystemPendingMemberInvite, DesignSystemUserInvitation } from "@supernova-studio/model";
|
|
3
3
|
import { DesignSystemAccessMode, ExporterJobDestination, TokenThemeOverrideTranserObject, UserRole } from "../../../exports";
|
|
4
4
|
import { Brand, BrandRemoteModel, BrandUpdateModel } from "../../../model/base/SDKBrand";
|
|
@@ -706,16 +706,20 @@ export declare class DataCoreWriteRequests {
|
|
|
706
706
|
scheduleImportJobForFigmaSources(designSystemId: string, versionId: string, sourceIds: Array<string>, dryRun: boolean): Promise<ImportJobRemoteModel>;
|
|
707
707
|
/** Remote: Deletes a remote data source */
|
|
708
708
|
deleteRemoteSource(designSystemId: string, sourceId: string): Promise<void>;
|
|
709
|
-
|
|
710
|
-
|
|
709
|
+
linkSource(designSystemId: string, data: object): Promise<SourceRemoteModel>;
|
|
710
|
+
updateSource(designSystemId: string, sourceId: string, data: object): Promise<SourceRemoteModel>;
|
|
711
|
+
updateStorybookSource(designSystemId: string, versionId: string, data: object): Promise<{
|
|
712
|
+
isFailed: boolean;
|
|
713
|
+
docsCount: number;
|
|
714
|
+
storiesCount: number;
|
|
715
|
+
created: string[];
|
|
716
|
+
updated: string[];
|
|
717
|
+
deleted: string[];
|
|
718
|
+
}>;
|
|
711
719
|
writeTokenStudioJSONData(designSystemId: string, versionId: string, data: object): Promise<object>;
|
|
712
720
|
importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", importType: "Upload", payload: any, isTokenTypeSplitEnabled?: boolean): Promise<ImportJobRemoteModel>;
|
|
713
721
|
setKeyValueStorageData(designSystemId: string, kvData: object): Promise<void>;
|
|
714
722
|
createPageRedirect(designSystemId: string, body: DTOPageRedirectCreateBody): Promise<void>;
|
|
715
723
|
updatePageRedirect(designSystemId: string, redirectId: string, body: DTOPageRedirectUpdateBody): Promise<void>;
|
|
716
724
|
deletePageRedirect(designSystemId: string, redirectId: string): Promise<void>;
|
|
717
|
-
createRemoteUntypedData(workspaceId: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
|
|
718
|
-
deleteRemoteAllUntypedData(workspaceId: string): Promise<void>;
|
|
719
|
-
updateRemoteUntypedData(workspaceId: string, id: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
|
|
720
|
-
deleteRemoteUntypedData(workspaceId: string, id: string): Promise<void>;
|
|
721
725
|
}
|
|
@@ -5,7 +5,8 @@ declare enum SourceRemoteType {
|
|
|
5
5
|
figma = "Figma",
|
|
6
6
|
tokenStudio = "TokenStudio",
|
|
7
7
|
figmaVariablesPlugin = "FigmaVariablesPlugin",
|
|
8
|
-
upload = "Upload"
|
|
8
|
+
upload = "Upload",
|
|
9
|
+
storybook = "Storybook"
|
|
9
10
|
}
|
|
10
11
|
export type SourceRemoteModel = {
|
|
11
12
|
type: SourceRemoteType;
|
|
@@ -20,6 +21,7 @@ export type SourceRemoteModel = {
|
|
|
20
21
|
cloud?: SourceRemoteModelCloud;
|
|
21
22
|
tokenStudio?: SourceRemoteModelTokensStudio;
|
|
22
23
|
figmaVariablesPlugin?: SourceRemoteModelFigmaVariablesPlugin;
|
|
24
|
+
storybook?: SourceRemoteModelStorybook;
|
|
23
25
|
scope: SourceScope;
|
|
24
26
|
};
|
|
25
27
|
export type SourceScope = {
|
|
@@ -115,6 +117,17 @@ export type SourceRemoteModelFigmaVariablesPlugin = {
|
|
|
115
117
|
lastImportMetadata?: Record<string, any>;
|
|
116
118
|
isTokenTypeSplitEnabled: boolean;
|
|
117
119
|
};
|
|
120
|
+
export type SourceRemoteModelStorybook = {
|
|
121
|
+
userUrl: string;
|
|
122
|
+
indexUrl: string;
|
|
123
|
+
isFailed: boolean;
|
|
124
|
+
docsCount: number;
|
|
125
|
+
storiesCount: number;
|
|
126
|
+
lastImportedAt?: string;
|
|
127
|
+
lastImportedSuccessfully?: string;
|
|
128
|
+
description?: string;
|
|
129
|
+
isUsingVpn?: boolean;
|
|
130
|
+
};
|
|
118
131
|
export type SourceModelTokenStudio = Omit<SourceRemoteModelTokensStudio, "lastUpdatesCheckedAt" | "lastImportedAt"> & {
|
|
119
132
|
lastUpdatesCheckedAt?: Date;
|
|
120
133
|
lastImportedAt?: Date;
|
|
@@ -126,6 +139,11 @@ export type SourceModelCloud = Omit<SourceRemoteModelCloud, "lastUpdatesCheckedA
|
|
|
126
139
|
export type SourceModelFigmaVariablesPlugin = Omit<SourceRemoteModelFigmaVariablesPlugin, "lastImportedAt"> & {
|
|
127
140
|
lastImportedAt?: Date;
|
|
128
141
|
};
|
|
142
|
+
export type SourceModelStorybook = Omit<SourceRemoteModelStorybook, "lastImportedAt" | "lastImportedSuccessfully"> & {
|
|
143
|
+
lastImportedAt?: Date;
|
|
144
|
+
lastImportedSuccessfully?: Date;
|
|
145
|
+
displayName?: string;
|
|
146
|
+
};
|
|
129
147
|
export type SourceTransportModel = Pick<Source, "type" | "id" | "fileName" | "brandId" | "themeId" | "scope"> & {
|
|
130
148
|
cloud?: SourceRemoteModelCloud | null;
|
|
131
149
|
};
|
|
@@ -138,6 +156,7 @@ export declare class Source {
|
|
|
138
156
|
cloud: SourceModelCloud | null;
|
|
139
157
|
tokenStudio?: SourceModelTokenStudio | null;
|
|
140
158
|
figmaVariablesPlugin?: SourceModelFigmaVariablesPlugin | null;
|
|
159
|
+
storybook?: SourceModelStorybook | null;
|
|
141
160
|
scope: SourceScope;
|
|
142
161
|
get lastImportedAt(): Date | null;
|
|
143
162
|
get hasError(): boolean;
|
|
@@ -3,7 +3,7 @@ export type TokenOriginModel = {
|
|
|
3
3
|
id?: string;
|
|
4
4
|
name?: string;
|
|
5
5
|
sourceId?: string;
|
|
6
|
-
sourceType?: SourceType
|
|
6
|
+
sourceType?: Exclude<SourceType, "Storybook">;
|
|
7
7
|
referenceOriginId?: string;
|
|
8
8
|
referencePersistentId?: string;
|
|
9
9
|
referenceResolutionFailed?: boolean;
|
|
@@ -15,7 +15,7 @@ export declare class TokenOrigin {
|
|
|
15
15
|
id: string | null;
|
|
16
16
|
name: string | null;
|
|
17
17
|
sourceId: string | null;
|
|
18
|
-
sourceType?: SourceType | null;
|
|
18
|
+
sourceType?: Exclude<SourceType, "Storybook"> | null;
|
|
19
19
|
referenceOriginId?: string | null;
|
|
20
20
|
referencePersistentId?: string | null;
|
|
21
21
|
/**
|