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

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/model/enums/SDKSourceType.d.ts

@@ -1,5 +1,6 @@
 export declare enum SourceType {
     figma = "Figma",
     tokenStudio = "TokenStudio",
-    figmaVariablesPlugin = "FigmaVariablesPlugin"
+    figmaVariablesPlugin = "FigmaVariablesPlugin",
+    storybook = "Storybook"
 }

package/build/sdk-typescript/src/model/support/SDKSource.d.ts

@@ -5,7 +5,8 @@ declare enum SourceRemoteType {
     figma = "Figma",
     tokenStudio = "TokenStudio",
     figmaVariablesPlugin = "FigmaVariablesPlugin",
-    upload = "Upload"
+    upload = "Upload",
+    storybook = "Storybook"
 }
 export type SourceRemoteModel = {
     type: SourceRemoteType;
@@ -20,6 +21,7 @@ export type SourceRemoteModel = {
     cloud?: SourceRemoteModelCloud;
     tokenStudio?: SourceRemoteModelTokensStudio;
     figmaVariablesPlugin?: SourceRemoteModelFigmaVariablesPlugin;
+    storybook?: SourceRemoteModelStorybook;
     scope: SourceScope;
 };
 export type SourceScope = {
@@ -115,6 +117,17 @@ export type SourceRemoteModelFigmaVariablesPlugin = {
     lastImportMetadata?: Record<string, any>;
     isTokenTypeSplitEnabled: boolean;
 };
+export type SourceRemoteModelStorybook = {
+    userUrl: string;
+    indexUrl: string;
+    isFailed: boolean;
+    docsCount: number;
+    storiesCount: number;
+    lastImportedAt?: string;
+    lastImportedSuccessfully?: string;
+    description?: string;
+    isUsingVpn?: boolean;
+};
 export type SourceModelTokenStudio = Omit<SourceRemoteModelTokensStudio, "lastUpdatesCheckedAt" | "lastImportedAt"> & {
     lastUpdatesCheckedAt?: Date;
     lastImportedAt?: Date;
@@ -126,6 +139,11 @@ export type SourceModelCloud = Omit<SourceRemoteModelCloud, "lastUpdatesCheckedA
 export type SourceModelFigmaVariablesPlugin = Omit<SourceRemoteModelFigmaVariablesPlugin, "lastImportedAt"> & {
     lastImportedAt?: Date;
 };
+export type SourceModelStorybook = Omit<SourceRemoteModelStorybook, "lastImportedAt" | "lastImportedSuccessfully"> & {
+    lastImportedAt?: Date;
+    lastImportedSuccessfully?: Date;
+    displayName?: string;
+};
 export type SourceTransportModel = Pick<Source, "type" | "id" | "fileName" | "brandId" | "themeId" | "scope"> & {
     cloud?: SourceRemoteModelCloud | null;
 };
@@ -138,6 +156,7 @@ export declare class Source {
     cloud: SourceModelCloud | null;
     tokenStudio?: SourceModelTokenStudio | null;
     figmaVariablesPlugin?: SourceModelFigmaVariablesPlugin | null;
+    storybook?: SourceModelStorybook | null;
     scope: SourceScope;
     get lastImportedAt(): Date | null;
     get hasError(): boolean;

package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts

@@ -3,7 +3,7 @@ export type TokenOriginModel = {
     id?: string;
     name?: string;
     sourceId?: string;
-    sourceType?: SourceType;
+    sourceType?: Exclude<SourceType, "Storybook">;
     referenceOriginId?: string;
     referencePersistentId?: string;
     referenceResolutionFailed?: boolean;
@@ -15,7 +15,7 @@ export declare class TokenOrigin {
     id: string | null;
     name: string | null;
     sourceId: string | null;
-    sourceType?: SourceType | null;
+    sourceType?: Exclude<SourceType, "Storybook"> | null;
     referenceOriginId?: string | null;
     referencePersistentId?: string | null;
     /**

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