@travetto/app/src/types.ts

Application registration/management and run support.

import type { Closeable, Class } from '@travetto/base';
import type { FieldConfig } from '@travetto/schema';

type OrProm<T> = T | Promise<T>;

/** A pattern that can be waited on */
export type Waitable = { wait(): Promise<unknown> } | { on(event: 'close', cb: Function): unknown };

export type AppClass = {
  run(...args: unknown[]): OrProm<Waitable | Closeable | void | undefined>;
};

export type ApplicationParam = (Omit<FieldConfig, 'type' | 'match'> & { type: string, match?: { re: string } });

/**
 * The application's configuration
 */
export interface ApplicationConfig<T extends AppClass = AppClass> {
  name: string; // App name
  globalName: string; // Global name, for resolving in monorepos
  module: string;
  import: string; // Import for loading app
  description?: string;
  start: number; // Start of app
  codeStart: number; // The start of the code
  params: ApplicationParam[]; // List of params
  targetId: string; // The class id
  target?: Class<T>; // The actual class of the app
  generatedTime?: number;
}