@dagger.io/dagger 0.18.17 → 0.18.18

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

@@ -53,6 +53,12 @@ export declare enum CacheSharingMode {
 export type CacheVolumeID = string & {
     __CacheVolumeID: never;
 };
+/**
+ * The `ChangesetID` scalar type represents an identifier for an object of type Changeset.
+ */
+export type ChangesetID = string & {
+    __ChangesetID: never;
+};
 /**
  * The `CloudID` scalar type represents an identifier for an object of type Cloud.
  */
@@ -764,12 +770,28 @@ export type DirectoryWithDirectoryOpts = {
      * Include only artifacts that match the given pattern (e.g., ["app/", "package.*"]).
      */
     include?: string[];
+    /**
+     * 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.
+     */
+    owner?: string;
 };
 export type DirectoryWithFileOpts = {
     /**
      * Permission given to the copied file (e.g., 0600).
      */
     permissions?: number;
+    /**
+     * 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.
+     */
+    owner?: string;
 };
 export type DirectoryWithFilesOpts = {
     /**
@@ -840,6 +862,12 @@ export type EnumTypeDefID = string & {
 export type EnumValueTypeDefID = string & {
     __EnumValueTypeDefID: never;
 };
+/**
+ * The `EnvFileID` scalar type represents an identifier for an object of type EnvFile.
+ */
+export type EnvFileID = string & {
+    __EnvFileID: never;
+};
 /**
  * The `EnvID` scalar type represents an identifier for an object of type Env.
  */
@@ -887,6 +915,12 @@ export declare enum ExistsType {
 export type FieldTypeDefID = string & {
     __FieldTypeDefID: never;
 };
+export type FileAsEnvFileOpts = {
+    /**
+     * Replace "${VAR}" or "$VAR" with the value of other vars
+     */
+    expand?: boolean;
+};
 export type FileContentsOpts = {
     /**
      * Start reading after this line
@@ -1061,9 +1095,9 @@ export type HostDirectoryOpts = {
      */
     noCache?: boolean;
     /**
-     * Don't apply .gitignore filter rules inside the directory
+     * Apply .gitignore filter rules inside the directory
      */
-    noGitAutoIgnore?: boolean;
+    gitignore?: boolean;
 };
 export type HostFileOpts = {
     /**
@@ -1071,6 +1105,9 @@ export type HostFileOpts = {
      */
     noCache?: boolean;
 };
+export type HostFindUpOpts = {
+    noCache?: boolean;
+};
 export type HostServiceOpts = {
     /**
      * Upstream host to forward traffic to.
@@ -1280,6 +1317,12 @@ export type ClientEnvOpts = {
      */
     writable?: boolean;
 };
+export type ClientEnvFileOpts = {
+    /**
+     * Replace "${VAR}" or "$VAR" with the value of other vars
+     */
+    expand?: boolean;
+};
 export type ClientFileOpts = {
     /**
      * Permissions of the new file. Example: 0600
@@ -1690,6 +1733,10 @@ export declare class Binding extends BaseClient {
      * Retrieve the binding value, as type CacheVolume
      */
     asCacheVolume: () => CacheVolume;
+    /**
+     * Retrieve the binding value, as type Changeset
+     */
+    asChangeset: () => Changeset;
     /**
      * Retrieve the binding value, as type Cloud
      */
@@ -1706,6 +1753,10 @@ export declare class Binding extends BaseClient {
      * Retrieve the binding value, as type Env
      */
     asEnv: () => Env;
+    /**
+     * Retrieve the binding value, as type EnvFile
+     */
+    asEnvFile: () => EnvFile;
     /**
      * Retrieve the binding value, as type File
      */
@@ -1793,6 +1844,53 @@ export declare class CacheVolume extends BaseClient {
      */
     id: () => Promise<CacheVolumeID>;
 }
+/**
+ * A comparison between two directories representing changes that can be applied.
+ */
+export declare class Changeset extends BaseClient {
+    private readonly _id?;
+    private readonly _sync?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(ctx?: Context, _id?: ChangesetID, _sync?: ChangesetID);
+    /**
+     * A unique identifier for this Changeset.
+     */
+    id: () => Promise<ChangesetID>;
+    /**
+     * Files and directories that were added in the newer directory.
+     */
+    addedPaths: () => Promise<string[]>;
+    /**
+     * The newer/upper snapshot.
+     */
+    after: () => Directory;
+    /**
+     * Return a Git-compatible patch of the changes
+     */
+    asPatch: () => File;
+    /**
+     * The older/lower snapshot to compare against.
+     */
+    before: () => Directory;
+    /**
+     * Return a snapshot containing only the created and modified files
+     */
+    layer: () => Directory;
+    /**
+     * Files and directories that existed before and were updated in the newer directory.
+     */
+    modifiedPaths: () => Promise<string[]>;
+    /**
+     * Files and directories that were removed. Directories are indicated by a trailing slash, and their child paths are not included.
+     */
+    removedPaths: () => Promise<string[]>;
+    /**
+     * Force evaluation in the engine.
+     */
+    sync: () => Promise<Changeset>;
+}
 /**
  * Dagger Cloud configuration and state
  */
@@ -2485,12 +2583,13 @@ export declare class Directory extends BaseClient {
     private readonly _digest?;
     private readonly _exists?;
     private readonly _export?;
+    private readonly _findUp?;
     private readonly _name?;
     private readonly _sync?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx?: Context, _id?: DirectoryID, _digest?: string, _exists?: boolean, _export?: string, _name?: string, _sync?: DirectoryID);
+    constructor(ctx?: Context, _id?: DirectoryID, _digest?: string, _exists?: boolean, _export?: string, _findUp?: string, _name?: string, _sync?: DirectoryID);
     /**
      * A unique identifier for this Directory.
      */
@@ -2513,6 +2612,23 @@ export declare class Directory extends BaseClient {
      * If not set, the module source code is loaded from the root of the directory.
      */
     asModuleSource: (opts?: DirectoryAsModuleSourceOpts) => ModuleSource;
+    /**
+     * 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: Directory) => Changeset;
+    /**
+     * 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: string, owner: string) => Directory;
     /**
      * Return the difference between this directory and an another directory. The difference is encoded as a directory.
      * @param other The directory to compare against
@@ -2570,6 +2686,12 @@ export declare class Directory extends BaseClient {
      * @param opts.include If set, only paths matching one of these glob patterns is included in the new snapshot. Example: (e.g., ["app/", "package.*"]).
      */
     filter: (opts?: DirectoryFilterOpts) => Directory;
+    /**
+     * 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: (name: string, start: string) => Promise<string>;
     /**
      * Returns a list of files and directories that matche the given pattern.
      * @param pattern Pattern to match (e.g., "*.md").
@@ -2608,12 +2730,22 @@ export declare class Directory extends BaseClient {
      * @param opts.insecureRootCapabilities Execute the command with all root capabilities. This is similar to running a command with "sudo" or executing "docker run" with the "--privileged" flag. Containerization does not provide any security guarantees when using this option. It should only be used when absolutely necessary and only with trusted commands.
      */
     terminal: (opts?: DirectoryTerminalOpts) => Directory;
+    /**
+     * Return a directory with changes from another directory applied to it.
+     * @param changes Changes to apply to the directory
+     */
+    withChanges: (changes: Changeset) => Directory;
     /**
      * 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: string, directory: Directory, opts?: DirectoryWithDirectoryOpts) => Directory;
     /**
@@ -2621,6 +2753,11 @@ export declare 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: string, source: File, opts?: DirectoryWithFileOpts) => Directory;
     /**
@@ -2649,6 +2786,12 @@ export declare class Directory extends BaseClient {
      * @experimental
      */
     withPatch: (patch: string) => Directory;
+    /**
+     * Retrieves this directory with the given Git-compatible patch file applied.
+     * @param patch File containing the patch to apply
+     * @experimental
+     */
+    withPatchFile: (patch: File) => Directory;
     /**
      * Return a snapshot with a symlink
      * @param target Location of the file or directory to link to (e.g., "/existing/file").
@@ -2932,6 +3075,19 @@ export declare class Env extends BaseClient {
      * @param description A description of the desired value of the binding
      */
     withCacheVolumeOutput: (name: string, description: string) => Env;
+    /**
+     * 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: string, value: Changeset, description: string) => Env;
+    /**
+     * 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: string, description: string) => Env;
     /**
      * Create or update a binding of type Cloud in the environment
      * @param name The name of the binding
@@ -2971,6 +3127,19 @@ export declare class Env extends BaseClient {
      * @param description A description of the desired value of the binding
      */
     withDirectoryOutput: (name: string, description: string) => Env;
+    /**
+     * 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: string, value: EnvFile, description: string) => Env;
+    /**
+     * 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: string, description: string) => Env;
     /**
      * Create or update a binding of type Env in the environment
      * @param name The name of the binding
@@ -3173,6 +3342,57 @@ export declare class Env extends BaseClient {
      */
     with: (arg: (param: Env) => Env) => Env;
 }
+/**
+ * A collection of environment variables.
+ */
+export declare class EnvFile extends BaseClient {
+    private readonly _id?;
+    private readonly _exists?;
+    private readonly _get?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(ctx?: Context, _id?: EnvFileID, _exists?: boolean, _get?: string);
+    /**
+     * A unique identifier for this EnvFile.
+     */
+    id: () => Promise<EnvFileID>;
+    /**
+     * Return as a file
+     */
+    asFile: () => File;
+    /**
+     * Check if a variable exists
+     * @param name Variable name
+     */
+    exists: (name: string) => Promise<boolean>;
+    /**
+     * Lookup a variable (last occurrence wins) and return its value, or an empty string
+     * @param name Variable name
+     */
+    get: (name: string) => Promise<string>;
+    /**
+     * Return all variables
+     */
+    variables: () => Promise<EnvVariable[]>;
+    /**
+     * Add a variable
+     * @param name Variable name
+     * @param value Variable value
+     */
+    withVariable: (name: string, value: string) => EnvFile;
+    /**
+     * Remove all occurrences of the named variable
+     * @param name Variable name
+     */
+    withoutVariable: (name: string) => EnvFile;
+    /**
+     * Call the provided function with current EnvFile.
+     *
+     * This is useful for reusability and readability by not breaking the calling chain.
+     */
+    with: (arg: (param: EnvFile) => EnvFile) => EnvFile;
+}
 /**
  * An environment variable name and value.
  */
@@ -3303,6 +3523,20 @@ export declare class File extends BaseClient {
      * A unique identifier for this File.
      */
     id: () => Promise<FileID>;
+    /**
+     * Parse as an env file
+     * @param opts.expand Replace "${VAR}" or "$VAR" with the value of other vars
+     */
+    asEnvFile: (opts?: FileAsEnvFileOpts) => EnvFile;
+    /**
+     * 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: string) => File;
     /**
      * Retrieves the contents of the file.
      * @param opts.offsetLines Start reading after this line
@@ -3725,10 +3959,11 @@ export declare class GitRepository extends BaseClient {
  */
 export declare class Host extends BaseClient {
     private readonly _id?;
+    private readonly _findUp?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx?: Context, _id?: HostID);
+    constructor(ctx?: Context, _id?: HostID, _findUp?: string);
     /**
      * A unique identifier for this Host.
      */
@@ -3744,7 +3979,7 @@ export declare 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: string, opts?: HostDirectoryOpts) => Directory;
     /**
@@ -3753,6 +3988,11 @@ export declare class Host extends BaseClient {
      * @param opts.noCache If true, the file will always be reloaded from the host.
      */
     file: (path: string, opts?: HostFileOpts) => File;
+    /**
+     * 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: (name: string, opts?: HostFindUpOpts) => Promise<string>;
     /**
      * 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.
@@ -4566,6 +4806,11 @@ export declare class Client extends BaseClient {
      * @experimental
      */
     env: (opts?: ClientEnvOpts) => Env;
+    /**
+     * Initialize an environment file
+     * @param opts.expand Replace "${VAR}" or "$VAR" with the value of other vars
+     */
+    envFile: (opts?: ClientEnvFileOpts) => EnvFile;
     /**
      * Create a new error.
      * @param message A brief description of the error.
@@ -4636,6 +4881,10 @@ export declare class Client extends BaseClient {
      * Load a CacheVolume from its ID.
      */
     loadCacheVolumeFromID: (id: CacheVolumeID) => CacheVolume;
+    /**
+     * Load a Changeset from its ID.
+     */
+    loadChangesetFromID: (id: ChangesetID) => Changeset;
     /**
      * Load a Cloud from its ID.
      */
@@ -4676,6 +4925,10 @@ export declare class Client extends BaseClient {
      * Load a EnumValueTypeDef from its ID.
      */
     loadEnumValueTypeDefFromID: (id: EnumValueTypeDefID) => EnumValueTypeDef;
+    /**
+     * Load a EnvFile from its ID.
+     */
+    loadEnvFileFromID: (id: EnvFileID) => EnvFile;
     /**
      * Load a Env from its ID.
      */