@supernova-studio/supernova-sdk-beta 2.2.2 → 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 +2 -5
- package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +2 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaDataSources.d.ts +13 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDocsAnalytics.d.ts +8 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaRawData.d.ts +14 -49
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +0 -35
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +17 -40
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +85 -16
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +16 -12
- package/build/sdk-typescript/src/core/resolvers/SDKDesignComponentGroupResolver.d.ts +0 -1
- package/build/sdk-typescript/src/exports.d.ts +6 -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/properties/SDKDocsBlockStorybookProperty.d.ts +14 -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 +1 -1
- 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/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/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +1 -0
- package/build/sdk-typescript/src/utils/RawUtils.d.ts +58 -0
- 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/core/areas/SDKAreaPublishedDocumentation.d.ts +0 -9
- package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsTimeFrameComparison.d.ts +0 -7
- package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsVisitsDifference.d.ts +0 -10
- package/build/sdk-typescript/src/model/docs_analytics/SDKPublishedDocPageVisitData.d.ts +0 -10
- package/build/sdk-typescript/src/model/projects/SDKProject.d.ts +0 -39
- package/build/sdk-typescript/src/model/projects/SDKProjectContext.d.ts +0 -47
|
@@ -7,13 +7,12 @@ import { AreaCodeComponents } from "./areas/SDKAreaCodeComponents";
|
|
|
7
7
|
import { AreaComponents } from "./areas/SDKAreaComponents";
|
|
8
8
|
import { AreaDataSources } from "./areas/SDKAreaDataSources";
|
|
9
9
|
import { AreaDesignSystems } from "./areas/SDKAreaDesignSystems";
|
|
10
|
+
import { AreaDocsAnalytics } from "./areas/SDKAreaDocsAnalytics";
|
|
10
11
|
import { AreaDocumentation } from "./areas/SDKAreaDocumentation";
|
|
11
12
|
import { AreaIntegrations } from "./areas/SDKAreaIntegrations";
|
|
12
13
|
import { AreaMe } from "./areas/SDKAreaMe";
|
|
13
14
|
import { AreaMultiplayer } from "./areas/SDKAreaMultiplayer";
|
|
14
15
|
import { AreaNetwork } from "./areas/SDKAreaNetwork";
|
|
15
|
-
import { AreaProjects } from "./areas/SDKAreaProjects";
|
|
16
|
-
import { AreaPublishedDocumentation } from "./areas/SDKAreaPublishedDocumentation";
|
|
17
16
|
import { AreaRawData } from "./areas/SDKAreaRawData";
|
|
18
17
|
import { AreaResources } from "./areas/SDKAreaResources";
|
|
19
18
|
import { AreaStorage } from "./areas/SDKAreaStorage";
|
|
@@ -52,7 +51,7 @@ export declare class Supernova {
|
|
|
52
51
|
/** Get, create, update, manipulate or delete documentation items */
|
|
53
52
|
documentation: AreaDocumentation;
|
|
54
53
|
/** Get published documentation items */
|
|
55
|
-
|
|
54
|
+
docsAnalytics: AreaDocsAnalytics;
|
|
56
55
|
/** Get, create, update, manipulate or delete pipelines and automation jobs */
|
|
57
56
|
automation: AreaAutomation;
|
|
58
57
|
/** Get, create, update, manipulate or delete users */
|
|
@@ -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
|
/**
|
|
@@ -117,7 +117,8 @@ export declare class AreaAutomation {
|
|
|
117
117
|
* @param brandId
|
|
118
118
|
* @param themePersistentIds
|
|
119
119
|
* @param exporterConfigurationProperties
|
|
120
|
+
* @param previewMode
|
|
120
121
|
*/
|
|
121
|
-
createExporterBuild(workspaceId: string, designSystemId: string, versionId: string, exporterId: string, destinations: ExporterJobDestination, brandId: string | undefined, themePersistentIds: Array<string> | undefined, exporterConfigurationProperties: DTOExporterPropertyValueMap | undefined): Promise<ExportBuild>;
|
|
122
|
+
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>;
|
|
122
123
|
deletePipeline(workspaceId: string, pipelineId: string): Promise<void>;
|
|
123
124
|
}
|
|
@@ -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
|
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { DocsAnalyticsTimeFrame } from "../../model/docs_analytics/SDKDocsAnalyticsTimeFrame";
|
|
2
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
3
|
+
export declare class AreaDocsAnalytics {
|
|
4
|
+
/** Internal: Engine */
|
|
5
|
+
private dataCore;
|
|
6
|
+
constructor(dataCore: DataCore);
|
|
7
|
+
getDocsPageAnalytics(designSystemId: string, versionId: string, timeFrames: Array<DocsAnalyticsTimeFrame>): Promise<import("../../model/docs_analytics/SDKDocsAnalyticsData").DocsAnalyticsData>;
|
|
8
|
+
}
|
|
@@ -1,22 +1,19 @@
|
|
|
1
1
|
import { DTODesignSystem } from "@supernova-studio/client";
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
import { DesignSystemVersion, DesignSystemVersionRemoteModel } from "../../model/base/SDKDesignSystemVersion";
|
|
6
|
-
import { Component, ComponentRemoteModel } from "../../model/components/SDKComponent";
|
|
2
|
+
import { BrandRemoteModel } from "../../model/base/SDKBrand";
|
|
3
|
+
import { DesignSystemVersionRemoteModel } from "../../model/base/SDKDesignSystemVersion";
|
|
4
|
+
import { ComponentRemoteModel } from "../../model/components/SDKComponent";
|
|
7
5
|
import { DesignComponentRemoteModel } from "../../model/components/SDKDesignComponent";
|
|
8
|
-
import {
|
|
9
|
-
import {
|
|
10
|
-
import {
|
|
11
|
-
import {
|
|
12
|
-
import { ComponentGroup, ComponentGroupRemoteModel } from "../../model/groups/SDKComponentGroup";
|
|
6
|
+
import { ElementDataViewRemoteModel } from "../../model/elements/SDKElementDataView";
|
|
7
|
+
import { ElementPropertyRemoteModel } from "../../model/elements/SDKElementProperty";
|
|
8
|
+
import { ElementPropertyValueRemoteModel } from "../../model/elements/values/SDKElementPropertyValue";
|
|
9
|
+
import { ComponentGroupRemoteModel } from "../../model/groups/SDKComponentGroup";
|
|
13
10
|
import { DesignComponentGroupRemoteModel } from "../../model/groups/SDKDesignComponentGroup";
|
|
14
|
-
import {
|
|
15
|
-
import {
|
|
16
|
-
import {
|
|
17
|
-
import {
|
|
18
|
-
import { Token } from "../../model/tokens/SDKToken";
|
|
11
|
+
import { TokenGroupRemoteModel } from "../../model/groups/SDKTokenGroup";
|
|
12
|
+
import { MembershipRemoteModel } from "../../model/membership/SDKMembership";
|
|
13
|
+
import { ResourceFontModel } from "../../model/resources/SDKResourceFont";
|
|
14
|
+
import { SourceRemoteModel } from "../../model/support/SDKSource";
|
|
19
15
|
import { TokenRemoteModel } from "../../model/tokens/remote/SDKRemoteTokenModel";
|
|
16
|
+
import { UserRemoteModel } from "../../model/users/SDKUser";
|
|
20
17
|
import { DataCore } from "../data/SDKDataCore";
|
|
21
18
|
export declare class AreaRawData {
|
|
22
19
|
/** Internal: Engine */
|
|
@@ -52,38 +49,6 @@ export declare class AreaRawData {
|
|
|
52
49
|
getRawVersionModelData(designSystemId: string): Promise<Array<DesignSystemVersionRemoteModel>>;
|
|
53
50
|
/** Fetches raw brands */
|
|
54
51
|
getRawBrandModelData(designSystemId: string, versionId: string): Promise<Array<BrandRemoteModel>>;
|
|
55
|
-
/**
|
|
56
|
-
|
|
57
|
-
/** Build component groups */
|
|
58
|
-
buildComponentGroupsFromRaw(rawData: Array<ComponentGroupRemoteModel>, components: Array<Component>): Array<ComponentGroup>;
|
|
59
|
-
/** Builds assets from raw data */
|
|
60
|
-
buildAssetsFromRaw(rawData: Array<DesignComponentRemoteModel>, sources: Array<Source>): Array<Asset>;
|
|
61
|
-
/** Build asset groups */
|
|
62
|
-
buildAssetGroupsFromRaw(rawData: Array<DesignComponentGroupRemoteModel>, assets: Array<Asset>): Array<AssetGroup>;
|
|
63
|
-
/** Builds tokens from raw data */
|
|
64
|
-
buildTokensFromRaw(rawData: Array<TokenRemoteModel>, properties: Array<ElementProperty>, propertyValues: Array<ElementPropertyValue>, propertyViews: Array<ElementDataView>, tokenGroups: Array<TokenGroup>, sources: Array<Source>, designSystemId: string, versionId: string): Array<Token>;
|
|
65
|
-
/** Build token groups */
|
|
66
|
-
buildTokenGroupsFromRaw(rawData: Array<TokenGroupRemoteModel>): Array<TokenGroup>;
|
|
67
|
-
/** Builds elements from raw data */
|
|
68
|
-
buildElementsFromRaw(rawData: {
|
|
69
|
-
propertyValues: Array<ElementPropertyValueRemoteModel>;
|
|
70
|
-
propertyViews: Array<ElementDataViewRemoteModel>;
|
|
71
|
-
propertyDefinitions: Array<ElementPropertyRemoteModel>;
|
|
72
|
-
}): {
|
|
73
|
-
propertyValues: Array<ElementPropertyValue>;
|
|
74
|
-
propertyViews: Array<ElementDataView>;
|
|
75
|
-
propertyDefinitions: Array<ElementProperty>;
|
|
76
|
-
};
|
|
77
|
-
/** Build sources */
|
|
78
|
-
buildSourcesFromRaw(rawData: Array<SourceRemoteModel>): Array<Source>;
|
|
79
|
-
/** Build font resources */
|
|
80
|
-
buildFontResourcesFromRaw(rawData: Array<ResourceFontModel>): Array<ResourceFont>;
|
|
81
|
-
/** Builds memberships */
|
|
82
|
-
buildMembershipsFromRaw(rawData: Array<MembershipRemoteModel>): Array<Membership>;
|
|
83
|
-
/** Builds design systems */
|
|
84
|
-
buildDesignSystemsFromRaw(rawData: Array<DTODesignSystem>): Array<DesignSystem>;
|
|
85
|
-
/** Builds versions */
|
|
86
|
-
buildVersionsFromRaw(rawData: Array<DesignSystemVersionRemoteModel>): Array<DesignSystemVersion>;
|
|
87
|
-
/** Builds brands */
|
|
88
|
-
buildBrandsFromRaw(rawData: Array<BrandRemoteModel>): Array<Brand>;
|
|
52
|
+
/** Fetches raw current user */
|
|
53
|
+
getRawCurrentUserModelData(): Promise<UserRemoteModel>;
|
|
89
54
|
}
|
|
@@ -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,
|
|
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,
|
|
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";
|
|
@@ -18,7 +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 {
|
|
21
|
+
import { DocsAnalyticsData } from "../../model/docs_analytics/SDKDocsAnalyticsData";
|
|
22
22
|
import { ElementDataView } from "../../model/elements/SDKElementDataView";
|
|
23
23
|
import { ElementDataViewColumn } from "../../model/elements/SDKElementDataViewColumn";
|
|
24
24
|
import { ElementProperty, ElementPropertyCreationModel, ElementPropertyTargetElementType, ElementPropertyUpdateModel } from "../../model/elements/SDKElementProperty";
|
|
@@ -364,8 +364,7 @@ export declare class DataCore {
|
|
|
364
364
|
/** Publish the documentation drafts */
|
|
365
365
|
documentationPublishDrafts(designSystemId: string, versionId: string, environment: DocumentationEnvironment, changes: DTOPublishDocumentationRequest["changes"]): Promise<ExportBuild>;
|
|
366
366
|
getDocumentationPageAnchors(designSystemId: string, versionId: string, pageId: string): Promise<Array<DTODocumentationPageAnchor>>;
|
|
367
|
-
|
|
368
|
-
docsAnalyticsVisitsDifferences(designSystemId: string, versionId: string, payload: DTODocumentationAnalyticsDiffPayload): Promise<Array<DocsAnalyticsVisitsDifference>>;
|
|
367
|
+
docsPageAnalytics(designSystemId: string, versionId: string, timeFrames: Array<DTODocumentationAnalyticsTimeFrame>): Promise<DocsAnalyticsData>;
|
|
369
368
|
/** Retrieve all asset resources */
|
|
370
369
|
assetResources(designSystemId: string, versionId: string): Promise<Array<ResourceAsset>>;
|
|
371
370
|
/** Retrieve all font resources */
|
|
@@ -420,7 +419,7 @@ export declare class DataCore {
|
|
|
420
419
|
documentationBuilds(workspaceId: string, versionId: string, environment: DocumentationEnvironment, status?: ExportBuildStatus, createdByUserId?: string, limit?: number): Promise<Array<ExportBuild>>;
|
|
421
420
|
buildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLog>>;
|
|
422
421
|
/** Create a new exporter build */
|
|
423
|
-
createExporterBuild(workspaceId: string, designSystemId: string, versionId: string, exporterId: string, destinations: ExporterJobDestination, brandId: string | undefined, themePersistentIds: Array<string> | undefined, exporterConfigurationProperties: DTOExporterPropertyValueMap | undefined): Promise<ExportBuild>;
|
|
422
|
+
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>;
|
|
424
423
|
workspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeatures>;
|
|
425
424
|
/** Download information about a single workspace and retrieve it resolved */
|
|
426
425
|
workspace(workspaceId: string): Promise<Workspace>;
|
|
@@ -567,6 +566,7 @@ export declare class DataCore {
|
|
|
567
566
|
designSystemContacts(designSystemId: string): Promise<DesignSystemContactList>;
|
|
568
567
|
getFigmaNodeStructures(designSystemId: string): Promise<Array<FigmaStructure>>;
|
|
569
568
|
getFigmaNodeStructureDetail(designSystemId: string, figmaStructureId: string): Promise<FigmaStructureDetail>;
|
|
569
|
+
getStorybookEntries(designSystemId: string, versionId: string): Promise<DTOStorybookEntry[]>;
|
|
570
570
|
deleteFigmaSource(designSystemId: string, sourceId: string): Promise<void>;
|
|
571
571
|
linkFigmaSource(designSystemId: string, brandId: string, url: string, options: {
|
|
572
572
|
scopes: {
|
|
@@ -589,6 +589,17 @@ export declare class DataCore {
|
|
|
589
589
|
autoImport?: SourceRemoteModelCloud["autoImportMode"];
|
|
590
590
|
themeId?: string | null;
|
|
591
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
|
+
}>;
|
|
592
603
|
versions(designSystemId: string): Promise<Array<DesignSystemVersion>>;
|
|
593
604
|
version(designSystemId: string, versionId: string): Promise<DesignSystemVersion>;
|
|
594
605
|
versionCreationJob(designSystemId: string, jobId: string): Promise<DesignSystemVersionCreationJob>;
|
|
@@ -612,40 +623,6 @@ export declare class DataCore {
|
|
|
612
623
|
readKeyValueStorageData(designSystemId: string, key: string): Promise<string | object | undefined>;
|
|
613
624
|
setKeyValueStorageData(designSystemId: string, key: string, value: string | object): Promise<void>;
|
|
614
625
|
unsetKeyValueStorageData(designSystemId: string, key: string): Promise<void>;
|
|
615
|
-
/**
|
|
616
|
-
* Lists all untyped data for a given workspace.
|
|
617
|
-
* @param workspaceId - The ID of the workspace.
|
|
618
|
-
* @returns A promise that resolves to the list of untyped data.
|
|
619
|
-
*/
|
|
620
|
-
listUntypedData(workspaceId: string): Promise<DTOWorkspaceUntypedDataListResponse>;
|
|
621
|
-
/**
|
|
622
|
-
* Creates new untyped data in the specified workspace.
|
|
623
|
-
* @param workspaceId - The ID of the workspace.
|
|
624
|
-
* @param data - The data to create.
|
|
625
|
-
* @returns A promise that resolves to the created untyped data.
|
|
626
|
-
*/
|
|
627
|
-
createUntypedData(workspaceId: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
|
|
628
|
-
/**
|
|
629
|
-
* Deletes all untyped data in the specified workspace.
|
|
630
|
-
* @param workspaceId - The ID of the workspace.
|
|
631
|
-
* @returns A promise that resolves when the operation is complete.
|
|
632
|
-
*/
|
|
633
|
-
deleteAllUntypedData(workspaceId: string): Promise<void>;
|
|
634
|
-
/**
|
|
635
|
-
* Updates specific untyped data in the specified workspace.
|
|
636
|
-
* @param workspaceId - The ID of the workspace.
|
|
637
|
-
* @param id - The ID of the untyped data to update.
|
|
638
|
-
* @param data - The updated data.
|
|
639
|
-
* @returns A promise that resolves to the updated untyped data.
|
|
640
|
-
*/
|
|
641
|
-
updateUntypedData(workspaceId: string, id: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
|
|
642
|
-
/**
|
|
643
|
-
* Deletes specific untyped data in the specified workspace.
|
|
644
|
-
* @param workspaceId - The ID of the workspace.
|
|
645
|
-
* @param id - The ID of the untyped data to delete.
|
|
646
|
-
* @returns A promise that resolves when the operation is complete.
|
|
647
|
-
*/
|
|
648
|
-
deleteUntypedData(workspaceId: string, id: string): Promise<void>;
|
|
649
626
|
getPageRedirects(designSystemId: string): Promise<{
|
|
650
627
|
path: string;
|
|
651
628
|
id: string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DTODesignElementsDataDiffResponse, DTODesignSystem, DTODesignSystemContactsResponse, DTODesignSystemMemberListResponse, DTODesignSystemVersionStats,
|
|
1
|
+
import { DTODesignElementsDataDiffResponse, DTODesignSystem, DTODesignSystemContactsResponse, DTODesignSystemMemberListResponse, DTODesignSystemVersionStats, DTODocumentationAnalyticsTimeFrame, DTODocumentationLinkPreviewRequest, DTOFigmaNode, DTOFigmaNodeV2, DTOGetDocumentationPageAnchorsResponse, DTOPipeline, DTOTokenCollection } from "@supernova-studio/client";
|
|
2
2
|
import { AclRemoteModel } from "../../../model/acl/SDKAcl";
|
|
3
3
|
import { BootstrapDataRemoteModel } from "../../../model/base/SDKBootstrapData";
|
|
4
4
|
import { BrandRemoteModel } from "../../../model/base/SDKBrand";
|
|
@@ -143,6 +143,23 @@ export declare class DataCoreReadRequests {
|
|
|
143
143
|
/** Remote: Get information about design system's members */
|
|
144
144
|
getRemoteDesignSystemMemberList(designSystemId: string): Promise<DTODesignSystemMemberListResponse>;
|
|
145
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
|
+
}[]>;
|
|
146
163
|
/** Remote: Get design system documentation url */
|
|
147
164
|
getRemoteDocumentationUrl(designSystemId: string, versionId: string): Promise<string | null>;
|
|
148
165
|
/** Remote: Get documentation metadata */
|
|
@@ -158,15 +175,73 @@ export declare class DataCoreReadRequests {
|
|
|
158
175
|
/** Remote: Get id of the room for a specific workspace. */
|
|
159
176
|
getRemoteDocumentationWorkspaceRoomId(workspaceId: string): Promise<string>;
|
|
160
177
|
getRemoteDocumentationPageAnchors(designSystemId: string, versionId: string, pageId: string): Promise<DTOGetDocumentationPageAnchorsResponse>;
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
178
|
+
getRemoteDocsPageAnalytics(designSystemId: string, versionId: string, timeFrames: Array<DTODocumentationAnalyticsTimeFrame>): Promise<{
|
|
179
|
+
analytics: {
|
|
180
|
+
pagePersistentId: string;
|
|
181
|
+
timestamp: Date;
|
|
182
|
+
versionId: string;
|
|
183
|
+
visits: number;
|
|
184
|
+
sessions: number;
|
|
185
|
+
locale?: string | undefined;
|
|
186
|
+
}[];
|
|
187
|
+
perPageAnalytics: {
|
|
188
|
+
pagePersistentId: string;
|
|
189
|
+
timestamp: Date;
|
|
190
|
+
versionId: string;
|
|
191
|
+
visits: number;
|
|
192
|
+
sessions: number;
|
|
193
|
+
locale?: string | undefined;
|
|
194
|
+
}[];
|
|
195
|
+
globalAnalytics: {
|
|
196
|
+
timestamp: Date;
|
|
197
|
+
versionId: string;
|
|
198
|
+
visits: number;
|
|
199
|
+
sessions: number;
|
|
200
|
+
locale?: string | undefined;
|
|
201
|
+
}[];
|
|
202
|
+
pageAnalytics: {
|
|
203
|
+
pagePersistentId: string;
|
|
204
|
+
timestamp: Date;
|
|
205
|
+
versionId: string;
|
|
206
|
+
visits: number;
|
|
207
|
+
sessions: number;
|
|
208
|
+
locale?: string | undefined;
|
|
209
|
+
}[];
|
|
210
|
+
heatMapData: {
|
|
211
|
+
timeFrame: {
|
|
212
|
+
start: Date;
|
|
213
|
+
end?: Date | undefined;
|
|
214
|
+
};
|
|
215
|
+
mon: number[];
|
|
216
|
+
tue: number[];
|
|
217
|
+
wed: number[];
|
|
218
|
+
thu: number[];
|
|
219
|
+
fri: number[];
|
|
220
|
+
sat: number[];
|
|
221
|
+
sun: number[];
|
|
222
|
+
}[];
|
|
223
|
+
comparisonData: {
|
|
224
|
+
timeFrame: {
|
|
225
|
+
start: Date;
|
|
226
|
+
end?: Date | undefined;
|
|
227
|
+
};
|
|
228
|
+
priorVisitCount: number;
|
|
229
|
+
priorSessionCount: number;
|
|
230
|
+
currentVisitCount: number;
|
|
231
|
+
currentSessionCount: number;
|
|
232
|
+
}[];
|
|
233
|
+
pageComparisonData: {
|
|
234
|
+
pagePersistentId: string;
|
|
235
|
+
timeFrame: {
|
|
236
|
+
start: Date;
|
|
237
|
+
end?: Date | undefined;
|
|
238
|
+
};
|
|
239
|
+
priorVisitCount: number;
|
|
240
|
+
priorSessionCount: number;
|
|
241
|
+
currentVisitCount: number;
|
|
242
|
+
currentSessionCount: number;
|
|
243
|
+
}[];
|
|
244
|
+
}>;
|
|
170
245
|
/** Remote: Get custom blocks for currently installed documentation exporter under specific ds */
|
|
171
246
|
getRemoteExporterCustomBlocks(designSystemId: string, versionId: string): Promise<Array<ExporterCustomBlockModel>>;
|
|
172
247
|
/** Remote: Get user configuration of specific installed exporter */
|
|
@@ -274,10 +349,4 @@ export declare class DataCoreReadRequests {
|
|
|
274
349
|
designSystemId: string;
|
|
275
350
|
pagePersistentId: string;
|
|
276
351
|
}[]>;
|
|
277
|
-
/**
|
|
278
|
-
* Fetches all untyped data for a given workspace.
|
|
279
|
-
* @param workspaceId - The ID of the workspace.
|
|
280
|
-
* @returns A promise that resolves to the list of untyped data.
|
|
281
|
-
*/
|
|
282
|
-
getRemoteUntypedDataList(workspaceId: string): Promise<DTOWorkspaceUntypedDataListResponse>;
|
|
283
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";
|
|
@@ -321,8 +321,8 @@ export declare class DataCoreWriteRequests {
|
|
|
321
321
|
documentation?: {
|
|
322
322
|
environment: "Live" | "Preview";
|
|
323
323
|
changes?: {
|
|
324
|
-
pagePersistentIds: string[];
|
|
325
324
|
groupPersistentIds: string[];
|
|
325
|
+
pagePersistentIds: string[];
|
|
326
326
|
} | undefined;
|
|
327
327
|
} | undefined;
|
|
328
328
|
webhookUrl?: string | undefined;
|
|
@@ -390,8 +390,8 @@ export declare class DataCoreWriteRequests {
|
|
|
390
390
|
destinationSnDocs?: {
|
|
391
391
|
environment: "Live" | "Preview";
|
|
392
392
|
changes?: {
|
|
393
|
-
pagePersistentIds: string[];
|
|
394
393
|
groupPersistentIds: string[];
|
|
394
|
+
pagePersistentIds: string[];
|
|
395
395
|
} | undefined;
|
|
396
396
|
} | undefined;
|
|
397
397
|
destinationS3?: {} | undefined;
|
|
@@ -548,8 +548,8 @@ export declare class DataCoreWriteRequests {
|
|
|
548
548
|
documentation?: {
|
|
549
549
|
environment: "Live" | "Preview";
|
|
550
550
|
changes?: {
|
|
551
|
-
pagePersistentIds: string[];
|
|
552
551
|
groupPersistentIds: string[];
|
|
552
|
+
pagePersistentIds: string[];
|
|
553
553
|
} | undefined;
|
|
554
554
|
} | undefined;
|
|
555
555
|
webhookUrl?: string | undefined;
|
|
@@ -617,8 +617,8 @@ export declare class DataCoreWriteRequests {
|
|
|
617
617
|
destinationSnDocs?: {
|
|
618
618
|
environment: "Live" | "Preview";
|
|
619
619
|
changes?: {
|
|
620
|
-
pagePersistentIds: string[];
|
|
621
620
|
groupPersistentIds: string[];
|
|
621
|
+
pagePersistentIds: string[];
|
|
622
622
|
} | undefined;
|
|
623
623
|
} | undefined;
|
|
624
624
|
destinationS3?: {} | undefined;
|
|
@@ -701,21 +701,25 @@ export declare class DataCoreWriteRequests {
|
|
|
701
701
|
/** Remote: Deletes an exporter configuration property value */
|
|
702
702
|
deleteRemoteExporterConfigurationPropertyValue(designSystemId: string, exporterId: string, propertyKey: string): Promise<any>;
|
|
703
703
|
/** 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>;
|
|
704
|
+
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
705
|
/** Remote: Schedules import job */
|
|
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,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;
|
|
@@ -71,10 +71,12 @@ export { DesignComponentPropertyBoolean, DesignComponentPropertyDefinition, Desi
|
|
|
71
71
|
export { CodeComponent } from "./model/code-components/SDKCodeComponent";
|
|
72
72
|
export { CodeComponentPropertyControlType, CodeComponentPropertyControlDefinition, } from "./model/code-components/SDKCodeComponentPropertyControlDefinition";
|
|
73
73
|
export { CodeComponentPropertyDefinition } from "./model/code-components/SDKCodeComponentPropertyDefinition";
|
|
74
|
-
export {
|
|
75
|
-
export {
|
|
74
|
+
export { DocsAnalyticsVisitData } from "./model/docs_analytics/SDKDocsAnalyticsVisitData";
|
|
75
|
+
export { DocsAnalyticsPageVisitData } from "./model/docs_analytics/SDKDocsAnalyticsPageVisitData";
|
|
76
76
|
export { DocsAnalyticsTimeFrame } from "./model/docs_analytics/SDKDocsAnalyticsTimeFrame";
|
|
77
|
-
export {
|
|
77
|
+
export { DocsAnalyticsComparisonData } from "./model/docs_analytics/SDKDocsAnalyticsComparisonData";
|
|
78
|
+
export { DocsAnalyticsPageComparisonData } from "./model/docs_analytics/SDKDocsAnalyticsPageComparisonData";
|
|
79
|
+
export { DocsAnalyticsVisitHeatMapWeek } from "./model/docs_analytics/SDKDocsAnalyticsVisitHeatMapWeek";
|
|
78
80
|
export { DocsBlockBehavior } from "./model/docs/blocks/definition/SDKDocsBlockBehavior";
|
|
79
81
|
export { DocsBlockDefinition } from "./model/docs/blocks/definition/SDKDocsBlockDefinition";
|
|
80
82
|
export { DocsBlockItemDefinition } from "./model/docs/blocks/definition/SDKDocsBlockItemDefinition";
|
|
@@ -329,3 +331,4 @@ export type { DesignComponentGroupRemoteModel } from "./model/groups/SDKDesignCo
|
|
|
329
331
|
export type { ElementPropertyRemoteModel } from "./model/elements/SDKElementProperty";
|
|
330
332
|
export type { ElementPropertyValueRemoteModel } from "./model/elements/values/SDKElementPropertyValue";
|
|
331
333
|
export type { ElementDataViewRemoteModel } from "./model/elements/SDKElementDataView";
|
|
334
|
+
export { RawUtils } from "./utils/RawUtils";
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { DTOCodeComponentProperty } from "@supernova-studio/client";
|
|
2
1
|
export declare enum CodeComponentPropertyControlType {
|
|
3
2
|
Boolean = "Boolean",
|
|
4
3
|
Function = "Function",
|
|
@@ -8,10 +7,8 @@ export declare enum CodeComponentPropertyControlType {
|
|
|
8
7
|
String = "String",
|
|
9
8
|
Unknown = "Unknown"
|
|
10
9
|
}
|
|
11
|
-
type CodeComponentPropertyControlDefinitionRemoteType =
|
|
10
|
+
type CodeComponentPropertyControlDefinitionRemoteType = string;
|
|
12
11
|
export declare class CodeComponentPropertyControlDefinition {
|
|
13
|
-
isArray: boolean;
|
|
14
|
-
type: CodeComponentPropertyControlType;
|
|
15
12
|
constructor(model: CodeComponentPropertyControlDefinitionRemoteType);
|
|
16
13
|
}
|
|
17
14
|
export {};
|
package/build/sdk-typescript/src/model/code-components/SDKCodeComponentPropertyDefinition.d.ts
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
import { DTOCodeComponentProperty } from "@supernova-studio/client";
|
|
2
|
-
import { CodeComponentPropertyControlDefinition } from "./SDKCodeComponentPropertyControlDefinition";
|
|
3
2
|
type CodeComponentPropertyDefinitionRemoteType = DTOCodeComponentProperty;
|
|
4
3
|
export declare class CodeComponentPropertyDefinition {
|
|
5
|
-
control: CodeComponentPropertyControlDefinition;
|
|
6
4
|
defaultValue: string | null;
|
|
7
5
|
name: string;
|
|
8
6
|
required: boolean;
|
package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts
CHANGED
|
@@ -12,12 +12,21 @@ export type DocsBlockStorybookPropertyOptions = {
|
|
|
12
12
|
/** Defines how the storybook should be rendered in the editor */
|
|
13
13
|
renderLayoutAs?: "Playground" | "Iframe";
|
|
14
14
|
};
|
|
15
|
+
export type DocsBlockStorybookValue = Array<{
|
|
16
|
+
entityId?: string;
|
|
17
|
+
embed?: {
|
|
18
|
+
inputUrl: string;
|
|
19
|
+
embedUrl: string;
|
|
20
|
+
};
|
|
21
|
+
entityMeta?: {
|
|
22
|
+
caption?: string;
|
|
23
|
+
height?: number;
|
|
24
|
+
hiddenProps?: Array<string>;
|
|
25
|
+
propValues?: Record<string, unknown>;
|
|
26
|
+
};
|
|
27
|
+
}> | undefined;
|
|
15
28
|
/** Storybook property - Data */
|
|
16
|
-
export type DocsBlockStorybookPropertyData = DocsBlockPropertyData<
|
|
17
|
-
alt?: string;
|
|
18
|
-
caption?: string;
|
|
19
|
-
height?: number;
|
|
20
|
-
embedUrl?: string;
|
|
29
|
+
export type DocsBlockStorybookPropertyData = DocsBlockPropertyData<DocsBlockStorybookValue> & {
|
|
21
30
|
showCode?: boolean;
|
|
22
31
|
showFooter?: boolean;
|
|
23
32
|
showProperties?: boolean;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { DTOPublishedDocAnalyticsComparisonData } from "@supernova-studio/client";
|
|
2
|
+
import { DocsAnalyticsTimeFrame } from "./SDKDocsAnalyticsTimeFrame";
|
|
3
|
+
export declare class DocsAnalyticsComparisonData {
|
|
4
|
+
timeFrame: DocsAnalyticsTimeFrame;
|
|
5
|
+
currentVisitCount: number;
|
|
6
|
+
priorVisitCount: number;
|
|
7
|
+
currentSessionCount: number;
|
|
8
|
+
priorSessionCount: number;
|
|
9
|
+
constructor(model: DTOPublishedDocAnalyticsComparisonData);
|
|
10
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { DTODocumentationPageAnalyticsResponse } from "@supernova-studio/client";
|
|
2
|
+
import { DocsAnalyticsComparisonData } from "./SDKDocsAnalyticsComparisonData";
|
|
3
|
+
import { DocsAnalyticsPageComparisonData } from "./SDKDocsAnalyticsPageComparisonData";
|
|
4
|
+
import { DocsAnalyticsPageVisitData } from "./SDKDocsAnalyticsPageVisitData";
|
|
5
|
+
import { DocsAnalyticsVisitData } from "./SDKDocsAnalyticsVisitData";
|
|
6
|
+
import { DocsAnalyticsVisitHeatMapWeek } from "./SDKDocsAnalyticsVisitHeatMapWeek";
|
|
7
|
+
export declare class DocsAnalyticsData {
|
|
8
|
+
globalAnalytics: DocsAnalyticsVisitData[];
|
|
9
|
+
pageAnalytics: DocsAnalyticsPageVisitData[];
|
|
10
|
+
heatMapData: DocsAnalyticsVisitHeatMapWeek[];
|
|
11
|
+
comparisonData: DocsAnalyticsComparisonData[];
|
|
12
|
+
pageComparisonData: DocsAnalyticsPageComparisonData[];
|
|
13
|
+
constructor(model: DTODocumentationPageAnalyticsResponse);
|
|
14
|
+
}
|