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

package/build/sdk-typescript/src/core/SDKSupernova.d.ts

@@ -7,13 +7,13 @@ import { AreaCodeComponents } from "./areas/SDKAreaCodeComponents";
 import { AreaComponents } from "./areas/SDKAreaComponents";
 import { AreaDataSources } from "./areas/SDKAreaDataSources";
 import { AreaDesignSystems } from "./areas/SDKAreaDesignSystems";
+import { AreaDocsAnalytics } from "./areas/SDKAreaDocsAnalytics";
 import { AreaDocumentation } from "./areas/SDKAreaDocumentation";
 import { AreaIntegrations } from "./areas/SDKAreaIntegrations";
 import { AreaMe } from "./areas/SDKAreaMe";
 import { AreaMultiplayer } from "./areas/SDKAreaMultiplayer";
 import { AreaNetwork } from "./areas/SDKAreaNetwork";
 import { AreaProjects } from "./areas/SDKAreaProjects";
-import { AreaPublishedDocumentation } from "./areas/SDKAreaPublishedDocumentation";
 import { AreaRawData } from "./areas/SDKAreaRawData";
 import { AreaResources } from "./areas/SDKAreaResources";
 import { AreaStorage } from "./areas/SDKAreaStorage";
@@ -52,7 +52,7 @@ export declare class Supernova {
     /** Get, create, update, manipulate or delete documentation items */
     documentation: AreaDocumentation;
     /** Get published documentation items */
-    publishedDocumentation: AreaPublishedDocumentation;
+    docsAnalytics: AreaDocsAnalytics;
     /** Get, create, update, manipulate or delete pipelines and automation jobs */
     automation: AreaAutomation;
     /** Get, create, update, manipulate or delete users */

package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts

@@ -117,7 +117,8 @@ export declare class AreaAutomation {
      * @param brandId
      * @param themePersistentIds
      * @param exporterConfigurationProperties
+     * @param previewMode
      */
-    createExporterBuild(workspaceId: string, designSystemId: string, versionId: string, exporterId: string, destinations: ExporterJobDestination, brandId: string | undefined, themePersistentIds: Array<string> | undefined, exporterConfigurationProperties: DTOExporterPropertyValueMap | undefined): Promise<ExportBuild>;
+    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>;
     deletePipeline(workspaceId: string, pipelineId: string): Promise<void>;
 }

package/build/sdk-typescript/src/core/areas/SDKAreaDocsAnalytics.d.ts

@@ -0,0 +1,8 @@
+import { DocsAnalyticsTimeFrame } from "../../model/docs_analytics/SDKDocsAnalyticsTimeFrame";
+import { DataCore } from "../data/SDKDataCore";
+export declare class AreaDocsAnalytics {
+    /** Internal: Engine */
+    private dataCore;
+    constructor(dataCore: DataCore);
+    getDocsPageAnalytics(designSystemId: string, versionId: string, timeFrames: Array<DocsAnalyticsTimeFrame>): Promise<import("../../model/docs_analytics/SDKDocsAnalyticsData").DocsAnalyticsData>;
+}

package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts

@@ -7,6 +7,7 @@ import { DocsEntityGroupModel } from "../../model/docs/entities/SDKDocsEntityGro
 import { DocsEntityPageModel } from "../../model/docs/entities/SDKDocsEntityPage";
 import { DocsSection } from "../../model/docs/sections/SDKDocsSection";
 import { DocumentationLegacyGroup } from "../../model/documentation/SDKDocumentationLegacyGroup";
+import { DocumentationLegacyPage } from "../../model/documentation/SDKDocumentationLegacyPage";
 import { DocsPublishStatus } from "../../model/enums/SDKDocsPublishStatus";
 import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
 import { ExportBuild, ExportBuildStatus } from "../../model/exporters/exporter_builds/SDKExportBuild";
@@ -166,17 +167,15 @@ export declare class AreaDocumentation {
      * @returns nothing
      */
     ungroupDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTODeleteDocumentationGroupInput): Promise<void>;
-    /** Fetches object containing the structure of the docs - documentation pages and groups with metadata but without the page payloads
-     * Not implemented for now
-     * @param from - Remote version to fetch from
-     * @returnsDocumentationLegacy object
-     */
-    getDocumentationStructureFromRoot(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacyGroup>;
-    /** Fetches entire documentation documentation structure, including all pages and groups and their payloads
+    /** Fetches entire documentation including content in the legacy format
      * @param from - Remote version to fetch from
      * @returns All documentation items
      */
-    getDocumentationFromRoot(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacyGroup>;
+    getFullDocumentationLegacyRepresentation(from: RemoteWorkspaceVersionIdentifier): Promise<{
+        rootGroup: DocumentationLegacyGroup;
+        allPages: Array<DocumentationLegacyPage>;
+        allGroups: Array<DocumentationLegacyGroup>;
+    }>;
     /** Get ID of the multiplayer room for a given documentation page
      * @param from - Remote version to fetch from
      * @param pageId - ID of the documentation page

package/build/sdk-typescript/src/core/areas/SDKAreaRawData.d.ts

@@ -1,22 +1,19 @@
 import { DTODesignSystem } from "@supernova-studio/client";
-import { Asset } from "../../model/assets/SDKAsset";
-import { Brand, BrandRemoteModel } from "../../model/base/SDKBrand";
-import { DesignSystem } from "../../model/base/SDKDesignSystem";
-import { DesignSystemVersion, DesignSystemVersionRemoteModel } from "../../model/base/SDKDesignSystemVersion";
-import { Component, ComponentRemoteModel } from "../../model/components/SDKComponent";
+import { BrandRemoteModel } from "../../model/base/SDKBrand";
+import { DesignSystemVersionRemoteModel } from "../../model/base/SDKDesignSystemVersion";
+import { ComponentRemoteModel } from "../../model/components/SDKComponent";
 import { DesignComponentRemoteModel } from "../../model/components/SDKDesignComponent";
-import { ElementDataView, ElementDataViewRemoteModel } from "../../model/elements/SDKElementDataView";
-import { ElementProperty, ElementPropertyRemoteModel } from "../../model/elements/SDKElementProperty";
-import { ElementPropertyValue, ElementPropertyValueRemoteModel } from "../../model/elements/values/SDKElementPropertyValue";
-import { AssetGroup } from "../../model/groups/SDKAssetGroup";
-import { ComponentGroup, ComponentGroupRemoteModel } from "../../model/groups/SDKComponentGroup";
+import { ElementDataViewRemoteModel } from "../../model/elements/SDKElementDataView";
+import { ElementPropertyRemoteModel } from "../../model/elements/SDKElementProperty";
+import { ElementPropertyValueRemoteModel } from "../../model/elements/values/SDKElementPropertyValue";
+import { ComponentGroupRemoteModel } from "../../model/groups/SDKComponentGroup";
 import { DesignComponentGroupRemoteModel } from "../../model/groups/SDKDesignComponentGroup";
-import { TokenGroup, TokenGroupRemoteModel } from "../../model/groups/SDKTokenGroup";
-import { Membership, MembershipRemoteModel } from "../../model/membership/SDKMembership";
-import { ResourceFont, ResourceFontModel } from "../../model/resources/SDKResourceFont";
-import { Source, SourceRemoteModel } from "../../model/support/SDKSource";
-import { Token } from "../../model/tokens/SDKToken";
+import { TokenGroupRemoteModel } from "../../model/groups/SDKTokenGroup";
+import { MembershipRemoteModel } from "../../model/membership/SDKMembership";
+import { ResourceFontModel } from "../../model/resources/SDKResourceFont";
+import { SourceRemoteModel } from "../../model/support/SDKSource";
 import { TokenRemoteModel } from "../../model/tokens/remote/SDKRemoteTokenModel";
+import { UserRemoteModel } from "../../model/users/SDKUser";
 import { DataCore } from "../data/SDKDataCore";
 export declare class AreaRawData {
     /** Internal: Engine */
@@ -52,38 +49,6 @@ export declare class AreaRawData {
     getRawVersionModelData(designSystemId: string): Promise<Array<DesignSystemVersionRemoteModel>>;
     /** Fetches raw brands */
     getRawBrandModelData(designSystemId: string, versionId: string): Promise<Array<BrandRemoteModel>>;
-    /** Builds components from raw data */
-    buildComponentsFromRaw(rawData: Array<ComponentRemoteModel>, properties: Array<ElementProperty>, propertyValues: Array<ElementPropertyValue>): Array<Component>;
-    /** Build component groups */
-    buildComponentGroupsFromRaw(rawData: Array<ComponentGroupRemoteModel>, components: Array<Component>): Array<ComponentGroup>;
-    /** Builds assets from raw data */
-    buildAssetsFromRaw(rawData: Array<DesignComponentRemoteModel>, sources: Array<Source>): Array<Asset>;
-    /** Build asset groups */
-    buildAssetGroupsFromRaw(rawData: Array<DesignComponentGroupRemoteModel>, assets: Array<Asset>): Array<AssetGroup>;
-    /** Builds tokens from raw data */
-    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>;
-    /** Build token groups */
-    buildTokenGroupsFromRaw(rawData: Array<TokenGroupRemoteModel>): Array<TokenGroup>;
-    /** Builds elements from raw data */
-    buildElementsFromRaw(rawData: {
-        propertyValues: Array<ElementPropertyValueRemoteModel>;
-        propertyViews: Array<ElementDataViewRemoteModel>;
-        propertyDefinitions: Array<ElementPropertyRemoteModel>;
-    }): {
-        propertyValues: Array<ElementPropertyValue>;
-        propertyViews: Array<ElementDataView>;
-        propertyDefinitions: Array<ElementProperty>;
-    };
-    /** Build sources */
-    buildSourcesFromRaw(rawData: Array<SourceRemoteModel>): Array<Source>;
-    /** Build font resources */
-    buildFontResourcesFromRaw(rawData: Array<ResourceFontModel>): Array<ResourceFont>;
-    /** Builds memberships */
-    buildMembershipsFromRaw(rawData: Array<MembershipRemoteModel>): Array<Membership>;
-    /** Builds design systems */
-    buildDesignSystemsFromRaw(rawData: Array<DTODesignSystem>): Array<DesignSystem>;
-    /** Builds versions */
-    buildVersionsFromRaw(rawData: Array<DesignSystemVersionRemoteModel>): Array<DesignSystemVersion>;
-    /** Builds brands */
-    buildBrandsFromRaw(rawData: Array<BrandRemoteModel>): Array<Brand>;
+    /** Fetches raw current user */
+    getRawCurrentUserModelData(): Promise<UserRemoteModel>;
 }

package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts

@@ -1,6 +1,6 @@
-import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignElementsDataDiffResponse, DTODocumentationAnalyticsDiffPayload, 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";
+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";
 import { DesignSystemInvite, DesignSystemInviteUpdate, DesignSystemMemberUpdate, DesignSystemPendingMemberInvite, DesignSystemUserInvitation } from "@supernova-studio/model";
-import { DesignSystemAccessMode, DocsAnalyticsVisitsDifference, DocsBlockDefinition, ExportBuildStatus, ExporterJobDestination, ResourceFont, TokenThemeOverrideTranserObject, UserRole } from "../../exports";
+import { DesignSystemAccessMode, DocsBlockDefinition, DocumentationLegacyGroup, DocumentationLegacyPage, ExportBuildStatus, ExporterJobDestination, ResourceFont, TokenThemeOverrideTranserObject, UserRole } from "../../exports";
 import { Acl } from "../../model/acl/SDKAcl";
 import { Asset } from "../../model/assets/SDKAsset";
 import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
@@ -18,7 +18,7 @@ import { Component } from "../../model/components/SDKComponent";
 import { DesignComponent } from "../../model/components/SDKDesignComponent";
 import { DocsEntityGroupModel } from "../../model/docs/entities/SDKDocsEntityGroup";
 import { DocsEntityPageModel } from "../../model/docs/entities/SDKDocsEntityPage";
-import { PublishedDocPageVisitData } from "../../model/docs_analytics/SDKPublishedDocPageVisitData";
+import { DocsAnalyticsData } from "../../model/docs_analytics/SDKDocsAnalyticsData";
 import { ElementDataView } from "../../model/elements/SDKElementDataView";
 import { ElementDataViewColumn } from "../../model/elements/SDKElementDataViewColumn";
 import { ElementProperty, ElementPropertyCreationModel, ElementPropertyTargetElementType, ElementPropertyUpdateModel } from "../../model/elements/SDKElementProperty";
@@ -263,6 +263,12 @@ export declare class DataCore {
     restoreDocumentationGroup(designSystemId: string, versionId: string, payload: DTORestoreDocumentationGroupInput): Promise<void>;
     /** Restore a documentation page   */
     restoreDocumentationPage(designSystemId: string, versionId: string, payload: DTORestoreDocumentationPageInput): Promise<void>;
+    /** Fetches entire documentation including content in the legacy format */
+    getFullDocumentationLegacyRepresentation(designSystemId: string, versionId: string, workspaceId: string): Promise<{
+        rootGroup: DocumentationLegacyGroup;
+        allPages: Array<DocumentationLegacyPage>;
+        allGroups: Array<DocumentationLegacyGroup>;
+    }>;
     /** Create a custom property in remote */
     updateTokenProperty(designSystemId: string, versionId: string, propertyIdInVersion: string, model: ElementPropertyUpdateModel): Promise<void>;
     /** Delete a custom property in remote */
@@ -364,8 +370,7 @@ export declare class DataCore {
     /** Publish the documentation drafts */
     documentationPublishDrafts(designSystemId: string, versionId: string, environment: DocumentationEnvironment, changes: DTOPublishDocumentationRequest["changes"]): Promise<ExportBuild>;
     getDocumentationPageAnchors(designSystemId: string, versionId: string, pageId: string): Promise<Array<DTODocumentationPageAnchor>>;
-    publishedDocumentationPageVisitData(designSystemId: string, versionId: string, startDate: Date): Promise<Array<PublishedDocPageVisitData>>;
-    docsAnalyticsVisitsDifferences(designSystemId: string, versionId: string, payload: DTODocumentationAnalyticsDiffPayload): Promise<Array<DocsAnalyticsVisitsDifference>>;
+    docsPageAnalytics(designSystemId: string, versionId: string, timeFrames: Array<DTODocumentationAnalyticsTimeFrame>): Promise<DocsAnalyticsData>;
     /** Retrieve all asset resources */
     assetResources(designSystemId: string, versionId: string): Promise<Array<ResourceAsset>>;
     /** Retrieve all font resources */
@@ -420,7 +425,7 @@ export declare class DataCore {
     documentationBuilds(workspaceId: string, versionId: string, environment: DocumentationEnvironment, status?: ExportBuildStatus, createdByUserId?: string, limit?: number): Promise<Array<ExportBuild>>;
     buildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLog>>;
     /** Create a new exporter build */
-    createExporterBuild(workspaceId: string, designSystemId: string, versionId: string, exporterId: string, destinations: ExporterJobDestination, brandId: string | undefined, themePersistentIds: Array<string> | undefined, exporterConfigurationProperties: DTOExporterPropertyValueMap | undefined): Promise<ExportBuild>;
+    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>;
     workspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeatures>;
     /** Download information about a single workspace and retrieve it resolved */
     workspace(workspaceId: string): Promise<Workspace>;

package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts

@@ -1,4 +1,5 @@
-import { DTODesignElementsDataDiffResponse, DTODesignSystem, DTODesignSystemContactsResponse, DTODesignSystemMemberListResponse, DTODesignSystemVersionStats, DTODocumentationAnalyticsDiffPayload, DTODocumentationLinkPreviewRequest, DTOFigmaNode, DTOFigmaNodeV2, DTOGetDocumentationPageAnchorsResponse, DTOPipeline, DTOPublishedDocPageVisitData, DTOTokenCollection, DTOWorkspaceUntypedDataListResponse } from "@supernova-studio/client";
+import { DTODesignElementsDataDiffResponse, DTODesignSystem, DTODesignSystemContactsResponse, DTODesignSystemMemberListResponse, DTODesignSystemVersionStats, DTODocumentationAnalyticsTimeFrame, DTODocumentationLinkPreviewRequest, DTOFigmaNode, DTOFigmaNodeV2, DTOGetDocumentationPageAnchorsResponse, DTOPipeline, DTOTokenCollection, DTOWorkspaceUntypedDataListResponse } from "@supernova-studio/client";
+import { DocumentationLegacyGroupModel } from "../../../exports";
 import { AclRemoteModel } from "../../../model/acl/SDKAcl";
 import { BootstrapDataRemoteModel } from "../../../model/base/SDKBootstrapData";
 import { BrandRemoteModel } from "../../../model/base/SDKBrand";
@@ -147,6 +148,11 @@ export declare class DataCoreReadRequests {
     getRemoteDocumentationUrl(designSystemId: string, versionId: string): Promise<string | null>;
     /** Remote: Get documentation metadata */
     getRemoteDocumentationStructure(designSystemId: string, versionId: string): Promise<DocumentationLegacyModel>;
+    /** Remote: Get documentation metadata */
+    getRemoteDocumentationFullLegacyModel(designSystemId: string, versionId: string): Promise<{
+        pages: Array<DocumentationLegacyPageModel>;
+        groups: Array<DocumentationLegacyGroupModel>;
+    }>;
     /** Remote: Get documentation elements diff */
     getRemoteDocumentationElementsDiff(designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<DTODesignElementsDataDiffResponse>;
     /** Remote: Get documentation metadata */
@@ -158,15 +164,73 @@ export declare class DataCoreReadRequests {
     /** Remote: Get id of the room for a specific workspace. */
     getRemoteDocumentationWorkspaceRoomId(workspaceId: string): Promise<string>;
     getRemoteDocumentationPageAnchors(designSystemId: string, versionId: string, pageId: string): Promise<DTOGetDocumentationPageAnchorsResponse>;
-    getRemotePublishedDocumentationPageVisitData(designSystemId: string, versionId: string, startDate: Date): Promise<Array<DTOPublishedDocPageVisitData>>;
-    getRemoteDocsAnalyticsVisitsDifferences(designSystemId: string, versionId: string, payload: DTODocumentationAnalyticsDiffPayload): Promise<{
-        startDate: Date;
-        endDate: Date;
-        currentVisitCount: number;
-        currentSessionCount: number;
-        priorVisitCount: number;
-        priorSessionCount: number;
-    }[]>;
+    getRemoteDocsPageAnalytics(designSystemId: string, versionId: string, timeFrames: Array<DTODocumentationAnalyticsTimeFrame>): Promise<{
+        analytics: {
+            pagePersistentId: string;
+            timestamp: Date;
+            versionId: string;
+            visits: number;
+            sessions: number;
+            locale?: string | undefined;
+        }[];
+        perPageAnalytics: {
+            pagePersistentId: string;
+            timestamp: Date;
+            versionId: string;
+            visits: number;
+            sessions: number;
+            locale?: string | undefined;
+        }[];
+        globalAnalytics: {
+            timestamp: Date;
+            versionId: string;
+            visits: number;
+            sessions: number;
+            locale?: string | undefined;
+        }[];
+        pageAnalytics: {
+            pagePersistentId: string;
+            timestamp: Date;
+            versionId: string;
+            visits: number;
+            sessions: number;
+            locale?: string | undefined;
+        }[];
+        heatMapData: {
+            timeFrame: {
+                start: Date;
+                end?: Date | undefined;
+            };
+            mon: number[];
+            tue: number[];
+            wed: number[];
+            thu: number[];
+            fri: number[];
+            sat: number[];
+            sun: number[];
+        }[];
+        comparisonData: {
+            timeFrame: {
+                start: Date;
+                end?: Date | undefined;
+            };
+            priorVisitCount: number;
+            priorSessionCount: number;
+            currentVisitCount: number;
+            currentSessionCount: number;
+        }[];
+        pageComparisonData: {
+            pagePersistentId: string;
+            timeFrame: {
+                start: Date;
+                end?: Date | undefined;
+            };
+            priorVisitCount: number;
+            priorSessionCount: number;
+            currentVisitCount: number;
+            currentSessionCount: number;
+        }[];
+    }>;
     /** Remote: Get custom blocks for currently installed documentation exporter under specific ds */
     getRemoteExporterCustomBlocks(designSystemId: string, versionId: string): Promise<Array<ExporterCustomBlockModel>>;
     /** Remote: Get user configuration of specific installed exporter */

package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts

@@ -321,8 +321,8 @@ export declare class DataCoreWriteRequests {
                 documentation?: {
                     environment: "Live" | "Preview";
                     changes?: {
-                        pagePersistentIds: string[];
                         groupPersistentIds: string[];
+                        pagePersistentIds: string[];
                     } | undefined;
                 } | undefined;
                 webhookUrl?: string | undefined;
@@ -390,8 +390,8 @@ export declare class DataCoreWriteRequests {
         destinationSnDocs?: {
             environment: "Live" | "Preview";
             changes?: {
-                pagePersistentIds: string[];
                 groupPersistentIds: string[];
+                pagePersistentIds: string[];
             } | undefined;
         } | undefined;
         destinationS3?: {} | undefined;
@@ -548,8 +548,8 @@ export declare class DataCoreWriteRequests {
                 documentation?: {
                     environment: "Live" | "Preview";
                     changes?: {
-                        pagePersistentIds: string[];
                         groupPersistentIds: string[];
+                        pagePersistentIds: string[];
                     } | undefined;
                 } | undefined;
                 webhookUrl?: string | undefined;
@@ -617,8 +617,8 @@ export declare class DataCoreWriteRequests {
         destinationSnDocs?: {
             environment: "Live" | "Preview";
             changes?: {
-                pagePersistentIds: string[];
                 groupPersistentIds: string[];
+                pagePersistentIds: string[];
             } | undefined;
         } | undefined;
         destinationS3?: {} | undefined;
@@ -701,7 +701,7 @@ export declare class DataCoreWriteRequests {
     /** Remote: Deletes an exporter configuration property value */
     deleteRemoteExporterConfigurationPropertyValue(designSystemId: string, exporterId: string, propertyKey: string): Promise<any>;
     /** Remote: Create a new exporter build */
-    createExporterBuild(workspaceId: string, designSystemId: string, versionId: string, exporterId: string, destinations: ExporterJobDestination, brandId: string | undefined, themePersistentIds: Array<string> | undefined, exporterConfigurationProperties: DTOExporterPropertyValueMap | undefined): Promise<ExportBuildModel>;
+    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>;
     /** Remote: Schedules import job */
     scheduleImportJobForFigmaSources(designSystemId: string, versionId: string, sourceIds: Array<string>, dryRun: boolean): Promise<ImportJobRemoteModel>;
     /** Remote: Deletes a remote data source */

package/build/sdk-typescript/src/core/resolvers/SDKDesignComponentGroupResolver.d.ts

@@ -5,7 +5,6 @@ export declare class DesignComponentGroupResolver {
     constructor(designComponents: Array<DesignComponent>);
     resolveGroupData(data: Array<DesignComponentGroupRemoteModel>): Array<DesignComponentGroup>;
     private assignSourceDataToGroups;
-    private propagateSourceDataToAncestors;
     private recomputePaths;
     private recomputePathsFromRoot;
     private reorderGroupsByRoots;

package/build/sdk-typescript/src/exports.d.ts

@@ -71,10 +71,12 @@ export { DesignComponentPropertyBoolean, DesignComponentPropertyDefinition, Desi
 export { CodeComponent } from "./model/code-components/SDKCodeComponent";
 export { CodeComponentPropertyControlType, CodeComponentPropertyControlDefinition, } from "./model/code-components/SDKCodeComponentPropertyControlDefinition";
 export { CodeComponentPropertyDefinition } from "./model/code-components/SDKCodeComponentPropertyDefinition";
-export { PublishedDocPageVisitData } from "./model/docs_analytics/SDKPublishedDocPageVisitData";
-export { DocsAnalyticsVisitsDifference } from "./model/docs_analytics/SDKDocsAnalyticsVisitsDifference";
+export { DocsAnalyticsVisitData } from "./model/docs_analytics/SDKDocsAnalyticsVisitData";
+export { DocsAnalyticsPageVisitData } from "./model/docs_analytics/SDKDocsAnalyticsPageVisitData";
 export { DocsAnalyticsTimeFrame } from "./model/docs_analytics/SDKDocsAnalyticsTimeFrame";
-export { DocsAnalyticsTimeFrameComparison } from "./model/docs_analytics/SDKDocsAnalyticsTimeFrameComparison";
+export { DocsAnalyticsComparisonData } from "./model/docs_analytics/SDKDocsAnalyticsComparisonData";
+export { DocsAnalyticsPageComparisonData } from "./model/docs_analytics/SDKDocsAnalyticsPageComparisonData";
+export { DocsAnalyticsVisitHeatMapWeek } from "./model/docs_analytics/SDKDocsAnalyticsVisitHeatMapWeek";
 export { DocsBlockBehavior } from "./model/docs/blocks/definition/SDKDocsBlockBehavior";
 export { DocsBlockDefinition } from "./model/docs/blocks/definition/SDKDocsBlockDefinition";
 export { DocsBlockItemDefinition } from "./model/docs/blocks/definition/SDKDocsBlockItemDefinition";
@@ -329,3 +331,4 @@ export type { DesignComponentGroupRemoteModel } from "./model/groups/SDKDesignCo
 export type { ElementPropertyRemoteModel } from "./model/elements/SDKElementProperty";
 export type { ElementPropertyValueRemoteModel } from "./model/elements/values/SDKElementPropertyValue";
 export type { ElementDataViewRemoteModel } from "./model/elements/SDKElementDataView";
+export { RawUtils } from "./utils/RawUtils";

package/build/sdk-typescript/src/model/code-components/SDKCodeComponentPropertyControlDefinition.d.ts

@@ -1,4 +1,3 @@
-import { DTOCodeComponentProperty } from "@supernova-studio/client";
 export declare enum CodeComponentPropertyControlType {
     Boolean = "Boolean",
     Function = "Function",
@@ -8,10 +7,8 @@ export declare enum CodeComponentPropertyControlType {
     String = "String",
     Unknown = "Unknown"
 }
-type CodeComponentPropertyControlDefinitionRemoteType = DTOCodeComponentProperty['control'];
+type CodeComponentPropertyControlDefinitionRemoteType = string;
 export declare class CodeComponentPropertyControlDefinition {
-    isArray: boolean;
-    type: CodeComponentPropertyControlType;
     constructor(model: CodeComponentPropertyControlDefinitionRemoteType);
 }
 export {};

package/build/sdk-typescript/src/model/code-components/SDKCodeComponentPropertyDefinition.d.ts

@@ -1,8 +1,6 @@
 import { DTOCodeComponentProperty } from "@supernova-studio/client";
-import { CodeComponentPropertyControlDefinition } from "./SDKCodeComponentPropertyControlDefinition";
 type CodeComponentPropertyDefinitionRemoteType = DTOCodeComponentProperty;
 export declare class CodeComponentPropertyDefinition {
-    control: CodeComponentPropertyControlDefinition;
     defaultValue: string | null;
     name: string;
     required: boolean;

package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts

@@ -12,12 +12,21 @@ export type DocsBlockStorybookPropertyOptions = {
     /** Defines how the storybook should be rendered in the editor */
     renderLayoutAs?: "Playground" | "Iframe";
 };
+export type DocsBlockStorybookValue = Array<{
+    entityId?: string;
+    embed?: {
+        inputUrl: string;
+        embedUrl: string;
+    };
+    entityMeta?: {
+        caption?: string;
+        height?: number;
+        hiddenProps?: Array<string>;
+        propValues?: Record<string, unknown>;
+    };
+}> | undefined;
 /** Storybook property - Data */
-export type DocsBlockStorybookPropertyData = DocsBlockPropertyData<string | undefined> & {
-    alt?: string;
-    caption?: string;
-    height?: number;
-    embedUrl?: string;
+export type DocsBlockStorybookPropertyData = DocsBlockPropertyData<DocsBlockStorybookValue> & {
     showCode?: boolean;
     showFooter?: boolean;
     showProperties?: boolean;

package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsComparisonData.d.ts

@@ -0,0 +1,10 @@
+import { DTOPublishedDocAnalyticsComparisonData } from "@supernova-studio/client";
+import { DocsAnalyticsTimeFrame } from "./SDKDocsAnalyticsTimeFrame";
+export declare class DocsAnalyticsComparisonData {
+    timeFrame: DocsAnalyticsTimeFrame;
+    currentVisitCount: number;
+    priorVisitCount: number;
+    currentSessionCount: number;
+    priorSessionCount: number;
+    constructor(model: DTOPublishedDocAnalyticsComparisonData);
+}

package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsData.d.ts

@@ -0,0 +1,14 @@
+import { DTODocumentationPageAnalyticsResponse } from "@supernova-studio/client";
+import { DocsAnalyticsComparisonData } from "./SDKDocsAnalyticsComparisonData";
+import { DocsAnalyticsPageComparisonData } from "./SDKDocsAnalyticsPageComparisonData";
+import { DocsAnalyticsPageVisitData } from "./SDKDocsAnalyticsPageVisitData";
+import { DocsAnalyticsVisitData } from "./SDKDocsAnalyticsVisitData";
+import { DocsAnalyticsVisitHeatMapWeek } from "./SDKDocsAnalyticsVisitHeatMapWeek";
+export declare class DocsAnalyticsData {
+    globalAnalytics: DocsAnalyticsVisitData[];
+    pageAnalytics: DocsAnalyticsPageVisitData[];
+    heatMapData: DocsAnalyticsVisitHeatMapWeek[];
+    comparisonData: DocsAnalyticsComparisonData[];
+    pageComparisonData: DocsAnalyticsPageComparisonData[];
+    constructor(model: DTODocumentationPageAnalyticsResponse);
+}

package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsPageComparisonData.d.ts

@@ -0,0 +1,6 @@
+import { DTOPublishedDocPageAnalyticsComparisonData } from "@supernova-studio/client";
+import { DocsAnalyticsComparisonData } from "./SDKDocsAnalyticsComparisonData";
+export declare class DocsAnalyticsPageComparisonData extends DocsAnalyticsComparisonData {
+    pagePersistentId: string;
+    constructor(model: DTOPublishedDocPageAnalyticsComparisonData);
+}

package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsPageVisitData.d.ts

@@ -0,0 +1,6 @@
+import { DTOPublishedDocPageVisitData } from "@supernova-studio/client";
+import { DocsAnalyticsVisitData } from "./SDKDocsAnalyticsVisitData";
+export declare class DocsAnalyticsPageVisitData extends DocsAnalyticsVisitData {
+    pagePersistentId: string;
+    constructor(model: DTOPublishedDocPageVisitData);
+}

package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsTimeFrame.d.ts

@@ -1,6 +1,6 @@
 import { DTODocumentationAnalyticsTimeFrame } from "@supernova-studio/client";
 export declare class DocsAnalyticsTimeFrame {
     start: Date;
-    end: Date;
+    end: Date | null;
     constructor(model: DTODocumentationAnalyticsTimeFrame);
 }

package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsVisitData.d.ts

@@ -0,0 +1,9 @@
+import { DTOPublishedDocVisitData } from "@supernova-studio/client";
+export declare class DocsAnalyticsVisitData {
+    versionId: string;
+    locale: string | null;
+    timestamp: Date;
+    visits: number;
+    sessions: number;
+    constructor(model: DTOPublishedDocVisitData);
+}

package/build/sdk-typescript/src/model/docs_analytics/SDKDocsAnalyticsVisitHeatMapWeek.d.ts

@@ -0,0 +1,14 @@
+import { DTOPublishedDocVisitHeatMapWeek } from "@supernova-studio/client";
+import { DocsAnalyticsTimeFrame } from "./SDKDocsAnalyticsTimeFrame";
+export declare class DocsAnalyticsVisitHeatMapWeek {
+    timeFrame: DocsAnalyticsTimeFrame;
+    /** Visits per 2 hour intervals, starting at 0 (eg. 0, 2, 4, ...) */
+    mon: number[];
+    tue: number[];
+    wed: number[];
+    thu: number[];
+    fri: number[];
+    sat: number[];
+    sun: number[];
+    constructor(model: DTOPublishedDocVisitHeatMapWeek);
+}

package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts

@@ -76,6 +76,7 @@ export declare class DocsBlockBuilder {
     /** Create and item variant to render the item with default layout (all properties will be stacked into a single column) */
     defaultVariantUsingDefaultLayout(options: {
         properties: Array<DocsBlockItemPropertyAnyDefinition>;
+        name?: string;
         image?: string;
         description?: string;
         maxColumns?: number;

package/build/sdk-typescript/src/utils/RawUtils.d.ts

@@ -0,0 +1,58 @@
+import { DTODesignSystem } from "@supernova-studio/client";
+import { Asset } from "../model/assets/SDKAsset";
+import { Brand, BrandRemoteModel } from "../model/base/SDKBrand";
+import { DesignSystem } from "../model/base/SDKDesignSystem";
+import { DesignSystemVersion, DesignSystemVersionRemoteModel } from "../model/base/SDKDesignSystemVersion";
+import { Component, ComponentRemoteModel } from "../model/components/SDKComponent";
+import { DesignComponentRemoteModel } from "../model/components/SDKDesignComponent";
+import { ElementDataView, ElementDataViewRemoteModel } from "../model/elements/SDKElementDataView";
+import { ElementProperty, ElementPropertyRemoteModel } from "../model/elements/SDKElementProperty";
+import { ElementPropertyValue, ElementPropertyValueRemoteModel } from "../model/elements/values/SDKElementPropertyValue";
+import { AssetGroup } from "../model/groups/SDKAssetGroup";
+import { ComponentGroup, ComponentGroupRemoteModel } from "../model/groups/SDKComponentGroup";
+import { DesignComponentGroupRemoteModel } from "../model/groups/SDKDesignComponentGroup";
+import { TokenGroup, TokenGroupRemoteModel } from "../model/groups/SDKTokenGroup";
+import { Membership, MembershipRemoteModel } from "../model/membership/SDKMembership";
+import { ResourceFont, ResourceFontModel } from "../model/resources/SDKResourceFont";
+import { Source, SourceRemoteModel } from "../model/support/SDKSource";
+import { Token } from "../model/tokens/SDKToken";
+import { TokenRemoteModel } from "../model/tokens/remote/SDKRemoteTokenModel";
+import { User, UserRemoteModel } from "../model/users/SDKUser";
+export declare class RawUtils {
+    /** Builds components from raw data */
+    static buildComponentsFromRaw(rawData: Array<ComponentRemoteModel>, properties: Array<ElementProperty>, propertyValues: Array<ElementPropertyValue>): Array<Component>;
+    /** Build component groups */
+    static buildComponentGroupsFromRaw(rawData: Array<ComponentGroupRemoteModel>, components: Array<Component>): Array<ComponentGroup>;
+    /** Builds assets from raw data */
+    static buildAssetsFromRaw(rawData: Array<DesignComponentRemoteModel>, sources: Array<Source>): Array<Asset>;
+    /** Build asset groups */
+    static buildAssetGroupsFromRaw(rawData: Array<DesignComponentGroupRemoteModel>, assets: Array<Asset>): Array<AssetGroup>;
+    /** Builds tokens from raw data */
+    static 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>;
+    /** Build token groups */
+    static buildTokenGroupsFromRaw(rawData: Array<TokenGroupRemoteModel>): Array<TokenGroup>;
+    /** Builds elements from raw data */
+    static buildElementsFromRaw(rawData: {
+        propertyValues: Array<ElementPropertyValueRemoteModel>;
+        propertyViews: Array<ElementDataViewRemoteModel>;
+        propertyDefinitions: Array<ElementPropertyRemoteModel>;
+    }): {
+        propertyValues: Array<ElementPropertyValue>;
+        propertyViews: Array<ElementDataView>;
+        propertyDefinitions: Array<ElementProperty>;
+    };
+    /** Build sources */
+    static buildSourcesFromRaw(rawData: Array<SourceRemoteModel>): Array<Source>;
+    /** Build font resources */
+    static buildFontResourcesFromRaw(rawData: Array<ResourceFontModel>): Array<ResourceFont>;
+    /** Builds memberships */
+    static buildMembershipsFromRaw(rawData: Array<MembershipRemoteModel>): Array<Membership>;
+    /** Builds design systems */
+    static buildDesignSystemsFromRaw(rawData: Array<DTODesignSystem>): Array<DesignSystem>;
+    /** Builds versions */
+    static buildVersionsFromRaw(rawData: Array<DesignSystemVersionRemoteModel>): Array<DesignSystemVersion>;
+    /** Builds brands */
+    static buildBrandsFromRaw(rawData: Array<BrandRemoteModel>): Array<Brand>;
+    /** Builds user */
+    static buildUserFromRaw(rawData: UserRemoteModel): User;
+}