@dagger.io/dagger 0.19.9 → 0.19.11

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

@@ -71,12 +71,62 @@ export declare enum CacheSharingMode {
 export type CacheVolumeID = string & {
     __CacheVolumeID: never;
 };
+export type ChangesetWithChangesetOpts = {
+    /**
+     * What to do on a merge conflict
+     */
+    onConflict?: ChangesetMergeConflict;
+};
+export type ChangesetWithChangesetsOpts = {
+    /**
+     * What to do on a merge conflict
+     */
+    onConflict?: ChangesetsMergeConflict;
+};
 /**
  * The `ChangesetID` scalar type represents an identifier for an object of type Changeset.
  */
 export type ChangesetID = string & {
     __ChangesetID: never;
 };
+/**
+ * Strategy to use when merging changesets with conflicting changes.
+ */
+export declare enum ChangesetMergeConflict {
+    /**
+     * Attempt the merge and fail if git merge fails due to conflicts
+     */
+    Fail = "FAIL",
+    /**
+     * Fail before attempting merge if file-level conflicts are detected
+     */
+    FailEarly = "FAIL_EARLY",
+    /**
+     * Let git create conflict markers in files. For modify/delete conflicts, keeps the modified version. Fails on binary conflicts.
+     */
+    LeaveConflictMarkers = "LEAVE_CONFLICT_MARKERS",
+    /**
+     * The conflict is resolved by applying the version of the calling changeset
+     */
+    PreferOurs = "PREFER_OURS",
+    /**
+     * The conflict is resolved by applying the version of the other changeset
+     */
+    PreferTheirs = "PREFER_THEIRS"
+}
+/**
+ * Strategy to use when merging multiple changesets with git octopus merge.
+ */
+export declare enum ChangesetsMergeConflict {
+    /**
+     * Attempt the octopus merge and fail if git merge fails due to conflicts
+     */
+    Fail = "FAIL",
+    /**
+     * Fail before attempting merge if file-level conflicts are detected between any changesets
+     */
+    FailEarly = "FAIL_EARLY"
+}
 /**
  * The `CheckGroupID` scalar type represents an identifier for an object of type CheckGroup.
  */
@@ -615,6 +665,12 @@ export type ContainerWithoutUnixSocketOpts = {
 export type ContainerID = string & {
     __ContainerID: never;
 };
+export type CurrentModuleGeneratorsOpts = {
+    /**
+     * Only include generators matching the specified patterns
+     */
+    include?: string[];
+};
 export type CurrentModuleWorkdirOpts = {
     /**
      * Exclude artifacts that match the given pattern (e.g., ["node_modules/", ".git*"]).
@@ -680,6 +736,14 @@ export type DirectoryDockerBuildOpts = {
      * 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;
+    /**
+     * A socket to use for SSH authentication during the build
+     *
+     * (e.g., for Dockerfile RUN --mount=type=ssh instructions).
+     *
+     * Typically obtained via host.unixSocket() pointing to the SSH_AUTH_SOCK.
+     */
+    ssh?: Socket;
 };
 export type DirectoryEntriesOpts = {
     /**
@@ -892,6 +956,12 @@ export type EnumTypeDefID = string & {
 export type EnumValueTypeDefID = string & {
     __EnumValueTypeDefID: never;
 };
+export type EnvChecksOpts = {
+    /**
+     * Only include checks matching the specified patterns
+     */
+    include?: string[];
+};
 export type EnvFileGetOpts = {
     /**
      * Return the value exactly as written to the file. No quote removal or variable expansion
@@ -1097,6 +1167,7 @@ export type FunctionWithArgOpts = {
      * If deprecated, the reason or migration path.
      */
     deprecated?: string;
+    defaultAddress?: string;
 };
 export type FunctionWithCachePolicyOpts = {
     /**
@@ -1148,6 +1219,24 @@ export type FunctionID = string & {
 export type GeneratedCodeID = string & {
     __GeneratedCodeID: never;
 };
+export type GeneratorGroupChangesOpts = {
+    /**
+     * Strategy to apply on conflicts between generators
+     */
+    onConflict?: ChangesetsMergeConflict;
+};
+/**
+ * The `GeneratorGroupID` scalar type represents an identifier for an object of type GeneratorGroup.
+ */
+export type GeneratorGroupID = string & {
+    __GeneratorGroupID: never;
+};
+/**
+ * The `GeneratorID` scalar type represents an identifier for an object of type Generator.
+ */
+export type GeneratorID = string & {
+    __GeneratorID: never;
+};
 export type GitRefTreeOpts = {
     /**
      * Set to true to discard .git directory.
@@ -1322,6 +1411,12 @@ export type ModuleChecksOpts = {
      */
     include?: string[];
 };
+export type ModuleGeneratorsOpts = {
+    /**
+     * Only include generators matching the specified patterns
+     */
+    include?: string[];
+};
 export type ModuleServeOpts = {
     /**
      * Expose the dependencies of this module to the client
@@ -1540,11 +1635,11 @@ export type ClientSecretOpts = {
  */
 export declare enum ReturnType {
     /**
-     * Any execution (exit codes 0-127)
+     * Any execution (exit codes 0-127 and 192-255)
      */
     Any = "ANY",
     /**
-     * A failed execution (exit codes 1-127)
+     * A failed execution (exit codes 1-127 and 192-255)
      */
     Failure = "FAILURE",
     /**
@@ -1963,6 +2058,14 @@ export declare class Binding extends BaseClient {
      * Retrieve the binding value, as type File
      */
     asFile: () => File;
+    /**
+     * Retrieve the binding value, as type Generator
+     */
+    asGenerator: () => Generator;
+    /**
+     * Retrieve the binding value, as type GeneratorGroup
+     */
+    asGeneratorGroup: () => GeneratorGroup;
     /**
      * Retrieve the binding value, as type GitRef
      */
@@ -2103,6 +2206,30 @@ export declare class Changeset extends BaseClient {
      * Force evaluation in the engine.
      */
     sync: () => Promise<Changeset>;
+    /**
+     * Add changes to an existing changeset
+     *
+     * By default the operation will fail in case of conflicts, for instance a file modified in both changesets. The behavior can be adjusted using onConflict argument
+     * @param changes Changes to merge into the actual changeset
+     * @param opts.onConflict What to do on a merge conflict
+     */
+    withChangeset: (changes: Changeset, opts?: ChangesetWithChangesetOpts) => Changeset;
+    /**
+     * Add changes from multiple changesets using git octopus merge strategy
+     *
+     * This is more efficient than chaining multiple withChangeset calls when merging many changesets.
+     *
+     * Only FAIL and FAIL_EARLY conflict strategies are supported (octopus merge cannot use -X ours/theirs).
+     * @param changes List of changesets to merge into the actual changeset
+     * @param opts.onConflict What to do on a merge conflict
+     */
+    withChangesets: (changes: Changeset[], opts?: ChangesetWithChangesetsOpts) => Changeset;
+    /**
+     * Call the provided function with current Changeset.
+     *
+     * This is useful for reusability and readability by not breaking the calling chain.
+     */
+    with: (arg: (param: Changeset) => Changeset) => Changeset;
 }
 export declare class Check extends BaseClient {
     private readonly _id?;
@@ -2147,10 +2274,6 @@ export declare class Check extends BaseClient {
      * Execute the check
      */
     run: () => Check;
-    /**
-     * The module source where the check is defined (i.e., toolchains)
-     */
-    source: () => ModuleSource;
     /**
      * Call the provided function with current Check.
      *
@@ -2858,6 +2981,12 @@ export declare class CurrentModule extends BaseClient {
      * The generated files and directories made on top of the module source's context directory.
      */
     generatedContextDirectory: () => Directory;
+    /**
+     * Return all generators defined by the module
+     * @param opts.include Only include generators matching the specified patterns
+     * @experimental
+     */
+    generators: (opts?: CurrentModuleGeneratorsOpts) => GeneratorGroup;
     /**
      * The name of the module being executed in
      */
@@ -2960,6 +3089,11 @@ export declare class Directory extends BaseClient {
      * @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.
+     * @param opts.ssh A socket to use for SSH authentication during the build
+     *
+     * (e.g., for Dockerfile RUN --mount=type=ssh instructions).
+     *
+     * Typically obtained via host.unixSocket() pointing to the SSH_AUTH_SOCK.
      */
     dockerBuild: (opts?: DirectoryDockerBuildOpts) => Container;
     /**
@@ -3372,6 +3506,18 @@ export declare class Env extends BaseClient {
      * A unique identifier for this Env.
      */
     id: () => Promise<EnvID>;
+    /**
+     * Return the check with the given name from the installed modules. Must match exactly one check.
+     * @param name The name of the check to retrieve
+     * @experimental
+     */
+    check: (name: string) => Check;
+    /**
+     * Return all checks defined by the installed modules
+     * @param opts.include Only include checks matching the specified patterns
+     * @experimental
+     */
+    checks: (opts?: EnvChecksOpts) => CheckGroup;
     /**
      * Retrieves an input binding by name
      */
@@ -3537,6 +3683,32 @@ export declare class Env extends BaseClient {
      * @param description A description of the desired value of the binding
      */
     withFileOutput: (name: string, description: string) => Env;
+    /**
+     * Create or update a binding of type GeneratorGroup in the environment
+     * @param name The name of the binding
+     * @param value The GeneratorGroup value to assign to the binding
+     * @param description The purpose of the input
+     */
+    withGeneratorGroupInput: (name: string, value: GeneratorGroup, description: string) => Env;
+    /**
+     * Declare a desired GeneratorGroup 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
+     */
+    withGeneratorGroupOutput: (name: string, description: string) => Env;
+    /**
+     * Create or update a binding of type Generator in the environment
+     * @param name The name of the binding
+     * @param value The Generator value to assign to the binding
+     * @param description The purpose of the input
+     */
+    withGeneratorInput: (name: string, value: Generator, description: string) => Env;
+    /**
+     * Declare a desired Generator 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
+     */
+    withGeneratorOutput: (name: string, description: string) => Env;
     /**
      * Create or update a binding of type GitRef in the environment
      * @param name The name of the binding
@@ -3576,10 +3748,17 @@ export declare class Env extends BaseClient {
      * @param description A description of the desired value of the binding
      */
     withJSONValueOutput: (name: string, description: string) => Env;
+    /**
+     * Sets the main module for this environment (the project being worked on)
+     *
+     * Contextual path arguments will be populated using the environment's workspace.
+     */
+    withMainModule: (module_: Module_) => Env;
     /**
      * Installs a module into the environment, exposing its functions to the model
      *
      * Contextual path arguments will be populated using the environment's workspace.
+     * @deprecated Use withMainModule instead
      */
     withModule: (module_: Module_) => Env;
     /**
@@ -4097,6 +4276,10 @@ export declare class Function_ extends BaseClient {
      * @param description The doc string to set.
      */
     withDescription: (description: string) => Function_;
+    /**
+     * Returns the function with a flag indicating it's a generator.
+     */
+    withGenerator: () => Function_;
     /**
      * Returns the function with the given source map.
      * @param sourceMap The source map for the function definition.
@@ -4116,6 +4299,7 @@ export declare class Function_ extends BaseClient {
  */
 export declare class FunctionArg extends BaseClient {
     private readonly _id?;
+    private readonly _defaultAddress?;
     private readonly _defaultPath?;
     private readonly _defaultValue?;
     private readonly _deprecated?;
@@ -4124,11 +4308,15 @@ export declare class FunctionArg extends BaseClient {
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx?: Context, _id?: FunctionArgID, _defaultPath?: string, _defaultValue?: JSON, _deprecated?: string, _description?: string, _name?: string);
+    constructor(ctx?: Context, _id?: FunctionArgID, _defaultAddress?: string, _defaultPath?: string, _defaultValue?: JSON, _deprecated?: string, _description?: string, _name?: string);
     /**
      * A unique identifier for this FunctionArg.
      */
     id: () => Promise<FunctionArgID>;
+    /**
+     * Only applies to arguments of type Container. If the argument is not set, load it from the given address (e.g. alpine:latest)
+     */
+    defaultAddress: () => Promise<string>;
     /**
      * Only applies to arguments of type File or Directory. If the argument is not set, load it from the given path in the context directory
      */
@@ -4271,6 +4459,90 @@ export declare class GeneratedCode extends BaseClient {
      */
     with: (arg: (param: GeneratedCode) => GeneratedCode) => GeneratedCode;
 }
+export declare class Generator extends BaseClient {
+    private readonly _id?;
+    private readonly _completed?;
+    private readonly _description?;
+    private readonly _isEmpty?;
+    private readonly _name?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(ctx?: Context, _id?: GeneratorID, _completed?: boolean, _description?: string, _isEmpty?: boolean, _name?: string);
+    /**
+     * A unique identifier for this Generator.
+     */
+    id: () => Promise<GeneratorID>;
+    /**
+     * The generated changeset
+     */
+    changes: () => Changeset;
+    /**
+     * Whether the generator complete
+     */
+    completed: () => Promise<boolean>;
+    /**
+     * Return the description of the generator
+     */
+    description: () => Promise<string>;
+    /**
+     * Wether changeset from the generator execution is empty or not
+     */
+    isEmpty: () => Promise<boolean>;
+    /**
+     * Return the fully qualified name of the generator
+     */
+    name: () => Promise<string>;
+    /**
+     * Execute the generator
+     */
+    run: () => Generator;
+    /**
+     * Call the provided function with current Generator.
+     *
+     * This is useful for reusability and readability by not breaking the calling chain.
+     */
+    with: (arg: (param: Generator) => Generator) => Generator;
+}
+export declare class GeneratorGroup extends BaseClient {
+    private readonly _id?;
+    private readonly _isEmpty?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(ctx?: Context, _id?: GeneratorGroupID, _isEmpty?: boolean);
+    /**
+     * A unique identifier for this GeneratorGroup.
+     */
+    id: () => Promise<GeneratorGroupID>;
+    /**
+     * The combined changes from the generators execution
+     *
+     * If any conflict occurs, for instance if the same file is modified by multiple generators, or if a file is both modified and deleted, an error is raised and the merge of the changesets will failed.
+     *
+     * Set 'continueOnConflicts' flag to force to merge the changes in a 'last write wins' strategy.
+     * @param opts.onConflict Strategy to apply on conflicts between generators
+     */
+    changes: (opts?: GeneratorGroupChangesOpts) => Changeset;
+    /**
+     * Whether the generated changeset is empty or not
+     */
+    isEmpty: () => Promise<boolean>;
+    /**
+     * Return a list of individual generators and their details
+     */
+    list: () => Promise<Generator[]>;
+    /**
+     * Execute all selected generators
+     */
+    run: () => GeneratorGroup;
+    /**
+     * Call the provided function with current GeneratorGroup.
+     *
+     * This is useful for reusability and readability by not breaking the calling chain.
+     */
+    with: (arg: (param: GeneratorGroup) => GeneratorGroup) => GeneratorGroup;
+}
 /**
  * A git ref (tag, branch, or commit).
  */
@@ -4827,6 +5099,18 @@ export declare class Module_ extends BaseClient {
      * The generated files and directories made on top of the module source's context directory.
      */
     generatedContextDirectory: () => Directory;
+    /**
+     * Return the generator defined by the module with the given name. Must match to exactly one generator.
+     * @param name The name of the generator to retrieve
+     * @experimental
+     */
+    generator: (name: string) => Generator;
+    /**
+     * Return all generators defined by the module
+     * @param opts.include Only include generators matching the specified patterns
+     * @experimental
+     */
+    generators: (opts?: ModuleGeneratorsOpts) => GeneratorGroup;
     /**
      * Interfaces served by this module.
      */
@@ -5519,6 +5803,14 @@ export declare class Client extends BaseClient {
      * Load a GeneratedCode from its ID.
      */
     loadGeneratedCodeFromID: (id: GeneratedCodeID) => GeneratedCode;
+    /**
+     * Load a Generator from its ID.
+     */
+    loadGeneratorFromID: (id: GeneratorID) => Generator;
+    /**
+     * Load a GeneratorGroup from its ID.
+     */
+    loadGeneratorGroupFromID: (id: GeneratorGroupID) => GeneratorGroup;
     /**
      * Load a GitRef from its ID.
      */