Core API reference

The supported portable API is exposed by grenadine.core. Lower-level namespaces implement it and should not be required for ordinary use. Host constructors such as grenadine.host.jvm/host provide platform effects.

High-level operations

expand-deps

(expand-deps deps opts) ;=> expansion

Runs portable tools.deps-style tree expansion for arbitrary coordinate types. The required :coord-id, :coord-deps, and :compare-versions functions identify a coordinate, return its child dependency entries, and order two coordinates for the same library. :known-coordinate? and :base-lib may customize validation and exclusion matching.

:override-deps replaces coordinates at every occurrence, :default-deps fills missing coordinates, and :trace? true includes the traversal log and version map. The result contains selected :libs, stable first-inclusion :order, structured :warnings, and optional :trace. :on-warning receives each warning as it occurs.

install!

(install! deps opts) ;=> result

Resolves and installs a deps.edn-style Maven dependency map. Important options:

Option	Meaning
:host	Required effect-function map unless all repository stages are replaced.
:mediation	:newest, :nearest, or :tools-deps.
:repos	Ordered remote repositories; defaults to Central and Clojars.
:local-repo	Maven repository path.
:include-optional?	Include optional transitive dependencies.
:exclusions	Global exclusions as symbols, strings, or coordinate maps.
:source-roots?	Extract installed JARs and return source roots.
:source-libs	Restrict extraction to a set of library symbols.
:on-install	Callback invoked after each newly installed artifact.
:fetch-pom	Coordinate-to-POM function replacing repository POM lookup.
:pom-fn	Coordinate-to-effective-POM function replacing model construction.

The result contains:

Key	Value
:classpath	Local JAR paths in lock order.
:fetched	Artifacts downloaded by this call.
:cached	Artifacts already present locally.
:source-roots	Extracted roots, or nil when extraction was not requested.
:lock	Enriched deterministic lock data.
:resolution	Full graph-resolution result.
:warnings	Resolution and repository warnings.

Artifact or extraction failures throw ExceptionInfo with type :grenadine.core/install-failed or :grenadine.core/extraction-failed and a :failed vector in ex-data.

effective-pom

(effective-pom coords opts) ;=> effective-model

Builds one effective POM. coords is a map containing :group, :artifact, and :version. Supply either :fetch-pom or repository options including a host. The returned model contains :coords, :packaging, :properties, :dep-management, and :deps.

resolve-graph

(resolve-graph deps opts) ;=> resolution

Resolves and mediates without installing. Supply :pom-fn, :fetch-pom, or a repository-backed host. The result contains :selected, :graph, :omitted, :warnings, and :occurrences.

Model and lock operations

parse-pom

(parse-pom xml-text) ;=> raw-model

Parses Maven POM XML into Grenadine's canonical raw model without inheritance or interpolation.

interpolate

(interpolate text properties) ;=> string

Interpolates Maven-style ${property} references. Property cycles are reported as structured exceptions.

emit-lock

(emit-lock resolution opts) ;=> lock

Converts a resolution into stable version 1 lock data. :repos controls the repository list, :repo-fn selects an index for each coordinate, :pom-fn identifies pom packaging, and :integrity may supply GAV-keyed SHA-256 and size values.

fetch-lock!

(fetch-lock! lock opts) ;=> fetch-result

Installs every lock artifact. Returns :lock, :fetched, :cached, :failed, and :warnings; this lower-level function reports failures as data.

lock->classpath

(lock->classpath lock {:local-repo "/path/to/m2"}) ;=> [paths...]

Returns local artifact paths without touching the filesystem.

prepare-source-roots!

(prepare-source-roots! lock opts) ;=> {:roots [...] :failed [...]}

Extracts installed JARs into digest-keyed directories. The host is responsible for safe and atomic archive extraction.

Custom host contract

A host is a map of effect functions. Repository-backed installation uses:

Key	Contract
:http-get	URL to {:status integer :headers map :body bytes}.
:read-bytes	Path to bytes.
:write-bytes!	Path and bytes to a write effect.
:bytes->utf8	Bytes to text.
:digest	:sha1 or :sha256 and bytes to lowercase hexadecimal text.
:byte-count	Bytes to integer size.
:exists?	Path existence predicate.
:mkdirs!	Create a directory tree.
:atomic-move!	Move a completed temporary path into place.
:delete!	Remove a path.
:home-dir	Zero-argument home directory lookup.
:getenv	Environment lookup used for repository configuration.
:extract-jar!	Safely extract a JAR to a destination. Required only for source roots.

Missing required functions produce :grenadine.repo/incomplete-host with the missing key in ex-data.