@dagger.io/dagger 0.19.11 → 0.20.1

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

@@ -383,6 +383,32 @@ export type ContainerWithDirectoryOpts = {
      */
     expand?: boolean;
 };
+export type ContainerWithDockerHealthcheckOpts = {
+    /**
+     * When true, command must be a single element, which is run using the container's shell
+     */
+    shell?: boolean;
+    /**
+     * Interval between running healthcheck. Example: "30s"
+     */
+    interval?: string;
+    /**
+     * Healthcheck timeout. Example: "3s"
+     */
+    timeout?: string;
+    /**
+     * StartPeriod allows for failures during this initial startup period which do not count towards maximum number of retries. Example: "0s"
+     */
+    startPeriod?: string;
+    /**
+     * StartInterval configures the duration between checks during the startup phase. Example: "5s"
+     */
+    startInterval?: string;
+    /**
+     * The maximum number of consecutive failures before the container is marked as unhealthy. Example: "3"
+     */
+    retries?: number;
+};
 export type ContainerWithEntrypointOpts = {
     /**
      * Don't reset the default arguments when setting the entrypoint. By default it is reset, since entrypoint and default args are often tightly coupled.
@@ -919,6 +945,22 @@ export type EngineCachePruneOpts = {
      * Use the engine-wide default pruning policy if true, otherwise prune the whole cache of any releasable entries.
      */
     useDefaultPolicy?: boolean;
+    /**
+     * Override the maximum disk space to keep before pruning (e.g. "200GB" or "80%").
+     */
+    maxUsedSpace?: string;
+    /**
+     * Override the minimum disk space to retain during pruning (e.g. "500GB" or "10%").
+     */
+    reservedSpace?: string;
+    /**
+     * Override the minimum free disk space target during pruning (e.g. "20GB" or "20%").
+     */
+    minFreeSpace?: string;
+    /**
+     * Override the target disk space to keep after pruning (e.g. "200GB" or "50%").
+     */
+    targetSpace?: string;
 };
 /**
  * The `EngineCacheEntryID` scalar type represents an identifier for an object of type EngineCacheEntry.
@@ -1246,6 +1288,10 @@ export type GitRefTreeOpts = {
      * The depth of the tree to fetch.
      */
     depth?: number;
+    /**
+     * Set to true to populate tag refs in the local checkout .git.
+     */
+    includeTags?: boolean;
 };
 /**
  * The `GitRefID` scalar type represents an identifier for an object of type GitRef.
@@ -1271,6 +1317,12 @@ export type GitRepositoryTagsOpts = {
 export type GitRepositoryID = string & {
     __GitRepositoryID: never;
 };
+/**
+ * The `HealthcheckConfigID` scalar type represents an identifier for an object of type HealthcheckConfig.
+ */
+export type HealthcheckConfigID = string & {
+    __HealthcheckConfigID: never;
+};
 export type HostDirectoryOpts = {
     /**
      * Exclude artifacts that match the given pattern (e.g., ["node_modules/", ".git*"]).
@@ -1518,6 +1570,12 @@ export type ClientContainerOpts = {
      */
     platform?: Platform;
 };
+export type ClientCurrentWorkspaceOpts = {
+    /**
+     * If true, skip legacy dagger.json migration checks.
+     */
+    skipMigrationCheck?: boolean;
+};
 export type ClientEnvOpts = {
     /**
      * Give the environment the same privileges as the caller: core API including host access, current module, and dependencies
@@ -1933,6 +1991,32 @@ export declare enum TypeDefKind {
 export type Void = string & {
     __Void: never;
 };
+export type WorkspaceDirectoryOpts = {
+    /**
+     * Exclude artifacts that match the given pattern (e.g., ["node_modules/", ".git*"]).
+     */
+    exclude?: string[];
+    /**
+     * Include only artifacts that match the given pattern (e.g., ["app/", "package.*"]).
+     */
+    include?: string[];
+    /**
+     * Apply .gitignore filter rules inside the directory.
+     */
+    gitignore?: boolean;
+};
+export type WorkspaceFindUpOpts = {
+    /**
+     * Path to start the search from, relative to the workspace root.
+     */
+    from?: string;
+};
+/**
+ * The `WorkspaceID` scalar type represents an identifier for an object of type Workspace.
+ */
+export type WorkspaceID = string & {
+    __WorkspaceID: never;
+};
 export type __DirectiveArgsOpts = {
     includeDeprecated?: boolean;
 };
@@ -2118,6 +2202,10 @@ export declare class Binding extends BaseClient {
      * Returns the binding's string value
      */
     asString: () => Promise<string>;
+    /**
+     * Retrieve the binding value, as type Workspace
+     */
+    asWorkspace: () => Workspace;
     /**
      * Returns the digest of the binding value
      */
@@ -2254,10 +2342,18 @@ export declare class Check extends BaseClient {
      * The description of the check
      */
     description: () => Promise<string>;
+    /**
+     * If the check failed, this is the error
+     */
+    error: () => Error;
     /**
      * Return the fully qualified name of the check
      */
     name: () => Promise<string>;
+    /**
+     * The original module in which the check has been defined
+     */
+    originalModule: () => Module_;
     /**
      * Whether the check passed
      */
@@ -2405,6 +2501,10 @@ export declare class Container extends BaseClient {
      * @param opts.expand Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
      */
     directory: (path: string, opts?: ContainerDirectoryOpts) => Directory;
+    /**
+     * Retrieves this container's configured docker healthcheck.
+     */
+    dockerHealthcheck: () => HealthcheckConfig;
     /**
      * Return the container's OCI entrypoint.
      */
@@ -2637,6 +2737,17 @@ export declare class Container extends BaseClient {
      * @param opts.expand Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
      */
     withDirectory: (path: string, source: Directory, opts?: ContainerWithDirectoryOpts) => Container;
+    /**
+     * Retrieves this container with the specificed docker healtcheck command set.
+     * @param args Healthcheck command to execute. Example: ["go", "run", "main.go"].
+     * @param opts.shell When true, command must be a single element, which is run using the container's shell
+     * @param opts.interval Interval between running healthcheck. Example: "30s"
+     * @param opts.timeout Healthcheck timeout. Example: "3s"
+     * @param opts.startPeriod StartPeriod allows for failures during this initial startup period which do not count towards maximum number of retries. Example: "0s"
+     * @param opts.startInterval StartInterval configures the duration between checks during the startup phase. Example: "5s"
+     * @param opts.retries The maximum number of consecutive failures before the container is marked as unhealthy. Example: "3"
+     */
+    withDockerHealthcheck: (args: string[], opts?: ContainerWithDockerHealthcheckOpts) => Container;
     /**
      * Set an OCI-style entrypoint. It will be included in the container's OCI configuration. Note, withExec ignores the entrypoint by default.
      * @param args Arguments of the entrypoint. Example: ["go", "run"].
@@ -2879,6 +2990,10 @@ export declare class Container extends BaseClient {
      * @param opts.expand Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
      */
     withoutDirectory: (path: string, opts?: ContainerWithoutDirectoryOpts) => Container;
+    /**
+     * Retrieves this container without a configured docker healtcheck command.
+     */
+    withoutDockerHealthcheck: () => Container;
     /**
      * Reset the container's OCI entrypoint.
      * @param opts.keepDefaultArgs Don't remove the default arguments when unsetting the entrypoint.
@@ -3339,6 +3454,10 @@ export declare class EngineCache extends BaseClient {
     /**
      * Prune the cache of releaseable entries
      * @param opts.useDefaultPolicy Use the engine-wide default pruning policy if true, otherwise prune the whole cache of any releasable entries.
+     * @param opts.maxUsedSpace Override the maximum disk space to keep before pruning (e.g. "200GB" or "80%").
+     * @param opts.reservedSpace Override the minimum disk space to retain during pruning (e.g. "500GB" or "10%").
+     * @param opts.minFreeSpace Override the minimum free disk space target during pruning (e.g. "20GB" or "20%").
+     * @param opts.targetSpace Override the target disk space to keep after pruning (e.g. "200GB" or "50%").
      */
     prune: (opts?: EngineCachePruneOpts) => Promise<void>;
     /**
@@ -3360,10 +3479,11 @@ export declare class EngineCacheEntry extends BaseClient {
     private readonly _description?;
     private readonly _diskSpaceBytes?;
     private readonly _mostRecentUseTimeUnixNano?;
+    private readonly _recordType?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx?: Context, _id?: EngineCacheEntryID, _activelyUsed?: boolean, _createdTimeUnixNano?: number, _description?: string, _diskSpaceBytes?: number, _mostRecentUseTimeUnixNano?: number);
+    constructor(ctx?: Context, _id?: EngineCacheEntryID, _activelyUsed?: boolean, _createdTimeUnixNano?: number, _description?: string, _diskSpaceBytes?: number, _mostRecentUseTimeUnixNano?: number, _recordType?: string);
     /**
      * A unique identifier for this EngineCacheEntry.
      */
@@ -3388,6 +3508,10 @@ export declare class EngineCacheEntry extends BaseClient {
      * The most recent time the cache entry was used, in Unix nanoseconds.
      */
     mostRecentUseTimeUnixNano: () => Promise<number>;
+    /**
+     * The type of the cache record (e.g. regular, internal, frontend, source.local, source.git.checkout, exec.cachemount).
+     */
+    recordType: () => Promise<string>;
 }
 /**
  * A set of cache entries returned by a query to a cache
@@ -3896,6 +4020,19 @@ export declare class Env extends BaseClient {
      * @param workspace The directory to set as the host filesystem
      */
     withWorkspace: (workspace: Directory) => Env;
+    /**
+     * Create or update a binding of type Workspace in the environment
+     * @param name The name of the binding
+     * @param value The Workspace value to assign to the binding
+     * @param description The purpose of the input
+     */
+    withWorkspaceInput: (name: string, value: Workspace, description: string) => Env;
+    /**
+     * Declare a desired Workspace 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
+     */
+    withWorkspaceOutput: (name: string, description: string) => Env;
     /**
      * Returns a new environment without any outputs
      */
@@ -4493,6 +4630,14 @@ export declare class Generator extends BaseClient {
      * Return the fully qualified name of the generator
      */
     name: () => Promise<string>;
+    /**
+     * The original module in which the generator has been defined
+     */
+    originalModule: () => Module_;
+    /**
+     * The path of the generator within its module
+     */
+    path: () => Promise<string[]>;
     /**
      * Execute the generator
      */
@@ -4575,6 +4720,7 @@ export declare class GitRef extends BaseClient {
      * The filesystem tree at this ref.
      * @param opts.discardGitDir Set to true to discard .git directory.
      * @param opts.depth The depth of the tree to fetch.
+     * @param opts.includeTags Set to true to populate tag refs in the local checkout .git.
      */
     tree: (opts?: GitRefTreeOpts) => Directory;
     /**
@@ -4645,6 +4791,54 @@ export declare class GitRepository extends BaseClient {
      */
     url: () => Promise<string>;
 }
+/**
+ * Image healthcheck configuration.
+ */
+export declare class HealthcheckConfig extends BaseClient {
+    private readonly _id?;
+    private readonly _interval?;
+    private readonly _retries?;
+    private readonly _shell?;
+    private readonly _startInterval?;
+    private readonly _startPeriod?;
+    private readonly _timeout?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(ctx?: Context, _id?: HealthcheckConfigID, _interval?: string, _retries?: number, _shell?: boolean, _startInterval?: string, _startPeriod?: string, _timeout?: string);
+    /**
+     * A unique identifier for this HealthcheckConfig.
+     */
+    id: () => Promise<HealthcheckConfigID>;
+    /**
+     * Healthcheck command arguments.
+     */
+    args: () => Promise<string[]>;
+    /**
+     * Interval between running healthcheck. Example:30s
+     */
+    interval: () => Promise<string>;
+    /**
+     * The maximum number of consecutive failures before the container is marked as unhealthy. Example:3
+     */
+    retries: () => Promise<number>;
+    /**
+     * Healthcheck command is a shell command.
+     */
+    shell: () => Promise<boolean>;
+    /**
+     * StartInterval configures the duration between checks during the startup phase. Example:5s
+     */
+    startInterval: () => Promise<string>;
+    /**
+     * StartPeriod allows for failures during this initial startup period which do not count towards maximum number of retries. Example:0s
+     */
+    startPeriod: () => Promise<string>;
+    /**
+     * Healthcheck timeout. Example:3s
+     */
+    timeout: () => Promise<string>;
+}
 /**
  * Information about the host environment.
  */
@@ -5287,6 +5481,10 @@ export declare class ModuleSource extends BaseClient {
      * The engine version of the module.
      */
     engineVersion: () => Promise<string>;
+    /**
+     * The generated files and directories made on top of the module source's context directory, returned as a Changeset.
+     */
+    generatedContextChangeset: () => Changeset;
     /**
      * The generated files and directories made on top of the module source's context directory.
      */
@@ -5571,6 +5769,10 @@ export declare class Client extends BaseClient {
      * @param key A string identifier to target this cache volume (e.g., "modules-cache").
      */
     cacheVolume: (key: string) => CacheVolume;
+    /**
+     * Creates an empty changeset
+     */
+    changeset: () => Changeset;
     /**
      * Dagger Cloud configuration and state
      */
@@ -5605,6 +5807,12 @@ export declare class Client extends BaseClient {
      * The TypeDef representations of the objects currently being served in the session.
      */
     currentTypeDefs: () => Promise<TypeDef[]>;
+    /**
+     * Detect and return the current workspace.
+     * @param opts.skipMigrationCheck If true, skip legacy dagger.json migration checks.
+     * @experimental
+     */
+    currentWorkspace: (opts?: ClientCurrentWorkspaceOpts) => Workspace;
     /**
      * The default platform of the engine.
      */
@@ -5819,6 +6027,10 @@ export declare class Client extends BaseClient {
      * Load a GitRepository from its ID.
      */
     loadGitRepositoryFromID: (id: GitRepositoryID) => GitRepository;
+    /**
+     * Load a HealthcheckConfig from its ID.
+     */
+    loadHealthcheckConfigFromID: (id: HealthcheckConfigID) => HealthcheckConfig;
     /**
      * Load a Host from its ID.
      */
@@ -5915,6 +6127,10 @@ export declare class Client extends BaseClient {
      * Load a TypeDef from its ID.
      */
     loadTypeDefFromID: (id: TypeDefID) => TypeDef;
+    /**
+     * Load a Workspace from its ID.
+     */
+    loadWorkspaceFromID: (id: WorkspaceID) => Workspace;
     /**
      * Create a new module.
      */
@@ -6410,6 +6626,58 @@ export declare class TypeDef extends BaseClient {
      */
     with: (arg: (param: TypeDef) => TypeDef) => TypeDef;
 }
+/**
+ * A Dagger workspace detected from the current working directory.
+ */
+export declare class Workspace extends BaseClient {
+    private readonly _id?;
+    private readonly _clientId?;
+    private readonly _findUp?;
+    private readonly _root?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(ctx?: Context, _id?: WorkspaceID, _clientId?: string, _findUp?: string, _root?: string);
+    /**
+     * A unique identifier for this Workspace.
+     */
+    id: () => Promise<WorkspaceID>;
+    /**
+     * The client ID that owns this workspace's host filesystem.
+     */
+    clientId: () => Promise<string>;
+    /**
+     * Returns a Directory from the workspace.
+     *
+     * Path is relative to workspace root. Use "." for the root directory.
+     * @param path Location of the directory to retrieve, relative to the workspace root (e.g., "src", ".").
+     * @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.
+     */
+    directory: (path: string, opts?: WorkspaceDirectoryOpts) => Directory;
+    /**
+     * Returns a File from the workspace.
+     *
+     * Path is relative to workspace root.
+     * @param path Location of the file to retrieve, relative to the workspace root (e.g., "go.mod").
+     */
+    file: (path: string) => File;
+    /**
+     * Search for a file or directory by walking up from the start path within the workspace.
+     *
+     * Returns the path relative to the workspace root if found, or null if not found.
+     *
+     * The search stops at the workspace root and will not traverse above it.
+     * @param name The name of the file or directory to search for.
+     * @param opts.from Path to start the search from, relative to the workspace root.
+     */
+    findUp: (name: string, opts?: WorkspaceFindUpOpts) => Promise<string>;
+    /**
+     * Absolute path to the workspace root directory.
+     */
+    root: () => Promise<string>;
+}
 export declare const dag: Client;
 export {};
 //# sourceMappingURL=client.gen.d.ts.map