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

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

@@ -68,9 +68,15 @@ export { ElementDataViewColumn, ElementDataViewColumnBasePropertyType, ElementDa
 export { DesignComponent } from "./model/components/SDKDesignComponent";
 export { DesignComponentVariant } from "./model/components/SDKDesignComponentVariant";
 export { DesignComponentPropertyBoolean, DesignComponentPropertyDefinition, DesignComponentPropertyInstanceSwap, DesignComponentPropertyText, DesignComponentPropertyVariant, DesignComponentPropertyType, } from "./model/components/SDKDesignComponentPropertyDefinition";
-export { CodeComponent } from './model/code-components/SDKCodeComponent';
-export { CodeComponentPropertyControlType, CodeComponentPropertyControlDefinition } from './model/code-components/SDKCodeComponentPropertyControlDefinition';
-export { CodeComponentPropertyDefinition } from './model/code-components/SDKCodeComponentPropertyDefinition';
+export { CodeComponent } from "./model/code-components/SDKCodeComponent";
+export { CodeComponentPropertyControlType, CodeComponentPropertyControlDefinition, } from "./model/code-components/SDKCodeComponentPropertyControlDefinition";
+export { CodeComponentPropertyDefinition } from "./model/code-components/SDKCodeComponentPropertyDefinition";
+export { DocsAnalyticsVisitData } from "./model/docs_analytics/SDKDocsAnalyticsVisitData";
+export { DocsAnalyticsPageVisitData } from "./model/docs_analytics/SDKDocsAnalyticsPageVisitData";
+export { DocsAnalyticsTimeFrame } from "./model/docs_analytics/SDKDocsAnalyticsTimeFrame";
+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";
@@ -325,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,26 @@ 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;
+    showDescription?: boolean;
+    showDefaults?: boolean;
 };
 /** Storybook property - Definition model */
 export type DocsBlockStorybookPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockStorybookPropertyOptions;

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

@@ -0,0 +1,6 @@
+import { DTODocumentationAnalyticsTimeFrame } from "@supernova-studio/client";
+export declare class DocsAnalyticsTimeFrame {
+    start: 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/model/projects/SDKProject.d.ts

@@ -0,0 +1,39 @@
+export type SDKProjectRemoteModel = {
+    id: string;
+    name: string;
+    createdAt: string;
+    contextId: string;
+};
+export type SDKProjectTransportModel = {
+    id: string;
+    name: string;
+    createdAt: string;
+    contextId: string;
+};
+export declare class SDKProject {
+    /** Unique identifier of the project */
+    id: string;
+    /** Name of the project */
+    name: string;
+    /** Date and time when the project was created */
+    createdAt: Date;
+    /** Unique identifier of the project context */
+    contextId: string;
+    constructor(model: SDKProjectRemoteModel);
+    /**
+     * Constructs a representation suitable for remote storage.
+     * @returns The remote model of the project.
+     */
+    toRemote(): SDKProjectRemoteModel;
+    /**
+     * Constructs a representation that can be serialized to JSON for transport.
+     * @returns The transport model of the project.
+     */
+    toTransport(): SDKProjectTransportModel;
+    /**
+     * Reconstructs an SDKProject instance from a transport model.
+     * @param model - The transport model to deserialize.
+     * @returns A new SDKProject instance.
+     */
+    static fromTransport(model: SDKProjectTransportModel): SDKProject;
+}

package/build/sdk-typescript/src/model/projects/SDKProjectContext.d.ts

@@ -0,0 +1,47 @@
+export type SDKProjectContextRemoteModel = {
+    id: string;
+    name: string;
+    description?: string;
+    designSystemId: string;
+    dependencies: Array<string>;
+    npmProxyRegistry?: object;
+};
+export type SDKProjectContextTransportModel = {
+    id: string;
+    name: string;
+    description?: string;
+    designSystemId: string;
+    dependencies: Array<string>;
+    npmProxyRegistry?: object;
+};
+export interface SDKProjectContextCreationModel {
+    name: string;
+    description?: string;
+    designSystemId: string;
+    dependencies: Array<string>;
+    npmProxyRegistry?: object;
+}
+/**
+ * Represents a project context containing repository and technology information.
+ */
+export declare class SDKProjectContext {
+    id: string;
+    name: string;
+    description: string | undefined;
+    designSystemId: string;
+    dependencies: Array<string>;
+    npmProxyRegistry: object | undefined;
+    constructor(model: SDKProjectContextRemoteModel);
+    /**
+     * Converts the context to a remote model for storage.
+     */
+    toRemote(): SDKProjectContextRemoteModel;
+    /**
+     * Converts the context to a transport model for serialization.
+     */
+    toTransport(): SDKProjectContextTransportModel;
+    /**
+     * Creates an instance from a transport model.
+     */
+    static fromTransport(model: SDKProjectContextTransportModel): SDKProjectContext;
+}

package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProductFeatures.d.ts

@@ -1,6 +1,6 @@
 export type ProductFeature = {
     [key: string]: {
-        enabled: boolean;
+        enabled?: boolean;
         max?: number;
         errorMessage: string;
         errorReason: string;

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;
+}