@supernova-studio/supernova-sdk-beta 0.7.17

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

@@ -0,0 +1,115 @@
+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;
+    brandId: string | null;
+    themeId: string | null;
+};
+/** 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;
+    /** The identifier of the brand used for this build */
+    brandId: string | null;
+    /** The identifier of the theme used for this build */
+    themeId: string | null;
+    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;
+    /**
+     * Returns the URL for published documentation associated with the export build.
+     * @returns {string|null} - The URL to the documentation, or null if not available.
+     */
+    get documentationUrl(): string | null;
+}

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

@@ -0,0 +1,84 @@
+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);
+}
+export type ExportBuildDocumentationResultModel = {
+    url: string;
+};
+/** The type definition for documentation build's result. */
+export declare class ExportBuildDocumentationResult {
+    /** The URL of documentation's website associated with the export build result. */
+    url: string;
+    constructor(data: ExportBuildDocumentationResultModel);
+}
+/**
+ * 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"
+}
+export 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;
+    documentation: ExportBuildDocumentationResult | 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 documentation build result, or null if not available */
+    documentation: ExportBuildDocumentationResult | null;
+    /** The error message, or null if not available */
+    error: string | null;
+    constructor(data: ExportBuildResultModel);
+}

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

@@ -0,0 +1,126 @@
+import { DocumentationEnvironment } from "../../enums/SDKDocumentationEnvironment";
+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 DocsExportDestinationModel = {
+    environment: DocumentationEnvironment;
+};
+/**
+ * Type definition for the data model of a documentation export destination.
+ * @typedef {Object} DocsExportDestinationModel
+ * @property {DocumentationEnvironment|null} environment - The environment of the docs export build.
+ */
+export declare class DocsExportDestination {
+    environment: DocumentationEnvironment;
+    constructor(data: DocsExportDestinationModel);
+}
+export type ExportDestinationsModel = {
+    s3: S3ExportDestination | null;
+    azure: AzureExportDestination | null;
+    bitbucket: BitbucketExportDestination | null;
+    github: GithubExportDestination | null;
+    gitlab: GitlabExportDestination | null;
+    documentation: DocsExportDestination | 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 {DocsExportDestination|null} documentation - The documentation associated with the export destinations, or null if not available.
+ * @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;
+    documentation: DocsExportDestination | 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/SDKRemoteAzureCodegenBranchModel.d.ts

@@ -0,0 +1,5 @@
+export type CodegenAzureBranchRemoteModel = {
+    name: string;
+    lastCommitId: string;
+    repositoryId: string;
+};

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

@@ -0,0 +1,5 @@
+export type CodegenAzureOrganizationRemoteModel = {
+    id: number;
+    name: string;
+    uri: string;
+};

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

@@ -0,0 +1,5 @@
+export type CodegenAzureProjectRemoteModel = {
+    id: number;
+    name: string;
+    organizationId: string;
+};

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

@@ -0,0 +1,9 @@
+export type CodegenAzureRepositoryRemoteModel = {
+    id: string;
+    name: string;
+    projectId: string;
+    forked: boolean;
+    defaultBranch?: string;
+    required: boolean;
+    url: string;
+};

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

@@ -0,0 +1,5 @@
+export type CodegenBitbucketBranchRemoteModel = {
+    name: string;
+    lastCommitId: string;
+    repoSlug: string;
+};

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

@@ -0,0 +1,4 @@
+export type CodegenBitbucketProjectRemoteModel = {
+    key: string;
+    name: string;
+};

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

@@ -0,0 +1,6 @@
+export type CodegenBitbucketRepositoryRemoteModel = {
+    slug: string;
+    name: string;
+    projectKey: string;
+    url: string;
+};

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

@@ -0,0 +1,4 @@
+export type CodegenBitbucketWorkspaceRemoteModel = {
+    slug: string;
+    name: string;
+};

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

@@ -0,0 +1,7 @@
+export type CodegenAccountRemoteModel = {
+    id: string;
+    accountType: "User" | "Organization";
+    handle: string;
+    installationUrl: string;
+    description?: string;
+};

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

@@ -0,0 +1,6 @@
+export type CodegenBranchRemoteModel = {
+    repository: string;
+    name: string;
+    lastCommitId: string;
+    protected: boolean;
+};

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

@@ -0,0 +1,8 @@
+export type CodegenConnectionRemoteModel = {
+    id: string;
+    ownerId: string;
+    customUrl: string;
+    name: string;
+    authType: string;
+    service: string;
+};

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

@@ -0,0 +1,17 @@
+export type CodegenRepositoryRemoteModel = {
+    id: number;
+    /** @deprecated use owner instead */
+    installationHandle: string;
+    /** @deprecated use name instead */
+    handle: string;
+    owner: string;
+    name: string;
+    fullName: string;
+    url: string;
+    description: string;
+    archived: boolean;
+    disabled: boolean;
+    forked: boolean;
+    private: boolean;
+    defaultBranch: string;
+};

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

@@ -0,0 +1,9 @@
+import { ConnectionProviders } from "../../enums/SDKConnectionProviders";
+export type ConnectionRemoteModel = {
+    id: string;
+    ownerId: string;
+    customUrl: string;
+    name: string;
+    authType: "PAT";
+    service: ConnectionProviders;
+};

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

@@ -0,0 +1,5 @@
+export type CodegenGitlabBranchRemoteModel = {
+    name: string;
+    lastCommitId: string;
+    repositoryId: string;
+};

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

@@ -0,0 +1,4 @@
+export type CodegenGitlabGroupRemoteModel = {
+    id: number;
+    name: string;
+};

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

@@ -0,0 +1,7 @@
+export type CodegenGitlabRepositoryRemoteModel = {
+    id: number;
+    name: string;
+    defaultBranch: string;
+    url: string;
+    cloneUrl: string;
+};

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

@@ -0,0 +1,57 @@
+import { ExportBuildModel } from "../exporter_builds/SDKExportBuild";
+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;
+    latestJobs: Array<ExportBuildModel> | null;
+};

package/build/sdk-typescript/src/model/groups/SDKAssetGroup.d.ts

@@ -0,0 +1,24 @@
+import { DesignComponentGroupRemoteModel } from "./SDKDesignComponentGroup";
+export declare class AssetGroup {
+    id: string;
+    persistentId: string;
+    brandId: string;
+    name: string;
+    description: string;
+    path: Array<string>;
+    subgroupIds: Array<string>;
+    isRoot: boolean;
+    childrenIds: Array<string>;
+    assetIds: Array<string>;
+    parentGroupId: string | null;
+    createdAt: Date | null;
+    updatedAt: Date | null;
+    isAssetGroup: boolean;
+    sourceId: string | null;
+    sourceName: string | null;
+    constructor(model: DesignComponentGroupRemoteModel);
+    addChild(groupId: string): void;
+    addChildren(groupsIds: Array<string>): void;
+    setPath(segments: Array<string>): void;
+    setParentGroupId(parentGroupId: string | null): void;
+}

package/build/sdk-typescript/src/model/groups/SDKComponentGroup.d.ts

@@ -0,0 +1,40 @@
+export type ComponentGroupRemoteModel = {
+    id: string;
+    brandId: string;
+    designSystemVersionId: string;
+    persistentId: string;
+    isRoot: boolean;
+    meta: {
+        name: string;
+        description: string;
+    };
+    childrenIds: string[];
+    createdAt?: string;
+    updatedAt?: string;
+    parentId?: string;
+};
+export declare class ComponentGroup {
+    id: string;
+    idInVersion: string;
+    brandId: string;
+    designSystemVersionId: string;
+    name: string;
+    description: string;
+    path: Array<string>;
+    subgroupIds: Array<string>;
+    isRoot: boolean;
+    childrenIds: Array<string>;
+    componentIds: Array<string>;
+    parentGroupId: string | null;
+    sortOrder: number;
+    createdAt: Date | null;
+    updatedAt: Date | null;
+    constructor(model: ComponentGroupRemoteModel);
+    addChild(groupId: string): void;
+    addChildren(groupsIds: Array<string>): void;
+    setPath(segments: Array<string>): void;
+    setParentGroupId(parentGroupId: string | null): void;
+    setSortOrder(order: number): void;
+    toWriteObject(): ComponentGroupRemoteModel;
+    toMutatedObject(childrenIds: Array<string>): ComponentGroup;
+}

package/build/sdk-typescript/src/model/groups/SDKDesignComponentGroup.d.ts

@@ -0,0 +1,33 @@
+export type DesignComponentGroupRemoteModel = {
+    id: string;
+    designSystemVersionId: string;
+    persistentId: string;
+    brandId: string;
+    isRoot: boolean;
+    meta: {
+        name: string;
+        description: string;
+    };
+    childrenIds: string[];
+    createdAt?: string;
+    updatedAt?: string;
+};
+export declare class DesignComponentGroup {
+    id: string;
+    brandId: string;
+    name: string;
+    description: string;
+    path: Array<string>;
+    subgroupIds: Array<string>;
+    isRoot: boolean;
+    childrenIds: Array<string>;
+    componentIds: Array<string>;
+    parentGroupId: string | null;
+    createdAt: Date | null;
+    updatedAt: Date | null;
+    constructor(model: DesignComponentGroupRemoteModel);
+    addChild(groupId: string): void;
+    addChildren(groupsIds: Array<string>): void;
+    setPath(segments: Array<string>): void;
+    setParentGroupId(parentGroupId: string | null): void;
+}

package/build/sdk-typescript/src/model/groups/SDKTokenGroup.d.ts

@@ -0,0 +1,43 @@
+import { TokenType } from "../enums/SDKTokenType";
+export type TokenGroupRemoteModel = {
+    id?: string;
+    parentId?: string;
+    brandId: string;
+    tokenType: TokenType;
+    designSystemVersionId: string;
+    persistentId?: string;
+    isRoot: boolean;
+    meta: {
+        name: string;
+        description: string;
+    };
+    childrenIds: string[];
+    createdAt?: string;
+    updatedAt?: string;
+};
+export declare class TokenGroup {
+    id: string;
+    idInVersion: string;
+    brandId: string;
+    designSystemVersionId: string;
+    name: string;
+    description: string;
+    path: Array<string>;
+    subgroupIds: Array<string>;
+    tokenType: TokenType;
+    isRoot: boolean;
+    childrenIds: Array<string>;
+    tokenIds: Array<string>;
+    parentGroupId: string | null;
+    sortOrder: number;
+    createdAt: Date | null;
+    updatedAt: Date | null;
+    constructor(model: TokenGroupRemoteModel);
+    addChild(groupId: string): void;
+    addChildren(groupsIds: Array<string>): void;
+    setPath(segments: Array<string>): void;
+    setParentGroupId(parentGroupId: string | null): void;
+    setSortOrder(order: number): void;
+    toWriteObject(): TokenGroupRemoteModel;
+    toMutatedObject(childrenIds: Array<string>): TokenGroup;
+}