fluidtrends/carmel.sdk

import {
  IClass,
  UTF8,
  Path,
  Name,
  CommandArg,
  Module,
  ITemplate,
  Version,
  Id,
} from '.'
import { Target, ArtifactsKind } from './base'

export interface IData extends IClass {
  readonly raw: UTF8
  readonly isJson: boolean

  json(): any
  update(data: UTF8 | object): void
  append(data: UTF8 | object): void
}

export interface IFile extends IClass {
  readonly path?: Path
  readonly data: IData
  readonly exists: boolean

  remove(): IFile
  load(): UTF8 | JSON
  save(): void
  move(to: IFile): void
  copy(to: IFile): void
  link(file?: IFile): IFile | undefined
  update(data: UTF8 | object, mode?: number): void
}

export interface IDir extends IClass {
  readonly path?: Path
  readonly exists: boolean
  readonly files: Path[]
  readonly dirs: Path[]

  remove(): IDir
  copy(dir: IDir): IDir | undefined
  move(dir: IDir): IDir | undefined
  dir(dirpath: Path): IDir | undefined
  file(filepath: Path, check?: boolean): IFile | undefined
  make(): IDir | undefined
  link(dir?: IDir): IDir | undefined
}

export interface IScript extends IClass {
  readonly name: Name
  readonly target: Target
  readonly dir?: IDir
  readonly exists: boolean
  readonly module?: Module

  load(): Promise<IScript | undefined>
  exec(args?: CommandArg[]): Promise<any>
}

export interface ILogger extends IClass {
  readonly props: any
}

export interface IBundle extends IClass {
  readonly dir: IDir
  readonly id: Id
  readonly version: Version
  readonly exists: boolean

  load(): Promise<IBundle>
  loadArtifact(name: Name, kind: ArtifactsKind): Promise<any>
}