@dagger.io/dagger 0.18.18 → 0.19.0

package/dist/src/api/client.gen.d.ts

@@ -14,6 +14,22 @@ declare class BaseClient {
      */
     constructor(_ctx?: Context);
 }
+export type AddressDirectoryOpts = {
+    exclude?: string[];
+    include?: string[];
+    noCache?: boolean;
+};
+export type AddressFileOpts = {
+    exclude?: string[];
+    include?: string[];
+    noCache?: boolean;
+};
+/**
+ * The `AddressID` scalar type represents an identifier for an object of type Address.
+ */
+export type AddressID = string & {
+    __AddressID: never;
+};
 /**
  * The `BindingID` scalar type represents an identifier for an object of type Binding.
  */
@@ -115,34 +131,6 @@ export type ContainerAsTarballOpts = {
      */
     mediaTypes?: ImageMediaTypes;
 };
-export type ContainerBuildOpts = {
-    /**
-     * Path to the Dockerfile to use.
-     */
-    dockerfile?: string;
-    /**
-     * Target build stage to build.
-     */
-    target?: string;
-    /**
-     * Additional build arguments.
-     */
-    buildArgs?: BuildArg[];
-    /**
-     * 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))
-     */
-    secrets?: Secret[];
-    /**
-     * 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.
-     */
-    noInit?: boolean;
-};
 export type ContainerDirectoryOpts = {
     /**
      * Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
@@ -862,6 +850,18 @@ export type EnumTypeDefID = string & {
 export type EnumValueTypeDefID = string & {
     __EnumValueTypeDefID: never;
 };
+export type EnvFileGetOpts = {
+    /**
+     * Return the value exactly as written to the file. No quote removal or variable expansion
+     */
+    raw?: boolean;
+};
+export type EnvFileVariablesOpts = {
+    /**
+     * Return values exactly as written to the file. No quote removal or variable expansion
+     */
+    raw?: boolean;
+};
 /**
  * The `EnvFileID` scalar type represents an identifier for an object of type EnvFile.
  */
@@ -1714,6 +1714,57 @@ export type __TypeFieldsOpts = {
 export type __TypeInputFieldsOpts = {
     includeDeprecated?: boolean;
 };
+/**
+ * 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 declare class Address extends BaseClient {
+    private readonly _id?;
+    private readonly _value?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(ctx?: Context, _id?: AddressID, _value?: string);
+    /**
+     * A unique identifier for this Address.
+     */
+    id: () => Promise<AddressID>;
+    /**
+     * Load a container from the address.
+     */
+    container: () => Container;
+    /**
+     * Load a directory from the address.
+     */
+    directory: (opts?: AddressDirectoryOpts) => Directory;
+    /**
+     * Load a file from the address.
+     */
+    file: (opts?: AddressFileOpts) => File;
+    /**
+     * Load a git ref (branch, tag or commit) from the address.
+     */
+    gitRef: () => GitRef;
+    /**
+     * Load a git repository from the address.
+     */
+    gitRepository: () => GitRepository;
+    /**
+     * Load a secret from the address.
+     */
+    secret: () => Secret;
+    /**
+     * Load a service from the address.
+     */
+    service: () => Service;
+    /**
+     * Load a local socket from the address.
+     */
+    socket: () => Socket;
+    /**
+     * The address value
+     */
+    value: () => Promise<string>;
+}
 export declare class Binding extends BaseClient {
     private readonly _id?;
     private readonly _asString?;
@@ -1729,6 +1780,10 @@ export declare class Binding extends BaseClient {
      * A unique identifier for this Binding.
      */
     id: () => Promise<BindingID>;
+    /**
+     * Retrieve the binding value, as type Address
+     */
+    asAddress: () => Address;
     /**
      * Retrieve the binding value, as type CacheVolume
      */
@@ -1773,10 +1828,6 @@ export declare class Binding extends BaseClient {
      * Retrieve the binding value, as type JSONValue
      */
     asJSONValue: () => JSONValue;
-    /**
-     * Retrieve the binding value, as type LLM
-     */
-    asLLM: () => LLM;
     /**
      * Retrieve the binding value, as type Module
      */
@@ -1810,11 +1861,11 @@ export declare class Binding extends BaseClient {
      */
     asSocket: () => Socket;
     /**
-     * The binding's string value
+     * Returns the binding's string value
      */
     asString: () => Promise<string>;
     /**
-     * The digest of the binding value
+     * Returns the digest of the binding value
      */
     digest: () => Promise<string>;
     /**
@@ -1822,11 +1873,11 @@ export declare class Binding extends BaseClient {
      */
     isNull: () => Promise<boolean>;
     /**
-     * The binding name
+     * Returns the binding name
      */
     name: () => Promise<string>;
     /**
-     * The binding type
+     * Returns the binding type
      */
     typeName: () => Promise<string>;
 }
@@ -1849,11 +1900,12 @@ export declare class CacheVolume extends BaseClient {
  */
 export declare class Changeset extends BaseClient {
     private readonly _id?;
+    private readonly _export?;
     private readonly _sync?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx?: Context, _id?: ChangesetID, _sync?: ChangesetID);
+    constructor(ctx?: Context, _id?: ChangesetID, _export?: string, _sync?: ChangesetID);
     /**
      * A unique identifier for this Changeset.
      */
@@ -1874,6 +1926,11 @@ export declare class Changeset extends BaseClient {
      * The older/lower snapshot to compare against.
      */
     before: () => Directory;
+    /**
+     * Applies the diff represented by this changeset to a path on the host.
+     * @param path Location of the copied directory (e.g., "logs/").
+     */
+    export: (path: string) => Promise<string>;
     /**
      * Return a snapshot containing only the created and modified files
      */
@@ -1968,23 +2025,6 @@ export declare class Container extends BaseClient {
      * Defaults to OCI, which is largely compatible with most recent container runtimes, but Docker may be needed for older runtimes without OCI support.
      */
     asTarball: (opts?: ContainerAsTarballOpts) => File;
-    /**
-     * 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: Directory, opts?: ContainerBuildOpts) => Container;
     /**
      * The combined buffered standard output and standard error stream of the last executed command
      *
@@ -2217,7 +2257,7 @@ export declare 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.
@@ -2227,7 +2267,7 @@ export declare 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: string, directory: Directory, opts?: ContainerWithDirectoryOpts) => Container;
+    withDirectory: (path: string, source: Directory, opts?: ContainerWithDirectoryOpts) => Container;
     /**
      * Set an OCI-style entrypoint. It will be included in the container's OCI configuration. Note, withExec ignores the entrypoint by default.
      * @param args Arguments of the entrypoint. Example: ["go", "run"].
@@ -2738,7 +2778,7 @@ export declare 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.
@@ -2747,7 +2787,7 @@ export declare class Directory extends BaseClient {
      *
      * If the group is omitted, it defaults to the same as the user.
      */
-    withDirectory: (path: string, directory: Directory, opts?: DirectoryWithDirectoryOpts) => Directory;
+    withDirectory: (path: string, source: Directory, opts?: DirectoryWithDirectoryOpts) => Directory;
     /**
      * Retrieves this directory plus the contents of the given file copied to the given path.
      * @param path Location of the copied file (e.g., "/file.txt").
@@ -2850,7 +2890,6 @@ export declare class Engine extends BaseClient {
  */
 export declare class EngineCache extends BaseClient {
     private readonly _id?;
-    private readonly _keepBytes?;
     private readonly _maxUsedSpace?;
     private readonly _minFreeSpace?;
     private readonly _prune?;
@@ -2859,7 +2898,7 @@ export declare class EngineCache extends BaseClient {
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx?: Context, _id?: EngineCacheID, _keepBytes?: number, _maxUsedSpace?: number, _minFreeSpace?: number, _prune?: Void, _reservedSpace?: number, _targetSpace?: number);
+    constructor(ctx?: Context, _id?: EngineCacheID, _maxUsedSpace?: number, _minFreeSpace?: number, _prune?: Void, _reservedSpace?: number, _targetSpace?: number);
     /**
      * A unique identifier for this EngineCache.
      */
@@ -2868,11 +2907,6 @@ export declare class EngineCache extends BaseClient {
      * The current set of entries in the cache
      */
     entrySet: (opts?: EngineCacheEntrySetOpts) => EngineCacheEntrySet;
-    /**
-     * The maximum bytes to keep in the cache without pruning, after which automatic pruning may kick in.
-     * @deprecated Use minFreeSpace instead.
-     */
-    keepBytes: () => Promise<number>;
     /**
      * The maximum bytes to keep in the cache without pruning.
      */
@@ -3047,21 +3081,34 @@ export declare class Env extends BaseClient {
      */
     id: () => Promise<EnvID>;
     /**
-     * retrieve an input value by name
+     * Retrieves an input binding by name
      */
     input: (name: string) => Binding;
     /**
-     * return all input values for the environment
+     * Returns all input bindings provided to the environment
      */
     inputs: () => Promise<Binding[]>;
     /**
-     * retrieve an output value by name
+     * Retrieves an output binding by name
      */
     output: (name: string) => Binding;
     /**
-     * return all output values for the environment
+     * Returns all declared output bindings for the environment
      */
     outputs: () => Promise<Binding[]>;
+    /**
+     * 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: string, value: Address, description: string) => Env;
+    /**
+     * 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: string, description: string) => Env;
     /**
      * Create or update a binding of type CacheVolume in the environment
      * @param name The name of the binding
@@ -3114,6 +3161,12 @@ export declare class Env extends BaseClient {
      * @param description A description of the desired value of the binding
      */
     withContainerOutput: (name: string, description: string) => Env;
+    /**
+     * 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: () => Env;
     /**
      * Create or update a binding of type Directory in the environment
      * @param name The name of the binding
@@ -3206,18 +3259,11 @@ export declare class Env extends BaseClient {
      */
     withJSONValueOutput: (name: string, description: string) => Env;
     /**
-     * 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: string, value: LLM, description: string) => Env;
-    /**
-     * 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: string, description: string) => Env;
+    withModule: (module_: Module_) => Env;
     /**
      * Create or update a binding of type ModuleConfigClient in the environment
      * @param name The name of the binding
@@ -3323,18 +3369,28 @@ export declare class Env extends BaseClient {
      */
     withSocketOutput: (name: string, description: string) => Env;
     /**
-     * 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
      */
     withStringInput: (name: string, value: string, description: string) => Env;
     /**
-     * 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
      */
     withStringOutput: (name: string, description: string) => Env;
+    /**
+     * Returns a new environment with the provided workspace
+     * @param workspace The directory to set as the host filesystem
+     */
+    withWorkspace: (workspace: Directory) => Env;
+    /**
+     * Returns a new environment without any outputs
+     */
+    withoutOutputs: () => Env;
+    workspace: () => Directory;
     /**
      * Call the provided function with current Env.
      *
@@ -3369,12 +3425,14 @@ export declare 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: (name: string) => Promise<string>;
+    get: (name: string, opts?: EnvFileGetOpts) => Promise<string>;
     /**
      * Return all variables
+     * @param opts.raw Return values exactly as written to the file. No quote removal or variable expansion
      */
-    variables: () => Promise<EnvVariable[]>;
+    variables: (opts?: EnvFileVariablesOpts) => Promise<EnvVariable[]>;
     /**
      * Add a variable
      * @param name Variable name
@@ -3935,24 +3993,6 @@ export declare class GitRepository extends BaseClient {
      * The URL of the git repository.
      */
     url: () => Promise<string>;
-    /**
-     * 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: Secret) => GitRepository;
-    /**
-     * 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: Secret) => GitRepository;
-    /**
-     * Call the provided function with current GitRepository.
-     *
-     * This is useful for reusability and readability by not breaking the calling chain.
-     */
-    with: (arg: (param: GitRepository) => GitRepository) => GitRepository;
 }
 /**
  * Information about the host environment.
@@ -4003,15 +4043,6 @@ export declare class Host extends BaseClient {
      * @param opts.host Upstream host to forward traffic to.
      */
     service: (ports: PortForward[], opts?: HostServiceOpts) => Service;
-    /**
-     * 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: string, path: string) => Secret;
     /**
      * Creates a tunnel that forwards traffic from the host to a service.
      * @param service Service to send traffic from the tunnel.
@@ -4176,16 +4207,18 @@ export declare class JSONValue extends BaseClient {
 }
 export declare class LLM extends BaseClient {
     private readonly _id?;
+    private readonly _hasPrompt?;
     private readonly _historyJSON?;
     private readonly _lastReply?;
     private readonly _model?;
     private readonly _provider?;
+    private readonly _step?;
     private readonly _sync?;
     private readonly _tools?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx?: Context, _id?: LLMID, _historyJSON?: JSON, _lastReply?: string, _model?: string, _provider?: string, _sync?: LLMID, _tools?: string);
+    constructor(ctx?: Context, _id?: LLMID, _hasPrompt?: boolean, _historyJSON?: JSON, _lastReply?: string, _model?: string, _provider?: string, _step?: LLMID, _sync?: LLMID, _tools?: string);
     /**
      * A unique identifier for this LLM.
      */
@@ -4202,6 +4235,10 @@ export declare class LLM extends BaseClient {
      * return the LLM's current environment
      */
     env: () => Env;
+    /**
+     * Indicates whether there are any queued prompts or tool results to send to the model
+     */
+    hasPrompt: () => Promise<boolean>;
     /**
      * return the llm message history
      */
@@ -4215,7 +4252,7 @@ export declare class LLM extends BaseClient {
      */
     lastReply: () => Promise<string>;
     /**
-     * synchronize LLM state
+     * Submit the queued prompt, evaluate any tool calls, queue their results, and keep going until the model ends its turn
      */
     loop: () => LLM;
     /**
@@ -4226,6 +4263,10 @@ export declare class LLM extends BaseClient {
      * return the provider used by the llm
      */
     provider: () => Promise<string>;
+    /**
+     * Submit the queued prompt or tool call results, evaluate any tool calls, and queue their results
+     */
+    step: () => Promise<LLM>;
     /**
      * synchronize LLM state
      */
@@ -4238,10 +4279,24 @@ export declare class LLM extends BaseClient {
      * print documentation for available tools
      */
     tools: () => Promise<string>;
+    /**
+     * 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: string, function_: string) => LLM;
     /**
      * allow the LLM to interact with an environment via MCP
      */
     withEnv: (env: Env) => LLM;
+    /**
+     * 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: string, service: Service) => LLM;
     /**
      * swap out the llm model
      * @param model The model to use
@@ -4257,6 +4312,10 @@ export declare class LLM extends BaseClient {
      * @param file The file to read the prompt from
      */
     withPromptFile: (file: File) => LLM;
+    /**
+     * Use a static set of tools for method calls, e.g. for MCP clients that do not support dynamic tool registration
+     */
+    withStaticTools: () => LLM;
     /**
      * Add a system prompt to the LLM's environment
      * @param prompt The system prompt to send
@@ -4643,6 +4702,11 @@ export declare class ModuleSource extends BaseClient {
      * @param dependencies The dependencies to update.
      */
     withUpdateDependencies: (dependencies: string[]) => ModuleSource;
+    /**
+     * Update one or more clients.
+     * @param clients The clients to update
+     */
+    withUpdatedClients: (clients: string[]) => ModuleSource;
     /**
      * Remove the current blueprint from the module source.
      */
@@ -4757,6 +4821,10 @@ export declare class Client extends BaseClient {
      * Get the Raw GraphQL client.
      */
     getGQLClient(): import("graphql-request").GraphQLClient;
+    /**
+     * initialize an address to load directories, containers, secrets or other object types.
+     */
+    address: (value: string) => Address;
     /**
      * Constructs a cache volume for a given cache key.
      * @param key A string identifier to target this cache volume (e.g., "modules-cache").
@@ -4773,6 +4841,15 @@ export declare class Client extends BaseClient {
      * @param opts.platform Platform to initialize the container with. Defaults to the native platform of the current engine
      */
     container: (opts?: ClientContainerOpts) => Container;
+    /**
+     * 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: () => Env;
     /**
      * The FunctionCall context that the SDK caller is currently executing in.
      *
@@ -4800,7 +4877,7 @@ export declare class Client extends BaseClient {
      */
     engine: () => Engine;
     /**
-     * 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
@@ -4873,6 +4950,10 @@ export declare class Client extends BaseClient {
      * @experimental
      */
     llm: (opts?: ClientLlmOpts) => LLM;
+    /**
+     * Load a Address from its ID.
+     */
+    loadAddressFromID: (id: AddressID) => Address;
     /**
      * Load a Binding from its ID.
      */