dagger

# This file generated by `dagger_codegen`. Please DO NOT EDIT.
defmodule Dagger.Module do
  @moduledoc """
  A Dagger module.
  """

  use Dagger.Core.Base, kind: :object, name: "Module"

  alias Dagger.Core.Client
  alias Dagger.Core.QueryBuilder, as: QB

  @derive Dagger.ID
  @derive Dagger.Sync
  defstruct [:query_builder, :client]

  @type t() :: %__MODULE__{}

  @doc """
  Return the check defined by the module with the given name. Must match to exactly one check.

  > #### Experimental {: .warning}
  >
  > "This API is highly experimental and may be removed or replaced entirely."
  """
  @spec check(t(), String.t()) :: Dagger.Check.t()
  def check(%__MODULE__{} = module, name) do
    query_builder =
      module.query_builder |> QB.select("check") |> QB.put_arg("name", name)

    %Dagger.Check{
      query_builder: query_builder,
      client: module.client
    }
  end

  @doc """
  Return all checks defined by the module

  > #### Experimental {: .warning}
  >
  > "This API is highly experimental and may be removed or replaced entirely."
  """
  @spec checks(t(), [{:include, [String.t()]}]) :: Dagger.CheckGroup.t()
  def checks(%__MODULE__{} = module, optional_args \\ []) do
    query_builder =
      module.query_builder
      |> QB.select("checks")
      |> QB.maybe_put_arg("include", optional_args[:include])

    %Dagger.CheckGroup{
      query_builder: query_builder,
      client: module.client
    }
  end

  @doc """
  The dependencies of the module.
  """
  @spec dependencies(t()) :: {:ok, [Dagger.Module.t()]} | {:error, term()}
  def dependencies(%__MODULE__{} = module) do
    query_builder =
      module.query_builder |> QB.select("dependencies") |> QB.select("id")

    with {:ok, items} <- Client.execute(module.client, query_builder) do
      {:ok,
       for %{"id" => id} <- items do
         %Dagger.Module{
           query_builder:
             QB.query()
             |> QB.select("loadModuleFromID")
             |> QB.put_arg("id", id),
           client: module.client
         }
       end}
    end
  end

  @doc """
  The doc string of the module, if any
  """
  @spec description(t()) :: {:ok, String.t()} | {:error, term()}
  def description(%__MODULE__{} = module) do
    query_builder =
      module.query_builder |> QB.select("description")

    Client.execute(module.client, query_builder)
  end

  @doc """
  Enumerations served by this module.
  """
  @spec enums(t()) :: {:ok, [Dagger.TypeDef.t()]} | {:error, term()}
  def enums(%__MODULE__{} = module) do
    query_builder =
      module.query_builder |> QB.select("enums") |> QB.select("id")

    with {:ok, items} <- Client.execute(module.client, query_builder) do
      {:ok,
       for %{"id" => id} <- items do
         %Dagger.TypeDef{
           query_builder:
             QB.query()
             |> QB.select("loadTypeDefFromID")
             |> QB.put_arg("id", id),
           client: module.client
         }
       end}
    end
  end

  @doc """
  The generated files and directories made on top of the module source's context directory.
  """
  @spec generated_context_directory(t()) :: Dagger.Directory.t()
  def generated_context_directory(%__MODULE__{} = module) do
    query_builder =
      module.query_builder |> QB.select("generatedContextDirectory")

    %Dagger.Directory{
      query_builder: query_builder,
      client: module.client
    }
  end

  @doc """
  A unique identifier for this Module.
  """
  @spec id(t()) :: {:ok, Dagger.ModuleID.t()} | {:error, term()}
  def id(%__MODULE__{} = module) do
    query_builder =
      module.query_builder |> QB.select("id")

    Client.execute(module.client, query_builder)
  end

  @doc """
  Interfaces served by this module.
  """
  @spec interfaces(t()) :: {:ok, [Dagger.TypeDef.t()]} | {:error, term()}
  def interfaces(%__MODULE__{} = module) do
    query_builder =
      module.query_builder |> QB.select("interfaces") |> QB.select("id")

    with {:ok, items} <- Client.execute(module.client, query_builder) do
      {:ok,
       for %{"id" => id} <- items do
         %Dagger.TypeDef{
           query_builder:
             QB.query()
             |> QB.select("loadTypeDefFromID")
             |> QB.put_arg("id", id),
           client: module.client
         }
       end}
    end
  end

  @doc """
  The introspection schema JSON file for this module.

  This file represents the schema visible to the module's source code, including all core types and those from the dependencies.

  Note: this is in the context of a module, so some core types may be hidden.
  """
  @spec introspection_schema_json(t()) :: Dagger.File.t()
  def introspection_schema_json(%__MODULE__{} = module) do
    query_builder =
      module.query_builder |> QB.select("introspectionSchemaJSON")

    %Dagger.File{
      query_builder: query_builder,
      client: module.client
    }
  end

  @doc """
  The name of the module
  """
  @spec name(t()) :: {:ok, String.t()} | {:error, term()}
  def name(%__MODULE__{} = module) do
    query_builder =
      module.query_builder |> QB.select("name")

    Client.execute(module.client, query_builder)
  end

  @doc """
  Objects served by this module.
  """
  @spec objects(t()) :: {:ok, [Dagger.TypeDef.t()]} | {:error, term()}
  def objects(%__MODULE__{} = module) do
    query_builder =
      module.query_builder |> QB.select("objects") |> QB.select("id")

    with {:ok, items} <- Client.execute(module.client, query_builder) do
      {:ok,
       for %{"id" => id} <- items do
         %Dagger.TypeDef{
           query_builder:
             QB.query()
             |> QB.select("loadTypeDefFromID")
             |> QB.put_arg("id", id),
           client: module.client
         }
       end}
    end
  end

  @doc """
  The container that runs the module's entrypoint. It will fail to execute if the module doesn't compile.
  """
  @spec runtime(t()) :: Dagger.Container.t()
  def runtime(%__MODULE__{} = module) do
    query_builder =
      module.query_builder |> QB.select("runtime")

    %Dagger.Container{
      query_builder: query_builder,
      client: module.client
    }
  end

  @doc """
  The SDK config used by this module.
  """
  @spec sdk(t()) :: Dagger.SDKConfig.t() | nil
  def sdk(%__MODULE__{} = module) do
    query_builder =
      module.query_builder |> QB.select("sdk")

    %Dagger.SDKConfig{
      query_builder: query_builder,
      client: module.client
    }
  end

  @doc """
  Serve a module's API in the current session.

  Note: this can only be called once per session. In the future, it could return a stream or service to remove the side effect.
  """
  @spec serve(t(), [{:include_dependencies, boolean() | nil}]) :: :ok | {:error, term()}
  def serve(%__MODULE__{} = module, optional_args \\ []) do
    query_builder =
      module.query_builder
      |> QB.select("serve")
      |> QB.maybe_put_arg("includeDependencies", optional_args[:include_dependencies])

    case Client.execute(module.client, query_builder) do
      {:ok, _} -> :ok
      error -> error
    end
  end

  @doc """
  The source for the module.
  """
  @spec source(t()) :: Dagger.ModuleSource.t() | nil
  def source(%__MODULE__{} = module) do
    query_builder =
      module.query_builder |> QB.select("source")

    %Dagger.ModuleSource{
      query_builder: query_builder,
      client: module.client
    }
  end

  @doc """
  Forces evaluation of the module, including any loading into the engine and associated validation.
  """
  @spec sync(t()) :: {:ok, Dagger.Module.t()} | {:error, term()}
  def sync(%__MODULE__{} = module) do
    query_builder =
      module.query_builder |> QB.select("sync")

    with {:ok, id} <- Client.execute(module.client, query_builder) do
      {:ok,
       %Dagger.Module{
         query_builder:
           QB.query()
           |> QB.select("loadModuleFromID")
           |> QB.put_arg("id", id),
         client: module.client
       }}
    end
  end

  @doc """
  User-defined default values, loaded from local .env files.
  """
  @spec user_defaults(t()) :: Dagger.EnvFile.t()
  def user_defaults(%__MODULE__{} = module) do
    query_builder =
      module.query_builder |> QB.select("userDefaults")

    %Dagger.EnvFile{
      query_builder: query_builder,
      client: module.client
    }
  end

  @doc """
  Retrieves the module with the given description
  """
  @spec with_description(t(), String.t()) :: Dagger.Module.t()
  def with_description(%__MODULE__{} = module, description) do
    query_builder =
      module.query_builder
      |> QB.select("withDescription")
      |> QB.put_arg("description", description)

    %Dagger.Module{
      query_builder: query_builder,
      client: module.client
    }
  end

  @doc """
  This module plus the given Enum type and associated values
  """
  @spec with_enum(t(), Dagger.TypeDef.t()) :: Dagger.Module.t()
  def with_enum(%__MODULE__{} = module, enum) do
    query_builder =
      module.query_builder |> QB.select("withEnum") |> QB.put_arg("enum", Dagger.ID.id!(enum))

    %Dagger.Module{
      query_builder: query_builder,
      client: module.client
    }
  end

  @doc """
  This module plus the given Interface type and associated functions
  """
  @spec with_interface(t(), Dagger.TypeDef.t()) :: Dagger.Module.t()
  def with_interface(%__MODULE__{} = module, iface) do
    query_builder =
      module.query_builder
      |> QB.select("withInterface")
      |> QB.put_arg("iface", Dagger.ID.id!(iface))

    %Dagger.Module{
      query_builder: query_builder,
      client: module.client
    }
  end

  @doc """
  This module plus the given Object type and associated functions.
  """
  @spec with_object(t(), Dagger.TypeDef.t()) :: Dagger.Module.t()
  def with_object(%__MODULE__{} = module, object) do
    query_builder =
      module.query_builder
      |> QB.select("withObject")
      |> QB.put_arg("object", Dagger.ID.id!(object))

    %Dagger.Module{
      query_builder: query_builder,
      client: module.client
    }
  end
end

defimpl Jason.Encoder, for: Dagger.Module do
  def encode(module, opts) do
    {:ok, id} = Dagger.Module.id(module)
    Jason.Encode.string(id, opts)
  end
end

defimpl Nestru.Decoder, for: Dagger.Module do
  def decode_fields_hint(_struct, _context, id) do
    {:ok, Dagger.Client.load_module_from_id(Dagger.Global.dag(), id)}
  end
end