@topgroup/diginext/dist/interfaces/SystemTypes.d.ts

A BUILD SERVER & CLI to deploy apps to any Kubernetes clusters.

import type express from "express";
import type BaseController from "../controllers/BaseController";
import type { IRole, IUser, IWorkspace, RoleRoute } from "../entities";
export interface AppRequest extends express.Request {
    query: any;
    user?: IUser;
    role?: IRole;
    workspace?: IWorkspace;
    ownership?: Ownership;
    controller?: BaseController;
}
export interface AppResponse extends express.Response {
    body?: string;
}
export interface Ownership {
    workspace: IWorkspace;
    owner: IUser;
}
export declare const logTypes: readonly ["debug", "warn", "error", "fatal"];
export type LogType = (typeof logTypes)[number];
export declare const retentionTypes: readonly ["limit", "duration"];
export type RetentionType = (typeof retentionTypes)[number];
export declare const requestMethodList: readonly ["GET", "POST", "PATCH", "DELETE"];
export type RequestMethodType = (typeof requestMethodList)[number];
export declare const cloudProviderList: readonly ["gcloud", "digitalocean", "custom"];
export type CloudProviderType = (typeof cloudProviderList)[number];
export declare const cloudDatabaseList: readonly ["mongodb", "mysql", "mariadb", "postgresql", "sqlserver", "sqlite", "redis", "dynamodb"];
export type CloudDatabaseType = (typeof cloudDatabaseList)[number];
export declare const registryProviderList: readonly ["gcloud", "digitalocean", "dockerhub"];
export type RegistryProviderType = (typeof registryProviderList)[number];
export declare const storageProviderList: readonly ["gcloud", "do_space", "aws_s3"];
export type StorageProviderType = (typeof storageProviderList)[number];
export declare const availableGitProviders: readonly ["bitbucket", "github"];
export type GitProviderType = (typeof availableGitProviders)[number];
export declare const availableResourceSizes: readonly ["none", "1x", "2x", "3x", "4x", "5x", "6x", "7x", "8x", "9x", "10x"];
/**
 * Container quota resources
 * @example
 * "none" - {}
 * "1x" - { requests: { cpu: "20m", memory: "128Mi" }, limits: { cpu: "20m", memory: 128Mi" } }
 * "2x" - { requests: { cpu: "40m", memory: "256Mi" }, limits: { cpu: "40m", memory: "256Mi" } }
 * "3x" - { requests: { cpu: "80m", memory: "512Mi" }, limits: { cpu: "80m", memory: "512Mi" } }
 * "4x" - { requests: { cpu: "160m", memory: "1024Mi" }, limits: { cpu: "160m", memory: "1024Mi" } }
 * "5x" - { requests: { cpu: "320m", memory: "2048Mi" }, limits: { cpu: "320m", memory: "2048Mi" } }
 * "6x" - { requests: { cpu: "640m", memory: "4058Mi" }, limits: { cpu: "640m", memory: "4058Mi" } }
 * "7x" - { requests: { cpu: "1280m", memory: "2048Mi" }, limits: { cpu: "1280m", memory: "2048Mi" } }
 * "8x" - { requests: { cpu: "2560m", memory: "8116Mi" }, limits: { cpu: "2560m", memory: "8116Mi" } }
 * "9x" - { requests: { cpu: "5120m", memory: "16232Mi" }, limits: { cpu: "5120m", memory: "16232Mi" } }
 * "10x" - { requests: { cpu: "10024m", memory: "32464Mi" }, limits: { cpu: "10024m", memory: "32464Mi" } }
 */
export type ResourceQuotaSize = (typeof availableResourceSizes)[number];
export declare const gitProviderDomain: {
    bitbucket: string;
    github: string;
    gitlab: string;
};
export declare const gitProviderDomainList: readonly ["bitbucket.org", "github.com"];
export type GitProviderDomain = (typeof gitProviderDomainList)[number];
export declare const buildStatusList: readonly ["pending", "start", "building", "failed", "success", "cancelled"];
export type BuildStatus = (typeof buildStatusList)[number];
export declare const deployStatusList: readonly ["pending", "in_progress", "failed", "success", "cancelled"];
export type DeployStatus = (typeof deployStatusList)[number];
export declare const backupStatusList: readonly ["start", "in_progress", "failed", "success", "cancelled"];
export type BackupStatus = (typeof backupStatusList)[number];
export declare const cronjobStatusList: readonly ["in_progress", "failed", "success", "cancelled"];
export type CronjobStatus = (typeof cronjobStatusList)[number];
/**
 * App status:
 * - `deploying`: App is being deployed.
 * - `healthy`: App's containers are running well.
 * - `partial_healthy`: Some of the app's containers are unhealthy.
 * - `undeployed`: App has not been deployed yet.
 * - `failed`: App's containers are unable to deploy due to image pull back-off or image pulling errors.
 * - `crashed`: App's containers are facing some unexpected errors.
 * - `unknown`: Other unknown errors.
 */
export declare const appStatusList: readonly ["deploying", "healthy", "partial_healthy", "undeployed", "failed", "crashed", "unknown"];
export type AppStatus = (typeof appStatusList)[number];
/**
 * @default "letsencrypt"
 */
export declare const sslIssuerList: readonly ["letsencrypt", "custom", "none"];
export type SslIssuer = (typeof sslIssuerList)[number];
export declare const buildPlatformList: readonly ["linux/arm64", "linux/amd64", "linux/amd64/v2", "linux/riscv64", "linux/ppc64le", "linux/s390x", "linux/386", "linux/mips64le", "linux/mips64", "linux/arm/v7", "linux/arm/v6"];
export type BuildPlatform = (typeof buildPlatformList)[number];
export declare const systemEventList: readonly ["build_status", "deploy_status", "dbbackup_status", "app_status", "project_status", "environment_status"];
export type SystemEvent = (typeof systemEventList)[number];
export declare const webhookChannelList: readonly ["http_callback", "email", "sms", "web_push", "push_notification", "instant_message"];
export type WebhookChannel = (typeof webhookChannelList)[number];
export declare const webhookEventStatusList: ("unknown" | "start" | "success" | "in_progress" | "failed" | "pending" | "building" | "cancelled" | "deploying" | "healthy" | "partial_healthy" | "undeployed" | "crashed")[];
export type WebhookEventStatus = (typeof webhookEventStatusList)[number];
/**
 * Credential fields / maskFields / sensitive fields
 */
export declare const credentialFields: string[];
/**
 * ROLES & PERMISSIONS: API Routes
 */
export declare const adminRoleRoutes: RoleRoute[];
export declare const moderatorRoleRoutes: RoleRoute[];
export declare const memberRoleRoutes: RoleRoute[];
export declare const guestRoleRoutes: RoleRoute[];
//# sourceMappingURL=SystemTypes.d.ts.map