/** Simple read-only file store. */
export interface ReadOnlyFileStore {
  /** Reads a file given a path, or an URI as returned by calling `save`. Returns file contents. */
  read(pathOrUrl: string): Promise<Buffer>;
  /** Downloads a file given a path, or an URI as returned by calling `save`. Saves file to local path. */
  download(pathOrUrlStr: string, destPath: string): Promise<void>;
  /** Returns whether a file at the given path or URI exists. */
  exists(pathOrUrl: string): Promise<boolean>;
}

export type FileStoreSaveOptions = { public?: boolean; metadata?: Record<string, string>; compress?: boolean };

/** Simple file store. */
export interface FileStore extends ReadOnlyFileStore {
  /**
   * Saves contents to the given path. Returns an URI that can be used later to `read` the file.
   * Default: `compress` is false unless explicitly set.
   */
  save(path: string, data: Buffer, opts?: FileStoreSaveOptions): Promise<string>;
  /**
   * Uploads contents from a local file. Returns an URI that can be used later to `read` the file.
   * Default: `compress` is true unless explicitly set to false.
   */
  upload(destPath: string, srcPath: string, opts?: FileStoreSaveOptions): Promise<string>;
}