feat: adds module interfaces for cleaning up internal API

lib/default.nix

@@ -1,5 +1,8 @@
 { pkgs, lib, plugins }:
 {
+  inherit (import ../modules { inherit pkgs; })
+    mkConfigResult mkEvalRequest mkPluginRequest;
+
   eval = import ./eval.nix { inherit pkgs lib plugins; };
 
   genConfig = import ./generate.nix { inherit pkgs lib plugins; };

modules/config_result.nix

@@ -0,0 +1,14 @@
+{ config, lib, ... }:
+with lib;
+{
+  options = {
+    file = mkOption {
+      type = types.package;
+      description = "The derivation for generating the configuration file";
+    };
+    shellHook = mkOption {
+      type = types.str;
+      description = "The shell hook for managing the generated file";
+    };
+  };
+}

modules/default.nix

@@ -0,0 +1,38 @@
+{ pkgs }:
+with pkgs.lib;
+{
+  mkConfigResult = { file, shellHook }:
+    evalModules ({
+      modules = [
+        ../modules/config.nix
+        {
+          inherit file shellHook;
+        }
+      ];
+    }).config;
+  mkEvalRequest = { pluginRequest, files, flags ? [ ], postBuild ? "", shellHookExtra ? "" }:
+    evalModules ({
+      modules = [
+        ../modules/eval_request.nix
+        {
+          inherit name configData;
+        }
+        (optionalAttrs (flags != [ ]) { inherit flags; })
+        (optionalAttrs (postBuild != "") { inherit postBuild; })
+        (optionalAttrs (shellHookExtra != "") { inherit shellHookExtra; })
+      ];
+    }).config;
+  mkPluginRequest = { name, configData, mode ? "", options ? { }, output ? "", type ? "" }:
+    evalModules ({
+      modules = [
+        ../modules/plugin_request.nix
+        {
+          inherit name configData;
+        }
+        (optionalAttrs (mode != "") { inherit mode; })
+        (optionalAttrs (options != { }) { inherit options; })
+        (optionalAttrs (output != "") { inherit output; })
+        (optionalAttrs (type != "") { inherit type; })
+      ];
+    }).config;
+}

modules/eval_request.nix

@@ -0,0 +1,29 @@
+{ config, lib, ... }:
+with lib;
+{
+  options = {
+    pluginRequest = mkOption {
+      type = types.submodule (import ./plugin_request.nix);
+      description = "The embedded plugin request";
+    };
+    files = mkOption {
+      type = types.listOf types.str;
+      description = "A list of input files to evaluate";
+    };
+    flags = mkOption {
+      type = types.attrs;
+      description = "An optional list of flags to pass to cue eval";
+      default = [ ];
+    };
+    postBuild = mkOption {
+      type = types.str;
+      description = "Shell code to run after executing cue eval";
+      default = "";
+    };
+    shellHookExtra = mkOption {
+      type = types.str;
+      description = "Shell code to run after configuration file is updated";
+      default = "";
+    };
+  };
+}

modules/plugin_request.nix

@@ -0,0 +1,34 @@
+{ config, lib, ... }:
+with lib;
+{
+  options = {
+    name = mkOption {
+      type = types.str;
+      description = "The plugin to use";
+    };
+    configData = mkOption {
+      type = types.anything;
+      description = "The raw configuration data";
+    };
+    mode = mkOption {
+      type = types.str;
+      description = "The output mode to use";
+      default = "link";
+    };
+    options = mkOption {
+      type = types.attrs;
+      description = "Additional options to pass to the plugin";
+      default = { };
+    };
+    output = mkOption {
+      type = types.str;
+      description = "The output path of the generated configuration file";
+      default = "";
+    };
+    type = mkOption {
+      type = types.str;
+      description = "The type of configuration to generate";
+      default = "default";
+    };
+  };
+}