@digital-ai/plugin-dai-release-common/dist/index.d.ts

Common functionalities for the dai-release plugin

import * as _backstage_plugin_permission_common from '@backstage/plugin-permission-common';

/***/
/**
 * Common functionalities for the dai-release plugin.
 *
 * @packageDocumentation
 */
/** @public */
type Folder = {
    id: string;
    type: string;
    $token: string;
    title: string;
    children: Folder[];
    $metadata: {
        security: {
            permissions: string[];
            teams: string[];
        };
    };
};
type FolderBackendResponse = {
    folders: Folder[];
    totalPages: number;
    totalElements: number;
};

/***/
/**
 * Common functionalities for the dai-release plugin.
 *
 * @packageDocumentation
 */
/** @public */
type ReleaseCountResults = {
    live: ReleaseCountResult;
    archived: ReleaseCountResult;
    all: ReleaseCountResult;
};
type ReleaseCountResult = {
    total: number;
    byStatus: StatusCount;
};
type StatusCount = {
    [key: string]: number;
};

/***/
/**
 * Common functionalities for the dai-release plugin.
 *
 * @packageDocumentation
 */
/** @public */
type ReleaseList = {
    total: number;
    releases: Release[];
};
type Release = {
    id: string;
    title: string;
    folder?: string;
    status: string;
    fromDate: number;
    endDate: number;
    releaseRedirectUri: string;
};

/***/
/**
 * Common functionalities for the dai-release plugin.
 *
 * @packageDocumentation
 */
/** @public */
interface Overview {
    id: string;
    type: string;
    title: string;
    status: string;
    kind: string;
}
interface ReleaseOverview extends Overview {
    startDate: number;
    endDate: number;
}
interface ReleaseFallBackOverview extends Overview {
    startDate: string;
    endDate: string;
    dueDate: string;
    scheduledStartDate: string;
}

/**
 * This permission is used to determine if a user is allowed to view the deploy plugin
 *
 * @public
 */
declare const daiReleaseViewPermission: _backstage_plugin_permission_common.BasicPermission;
/**
 * @public
 */
declare const daiReleasePermissions: _backstage_plugin_permission_common.BasicPermission[];

/** @public */
interface ReleaseInstanceConfig {
    name: string;
    host: string;
    token: string;
}

/***/
/**
 * Common functionalities for the dai-release plugin.
 *
 * @packageDocumentation
 */
/** @public */
type TemplateList = {
    templates: Template[];
};
type Template = {
    id: string;
    title: string;
    folder?: string;
    folderId: string;
    newReleaseRedirectUri: string;
    titleRedirectUri: string;
};
/** @public */
type TemplateOverview = {
    id: string;
    type: string;
    kind: string;
    title: string;
    tags?: string[];
};
type TemplateFolderGitConfig = {
    id: string;
    type: string;
    title: string;
    url: string;
};
type TemplateGitCommitVersion = {
    name: string;
    shortMessage: string;
    commiter: string;
    commitTime: number;
    commitHash: string;
};
type TemplateCommitVersions = {
    fetched: string;
    versions: TemplateGitCommitVersion[];
};
type TemplateGitMetaInfo = {
    folderId: string;
    url: string;
    name: string;
    shortMessage: string;
    committer: string;
    commitTime: number;
    commitHash: string;
};

/** @public */
type Categories = {
    totalElements: number;
    totalPages: number;
    size: number;
    number: number;
    numberOfElements: number;
    content: CategoriesContentList[];
    first: boolean;
    last: boolean;
};
type CategoriesContentList = {
    id: string;
    title: string;
    active: boolean;
    associatedWorkflowsCount: number;
    type: string;
};
type CategoriesContentActiveList = {
    id: string;
    title: string;
};
type ReleaseCategories = {
    activeCategory: CategoriesContentActiveList[];
};

/***/
/**
 * Common functionalities for the dai-release plugin.
 *
 * @packageDocumentation
 */
/** @public */
type Logo = {
    id: string;
    type: string;
    contentType: string;
};
type ScmTraceabilityData = {
    kind: string;
    commit: string;
    author: string;
    date: number;
    message: string;
    remote: string;
    fileName: string;
};
type WorkflowContent = {
    id: string;
    title: string;
    description: string;
    logo: Logo;
    author: string;
    tags: string[];
    categories: string[];
    scmTraceabilityData: ScmTraceabilityData;
    folderId: string;
    folderTitle: string;
    allowTargetFolderOverride: boolean;
    defaultTargetFolder: string;
    executions: number;
};
type WorkflowsOverview = {
    totalElements: number;
    totalPages: number;
    size: number;
    number: number;
    numberOfElements: number;
    content: WorkflowContent[];
    first: boolean;
    last: boolean;
};
type GitInfo = {
    commitId: string;
    repoLink: string;
};
type Workflow = {
    title: string;
    id: string;
    description: string;
    logoLink: string;
    author: string;
    folderTitle: string;
    categories: string[];
    git: GitInfo;
    defaultTargetFolder: string;
};
type WorkflowsList = {
    workflows: Workflow[];
    totalPages: number;
    totalElements: number;
};

export { type Categories, type CategoriesContentActiveList, type CategoriesContentList, type Folder, type FolderBackendResponse, type GitInfo, type Logo, type Overview, type Release, type ReleaseCategories, type ReleaseCountResult, type ReleaseCountResults, type ReleaseFallBackOverview, type ReleaseInstanceConfig, type ReleaseList, type ReleaseOverview, type ScmTraceabilityData, type StatusCount, type Template, type TemplateCommitVersions, type TemplateFolderGitConfig, type TemplateGitCommitVersion, type TemplateGitMetaInfo, type TemplateList, type TemplateOverview, type Workflow, type WorkflowContent, type WorkflowsList, type WorkflowsOverview, daiReleasePermissions, daiReleaseViewPermission };