a2r/model/index.d.ts

A2R Framework

/// <reference types="node" />
import { CommandLineOptions, OptionDefinition as ArgRule } from 'command-line-args';
import { OptionDefinition as ArgDefinition } from 'command-line-usage';
/**
 * Type used to make one or multiple interface keys optional
 */
export declare type WithOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
export interface CommandArg {
    name: string;
    type: ArgRule['type'];
    typeLabel: ArgDefinition['typeLabel'];
    description: ArgDefinition['description'];
    required?: boolean;
}
export interface Command {
    name: string;
    description: string;
    args: CommandArg[];
    run: (info: RunningCommand) => Promise<void>;
}
export interface RunningCommand {
    commandName: string;
    argv: string[];
    options: CommandLineOptions;
}
export interface ParsedArgs {
    command: string | null;
    argv: string[];
}
/**
 * Response from terminal after executing command
 */
export interface CommandResponse {
    /**
     * Executed command
     * @type {string}
     * @memberof CommandResponse
     */
    command: string;
    /**
     * Args passed to command
     * @type {string}
     * @memberof CommandResponse
     */
    args: string;
    /**
     * Command exit code
     * @type {number}
     * @memberof CommandResponse
     */
    exitCode: number | null;
    /**
     * Command exit code
     * @type {number}
     * @memberof CommandResponse
     */
    closeCode: number | null;
    /**
     * Output from `stdout`
     * @type {string}
     * @memberof CommandResponse
     */
    stdout: string;
    /**
     * Error (if any)
     * @type {(Error | null)}
     * @memberof CommandResponse
     */
    error: Error | null;
    /**
     * Signal received on exit event (if any)
     * @type {(NodeJS.Signals | null)}
     * @memberof CommandResponse
     */
    exitSignal: NodeJS.Signals | null;
    /**
     * Signal received on close event (if any)
     * @type {(NodeJS.Signals | null)}
     * @memberof CommandResponse
     */
    closeSignal: NodeJS.Signals | null;
}
/**
 * Docker info relative to a project
 */
export interface DockerInfo {
    version: string;
    name: string;
    imageName: string;
    env?: {
        [key: string]: string | number;
    };
}
/**
 * Server info
 */
export interface ServerInfo extends DockerInfo {
    url?: string;
    watchFolders?: string[];
}
/**
 * Project info
 */
export interface ProjectInfo {
    type: 'next' | 'expo' | 'electron';
    path: string;
    dockerName?: string;
    dockerBase?: string;
    dockerWorkingDir?: string;
    baseProject?: string;
    env?: {
        [key: string]: string | number;
    };
}
export declare type RunningProjectInfo = WithOptional<Omit<Required<ProjectInfo>, 'env'>, 'baseProject'>;
/**
 * Database info
 */
export interface DatabaseInfo {
    url: string;
    name: string;
    version?: string;
}
/**
 * Solution info
 */
export interface SolutionInfo {
    version: string;
    projectName: string;
    productName?: string;
    productionDomain: string;
    projects: ProjectInfo[];
    devServer: ServerInfo;
    server: ServerInfo;
    db?: DatabaseInfo;
}
/**
 * Running server settings
 */
export interface ServerSettings {
    port: number;
    dockerName: string;
    dockerImage: string;
    serverPath: string;
}
/**
 * Live settings (when running `a2r start`)
 */
export interface DevSettings {
    server: ServerSettings;
    keys: {
        [key: string]: string;
    };
    activeProjects: RunningProjectInfo[];
}
/**
 * Basic interface for parsing `package.json`
 */
export interface PackageJson {
    name: string;
    productName?: string;
    dependencies?: {
        [key: string]: string;
    };
    devDependencies?: {
        [key: string]: string;
    };
}
export interface TsConfig {
    compilerOptions: {
        [key: string]: any;
    };
}
/**
 * Service info for docker-compose
 */
export interface DockerComposeService {
    image: string;
    volumes?: string[];
    ports?: string[];
    tty?: boolean;
    restart?: 'no' | 'always' | 'on-failure' | 'unless-stopped';
}
/**
 * Services dictionary for docker-compose
 */
export interface DockerComposeServices {
    [key: string]: DockerComposeService;
}
/**
 * Volume options info for docker-compose
 */
export interface DockerComposeVolumeOptions {
    type: 'none';
    device: string;
    o: 'bind';
}
/**
 * Volume info for docker-compose
 */
export interface DockerComposeVolume {
    driver: 'local';
    driver_opts: DockerComposeVolumeOptions;
}
/**
 * Volumes dictionary for docker-compose
 */
export interface DockerComposeVolumes {
    [key: string]: DockerComposeVolume;
}
/**
 * Info for docker-compose
 */
export interface DockerCompose {
    version: string;
    services: DockerComposeServices;
    volumes: DockerComposeVolumes;
}
export * from './auth';