@supernova-studio/supernova-sdk-beta 2.2.1 → 2.2.4

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.
Files changed (31) hide show
  1. package/build/sdk-typescript/src/core/SDKSupernova.d.ts +6 -0
  2. package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +2 -1
  3. package/build/sdk-typescript/src/core/areas/SDKAreaDocsAnalytics.d.ts +8 -0
  4. package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +7 -8
  5. package/build/sdk-typescript/src/core/areas/SDKAreaProjects.d.ts +69 -0
  6. package/build/sdk-typescript/src/core/areas/SDKAreaRawData.d.ts +14 -49
  7. package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +35 -0
  8. package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +45 -3
  9. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +80 -1
  10. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +12 -8
  11. package/build/sdk-typescript/src/core/resolvers/SDKDesignComponentGroupResolver.d.ts +0 -1
  12. package/build/sdk-typescript/src/core/resolvers/SDKDocsEntityItemResolver.d.ts +8 -8
  13. package/build/sdk-typescript/src/exports.d.ts +10 -3
  14. package/build/sdk-typescript/src/model/code-components/SDKCodeComponentPropertyControlDefinition.d.ts +1 -4
  15. package/build/sdk-typescript/src/model/code-components/SDKCodeComponentPropertyDefinition.d.ts +0 -2
  16. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +19 -5
  17. package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsComparisonData.d.ts +10 -0
  18. package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsData.d.ts +14 -0
  19. package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsPageComparisonData.d.ts +6 -0
  20. package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsPageVisitData.d.ts +6 -0
  21. package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsTimeFrame.d.ts +6 -0
  22. package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsVisitData.d.ts +9 -0
  23. package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsVisitHeatMapWeek.d.ts +14 -0
  24. package/build/sdk-typescript/src/model/projects/SDKProject.d.ts +39 -0
  25. package/build/sdk-typescript/src/model/projects/SDKProjectContext.d.ts +47 -0
  26. package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProductFeatures.d.ts +1 -1
  27. package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +1 -0
  28. package/build/sdk-typescript/src/utils/RawUtils.d.ts +58 -0
  29. package/build/supernova-sdk-typescript.js +1 -1
  30. package/build/supernova-sdk-typescript.js.map +1 -1
  31. package/package.json +18 -31
@@ -7,11 +7,13 @@ 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";
16
+ import { AreaProjects } from "./areas/SDKAreaProjects";
15
17
  import { AreaRawData } from "./areas/SDKAreaRawData";
16
18
  import { AreaResources } from "./areas/SDKAreaResources";
17
19
  import { AreaStorage } from "./areas/SDKAreaStorage";
@@ -49,6 +51,8 @@ export declare class Supernova {
49
51
  resources: AreaResources;
50
52
  /** Get, create, update, manipulate or delete documentation items */
51
53
  documentation: AreaDocumentation;
54
+ /** Get published documentation items */
55
+ docsAnalytics: AreaDocsAnalytics;
52
56
  /** Get, create, update, manipulate or delete pipelines and automation jobs */
53
57
  automation: AreaAutomation;
54
58
  /** Get, create, update, manipulate or delete users */
@@ -71,6 +75,8 @@ export declare class Supernova {
71
75
  multiplayer: AreaMultiplayer;
72
76
  /** Get access to AI capabilities */
73
77
  ai: AreaAI;
78
+ /** Get access to projects */
79
+ projects: AreaProjects;
74
80
  /** Get access to raw data for local-only restoration of data */
75
81
  raw: AreaRawData;
76
82
  /**
@@ -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
  }
@@ -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
+ }
@@ -7,6 +7,7 @@ import { DocsEntityGroupModel } from "../../model/docs/entities/SDKDocsEntityGro
7
7
  import { DocsEntityPageModel } from "../../model/docs/entities/SDKDocsEntityPage";
8
8
  import { DocsSection } from "../../model/docs/sections/SDKDocsSection";
9
9
  import { DocumentationLegacyGroup } from "../../model/documentation/SDKDocumentationLegacyGroup";
10
+ import { DocumentationLegacyPage } from "../../model/documentation/SDKDocumentationLegacyPage";
10
11
  import { DocsPublishStatus } from "../../model/enums/SDKDocsPublishStatus";
11
12
  import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
12
13
  import { ExportBuild, ExportBuildStatus } from "../../model/exporters/exporter_builds/SDKExportBuild";
@@ -166,17 +167,15 @@ export declare class AreaDocumentation {
166
167
  * @returns nothing
167
168
  */
168
169
  ungroupDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTODeleteDocumentationGroupInput): Promise<void>;
169
- /** Fetches object containing the structure of the docs - documentation pages and groups with metadata but without the page payloads
170
- * Not implemented for now
171
- * @param from - Remote version to fetch from
172
- * @returnsDocumentationLegacy object
173
- */
174
- getDocumentationStructureFromRoot(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacyGroup>;
175
- /** Fetches entire documentation documentation structure, including all pages and groups and their payloads
170
+ /** Fetches entire documentation including content in the legacy format
176
171
  * @param from - Remote version to fetch from
177
172
  * @returns All documentation items
178
173
  */
179
- getDocumentationFromRoot(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacyGroup>;
174
+ getFullDocumentationLegacyRepresentation(from: RemoteWorkspaceVersionIdentifier): Promise<{
175
+ rootGroup: DocumentationLegacyGroup;
176
+ allPages: Array<DocumentationLegacyPage>;
177
+ allGroups: Array<DocumentationLegacyGroup>;
178
+ }>;
180
179
  /** Get ID of the multiplayer room for a given documentation page
181
180
  * @param from - Remote version to fetch from
182
181
  * @param pageId - ID of the documentation page
@@ -0,0 +1,69 @@
1
+ import { SDKProject } from "../../model/projects/SDKProject";
2
+ import { SDKProjectContext, SDKProjectContextCreationModel } from "../../model/projects/SDKProjectContext";
3
+ import { DataCore } from "../data/SDKDataCore";
4
+ /**
5
+ * Manages project-related operations within a workspace using untyped data storage.
6
+ */
7
+ export declare class AreaProjects {
8
+ /** Internal reference to DataCore for data operations */
9
+ private dataCore;
10
+ /** Key under which all projects are stored */
11
+ private readonly PROJECTS_KEY;
12
+ /** Key under which all project contexts are stored */
13
+ private readonly PROJECT_CONTEXTS_KEY;
14
+ constructor(dataCore: DataCore);
15
+ /**
16
+ * Fetches all projects for a given workspace.
17
+ * @param workspaceId - The ID of the workspace.
18
+ * @returns A promise resolving to an array of SDKProject instances.
19
+ */
20
+ getAllProjects(workspaceId: string): Promise<SDKProject[]>;
21
+ /**
22
+ * Creates a new project in the specified workspace.
23
+ * @param workspaceId - The ID of the workspace.
24
+ * @param name - The name of the new project.
25
+ * @returns A promise resolving to the created SDKProject instance.
26
+ */
27
+ createProject(workspaceId: string, name: string, contextId: string): Promise<SDKProject>;
28
+ /**
29
+ * Updates an existing project in the specified workspace.
30
+ * @param workspaceId - The ID of the workspace.
31
+ * @param updatedProject - The updated SDKProject instance.
32
+ * @returns A promise that resolves when the update is complete.
33
+ * @throws Error if the project is not found.
34
+ */
35
+ updateProject(workspaceId: string, updatedProject: SDKProject): Promise<void>;
36
+ /**
37
+ * Deletes a project from the specified workspace.
38
+ * @param workspaceId - The ID of the workspace.
39
+ * @param projectId - The ID of the project to delete.
40
+ * @returns A promise that resolves when the deletion is complete.
41
+ */
42
+ deleteProject(workspaceId: string, projectId: string): Promise<void>;
43
+ /**
44
+ * Retrieves all project contexts in a workspace.
45
+ * @param workspaceId - The ID of the workspace.
46
+ * @returns An array of SDKProjectContext instances.
47
+ */
48
+ getAllProjectContexts(workspaceId: string): Promise<SDKProjectContext[]>;
49
+ /**
50
+ * Creates a new project context.
51
+ * @param workspaceId - The ID of the workspace.
52
+ * @param creationModel - The properties for the new context.
53
+ * @returns The created SDKProjectContext instance.
54
+ */
55
+ createProjectContext(workspaceId: string, creationModel: SDKProjectContextCreationModel): Promise<SDKProjectContext>;
56
+ /**
57
+ * Updates an existing project context.
58
+ * @param workspaceId - The ID of the workspace.
59
+ * @param updatedContext - The updated context instance.
60
+ * @throws Error if the context is not found.
61
+ */
62
+ updateProjectContext(workspaceId: string, updatedContext: SDKProjectContext): Promise<void>;
63
+ /**
64
+ * Deletes a project context.
65
+ * @param workspaceId - The ID of the workspace.
66
+ * @param contextId - The ID of the context to delete.
67
+ */
68
+ deleteProjectContext(workspaceId: string, contextId: string): Promise<void>;
69
+ }
@@ -1,22 +1,19 @@
1
1
  import { DTODesignSystem } from "@supernova-studio/client";
2
- import { Asset } from "../../model/assets/SDKAsset";
3
- import { Brand, BrandRemoteModel } from "../../model/base/SDKBrand";
4
- import { DesignSystem } from "../../model/base/SDKDesignSystem";
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 { ElementDataView, ElementDataViewRemoteModel } from "../../model/elements/SDKElementDataView";
9
- import { ElementProperty, ElementPropertyRemoteModel } from "../../model/elements/SDKElementProperty";
10
- import { ElementPropertyValue, ElementPropertyValueRemoteModel } from "../../model/elements/values/SDKElementPropertyValue";
11
- import { AssetGroup } from "../../model/groups/SDKAssetGroup";
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 { TokenGroup, TokenGroupRemoteModel } from "../../model/groups/SDKTokenGroup";
15
- import { Membership, MembershipRemoteModel } from "../../model/membership/SDKMembership";
16
- import { ResourceFont, ResourceFontModel } from "../../model/resources/SDKResourceFont";
17
- import { Source, SourceRemoteModel } from "../../model/support/SDKSource";
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
- /** Builds components from raw data */
56
- buildComponentsFromRaw(rawData: Array<ComponentRemoteModel>, properties: Array<ElementProperty>, propertyValues: Array<ElementPropertyValue>): Array<Component>;
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,3 +1,4 @@
1
+ import { DTOWorkspaceUntypedDataListResponse, DTOWorkspaceUntypedDataResponse } from "@supernova-studio/client";
1
2
  import { Acl } from "../../model/acl/SDKAcl";
2
3
  import { UserRole } from "../../model/enums/SDKUserRole";
3
4
  import { Membership } from "../../model/membership/SDKMembership";
@@ -234,4 +235,38 @@ export declare class AreaWorkspaces {
234
235
  * @returns Nothing
235
236
  */
236
237
  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>;
237
272
  }
@@ -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, 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, 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";
@@ -262,6 +263,12 @@ export declare class DataCore {
262
263
  restoreDocumentationGroup(designSystemId: string, versionId: string, payload: DTORestoreDocumentationGroupInput): Promise<void>;
263
264
  /** Restore a documentation page */
264
265
  restoreDocumentationPage(designSystemId: string, versionId: string, payload: DTORestoreDocumentationPageInput): Promise<void>;
266
+ /** Fetches entire documentation including content in the legacy format */
267
+ getFullDocumentationLegacyRepresentation(designSystemId: string, versionId: string, workspaceId: string): Promise<{
268
+ rootGroup: DocumentationLegacyGroup;
269
+ allPages: Array<DocumentationLegacyPage>;
270
+ allGroups: Array<DocumentationLegacyGroup>;
271
+ }>;
265
272
  /** Create a custom property in remote */
266
273
  updateTokenProperty(designSystemId: string, versionId: string, propertyIdInVersion: string, model: ElementPropertyUpdateModel): Promise<void>;
267
274
  /** Delete a custom property in remote */
@@ -363,6 +370,7 @@ export declare class DataCore {
363
370
  /** Publish the documentation drafts */
364
371
  documentationPublishDrafts(designSystemId: string, versionId: string, environment: DocumentationEnvironment, changes: DTOPublishDocumentationRequest["changes"]): Promise<ExportBuild>;
365
372
  getDocumentationPageAnchors(designSystemId: string, versionId: string, pageId: string): Promise<Array<DTODocumentationPageAnchor>>;
373
+ docsPageAnalytics(designSystemId: string, versionId: string, timeFrames: Array<DTODocumentationAnalyticsTimeFrame>): Promise<DocsAnalyticsData>;
366
374
  /** Retrieve all asset resources */
367
375
  assetResources(designSystemId: string, versionId: string): Promise<Array<ResourceAsset>>;
368
376
  /** Retrieve all font resources */
@@ -417,7 +425,7 @@ export declare class DataCore {
417
425
  documentationBuilds(workspaceId: string, versionId: string, environment: DocumentationEnvironment, status?: ExportBuildStatus, createdByUserId?: string, limit?: number): Promise<Array<ExportBuild>>;
418
426
  buildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLog>>;
419
427
  /** Create a new exporter build */
420
- createExporterBuild(workspaceId: string, designSystemId: string, versionId: string, exporterId: string, destinations: ExporterJobDestination, brandId: string | undefined, themePersistentIds: Array<string> | undefined, exporterConfigurationProperties: DTOExporterPropertyValueMap | undefined): Promise<ExportBuild>;
428
+ 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>;
421
429
  workspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeatures>;
422
430
  /** Download information about a single workspace and retrieve it resolved */
423
431
  workspace(workspaceId: string): Promise<Workspace>;
@@ -609,6 +617,40 @@ export declare class DataCore {
609
617
  readKeyValueStorageData(designSystemId: string, key: string): Promise<string | object | undefined>;
610
618
  setKeyValueStorageData(designSystemId: string, key: string, value: string | object): Promise<void>;
611
619
  unsetKeyValueStorageData(designSystemId: string, key: string): Promise<void>;
620
+ /**
621
+ * Lists all untyped data for a given workspace.
622
+ * @param workspaceId - The ID of the workspace.
623
+ * @returns A promise that resolves to the list of untyped data.
624
+ */
625
+ listUntypedData(workspaceId: string): Promise<DTOWorkspaceUntypedDataListResponse>;
626
+ /**
627
+ * Creates new untyped data in the specified workspace.
628
+ * @param workspaceId - The ID of the workspace.
629
+ * @param data - The data to create.
630
+ * @returns A promise that resolves to the created untyped data.
631
+ */
632
+ createUntypedData(workspaceId: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
633
+ /**
634
+ * Deletes all untyped data in the specified workspace.
635
+ * @param workspaceId - The ID of the workspace.
636
+ * @returns A promise that resolves when the operation is complete.
637
+ */
638
+ deleteAllUntypedData(workspaceId: string): Promise<void>;
639
+ /**
640
+ * Updates specific untyped data in the specified workspace.
641
+ * @param workspaceId - The ID of the workspace.
642
+ * @param id - The ID of the untyped data to update.
643
+ * @param data - The updated data.
644
+ * @returns A promise that resolves to the updated untyped data.
645
+ */
646
+ updateUntypedData(workspaceId: string, id: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
647
+ /**
648
+ * Deletes specific untyped data in the specified workspace.
649
+ * @param workspaceId - The ID of the workspace.
650
+ * @param id - The ID of the untyped data to delete.
651
+ * @returns A promise that resolves when the operation is complete.
652
+ */
653
+ deleteUntypedData(workspaceId: string, id: string): Promise<void>;
612
654
  getPageRedirects(designSystemId: string): Promise<{
613
655
  path: string;
614
656
  id: string;
@@ -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, 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";
@@ -147,6 +148,11 @@ export declare class DataCoreReadRequests {
147
148
  getRemoteDocumentationUrl(designSystemId: string, versionId: string): Promise<string | null>;
148
149
  /** Remote: Get documentation metadata */
149
150
  getRemoteDocumentationStructure(designSystemId: string, versionId: string): Promise<DocumentationLegacyModel>;
151
+ /** Remote: Get documentation metadata */
152
+ getRemoteDocumentationFullLegacyModel(designSystemId: string, versionId: string): Promise<{
153
+ pages: Array<DocumentationLegacyPageModel>;
154
+ groups: Array<DocumentationLegacyGroupModel>;
155
+ }>;
150
156
  /** Remote: Get documentation elements diff */
151
157
  getRemoteDocumentationElementsDiff(designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<DTODesignElementsDataDiffResponse>;
152
158
  /** Remote: Get documentation metadata */
@@ -158,6 +164,73 @@ export declare class DataCoreReadRequests {
158
164
  /** Remote: Get id of the room for a specific workspace. */
159
165
  getRemoteDocumentationWorkspaceRoomId(workspaceId: string): Promise<string>;
160
166
  getRemoteDocumentationPageAnchors(designSystemId: string, versionId: string, pageId: string): Promise<DTOGetDocumentationPageAnchorsResponse>;
167
+ getRemoteDocsPageAnalytics(designSystemId: string, versionId: string, timeFrames: Array<DTODocumentationAnalyticsTimeFrame>): Promise<{
168
+ analytics: {
169
+ pagePersistentId: string;
170
+ timestamp: Date;
171
+ versionId: string;
172
+ visits: number;
173
+ sessions: number;
174
+ locale?: string | undefined;
175
+ }[];
176
+ perPageAnalytics: {
177
+ pagePersistentId: string;
178
+ timestamp: Date;
179
+ versionId: string;
180
+ visits: number;
181
+ sessions: number;
182
+ locale?: string | undefined;
183
+ }[];
184
+ globalAnalytics: {
185
+ timestamp: Date;
186
+ versionId: string;
187
+ visits: number;
188
+ sessions: number;
189
+ locale?: string | undefined;
190
+ }[];
191
+ pageAnalytics: {
192
+ pagePersistentId: string;
193
+ timestamp: Date;
194
+ versionId: string;
195
+ visits: number;
196
+ sessions: number;
197
+ locale?: string | undefined;
198
+ }[];
199
+ heatMapData: {
200
+ timeFrame: {
201
+ start: Date;
202
+ end?: Date | undefined;
203
+ };
204
+ mon: number[];
205
+ tue: number[];
206
+ wed: number[];
207
+ thu: number[];
208
+ fri: number[];
209
+ sat: number[];
210
+ sun: number[];
211
+ }[];
212
+ comparisonData: {
213
+ timeFrame: {
214
+ start: Date;
215
+ end?: Date | undefined;
216
+ };
217
+ priorVisitCount: number;
218
+ priorSessionCount: number;
219
+ currentVisitCount: number;
220
+ currentSessionCount: number;
221
+ }[];
222
+ pageComparisonData: {
223
+ pagePersistentId: string;
224
+ timeFrame: {
225
+ start: Date;
226
+ end?: Date | undefined;
227
+ };
228
+ priorVisitCount: number;
229
+ priorSessionCount: number;
230
+ currentVisitCount: number;
231
+ currentSessionCount: number;
232
+ }[];
233
+ }>;
161
234
  /** Remote: Get custom blocks for currently installed documentation exporter under specific ds */
162
235
  getRemoteExporterCustomBlocks(designSystemId: string, versionId: string): Promise<Array<ExporterCustomBlockModel>>;
163
236
  /** Remote: Get user configuration of specific installed exporter */
@@ -265,4 +338,10 @@ export declare class DataCoreReadRequests {
265
338
  designSystemId: string;
266
339
  pagePersistentId: string;
267
340
  }[]>;
341
+ /**
342
+ * Fetches all untyped data for a given workspace.
343
+ * @param workspaceId - The ID of the workspace.
344
+ * @returns A promise that resolves to the list of untyped data.
345
+ */
346
+ getRemoteUntypedDataList(workspaceId: string): Promise<DTOWorkspaceUntypedDataListResponse>;
268
347
  }
@@ -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";
@@ -234,8 +234,8 @@ export declare class DataCoreWriteRequests {
234
234
  deleteRemoteWorkspaceIntegration(workspaceId: string, integrationId: string): Promise<WorkspaceIntegrationType>;
235
235
  /** Remote: Create pipeline */
236
236
  createRemotePipeline(workspaceId: string, payload: DTOPipelineCreateBody): Promise<{
237
- id: string;
238
237
  name: string;
238
+ id: string;
239
239
  workspaceId: string;
240
240
  designSystemId: string;
241
241
  exporterId: string;
@@ -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;
@@ -461,8 +461,8 @@ export declare class DataCoreWriteRequests {
461
461
  }>;
462
462
  /** Remote: Update pipeline */
463
463
  updateRemotePipeline(designSystemId: string, pipelineId: string, payload: DTOPipelineUpdateBody): Promise<{
464
- id: string;
465
464
  name: string;
465
+ id: string;
466
466
  workspaceId: string;
467
467
  designSystemId: string;
468
468
  exporterId: string;
@@ -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,7 +701,7 @@ 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 */
@@ -714,4 +714,8 @@ export declare class DataCoreWriteRequests {
714
714
  createPageRedirect(designSystemId: string, body: DTOPageRedirectCreateBody): Promise<void>;
715
715
  updatePageRedirect(designSystemId: string, redirectId: string, body: DTOPageRedirectUpdateBody): Promise<void>;
716
716
  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>;
717
721
  }
@@ -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;
@@ -5,15 +5,13 @@ export declare class DocsEntityItemResolver {
5
5
  hashedItems: Map<string, {
6
6
  type: "Group";
7
7
  id: string;
8
- persistentId: string;
9
8
  designSystemVersionId: string;
9
+ persistentId: string;
10
10
  createdAt: Date;
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
  } | {
@@ -107,11 +107,10 @@ export declare class DocsEntityItemResolver {
107
107
  path: string;
108
108
  type: "Page";
109
109
  id: string;
110
- persistentId: string;
111
110
  designSystemVersionId: string;
111
+ persistentId: string;
112
112
  createdAt: Date;
113
113
  updatedAt: Date;
114
- shortPersistentId: string;
115
114
  title: string;
116
115
  configuration: {
117
116
  showSidebar: boolean;
@@ -145,8 +144,8 @@ 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
150
  designSystemVersionId: string;
152
151
  createdAt: Date;
@@ -155,6 +154,7 @@ export declare class DocsEntityItemResolver {
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
  } | {