@supernova-studio/supernova-sdk-beta 1.6.25 → 1.6.26

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

@@ -0,0 +1,131 @@
+import { PipelineRemoteModel } from "./remote/SDKRemotePipelineModel";
+export type NewPipelinePayload = {
+    brandId?: string;
+    designSystemId: string;
+    destinations: {
+        azure: null;
+        bitbucket: null;
+        documentation: null;
+        github: null;
+        gitlab: null;
+        s3: Record<string, any>;
+        webhookUrl: null;
+    };
+    eventType: "OnHeadChanged" | "OnSourceUpdated" | "OnVersionReleased";
+    exporterId: string;
+    isEnabled: boolean;
+    name: string;
+};
+export type PipelineModel = {
+    id: string;
+    workspaceId: string;
+    designSystem: {
+        id: string;
+        meta: {
+            name: string;
+            description: string;
+        };
+    };
+    name: string;
+    isEnabled: boolean;
+    eventType: "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
+    exporterId: string;
+    destinations: {
+        webhookUrl: string | null;
+        documentation: {
+            environment: "Live" | "Preview";
+        } | null;
+        s3: Record<any, any> | null;
+        github: {
+            connectionId: string;
+            url: string;
+            branch: string;
+            relativePath: string;
+        } | null;
+        azure: {
+            connectionId: string;
+            organizationId: string;
+            projectId: string;
+            repositoryId: string;
+            branch: string;
+            relativePath: string;
+            url: string;
+        } | null;
+        gitlab: {
+            connectionId: string;
+            projectId: string;
+            branch: string;
+            relativePath: string;
+            url: string;
+        } | null;
+        bitbucket: {
+            connectionId: string;
+            workspaceSlug: string;
+            projectKey: string;
+            repoSlug: string;
+            branch: string;
+            relativePath: string;
+            url: string;
+        } | null;
+    };
+    brandId: string | null;
+    themeId: string | null;
+};
+export declare class Pipeline {
+    id: string;
+    workspaceId: string;
+    designSystem: {
+        id: string;
+        meta: {
+            name: string;
+            description: string;
+        };
+    };
+    name: string;
+    isEnabled: boolean;
+    eventType: "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
+    exporterId: string;
+    destinations: {
+        webhookUrl: string | null;
+        documentation: {
+            environment: "Live" | "Preview";
+        } | null;
+        s3: Record<any, any> | null;
+        github: {
+            connectionId: string;
+            url: string;
+            branch: string;
+            relativePath: string;
+        } | null;
+        azure: {
+            connectionId: string;
+            organizationId: string;
+            projectId: string;
+            repositoryId: string;
+            branch: string;
+            relativePath: string;
+            url: string;
+        } | null;
+        gitlab: {
+            connectionId: string;
+            projectId: string;
+            branch: string;
+            relativePath: string;
+            url: string;
+        } | null;
+        bitbucket: {
+            connectionId: string;
+            workspaceSlug: string;
+            projectKey: string;
+            repoSlug: string;
+            branch: string;
+            relativePath: string;
+            url: string;
+        } | null;
+    };
+    brandId: string | null;
+    themeId: string | null;
+    constructor(data: PipelineRemoteModel);
+    get isBuildOnly(): boolean;
+    get gitProviderType(): "github" | "bitbucket" | "gitlab" | "azure" | null;
+}

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

@@ -0,0 +1,104 @@
+import { ExportBuildResult } from "./SDKExportBuildResults";
+import { ExportDestinations } from "./SDKExportDestinations";
+export type ExportBuildCreatedByModel = {
+    userId: string;
+    userName: string | null;
+};
+export declare class ExportBuildCreatedBy {
+    userId: string;
+    userName: string | null;
+    constructor(data: ExportBuildCreatedByModel);
+}
+/**
+ * The enum representing possible statuses of an export build.
+ * @enum {string}
+ */
+export declare enum ExportBuildStatus {
+    InProgress = "InProgress",
+    Success = "Success",
+    Failed = "Failed",
+    Timeout = "Timeout"
+}
+export type ExportBuildModel = {
+    index: number | null;
+    id: string;
+    createdAt: string;
+    finishedAt: string | null;
+    designSystem: {
+        id: string;
+        meta: {
+            name: string;
+            description: string;
+        };
+    };
+    designSystemVersion: {
+        id: string;
+        meta: {
+            name: string;
+            description: string;
+        };
+        version: string;
+        isReadonly: boolean;
+    };
+    result: ExportBuildResult | null;
+    status: ExportBuildStatus;
+    estimatedExecutionTime: number | null;
+    createdBy: ExportBuildCreatedBy | null;
+    destinations: ExportDestinations;
+    scheduleId: string | null;
+    exporterId: string;
+};
+/** Build run entry */
+export declare class ExportBuild {
+    /** The index of the export build, or null if not provided */
+    index: number | null;
+    /** The unique identifier for the export build */
+    id: string;
+    /** The date and time when the export build was created */
+    createdAt: Date;
+    /** The date and time when the export build was finished, or null if not finished yet */
+    finishedAt: Date | null;
+    /** The design system associated with the export build */
+    designSystem: {
+        id: string;
+        meta: {
+            name: string;
+            description: string;
+        };
+    };
+    /** The version of the design system used in the export build */
+    designSystemVersion: {
+        id: string;
+        meta: {
+            name: string;
+            description: string;
+        };
+        version: string;
+        isReadonly: boolean;
+    };
+    /** The result of the export build, or null if not available */
+    result: ExportBuildResult | null;
+    /** The status of the export build */
+    status: ExportBuildStatus;
+    /** The estimated execution time for the export build, or null if not available */
+    estimatedExecutionTime: number | null;
+    /** The user who created the export build, or null if not available */
+    createdBy: ExportBuildCreatedBy | null;
+    /** The destinations associated with the export build */
+    destinations: ExportDestinations;
+    /** The identifier of the hook associated with the export build, or null if not available */
+    scheduleId: string | null;
+    /** The identifier of the exporter associated with the export build */
+    exporterId: string;
+    constructor(data: ExportBuildModel);
+    /**
+     * Gets the URL for downloading the code generated by the export build.
+     * @returns {string|null} - The URL for downloading the code, or null if not available.
+     */
+    get downloadCodeUrl(): string | null;
+    /**
+     * Gets the URL for the pull request associated with the export build.
+     * @returns {string|null} - The URL for the pull request, or null if not available.
+     */
+    get pullRequestUrl(): string | null;
+}

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

@@ -0,0 +1,73 @@
+export type S3ExportBuildResultModel = {
+    urls: Array<string>;
+    url: string;
+};
+/** The type definition for the data model of an S3 export build result. */
+export declare class S3ExportBuildResult {
+    /** An array of URLs associated with the export build result */
+    urls: Array<string>;
+    /** A URL associated with the export build result */
+    url: string;
+    constructor(data: S3ExportBuildResultModel);
+}
+export type ExportBuildPullRequestResultModel = {
+    pullRequestUrl: string;
+};
+/** The type definition for the data model of an export build pull request result. */
+export declare class ExportBuildPullRequestResult {
+    /** The URL of the pull request associated with the export build result. */
+    pullRequestUrl: string;
+    constructor(data: ExportBuildPullRequestResultModel);
+}
+/**
+ * The enum representing possible types of export build result logs.
+ * @enum {string}
+ */
+export declare enum ExportBuildResultLogType {
+    success = "success",
+    info = "info",
+    warning = "warning",
+    user = "user",
+    error = "error"
+}
+type ExportBuildResultLogModel = {
+    time: string;
+    type: ExportBuildResultLogType;
+    message: string;
+};
+export declare class ExportBuildResultLog {
+    /** The time when the log entry was created */
+    time: Date;
+    /** The type of the log entry */
+    type: ExportBuildResultLogType;
+    /** The message of the log entry */
+    message: string;
+    constructor(data: ExportBuildResultLogModel);
+}
+export type ExportBuildResultModel = {
+    logs: Array<ExportBuildResultLog>;
+    s3: S3ExportBuildResult | null;
+    azure: ExportBuildPullRequestResult | null;
+    bitbucket: ExportBuildPullRequestResult | null;
+    github: ExportBuildPullRequestResult | null;
+    gitlab: ExportBuildPullRequestResult | null;
+    error: string | null;
+};
+export declare class ExportBuildResult {
+    /** An array of log entries associated with the export build result */
+    logs: Array<ExportBuildResultLog>;
+    /** The S3 export build result, or null if not available */
+    s3: S3ExportBuildResult | null;
+    /** The Azure export build pull request result, or null if not available */
+    azure: ExportBuildPullRequestResult | null;
+    /** The Bitbucket export build pull request result, or null if not available */
+    bitbucket: ExportBuildPullRequestResult | null;
+    /** The GitHub export build pull request result, or null if not available */
+    github: ExportBuildPullRequestResult | null;
+    /** The GitLab export build pull request result, or null if not available */
+    gitlab: ExportBuildPullRequestResult | null;
+    /** The error message, or null if not available */
+    error: string | null;
+    constructor(data: ExportBuildResultModel);
+}
+export {};

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

@@ -0,0 +1,111 @@
+export type S3ExportDestinationModel = {
+    url: string | null;
+};
+/**
+ * Type definition for the data model of an S3 export destination.
+ * @typedef {Object} S3ExportDestinationModel
+ * @property {string|null} url - The URL of the S3 export destination or null.
+ */
+export declare class S3ExportDestination {
+    url: string | null;
+    constructor(data: S3ExportDestinationModel);
+}
+export type AzureExportDestinationModel = {
+    connectionId: string | null;
+    organizationId: string;
+    projectId: string;
+    repositoryId: string;
+    branch: string;
+    relativePath: string;
+    url: string | null;
+};
+export declare class AzureExportDestination {
+    connectionId: string | null;
+    organizationId: string;
+    projectId: string;
+    repositoryId: string;
+    branch: string;
+    relativePath: string;
+    url: string | null;
+    constructor(data: AzureExportDestinationModel);
+}
+export type BitbucketExportDestinationModel = {
+    connectionId: string | null;
+    workspaceSlug: string;
+    projectKey: string;
+    repoSlug: string;
+    branch: string;
+    relativePath: string;
+    url: string | null;
+};
+export declare class BitbucketExportDestination {
+    connectionId: string | null;
+    workspaceSlug: string;
+    projectKey: string;
+    repoSlug: string;
+    branch: string;
+    relativePath: string;
+    url: string | null;
+    constructor(data: BitbucketExportDestinationModel);
+}
+export type GithubExportDestinationModel = {
+    connectionId: string | null;
+    url: string;
+    branch: string;
+    relativePath: string;
+};
+export declare class GithubExportDestination {
+    connectionId: string | null;
+    url: string;
+    branch: string;
+    relativePath: string;
+    constructor(data: GithubExportDestinationModel);
+}
+export type GitlabExportDestinationModel = {
+    connectionId: string | null;
+    repositoryId: string;
+    branch: string;
+    relativePath: string;
+    url: string | null;
+};
+export declare class GitlabExportDestination {
+    connectionId: string | null;
+    repositoryId: string;
+    branch: string;
+    relativePath: string;
+    url: string | null;
+    constructor(data: GitlabExportDestinationModel);
+}
+export type ExportDestinationsModel = {
+    s3: S3ExportDestination | null;
+    azure: AzureExportDestination | null;
+    bitbucket: BitbucketExportDestination | null;
+    github: GithubExportDestination | null;
+    gitlab: GitlabExportDestination | null;
+    webhookUrl: string | null;
+};
+/**
+ * Type definition for the data model of export destinations.
+ * @typedef {Object} ExportDestinationsModel
+ * @property {S3ExportDestination|null} s3 - The S3 export destination, or null if not available.
+ * @property {AzureExportDestination|null} azure - The Azure export destination, or null if not available.
+ * @property {BitbucketExportDestination|null} bitbucket - The Bitbucket export destination, or null if not available.
+ * @property {GithubExportDestination|null} github - The Github export destination, or null if not available.
+ * @property {GitlabExportDestination|null} gitlab - The Gitlab export destination, or null if not available.
+ * // @property {any|null} documentation - The documentation associated with the export destinations, or null if not available. Uncomment if documentation model is provided.
+ * @property {string|null} webhookUrl - The webhook URL associated with the export destinations, or null if not available.
+ */
+export declare class ExportDestinations {
+    s3: S3ExportDestination | null;
+    azure: AzureExportDestination | null;
+    bitbucket: BitbucketExportDestination | null;
+    github: GithubExportDestination | null;
+    gitlab: GitlabExportDestination | null;
+    webhookUrl: string | null;
+    constructor(data: ExportDestinationsModel);
+    /**
+     * Determines whether there is a pull request (PR) destination available.
+     * @returns {boolean} - Returns true if any of the export destinations (azure, bitbucket, github, gitlab) is available.
+     */
+    get hasPRDestination(): boolean;
+}

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

@@ -0,0 +1,55 @@
+export type PipelineRemoteModel = {
+    id: string;
+    workspaceId: string;
+    designSystem: {
+        id: string;
+        meta: {
+            name: string;
+            description: string;
+        };
+    };
+    name: string;
+    isEnabled: boolean;
+    eventType: "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
+    exporterId: string;
+    destinations: {
+        webhookUrl: string | null;
+        documentation: {
+            environment: "Live" | "Preview";
+        } | null;
+        s3: Record<any, any> | null;
+        github: {
+            connectionId: string;
+            url: string;
+            branch: string;
+            relativePath: string;
+        } | null;
+        azure: {
+            connectionId: string;
+            organizationId: string;
+            projectId: string;
+            repositoryId: string;
+            branch: string;
+            relativePath: string;
+            url: string;
+        } | null;
+        gitlab: {
+            connectionId: string;
+            projectId: string;
+            branch: string;
+            relativePath: string;
+            url: string;
+        } | null;
+        bitbucket: {
+            connectionId: string;
+            workspaceSlug: string;
+            projectKey: string;
+            repoSlug: string;
+            branch: string;
+            relativePath: string;
+            url: string;
+        } | null;
+    };
+    brandId: string | null;
+    themeId: string | null;
+};

package/build/sdk-typescript/src/model/jobs/SDKImportJob.d.ts

@@ -1,9 +1,5 @@
 import { ImportJobOperation } from "../enums/SDKImportJobOperation";
 import { ImportJobState } from "../enums/SDKImportJobState";
-import { Source, SourceRemoteModel } from "../support/SDKSource";
-type SourceRemoteModelWithSourceId = Omit<SourceRemoteModel, "id"> & {
-    sourceId: string;
-};
 export type ImportJobRemoteModel = {
     id: string;
     designSystemId: string;
@@ -13,7 +9,7 @@ export type ImportJobRemoteModel = {
     state: ImportJobState;
     error?: string;
     operation: ImportJobOperation;
-    sources: Array<SourceRemoteModelWithSourceId>;
+    sourceIds: Array<string>;
 };
 export declare class ImportJob {
     /** Unique identifier of the job */
@@ -33,7 +29,6 @@ export declare class ImportJob {
     /** Job operation - Check or Import */
     operation: ImportJobOperation;
     /** All sources participating in this import job */
-    sources: Array<Source>;
+    sourceIds: Array<string>;
     constructor(model: ImportJobRemoteModel);
 }
-export {};

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

@@ -0,0 +1,21 @@
+import { CustomDomainErrorCode } from "../enums/SDKCustomDomainErrorCode";
+import { CustomDomainState } from "../enums/SDKCustomDomainState";
+export type CustomDomainRemoteModel = {
+    id: string;
+    designSystemId: string;
+    supernovaDomain: string;
+    customerDomain: string;
+    state: CustomDomainState;
+    error: string | null;
+    errorCode: CustomDomainErrorCode;
+};
+export declare class CustomDomain {
+    id: string;
+    designSystemId: string;
+    supernovaDomain: string;
+    customerDomain: string;
+    state: CustomDomainState;
+    error: string | null;
+    errorCode: CustomDomainErrorCode | null;
+    constructor(model: CustomDomainRemoteModel);
+}

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

@@ -1,3 +1,4 @@
+import { ImportWarningType } from "../enums/SDKCloudWarningType";
 import { SourceType } from "../enums/SDKSourceType";
 export type SourceRemoteModel = {
     type: SourceType;
@@ -46,14 +47,8 @@ export type SourceRemoteModelCloud = {
         isFailed: boolean;
         versionId: string;
         fileSize?: number;
-        warnings?: Array<{
-            warningType: string;
-        }>;
-    };
-    lastImportFramesResult?: {
-        sourceId: string;
-        isFailed: string;
-        error?: string;
+        warnings?: Array<SourceImportResultWarning>;
+        isFramesFailed: boolean;
         assetsInFile?: {
             frames: number;
             components: number;
@@ -63,6 +58,20 @@ export type SourceRemoteModelCloud = {
     ownerId: string;
     ownerUserName: string;
     state: string;
+    stats: {
+        tokens: number;
+        components: number;
+        assets: number;
+        frames: number;
+    };
+};
+export type SourceImportResultWarning = {
+    warningType: ImportWarningType;
+    componentId: string;
+    componentName: string;
+    styleId: string;
+    styleName: string;
+    unsupportedStyleValueType: string;
 };
 export type SourceRemoteModelTokensStudio = {
     connectionName: string;
@@ -109,6 +118,9 @@ export declare class Source {
     scope: SourceScope;
     get hasError(): boolean;
     get hasWarning(): boolean;
+    get isCloudAvailable(): boolean;
+    get isTokensStudioAvailable(): boolean;
+    get tokensStudioHasError(): boolean;
     constructor(model: SourceRemoteModel);
     /** Constructs representation that can be used to write full object to remote */
     toRemote(): SourceRemoteModel;

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

@@ -1,7 +1,9 @@
+import { SourceType } from "../../model/enums/SDKSourceType";
 export type TokenOriginModel = {
     id?: string;
     name?: string;
     sourceId?: string;
+    sourceType?: SourceType;
     referenceOriginId?: string;
     referencePersistentId?: string;
 };
@@ -9,6 +11,7 @@ export declare class TokenOrigin {
     id: string | null;
     name: string | null;
     sourceId: string | null;
+    sourceType?: SourceType | null;
     referenceOriginId?: string | null;
     referencePersistentId?: string | null;
     constructor(model: TokenOriginModel);

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

@@ -1,4 +1,5 @@
 import { DTTokenReferenceResolver } from "../../tools/design-tokens/utilities/SDKDTTokenReferenceResolver";
+import { TokenClassTypeMapToken } from "../../utils/TokenUtils";
 import { ElementProperty } from "../elements/SDKElementProperty";
 import { ElementPropertyValue } from "../elements/values/SDKElementPropertyValue";
 import { DimensionTokenType, TokenType } from "../enums/SDKTokenType";
@@ -7,7 +8,6 @@ import { DimensionTokenRemoteModel, TokenRemoteModel } from "./remote/SDKRemoteT
 import { AnyDimensionTokenRemoteValue } from "./remote/SDKRemoteTokenValue";
 import { Token } from "./SDKToken";
 import { AnyDimensionTokenValue, BorderWidthTokenValue, DimensionTokenValue, DurationTokenValue, FontSizeTokenValue, LetterSpacingTokenValue, LineHeightTokenValue, OpacityTokenValue, ParagraphSpacingTokenValue, RadiusTokenValue, SizeTokenValue, SpaceTokenValue, ZIndexTokenValue } from "./SDKTokenValue";
-import { TokenClassTypeMapToken } from "../../utils/TokenUtils";
 export declare class DimensionCategoryToken<T extends AnyDimensionTokenValue> extends Token {
     value: T;
     constructor(versionId: string, baseToken: TokenRemoteModel, value: T, alias: DimensionCategoryToken<T> | null, properties: Array<ElementProperty>, propertyValues: Array<ElementPropertyValue>);

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

@@ -1,13 +1,10 @@
 import { WorkspaceProfile, WorkspaceProfileRemoteModel, WorkspaceProfileTransportModel } from "./SDKWorkspaceProfile";
-import { WorkspaceSubscription, WorkspaceSubscriptionRemoteModel, WorkspaceSubscriptionTransportModel } from "./SDKWorkspaceSubscription";
 export type WorkspaceRemoteModel = {
     id: string;
-    subscription: WorkspaceSubscriptionRemoteModel;
     profile: WorkspaceProfileRemoteModel;
 };
 export type WorkspaceTransportModel = {
     id: string;
-    subscription: WorkspaceSubscriptionTransportModel;
     profile: WorkspaceProfileTransportModel;
 };
 export declare class Workspace {
@@ -15,8 +12,6 @@ export declare class Workspace {
     id: string;
     /** Workspace profile with all information about billing, workspace, avatars etc. */
     profile: WorkspaceProfile;
-    /** Workspace subscription configuration */
-    subscription: WorkspaceSubscription;
     constructor(model: WorkspaceRemoteModel);
     /** Constructs representation that can be used to write full object to remote */
     toRemote(): WorkspaceRemoteModel;

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

@@ -0,0 +1,31 @@
+import { UserRole } from "../enums/SDKUserRole";
+export type WorkspaceInvitationRemoteModel = {
+    id: string;
+    email: string;
+    createdAt: string;
+    resentAt?: string;
+    role: UserRole;
+    workspaceId: string;
+    invitedBy: string;
+};
+export type WorkspaceInvitationTransportModel = WorkspaceInvitationRemoteModel;
+export declare class WorkspaceInvitation {
+    /** Unique identifier of the invitation */
+    id: string;
+    /** Email address associated with the invitation */
+    email: string;
+    /** Date and time when the invitation was created */
+    createdAt: Date;
+    /** Date and time when the invitation was last resent, or null if never resent */
+    resentAt: Date | null;
+    /** Role assigned to the user being invited */
+    role: UserRole;
+    /** ID of the workspace associated with the invitation */
+    workspaceId: string;
+    /** User who sent the invitation */
+    invitedBy: string;
+    constructor(model: WorkspaceInvitationRemoteModel);
+    toRemote(): WorkspaceInvitationTransportModel;
+    toTransport(): WorkspaceInvitationTransportModel;
+    static fromTransport(model: WorkspaceInvitationTransportModel): WorkspaceInvitation;
+}