komodo/types/types.d.ts

export interface Collection<T> {
  [index: string]: T;
}

export type BuildActionStates = Collection<BuildActionState>;
export type DeployActionStates = Collection<DeployActionState>;
export type ServerActionStates = Collection<ServerActionState>;
export type Servers = Collection<Server>;
export type Builds = Collection<Build>;
export type Deployments = Collection<Deployment>;

export type User = {
  _id?: string;
  username: string;
  permissions?: number;
  password?: string;
  githubID?: number;
  avatar?: string;
  enabled?: true; // users start out disabled and have to be enabled through admin
};

export type Action = {
  type: string;
  userID: string;
};

export type Log = {
  stdout?: string;
  stderr?: string;
};

export type Update = {
  _id?: string;
  buildID?: string;
  deploymentID?: string;
  pm2DeploymentID?: string;
  serverID?: string;
  operation: string;
  command: string;
  log: Log;
  timestamp: number;
  note: string;
  isError?: boolean;
  operator: string; // the userID or username
};

export type Server = {
  _id?: string;
  name: string;
  address: string;
  status?: "OK" | "Incorrect Password" | "Could Not Be Reached";
  enabled: boolean;
  isCore?: boolean;
  owners: string[];
  toNotify: string[];
  statsInterval?: number;
  // usage stats threshold
  cpuAlert?: number; // 0 - 100
  memAlert?: number; // 0 - 100
  diskAlert?: number; // 0 - 100
  // optional custom passkey
  passkey?: string;
  // optional instance info
  region?: string;
  instanceID?: string;
};

export type DockerBuildArgs = {
  buildPath: string; // build folder relative to repo root
  dockerfilePath?: string; // relative to buildPath
  account?: string;
};

// these are potentially dangerous but also useful
// maybe best for admins to add premade curated command strings, so user dev can't input them directly, only give path to run in.
export type Command = {
  name?: string;
  path?: string;
  command: string; // no cd and no sudo
};

export interface Build {
  _id?: string;
  name: string;
  pullName?: string; // used for git listener / folder name
  commands?: Command[];
  /* repo related */
  repo?: string;
  subfolder?: string; // subfolder of monorepo. uses sparse clone
  branch?: string;
  githubAccount?: string; // to gain access to private repos
  onClone?: Command;
  /* build related */
  cliBuild?: Command; // run shell commands on build, before docker build step if it exists
  dockerBuildArgs?: DockerBuildArgs; // provided if docker build
  dockerAccount?: string; // username
  owners: string[]; // userID / username
}

export type DeploymentGitConfig = {
  pullName?: string; // used for git listener / folder name
  repo?: string;
  branch?: string;
  subfolder?: string; // subfolder of repo to clone (uses sparse clone)
  githubAccount?: string;
  // repoMount?: string; // subfolder of repo to mount in container
  // containerMount?: string; // the file path to mount repo on inside the container
  onPull?: Command;
  onClone?: Command;
};

export type DockerRunArgs = {
  image?: string;
  containerName?: string; // also for auto pull of repo, will be set by time deployment created
  ports?: Conversion[];
  volumes?: Conversion[];
  environment?: EnvironmentVar[];
  network?: string;
  restart?: string;
  postImage?: string; // interpolated into run command after the image string
  containerUser?: string; // after -u in the run command
  dockerAccount?: string;
};

export interface Deployment extends DockerRunArgs {
  _id?: string;
  name: string;
  owners: string[];
  isCore?: boolean; // whether this deployment is monitor-core. only one per monitor system. set up with cli
  serverID?: string; // only added if running on periphery server
  buildID?: string; // if deploying a monitor build
  /* to manage repo for static frontend, mounted as a volume. locally in REPO_ROOT/containerName */
  repo?: string;
  branch?: string;
  subfolder?: string; // subfolder of repo to clone (uses sparse clone)
  githubAccount?: string;
  repoMount?: string; // subfolder of repo to mount in container
  containerMount?: string; // the file path to mount repo on inside the container
  onPull?: Command;
  onClone?: Command;
  // gitConfigs?: DeploymentGitConfig[];
  // running status
  status?: "not deployed" | "unknown" | ContainerStatus;
}

export interface Pm2Deployment extends DeploymentGitConfig {
  _id?: string;
  name: string;
  serverID: string;
  owners: string[];
}

export type Conversion = {
  local: string;
  container: string;
};

export type EnvironmentVar = {
  variable: string;
  value: string;
};

export type BuildActionState = {
  pulling: boolean;
  building: boolean;
  cloning: boolean;
  updating: boolean;
  deleting: boolean;
};

export type DeployActionState = {
  deploying: boolean;
  deleting: boolean;
  starting: boolean;
  stopping: boolean;
  updating: boolean;
  fullDeleting: boolean;
  pulling: boolean;
  recloning: boolean;
};

export type ServerActionState = {
  pruningImages: boolean;
  pruningNetworks: boolean;
  pruningContainers: boolean;
  deleting: boolean;
};

export type ContainerStatus = {
  name: string;
  Status: string;
  State: "created" | "running" | "exited" | "restarting";
};

export type Network = {
  // _id: string;
  name: string;
  driver: string;
};

export type EntityCollection = {
  _id?: string;
  name: string;
  deploymentIDs: string[];
  buildIDs: string[];
  owners: string[]; // userID
};

export type CommandLogError = {
  command: string;
  log: Log;
  isError: boolean;
};

export type PeripherySecrets = {
  PASSKEY: string;
  DOCKER_ACCOUNTS: {
    [
      username: string
    ]: string /* this is the password for the account (they don't use auth tokens) */;
  };
  GITHUB_ACCOUNTS: {
    [
      username: string
    ]: string /* this is a personal access token for the acct */;
  };
};

export type CoreSecrets = PeripherySecrets & {
  JWT: { SECRET: string };
  GITHUB_OAUTH: { ID: string; SECRET: string };
  SLACK_TOKEN: string;
  GITHUB_WEBHOOK_SECRET: string;
};

export type StoredStats = SystemStats & {
  _id?: string,
  serverID: string,
  ts: number,
}

export type SystemStats = {
  cpu: number;
  mem: MemStats;
  disk: DiskStats;
};

export type MemStats = {
  totalMemMb: number;
  usedMemMb: number;
  freeMemMb: number;
  usedMemPercentage: number;
  freeMemPercentage: number;
};

export type DiskStats = {
  totalGb: number;
  usedGb: number;
  freeGb: number;
  usedPercentage: number;
  freePercentage: number;
};

export type DockerStat = {
  BlockIO: string;
  CPUPerc: string;
  Container: string;
  ID: string;
  MemPerc: string;
  MemUsage: string;
  Name: string;
  NetIO: string;
  PIDs: string;
}

export type AccountAccess = {
  _id?: string;
  type: "github" | "docker";
  users: string[] // list of user usernames;
  username: string; // specifies the account corresponding to those defined in secrets;
}

export type PM2Process = {
  pid?: number;
  name?: string;
  status?: string;
  cpu?: number;
  memory?: number;
  uptime?: number;
  createdAt?: number;
  restarts?: number;
}