@supernova-studio/supernova-sdk-beta 2.0.23 → 2.0.27

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

@@ -49,7 +49,7 @@ export declare class AreaBulkOperations {
      * @param payload - Payload to import. Types to come
      * @returns Nothing
      */
-    importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", payload: any): Promise<ImportJob>;
+    importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", payload: any, isTokenTypeSplitEnabled?: boolean): Promise<ImportJob>;
     /** Batch updates, creates or deletes token data from Supernova at once. Use this method to perform multiple operations at once instead of chaining single update operations. Batch routine runs everything in a single transaction, so either all operations succeed or all fail.
      *
      * WARNING: This method is not yet complete and only supports limited set of operations. Also, doesn't work as transation just yet.

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

@@ -1,5 +1,5 @@
 import { DTODocumentationLinkPreviewRequest, DTODocumentationPageApprovalStateChangeInput } from "@supernova-studio/client";
-import { DesignSystemInvite, DesignSystemPendingMemberInvite, DesignSystemUserInvitation } from "@supernova-studio/model";
+import { DesignSystemInvite, DesignSystemInviteUpdate, DesignSystemMemberUpdate, DesignSystemPendingMemberInvite, DesignSystemUserInvitation } from "@supernova-studio/model";
 import { DesignSystem, DesignSystemAccessMode, DesignSystemSwitcher } from "../../model/base/SDKDesignSystem";
 import { DesignSystemMemberList } from "../../model/base/SDKDesignSystemMemberList";
 import { CustomDomain } from "../../model/support/SDKCustomDomain";
@@ -123,11 +123,13 @@ export declare class AreaDesignSystems {
      * @param usersToInvite - Existing users to invite
      * @param invitesToInvite - Pending memberships to invite
      * @param emailsToInvite - New emails to invite
+     * @param invitesToUpdate - Pending memberships to change dsRole
      * @param deleteInvitationIds - Pending memberships to delete
+     * @param usersToUpdate - Existing users to change dsRole
      * @param removeUserIds - Existing users to remove
      * @returns nothing
      */
-    updateDesignSystemMemberList(designSystemId: string, usersToInvite?: Array<DesignSystemUserInvitation>, invitesToInvite?: Array<DesignSystemPendingMemberInvite>, emailsToInvite?: Array<DesignSystemInvite>, deleteInvitationIds?: Array<string>, removeUserIds?: Array<string>): Promise<void>;
+    updateDesignSystemMemberList(designSystemId: string, usersToInvite?: Array<DesignSystemUserInvitation>, invitesToInvite?: Array<DesignSystemPendingMemberInvite>, emailsToInvite?: Array<DesignSystemInvite>, invitesToUpdate?: Array<DesignSystemInviteUpdate>, deleteInvitationIds?: Array<string>, usersToUpdate?: Array<DesignSystemMemberUpdate>, removeUserIds?: Array<string>): Promise<void>;
     /** Deletes a design system. This action is irreversible, all data will be lost, and can only be performed by the admins of the workspace
      * @param designSystemId - ID of the design system
      * @returns Nothing. RIP design system.

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

@@ -214,6 +214,13 @@ export declare class AreaTokens {
     writeTheme(to: RemoteVersionIdentifier, theme: TokenTheme): Promise<void>;
     /** Resolves tokens by applying themes to them and retrieves new token set where values correctly correspond to that theme */
     computeTokensByApplyingThemes(allTokens: Array<Token>, tokens: Array<Token>, themes: Array<TokenTheme>): Array<Token>;
+    computeInnerReferencesByApplyingThemesEfficient(tokensIndex: Map<string, Token>, themeOverridesIndex: {
+        [key: string]: Map<string, Token>;
+    }, tokens: Array<Token>, themes: Array<TokenTheme>): Array<Token>;
+    private computeSingleTokenValueFromReferenceByApplyingThemes;
+    computeTokensByApplyingThemesEfficient(tokensIndex: Map<string, Token>, themeOverridesIndex: {
+        [key: string]: Map<string, Token>;
+    }, tokens: Array<Token>, themes: Array<TokenTheme>): Array<Token>;
     /** Separates groups by types */
     computeGroupTrees(groups: Array<TokenGroup>): Promise<Map<TokenType, Array<TokenGroup>>>;
     /** Get determistic mocked token data. Must be used with mocked token groups */

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

@@ -1,6 +1,6 @@
 import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignElementsDataDiffResponse, DTODocumentationLinkPreviewRequest, DTODocumentationPageAnchor, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOFigmaNode, // TODO? DTODeleteDocumentationTabGroupInput,
 DTOFigmaNodeRenderInput, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
-import { DesignSystemInvite, DesignSystemPendingMemberInvite, DesignSystemUserInvitation } from "@supernova-studio/model";
+import { DesignSystemInvite, DesignSystemInviteUpdate, DesignSystemMemberUpdate, DesignSystemPendingMemberInvite, DesignSystemUserInvitation } from "@supernova-studio/model";
 import { DesignSystemAccessMode, DocsBlockDefinition, ExportBuildStatus, ResourceFont, TokenThemeOverrideTranserObject } from "../../exports";
 import { Acl } from "../../model/acl/SDKAcl";
 import { Asset } from "../../model/assets/SDKAsset";
@@ -192,7 +192,7 @@ export declare class DataCore {
     /** Update design system's access mode and, if switching to invite-only, also the member list */
     updateDesignSystemAccessModeAndMemberList(designSystemId: string, accessMode: DesignSystemAccessMode, retainUserIds: Array<string>, retainInviteIds: Array<string>): Promise<void>;
     /** Update design system's member list */
-    updateDesignSystemMemberList(designSystemId: string, usersToInvite?: Array<DesignSystemUserInvitation>, invitesToInvite?: Array<DesignSystemPendingMemberInvite>, emailsToInvite?: Array<DesignSystemInvite>, deleteInvitationIds?: Array<string>, removeUserIds?: Array<string>): Promise<void>;
+    updateDesignSystemMemberList(designSystemId: string, usersToInvite?: Array<DesignSystemUserInvitation>, invitesToInvite?: Array<DesignSystemPendingMemberInvite>, emailsToInvite?: Array<DesignSystemInvite>, invitesToUpdate?: Array<DesignSystemInviteUpdate>, deleteInvitationIds?: Array<string>, usersToUpdate?: Array<DesignSystemMemberUpdate>, removeUserIds?: Array<string>): Promise<void>;
     /** Create a group within documentation */
     createDocumentationGroup(designSystemId: string, versionId: string, payload: Omit<DTOCreateDocumentationGroupInput, "persistentId">): Promise<string>;
     /** Create a tab group within documentation */
@@ -548,7 +548,7 @@ export declare class DataCore {
     createPersonalAccessTokenConnection(service: ConnectionProviders, connection: PersonalAccessTokenConnectionPayload | AzurePersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
     bulkUpdateTokenData(designSystemId: string, versionId: string, data: TokenUpdateTransactionData): Promise<any>;
     bulkUpdateComponentData(designSystemId: string, versionId: string, data: ComponentUpdateTransactionData): Promise<any>;
-    importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", payload: any): Promise<ImportJob>;
+    importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", payload: any, isTokenTypeSplitEnabled?: boolean): Promise<ImportJob>;
     getImportJob(designSystemId: string, versionId: string, jobId: string): Promise<ImportJob>;
     getImportJobs(designSystemId: string, versionId: string): Promise<Array<ImportJob>>;
     scheduleImportJobForFigmaSources(designSystemId: string, versionId: string, sourceIds: Array<string>, dryRun: boolean): Promise<ImportJob>;

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

@@ -1,5 +1,5 @@
 import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignSystem, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOFigmaNode, DTOFigmaNodeRenderInput, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
-import { DesignSystemInvite, DesignSystemPendingMemberInvite, DesignSystemUserInvitation } from "@supernova-studio/model";
+import { DesignSystemInvite, DesignSystemInviteUpdate, DesignSystemMemberUpdate, DesignSystemPendingMemberInvite, DesignSystemUserInvitation } from "@supernova-studio/model";
 import { DesignSystemAccessMode, TokenThemeOverrideTranserObject } from "../../../exports";
 import { Brand, BrandRemoteModel, BrandUpdateModel } from "../../../model/base/SDKBrand";
 import { DesignSystem, DesignSystemSwitcher } from "../../../model/base/SDKDesignSystem";
@@ -138,7 +138,7 @@ export declare class DataCoreWriteRequests {
     /** Remote: Updates a design system's access mode and, if switching to invite-only, also the member list */
     updateRemoteDesignSystemAccessModeAndMemberList(designSystemId: string, accessMode: DesignSystemAccessMode, retainUserIds: Array<string>, retainInviteIds: Array<string>): Promise<void>;
     /** Remote: Updates a design system's member list */
-    updateRemoteDesignSystemMemberList(designSystemId: string, usersToInvite?: Array<DesignSystemUserInvitation>, invitesToInvite?: Array<DesignSystemPendingMemberInvite>, emailsToInvite?: Array<DesignSystemInvite>, deleteInvitationIds?: Array<string>, removeUserIds?: Array<string>): Promise<void>;
+    updateRemoteDesignSystemMemberList(designSystemId: string, usersToInvite?: Array<DesignSystemUserInvitation>, invitesToInvite?: Array<DesignSystemPendingMemberInvite>, emailsToInvite?: Array<DesignSystemInvite>, invitesToUpdate?: Array<DesignSystemInviteUpdate>, deleteInvitationIds?: Array<string>, usersToUpdate?: Array<DesignSystemMemberUpdate>, removeUserIds?: Array<string>): Promise<void>;
     /** Remote: Deletes a design system */
     deleteDesignSystem(designSystemId: string): Promise<void>;
     private elementAction;
@@ -256,6 +256,6 @@ export declare class DataCoreWriteRequests {
     linkFigmaSource(designSystemId: string, data: object): Promise<SourceRemoteModel>;
     updateFigmaSource(designSystemId: string, sourceId: string, data: object): Promise<SourceRemoteModel>;
     writeTokenStudioJSONData(designSystemId: string, versionId: string, data: object): Promise<object>;
-    importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", importType: "Upload", payload: any): Promise<ImportJobRemoteModel>;
+    importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", importType: "Upload", payload: any, isTokenTypeSplitEnabled?: boolean): Promise<ImportJobRemoteModel>;
     setKeyValueStorageData(designSystemId: string, kvData: object): Promise<void>;
 }

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

@@ -34,6 +34,7 @@ export type { FeaturePermissionResolution } from "./model/workspaces/SDKWorkspac
 export { Brand } from "./model/base/SDKBrand";
 export type { BrandUpdateModel } from "./model/base/SDKBrand";
 export { DesignSystem } from "./model/base/SDKDesignSystem";
+export type { DesignSystemRole } from "./model/enums/SDKDesignSystemRole";
 export type { DesignSystemAccessMode } from "./model/base/SDKDesignSystem";
 export { DesignSystemVersion } from "./model/base/SDKDesignSystemVersion";
 export type { DesignSystemVersionCreate, DesignSystemVersionUpdateModel, DesignSystemVersionCreationJob, } from "./model/base/SDKDesignSystemVersion";

package/build/sdk-typescript/src/model/base/SDKDesignSystem.d.ts

@@ -1,5 +1,5 @@
 import { DTODesignSystem } from "@supernova-studio/client";
-import { UserRole } from "../enums/SDKUserRole";
+import { DesignSystemRole } from "../enums/SDKDesignSystemRole";
 export type DesignSystemSwitcher = {
     isEnabled: boolean;
     designSystemIds: Array<string>;
@@ -34,13 +34,16 @@ export declare class DesignSystem {
     /** Access mode of the design system */
     accessMode: DesignSystemAccessMode;
     /** Effective role of the user in the design system.
-     * Is `null` when the user doesn't have access to the design system, but can know about its existence (e.g. Owners). */
-    effectiveRole: UserRole | null;
-    constructor(model: DTODesignSystem);
+     * Is `null` the DS role is inherited from the WS. */
+    effectiveRole: DesignSystemRole | null;
+    /** Flag which determines if the design system is available to the user.
+     * If `false` then the user doesn't have access to the design system, but knows about its existence (e.g. Owners). */
+    isAvailableToUser: boolean;
+    constructor(model: Omit<DTODesignSystem, "isPublic"> & {
+        isPublic: boolean;
+    });
     /** Constructs representation that can be used to transport the instantiated object as JSON, for example for SSR <> Client use-cases. Reconstruct to class instance using `fromTransport` */
     toTransport(): DesignSystemTransportModel;
     /** Reconstructs class from the transport model */
     static fromTransport(model: DesignSystemTransportModel): DesignSystem;
-    /** Returns true if the design system is available to the current user */
-    get isAvailableToUser(): boolean;
 }

package/build/sdk-typescript/src/model/base/SDKDesignSystemMemberList.d.ts

@@ -1,13 +1,23 @@
 import { DTODesignSystemMemberListResponse } from "@supernova-studio/client";
+import { DesignSystemRole } from "../enums/SDKDesignSystemRole";
+/**
+ * Re-mapped from DesignSystemMember to User, because "member" encapsulates both users and invitations.
+ */
 export type DesignSystemUser = {
     userId: string;
+    designSystemRole: DesignSystemRole | null;
 };
 export type DesignSystemInvitation = {
     id: string;
     workspaceInvitationId: string;
+    designSystemRole: DesignSystemRole | null;
 };
 export declare class DesignSystemMemberList {
-    /** List of existing users that belong to the design system */
+    /**
+     * List of existing users that belong to the design system.
+     *
+     * Re-mapped from "members" to "users", because "member" encapsulates both users and invitations.
+     */
     users: Array<DesignSystemUser>;
     /** List of invitations that belong to the design system */
     invitations: Array<DesignSystemInvitation>;

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

@@ -23,9 +23,15 @@ export declare class DesignComponentPropertyText extends DesignComponentProperty
     defaultValue: string;
     constructor(model: DTOFigmaComponentTextProperty);
 }
+type InstanceSwapDefaultValuePreview = {
+    componentName: string;
+    componentSetName: string | null;
+    isRemote: boolean;
+};
 export declare class DesignComponentPropertyInstanceSwap extends DesignComponentPropertyDefinition {
     type: DesignComponentPropertyType.InstanceSwap;
     defaultValue: string;
+    defaultValuePreview: InstanceSwapDefaultValuePreview | null;
     constructor(model: DTOFigmaComponentInstanceSwapProperty);
 }
 export declare class DesignComponentPropertyVariant extends DesignComponentPropertyDefinition {

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

@@ -0,0 +1,5 @@
+import { DTODesignSystemRole } from "@supernova-studio/client";
+import { UserRole } from "./SDKUserRole";
+export type DesignSystemRole = Exclude<UserRole, UserRole.owner | UserRole.billing>;
+export declare const convertRemoteToDesignSystemRole: (remoteRole: DTODesignSystemRole) => DesignSystemRole;
+export declare const resolveDesignSystemRoleFromWorkspaceRole: (wsRole: UserRole) => UserRole;

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

@@ -1,4 +1,7 @@
-import { WorkspaceRole } from "@supernova-studio/model";
+import { DTOWorkspaceRole } from "@supernova-studio/client";
+/**
+ * Workspace role
+ * */
 export declare enum UserRole {
     owner = "Owner",
     admin = "Admin",
@@ -7,5 +10,5 @@ export declare enum UserRole {
     billing = "Billing",
     viewer = "Viewer"
 }
-export declare const convertRemoteToUserRole: (remoteRole: WorkspaceRole) => UserRole;
+export declare const convertRemoteToUserRole: (remoteRole: DTOWorkspaceRole) => UserRole;
 export type UserRoleWithoutOwner = Exclude<UserRole, UserRole.owner>;

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

@@ -113,6 +113,7 @@ export type SourceRemoteModelFigmaVariablesPlugin = {
     fileId: string;
     lastImportedAt?: string;
     lastImportMetadata?: Record<string, any>;
+    isTokenTypeSplitEnabled: boolean;
 };
 export type SourceModelTokenStudio = Omit<SourceRemoteModelTokensStudio, "lastUpdatesCheckedAt" | "lastImportedAt"> & {
     lastUpdatesCheckedAt?: Date;

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

@@ -18,6 +18,7 @@ export declare class Token implements TokenValue {
     tokenType: TokenType;
     origin: TokenOrigin | null;
     parentGroupId: string;
+    tokenPath: Array<string> | null;
     sortOrder: number;
     properties: Array<ElementProperty>;
     propertyValues: {
@@ -27,6 +28,7 @@ export declare class Token implements TokenValue {
     updatedAt: Date | null;
     constructor(model: TokenRemoteModel, versionId: string, properties: Array<ElementProperty>, propertyValues: Array<ElementPropertyValue>, empty?: boolean);
     setParentGroupId(parentGroupId: string | null): void;
+    setTokenPath(tokenPath: Array<string>): void;
     setSortOrder(order: number): void;
     toBaseWriteObject(): TokenRemoteModel;
     toWriteObject(): TokenRemoteModel;

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

@@ -10,7 +10,10 @@ export declare class UserMembership {
     user: User;
     /** Role of the user in the workspace */
     role: UserRole;
-    /** Role of the user in the workspace */
+    /**
+     * Effective role of the user in the workspace, which can be different from the regular role
+     * when the workspace is suspended etc.
+     */
     effectiveRole: UserRole;
     constructor(model: UserMembershipRemoteModel);
     /** Constructs representation that can be used to write full object to remote */

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

@@ -5,6 +5,11 @@ export type TokenUtilPreviewTokenValueSegment = {
     referenceResolutionFailed?: boolean;
     referenceOriginRemote?: boolean;
     referenceOriginName?: string;
+    referenceFullPath?: string;
+    isDifferentTypeValue?: boolean;
+    isValueOutOfRange?: boolean;
+    tokenOutOfRangeErrorMessage?: string;
+    tokenDifferentTypeErrorMessage?: 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 = {

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

@@ -1,4 +1,4 @@
-import { AnyToken, BlurType, BorderPosition, BorderStyle, DTProcessedTokenNode, GradientType, ShadowType, TextCase, TokenGroup, TokenTheme } from "../exports";
+import { AnyToken, AnyDimensionToken, BlurType, BorderPosition, BorderStyle, DTProcessedTokenNode, GradientType, ShadowType, TextCase, TokenGroup, TokenTheme } from "../exports";
 import { ElementProperty } from "../model/elements/SDKElementProperty";
 import { TokenType } from "../model/enums/SDKTokenType";
 import { BlurToken } from "../model/tokens/SDKBlurToken";
@@ -76,12 +76,23 @@ type TokenClassMapCompletenessTypeCheck<T extends {
     [key in TokenType]: new (...args: any[]) => TokenTypeMapToken[key];
 }> = T;
 export type TokenClassTypeMapToken = TokenClassMapCompletenessTypeCheck<ActualTypeToTokenClassMap>;
+type DifferentTypeValidationResult = {
+    isDifferentTypeValue: boolean;
+    errorMessage?: string;
+};
+type ValueOutOfRangeValidationResult = {
+    isTokenOutOfRange: boolean;
+    errorMessage?: string;
+};
 export declare class TokenUtils {
     /** Map tokens for lookup */
     static tokensToReferenceMap(tokens: Array<Token>): Map<string, Token>;
     /** Map token groups for lookup */
     static tokenGroupsToReferenceMap(groups: Array<TokenGroup>): Map<string, TokenGroup>;
     static lookupReference<T extends Token>(id: string | undefined | null, tokens: Map<string, Token>): T | undefined;
+    static isDimensionToken(token?: AnyToken | undefined | null): token is AnyDimensionToken;
+    static isDifferentTypeValue<T extends AnyToken>(token: T): DifferentTypeValidationResult;
+    static isTokenOutOfRange<T extends AnyToken>(token: T): ValueOutOfRangeValidationResult;
     /** Creates a new token group for a given token type. Default values will be used for all properties */
     static createDefaultTokenGroup(type: TokenType, versionId: string, brandId: string, name?: string): TokenGroup;
     /** Creates a new token theme. Default values will be used for all properties */
@@ -148,7 +159,7 @@ export declare class TokenUtils {
     /** Creates a new color token with updated .color value */
     static colorTokenByUpdatingColor(token: ColorToken, newValue: ColorValue | ColorToken): ColorToken;
     /** Creates a new color token with updated .opacity value */
-    static colorTokenByUpdatingOpacity(token: ColorToken, newValue: number | OpacityToken): ColorToken;
+    static colorTokenByUpdatingOpacity(token: ColorToken, newValue: number | OpacityToken, checkReference?: boolean): ColorToken;
     /** Creates a new blur token with updated .type value */
     static blurTokenByUpdatingType(token: BlurToken, newValue: BlurType): BlurToken;
     /** Creates a new blur token with updated .radius value */