@dagger.io/dagger 0.9.8 → 0.9.9

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

@@ -165,11 +165,11 @@ export type ContainerPublishOpts = {
      */
     mediaTypes?: ImageMediaTypes;
 };
-export type ContainerShellOpts = {
+export type ContainerTerminalOpts = {
     /**
-     * If set, override the container's default shell and invoke these arguments instead.
+     * If set, override the container's default terminal command and invoke these command arguments instead.
      */
-    args?: string[];
+    cmd?: string[];
 };
 export type ContainerWithDirectoryOpts = {
     /**
@@ -377,13 +377,13 @@ export type CurrentModuleID = string & {
 };
 export type DirectoryAsModuleOpts = {
     /**
-     * An optional subpath of the directory which contains the module's source code.
+     * An optional subpath of the directory which contains the module's configuration file.
      *
      * This is needed when the module code is in a subdirectory but requires parent directories to be loaded in order to execute. For example, the module source code may need a go.mod, project.toml, package.json, etc. file from a parent directory.
      *
      * If not set, the module source code is loaded from the root of the directory.
      */
-    sourceSubpath?: string;
+    sourceRootPath?: string;
 };
 export type DirectoryDockerBuildOpts = {
     /**
@@ -774,10 +774,6 @@ export type ClientModuleDependencyOpts = {
     name?: string;
 };
 export type ClientModuleSourceOpts = {
-    /**
-     * An explicitly set root directory for the module source. This is required to load local sources as modules; other source types implicitly encode the root directory and do not require this.
-     */
-    rootDirectory?: Directory;
     /**
      * If true, enforce that the source is a stable version for source kinds that support versioning.
      */
@@ -816,8 +812,16 @@ export type ServiceStopOpts = {
     kill?: boolean;
 };
 export type ServiceUpOpts = {
+    /**
+     * List of frontend/backend port mappings to forward.
+     *
+     * Frontend is the port accepting traffic on the host, backend is the service port.
+     */
     ports?: PortForward[];
-    native?: boolean;
+    /**
+     * Bind each tunnel port to a random port on the host.
+     */
+    random?: boolean;
 };
 /**
  * The `ServiceID` scalar type represents an identifier for an object of type Service.
@@ -1129,11 +1133,6 @@ export declare class Container extends BaseClient {
      * Retrieves this container's root filesystem. Mounts are not included.
      */
     rootfs: () => Directory;
-    /**
-     * Return an interactive terminal for this container using its configured shell if not overridden by args (or sh as a fallback default).
-     * @param opts.args If set, override the container's default shell and invoke these arguments instead.
-     */
-    shell: (opts?: ContainerShellOpts) => Terminal;
     /**
      * The error stream of the last executed command.
      *
@@ -1152,6 +1151,11 @@ export declare class Container extends BaseClient {
      * It doesn't run the default command if no exec has been set.
      */
     sync: () => Promise<Container>;
+    /**
+     * Return an interactive terminal for this container using its configured default terminal command if not overridden by args (or sh as a fallback default).
+     * @param opts.cmd If set, override the container's default terminal command and invoke these command arguments instead.
+     */
+    terminal: (opts?: ContainerTerminalOpts) => Terminal;
     /**
      * Retrieves the user to be set for all commands.
      */
@@ -1162,10 +1166,10 @@ export declare class Container extends BaseClient {
      */
     withDefaultArgs: (args: string[]) => Container;
     /**
-     * Set the default command to invoke for the "shell" API.
-     * @param args The args of the command to set the default shell to.
+     * Set the default command to invoke for the container's terminal API.
+     * @param args The args of the command.
      */
-    withDefaultShell: (args: string[]) => Container;
+    withDefaultTerminalCmd: (args: string[]) => Container;
     /**
      * Retrieves this container plus a directory written at the given path.
      * @param path Location of the written directory (e.g., "/tmp/directory").
@@ -1493,7 +1497,7 @@ export declare class Directory extends BaseClient {
     id: () => Promise<DirectoryID>;
     /**
      * Load the directory as a Dagger module
-     * @param opts.sourceSubpath An optional subpath of the directory which contains the module's source code.
+     * @param opts.sourceRootPath An optional subpath of the directory which contains the module's configuration file.
      *
      * This is needed when the module code is in a subdirectory but requires parent directories to be loaded in order to execute. For example, the module source code may need a go.mod, project.toml, package.json, etc. file from a parent directory.
      *
@@ -1622,7 +1626,13 @@ export declare class EnvVariable extends BaseClient {
      * A unique identifier for this EnvVariable.
      */
     id: () => Promise<EnvVariableID>;
+    /**
+     * The environment variable name.
+     */
     name: () => Promise<string>;
+    /**
+     * The environment variable value.
+     */
     value: () => Promise<string>;
 }
 /**
@@ -1645,8 +1655,17 @@ export declare class FieldTypeDef extends BaseClient {
      * A unique identifier for this FieldTypeDef.
      */
     id: () => Promise<FieldTypeDefID>;
+    /**
+     * A doc string for the field, if any.
+     */
     description: () => Promise<string>;
+    /**
+     * The name of the field in lowerCamelCase format.
+     */
     name: () => Promise<string>;
+    /**
+     * The type of the field.
+     */
     typeDef: () => TypeDef;
 }
 /**
@@ -1726,9 +1745,21 @@ export declare class Function_ extends BaseClient {
      * A unique identifier for this Function.
      */
     id: () => Promise<FunctionID>;
+    /**
+     * Arguments accepted by the function, if any.
+     */
     args: () => Promise<FunctionArg[]>;
+    /**
+     * A doc string for the function, if any.
+     */
     description: () => Promise<string>;
+    /**
+     * The name of the function.
+     */
     name: () => Promise<string>;
+    /**
+     * The type returned by the function.
+     */
     returnType: () => TypeDef;
     /**
      * Returns the function with the provided argument
@@ -1771,9 +1802,21 @@ export declare class FunctionArg extends BaseClient {
      * A unique identifier for this FunctionArg.
      */
     id: () => Promise<FunctionArgID>;
+    /**
+     * A default value to use for this argument when not explicitly set by the caller, if any.
+     */
     defaultValue: () => Promise<JSON>;
+    /**
+     * A doc string for the argument, if any.
+     */
     description: () => Promise<string>;
+    /**
+     * The name of the argument in lowerCamelCase format.
+     */
     name: () => Promise<string>;
+    /**
+     * The type of the argument.
+     */
     typeDef: () => TypeDef;
 }
 /**
@@ -1796,9 +1839,21 @@ export declare class FunctionCall extends BaseClient {
      * A unique identifier for this FunctionCall.
      */
     id: () => Promise<FunctionCallID>;
+    /**
+     * The argument values the function is being invoked with.
+     */
     inputArgs: () => Promise<FunctionCallArgValue[]>;
+    /**
+     * The name of the function being called.
+     */
     name: () => Promise<string>;
+    /**
+     * The value of the parent object of the function being called. If the function is top-level to the module, this is always an empty object.
+     */
     parent: () => Promise<JSON>;
+    /**
+     * The name of the parent object of the function being called. If the function is top-level to the module, this is the name of the module.
+     */
     parentName: () => Promise<string>;
     /**
      * Set the return value of the function call to the provided value.
@@ -1824,7 +1879,13 @@ export declare class FunctionCallArgValue extends BaseClient {
      * A unique identifier for this FunctionCallArgValue.
      */
     id: () => Promise<FunctionCallArgValueID>;
+    /**
+     * The name of the argument.
+     */
     name: () => Promise<string>;
+    /**
+     * The value of the argument represented as a JSON serialized string.
+     */
     value: () => Promise<JSON>;
 }
 /**
@@ -1843,8 +1904,17 @@ export declare class GeneratedCode extends BaseClient {
      * A unique identifier for this GeneratedCode.
      */
     id: () => Promise<GeneratedCodeID>;
+    /**
+     * The directory containing the generated code.
+     */
     code: () => Directory;
+    /**
+     * List of paths to mark generated in version control (i.e. .gitattributes).
+     */
     vcsGeneratedPaths: () => Promise<string[]>;
+    /**
+     * List of paths to ignore in version control (i.e. .gitignore).
+     */
     vcsIgnoredPaths: () => Promise<string[]>;
     /**
      * Set the list of paths to mark generated in version control.
@@ -1869,7 +1939,7 @@ export declare class GitModuleSource extends BaseClient {
     private readonly _cloneURL?;
     private readonly _commit?;
     private readonly _htmlURL?;
-    private readonly _sourceSubpath?;
+    private readonly _rootSubpath?;
     private readonly _version?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
@@ -1877,7 +1947,7 @@ export declare class GitModuleSource extends BaseClient {
     constructor(parent?: {
         queryTree?: QueryTree[];
         ctx: Context;
-    }, _id?: GitModuleSourceID, _cloneURL?: string, _commit?: string, _htmlURL?: string, _sourceSubpath?: string, _version?: string);
+    }, _id?: GitModuleSourceID, _cloneURL?: string, _commit?: string, _htmlURL?: string, _rootSubpath?: string, _version?: string);
     /**
      * A unique identifier for this GitModuleSource.
      */
@@ -1886,12 +1956,25 @@ export declare class GitModuleSource extends BaseClient {
      * The URL from which the source's git repo can be cloned.
      */
     cloneURL: () => Promise<string>;
+    /**
+     * The resolved commit of the git repo this source points to.
+     */
     commit: () => Promise<string>;
+    /**
+     * The directory containing everything needed to load load and use the module.
+     */
+    contextDirectory: () => Directory;
     /**
      * The URL to the source's git repo in a web browser
      */
     htmlURL: () => Promise<string>;
-    sourceSubpath: () => Promise<string>;
+    /**
+     * The path to the root of the module source under the context directory. This directory contains its configuration file. It also contains its source code (possibly as a subdirectory).
+     */
+    rootSubpath: () => Promise<string>;
+    /**
+     * The specified version of the git repo this source points to.
+     */
     version: () => Promise<string>;
 }
 /**
@@ -1948,6 +2031,11 @@ export declare class GitRepository extends BaseClient {
      * @param id Identifier of the commit (e.g., "b6315d8f2810962c601af73f86831f6866ea798b").
      */
     commit: (id: string) => GitRef;
+    /**
+     * Returns details of a ref.
+     * @param name Ref's name (can be a commit identifier, a tag name, a branch name, or a fully-qualified ref).
+     */
+    ref: (name: string) => GitRef;
     /**
      * Returns details of a tag.
      * @param name Tag's name (e.g., "v0.3.9").
@@ -2041,7 +2129,13 @@ export declare class InputTypeDef extends BaseClient {
      * A unique identifier for this InputTypeDef.
      */
     id: () => Promise<InputTypeDefID>;
+    /**
+     * Static fields defined on this input object, if any.
+     */
     fields: () => Promise<FieldTypeDef[]>;
+    /**
+     * The name of the input object.
+     */
     name: () => Promise<string>;
 }
 /**
@@ -2063,9 +2157,21 @@ export declare class InterfaceTypeDef extends BaseClient {
      * A unique identifier for this InterfaceTypeDef.
      */
     id: () => Promise<InterfaceTypeDefID>;
+    /**
+     * The doc string for the interface, if any.
+     */
     description: () => Promise<string>;
+    /**
+     * Functions defined on this interface, if any.
+     */
     functions: () => Promise<Function_[]>;
+    /**
+     * The name of the interface.
+     */
     name: () => Promise<string>;
+    /**
+     * If this InterfaceTypeDef is associated with a Module, the name of the module. Unset otherwise.
+     */
     sourceModuleName: () => Promise<string>;
 }
 /**
@@ -2086,7 +2192,13 @@ export declare class Label extends BaseClient {
      * A unique identifier for this Label.
      */
     id: () => Promise<LabelID>;
+    /**
+     * The label name.
+     */
     name: () => Promise<string>;
+    /**
+     * The label value.
+     */
     value: () => Promise<string>;
 }
 /**
@@ -2105,6 +2217,9 @@ export declare class ListTypeDef extends BaseClient {
      * A unique identifier for this ListTypeDef.
      */
     id: () => Promise<ListTypeDefID>;
+    /**
+     * The type of the elements in the list.
+     */
     elementTypeDef: () => TypeDef;
 }
 /**
@@ -2112,19 +2227,26 @@ export declare class ListTypeDef extends BaseClient {
  */
 export declare class LocalModuleSource extends BaseClient {
     private readonly _id?;
-    private readonly _sourceSubpath?;
+    private readonly _rootSubpath?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
     constructor(parent?: {
         queryTree?: QueryTree[];
         ctx: Context;
-    }, _id?: LocalModuleSourceID, _sourceSubpath?: string);
+    }, _id?: LocalModuleSourceID, _rootSubpath?: string);
     /**
      * A unique identifier for this LocalModuleSource.
      */
     id: () => Promise<LocalModuleSourceID>;
-    sourceSubpath: () => Promise<string>;
+    /**
+     * The directory containing everything needed to load load and use the module.
+     */
+    contextDirectory: () => Directory;
+    /**
+     * The path to the root of the module source under the context directory. This directory contains its configuration file. It also contains its source code (possibly as a subdirectory).
+     */
+    rootSubpath: () => Promise<string>;
 }
 /**
  * A Dagger module.
@@ -2146,21 +2268,49 @@ export declare class Module_ extends BaseClient {
      * A unique identifier for this Module.
      */
     id: () => Promise<ModuleID>;
+    /**
+     * Modules used by this module.
+     */
     dependencies: () => Promise<Module_[]>;
+    /**
+     * The dependencies as configured by the module.
+     */
     dependencyConfig: () => Promise<ModuleDependency[]>;
+    /**
+     * The doc string of the module, if any
+     */
     description: () => Promise<string>;
     /**
-     * The module's root directory containing the config file for it and its source (possibly as a subdir). It includes any generated code or updated config files created after initial load, but not any files/directories that were unchanged after sdk codegen was run.
+     * The generated files and directories made on top of the module source's context directory.
+     */
+    generatedContextDiff: () => Directory;
+    /**
+     * The module source's context plus any configuration and source files created by codegen.
      */
-    generatedSourceRootDirectory: () => Directory;
+    generatedContextDirectory: () => Directory;
     /**
      * Retrieves the module with the objects loaded via its SDK.
      */
     initialize: () => Module_;
+    /**
+     * Interfaces served by this module.
+     */
     interfaces: () => Promise<TypeDef[]>;
+    /**
+     * The name of the module
+     */
     name: () => Promise<string>;
+    /**
+     * Objects served by this module.
+     */
     objects: () => Promise<TypeDef[]>;
+    /**
+     * The container that runs the module's entrypoint. It will fail to execute if the module doesn't compile.
+     */
     runtime: () => Container;
+    /**
+     * The SDK used by this module. Either a name of a builtin SDK or a module source ref string pointing to the SDK's implementation.
+     */
     sdk: () => Promise<string>;
     /**
      * Serve a module's API in the current session.
@@ -2168,12 +2318,10 @@ export declare class Module_ extends BaseClient {
      * Note: this can only be called once per session. In the future, it could return a stream or service to remove the side effect.
      */
     serve: () => Promise<Void>;
-    source: () => ModuleSource;
     /**
-     * Update the module configuration to use the given dependencies.
-     * @param dependencies The dependency modules to install.
+     * The source for the module.
      */
-    withDependencies: (dependencies: ModuleDependency[]) => Module_;
+    source: () => ModuleSource;
     /**
      * Retrieves the module with the given description
      * @param description The description to set
@@ -2183,20 +2331,10 @@ export declare class Module_ extends BaseClient {
      * This module plus the given Interface type and associated functions
      */
     withInterface: (iface: TypeDef) => Module_;
-    /**
-     * Update the module configuration to use the given name.
-     * @param name The name to use.
-     */
-    withName: (name: string) => Module_;
     /**
      * This module plus the given Object type and associated functions.
      */
     withObject: (object: TypeDef) => Module_;
-    /**
-     * Update the module configuration to use the given SDK.
-     * @param sdk The SDK to use.
-     */
-    withSDK: (sdk: string) => Module_;
     /**
      * Retrieves the module with basic configuration loaded if present.
      * @param source The module source to initialize from.
@@ -2226,7 +2364,13 @@ export declare class ModuleDependency extends BaseClient {
      * A unique identifier for this ModuleDependency.
      */
     id: () => Promise<ModuleDependencyID>;
+    /**
+     * The name of the dependency module.
+     */
     name: () => Promise<string>;
+    /**
+     * The source for the dependency module.
+     */
     source: () => ModuleSource;
 }
 /**
@@ -2235,21 +2379,31 @@ export declare class ModuleDependency extends BaseClient {
 export declare class ModuleSource extends BaseClient {
     private readonly _id?;
     private readonly _asString?;
+    private readonly _configExists?;
     private readonly _kind?;
     private readonly _moduleName?;
-    private readonly _subpath?;
+    private readonly _moduleOriginalName?;
+    private readonly _resolveContextPathFromCaller?;
+    private readonly _sourceRootSubpath?;
+    private readonly _sourceSubpath?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
     constructor(parent?: {
         queryTree?: QueryTree[];
         ctx: Context;
-    }, _id?: ModuleSourceID, _asString?: string, _kind?: ModuleSourceKind, _moduleName?: string, _subpath?: string);
+    }, _id?: ModuleSourceID, _asString?: string, _configExists?: boolean, _kind?: ModuleSourceKind, _moduleName?: string, _moduleOriginalName?: string, _resolveContextPathFromCaller?: string, _sourceRootSubpath?: string, _sourceSubpath?: string);
     /**
      * A unique identifier for this ModuleSource.
      */
     id: () => Promise<ModuleSourceID>;
+    /**
+     * If the source is a of kind git, the git source representation of it.
+     */
     asGitSource: () => GitModuleSource;
+    /**
+     * If the source is of kind local, the local source representation of it.
+     */
     asLocalSource: () => LocalModuleSource;
     /**
      * Load the source as a module. If this is a local source, the parent directory must have been provided during module source creation
@@ -2260,25 +2414,80 @@ export declare class ModuleSource extends BaseClient {
      */
     asString: () => Promise<string>;
     /**
-     * The directory containing the actual module's source code, as determined from the root directory and subpath.
+     * Returns whether the module source has a configuration file.
+     */
+    configExists: () => Promise<boolean>;
+    /**
+     * The directory containing everything needed to load load and use the module.
+     */
+    contextDirectory: () => Directory;
+    /**
+     * The dependencies of the module source. Includes dependencies from the configuration and any extras from withDependencies calls.
+     */
+    dependencies: () => Promise<ModuleDependency[]>;
+    /**
+     * The directory containing the module configuration and source code (source code may be in a subdir).
      * @param path The path from the source directory to select.
      */
     directory: (path: string) => Directory;
+    /**
+     * The kind of source (e.g. local, git, etc.)
+     */
     kind: () => Promise<ModuleSourceKind>;
     /**
-     * If set, the name of the module this source references
+     * If set, the name of the module this source references, including any overrides at runtime by callers.
      */
     moduleName: () => Promise<string>;
+    /**
+     * The original name of the module this source references, as defined in the module configuration.
+     */
+    moduleOriginalName: () => Promise<string>;
+    /**
+     * The path to the module source's context directory on the caller's filesystem. Only valid for local sources.
+     */
+    resolveContextPathFromCaller: () => Promise<string>;
     /**
      * Resolve the provided module source arg as a dependency relative to this module source.
      * @param dep The dependency module source to resolve.
      */
     resolveDependency: (dep: ModuleSource) => ModuleSource;
-    rootDirectory: () => Directory;
     /**
-     * The path to the module subdirectory containing the actual module's source code.
+     * Load the source from its path on the caller's filesystem, including only needed+configured files and directories. Only valid for local sources.
      */
-    subpath: () => Promise<string>;
+    resolveFromCaller: () => ModuleSource;
+    /**
+     * The path relative to context of the root of the module source, which contains dagger.json. It also contains the module implementation source code, but that may or may not being a subdir of this root.
+     */
+    sourceRootSubpath: () => Promise<string>;
+    /**
+     * The path relative to context of the module implementation source code.
+     */
+    sourceSubpath: () => Promise<string>;
+    /**
+     * Update the module source with a new context directory. Only valid for local sources.
+     * @param dir The directory to set as the context directory.
+     */
+    withContextDirectory: (dir: Directory) => ModuleSource;
+    /**
+     * Append the provided dependencies to the module source's dependency list.
+     * @param dependencies The dependencies to append.
+     */
+    withDependencies: (dependencies: ModuleDependency[]) => ModuleSource;
+    /**
+     * Update the module source with a new name.
+     * @param name The name to set.
+     */
+    withName: (name: string) => ModuleSource;
+    /**
+     * Update the module source with a new SDK.
+     * @param sdk The SDK to set.
+     */
+    withSDK: (sdk: string) => ModuleSource;
+    /**
+     * Update the module source with a new source subpath.
+     * @param path The path to set as the source subpath.
+     */
+    withSourceSubpath: (path: string) => ModuleSource;
     /**
      * Call the provided function with current ModuleSource.
      *
@@ -2305,11 +2514,29 @@ export declare class ObjectTypeDef extends BaseClient {
      * A unique identifier for this ObjectTypeDef.
      */
     id: () => Promise<ObjectTypeDefID>;
+    /**
+     * The function used to construct new instances of this object, if any
+     */
     constructor_: () => Function_;
+    /**
+     * The doc string for the object, if any.
+     */
     description: () => Promise<string>;
+    /**
+     * Static fields defined on this object, if any.
+     */
     fields: () => Promise<FieldTypeDef[]>;
+    /**
+     * Functions defined on this object, if any.
+     */
     functions: () => Promise<Function_[]>;
+    /**
+     * The name of the object.
+     */
     name: () => Promise<string>;
+    /**
+     * If this ObjectTypeDef is associated with a Module, the name of the module. Unset otherwise.
+     */
     sourceModuleName: () => Promise<string>;
 }
 /**
@@ -2332,9 +2559,21 @@ export declare class Port extends BaseClient {
      * A unique identifier for this Port.
      */
     id: () => Promise<PortID>;
+    /**
+     * The port description.
+     */
     description: () => Promise<string>;
+    /**
+     * Skip the health check when run as a service.
+     */
     experimentalSkipHealthcheck: () => Promise<boolean>;
+    /**
+     * The port number.
+     */
     port: () => Promise<number>;
+    /**
+     * The transport layer protocol.
+     */
     protocol: () => Promise<NetworkProtocol>;
 }
 /**
@@ -2573,7 +2812,6 @@ export declare class Client extends BaseClient {
     /**
      * Create a new module source instance from a source ref string.
      * @param refString The string ref representation of the module source
-     * @param opts.rootDirectory An explicitly set root directory for the module source. This is required to load local sources as modules; other source types implicitly encode the root directory and do not require this.
      * @param opts.stable If true, enforce that the source is a stable version for source kinds that support versioning.
      */
     moduleSource: (refString: string, opts?: ClientModuleSourceOpts) => ModuleSource;
@@ -2686,6 +2924,10 @@ export declare class Service extends BaseClient {
     stop: (opts?: ServiceStopOpts) => Promise<Service>;
     /**
      * Creates a tunnel that forwards traffic from the caller's network to this service.
+     * @param opts.ports List of frontend/backend port mappings to forward.
+     *
+     * Frontend is the port accepting traffic on the host, backend is the service port.
+     * @param opts.random Bind each tunnel port to a random port on the host.
      */
     up: (opts?: ServiceUpOpts) => Promise<Void>;
 }
@@ -2746,11 +2988,29 @@ export declare class TypeDef extends BaseClient {
      * A unique identifier for this TypeDef.
      */
     id: () => Promise<TypeDefID>;
+    /**
+     * If kind is INPUT, the input-specific type definition. If kind is not INPUT, this will be null.
+     */
     asInput: () => InputTypeDef;
+    /**
+     * If kind is INTERFACE, the interface-specific type definition. If kind is not INTERFACE, this will be null.
+     */
     asInterface: () => InterfaceTypeDef;
+    /**
+     * If kind is LIST, the list-specific type definition. If kind is not LIST, this will be null.
+     */
     asList: () => ListTypeDef;
+    /**
+     * If kind is OBJECT, the object-specific type definition. If kind is not OBJECT, this will be null.
+     */
     asObject: () => ObjectTypeDef;
+    /**
+     * The kind of type this is (e.g. primitive, list, object).
+     */
     kind: () => Promise<TypeDefKind>;
+    /**
+     * Whether this type can be set to null. Defaults to false.
+     */
     optional: () => Promise<boolean>;
     /**
      * Adds a function for constructing a new instance of an Object TypeDef, failing if the type is not an object.