vibez-core/src/vibez/modules/common/Common.ts

Utilities, types and common dependencies.

export interface Describable {
  name: string;
  description?: string;
  shortDescription: string;
}

export interface Indexable {
  id: string;
}

export interface IndexableCollection<T extends string> extends Indexable {
  readonly collection: T;
}

export interface JSONResponse<T> {
  code: number;
  error?: Error;
  message?: T;
  reason?: string;
}
export type Collections = "Errors";
export type VibezErrorPriority = "LOW" | "MEDIUM" | "HIGH";
export type ContextAction = "Read" | "Delete" | "Write";
export type EventKind = "Info" | "Warning" | "Error";

export interface CommonCollection<T extends Collections>
  extends IndexableCollection<T> {}

export interface Event<T extends EventKind> {
  kind: T;
  date: Date;
  description: string;
  actor: string;
  component: string;
}

export interface WritingResult {
  date: Date;
}

export interface Store<T> {
  write(entry: T): Promise<WritingResult>;
  read(filter?: any): Promise<Array<T>>;
}
export interface ValidationResult {
  passed: boolean;
  details: Array<string>;
}