open Oar_core

val firebase_base :
  project_id:string -> ?requires:(libname list)
  -> string -> unit
(** [Oar_kit.firebase_base unitname]
    bases your website.

  [Oar_kit.firebase_base] collects all
  projections then deploys, as a form of
  {{: https://en.wikipedia.org/wiki/Unity_build}unity build}

  @example {[
    open Oar_kit

    let blpl = Firebase.libname "blueprint-execute-library"
    and misc = Firebase.libname "misc"

    let __base =
      let requires = [misc; blpl]
      and project_id = "baorepo" in
      Firebase_base.v "baorepo" ~requires ~project_id
  ]}
  
  @param project_id Firebase project ID
  @param requires Dependent units that
  this base requires ie. they must be
  done first before the base is marked
  done. Also simply called {i requires}.
  These requires are usually projections
  onto this base. Default is [[]] *)

val firebase_pdf :
  srcs:(
    [> \`File of fpath
    | \`Dir of fpath ] list ) ->
  prefix:string -> string -> unit
(** TODO *)

val firebase_static :
  public_dir:fpath -> prefix:string ->
  ?redirect_index:bool -> string -> unit
(** [Oar_kit.firebase_static libname]
  projects a statically-generated
  website onto your base website.

  @example {[ 
    open Oar_kit

    let blpl = Firebase.libname "blueprint-execute-library"

    let __blpl =
      let public_dir = ~/"_b0/b/user/front"
      and prefix = "~kinten/blueprint-execute-library"
      and redirect_index = false in
      Firebase_static.v blpl ~public_dir ~prefix ~redirect_index
  ]}
  
  @param public_dir Relative path to
  distribution content directory
  @param prefix Prefix of serving address
  @param redirect_index Will Firebase
  redirect all requests to handler of
  index aka. [/]? Default is [false]
  TODO(kinten) currently ignored, and
  how are we implementing this anyway?
  *)

val ( ~/ ) :
  string -> fpath
(** [~/"your-path-here"], or [Oar_kit.fpath_of_string],
  is a way to conveniently create
  relative file paths from string. Here
  "relative" means from current working
  directory. *)

val%sym.val [%sym.raw include%oar [%sym.hole]] :
  [%sym.raw oar_dir_expr] -> unit
(** [include%oar dir], or [Oar_kit.Topdirs.dir_use],
  directs the interpreter to evaluate
  the directory as specified by [dir],
  specificially evaluating the Oar
  script (e.g. [firebaserc]) contained
  in that directory.

  For valid [oar_dir_expr] for [dir],
  see {!section:oar-dir-expr} right
  below. *)

(** {1:oar-dir-expr Directory expressions} *)

val%sym.val [%sym.raw [%dir dirname]] : [%sym.raw oar_dir_expr]
(** TODO(kinten) *)

val%sym.val [%sym.raw [%file filename]] : [%sym.raw oar_dir_expr]
(** TODO(kinten) *)