@spec as_module(t()) :: Dagger.Module.t()

Load the source as a module. If this is a local source, the parent directory must have been provided during module source creation

@spec as_string(t()) :: {:ok, String.t()} | {:error, term()}

A human readable ref string representation of this module source.

@spec blueprint(t()) :: t()

The blueprint referenced by the module source.

@spec client_schema_introspection_json(t()) :: Dagger.File.t()

The client-facing introspection schema JSON file for this module source.

This is the schema consumed by client codegen: unlike introspectionSchemaJSON (the module-facing schema), it hides no core types and installs this module (reached via dag.<moduleName>) so a generated client can bind it. The module's dependencies are excluded: a client is generated for a single module plus core, not its dependency graph.

@spec clone_ref(t()) :: {:ok, String.t()} | {:error, term()}

The ref to clone the root of the git repo from. Only valid for git sources.

@spec commit(t()) :: {:ok, String.t()} | {:error, term()}

The resolved commit of the git repo this source points to.

@spec config_clients(t()) :: {:ok, [Dagger.ModuleConfigClient.t()]} | {:error, term()}

The clients generated for the module.

@spec config_exists(t()) :: {:ok, boolean()} | {:error, term()}

Whether an existing module config file was found.

@spec context_directory(t()) :: Dagger.Directory.t()

The full directory loaded for the module source, including the source code as a subdirectory.

@spec dependencies(t()) :: {:ok, [t()]} | {:error, term()}

The dependencies of the module source.

@spec digest(t()) :: {:ok, String.t()} | {:error, term()}

A content-hash of the module source. Module sources with the same digest will output the same generated context and convert into the same module instance.

@spec directory(t(), String.t()) :: Dagger.Directory.t()

The directory containing the module configuration and source code (source code may be in a subdir).

@spec engine_version(t()) :: {:ok, String.t()} | {:error, term()}

The engine version of the module.

@spec generate(t(), Dagger.Workspace.t()) :: Dagger.Workspace.t()

Return the supplied workspace with this module's generated context applied.

The workspace change baseline is preserved, so a later Workspace.changes call includes this generation together with any other edits made by the caller.

@spec generate_local_dependencies(t(), Dagger.Workspace.t()) :: Dagger.Changeset.t()

Generate this module's transitive local dependency closure and return the staged changes as a single changeset against the unstaged workspace root.

Each local dependency is generated by its own SDK against a workspace scoped to it, carrying the dependency's own already-generated dependencies. Remote (git) dependencies are assumed committed and skipped. Overlay the result onto the workspace before generating this module; it is not this module's own generated code.

@spec generated_context_changeset(t()) :: Dagger.Changeset.t()

The generated files and directories made on top of the module source's context directory, returned as a Changeset.

@spec generated_context_directory(t()) :: Dagger.Directory.t()

The generated files and directories made on top of the module source's context directory.

@spec html_repo_url(t()) :: {:ok, String.t()} | {:error, term()}

The URL to access the web view of the repository (e.g., GitHub, GitLab, Bitbucket).

@spec html_url(t()) :: {:ok, String.t()} | {:error, term()}

The URL to the source's git repo in a web browser. Only valid for git sources.

@spec id(t()) :: {:ok, String.t()} | {:error, term()}

A unique identifier for this ModuleSource.

@spec introspection_schema_json(t()) :: Dagger.File.t()

The introspection schema JSON file for this module source.

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 kind(t()) :: {:ok, Dagger.ModuleSourceKind.t()} | {:error, term()}

The kind of module source (currently local, git or dir).

@spec local_context_directory_path(t()) :: {:ok, String.t()} | {:error, term()}

The full absolute path to the context directory on the caller's host filesystem that this module source is loaded from. Only valid for local module sources.

@spec module_name(t()) :: {:ok, String.t()} | {:error, term()}

The name of the module, including any setting via the withName API.

@spec module_original_name(t()) :: {:ok, String.t()} | {:error, term()}

The original name of the module as read from the module config file (or set for the first time with the withName API).

@spec original_subpath(t()) :: {:ok, String.t()} | {:error, term()}

The original subpath used when instantiating this module source, relative to the context directory.

@spec pin(t()) :: {:ok, String.t()} | {:error, term()}

The pinned version of this module source.

@spec repo_root_path(t()) :: {:ok, String.t()} | {:error, term()}

The import path corresponding to the root of the git repo this source points to. Only valid for git sources.

@spec sdk(t()) :: {:ok, Dagger.SDKConfig.t() | nil} | {:error, term()}

The SDK configuration of the module.

@spec source_root_subpath(t()) :: {:ok, String.t()} | {:error, term()}

The path, relative to the context directory, that contains the module config.

@spec source_subpath(t()) :: {:ok, String.t()} | {:error, term()}

The path to the directory containing the module's source code, relative to the context directory.

@spec sync(t()) :: {:ok, t()} | {:error, term()}

Forces evaluation of the module source, including any loading into the engine and associated validation.

@spec toolchains(t()) :: {:ok, [t()]} | {:error, term()}

The toolchains referenced by the module source.

@spec updated_config_directory(t()) :: Dagger.Directory.t()

The module's dagger.json with any in-memory edits from with* APIs applied, as a diff relative to the source's context directory.

Unlike generatedContextDirectory, this does not run codegen and does not validate the engine version against the running engine, so it can be used to declare an engine requirement newer than the running engine. Loading or serving such a module still fails at moduleSource.asModule.

@spec user_defaults(t()) :: Dagger.EnvFile.t()

User-defined defaults read from local .env files

@spec version(t()) :: {:ok, String.t()} | {:error, term()}

The specified version of the git repo this source points to.

@spec with_blueprint(t(), t()) :: t()

Set a blueprint for the module source.

@spec with_client(t(), String.t(), String.t()) :: t()

Update the module source with a new client to generate.

@spec with_dependencies(t(), [String.t()]) :: t()

Append the provided dependencies to the module source's dependency list.

@spec with_engine_version(t(), String.t()) :: t()

Upgrade the engine version of the module to the given value.

@spec with_experimental_features(t(), [Dagger.ModuleSourceExperimentalFeature.t()]) ::
  t()

Enable the experimental features for the module source.

@spec with_includes(t(), [String.t()]) :: t()

Update the module source with additional include patterns for files+directories from its context that are required for building it

@spec with_name(t(), String.t()) :: t()

Update the module source with a new name.

@spec with_sdk(t(), String.t()) :: t()

Update the module source with a new SDK.

@spec with_source_subpath(t(), String.t()) :: t()

Update the module source with a new source subpath.

@spec with_toolchains(t(), [String.t()]) :: t()

Add toolchains to the module source.

@spec with_update_blueprint(t()) :: t()

Update the blueprint module to the latest version.

@spec with_update_dependencies(t(), [String.t()]) :: t()

Update one or more module dependencies.

@spec with_update_toolchains(t(), [String.t()]) :: t()

Update one or more toolchains.

@spec with_updated_clients(t(), [String.t()]) :: t()

Update one or more clients.

@spec without_blueprint(t()) :: t()

Remove the current blueprint from the module source.

@spec without_client(t(), String.t()) :: t()

Remove a client from the module source.

@spec without_dependencies(t(), [String.t()]) :: t()

Remove the provided dependencies from the module source's dependency list.

@spec without_experimental_features(t(), [Dagger.ModuleSourceExperimentalFeature.t()]) ::
  t()

Disable experimental features for the module source.

@spec without_toolchains(t(), [String.t()]) :: t()

Remove the provided toolchains from the module source.