# Configuration options specific to a single workadventure instance.

{ lib, pkgs, config, ... }:

with lib;
with pkgs;
{
  options = rec {
    backend = {
      httpPort = mkOption {
        default = 8081;
        type = types.ints.u16;
        description = "The TCP port the backend will bind to for http";
      };

      grpcPort = mkOption {
        default = 50051;
        type = types.ints.u16;
        description = "The TCP port the backend will bind to for grpc";
      };

      package = mkOption {
        default = workadventure.back;
        defaultText = "third_party.workadventure-nix.back";
        type = types.package;
        description = "Backend package to use";
      };
    };

    pusher = {
      port = mkOption {
        default = 8080;
        type = types.ints.u16;
        description = "The TCP port the pusher will bind to";
      };

      package = mkOption {
        default = workadventure.pusher;
        defaultText = "third_party.workadventure-nix.pusher";
        type = types.package;
        description = "Pusher package to use";
      };
    };

    frontend = {
      package = mkOption {
        default = workadventure.front;
        defaultText = "third_party.workadventure-nix.front";
        type = types.package;
        description = "Front package to use";
      };
      
      defaultMap = mkOption {
        default = null;
        defaultText = "not set";
        type = types.nullOr types.str;
        description = "The url to the default map, which will be loaded if none is given in the url. Must be a reachable url relative to the public map url defined in `maps.url`.";
      };
      
      settings = mkOption {
        default = {};
        type = types.attrsOf types.str;
        description = "Settings for workadventure's frontend.";
        example =  {
          stunServer = "stun:some.stunserver:3478";
          turnServer = "turn:some.turnserver";
          turnUser = "user";
          turnPassword = "password";
        };

      };

      urls = {
        api = mkOption {
          default = "/pusher";
          type = types.str;
          description = "The base url for the api, from the browser's point of view";
        };

        uploader = mkOption {
          default = "/uploader";
          type = types.str;
          description = "The base url for the uploader, from the browser's point of view";
        };

        admin = mkOption {
          default = "/pusher/admin";
          type = types.str;
          description = "The base url for the admin, from the browser's point of view";
        };

        maps = mkOption {
          default = "/maps";
          type = types.str;
          description = "The base url for serving maps, from the browser's point of view";
        };
      };
    };

    maps = {
      path = mkOption {
        default = workadventure.maps.outPath + "/workadventuremaps/";
        defaultText = "third_party.workadventure-nix.maps";
        type = types.path;
        description = "Maps package to use";
      };
    };

    nginx = {
      default = mkOption {
        default = false;
        type = types.bool;
        description = "Whether this instance will be the default one served by nginx";
      };

      domain = mkOption {
        default = "localhost";
        type = types.str;
        description = "The domain name to serve workadenture services under. Mutually exclusive with domains.X";
      };

      serveDefaultMaps = mkOption {
        default = true;
        type = types.bool;
        description = "Whether to serve the maps provided by workadventure";
      };

      domains = {
        back = mkOption {
          default = null;
          type = types.nullOr types.str;
          description = "The domain name to serve the backend under";
        };

        pusher = mkOption {
          default = null;
          type = types.nullOr types.str;
          description = "The domain name to serve the pusher under";
        };

        maps = mkOption {
          default = null;
          type = types.nullOr types.str;
          description = "The domain name to serve the maps under";
        };

        front = mkOption {
          default = null;
          type = types.nullOr types.str;
          description = "The domain name to serve the front under";
        };
      };
    };
  };
}