@dagger.io/dagger 0.18.18 → 0.19.0

package/dist/src/api/client.gen.js

@@ -505,6 +505,99 @@ function TypeDefKindNameToValue(name) {
             return name;
     }
 }
+/**
+ * A standardized address to load containers, directories, secrets, and other object types. Address format depends on the type, and is validated at type selection.
+ */
+export class Address extends BaseClient {
+    _id = undefined;
+    _value = undefined;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(ctx, _id, _value) {
+        super(ctx);
+        this._id = _id;
+        this._value = _value;
+    }
+    /**
+     * A unique identifier for this Address.
+     */
+    id = async () => {
+        if (this._id) {
+            return this._id;
+        }
+        const ctx = this._ctx.select("id");
+        const response = await ctx.execute();
+        return response;
+    };
+    /**
+     * Load a container from the address.
+     */
+    container = () => {
+        const ctx = this._ctx.select("container");
+        return new Container(ctx);
+    };
+    /**
+     * Load a directory from the address.
+     */
+    directory = (opts) => {
+        const ctx = this._ctx.select("directory", { ...opts });
+        return new Directory(ctx);
+    };
+    /**
+     * Load a file from the address.
+     */
+    file = (opts) => {
+        const ctx = this._ctx.select("file", { ...opts });
+        return new File(ctx);
+    };
+    /**
+     * Load a git ref (branch, tag or commit) from the address.
+     */
+    gitRef = () => {
+        const ctx = this._ctx.select("gitRef");
+        return new GitRef(ctx);
+    };
+    /**
+     * Load a git repository from the address.
+     */
+    gitRepository = () => {
+        const ctx = this._ctx.select("gitRepository");
+        return new GitRepository(ctx);
+    };
+    /**
+     * Load a secret from the address.
+     */
+    secret = () => {
+        const ctx = this._ctx.select("secret");
+        return new Secret(ctx);
+    };
+    /**
+     * Load a service from the address.
+     */
+    service = () => {
+        const ctx = this._ctx.select("service");
+        return new Service(ctx);
+    };
+    /**
+     * Load a local socket from the address.
+     */
+    socket = () => {
+        const ctx = this._ctx.select("socket");
+        return new Socket(ctx);
+    };
+    /**
+     * The address value
+     */
+    value = async () => {
+        if (this._value) {
+            return this._value;
+        }
+        const ctx = this._ctx.select("value");
+        const response = await ctx.execute();
+        return response;
+    };
+}
 export class Binding extends BaseClient {
     _id = undefined;
     _asString = undefined;
@@ -535,6 +628,13 @@ export class Binding extends BaseClient {
         const response = await ctx.execute();
         return response;
     };
+    /**
+     * Retrieve the binding value, as type Address
+     */
+    asAddress = () => {
+        const ctx = this._ctx.select("asAddress");
+        return new Address(ctx);
+    };
     /**
      * Retrieve the binding value, as type CacheVolume
      */
@@ -612,13 +712,6 @@ export class Binding extends BaseClient {
         const ctx = this._ctx.select("asJSONValue");
         return new JSONValue(ctx);
     };
-    /**
-     * Retrieve the binding value, as type LLM
-     */
-    asLLM = () => {
-        const ctx = this._ctx.select("asLLM");
-        return new LLM(ctx);
-    };
     /**
      * Retrieve the binding value, as type Module
      */
@@ -676,7 +769,7 @@ export class Binding extends BaseClient {
         return new Socket(ctx);
     };
     /**
-     * The binding's string value
+     * Returns the binding's string value
      */
     asString = async () => {
         if (this._asString) {
@@ -687,7 +780,7 @@ export class Binding extends BaseClient {
         return response;
     };
     /**
-     * The digest of the binding value
+     * Returns the digest of the binding value
      */
     digest = async () => {
         if (this._digest) {
@@ -709,7 +802,7 @@ export class Binding extends BaseClient {
         return response;
     };
     /**
-     * The binding name
+     * Returns the binding name
      */
     name = async () => {
         if (this._name) {
@@ -720,7 +813,7 @@ export class Binding extends BaseClient {
         return response;
     };
     /**
-     * The binding type
+     * Returns the binding type
      */
     typeName = async () => {
         if (this._typeName) {
@@ -760,13 +853,15 @@ export class CacheVolume extends BaseClient {
  */
 export class Changeset extends BaseClient {
     _id = undefined;
+    _export = undefined;
     _sync = undefined;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx, _id, _sync) {
+    constructor(ctx, _id, _export, _sync) {
         super(ctx);
         this._id = _id;
+        this._export = _export;
         this._sync = _sync;
     }
     /**
@@ -809,6 +904,18 @@ export class Changeset extends BaseClient {
         const ctx = this._ctx.select("before");
         return new Directory(ctx);
     };
+    /**
+     * Applies the diff represented by this changeset to a path on the host.
+     * @param path Location of the copied directory (e.g., "logs/").
+     */
+    export = async (path) => {
+        if (this._export) {
+            return this._export;
+        }
+        const ctx = this._ctx.select("export", { path });
+        const response = await ctx.execute();
+        return response;
+    };
     /**
      * Return a snapshot containing only the created and modified files
      */
@@ -975,26 +1082,6 @@ export class Container extends BaseClient {
         const ctx = this._ctx.select("asTarball", { ...opts, __metadata: metadata });
         return new File(ctx);
     };
-    /**
-     * Initializes this container from a Dockerfile build.
-     * @param context Directory context used by the Dockerfile.
-     * @param opts.dockerfile Path to the Dockerfile to use.
-     * @param opts.target Target build stage to build.
-     * @param opts.buildArgs Additional build arguments.
-     * @param opts.secrets Secrets to pass to the build.
-     *
-     * They will be mounted at /run/secrets/[secret-name] in the build container
-     *
-     * They can be accessed in the Dockerfile using the "secret" mount type and mount path /run/secrets/[secret-name], e.g. RUN --mount=type=secret,id=my-secret curl [http://example.com?token=$(cat /run/secrets/my-secret)](http://example.com?token=$(cat /run/secrets/my-secret))
-     * @param opts.noInit If set, skip the automatic init process injected into containers created by RUN statements.
-     *
-     * This should only be used if the user requires that their exec processes be the pid 1 process in the container. Otherwise it may result in unexpected behavior.
-     * @deprecated Use `Directory.build` instead
-     */
-    build = (context, opts) => {
-        const ctx = this._ctx.select("build", { context, ...opts });
-        return new Container(ctx);
-    };
     /**
      * The combined buffered standard output and standard error stream of the last executed command
      *
@@ -1424,7 +1511,7 @@ export class Container extends BaseClient {
     /**
      * Return a new container snapshot, with a directory added to its filesystem
      * @param path Location of the written directory (e.g., "/tmp/directory").
-     * @param directory Identifier of the directory to write
+     * @param source Identifier of the directory to write
      * @param opts.exclude Patterns to exclude in the written directory (e.g. ["node_modules/**", ".gitignore", ".git/"]).
      * @param opts.include Patterns to include in the written directory (e.g. ["*.go", "go.mod", "go.sum"]).
      * @param opts.owner A user:group to set for the directory and its contents.
@@ -1434,8 +1521,8 @@ export class Container extends BaseClient {
      * If the group is omitted, it defaults to the same as the user.
      * @param opts.expand Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
      */
-    withDirectory = (path, directory, opts) => {
-        const ctx = this._ctx.select("withDirectory", { path, directory, ...opts });
+    withDirectory = (path, source, opts) => {
+        const ctx = this._ctx.select("withDirectory", { path, source, ...opts });
         return new Container(ctx);
     };
     /**
@@ -2239,7 +2326,7 @@ export class Directory extends BaseClient {
     /**
      * Return a snapshot with a directory added
      * @param path Location of the written directory (e.g., "/src/").
-     * @param directory Identifier of the directory to copy.
+     * @param source Identifier of the directory to copy.
      * @param opts.exclude Exclude artifacts that match the given pattern (e.g., ["node_modules/", ".git*"]).
      * @param opts.include Include only artifacts that match the given pattern (e.g., ["app/", "package.*"]).
      * @param opts.owner A user:group to set for the copied directory and its contents.
@@ -2248,8 +2335,8 @@ export class Directory extends BaseClient {
      *
      * If the group is omitted, it defaults to the same as the user.
      */
-    withDirectory = (path, directory, opts) => {
-        const ctx = this._ctx.select("withDirectory", { path, directory, ...opts });
+    withDirectory = (path, source, opts) => {
+        const ctx = this._ctx.select("withDirectory", { path, source, ...opts });
         return new Directory(ctx);
     };
     /**
@@ -2402,7 +2489,6 @@ export class Engine extends BaseClient {
  */
 export class EngineCache extends BaseClient {
     _id = undefined;
-    _keepBytes = undefined;
     _maxUsedSpace = undefined;
     _minFreeSpace = undefined;
     _prune = undefined;
@@ -2411,10 +2497,9 @@ export class EngineCache extends BaseClient {
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx, _id, _keepBytes, _maxUsedSpace, _minFreeSpace, _prune, _reservedSpace, _targetSpace) {
+    constructor(ctx, _id, _maxUsedSpace, _minFreeSpace, _prune, _reservedSpace, _targetSpace) {
         super(ctx);
         this._id = _id;
-        this._keepBytes = _keepBytes;
         this._maxUsedSpace = _maxUsedSpace;
         this._minFreeSpace = _minFreeSpace;
         this._prune = _prune;
@@ -2439,18 +2524,6 @@ export class EngineCache extends BaseClient {
         const ctx = this._ctx.select("entrySet", { ...opts });
         return new EngineCacheEntrySet(ctx);
     };
-    /**
-     * The maximum bytes to keep in the cache without pruning, after which automatic pruning may kick in.
-     * @deprecated Use minFreeSpace instead.
-     */
-    keepBytes = async () => {
-        if (this._keepBytes) {
-            return this._keepBytes;
-        }
-        const ctx = this._ctx.select("keepBytes");
-        const response = await ctx.execute();
-        return response;
-    };
     /**
      * The maximum bytes to keep in the cache without pruning.
      */
@@ -2831,14 +2904,14 @@ export class Env extends BaseClient {
         return response;
     };
     /**
-     * retrieve an input value by name
+     * Retrieves an input binding by name
      */
     input = (name) => {
         const ctx = this._ctx.select("input", { name });
         return new Binding(ctx);
     };
     /**
-     * return all input values for the environment
+     * Returns all input bindings provided to the environment
      */
     inputs = async () => {
         const ctx = this._ctx.select("inputs").select("id");
@@ -2846,20 +2919,43 @@ export class Env extends BaseClient {
         return response.map((r) => new Client(ctx.copy()).loadBindingFromID(r.id));
     };
     /**
-     * retrieve an output value by name
+     * Retrieves an output binding by name
      */
     output = (name) => {
         const ctx = this._ctx.select("output", { name });
         return new Binding(ctx);
     };
     /**
-     * return all output values for the environment
+     * Returns all declared output bindings for the environment
      */
     outputs = async () => {
         const ctx = this._ctx.select("outputs").select("id");
         const response = await ctx.execute();
         return response.map((r) => new Client(ctx.copy()).loadBindingFromID(r.id));
     };
+    /**
+     * Create or update a binding of type Address in the environment
+     * @param name The name of the binding
+     * @param value The Address value to assign to the binding
+     * @param description The purpose of the input
+     */
+    withAddressInput = (name, value, description) => {
+        const ctx = this._ctx.select("withAddressInput", {
+            name,
+            value,
+            description,
+        });
+        return new Env(ctx);
+    };
+    /**
+     * Declare a desired Address output to be assigned in the environment
+     * @param name The name of the binding
+     * @param description A description of the desired value of the binding
+     */
+    withAddressOutput = (name, description) => {
+        const ctx = this._ctx.select("withAddressOutput", { name, description });
+        return new Env(ctx);
+    };
     /**
      * Create or update a binding of type CacheVolume in the environment
      * @param name The name of the binding
@@ -2948,6 +3044,15 @@ export class Env extends BaseClient {
         const ctx = this._ctx.select("withContainerOutput", { name, description });
         return new Env(ctx);
     };
+    /**
+     * Installs the current module into the environment, exposing its functions to the model
+     *
+     * Contextual path arguments will be populated using the environment's workspace.
+     */
+    withCurrentModule = () => {
+        const ctx = this._ctx.select("withCurrentModule");
+        return new Env(ctx);
+    };
     /**
      * Create or update a binding of type Directory in the environment
      * @param name The name of the binding
@@ -3105,22 +3210,14 @@ export class Env extends BaseClient {
         return new Env(ctx);
     };
     /**
-     * Create or update a binding of type LLM in the environment
-     * @param name The name of the binding
-     * @param value The LLM value to assign to the binding
-     * @param description The purpose of the input
-     */
-    withLLMInput = (name, value, description) => {
-        const ctx = this._ctx.select("withLLMInput", { name, value, description });
-        return new Env(ctx);
-    };
-    /**
-     * Declare a desired LLM output to be assigned in the environment
-     * @param name The name of the binding
-     * @param description A description of the desired value of the binding
+     * Installs a module into the environment, exposing its functions to the model
+     *
+     * Contextual path arguments will be populated using the environment's workspace.
      */
-    withLLMOutput = (name, description) => {
-        const ctx = this._ctx.select("withLLMOutput", { name, description });
+    withModule = (module_) => {
+        const ctx = this._ctx.select("withModule", {
+            module: module_,
+        });
         return new Env(ctx);
     };
     /**
@@ -3320,7 +3417,7 @@ export class Env extends BaseClient {
         return new Env(ctx);
     };
     /**
-     * Create or update an input value of type string
+     * Provides a string input binding to the environment
      * @param name The name of the binding
      * @param value The string value to assign to the binding
      * @param description The description of the input
@@ -3334,7 +3431,7 @@ export class Env extends BaseClient {
         return new Env(ctx);
     };
     /**
-     * Create or update an input value of type string
+     * Declares a desired string output binding
      * @param name The name of the binding
      * @param description The description of the output
      */
@@ -3342,6 +3439,25 @@ export class Env extends BaseClient {
         const ctx = this._ctx.select("withStringOutput", { name, description });
         return new Env(ctx);
     };
+    /**
+     * Returns a new environment with the provided workspace
+     * @param workspace The directory to set as the host filesystem
+     */
+    withWorkspace = (workspace) => {
+        const ctx = this._ctx.select("withWorkspace", { workspace });
+        return new Env(ctx);
+    };
+    /**
+     * Returns a new environment without any outputs
+     */
+    withoutOutputs = () => {
+        const ctx = this._ctx.select("withoutOutputs");
+        return new Env(ctx);
+    };
+    workspace = () => {
+        const ctx = this._ctx.select("workspace");
+        return new Directory(ctx);
+    };
     /**
      * Call the provided function with current Env.
      *
@@ -3400,20 +3516,22 @@ export class EnvFile extends BaseClient {
     /**
      * Lookup a variable (last occurrence wins) and return its value, or an empty string
      * @param name Variable name
+     * @param opts.raw Return the value exactly as written to the file. No quote removal or variable expansion
      */
-    get = async (name) => {
+    get = async (name, opts) => {
         if (this._get) {
             return this._get;
         }
-        const ctx = this._ctx.select("get", { name });
+        const ctx = this._ctx.select("get", { name, ...opts });
         const response = await ctx.execute();
         return response;
     };
     /**
      * Return all variables
+     * @param opts.raw Return values exactly as written to the file. No quote removal or variable expansion
      */
-    variables = async () => {
-        const ctx = this._ctx.select("variables").select("id");
+    variables = async (opts) => {
+        const ctx = this._ctx.select("variables", { ...opts }).select("id");
         const response = await ctx.execute();
         return response.map((r) => new Client(ctx.copy()).loadEnvVariableFromID(r.id));
     };
@@ -4460,32 +4578,6 @@ export class GitRepository extends BaseClient {
         const response = await ctx.execute();
         return response;
     };
-    /**
-     * Header to authenticate the remote with.
-     * @param header Secret used to populate the Authorization HTTP header
-     * @deprecated Use "httpAuthHeader" in the constructor instead.
-     */
-    withAuthHeader = (header) => {
-        const ctx = this._ctx.select("withAuthHeader", { header });
-        return new GitRepository(ctx);
-    };
-    /**
-     * Token to authenticate the remote with.
-     * @param token Secret used to populate the password during basic HTTP Authorization
-     * @deprecated Use "httpAuthToken" in the constructor instead.
-     */
-    withAuthToken = (token) => {
-        const ctx = this._ctx.select("withAuthToken", { token });
-        return new GitRepository(ctx);
-    };
-    /**
-     * Call the provided function with current GitRepository.
-     *
-     * This is useful for reusability and readability by not breaking the calling chain.
-     */
-    with = (arg) => {
-        return arg(this);
-    };
 }
 /**
  * Information about the host environment.
@@ -4566,18 +4658,6 @@ export class Host extends BaseClient {
         const ctx = this._ctx.select("service", { ports, ...opts });
         return new Service(ctx);
     };
-    /**
-     * Sets a secret given a user-defined name and the file path on the host, and returns the secret.
-     *
-     * The file is limited to a size of 512000 bytes.
-     * @param name The user defined name for this secret.
-     * @param path Location of the file to set as a secret.
-     * @deprecated setSecretFile is superceded by use of the secret API with file:// URIs
-     */
-    setSecretFile = (name, path) => {
-        const ctx = this._ctx.select("setSecretFile", { name, path });
-        return new Secret(ctx);
-    };
     /**
      * Creates a tunnel that forwards traffic from the host to a service.
      * @param service Service to send traffic from the tunnel.
@@ -4881,22 +4961,26 @@ export class JSONValue extends BaseClient {
 }
 export class LLM extends BaseClient {
     _id = undefined;
+    _hasPrompt = undefined;
     _historyJSON = undefined;
     _lastReply = undefined;
     _model = undefined;
     _provider = undefined;
+    _step = undefined;
     _sync = undefined;
     _tools = undefined;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx, _id, _historyJSON, _lastReply, _model, _provider, _sync, _tools) {
+    constructor(ctx, _id, _hasPrompt, _historyJSON, _lastReply, _model, _provider, _step, _sync, _tools) {
         super(ctx);
         this._id = _id;
+        this._hasPrompt = _hasPrompt;
         this._historyJSON = _historyJSON;
         this._lastReply = _lastReply;
         this._model = _model;
         this._provider = _provider;
+        this._step = _step;
         this._sync = _sync;
         this._tools = _tools;
     }
@@ -4934,6 +5018,17 @@ export class LLM extends BaseClient {
         const ctx = this._ctx.select("env");
         return new Env(ctx);
     };
+    /**
+     * Indicates whether there are any queued prompts or tool results to send to the model
+     */
+    hasPrompt = async () => {
+        if (this._hasPrompt) {
+            return this._hasPrompt;
+        }
+        const ctx = this._ctx.select("hasPrompt");
+        const response = await ctx.execute();
+        return response;
+    };
     /**
      * return the llm message history
      */
@@ -4965,7 +5060,7 @@ export class LLM extends BaseClient {
         return response;
     };
     /**
-     * synchronize LLM state
+     * Submit the queued prompt, evaluate any tool calls, queue their results, and keep going until the model ends its turn
      */
     loop = () => {
         const ctx = this._ctx.select("loop");
@@ -4993,6 +5088,14 @@ export class LLM extends BaseClient {
         const response = await ctx.execute();
         return response;
     };
+    /**
+     * Submit the queued prompt or tool call results, evaluate any tool calls, and queue their results
+     */
+    step = async () => {
+        const ctx = this._ctx.select("step");
+        const response = await ctx.execute();
+        return new Client(ctx.copy()).loadLLMFromID(response);
+    };
     /**
      * synchronize LLM state
      */
@@ -5019,6 +5122,20 @@ export class LLM extends BaseClient {
         const response = await ctx.execute();
         return response;
     };
+    /**
+     * Return a new LLM with the specified function no longer exposed as a tool
+     * @param typeName The type name whose function will be blocked
+     * @param function The function to block
+     *
+     * Will be converted to lowerCamelCase if necessary.
+     */
+    withBlockedFunction = (typeName, function_) => {
+        const ctx = this._ctx.select("withBlockedFunction", {
+            typeName,
+            function: function_,
+        });
+        return new LLM(ctx);
+    };
     /**
      * allow the LLM to interact with an environment via MCP
      */
@@ -5026,6 +5143,15 @@ export class LLM extends BaseClient {
         const ctx = this._ctx.select("withEnv", { env });
         return new LLM(ctx);
     };
+    /**
+     * Add an external MCP server to the LLM
+     * @param name The name of the MCP server
+     * @param service The MCP service to run and communicate with over stdio
+     */
+    withMCPServer = (name, service) => {
+        const ctx = this._ctx.select("withMCPServer", { name, service });
+        return new LLM(ctx);
+    };
     /**
      * swap out the llm model
      * @param model The model to use
@@ -5050,6 +5176,13 @@ export class LLM extends BaseClient {
         const ctx = this._ctx.select("withPromptFile", { file });
         return new LLM(ctx);
     };
+    /**
+     * Use a static set of tools for method calls, e.g. for MCP clients that do not support dynamic tool registration
+     */
+    withStaticTools = () => {
+        const ctx = this._ctx.select("withStaticTools");
+        return new LLM(ctx);
+    };
     /**
      * Add a system prompt to the LLM's environment
      * @param prompt The system prompt to send
@@ -5856,6 +5989,14 @@ export class ModuleSource extends BaseClient {
         const ctx = this._ctx.select("withUpdateDependencies", { dependencies });
         return new ModuleSource(ctx);
     };
+    /**
+     * Update one or more clients.
+     * @param clients The clients to update
+     */
+    withUpdatedClients = (clients) => {
+        const ctx = this._ctx.select("withUpdatedClients", { clients });
+        return new ModuleSource(ctx);
+    };
     /**
      * Remove the current blueprint from the module source.
      */
@@ -6077,6 +6218,13 @@ export class Client extends BaseClient {
     getGQLClient() {
         return this._ctx.getGQLClient();
     }
+    /**
+     * initialize an address to load directories, containers, secrets or other object types.
+     */
+    address = (value) => {
+        const ctx = this._ctx.select("address", { value });
+        return new Address(ctx);
+    };
     /**
      * Constructs a cache volume for a given cache key.
      * @param key A string identifier to target this cache volume (e.g., "modules-cache").
@@ -6102,6 +6250,18 @@ export class Client extends BaseClient {
         const ctx = this._ctx.select("container", { ...opts });
         return new Container(ctx);
     };
+    /**
+     * Returns the current environment
+     *
+     * When called from a function invoked via an LLM tool call, this will be the LLM's current environment, including any modifications made through calling tools. Env values returned by functions become the new environment for subsequent calls, and Changeset values returned by functions are applied to the environment's workspace.
+     *
+     * When called from a module function outside of an LLM, this returns an Env with the current module installed, and with the current module's source directory as its workspace.
+     * @experimental
+     */
+    currentEnv = () => {
+        const ctx = this._ctx.select("currentEnv");
+        return new Env(ctx);
+    };
     /**
      * The FunctionCall context that the SDK caller is currently executing in.
      *
@@ -6149,7 +6309,7 @@ export class Client extends BaseClient {
         return new Engine(ctx);
     };
     /**
-     * Initialize a new environment
+     * Initializes a new environment
      * @param opts.privileged Give the environment the same privileges as the caller: core API including host access, current module, and dependencies
      * @param opts.writable Allow new outputs to be declared and saved in the environment
      * @experimental
@@ -6255,6 +6415,13 @@ export class Client extends BaseClient {
         const ctx = this._ctx.select("llm", { ...opts });
         return new LLM(ctx);
     };
+    /**
+     * Load a Address from its ID.
+     */
+    loadAddressFromID = (id) => {
+        const ctx = this._ctx.select("loadAddressFromID", { id });
+        return new Address(ctx);
+    };
     /**
      * Load a Binding from its ID.
      */