@supernova-studio/supernova-sdk-beta 2.0.17 → 2.0.19

package/build/sdk-typescript/src/model/enums/SDKIconSet.d.ts

@@ -0,0 +1,5 @@
+export declare enum IconSet {
+    checkCircle = "CheckCircle",
+    crossCircle = "CrossCircle",
+    alert = "Alert"
+}

package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts

@@ -46,4 +46,4 @@ export type ReferencableTokenType = (typeof REFERENCABLE_TOKEN_TYPES)[number];
 export declare const tokenTypeIsReferencable: (tokenType: TokenType) => tokenType is TokenType.color | TokenType.radius | TokenType.borderWidth | TokenType.duration | TokenType.fontSize | TokenType.dimension | TokenType.letterSpacing | TokenType.lineHeight | TokenType.opacity | TokenType.paragraphSpacing | TokenType.size | TokenType.space | TokenType.zIndex | TokenType.textDecoration | TokenType.textCase | TokenType.fontFamily | TokenType.fontWeight;
 export declare const DT_TOKEN_TYPES: readonly [TokenType.color, TokenType.shadow, TokenType.gradient, TokenType.typography, TokenType.border, TokenType.dimension, TokenType.size, TokenType.space, TokenType.opacity, TokenType.fontSize, TokenType.lineHeight, TokenType.letterSpacing, TokenType.paragraphSpacing, TokenType.borderWidth, TokenType.radius, TokenType.duration, TokenType.zIndex, TokenType.fontFamily, TokenType.fontWeight, TokenType.textCase, TokenType.textDecoration, TokenType.visibility];
 export type DTTokenType = (typeof DT_TOKEN_TYPES)[number];
-export type DTOriginalTokenType = "color" | "borderRadius" | "boxShadow" | "gradient" | "typography" | "border" | "borderWidth" | "sizing" | "opacity" | "spacing" | "fontSizes" | "paragraphSpacing" | "letterSpacing" | "lineHeights" | "other" | "dimension" | "fontFamilies" | "fontWeights" | "textCase" | "textDecoration";
+export type DTOriginalTokenType = "color" | "borderRadius" | "boxShadow" | "gradient" | "typography" | "border" | "borderWidth" | "sizing" | "opacity" | "spacing" | "fontSizes" | "paragraphSpacing" | "letterSpacing" | "lineHeights" | "other" | "dimension" | "fontFamilies" | "fontWeights" | "textCase" | "textDecoration" | "duration";

package/build/sdk-typescript/src/model/exporters/SDKExporter.d.ts

@@ -7,6 +7,7 @@ export type ExporterModel = {
     packageId: string;
     isPrivate: boolean;
     isDefaultDocumentationExporter: boolean;
+    isOwner?: boolean;
     usesBrands: boolean;
     usesThemes?: boolean;
     name: string;
@@ -31,6 +32,11 @@ export type NewExporterPayload = {
     url?: string;
     provider?: ExporterProvider;
 };
+export type ExporterMembershipModel = {
+    exporterId: string;
+    workspaceId: string;
+    role: "Owner" | "User";
+};
 export declare class Exporter {
     /** Unique exporter installation id. This id is used to referenced exporter within Supernova system (for example, in ds.documentationExporterId) */
     id: string;
@@ -70,6 +76,8 @@ export declare class Exporter {
     gitBranch: string | null;
     /** Root directory in the repository containing the exporter package. If not provided, exporter is located at the root directory */
     gitDirectory: string | null;
+    /** If the workspace is owner of an exporter */
+    isOwner?: boolean;
     /** Contribution of this exporter to the Supernova system */
     contributes: {
         /** DocumentationLegacy block variants */

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

@@ -12,6 +12,7 @@ export type SourceRemoteModel = {
     id: string;
     fileName?: string;
     brandId?: string;
+    themeId?: string;
     plugin?: {
         fileId: string;
         lastImportedAt?: string;
@@ -124,7 +125,7 @@ export type SourceModelCloud = Omit<SourceRemoteModelCloud, "lastUpdatesCheckedA
 export type SourceModelFigmaVariablesPlugin = Omit<SourceRemoteModelFigmaVariablesPlugin, "lastImportedAt"> & {
     lastImportedAt?: Date;
 };
-export type SourceTransportModel = Pick<Source, "type" | "id" | "fileName" | "brandId" | "scope"> & {
+export type SourceTransportModel = Pick<Source, "type" | "id" | "fileName" | "brandId" | "themeId" | "scope"> & {
     cloud?: SourceRemoteModelCloud | null;
 };
 export declare class Source {
@@ -132,6 +133,7 @@ export declare class Source {
     id: string;
     fileName: string | null;
     brandId: string | null;
+    themeId: string | null;
     cloud: SourceModelCloud | null;
     tokenStudio?: SourceModelTokenStudio | null;
     figmaVariablesPlugin?: SourceModelFigmaVariablesPlugin | null;

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

@@ -7,6 +7,8 @@ export type TokenOriginModel = {
     referenceOriginId?: string;
     referencePersistentId?: string;
     referenceResolutionFailed?: boolean;
+    referenceOriginRemote?: boolean;
+    referenceOriginName?: string;
     key?: string;
 };
 export declare class TokenOrigin {
@@ -17,6 +19,8 @@ export declare class TokenOrigin {
     referenceOriginId?: string | null;
     referencePersistentId?: string | null;
     referenceResolutionFailed?: boolean | null;
+    referenceOriginRemote?: boolean | null;
+    referenceOriginName?: string | null;
     key?: string | null;
     constructor(model: TokenOriginModel);
 }

package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenModel.d.ts

@@ -17,6 +17,8 @@ export type TokenRemoteModel = {
         referenceOriginId?: string;
         referencePersistentId?: string;
         referenceResolutionFailed?: boolean;
+        referenceOriginRemote?: boolean;
+        referenceOriginName?: string;
         key?: string;
     };
     data: {

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

@@ -25,6 +25,8 @@ export type UserProfileOnboardingRemoteModel = {
     designSystemName?: string;
     figmaUrl?: string;
     defaultDestination?: UserOnboardingDefaultDestination;
+    isPageDraftOnboardingFinished?: boolean;
+    isApprovalsOnboardingFinished?: boolean;
 };
 export type UserProfileTransportModel = UserProfileRemoteModel;
 export type UserProfileOnboardingUpdateModel = UserProfileOnboardingRemoteModel;
@@ -54,6 +56,8 @@ export declare class UserProfile {
         designSystemName: string | null;
         figmaUrl: string | null;
         defaultDestination: UserOnboardingDefaultDestination | null;
+        isPageDraftOnboardingFinished: boolean | null;
+        isApprovalsOnboardingFinished: boolean | null;
     } | null;
     constructor(model: UserProfileRemoteModel);
     /** Constructs directly manipulable update object for user profile */

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

@@ -3,6 +3,7 @@ export type WorkspaceSSOSettingsRemoteModel = {
     defaultAutoInviteValue: boolean;
     autoInviteDomains: Record<string, boolean>;
     areInvitesDisabled: boolean;
+    skipDocsSupernovaLogin: boolean;
 };
 export type WorkspaceSSOSettingsUpdateModel = WorkspaceSSOSettingsRemoteModel;
 export type WorkspaceSSOSettingsTransportModel = WorkspaceSSOSettingsRemoteModel;
@@ -11,6 +12,7 @@ export declare class WorkspaceSSOSettings {
     defaultAutoInviteValue: boolean;
     autoInviteDomains: Record<string, boolean>;
     areInvitesDisabled: boolean;
+    skipDocsSupernovaLogin: boolean;
     constructor(model: WorkspaceSSOSettingsRemoteModel);
     toUpdateObject(): WorkspaceSSOSettingsUpdateModel;
     toRemote(): WorkspaceSSOSettingsTransportModel;

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

@@ -1,4 +1,3 @@
-import { DocsBlockFigmaNodePropertyOptions, DocsBlockMultiRichTextPropertyOptions } from "../../exports";
 import { DocsBlockDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockDefinition";
 import { DocsBlockItemDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockItemDefinition";
 import { DocsBlockLayout } from "../../model/docs/blocks/definition/SDKDocsBlockLayout";
@@ -14,12 +13,14 @@ import { DocsBlockComponentPropertyPropertyDefinition, DocsBlockComponentPropert
 import { DocsBlockDividerPropertyDefinition, DocsBlockDividerPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockDividerProperty";
 import { DocsBlockEmbedUrlPropertyDefinition, DocsBlockEmbedUrlPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty";
 import { DocsBlockFigmaComponentPropertyDefinition, DocsBlockFigmaComponentPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockFigmaComponentProperty";
-import { DocsBlockFigmaNodePropertyDefinition } from "../../model/docs/blocks/properties/SDKDocsBlockFigmaNodeProperty";
+import { DocsBlockFigmaNodePropertyDefinition, DocsBlockFigmaNodePropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockFigmaNodeProperty";
 import { DocsBlockImagePropertyDefinition, DocsBlockImagePropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockImageProperty";
 import { DocsBlockMarkdownPropertyDefinition, DocsBlockMarkdownPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockMarkdownProperty";
+import { DocsBlockMultiRichTextPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty";
 import { DocsBlockMultiSelectPropertyDefinition, DocsBlockMultiSelectPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty";
 import { DocsBlockNumberPropertyDefinition, DocsBlockNumberPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockNumberProperty";
 import { DocsBlockItemPropertyAnyDefinition } from "../../model/docs/blocks/properties/SDKDocsBlockProperty";
+import { DocsBlockRichTextEditorPropertyDefinition, DocsBlockRichTextEditorPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockRichTextEditorProperty";
 import { DocsBlockRichTextPropertyDefinition, DocsBlockRichTextPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockRichTextProperty";
 import { DocsBlockSingleSelectPropertyDefinition, DocsBlockSingleSelectPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty";
 import { DocsBlockStorybookPropertyDefinition, DocsBlockStorybookPropertyOptions } from "../../model/docs/blocks/properties/SDKDocsBlockStorybookProperty";
@@ -53,6 +54,7 @@ export declare class DocsBlockBuilder {
         image: string;
         layout: DocsBlockLayout;
         description?: string;
+        defaultColumns?: number;
         maxColumns?: number;
     }): DocsBlockVariant;
     /** Create and item variant to render the item with default layout (all properties will be stacked into a single column) */
@@ -63,6 +65,7 @@ export declare class DocsBlockBuilder {
         properties: Array<DocsBlockItemPropertyAnyDefinition>;
         description?: string;
         maxColumns?: number;
+        defaultColumns?: number;
         appearance?: {
             isBordered?: boolean;
             hasBackground?: boolean;
@@ -76,6 +79,7 @@ export declare class DocsBlockBuilder {
         image?: string;
         description?: string;
         maxColumns?: number;
+        defaultColumns?: number;
         appearance?: {
             isBordered?: boolean;
             hasBackground?: boolean;
@@ -131,7 +135,10 @@ export declare class DocsBlockBuilder {
         item: DocsBlockItemDefinition;
         maxItems?: number;
         description?: string;
-        linkable?: boolean;
+        options?: {
+            linkable?: boolean;
+            newItemLabel?: string;
+        };
         appearance?: {
             isBordered?: boolean;
             hasBackground?: boolean;
@@ -187,7 +194,7 @@ export declare class DocsBlockBuilder {
             [key: string]: DocsBlockRichTextPropertyOptions;
         };
     }): DocsBlockRichTextPropertyDefinition;
-    /** Create a block property with type .richText and its specific options */
+    /** Create a block property with type .multiRichText and its specific options */
     multiRichTextProperty(configuration: {
         id: string;
         name: string;
@@ -197,6 +204,16 @@ export declare class DocsBlockBuilder {
             [key: string]: DocsBlockMultiRichTextPropertyOptions;
         };
     }): DocsBlockRichTextPropertyDefinition;
+    /** Create a block property with type .multiRichText and its specific options */
+    richTextEditorProperty(configuration: {
+        id: string;
+        name: string;
+        description?: string;
+        options: DocsBlockRichTextEditorPropertyOptions;
+        variants?: {
+            [key: string]: DocsBlockRichTextEditorPropertyOptions;
+        };
+    }): DocsBlockRichTextEditorPropertyDefinition;
     /** Create a block property with type .boolean and its specific options */
     booleanProperty(configuration: {
         id: string;

package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewTypes.d.ts

@@ -3,12 +3,16 @@ export type TokenUtilPreviewTokenValueSegment = {
     referencedName?: string;
     prefersReferenceName?: boolean;
     referenceResolutionFailed?: boolean;
+    referenceOriginRemote?: boolean;
+    referenceOriginName?: string;
 };
 export type TokenUtilPreviewTokenType = "blur" | "border" | "borderWidth" | "color" | "copy" | "fontFamily" | "fontSize" | "fontWeight" | "dimension" | "duration" | "gradient" | "lineHeight" | "letterSpacing" | "opacity" | "paragraphSpacing" | "radius" | "shadow" | "size" | "space" | "string" | "textCase" | "textDecoration" | "typography" | "visibility" | "zIndex";
 export type TokenUtilPreviewMetadata = {
     displayValue: string;
     referencedTo?: string;
     referenceResolutionFailed?: boolean;
+    referenceOriginRemote?: boolean;
+    referenceOriginName?: string;
     tokenType: TokenUtilPreviewTokenType;
 } & ({
     meta?: null;

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

@@ -11,7 +11,7 @@ import { FontFamilyToken, FontWeightToken, ProductCopyToken, StringToken } from
 import { TextCaseToken } from "../model/tokens/SDKTextCaseToken";
 import { TextDecorationToken } from "../model/tokens/SDKTextDecorationToken";
 import { Token } from "../model/tokens/SDKToken";
-import { AnyTokenValue, AnyMultiLayerToken, AnySingleLayerToken, BorderWidthTokenValue, ColorTokenValue, ColorValue, DimensionTokenValue, DurationTokenValue, FontFamilyTokenValue, FontSizeTokenValue, FontWeightTokenValue, LetterSpacingTokenValue, LineHeightTokenValue, OpacityTokenValue, ParagraphSpacingTokenValue, ProductCopyTokenValue, RadiusTokenValue, RawValue, SizeTokenValue, SpaceTokenValue, StringTokenValue, TextCaseTokenValue, TextDecorationTokenValue, VisibilityTokenValue, ZIndexTokenValue } from "../model/tokens/SDKTokenValue";
+import { AnyMultiLayerToken, AnySingleLayerToken, AnyTokenValue, BorderWidthTokenValue, ColorTokenValue, ColorValue, DimensionTokenValue, DurationTokenValue, FontFamilyTokenValue, FontSizeTokenValue, FontWeightTokenValue, LetterSpacingTokenValue, LineHeightTokenValue, OpacityTokenValue, ParagraphSpacingTokenValue, ProductCopyTokenValue, RadiusTokenValue, RawValue, SizeTokenValue, SpaceTokenValue, StringTokenValue, TextCaseTokenValue, TextDecorationTokenValue, VisibilityTokenValue, ZIndexTokenValue } from "../model/tokens/SDKTokenValue";
 import { TypographyToken } from "../model/tokens/SDKTypographyToken";
 import { VisibilityToken } from "../model/tokens/SDKVisibilityToken";
 type TokenMapCompletenessTypeCheck<T extends {

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

@@ -0,0 +1,31 @@
+import { DimensionTokenType } from "../model/enums/SDKTokenType";
+export declare const typographyTokenDefaultValue: {
+    fontFamily: string;
+    fontWeight: string;
+    fontSize: number;
+    lineHeight: number;
+    letterSpacing: number;
+    paragraphIndent: number;
+    paragraphSpacing: number;
+};
+export declare const shadowTokenDefaultValue: {
+    x: number;
+    y: number;
+    blur: number;
+    spread: number;
+    color: string;
+    opacity: number;
+    type: string;
+};
+export declare const borderDefaultValue: {
+    color: string;
+    position: string;
+    style: string;
+    width: number;
+};
+export declare const blurDefaultValue: {
+    radius: number;
+    type: string;
+};
+export declare const opacityDefaultValue = 100;
+export declare const dimensionDefaultValues: Record<DimensionTokenType, number | string>;