@dagger.io/dagger 0.19.3 → 0.19.5

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

@@ -17,11 +17,13 @@ declare class BaseClient {
 export type AddressDirectoryOpts = {
     exclude?: string[];
     include?: string[];
+    gitignore?: boolean;
     noCache?: boolean;
 };
 export type AddressFileOpts = {
     exclude?: string[];
     include?: string[];
+    gitignore?: boolean;
     noCache?: boolean;
 };
 /**
@@ -296,6 +298,10 @@ export type ContainerWithDirectoryOpts = {
      * Patterns to include in the written directory (e.g. ["*.go", "go.mod", "go.sum"]).
      */
     include?: string[];
+    /**
+     * Apply .gitignore rules when writing the directory.
+     */
+    gitignore?: boolean;
     /**
      * A user:group to set for the directory and its contents.
      *
@@ -600,6 +606,10 @@ export type CurrentModuleWorkdirOpts = {
      * Include only artifacts that match the given pattern (e.g., ["app/", "package.*"]).
      */
     include?: string[];
+    /**
+     * Apply .gitignore filter rules inside the directory
+     */
+    gitignore?: boolean;
 };
 /**
  * The `CurrentModuleID` scalar type represents an identifier for an object of type CurrentModule.
@@ -684,6 +694,10 @@ export type DirectoryFilterOpts = {
      * If set, only paths matching one of these glob patterns is included in the new snapshot. Example: (e.g., ["app/", "package.*"]).
      */
     include?: string[];
+    /**
+     * If set, apply .gitignore rules when filtering the directory.
+     */
+    gitignore?: boolean;
 };
 export type DirectorySearchOpts = {
     /**
@@ -758,6 +772,10 @@ export type DirectoryWithDirectoryOpts = {
      * Include only artifacts that match the given pattern (e.g., ["app/", "package.*"]).
      */
     include?: string[];
+    /**
+     * Apply .gitignore filter rules inside the directory
+     */
+    gitignore?: boolean;
     /**
      * A user:group to set for the copied directory and its contents.
      *
@@ -918,6 +936,8 @@ export type FieldTypeDefID = string & {
 export type FileAsEnvFileOpts = {
     /**
      * Replace "${VAR}" or "$VAR" with the value of other vars
+     *
+     * @deprecated Variable expansion is now enabled by default
      */
     expand?: boolean;
 };
@@ -1016,6 +1036,22 @@ export type FunctionWithArgOpts = {
      * The source map for the argument definition.
      */
     sourceMap?: SourceMap;
+    /**
+     * If deprecated, the reason or migration path.
+     */
+    deprecated?: string;
+};
+export type FunctionWithCachePolicyOpts = {
+    /**
+     * The TTL for the cache policy, if applicable. Provided as a duration string, e.g. "5m", "1h30s".
+     */
+    timeToLive?: string;
+};
+export type FunctionWithDeprecatedOpts = {
+    /**
+     * Reason or migration path describing the deprecation.
+     */
+    reason?: string;
 };
 /**
  * The `FunctionArgID` scalar type represents an identifier for an object of type FunctionArg.
@@ -1023,6 +1059,14 @@ export type FunctionWithArgOpts = {
 export type FunctionArgID = string & {
     __FunctionArgID: never;
 };
+/**
+ * The behavior configured for function result caching.
+ */
+export declare enum FunctionCachePolicy {
+    Default = "Default",
+    Never = "Never",
+    PerSession = "PerSession"
+}
 /**
  * The `FunctionCallArgValueID` scalar type represents an identifier for an object of type FunctionCallArgValue.
  */
@@ -1329,6 +1373,8 @@ export type ClientEnvOpts = {
 export type ClientEnvFileOpts = {
     /**
      * Replace "${VAR}" or "$VAR" with the value of other vars
+     *
+     * @deprecated Variable expansion is now enabled by default
      */
     expand?: boolean;
 };
@@ -1341,6 +1387,8 @@ export type ClientFileOpts = {
 export type ClientGitOpts = {
     /**
      * DEPRECATED: Set to true to keep .git directory.
+     *
+     * @deprecated Set to true to keep .git directory.
      */
     keepGitDir?: boolean;
     /**
@@ -1549,6 +1597,10 @@ export type TypeDefWithEnumMemberOpts = {
      * The source map for the enum member definition.
      */
     sourceMap?: SourceMap;
+    /**
+     * If deprecated, the reason or migration path.
+     */
+    deprecated?: string;
 };
 export type TypeDefWithEnumValueOpts = {
     /**
@@ -1559,6 +1611,10 @@ export type TypeDefWithEnumValueOpts = {
      * The source map for the enum value definition.
      */
     sourceMap?: SourceMap;
+    /**
+     * If deprecated, the reason or migration path.
+     */
+    deprecated?: string;
 };
 export type TypeDefWithFieldOpts = {
     /**
@@ -1569,6 +1625,10 @@ export type TypeDefWithFieldOpts = {
      * The source map for the field definition.
      */
     sourceMap?: SourceMap;
+    /**
+     * If deprecated, the reason or migration path.
+     */
+    deprecated?: string;
 };
 export type TypeDefWithInterfaceOpts = {
     description?: string;
@@ -1577,6 +1637,7 @@ export type TypeDefWithInterfaceOpts = {
 export type TypeDefWithObjectOpts = {
     description?: string;
     sourceMap?: SourceMap;
+    deprecated?: string;
 };
 export type TypeDefWithScalarOpts = {
     description?: string;
@@ -2274,6 +2335,7 @@ export declare class Container extends BaseClient {
      * @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.gitignore Apply .gitignore rules when writing the directory.
      * @param opts.owner A user:group to set for the directory and its contents.
      *
      * The user and group can either be an ID (1000:1000) or a name (foo:bar).
@@ -2626,6 +2688,7 @@ export declare class CurrentModule extends BaseClient {
      * @param path Location of the directory to access (e.g., ".").
      * @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.gitignore Apply .gitignore filter rules inside the directory
      */
     workdir: (path: string, opts?: CurrentModuleWorkdirOpts) => Directory;
     /**
@@ -2743,6 +2806,7 @@ export declare class Directory extends BaseClient {
      * Return a snapshot with some paths included or excluded
      * @param opts.exclude If set, paths matching one of these glob patterns is excluded from the new snapshot. Example: ["node_modules/", ".git*", ".env"]
      * @param opts.include If set, only paths matching one of these glob patterns is included in the new snapshot. Example: (e.g., ["app/", "package.*"]).
+     * @param opts.gitignore If set, apply .gitignore rules when filtering the directory.
      */
     filter: (opts?: DirectoryFilterOpts) => Directory;
     /**
@@ -2800,6 +2864,7 @@ export declare class Directory extends BaseClient {
      * @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.gitignore Apply .gitignore filter rules inside the directory
      * @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).
@@ -2905,6 +2970,10 @@ export declare class Engine extends BaseClient {
      * A unique identifier for this Engine.
      */
     id: () => Promise<EngineID>;
+    /**
+     * The list of connected client IDs
+     */
+    clients: () => Promise<string[]>;
     /**
      * The local (on-disk) cache for the Dagger engine
      */
@@ -3071,17 +3140,22 @@ export declare class EnumTypeDef extends BaseClient {
  */
 export declare class EnumValueTypeDef extends BaseClient {
     private readonly _id?;
+    private readonly _deprecated?;
     private readonly _description?;
     private readonly _name?;
     private readonly _value?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx?: Context, _id?: EnumValueTypeDefID, _description?: string, _name?: string, _value?: string);
+    constructor(ctx?: Context, _id?: EnumValueTypeDefID, _deprecated?: string, _description?: string, _name?: string, _value?: string);
     /**
      * A unique identifier for this EnumValueTypeDef.
      */
     id: () => Promise<EnumValueTypeDefID>;
+    /**
+     * The reason this enum member is deprecated, if any.
+     */
+    deprecated: () => Promise<string>;
     /**
      * A doc string for the enum member, if any.
      */
@@ -3569,16 +3643,21 @@ export declare class ErrorValue extends BaseClient {
  */
 export declare class FieldTypeDef extends BaseClient {
     private readonly _id?;
+    private readonly _deprecated?;
     private readonly _description?;
     private readonly _name?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx?: Context, _id?: FieldTypeDefID, _description?: string, _name?: string);
+    constructor(ctx?: Context, _id?: FieldTypeDefID, _deprecated?: string, _description?: string, _name?: string);
     /**
      * A unique identifier for this FieldTypeDef.
      */
     id: () => Promise<FieldTypeDefID>;
+    /**
+     * The reason this enum member is deprecated, if any.
+     */
+    deprecated: () => Promise<string>;
     /**
      * A doc string for the field, if any.
      */
@@ -3715,12 +3794,13 @@ export declare class File extends BaseClient {
  */
 export declare class Function_ extends BaseClient {
     private readonly _id?;
+    private readonly _deprecated?;
     private readonly _description?;
     private readonly _name?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx?: Context, _id?: FunctionID, _description?: string, _name?: string);
+    constructor(ctx?: Context, _id?: FunctionID, _deprecated?: string, _description?: string, _name?: string);
     /**
      * A unique identifier for this Function.
      */
@@ -3729,6 +3809,10 @@ export declare class Function_ extends BaseClient {
      * Arguments accepted by the function, if any.
      */
     args: () => Promise<FunctionArg[]>;
+    /**
+     * The reason this function is deprecated, if any.
+     */
+    deprecated: () => Promise<string>;
     /**
      * A doc string for the function, if any.
      */
@@ -3754,8 +3838,20 @@ export declare class Function_ extends BaseClient {
      * @param opts.defaultPath If the argument is a Directory or File type, default to load path from context directory, relative to root directory.
      * @param opts.ignore Patterns to ignore when loading the contextual argument value.
      * @param opts.sourceMap The source map for the argument definition.
+     * @param opts.deprecated If deprecated, the reason or migration path.
      */
     withArg: (name: string, typeDef: TypeDef, opts?: FunctionWithArgOpts) => Function_;
+    /**
+     * Returns the function updated to use the provided cache policy.
+     * @param policy The cache policy to use.
+     * @param opts.timeToLive The TTL for the cache policy, if applicable. Provided as a duration string, e.g. "5m", "1h30s".
+     */
+    withCachePolicy: (policy: FunctionCachePolicy, opts?: FunctionWithCachePolicyOpts) => Function_;
+    /**
+     * Returns the function with the provided deprecation reason.
+     * @param opts.reason Reason or migration path describing the deprecation.
+     */
+    withDeprecated: (opts?: FunctionWithDeprecatedOpts) => Function_;
     /**
      * Returns the function with the given doc string.
      * @param description The doc string to set.
@@ -3782,12 +3878,13 @@ export declare class FunctionArg extends BaseClient {
     private readonly _id?;
     private readonly _defaultPath?;
     private readonly _defaultValue?;
+    private readonly _deprecated?;
     private readonly _description?;
     private readonly _name?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx?: Context, _id?: FunctionArgID, _defaultPath?: string, _defaultValue?: JSON, _description?: string, _name?: string);
+    constructor(ctx?: Context, _id?: FunctionArgID, _defaultPath?: string, _defaultValue?: JSON, _deprecated?: string, _description?: string, _name?: string);
     /**
      * A unique identifier for this FunctionArg.
      */
@@ -3800,6 +3897,10 @@ export declare class FunctionArg extends BaseClient {
      * A default value to use for this argument when not explicitly set by the caller, if any.
      */
     defaultValue: () => Promise<JSON>;
+    /**
+     * The reason this function is deprecated, if any.
+     */
+    deprecated: () => Promise<string>;
     /**
      * A doc string for the argument, if any.
      */
@@ -4023,6 +4124,10 @@ export declare class GitRepository extends BaseClient {
      * @param opts.patterns Glob patterns (e.g., "refs/tags/v*").
      */
     tags: (opts?: GitRepositoryTagsOpts) => Promise<string[]>;
+    /**
+     * Returns the changeset of uncommitted changes in the git repository.
+     */
+    uncommitted: () => Changeset;
     /**
      * The URL of the git repository.
      */
@@ -4702,6 +4807,10 @@ export declare class ModuleSource extends BaseClient {
      * Forces evaluation of the module source, including any loading into the engine and associated validation.
      */
     sync: () => Promise<ModuleSource>;
+    /**
+     * The toolchains referenced by the module source.
+     */
+    toolchains: () => Promise<ModuleSource[]>;
     /**
      * User-defined defaults read from local .env files
      */
@@ -4756,6 +4865,11 @@ export declare class ModuleSource extends BaseClient {
      * @param path The path to set as the source subpath. Must be relative to the module source's source root directory.
      */
     withSourceSubpath: (path: string) => ModuleSource;
+    /**
+     * Add toolchains to the module source.
+     * @param toolchains The toolchain modules to add.
+     */
+    withToolchains: (toolchains: ModuleSource[]) => ModuleSource;
     /**
      * Update the blueprint module to the latest version.
      */
@@ -4765,6 +4879,11 @@ export declare class ModuleSource extends BaseClient {
      * @param dependencies The dependencies to update.
      */
     withUpdateDependencies: (dependencies: string[]) => ModuleSource;
+    /**
+     * Update one or more toolchains.
+     * @param toolchains The toolchains to update.
+     */
+    withUpdateToolchains: (toolchains: string[]) => ModuleSource;
     /**
      * Update one or more clients.
      * @param clients The clients to update
@@ -4789,6 +4908,11 @@ export declare class ModuleSource extends BaseClient {
      * @param features The experimental features to disable.
      */
     withoutExperimentalFeatures: (features: ModuleSourceExperimentalFeature[]) => ModuleSource;
+    /**
+     * Remove the provided toolchains from the module source.
+     * @param toolchains The toolchains to remove.
+     */
+    withoutToolchains: (toolchains: string[]) => ModuleSource;
     /**
      * Call the provided function with current ModuleSource.
      *
@@ -4801,13 +4925,14 @@ export declare class ModuleSource extends BaseClient {
  */
 export declare class ObjectTypeDef extends BaseClient {
     private readonly _id?;
+    private readonly _deprecated?;
     private readonly _description?;
     private readonly _name?;
     private readonly _sourceModuleName?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx?: Context, _id?: ObjectTypeDefID, _description?: string, _name?: string, _sourceModuleName?: string);
+    constructor(ctx?: Context, _id?: ObjectTypeDefID, _deprecated?: string, _description?: string, _name?: string, _sourceModuleName?: string);
     /**
      * A unique identifier for this ObjectTypeDef.
      */
@@ -4816,6 +4941,10 @@ export declare class ObjectTypeDef extends BaseClient {
      * The function used to construct new instances of this object, if any
      */
     constructor_: () => Function_;
+    /**
+     * The reason this enum member is deprecated, if any.
+     */
+    deprecated: () => Promise<string>;
     /**
      * The doc string for the object, if any.
      */
@@ -5274,15 +5403,20 @@ export declare class Client extends BaseClient {
  */
 export declare class SDKConfig extends BaseClient {
     private readonly _id?;
+    private readonly _debug?;
     private readonly _source?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx?: Context, _id?: SDKConfigID, _source?: string);
+    constructor(ctx?: Context, _id?: SDKConfigID, _debug?: boolean, _source?: string);
     /**
      * A unique identifier for this SDKConfig.
      */
     id: () => Promise<SDKConfigID>;
+    /**
+     * Whether to start the SDK runtime in debug mode with an interactive terminal.
+     */
+    debug: () => Promise<boolean>;
     /**
      * Source of the SDK. Either a name of a builtin SDK or a module source ref string pointing to the SDK's implementation.
      */
@@ -5620,6 +5754,7 @@ export declare class TypeDef extends BaseClient {
      * @param opts.value The value of the member in the enum
      * @param opts.description A doc string for the member, if any
      * @param opts.sourceMap The source map for the enum member definition.
+     * @param opts.deprecated If deprecated, the reason or migration path.
      */
     withEnumMember: (name: string, opts?: TypeDefWithEnumMemberOpts) => TypeDef;
     /**
@@ -5627,6 +5762,7 @@ export declare class TypeDef extends BaseClient {
      * @param value The name of the value in the enum
      * @param opts.description A doc string for the value, if any
      * @param opts.sourceMap The source map for the enum value definition.
+     * @param opts.deprecated If deprecated, the reason or migration path.
      * @deprecated Use withEnumMember instead
      */
     withEnumValue: (value: string, opts?: TypeDefWithEnumValueOpts) => TypeDef;
@@ -5636,6 +5772,7 @@ export declare class TypeDef extends BaseClient {
      * @param typeDef The type of the field
      * @param opts.description A doc string for the field, if any
      * @param opts.sourceMap The source map for the field definition.
+     * @param opts.deprecated If deprecated, the reason or migration path.
      */
     withField: (name: string, typeDef: TypeDef, opts?: TypeDefWithFieldOpts) => TypeDef;
     /**