@supernova-studio/supernova-sdk-beta 1.6.29 → 1.6.31

package/build/sdk-typescript/src/model/resources/SDKResource.d.ts

@@ -0,0 +1,26 @@
+export declare enum ResourceType {
+    asset = "Asset",
+    font = "Font"
+}
+export type ResourceModel = {
+    id: string;
+    persistentId: string;
+    url: string;
+    originalName?: string;
+    scope: "DesignSystem" | "Documentation";
+};
+export declare class Resource {
+    /** Unique identifier of the resource */
+    id: string;
+    /** Unique identifier of the resource in the version */
+    idInVersion: string;
+    /** URL of the resource */
+    url: string;
+    /** Original filename of the resource */
+    originalName: string | null;
+    /** Scope of the resource */
+    scope: "DesignSystem" | "Documentation";
+    /** Type of the resource */
+    type: ResourceType;
+    constructor(model: ResourceModel);
+}

package/build/sdk-typescript/src/model/resources/SDKResourceAsset.d.ts

@@ -0,0 +1,6 @@
+import { Resource, ResourceModel, ResourceType } from "./SDKResource";
+export type ResourceAssetModel = ResourceModel;
+export declare class ResourceAsset extends Resource {
+    type: ResourceType;
+    constructor(model: ResourceAssetModel);
+}

package/build/sdk-typescript/src/model/resources/SDKResourceFont.d.ts

@@ -0,0 +1,15 @@
+import { Resource, ResourceModel, ResourceType } from "./SDKResource";
+export type ResourceFontModel = ResourceModel & {
+    fontProperties?: {
+        family?: string;
+        subfamily?: string;
+    };
+};
+export declare class ResourceFont extends Resource {
+    type: ResourceType;
+    fontProperties: {
+        family: string | null;
+        subfamily: string | null;
+    } | null;
+    constructor(model: ResourceFontModel);
+}

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

@@ -12,6 +12,7 @@ export type SourceRemoteModel = {
     };
     cloud?: SourceRemoteModelCloud;
     tokenStudio?: SourceRemoteModelTokensStudio;
+    figmaVariablesPlugin?: SourceRemoteModelFigmaVariablesPlugin;
     scope: SourceScope;
 };
 export type SourceScope = {
@@ -96,6 +97,10 @@ export type SourceRemoteModelTokensStudio = {
         themeId?: string;
     }>;
 };
+export type SourceRemoteModelFigmaVariablesPlugin = {
+    fileId: string;
+    lastImportedAt?: string;
+};
 export type SourceModelTokenStudio = Omit<SourceRemoteModelTokensStudio, "lastUpdatesCheckedAt" | "lastImportedAt"> & {
     lastUpdatesCheckedAt?: Date;
     lastImportedAt?: Date;
@@ -104,6 +109,9 @@ export type SourceModelCloud = Omit<SourceRemoteModelCloud, "lastUpdatesCheckedA
     lastUpdatesCheckedAt?: Date;
     lastImportedAt?: Date;
 };
+export type SourceModelFigmaVariablesPlugin = Omit<SourceRemoteModelFigmaVariablesPlugin, "lastImportedAt"> & {
+    lastImportedAt?: Date;
+};
 export type SourceTransportModel = Pick<Source, "type" | "id" | "fileName" | "linkType" | "brandId" | "scope"> & {
     cloud?: SourceRemoteModelCloud | null;
 };
@@ -115,7 +123,9 @@ export declare class Source {
     brandId: string | null;
     cloud: SourceModelCloud | null;
     tokenStudio?: SourceModelTokenStudio | null;
+    figmaVariablesPlugin?: SourceModelFigmaVariablesPlugin | null;
     scope: SourceScope;
+    get lastImportedAt(): Date | null;
     get hasError(): boolean;
     get hasWarning(): boolean;
     get isCloudAvailable(): boolean;

package/build/sdk-typescript/src/model/users/SDKUserProfile.d.ts

@@ -1,23 +1,27 @@
+export type UserOnboardingDepartmentType = "Design" | "Engineering" | "Brand" | "Other";
+export type UserOnboardingJobLevelType = "Executive" | "Manager" | "IndividualContributor" | "Other";
 export type UserProfileRemoteModel = {
     name?: string;
     nickname?: string;
     avatar?: string;
     onboarding?: UserProfileOnboardingRemoteModel;
+    isOnboardingFinished?: boolean;
 };
 export type UserProfileOnboardingRemoteModel = {
     companyName?: string;
     numberOfPeopleInOrg?: string;
     numberOfPeopleInDesignTeam?: string;
-    department?: string;
+    department?: UserOnboardingDepartmentType;
     jobTitle?: string;
     phase?: string;
-    jobLevel?: string;
+    jobLevel?: UserOnboardingJobLevelType;
 };
 export type UserProfileTransportModel = UserProfileRemoteModel;
 export type UserProfileOnboardingUpdateModel = UserProfileOnboardingRemoteModel;
 export type UserProfileUpdateModel = {
     name?: string;
     nickname?: string;
+    onboarding?: UserProfileOnboardingRemoteModel;
 };
 export declare class UserProfile {
     /** User name */
@@ -26,15 +30,17 @@ export declare class UserProfile {
     nickname: string | null;
     /** Avatar */
     avatar: string | null;
+    /** Is profile onboarding finished */
+    isOnboardingFinished: boolean;
     /** Onboarding object */
     onboarding: {
         companyName: string | null;
         numberOfPeopleInOrg: string | null;
         numberOfPeopleInDesignTeam: string | null;
-        department: string | null;
+        department: UserOnboardingDepartmentType | null;
         jobTitle: string | null;
         phase: string | null;
-        jobLevel: string | null;
+        jobLevel: UserOnboardingJobLevelType | null;
     } | null;
     constructor(model: UserProfileRemoteModel);
     /** Constructs directly manipulable update object for user profile */

package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONConverter.d.ts

@@ -17,6 +17,7 @@ export declare class DTJSONConverter {
     referenceResolver: DTTokenReferenceResolver;
     constructor(versionId: string, mapping: DTPluginToSupernovaMapPack);
     convertNodesToTokens(nodes: Array<DTParsedNode>, brand: Brand): Array<DTProcessedTokenNode>;
+    private restoreInitialTokenOrder;
     private remapRootNodeKey;
     private remapRootNodeKeys;
     private convertNodesToTokensForSupportedNodeTypes;

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

@@ -1,5 +1,5 @@
 import { DocsBlockDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockDefinition";
-import { DocsBlockItem } from "../../model/docs/blocks/definition/SDKDocsBlockItem";
+import { DocsBlockItemDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockItemDefinition";
 import { DocsBlockLayout } from "../../model/docs/blocks/definition/SDKDocsBlockLayout";
 import { DocsBlockOnboarding } from "../../model/docs/blocks/definition/SDKDocsBlockOnboarding";
 import { DocsBlockVariant } from "../../model/docs/blocks/definition/SDKDocsBlockVariant";
@@ -25,6 +25,7 @@ import { DocsBlockTextPropertyDefinition, DocsBlockTextPropertyOptions } from ".
 import { DocsBlockTokenPropertyDefinition, DocsBlockTokenPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockTokenProperty";
 import { DocsBlockTokenPropertyPropertyDefinition, DocsBlockTokenPropertyPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockTokenPropertyProperty";
 import { DocsBlockTokenTypePropertyDefinition, DocsBlockTokenTypePropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty";
+import { DocsBlockUrlPropertyDefinition, DocsBlockUrlPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockUrlProperty";
 import { DocsBlockBehaviorDataType } from "../../model/enums/SDKDocsBlockBehaviorDataType";
 import { DocsBlockBehaviorSelectionType } from "../../model/enums/SDKDocsBlockBehaviorSelectionType";
 import { DocsBlockCategory } from "../../model/enums/SDKDocsBlockCategory";
@@ -48,6 +49,7 @@ export declare class DocsBlockBuilder {
         name: string;
         image: string;
         layout: DocsBlockLayout;
+        description?: string;
         maxColumns?: number;
     }): DocsBlockVariant;
     /** Create and item variant to render the item with default layout (all properties will be stacked into a single column) */
@@ -56,12 +58,23 @@ export declare class DocsBlockBuilder {
         name: string;
         image: string;
         properties: Array<DocsBlockItemPropertyAnyDefinition>;
+        description?: string;
         maxColumns?: number;
+        appearance?: {
+            isBordered?: boolean;
+            hasBackground?: boolean;
+            isEditorPresentationDifferent?: boolean;
+        };
     }): DocsBlockVariant;
     /** 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>;
         maxColumns?: number;
+        appearance?: {
+            isBordered?: boolean;
+            hasBackground?: boolean;
+            isEditorPresentationDifferent?: boolean;
+        };
     }): DocsBlockVariant;
     /** Create block item with a single variant of rendering */
     singleVariantItem(configuration: {
@@ -71,7 +84,7 @@ export declare class DocsBlockBuilder {
             isBordered?: boolean;
             hasBackground?: boolean;
         };
-    }): DocsBlockItem;
+    }): DocsBlockItemDefinition;
     /** Create block item with multiple variants of rendering. The first variant becomes the default one */
     multiVariantItem(configuration: {
         properties: Array<DocsBlockItemPropertyAnyDefinition>;
@@ -80,7 +93,7 @@ export declare class DocsBlockBuilder {
             isBordered?: boolean;
             hasBackground?: boolean;
         };
-    }): DocsBlockItem;
+    }): DocsBlockItemDefinition;
     /** Creates a core block definition which can't select from Supernova data, and its item can only be created once (Examples: Rich Text, Callout, Heading blocks) */
     singleItemBlock(configuration: {
         id: string;
@@ -88,7 +101,7 @@ export declare class DocsBlockBuilder {
         category: DocsBlockCategory;
         icon: string;
         description?: string;
-        item: DocsBlockItem;
+        item: DocsBlockItemDefinition;
         linkable?: boolean;
         isBordered?: boolean;
         hasBackground?: boolean;
@@ -101,7 +114,7 @@ export declare class DocsBlockBuilder {
         name: string;
         category: DocsBlockCategory;
         icon: string;
-        item: DocsBlockItem;
+        item: DocsBlockItemDefinition;
         maxItems?: number;
         description?: string;
         linkable?: boolean;
@@ -116,7 +129,7 @@ export declare class DocsBlockBuilder {
         name: string;
         icon: string;
         category: DocsBlockCategory;
-        item: DocsBlockItem;
+        item: DocsBlockItemDefinition;
         dataType: Exclude<DocsBlockBehaviorDataType, DocsBlockBehaviorDataType.item>;
         selectionType: DocsBlockBehaviorSelectionType;
         maxSelection?: number;
@@ -292,6 +305,16 @@ export declare class DocsBlockBuilder {
             [key: string]: DocsBlockMarkdownPropertyOptions;
         };
     }): DocsBlockMarkdownPropertyDefinition;
+    /** Create a block property with type .url and its specific options */
+    urlProperty(configuration: {
+        id: string;
+        name: string;
+        description?: string;
+        options: DocsBlockUrlPropertyOptions;
+        variants?: {
+            [key: string]: DocsBlockUrlPropertyOptions;
+        };
+    }): DocsBlockUrlPropertyDefinition;
     /** Create a block property with type .storybook and its specific options */
     storybookProperty(configuration: {
         id: string;

package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementTransformer.d.ts

@@ -62,7 +62,7 @@ export declare class TokenJSONElementTransformer {
     safeGroupName(group: TokenGroup): string;
     processedName(name: string, naming: JSONBuilderNamingOption): string;
     /** Retrieve human-readable token type in unified fashion, used both as token type and as token master group */
-    typeLabel(type: TokenType): "color" | "gradient" | "typography" | "border" | "textCase" | "textDecoration" | "shadow" | "visibility" | "measure" | "text";
+    typeLabel(type: TokenType): "color" | "gradient" | "typography" | "border" | "textCase" | "textDecoration" | "visibility" | "shadow" | "measure" | "text";
     /** Retrieve chain of groups up to a specified group, ordered from parent to children */
     referenceGroupChain(containingGroup: TokenGroup, allGroups: Array<TokenGroup>): Array<TokenGroup>;
 }