arkit/src/types.ts

Visualises JavaScript, TypeScript and Flow codebases as meaningful and committable architecture diagrams

import { ConfigSchema } from "./schema";

export * from "./schema";

export const EMPTY_LAYER = Symbol("__empty_layer__");

export interface Components extends Map<string, Component> {}

export interface Layers
  extends Map<string | typeof EMPTY_LAYER, Set<Component>> {}

export enum Context {
  LAYER,
  RELATIONSHIP,
}

export interface Component {
  name: string;
  type: string;
  filename: string;
  imports: string[];
  layer: string | typeof EMPTY_LAYER;
  isImported: boolean;
  isClass: boolean;
  first?: boolean;
  last?: boolean;
}

export interface Imports {
  [file: string]: string[];
}

export interface Exports extends Array<string> {}

export interface File {
  imports: Imports;
  exports: Exports;
}

export interface Files {
  [file: string]: File;
}

export abstract class ConfigBase {
  readonly directory: string;
  readonly final: ConfigSchema;
  extensions: string[];
}

export class SavedString extends String {
  path?: string;
}