@supernova-studio/supernova-sdk-beta 2.1.2 → 2.1.12
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 +10 -2
- package/build/sdk-typescript/src/core/areas/SDKAreaAI.d.ts +37 -5
- package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +2 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaDataSources.d.ts +6 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDocsAnalytics.d.ts +8 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +9 -9
- package/build/sdk-typescript/src/core/areas/SDKAreaNetwork.d.ts +1 -2
- package/build/sdk-typescript/src/core/areas/SDKAreaProjects.d.ts +69 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaRawData.d.ts +33 -49
- package/build/sdk-typescript/src/core/areas/SDKAreaResources.d.ts +9 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +35 -0
- package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +10 -3
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +73 -8
- package/build/sdk-typescript/src/core/data/SDKDataCoreCached.d.ts +50 -0
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreAIRequests.d.ts +19 -4
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +70 -1
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +25 -14
- package/build/sdk-typescript/src/core/resolvers/SDKDesignComponentGroupResolver.d.ts +0 -1
- package/build/sdk-typescript/src/core/resolvers/SDKDocsEntityItemResolver.d.ts +13 -13
- package/build/sdk-typescript/src/exports.d.ts +13 -3
- package/build/sdk-typescript/src/model/code-components/SDKCodeComponentPropertyControlDefinition.d.ts +1 -4
- package/build/sdk-typescript/src/model/code-components/SDKCodeComponentPropertyDefinition.d.ts +0 -2
- package/build/sdk-typescript/src/model/docs/blocks/definition/actual/files/SDKDocsBlockActualFiles.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockFileProperty.d.ts +19 -0
- package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +19 -5
- package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsComparisonData.d.ts +10 -0
- package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsData.d.ts +14 -0
- package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsPageComparisonData.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsPageVisitData.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsTimeFrame.d.ts +6 -0
- package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsVisitData.d.ts +9 -0
- package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsVisitHeatMapWeek.d.ts +14 -0
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockBehaviorDataType.d.ts +3 -1
- package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +3 -1
- package/build/sdk-typescript/src/model/enums/SDKSourceType.d.ts +2 -1
- package/build/sdk-typescript/src/model/enums/SDKUserRole.d.ts +0 -2
- package/build/sdk-typescript/src/model/exporters/SDKPipeline.d.ts +1 -1
- package/build/sdk-typescript/src/model/files/SDKFileUpload.d.ts +28 -0
- package/build/sdk-typescript/src/model/groups/SDKTokenGroup.d.ts +1 -0
- package/build/sdk-typescript/src/model/projects/SDKProject.d.ts +39 -0
- package/build/sdk-typescript/src/model/projects/SDKProjectContext.d.ts +47 -0
- package/build/sdk-typescript/src/model/storybook/SDKStorybookEntry.d.ts +23 -0
- package/build/sdk-typescript/src/model/storybook/SDKStorybookUpdate.d.ts +17 -0
- package/build/sdk-typescript/src/model/support/SDKSource.d.ts +27 -1
- package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +2 -2
- package/build/sdk-typescript/src/model/tokens/SDKToken.d.ts +1 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProductFeatures.d.ts +1 -1
- package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +12 -0
- package/build/sdk-typescript/src/utils/RawUtils.d.ts +69 -0
- package/build/supernova-sdk-typescript.js +1 -2
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +33 -51
- package/build/sdk-typescript/src/model/exporters/remote/SDKRemotePipelineModel.d.ts +0 -51
- package/build/supernova-sdk-typescript.js.LICENSE.txt +0 -8
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignElementsDataDiffResponse, DTODocumentationLinkPreviewRequest, DTODocumentationPageAnchor, 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";
|
|
1
|
+
import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODataSourceStorybookCreatePayload, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignElementsDataDiffResponse, DTODocumentationAnalyticsTimeFrame, DTODocumentationLinkPreviewRequest, DTODocumentationPageAnchor, DTODocumentationPageApprovalStateChangeInput, DTODocumentationPageDependenciesGetResponse, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOElementActionInput, DTOElementPropertyValuesEditActionInput, DTOExporterPropertyValueMap, DTOFigmaNode, DTOFigmaNodeRenderIdInput, DTOFigmaNodeRenderInput, DTOFigmaNodeV2, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPageRedirectCreateBody, DTOPageRedirectUpdateBody, DTOPipelineCreateBody, DTOPipelineUpdateBody, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOStorybookEntryReplaceAction, DTOStorybookImportPayload, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTOWorkspaceUntypedDataListResponse, DTOWorkspaceUntypedDataResponse } from "@supernova-studio/client";
|
|
2
2
|
import { DesignSystemInvite, DesignSystemInviteUpdate, DesignSystemMemberUpdate, DesignSystemPendingMemberInvite, DesignSystemUserInvitation } from "@supernova-studio/model";
|
|
3
|
-
import { DesignSystemAccessMode, DocsBlockDefinition, ExportBuildStatus, ExporterJobDestination, ResourceFont, TokenThemeOverrideTranserObject, UserRole } from "../../exports";
|
|
3
|
+
import { DesignSystemAccessMode, DocsBlockDefinition, DocumentationLegacyGroup, DocumentationLegacyPage, 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";
|
|
@@ -18,6 +18,7 @@ import { Component } from "../../model/components/SDKComponent";
|
|
|
18
18
|
import { DesignComponent } from "../../model/components/SDKDesignComponent";
|
|
19
19
|
import { DocsEntityGroupModel } from "../../model/docs/entities/SDKDocsEntityGroup";
|
|
20
20
|
import { DocsEntityPageModel } from "../../model/docs/entities/SDKDocsEntityPage";
|
|
21
|
+
import { DocsAnalyticsData } from "../../model/docs_analytics/SDKDocsAnalyticsData";
|
|
21
22
|
import { ElementDataView } from "../../model/elements/SDKElementDataView";
|
|
22
23
|
import { ElementDataViewColumn } from "../../model/elements/SDKElementDataViewColumn";
|
|
23
24
|
import { ElementProperty, ElementPropertyCreationModel, ElementPropertyTargetElementType, ElementPropertyUpdateModel } from "../../model/elements/SDKElementProperty";
|
|
@@ -34,6 +35,7 @@ import { ExporterConfigurationProperty } from "../../model/exporters/custom_prop
|
|
|
34
35
|
import { ExportBuild } from "../../model/exporters/exporter_builds/SDKExportBuild";
|
|
35
36
|
import { ExportBuildResultLog } from "../../model/exporters/exporter_builds/SDKExportBuildResults";
|
|
36
37
|
import { ConnectionRemoteModel } from "../../model/exporters/remote/SDKRemoteConnectionsModel";
|
|
38
|
+
import { FileUploadItem } from "../../model/files/SDKFileUpload";
|
|
37
39
|
import { AssetGroup } from "../../model/groups/SDKAssetGroup";
|
|
38
40
|
import { ComponentGroup } from "../../model/groups/SDKComponentGroup";
|
|
39
41
|
import { DesignComponentGroup } from "../../model/groups/SDKDesignComponentGroup";
|
|
@@ -41,6 +43,7 @@ import { TokenGroup } from "../../model/groups/SDKTokenGroup";
|
|
|
41
43
|
import { ImportJob } from "../../model/jobs/SDKImportJob";
|
|
42
44
|
import { Membership } from "../../model/membership/SDKMembership";
|
|
43
45
|
import { ResourceAsset } from "../../model/resources/SDKResourceAsset";
|
|
46
|
+
import { StorybookEntry } from "../../model/storybook/SDKStorybookEntry";
|
|
44
47
|
import { CustomDomain } from "../../model/support/SDKCustomDomain";
|
|
45
48
|
import { FigmaStructure } from "../../model/support/SDKFigmaStructure";
|
|
46
49
|
import { FigmaStructureDetail } from "../../model/support/SDKFigmaStructureDetail";
|
|
@@ -71,11 +74,11 @@ import { GitProvidersBranches } from "../../model/workspaces/integrations/GitPro
|
|
|
71
74
|
import { GitProvidersOrganizations } from "../../model/workspaces/integrations/GitProvidersOrganizations";
|
|
72
75
|
import { GitProvidersProjects } from "../../model/workspaces/integrations/GitProvidersProjects";
|
|
73
76
|
import { GitProvidersRepositories } from "../../model/workspaces/integrations/GitProvidersRepositories";
|
|
77
|
+
import { AIGetRouteQueryTask } from "../areas/SDKAreaAI";
|
|
74
78
|
import { ComponentUpdateTransactionData, TokenUpdateTransactionData } from "../areas/SDKAreaBulkOperations";
|
|
75
79
|
import { DataCoreReadRequests } from "./requests/SDKDataCoreReadRequests";
|
|
76
80
|
import { RenderedAssetRequestSettings } from "./requests/SDKDataCoreRenderRequests";
|
|
77
81
|
import { DataBridge } from "./SDKDataBridge";
|
|
78
|
-
import { RequestInfo, RequestInit, Response } from "node-fetch";
|
|
79
82
|
export declare class DataCore {
|
|
80
83
|
/** Read part of the network calls */
|
|
81
84
|
read: DataCoreReadRequests;
|
|
@@ -101,10 +104,20 @@ export declare class DataCore {
|
|
|
101
104
|
maxWordCount: number;
|
|
102
105
|
strategy: "noun" | "verb";
|
|
103
106
|
}): Promise<string>;
|
|
107
|
+
/** Remote: Populates Forge instance a code snippet from a prompt. Response is streamed */
|
|
108
|
+
aiCode(workspaceId: string, designSystemId: string, versionId: string, projectId: string, participantId: string, messageType: string, prompt: string, options: {
|
|
109
|
+
agentId?: string;
|
|
110
|
+
branchId?: string;
|
|
111
|
+
}): Promise<ReadableStreamDefaultReader<Uint8Array>>;
|
|
104
112
|
/** Remote: Autocompletes a prompt into a full text. Response is not streamed. */
|
|
105
|
-
aiAutocompleteText(workspaceId: string, designSystemId: string, versionId: string,
|
|
113
|
+
aiAutocompleteText(workspaceId: string, designSystemId: string, versionId: string, textToComplete: string, options?: {
|
|
106
114
|
maximumLength: number;
|
|
107
|
-
|
|
115
|
+
previousText?: string;
|
|
116
|
+
afterText?: string;
|
|
117
|
+
}): Promise<{
|
|
118
|
+
completion: string;
|
|
119
|
+
fullText: string;
|
|
120
|
+
}>;
|
|
108
121
|
/** Remote: Answers question based on the data of design system in natural language. This method is non-streaming. */
|
|
109
122
|
aiAnswer(workspaceId: string, designSystemId: string, versionId: string, prompt: string, options: {
|
|
110
123
|
persona: "designer" | "developer";
|
|
@@ -116,9 +129,11 @@ export declare class DataCore {
|
|
|
116
129
|
persona: "designer" | "developer";
|
|
117
130
|
scope: "all" | "tokens" | "components" | "assets" | "docs";
|
|
118
131
|
density: "compact" | "full";
|
|
119
|
-
}): Promise<
|
|
132
|
+
}): Promise<ReadableStreamDefaultReader<Uint8Array>>;
|
|
120
133
|
/** Indexes or reindexes a design system to prepare it for QA engine */
|
|
121
|
-
aiRebuildAnswerIndex(workspaceId: string, designSystemId: string, versionId: string): Promise<
|
|
134
|
+
aiRebuildAnswerIndex(workspaceId: string, designSystemId: string, versionId: string): Promise<void>;
|
|
135
|
+
/** Remote: Retrieves executable url for various AI tasks */
|
|
136
|
+
executableTaskUrl(task: AIGetRouteQueryTask): Promise<string>;
|
|
122
137
|
/** Remote: Get information about currently logged in user */
|
|
123
138
|
currentUser(): Promise<User>;
|
|
124
139
|
/** Remote: Get information about a specific user */
|
|
@@ -255,6 +270,12 @@ export declare class DataCore {
|
|
|
255
270
|
restoreDocumentationGroup(designSystemId: string, versionId: string, payload: DTORestoreDocumentationGroupInput): Promise<void>;
|
|
256
271
|
/** Restore a documentation page */
|
|
257
272
|
restoreDocumentationPage(designSystemId: string, versionId: string, payload: DTORestoreDocumentationPageInput): Promise<void>;
|
|
273
|
+
/** Fetches entire documentation including content in the legacy format */
|
|
274
|
+
getFullDocumentationLegacyRepresentation(designSystemId: string, versionId: string, workspaceId: string): Promise<{
|
|
275
|
+
rootGroup: DocumentationLegacyGroup;
|
|
276
|
+
allPages: Array<DocumentationLegacyPage>;
|
|
277
|
+
allGroups: Array<DocumentationLegacyGroup>;
|
|
278
|
+
}>;
|
|
258
279
|
/** Create a custom property in remote */
|
|
259
280
|
updateTokenProperty(designSystemId: string, versionId: string, propertyIdInVersion: string, model: ElementPropertyUpdateModel): Promise<void>;
|
|
260
281
|
/** Delete a custom property in remote */
|
|
@@ -356,10 +377,14 @@ export declare class DataCore {
|
|
|
356
377
|
/** Publish the documentation drafts */
|
|
357
378
|
documentationPublishDrafts(designSystemId: string, versionId: string, environment: DocumentationEnvironment, changes: DTOPublishDocumentationRequest["changes"]): Promise<ExportBuild>;
|
|
358
379
|
getDocumentationPageAnchors(designSystemId: string, versionId: string, pageId: string): Promise<Array<DTODocumentationPageAnchor>>;
|
|
380
|
+
getDocumentationDependencies(designSystemId: string, versionId: string): Promise<DTODocumentationPageDependenciesGetResponse["dependencies"]>;
|
|
381
|
+
docsPageAnalytics(designSystemId: string, versionId: string, timeFrames: Array<DTODocumentationAnalyticsTimeFrame>): Promise<DocsAnalyticsData>;
|
|
359
382
|
/** Retrieve all asset resources */
|
|
360
383
|
assetResources(designSystemId: string, versionId: string): Promise<Array<ResourceAsset>>;
|
|
361
384
|
/** Retrieve all font resources */
|
|
362
385
|
fontResources(designSystemId: string, versionId: string): Promise<Array<ResourceFont>>;
|
|
386
|
+
/** Retrieve all files */
|
|
387
|
+
files(designSystemId: string, versionId: string): Promise<import("../../exports").RemoteFile[]>;
|
|
363
388
|
/** Upload asset resource */
|
|
364
389
|
uploadAssetResource(designSystemId: string, versionId: string, asset: File): Promise<ResourceAsset>;
|
|
365
390
|
/** Upload font resource */
|
|
@@ -370,6 +395,8 @@ export declare class DataCore {
|
|
|
370
395
|
deleteResource(designSystemId: string, versionId: string, resourceId: string): Promise<void>;
|
|
371
396
|
/** Delete any multiple resources */
|
|
372
397
|
deleteResources(designSystemId: string, versionId: string, resourceIds: string[]): Promise<void>;
|
|
398
|
+
initializeFileUpload(designSystemId: string, versionId: string, fileUploadItems: Array<FileUploadItem>): Promise<import("../../model/files/SDKFileUpload").FileUploadResult>;
|
|
399
|
+
finalizeFileUpload(designSystemId: string, versionId: string, fileIds: Array<string>): Promise<any>;
|
|
373
400
|
pipelines(workspaceId: string, designSystemId?: string): Promise<Array<Pipeline>>;
|
|
374
401
|
createPipeline(workspaceId: string, payload: DTOPipelineCreateBody): Promise<Pipeline>;
|
|
375
402
|
updatePipeline(designSystemId: string, pipelineId: string, payload: DTOPipelineUpdateBody): Promise<Pipeline>;
|
|
@@ -410,7 +437,7 @@ export declare class DataCore {
|
|
|
410
437
|
documentationBuilds(workspaceId: string, versionId: string, environment: DocumentationEnvironment, status?: ExportBuildStatus, createdByUserId?: string, limit?: number): Promise<Array<ExportBuild>>;
|
|
411
438
|
buildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLog>>;
|
|
412
439
|
/** Create a new exporter build */
|
|
413
|
-
createExporterBuild(workspaceId: string, designSystemId: string, versionId: string, exporterId: string, destinations: ExporterJobDestination, brandId: string | undefined, themePersistentIds: Array<string> | undefined, exporterConfigurationProperties: DTOExporterPropertyValueMap | undefined): Promise<ExportBuild>;
|
|
440
|
+
createExporterBuild(workspaceId: string, designSystemId: string, versionId: string, exporterId: string, destinations: ExporterJobDestination, brandId: string | undefined, themePersistentIds: Array<string> | undefined, exporterConfigurationProperties: DTOExporterPropertyValueMap | undefined, previewMode: boolean | undefined): Promise<ExportBuild>;
|
|
414
441
|
workspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeatures>;
|
|
415
442
|
/** Download information about a single workspace and retrieve it resolved */
|
|
416
443
|
workspace(workspaceId: string): Promise<Workspace>;
|
|
@@ -557,6 +584,7 @@ export declare class DataCore {
|
|
|
557
584
|
designSystemContacts(designSystemId: string): Promise<DesignSystemContactList>;
|
|
558
585
|
getFigmaNodeStructures(designSystemId: string): Promise<Array<FigmaStructure>>;
|
|
559
586
|
getFigmaNodeStructureDetail(designSystemId: string, figmaStructureId: string): Promise<FigmaStructureDetail>;
|
|
587
|
+
getStorybookEntries(designSystemId: string, versionId: string): Promise<StorybookEntry[]>;
|
|
560
588
|
deleteFigmaSource(designSystemId: string, sourceId: string): Promise<void>;
|
|
561
589
|
linkFigmaSource(designSystemId: string, brandId: string, url: string, options: {
|
|
562
590
|
scopes: {
|
|
@@ -579,6 +607,9 @@ export declare class DataCore {
|
|
|
579
607
|
autoImport?: SourceRemoteModelCloud["autoImportMode"];
|
|
580
608
|
themeId?: string | null;
|
|
581
609
|
}): Promise<Source>;
|
|
610
|
+
linkStorybookSource(designSystemId: string, payload: DTODataSourceStorybookCreatePayload): Promise<Source>;
|
|
611
|
+
updateStorybookSource(designSystemId: string, versionId: string, payload: DTOStorybookImportPayload): Promise<import("../../model/storybook/SDKStorybookUpdate").StorybookUpdate>;
|
|
612
|
+
replaceStorybookStory(designSystemId: string, versionId: string, storyId: string, payload: DTOStorybookEntryReplaceAction): Promise<any>;
|
|
582
613
|
versions(designSystemId: string): Promise<Array<DesignSystemVersion>>;
|
|
583
614
|
version(designSystemId: string, versionId: string): Promise<DesignSystemVersion>;
|
|
584
615
|
versionCreationJob(designSystemId: string, jobId: string): Promise<DesignSystemVersionCreationJob>;
|
|
@@ -602,6 +633,40 @@ export declare class DataCore {
|
|
|
602
633
|
readKeyValueStorageData(designSystemId: string, key: string): Promise<string | object | undefined>;
|
|
603
634
|
setKeyValueStorageData(designSystemId: string, key: string, value: string | object): Promise<void>;
|
|
604
635
|
unsetKeyValueStorageData(designSystemId: string, key: string): Promise<void>;
|
|
636
|
+
/**
|
|
637
|
+
* Lists all untyped data for a given workspace.
|
|
638
|
+
* @param workspaceId - The ID of the workspace.
|
|
639
|
+
* @returns A promise that resolves to the list of untyped data.
|
|
640
|
+
*/
|
|
641
|
+
listUntypedData(workspaceId: string): Promise<DTOWorkspaceUntypedDataListResponse>;
|
|
642
|
+
/**
|
|
643
|
+
* Creates new untyped data in the specified workspace.
|
|
644
|
+
* @param workspaceId - The ID of the workspace.
|
|
645
|
+
* @param data - The data to create.
|
|
646
|
+
* @returns A promise that resolves to the created untyped data.
|
|
647
|
+
*/
|
|
648
|
+
createUntypedData(workspaceId: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
|
|
649
|
+
/**
|
|
650
|
+
* Deletes all untyped data in the specified workspace.
|
|
651
|
+
* @param workspaceId - The ID of the workspace.
|
|
652
|
+
* @returns A promise that resolves when the operation is complete.
|
|
653
|
+
*/
|
|
654
|
+
deleteAllUntypedData(workspaceId: string): Promise<void>;
|
|
655
|
+
/**
|
|
656
|
+
* Updates specific untyped data in the specified workspace.
|
|
657
|
+
* @param workspaceId - The ID of the workspace.
|
|
658
|
+
* @param id - The ID of the untyped data to update.
|
|
659
|
+
* @param data - The updated data.
|
|
660
|
+
* @returns A promise that resolves to the updated untyped data.
|
|
661
|
+
*/
|
|
662
|
+
updateUntypedData(workspaceId: string, id: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
|
|
663
|
+
/**
|
|
664
|
+
* Deletes specific untyped data in the specified workspace.
|
|
665
|
+
* @param workspaceId - The ID of the workspace.
|
|
666
|
+
* @param id - The ID of the untyped data to delete.
|
|
667
|
+
* @returns A promise that resolves when the operation is complete.
|
|
668
|
+
*/
|
|
669
|
+
deleteUntypedData(workspaceId: string, id: string): Promise<void>;
|
|
605
670
|
getPageRedirects(designSystemId: string): Promise<{
|
|
606
671
|
path: string;
|
|
607
672
|
id: string;
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import { ElementDataView } from "../../model/elements/SDKElementDataView";
|
|
2
|
+
import { ElementProperty, ElementPropertyTargetElementType } from "../../model/elements/SDKElementProperty";
|
|
3
|
+
import { ElementPropertyValue } from "../../model/elements/values/SDKElementPropertyValue";
|
|
4
|
+
import { TokenType } from "../../model/enums/SDKTokenType";
|
|
5
|
+
import { TokenGroup } from "../../model/groups/SDKTokenGroup";
|
|
6
|
+
import { Component } from "../../model/components/SDKComponent";
|
|
7
|
+
import { ComponentGroup } from "../../model/groups/SDKComponentGroup";
|
|
8
|
+
import { DesignComponentGroup } from "../../model/groups/SDKDesignComponentGroup";
|
|
9
|
+
import { DesignComponent } from "../../model/components/SDKDesignComponent";
|
|
10
|
+
import { Source } from "../../model/support/SDKSource";
|
|
11
|
+
import { TokenTheme } from "../../model/themes/SDKTokenTheme";
|
|
12
|
+
import { Token } from "../../model/tokens/SDKToken";
|
|
13
|
+
import { DataCore } from "./SDKDataCore";
|
|
14
|
+
export declare class DataCoreCached extends DataCore {
|
|
15
|
+
private tokensCache;
|
|
16
|
+
private tokenGroupsCache;
|
|
17
|
+
private designSystemSourcesCache;
|
|
18
|
+
private themesCache;
|
|
19
|
+
private elementPropertyDefinitionsCache;
|
|
20
|
+
private elementPropertyValuesCache;
|
|
21
|
+
private elementViewsCache;
|
|
22
|
+
private componentsCache;
|
|
23
|
+
private componentGroupsCache;
|
|
24
|
+
private designComponentsCache;
|
|
25
|
+
private designComponentGroupsCache;
|
|
26
|
+
tokens(designSystemId: string, versionId: string, filter?: {
|
|
27
|
+
type?: TokenType;
|
|
28
|
+
brandId?: string;
|
|
29
|
+
}): Promise<Token[]>;
|
|
30
|
+
tokenGroups(designSystemId: string, versionId: string, filter?: {
|
|
31
|
+
type?: TokenType;
|
|
32
|
+
brandId?: string;
|
|
33
|
+
}): Promise<TokenGroup[]>;
|
|
34
|
+
designSystemSources(designSystemId: string): Promise<Source[]>;
|
|
35
|
+
themes(designSystemId: string, versionId: string): Promise<TokenTheme[]>;
|
|
36
|
+
elementPropertyDefinitions(designSystemId: string, versionId: string, type: ElementPropertyTargetElementType): Promise<ElementProperty[]>;
|
|
37
|
+
elementPropertyValues(designSystemId: string, versionId: string): Promise<ElementPropertyValue[]>;
|
|
38
|
+
elementViews(designSystemId: string, versionId: string, type: ElementPropertyTargetElementType): Promise<ElementDataView[]>;
|
|
39
|
+
components(designSystemId: string, versionId: string, filter?: {
|
|
40
|
+
brandId?: string;
|
|
41
|
+
}): Promise<Component[]>;
|
|
42
|
+
componentGroups(designSystemId: string, versionId: string): Promise<ComponentGroup[]>;
|
|
43
|
+
designComponents(designSystemId: string, versionId: string, filter?: {
|
|
44
|
+
brandId?: string;
|
|
45
|
+
}): Promise<DesignComponent[]>;
|
|
46
|
+
designComponentGroups(designSystemId: string, versionId: string, filter?: {
|
|
47
|
+
brandId?: string;
|
|
48
|
+
}): Promise<DesignComponentGroup[]>;
|
|
49
|
+
private cached;
|
|
50
|
+
}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { AIGetRouteQueryTask } from "../../areas/SDKAreaAI";
|
|
1
2
|
import { DataBridge } from "../SDKDataBridge";
|
|
2
3
|
export declare class DataCoreAIRequests {
|
|
3
4
|
private bridge;
|
|
@@ -7,10 +8,20 @@ export declare class DataCoreAIRequests {
|
|
|
7
8
|
maxWordCount: number;
|
|
8
9
|
strategy: "noun" | "verb";
|
|
9
10
|
}): Promise<string>;
|
|
11
|
+
/** Remote: Populates Forge instance a code snippet from a prompt. Response is streamed */
|
|
12
|
+
code(workspaceId: string, designSystemId: string, versionId: string, projectId: string, participantId: string, messageType: string, prompt: string, options: {
|
|
13
|
+
agentId?: string;
|
|
14
|
+
branchId?: string;
|
|
15
|
+
}): Promise<ReadableStreamDefaultReader<Uint8Array>>;
|
|
10
16
|
/** Remote: Autocompletes a prompt into a full text. Response is not streamed. */
|
|
11
|
-
autocompleteText(workspaceId: string, designSystemId: string, versionId: string,
|
|
17
|
+
autocompleteText(workspaceId: string, designSystemId: string, versionId: string, textToComplete: string, options?: {
|
|
12
18
|
maximumLength: number;
|
|
13
|
-
|
|
19
|
+
previousText?: string;
|
|
20
|
+
afterText?: string;
|
|
21
|
+
}): Promise<{
|
|
22
|
+
completion: string;
|
|
23
|
+
fullText: string;
|
|
24
|
+
}>;
|
|
14
25
|
/** Remote: Answers question based on the data of design system in natural language. This method is non-streaming. */
|
|
15
26
|
answer(workspaceId: string, designSystemId: string, versionId: string, question: string, options: {
|
|
16
27
|
persona: "designer" | "developer";
|
|
@@ -22,7 +33,11 @@ export declare class DataCoreAIRequests {
|
|
|
22
33
|
persona: "designer" | "developer";
|
|
23
34
|
scope: "all" | "tokens" | "components" | "assets" | "docs";
|
|
24
35
|
density: "compact" | "full";
|
|
25
|
-
}): Promise<
|
|
36
|
+
}): Promise<ReadableStreamDefaultReader<Uint8Array>>;
|
|
26
37
|
/** Indexes or reindexes a design system to prepare it for QA engine */
|
|
27
|
-
rebuildAnswerIndex(workspaceId: string, designSystemId: string, versionId: string): Promise<
|
|
38
|
+
rebuildAnswerIndex(workspaceId: string, designSystemId: string, versionId: string): Promise<void>;
|
|
39
|
+
/** Retrieves executable url for various AI tasks */
|
|
40
|
+
executableTaskUrl(task: AIGetRouteQueryTask): Promise<string>;
|
|
41
|
+
cachedEndpoints: Map<AIGetRouteQueryTask, string>;
|
|
42
|
+
private getCachedAIEndpoint;
|
|
28
43
|
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import { DTODesignElementsDataDiffResponse, DTODesignSystem, DTODesignSystemContactsResponse, DTODesignSystemMemberListResponse, DTODesignSystemVersionStats, DTODocumentationLinkPreviewRequest, DTOFigmaNode, DTOFigmaNodeV2, DTOGetDocumentationPageAnchorsResponse, DTOPipeline, DTOTokenCollection } from "@supernova-studio/client";
|
|
1
|
+
import { DTODesignElementsDataDiffResponse, DTODesignSystem, DTODesignSystemContactsResponse, DTODesignSystemMemberListResponse, DTODesignSystemVersionStats, DTODocumentationAnalyticsTimeFrame, DTODocumentationLinkPreviewRequest, DTODocumentationPageDependenciesGetResponse, DTOFigmaNode, DTOFigmaNodeV2, DTOGetDocumentationPageAnchorsResponse, DTOPipeline, DTOTokenCollection, DTOWorkspaceUntypedDataListResponse } from "@supernova-studio/client";
|
|
2
|
+
import { DocumentationLegacyGroupModel } from "../../../exports";
|
|
2
3
|
import { AclRemoteModel } from "../../../model/acl/SDKAcl";
|
|
3
4
|
import { BootstrapDataRemoteModel } from "../../../model/base/SDKBootstrapData";
|
|
4
5
|
import { BrandRemoteModel } from "../../../model/base/SDKBrand";
|
|
@@ -21,6 +22,7 @@ import { ExporterMembershipModel, ExporterModel, ExporterProvider } from "../../
|
|
|
21
22
|
import { ExporterCustomBlockModel } from "../../../model/exporters/custom_blocks/SDKExporterCustomBlock";
|
|
22
23
|
import { ExportBuildModel, ExportBuildStatus } from "../../../model/exporters/exporter_builds/SDKExportBuild";
|
|
23
24
|
import { ExportBuildResultLogModel } from "../../../model/exporters/exporter_builds/SDKExportBuildResults";
|
|
25
|
+
import { RemoteFile } from "../../../model/files/SDKFileUpload";
|
|
24
26
|
import { ComponentGroupRemoteModel } from "../../../model/groups/SDKComponentGroup";
|
|
25
27
|
import { DesignComponentGroupRemoteModel } from "../../../model/groups/SDKDesignComponentGroup";
|
|
26
28
|
import { TokenGroupRemoteModel } from "../../../model/groups/SDKTokenGroup";
|
|
@@ -28,6 +30,7 @@ import { ImportJobRemoteModel } from "../../../model/jobs/SDKImportJob";
|
|
|
28
30
|
import { MembershipRemoteModel } from "../../../model/membership/SDKMembership";
|
|
29
31
|
import { ResourceAssetModel } from "../../../model/resources/SDKResourceAsset";
|
|
30
32
|
import { ResourceFontModel } from "../../../model/resources/SDKResourceFont";
|
|
33
|
+
import { RemoteStorybookEntry } from "../../../model/storybook/SDKStorybookEntry";
|
|
31
34
|
import { CustomDomainRemoteModel } from "../../../model/support/SDKCustomDomain";
|
|
32
35
|
import { SourceRemoteModel } from "../../../model/support/SDKSource";
|
|
33
36
|
import { TokenThemeRemoteModel } from "../../../model/themes/SDKTokenTheme";
|
|
@@ -143,10 +146,16 @@ export declare class DataCoreReadRequests {
|
|
|
143
146
|
/** Remote: Get information about design system's members */
|
|
144
147
|
getRemoteDesignSystemMemberList(designSystemId: string): Promise<DTODesignSystemMemberListResponse>;
|
|
145
148
|
getRemoteContacts(designSystemId: string): Promise<DTODesignSystemContactsResponse>;
|
|
149
|
+
getStorybookEntries(designSystemId: string, versionId: string): Promise<RemoteStorybookEntry[]>;
|
|
146
150
|
/** Remote: Get design system documentation url */
|
|
147
151
|
getRemoteDocumentationUrl(designSystemId: string, versionId: string): Promise<string | null>;
|
|
148
152
|
/** Remote: Get documentation metadata */
|
|
149
153
|
getRemoteDocumentationStructure(designSystemId: string, versionId: string): Promise<DocumentationLegacyModel>;
|
|
154
|
+
/** Remote: Get documentation metadata */
|
|
155
|
+
getRemoteDocumentationFullLegacyModel(designSystemId: string, versionId: string): Promise<{
|
|
156
|
+
pages: Array<DocumentationLegacyPageModel>;
|
|
157
|
+
groups: Array<DocumentationLegacyGroupModel>;
|
|
158
|
+
}>;
|
|
150
159
|
/** Remote: Get documentation elements diff */
|
|
151
160
|
getRemoteDocumentationElementsDiff(designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<DTODesignElementsDataDiffResponse>;
|
|
152
161
|
/** Remote: Get documentation metadata */
|
|
@@ -158,6 +167,58 @@ export declare class DataCoreReadRequests {
|
|
|
158
167
|
/** Remote: Get id of the room for a specific workspace. */
|
|
159
168
|
getRemoteDocumentationWorkspaceRoomId(workspaceId: string): Promise<string>;
|
|
160
169
|
getRemoteDocumentationPageAnchors(designSystemId: string, versionId: string, pageId: string): Promise<DTOGetDocumentationPageAnchorsResponse>;
|
|
170
|
+
getRemoteDocumentationPageDependencies(designSystemId: string, versionId: string): Promise<DTODocumentationPageDependenciesGetResponse["dependencies"]>;
|
|
171
|
+
getRemoteDocsPageAnalytics(designSystemId: string, versionId: string, timeFrames: Array<DTODocumentationAnalyticsTimeFrame>): Promise<{
|
|
172
|
+
globalAnalytics: {
|
|
173
|
+
versionId: string;
|
|
174
|
+
timestamp: Date;
|
|
175
|
+
visits: number;
|
|
176
|
+
sessions: number;
|
|
177
|
+
locale?: string | undefined;
|
|
178
|
+
}[];
|
|
179
|
+
pageAnalytics: {
|
|
180
|
+
versionId: string;
|
|
181
|
+
pagePersistentId: string;
|
|
182
|
+
timestamp: Date;
|
|
183
|
+
visits: number;
|
|
184
|
+
sessions: number;
|
|
185
|
+
locale?: string | undefined;
|
|
186
|
+
}[];
|
|
187
|
+
heatMapData: {
|
|
188
|
+
timeFrame: {
|
|
189
|
+
start: Date;
|
|
190
|
+
end?: Date | undefined;
|
|
191
|
+
};
|
|
192
|
+
mon: number[];
|
|
193
|
+
tue: number[];
|
|
194
|
+
wed: number[];
|
|
195
|
+
thu: number[];
|
|
196
|
+
fri: number[];
|
|
197
|
+
sat: number[];
|
|
198
|
+
sun: number[];
|
|
199
|
+
}[];
|
|
200
|
+
comparisonData: {
|
|
201
|
+
timeFrame: {
|
|
202
|
+
start: Date;
|
|
203
|
+
end?: Date | undefined;
|
|
204
|
+
};
|
|
205
|
+
priorVisitCount: number;
|
|
206
|
+
priorSessionCount: number;
|
|
207
|
+
currentVisitCount: number;
|
|
208
|
+
currentSessionCount: number;
|
|
209
|
+
}[];
|
|
210
|
+
pageComparisonData: {
|
|
211
|
+
pagePersistentId: string;
|
|
212
|
+
timeFrame: {
|
|
213
|
+
start: Date;
|
|
214
|
+
end?: Date | undefined;
|
|
215
|
+
};
|
|
216
|
+
priorVisitCount: number;
|
|
217
|
+
priorSessionCount: number;
|
|
218
|
+
currentVisitCount: number;
|
|
219
|
+
currentSessionCount: number;
|
|
220
|
+
}[];
|
|
221
|
+
}>;
|
|
161
222
|
/** Remote: Get custom blocks for currently installed documentation exporter under specific ds */
|
|
162
223
|
getRemoteExporterCustomBlocks(designSystemId: string, versionId: string): Promise<Array<ExporterCustomBlockModel>>;
|
|
163
224
|
/** Remote: Get user configuration of specific installed exporter */
|
|
@@ -196,6 +257,8 @@ export declare class DataCoreReadRequests {
|
|
|
196
257
|
getRemoteAssetResources(designSystemId: string, versionId: string): Promise<Array<ResourceAssetModel>>;
|
|
197
258
|
/** Remote: Get all font resources */
|
|
198
259
|
getRemoteFontResources(designSystemId: string, versionId: string): Promise<Array<ResourceFontModel>>;
|
|
260
|
+
/** Remote: Get all files */
|
|
261
|
+
getRemoteFiles(designSystemId: string, versionId: string): Promise<RemoteFile[]>;
|
|
199
262
|
/** Remote: Get all tokens from all categories */
|
|
200
263
|
getRemoteTokens(designSystemId: string, versionId: string, filter?: {
|
|
201
264
|
type?: TokenType;
|
|
@@ -265,4 +328,10 @@ export declare class DataCoreReadRequests {
|
|
|
265
328
|
designSystemId: string;
|
|
266
329
|
pagePersistentId: string;
|
|
267
330
|
}[]>;
|
|
331
|
+
/**
|
|
332
|
+
* Fetches all untyped data for a given workspace.
|
|
333
|
+
* @param workspaceId - The ID of the workspace.
|
|
334
|
+
* @returns A promise that resolves to the list of untyped data.
|
|
335
|
+
*/
|
|
336
|
+
getRemoteUntypedDataList(workspaceId: string): Promise<DTOWorkspaceUntypedDataListResponse>;
|
|
268
337
|
}
|
|
@@ -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 } from "@supernova-studio/client";
|
|
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, DTOWorkspaceUntypedDataResponse } 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";
|
|
@@ -14,11 +14,14 @@ import { AuthenticationTokenPayload, AzurePersonalAccessTokenConnectionPayload,
|
|
|
14
14
|
import { ExporterProvider, NewExporterPayload } from "../../../model/exporters/SDKExporter";
|
|
15
15
|
import { ExportBuildModel } from "../../../model/exporters/exporter_builds/SDKExportBuild";
|
|
16
16
|
import { ConnectionRemoteModel } from "../../../model/exporters/remote/SDKRemoteConnectionsModel";
|
|
17
|
+
import { FileUploadItem } from "../../../model/files/SDKFileUpload";
|
|
18
|
+
import { FileUploadResult } from "../../../model/files/SDKFileUpload";
|
|
17
19
|
import { ComponentGroup, ComponentGroupRemoteModel } from "../../../model/groups/SDKComponentGroup";
|
|
18
20
|
import { TokenGroup, TokenGroupRemoteModel } from "../../../model/groups/SDKTokenGroup";
|
|
19
21
|
import { ImportJobRemoteModel } from "../../../model/jobs/SDKImportJob";
|
|
20
22
|
import { ResourceAssetModel } from "../../../model/resources/SDKResourceAsset";
|
|
21
23
|
import { ResourceFontModel } from "../../../model/resources/SDKResourceFont";
|
|
24
|
+
import { StorybookUpdate } from "../../../model/storybook/SDKStorybookUpdate";
|
|
22
25
|
import { CustomDomainRemoteModel } from "../../../model/support/SDKCustomDomain";
|
|
23
26
|
import { SourceRemoteModel } from "../../../model/support/SDKSource";
|
|
24
27
|
import { TokenThemeRemoteModel } from "../../../model/themes/SDKTokenTheme";
|
|
@@ -204,6 +207,8 @@ export declare class DataCoreWriteRequests {
|
|
|
204
207
|
deleteResource(designSystemId: string, versionId: string, resourceId: string): Promise<void>;
|
|
205
208
|
/** Remote: Delete resources */
|
|
206
209
|
deleteResources(designSystemId: string, versionId: string, resourceIds: string[]): Promise<void>;
|
|
210
|
+
initializeFileUpload(designSystemId: string, versionId: string, fileUploadItems: Array<FileUploadItem>): Promise<FileUploadResult>;
|
|
211
|
+
finalizeFileUpload(designSystemId: string, versionId: string, fileIds: Array<string>): Promise<any>;
|
|
207
212
|
createRemoteComponent(designSystemId: string, versionId: string, component: ComponentRemoteModel): Promise<ComponentRemoteModel>;
|
|
208
213
|
updateRemoteComponent(designSystemId: string, versionId: string, component: ComponentUpdateRemoteModel): Promise<ComponentRemoteModel>;
|
|
209
214
|
createRemoteComponentGroup(designSystemId: string, versionId: string, group: ComponentGroupRemoteModel): Promise<ComponentGroupRemoteModel>;
|
|
@@ -236,15 +241,15 @@ export declare class DataCoreWriteRequests {
|
|
|
236
241
|
createRemotePipeline(workspaceId: string, payload: DTOPipelineCreateBody): Promise<{
|
|
237
242
|
id: string;
|
|
238
243
|
name: string;
|
|
239
|
-
workspaceId: string;
|
|
240
244
|
designSystemId: string;
|
|
245
|
+
workspaceId: string;
|
|
241
246
|
exporterId: string;
|
|
242
247
|
isEnabled: boolean;
|
|
243
|
-
eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
|
|
248
|
+
eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished";
|
|
244
249
|
latestJobs: {
|
|
245
|
-
status: "Success" | "InProgress" | "Failed" | "Timeout";
|
|
246
250
|
id: string;
|
|
247
251
|
createdAt: Date;
|
|
252
|
+
status: "Success" | "InProgress" | "Failed" | "Timeout";
|
|
248
253
|
designSystem: {
|
|
249
254
|
id: string;
|
|
250
255
|
meta: {
|
|
@@ -321,8 +326,8 @@ export declare class DataCoreWriteRequests {
|
|
|
321
326
|
documentation?: {
|
|
322
327
|
environment: "Live" | "Preview";
|
|
323
328
|
changes?: {
|
|
324
|
-
pagePersistentIds: string[];
|
|
325
329
|
groupPersistentIds: string[];
|
|
330
|
+
pagePersistentIds: string[];
|
|
326
331
|
} | undefined;
|
|
327
332
|
} | undefined;
|
|
328
333
|
webhookUrl?: string | undefined;
|
|
@@ -390,8 +395,8 @@ export declare class DataCoreWriteRequests {
|
|
|
390
395
|
destinationSnDocs?: {
|
|
391
396
|
environment: "Live" | "Preview";
|
|
392
397
|
changes?: {
|
|
393
|
-
pagePersistentIds: string[];
|
|
394
398
|
groupPersistentIds: string[];
|
|
399
|
+
pagePersistentIds: string[];
|
|
395
400
|
} | undefined;
|
|
396
401
|
} | undefined;
|
|
397
402
|
destinationS3?: {} | undefined;
|
|
@@ -463,15 +468,15 @@ export declare class DataCoreWriteRequests {
|
|
|
463
468
|
updateRemotePipeline(designSystemId: string, pipelineId: string, payload: DTOPipelineUpdateBody): Promise<{
|
|
464
469
|
id: string;
|
|
465
470
|
name: string;
|
|
466
|
-
workspaceId: string;
|
|
467
471
|
designSystemId: string;
|
|
472
|
+
workspaceId: string;
|
|
468
473
|
exporterId: string;
|
|
469
474
|
isEnabled: boolean;
|
|
470
|
-
eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
|
|
475
|
+
eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished";
|
|
471
476
|
latestJobs: {
|
|
472
|
-
status: "Success" | "InProgress" | "Failed" | "Timeout";
|
|
473
477
|
id: string;
|
|
474
478
|
createdAt: Date;
|
|
479
|
+
status: "Success" | "InProgress" | "Failed" | "Timeout";
|
|
475
480
|
designSystem: {
|
|
476
481
|
id: string;
|
|
477
482
|
meta: {
|
|
@@ -548,8 +553,8 @@ export declare class DataCoreWriteRequests {
|
|
|
548
553
|
documentation?: {
|
|
549
554
|
environment: "Live" | "Preview";
|
|
550
555
|
changes?: {
|
|
551
|
-
pagePersistentIds: string[];
|
|
552
556
|
groupPersistentIds: string[];
|
|
557
|
+
pagePersistentIds: string[];
|
|
553
558
|
} | undefined;
|
|
554
559
|
} | undefined;
|
|
555
560
|
webhookUrl?: string | undefined;
|
|
@@ -617,8 +622,8 @@ export declare class DataCoreWriteRequests {
|
|
|
617
622
|
destinationSnDocs?: {
|
|
618
623
|
environment: "Live" | "Preview";
|
|
619
624
|
changes?: {
|
|
620
|
-
pagePersistentIds: string[];
|
|
621
625
|
groupPersistentIds: string[];
|
|
626
|
+
pagePersistentIds: string[];
|
|
622
627
|
} | undefined;
|
|
623
628
|
} | undefined;
|
|
624
629
|
destinationS3?: {} | undefined;
|
|
@@ -701,17 +706,23 @@ export declare class DataCoreWriteRequests {
|
|
|
701
706
|
/** Remote: Deletes an exporter configuration property value */
|
|
702
707
|
deleteRemoteExporterConfigurationPropertyValue(designSystemId: string, exporterId: string, propertyKey: string): Promise<any>;
|
|
703
708
|
/** Remote: Create a new exporter build */
|
|
704
|
-
createExporterBuild(workspaceId: string, designSystemId: string, versionId: string, exporterId: string, destinations: ExporterJobDestination, brandId: string | undefined, themePersistentIds: Array<string> | undefined, exporterConfigurationProperties: DTOExporterPropertyValueMap | undefined): Promise<ExportBuildModel>;
|
|
709
|
+
createExporterBuild(workspaceId: string, designSystemId: string, versionId: string, exporterId: string, destinations: ExporterJobDestination, brandId: string | undefined, themePersistentIds: Array<string> | undefined, exporterConfigurationProperties: DTOExporterPropertyValueMap | undefined, previewMode: boolean | undefined): Promise<ExportBuildModel>;
|
|
705
710
|
/** Remote: Schedules import job */
|
|
706
711
|
scheduleImportJobForFigmaSources(designSystemId: string, versionId: string, sourceIds: Array<string>, dryRun: boolean): Promise<ImportJobRemoteModel>;
|
|
707
712
|
/** Remote: Deletes a remote data source */
|
|
708
713
|
deleteRemoteSource(designSystemId: string, sourceId: string): Promise<void>;
|
|
709
|
-
|
|
710
|
-
|
|
714
|
+
linkSource(designSystemId: string, data: object): Promise<SourceRemoteModel>;
|
|
715
|
+
updateSource(designSystemId: string, sourceId: string, data: object): Promise<SourceRemoteModel>;
|
|
716
|
+
updateStorybookSource(designSystemId: string, versionId: string, data: object): Promise<StorybookUpdate>;
|
|
717
|
+
replaceStorybookStory(designSystemId: string, versionId: string, storyId: string, data: object): Promise<any>;
|
|
711
718
|
writeTokenStudioJSONData(designSystemId: string, versionId: string, data: object): Promise<object>;
|
|
712
719
|
importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", importType: "Upload", payload: any, isTokenTypeSplitEnabled?: boolean): Promise<ImportJobRemoteModel>;
|
|
713
720
|
setKeyValueStorageData(designSystemId: string, kvData: object): Promise<void>;
|
|
714
721
|
createPageRedirect(designSystemId: string, body: DTOPageRedirectCreateBody): Promise<void>;
|
|
715
722
|
updatePageRedirect(designSystemId: string, redirectId: string, body: DTOPageRedirectUpdateBody): Promise<void>;
|
|
716
723
|
deletePageRedirect(designSystemId: string, redirectId: string): Promise<void>;
|
|
724
|
+
createRemoteUntypedData(workspaceId: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
|
|
725
|
+
deleteRemoteAllUntypedData(workspaceId: string): Promise<void>;
|
|
726
|
+
updateRemoteUntypedData(workspaceId: string, id: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
|
|
727
|
+
deleteRemoteUntypedData(workspaceId: string, id: string): Promise<void>;
|
|
717
728
|
}
|
|
@@ -5,7 +5,6 @@ export declare class DesignComponentGroupResolver {
|
|
|
5
5
|
constructor(designComponents: Array<DesignComponent>);
|
|
6
6
|
resolveGroupData(data: Array<DesignComponentGroupRemoteModel>): Array<DesignComponentGroup>;
|
|
7
7
|
private assignSourceDataToGroups;
|
|
8
|
-
private propagateSourceDataToAncestors;
|
|
9
8
|
private recomputePaths;
|
|
10
9
|
private recomputePathsFromRoot;
|
|
11
10
|
private reorderGroupsByRoots;
|
|
@@ -3,17 +3,15 @@ import { DocsEntityGroup } from "../../model/docs/entities/SDKDocsEntityGroup";
|
|
|
3
3
|
import { DocsEntityPage } from "../../model/docs/entities/SDKDocsEntityPage";
|
|
4
4
|
export declare class DocsEntityItemResolver {
|
|
5
5
|
hashedItems: Map<string, {
|
|
6
|
-
type: "Group";
|
|
7
6
|
id: string;
|
|
8
|
-
persistentId: string;
|
|
9
|
-
designSystemVersionId: string;
|
|
10
7
|
createdAt: Date;
|
|
8
|
+
type: "Group";
|
|
9
|
+
designSystemVersionId: string;
|
|
10
|
+
persistentId: string;
|
|
11
11
|
updatedAt: Date;
|
|
12
|
-
shortPersistentId: string;
|
|
13
12
|
title: string;
|
|
14
13
|
isRoot: boolean;
|
|
15
14
|
childrenIds: string[];
|
|
16
|
-
groupBehavior: "Group" | "Tabs";
|
|
17
15
|
configuration: {
|
|
18
16
|
showSidebar: boolean;
|
|
19
17
|
isPrivate: boolean;
|
|
@@ -46,14 +44,16 @@ export declare class DocsEntityItemResolver {
|
|
|
46
44
|
minHeight?: number | null | undefined;
|
|
47
45
|
};
|
|
48
46
|
};
|
|
47
|
+
shortPersistentId: string;
|
|
48
|
+
groupBehavior: "Group" | "Tabs";
|
|
49
49
|
slug?: string | undefined;
|
|
50
|
-
userSlug?: string | undefined;
|
|
51
50
|
approvalState?: {
|
|
52
|
-
persistentId: string;
|
|
53
51
|
designSystemVersionId: string;
|
|
52
|
+
persistentId: string;
|
|
54
53
|
groupPersistentId: string;
|
|
55
54
|
approvalState: "ReadyForReview" | "ChangesRequested" | "Approved";
|
|
56
55
|
} | undefined;
|
|
56
|
+
userSlug?: string | undefined;
|
|
57
57
|
draftState?: {
|
|
58
58
|
changeType: "Created";
|
|
59
59
|
} | {
|
|
@@ -104,14 +104,13 @@ export declare class DocsEntityItemResolver {
|
|
|
104
104
|
lastPublishedAt: Date;
|
|
105
105
|
} | undefined;
|
|
106
106
|
} | {
|
|
107
|
+
id: string;
|
|
108
|
+
createdAt: Date;
|
|
107
109
|
path: string;
|
|
108
110
|
type: "Page";
|
|
109
|
-
id: string;
|
|
110
|
-
persistentId: string;
|
|
111
111
|
designSystemVersionId: string;
|
|
112
|
-
|
|
112
|
+
persistentId: string;
|
|
113
113
|
updatedAt: Date;
|
|
114
|
-
shortPersistentId: string;
|
|
115
114
|
title: string;
|
|
116
115
|
configuration: {
|
|
117
116
|
showSidebar: boolean;
|
|
@@ -145,16 +144,17 @@ export declare class DocsEntityItemResolver {
|
|
|
145
144
|
minHeight?: number | null | undefined;
|
|
146
145
|
};
|
|
147
146
|
};
|
|
147
|
+
shortPersistentId: string;
|
|
148
148
|
slug?: string | undefined;
|
|
149
|
-
userSlug?: string | undefined;
|
|
150
149
|
approvalState?: {
|
|
151
|
-
designSystemVersionId: string;
|
|
152
150
|
createdAt: Date;
|
|
151
|
+
designSystemVersionId: string;
|
|
153
152
|
updatedAt: Date;
|
|
154
153
|
pagePersistentId: string;
|
|
155
154
|
approvalState: "ReadyForReview" | "ChangesRequested" | "Approved";
|
|
156
155
|
updatedByUserId: string;
|
|
157
156
|
} | undefined;
|
|
157
|
+
userSlug?: string | undefined;
|
|
158
158
|
draftState?: {
|
|
159
159
|
changeType: "Created";
|
|
160
160
|
} | {
|