@dagger.io/dagger 0.19.2 → 0.19.4

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.
      *
@@ -1017,12 +1035,26 @@ export type FunctionWithArgOpts = {
      */
     sourceMap?: SourceMap;
 };
+export type FunctionWithCachePolicyOpts = {
+    /**
+     * The TTL for the cache policy, if applicable. Provided as a duration string, e.g. "5m", "1h30s".
+     */
+    timeToLive?: string;
+};
 /**
  * The `FunctionArgID` scalar type represents an identifier for an object of type FunctionArg.
  */
 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.
  */
@@ -1233,6 +1265,15 @@ export type ModuleConfigClientID = string & {
 export type ModuleID = string & {
     __ModuleID: never;
 };
+/**
+ * Experimental features of a module
+ */
+export declare enum ModuleSourceExperimentalFeature {
+    /**
+     * Self calls
+     */
+    SelfCalls = "SELF_CALLS"
+}
 /**
  * The `ModuleSourceID` scalar type represents an identifier for an object of type ModuleSource.
  */
@@ -1901,11 +1942,12 @@ export declare class CacheVolume extends BaseClient {
 export declare class Changeset extends BaseClient {
     private readonly _id?;
     private readonly _export?;
+    private readonly _isEmpty?;
     private readonly _sync?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx?: Context, _id?: ChangesetID, _export?: string, _sync?: ChangesetID);
+    constructor(ctx?: Context, _id?: ChangesetID, _export?: string, _isEmpty?: boolean, _sync?: ChangesetID);
     /**
      * A unique identifier for this Changeset.
      */
@@ -1931,6 +1973,10 @@ export declare class Changeset extends BaseClient {
      * @param path Location of the copied directory (e.g., "logs/").
      */
     export: (path: string) => Promise<string>;
+    /**
+     * Returns true if the changeset is empty (i.e. there are no changes).
+     */
+    isEmpty: () => Promise<boolean>;
     /**
      * Return a snapshot containing only the created and modified files
      */
@@ -2260,6 +2306,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).
@@ -2281,6 +2328,11 @@ export declare class Container extends BaseClient {
      * @param opts.expand Replace "${VAR}" or "$VAR" in the value according to the current environment variables defined in the container (e.g. "/opt/bin:$PATH").
      */
     withEnvVariable: (name: string, value: string, opts?: ContainerWithEnvVariableOpts) => Container;
+    /**
+     * Raise an error.
+     * @param err Message of the error to raise. If empty, the error will be ignored.
+     */
+    withError: (err: string) => Container;
     /**
      * Execute a command in the container, and return a new snapshot of the container state after execution.
      * @param args Command to execute. Must be valid exec() arguments, not a shell command. Example: ["go", "run", "main.go"].
@@ -2607,6 +2659,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;
     /**
@@ -2724,6 +2777,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;
     /**
@@ -2781,6 +2835,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).
@@ -2788,6 +2843,11 @@ export declare class Directory extends BaseClient {
      * If the group is omitted, it defaults to the same as the user.
      */
     withDirectory: (path: string, source: Directory, opts?: DirectoryWithDirectoryOpts) => Directory;
+    /**
+     * Raise an error.
+     * @param err Message of the error to raise. If empty, the error will be ignored.
+     */
+    withError: (err: string) => 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").
@@ -2872,18 +2932,27 @@ export declare class Directory extends BaseClient {
  */
 export declare class Engine extends BaseClient {
     private readonly _id?;
+    private readonly _name?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx?: Context, _id?: EngineID);
+    constructor(ctx?: Context, _id?: EngineID, _name?: string);
     /**
      * 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
      */
     localCache: () => EngineCache;
+    /**
+     * The name of the engine instance.
+     */
+    name: () => Promise<string>;
 }
 /**
  * A cache storage for the Dagger engine
@@ -3428,6 +3497,11 @@ export declare class EnvFile extends BaseClient {
      * @param opts.raw Return the value exactly as written to the file. No quote removal or variable expansion
      */
     get: (name: string, opts?: EnvFileGetOpts) => Promise<string>;
+    /**
+     * Filters variables by prefix and removes the pref from keys. Variables without the prefix are excluded. For example, with the prefix "MY_APP_" and variables: MY_APP_TOKEN=topsecret MY_APP_NAME=hello FOO=bar the resulting environment will contain: TOKEN=topsecret NAME=hello
+     * @param prefix The prefix to filter by
+     */
+    namespace_: (prefix: string) => EnvFile;
     /**
      * Return all variables
      * @param opts.raw Return values exactly as written to the file. No quote removal or variable expansion
@@ -3722,6 +3796,12 @@ export declare class Function_ extends BaseClient {
      * @param opts.sourceMap The source map for the argument definition.
      */
     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 given doc string.
      * @param description The doc string to set.
@@ -3989,6 +4069,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.
      */
@@ -4432,6 +4516,14 @@ export declare class Module_ extends BaseClient {
      * Interfaces served by this module.
      */
     interfaces: () => Promise<TypeDef[]>;
+    /**
+     * The introspection schema JSON file for this module.
+     *
+     * This file represents the schema visible to the module's source code, including all core types and those from the dependencies.
+     *
+     * Note: this is in the context of a module, so some core types may be hidden.
+     */
+    introspectionSchemaJSON: () => File;
     /**
      * The name of the module
      */
@@ -4608,6 +4700,14 @@ export declare class ModuleSource extends BaseClient {
      * The URL to the source's git repo in a web browser. Only valid for git sources.
      */
     htmlURL: () => Promise<string>;
+    /**
+     * The introspection schema JSON file for this module source.
+     *
+     * This file represents the schema visible to the module's source code, including all core types and those from the dependencies.
+     *
+     * Note: this is in the context of a module, so some core types may be hidden.
+     */
+    introspectionSchemaJSON: () => File;
     /**
      * The kind of module source (currently local, git or dir).
      */
@@ -4652,6 +4752,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
      */
@@ -4681,6 +4785,11 @@ export declare class ModuleSource extends BaseClient {
      * @param version The engine version to upgrade to.
      */
     withEngineVersion: (version: string) => ModuleSource;
+    /**
+     * Enable the experimental features for the module source.
+     * @param features The experimental features to enable.
+     */
+    withExperimentalFeatures: (features: ModuleSourceExperimentalFeature[]) => ModuleSource;
     /**
      * Update the module source with additional include patterns for files+directories from its context that are required for building it
      * @param patterns The new additional include patterns.
@@ -4701,6 +4810,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.
      */
@@ -4710,6 +4824,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
@@ -4729,6 +4848,16 @@ export declare class ModuleSource extends BaseClient {
      * @param dependencies The dependencies to remove.
      */
     withoutDependencies: (dependencies: string[]) => ModuleSource;
+    /**
+     * Disable experimental features for the module source.
+     * @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.
      *