@dagger.io/dagger 0.18.17 → 0.18.19

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
      */
@@ -542,6 +642,13 @@ export class Binding extends BaseClient {
         const ctx = this._ctx.select("asCacheVolume");
         return new CacheVolume(ctx);
     };
+    /**
+     * Retrieve the binding value, as type Changeset
+     */
+    asChangeset = () => {
+        const ctx = this._ctx.select("asChangeset");
+        return new Changeset(ctx);
+    };
     /**
      * Retrieve the binding value, as type Cloud
      */
@@ -570,6 +677,13 @@ export class Binding extends BaseClient {
         const ctx = this._ctx.select("asEnv");
         return new Env(ctx);
     };
+    /**
+     * Retrieve the binding value, as type EnvFile
+     */
+    asEnvFile = () => {
+        const ctx = this._ctx.select("asEnvFile");
+        return new EnvFile(ctx);
+    };
     /**
      * Retrieve the binding value, as type File
      */
@@ -741,6 +855,106 @@ export class CacheVolume extends BaseClient {
         return response;
     };
 }
+/**
+ * A comparison between two directories representing changes that can be applied.
+ */
+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, _export, _sync) {
+        super(ctx);
+        this._id = _id;
+        this._export = _export;
+        this._sync = _sync;
+    }
+    /**
+     * A unique identifier for this Changeset.
+     */
+    id = async () => {
+        if (this._id) {
+            return this._id;
+        }
+        const ctx = this._ctx.select("id");
+        const response = await ctx.execute();
+        return response;
+    };
+    /**
+     * Files and directories that were added in the newer directory.
+     */
+    addedPaths = async () => {
+        const ctx = this._ctx.select("addedPaths");
+        const response = await ctx.execute();
+        return response;
+    };
+    /**
+     * The newer/upper snapshot.
+     */
+    after = () => {
+        const ctx = this._ctx.select("after");
+        return new Directory(ctx);
+    };
+    /**
+     * Return a Git-compatible patch of the changes
+     */
+    asPatch = () => {
+        const ctx = this._ctx.select("asPatch");
+        return new File(ctx);
+    };
+    /**
+     * The older/lower snapshot to compare against.
+     */
+    before = () => {
+        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
+     */
+    layer = () => {
+        const ctx = this._ctx.select("layer");
+        return new Directory(ctx);
+    };
+    /**
+     * Files and directories that existed before and were updated in the newer directory.
+     */
+    modifiedPaths = async () => {
+        const ctx = this._ctx.select("modifiedPaths");
+        const response = await ctx.execute();
+        return response;
+    };
+    /**
+     * Files and directories that were removed. Directories are indicated by a trailing slash, and their child paths are not included.
+     */
+    removedPaths = async () => {
+        const ctx = this._ctx.select("removedPaths");
+        const response = await ctx.execute();
+        return response;
+    };
+    /**
+     * Force evaluation in the engine.
+     */
+    sync = async () => {
+        const ctx = this._ctx.select("sync");
+        const response = await ctx.execute();
+        return new Client(ctx.copy()).loadChangesetFromID(response);
+    };
+}
 /**
  * Dagger Cloud configuration and state
  */
@@ -1874,17 +2088,19 @@ export class Directory extends BaseClient {
     _digest = undefined;
     _exists = undefined;
     _export = undefined;
+    _findUp = undefined;
     _name = undefined;
     _sync = undefined;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx, _id, _digest, _exists, _export, _name, _sync) {
+    constructor(ctx, _id, _digest, _exists, _export, _findUp, _name, _sync) {
         super(ctx);
         this._id = _id;
         this._digest = _digest;
         this._exists = _exists;
         this._export = _export;
+        this._findUp = _findUp;
         this._name = _name;
         this._sync = _sync;
     }
@@ -1926,6 +2142,29 @@ export class Directory extends BaseClient {
         const ctx = this._ctx.select("asModuleSource", { ...opts });
         return new ModuleSource(ctx);
     };
+    /**
+     * Return the difference between this directory and another directory, typically an older snapshot.
+     *
+     * The difference is encoded as a changeset, which also tracks removed files, and can be applied to other directories.
+     * @param from The base directory snapshot to compare against
+     */
+    changes = (from) => {
+        const ctx = this._ctx.select("changes", { from });
+        return new Changeset(ctx);
+    };
+    /**
+     * Change the owner of the directory contents recursively.
+     * @param path Path of the directory to change ownership of (e.g., "/").
+     * @param owner A user:group to set for the mounted directory and its contents.
+     *
+     * The user and group must be an ID (1000:1000), not a name (foo:bar).
+     *
+     * If the group is omitted, it defaults to the same as the user.
+     */
+    chown = (path, owner) => {
+        const ctx = this._ctx.select("chown", { path, owner });
+        return new Directory(ctx);
+    };
     /**
      * Return the difference between this directory and an another directory. The difference is encoded as a directory.
      * @param other The directory to compare against
@@ -2030,6 +2269,19 @@ export class Directory extends BaseClient {
         const ctx = this._ctx.select("filter", { ...opts });
         return new Directory(ctx);
     };
+    /**
+     * Search up the directory tree for a file or directory, and return its path. If no match, return null
+     * @param name The name of the file or directory to search for
+     * @param start The path to start the search from
+     */
+    findUp = async (name, start) => {
+        if (this._findUp) {
+            return this._findUp;
+        }
+        const ctx = this._ctx.select("findUp", { name, start });
+        const response = await ctx.execute();
+        return response;
+    };
     /**
      * Returns a list of files and directories that matche the given pattern.
      * @param pattern Pattern to match (e.g., "*.md").
@@ -2090,12 +2342,25 @@ export class Directory extends BaseClient {
         const ctx = this._ctx.select("terminal", { ...opts });
         return new Directory(ctx);
     };
+    /**
+     * Return a directory with changes from another directory applied to it.
+     * @param changes Changes to apply to the directory
+     */
+    withChanges = (changes) => {
+        const ctx = this._ctx.select("withChanges", { changes });
+        return new Directory(ctx);
+    };
     /**
      * 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 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.
+     *
+     * The user and group must be an ID (1000:1000), not a name (foo:bar).
+     *
+     * 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 });
@@ -2106,6 +2371,11 @@ export class Directory extends BaseClient {
      * @param path Location of the copied file (e.g., "/file.txt").
      * @param source Identifier of the file to copy.
      * @param opts.permissions Permission given to the copied file (e.g., 0600).
+     * @param opts.owner A user:group to set for the copied directory and its contents.
+     *
+     * The user and group must be an ID (1000:1000), not a name (foo:bar).
+     *
+     * If the group is omitted, it defaults to the same as the user.
      */
     withFile = (path, source, opts) => {
         const ctx = this._ctx.select("withFile", { path, source, ...opts });
@@ -2149,6 +2419,15 @@ export class Directory extends BaseClient {
         const ctx = this._ctx.select("withPatch", { patch });
         return new Directory(ctx);
     };
+    /**
+     * Retrieves this directory with the given Git-compatible patch file applied.
+     * @param patch File containing the patch to apply
+     * @experimental
+     */
+    withPatchFile = (patch) => {
+        const ctx = this._ctx.select("withPatchFile", { patch });
+        return new Directory(ctx);
+    };
     /**
      * Return a snapshot with a symlink
      * @param target Location of the file or directory to link to (e.g., "/existing/file").
@@ -2695,6 +2974,29 @@ export class Env extends BaseClient {
         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
@@ -2718,6 +3020,29 @@ export class Env extends BaseClient {
         const ctx = this._ctx.select("withCacheVolumeOutput", { name, description });
         return new Env(ctx);
     };
+    /**
+     * Create or update a binding of type Changeset in the environment
+     * @param name The name of the binding
+     * @param value The Changeset value to assign to the binding
+     * @param description The purpose of the input
+     */
+    withChangesetInput = (name, value, description) => {
+        const ctx = this._ctx.select("withChangesetInput", {
+            name,
+            value,
+            description,
+        });
+        return new Env(ctx);
+    };
+    /**
+     * Declare a desired Changeset 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
+     */
+    withChangesetOutput = (name, description) => {
+        const ctx = this._ctx.select("withChangesetOutput", { name, description });
+        return new Env(ctx);
+    };
     /**
      * Create or update a binding of type Cloud in the environment
      * @param name The name of the binding
@@ -2783,6 +3108,29 @@ export class Env extends BaseClient {
         const ctx = this._ctx.select("withDirectoryOutput", { name, description });
         return new Env(ctx);
     };
+    /**
+     * Create or update a binding of type EnvFile in the environment
+     * @param name The name of the binding
+     * @param value The EnvFile value to assign to the binding
+     * @param description The purpose of the input
+     */
+    withEnvFileInput = (name, value, description) => {
+        const ctx = this._ctx.select("withEnvFileInput", {
+            name,
+            value,
+            description,
+        });
+        return new Env(ctx);
+    };
+    /**
+     * Declare a desired EnvFile 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
+     */
+    withEnvFileOutput = (name, description) => {
+        const ctx = this._ctx.select("withEnvFileOutput", { name, description });
+        return new Env(ctx);
+    };
     /**
      * Create or update a binding of type Env in the environment
      * @param name The name of the binding
@@ -3140,6 +3488,98 @@ export class Env extends BaseClient {
         return arg(this);
     };
 }
+/**
+ * A collection of environment variables.
+ */
+export class EnvFile extends BaseClient {
+    _id = undefined;
+    _exists = undefined;
+    _get = undefined;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(ctx, _id, _exists, _get) {
+        super(ctx);
+        this._id = _id;
+        this._exists = _exists;
+        this._get = _get;
+    }
+    /**
+     * A unique identifier for this EnvFile.
+     */
+    id = async () => {
+        if (this._id) {
+            return this._id;
+        }
+        const ctx = this._ctx.select("id");
+        const response = await ctx.execute();
+        return response;
+    };
+    /**
+     * Return as a file
+     */
+    asFile = () => {
+        const ctx = this._ctx.select("asFile");
+        return new File(ctx);
+    };
+    /**
+     * Check if a variable exists
+     * @param name Variable name
+     */
+    exists = async (name) => {
+        if (this._exists) {
+            return this._exists;
+        }
+        const ctx = this._ctx.select("exists", { name });
+        const response = await ctx.execute();
+        return response;
+    };
+    /**
+     * Lookup a variable (last occurrence wins) and return its value, or an empty string
+     * @param name Variable name
+     */
+    get = async (name) => {
+        if (this._get) {
+            return this._get;
+        }
+        const ctx = this._ctx.select("get", { name });
+        const response = await ctx.execute();
+        return response;
+    };
+    /**
+     * Return all variables
+     */
+    variables = async () => {
+        const ctx = this._ctx.select("variables").select("id");
+        const response = await ctx.execute();
+        return response.map((r) => new Client(ctx.copy()).loadEnvVariableFromID(r.id));
+    };
+    /**
+     * Add a variable
+     * @param name Variable name
+     * @param value Variable value
+     */
+    withVariable = (name, value) => {
+        const ctx = this._ctx.select("withVariable", { name, value });
+        return new EnvFile(ctx);
+    };
+    /**
+     * Remove all occurrences of the named variable
+     * @param name Variable name
+     */
+    withoutVariable = (name) => {
+        const ctx = this._ctx.select("withoutVariable", { name });
+        return new EnvFile(ctx);
+    };
+    /**
+     * Call the provided function with current EnvFile.
+     *
+     * This is useful for reusability and readability by not breaking the calling chain.
+     */
+    with = (arg) => {
+        return arg(this);
+    };
+}
 /**
  * An environment variable name and value.
  */
@@ -3397,6 +3837,26 @@ export class File extends BaseClient {
         const response = await ctx.execute();
         return response;
     };
+    /**
+     * Parse as an env file
+     * @param opts.expand Replace "${VAR}" or "$VAR" with the value of other vars
+     */
+    asEnvFile = (opts) => {
+        const ctx = this._ctx.select("asEnvFile", { ...opts });
+        return new EnvFile(ctx);
+    };
+    /**
+     * Change the owner of the file recursively.
+     * @param owner A user:group to set for the file.
+     *
+     * The user and group must be an ID (1000:1000), not a name (foo:bar).
+     *
+     * If the group is omitted, it defaults to the same as the user.
+     */
+    chown = (owner) => {
+        const ctx = this._ctx.select("chown", { owner });
+        return new File(ctx);
+    };
     /**
      * Retrieves the contents of the file.
      * @param opts.offsetLines Start reading after this line
@@ -4169,12 +4629,14 @@ export class GitRepository extends BaseClient {
  */
 export class Host extends BaseClient {
     _id = undefined;
+    _findUp = undefined;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx, _id) {
+    constructor(ctx, _id, _findUp) {
         super(ctx);
         this._id = _id;
+        this._findUp = _findUp;
     }
     /**
      * A unique identifier for this Host.
@@ -4201,7 +4663,7 @@ export class Host extends BaseClient {
      * @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.noCache If true, the directory will always be reloaded from the host.
-     * @param opts.noGitAutoIgnore Don't apply .gitignore filter rules inside the directory
+     * @param opts.gitignore Apply .gitignore filter rules inside the directory
      */
     directory = (path, opts) => {
         const ctx = this._ctx.select("directory", { path, ...opts });
@@ -4216,6 +4678,18 @@ export class Host extends BaseClient {
         const ctx = this._ctx.select("file", { path, ...opts });
         return new File(ctx);
     };
+    /**
+     * Search for a file or directory by walking up the tree from system workdir. Return its relative path. If no match, return null
+     * @param name name of the file or directory to search for
+     */
+    findUp = async (name, opts) => {
+        if (this._findUp) {
+            return this._findUp;
+        }
+        const ctx = this._ctx.select("findUp", { name, ...opts });
+        const response = await ctx.execute();
+        return response;
+    };
     /**
      * Creates a service that forwards traffic to a specified address via the host.
      * @param ports Ports to expose via the service, forwarding through the host network.
@@ -5519,6 +5993,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.
      */
@@ -5740,6 +6222,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").
@@ -5821,6 +6310,14 @@ export class Client extends BaseClient {
         const ctx = this._ctx.select("env", { ...opts });
         return new Env(ctx);
     };
+    /**
+     * Initialize an environment file
+     * @param opts.expand Replace "${VAR}" or "$VAR" with the value of other vars
+     */
+    envFile = (opts) => {
+        const ctx = this._ctx.select("envFile", { ...opts });
+        return new EnvFile(ctx);
+    };
     /**
      * Create a new error.
      * @param message A brief description of the error.
@@ -5910,6 +6407,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.
      */
@@ -5924,6 +6428,13 @@ export class Client extends BaseClient {
         const ctx = this._ctx.select("loadCacheVolumeFromID", { id });
         return new CacheVolume(ctx);
     };
+    /**
+     * Load a Changeset from its ID.
+     */
+    loadChangesetFromID = (id) => {
+        const ctx = this._ctx.select("loadChangesetFromID", { id });
+        return new Changeset(ctx);
+    };
     /**
      * Load a Cloud from its ID.
      */
@@ -5994,6 +6505,13 @@ export class Client extends BaseClient {
         const ctx = this._ctx.select("loadEnumValueTypeDefFromID", { id });
         return new EnumValueTypeDef(ctx);
     };
+    /**
+     * Load a EnvFile from its ID.
+     */
+    loadEnvFileFromID = (id) => {
+        const ctx = this._ctx.select("loadEnvFileFromID", { id });
+        return new EnvFile(ctx);
+    };
     /**
      * Load a Env from its ID.
      */