@dagger.io/dagger 0.8.7 → 0.9.0

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

@@ -50,12 +50,6 @@ export type BuildArg = {
      */
     value: string;
 };
-/**
- * A global cache volume identifier.
- */
-export type CacheID = string & {
-    __CacheID: never;
-};
 /**
  * Sharing mode of the cache volume.
  */
@@ -74,6 +68,33 @@ export declare enum CacheSharingMode {
      */
     Shared = "SHARED"
 }
+/**
+ * A global cache volume identifier.
+ */
+export type CacheVolumeID = string & {
+    __CacheVolumeID: never;
+};
+export type ContainerAsTarballOpts = {
+    /**
+     * Identifiers for other platform specific containers.
+     * Used for multi-platform image.
+     */
+    platformVariants?: Container[];
+    /**
+     * Force each layer of the image to use the specified compression algorithm.
+     * If this is unset, then if a layer already has a compressed blob in the engine's
+     * cache, that will be used (this can result in a mix of compression algorithms for
+     * different layers). If this is unset and a layer has no compressed blob in the
+     * engine's cache, then it will be compressed using Gzip.
+     */
+    forcedCompression?: ImageLayerCompression;
+    /**
+     * Use the specified media types for the image's layers. Defaults to OCI, which
+     * is largely compatible with most recent container runtimes, but Docker may be needed
+     * for older runtimes without OCI support.
+     */
+    mediaTypes?: ImageMediaTypes;
+};
 export type ContainerBuildOpts = {
     /**
      * Path to the Dockerfile to use.
@@ -100,16 +121,6 @@ export type ContainerBuildOpts = {
      */
     secrets?: Secret[];
 };
-export type ContainerEndpointOpts = {
-    /**
-     * The exposed port number for the endpoint
-     */
-    port?: number;
-    /**
-     * Return a URL with the given scheme, eg. http for http://
-     */
-    scheme?: string;
-};
 export type ContainerExportOpts = {
     /**
      * Identifiers for other platform specific containers.
@@ -365,6 +376,21 @@ export type ContainerID = string & {
 export type DateTime = string & {
     __DateTime: never;
 };
+export type DirectoryAsModuleOpts = {
+    /**
+     * An optional subpath of the directory which contains the module's source
+     * code.
+     *
+     * 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;
+};
 export type DirectoryDockerBuildOpts = {
     /**
      * Path to the Dockerfile to use (e.g., "frontend.Dockerfile").
@@ -460,6 +486,47 @@ export type FileExportOpts = {
 export type FileID = string & {
     __FileID: never;
 };
+export type FunctionCallOpts = {
+    input?: FunctionCallInput[];
+};
+export type FunctionWithArgOpts = {
+    /**
+     * A doc string for the argument, if any
+     */
+    description?: string;
+    /**
+     * A default value to use for this argument if not explicitly set by the caller, if any
+     */
+    defaultValue?: JSON;
+};
+/**
+ * A reference to a FunctionArg.
+ */
+export type FunctionArgID = string & {
+    __FunctionArgID: never;
+};
+export type FunctionCallInput = {
+    /**
+     * The name of the argument to the function
+     */
+    name: string;
+    /**
+     * The value of the argument represented as a string of the JSON serialization.
+     */
+    value: JSON;
+};
+/**
+ * A reference to a Function.
+ */
+export type FunctionID = string & {
+    __FunctionID: never;
+};
+/**
+ * A reference to GeneratedCode.
+ */
+export type GeneratedCodeID = string & {
+    __GeneratedCodeID: never;
+};
 export type GitRefTreeOpts = {
     sshKnownHosts?: string;
     sshAuthSocket?: Socket;
@@ -474,6 +541,34 @@ export type HostDirectoryOpts = {
      */
     include?: string[];
 };
+export type HostServiceOpts = {
+    /**
+     * Upstream host to forward traffic to.
+     */
+    host?: string;
+};
+export type HostTunnelOpts = {
+    /**
+     * Map each service port to the same port on the host, as if the service were
+     * running natively.
+     *
+     * Note: enabling may result in port conflicts.
+     */
+    native?: boolean;
+    /**
+     * Configure explicit port forwarding rules for the tunnel.
+     *
+     * If a port's frontend is unspecified or 0, a random port will be chosen by
+     * the host.
+     *
+     * If no ports are given, all of the service's ports are forwarded. If native
+     * is true, each port maps to the same port on the host. If native is false,
+     * each port maps to a random port chosen by the host.
+     *
+     * If ports are given and native is true, the ports are additive.
+     */
+    ports?: PortForward[];
+};
 /**
  * The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.
  */
@@ -496,6 +591,18 @@ export declare enum ImageMediaTypes {
     Dockermediatypes = "DockerMediaTypes",
     Ocimediatypes = "OCIMediaTypes"
 }
+/**
+ * An arbitrary JSON-encoded value.
+ */
+export type JSON = string & {
+    __JSON: never;
+};
+/**
+ * A reference to a Module.
+ */
+export type ModuleID = string & {
+    __ModuleID: never;
+};
 /**
  * Transport layer network protocol associated to a port.
  */
@@ -527,17 +634,19 @@ export type PipelineLabel = {
 export type Platform = string & {
     __Platform: never;
 };
-/**
- * A unique project command identifier.
- */
-export type ProjectCommandID = string & {
-    __ProjectCommandID: never;
-};
-/**
- * A unique project identifier.
- */
-export type ProjectID = string & {
-    __ProjectID: never;
+export type PortForward = {
+    /**
+     * Destination port for traffic.
+     */
+    backend: number;
+    /**
+     * Port to expose to clients. If unspecified, a default will be chosen.
+     */
+    frontend?: number;
+    /**
+     * Protocol to use for traffic.
+     */
+    protocol?: NetworkProtocol;
 };
 export type ClientContainerOpts = {
     id?: ContainerID;
@@ -554,13 +663,16 @@ export type ClientGitOpts = {
     /**
      * A service which must be started before the repo is fetched.
      */
-    experimentalServiceHost?: Container;
+    experimentalServiceHost?: Service;
 };
 export type ClientHttpOpts = {
     /**
      * A service which must be started before the URL is fetched.
      */
-    experimentalServiceHost?: Container;
+    experimentalServiceHost?: Service;
+};
+export type ClientModuleConfigOpts = {
+    subpath?: string;
 };
 export type ClientPipelineOpts = {
     /**
@@ -572,12 +684,6 @@ export type ClientPipelineOpts = {
      */
     labels?: PipelineLabel[];
 };
-export type ClientProjectOpts = {
-    id?: ProjectID;
-};
-export type ClientProjectCommandOpts = {
-    id?: ProjectCommandID;
-};
 export type ClientSocketOpts = {
     id?: SocketID;
 };
@@ -587,12 +693,88 @@ export type ClientSocketOpts = {
 export type SecretID = string & {
     __SecretID: never;
 };
+export type ServiceEndpointOpts = {
+    /**
+     * The exposed port number for the endpoint
+     */
+    port?: number;
+    /**
+     * Return a URL with the given scheme, eg. http for http://
+     */
+    scheme?: string;
+};
+/**
+ * A unique service identifier.
+ */
+export type ServiceID = string & {
+    __ServiceID: never;
+};
 /**
  * A content-addressed socket identifier.
  */
 export type SocketID = string & {
     __SocketID: never;
 };
+export type TypeDefWithFieldOpts = {
+    /**
+     * A doc string for the field, if any
+     */
+    description?: string;
+};
+export type TypeDefWithObjectOpts = {
+    description?: string;
+};
+/**
+ * A reference to a TypeDef.
+ */
+export type TypeDefID = string & {
+    __TypeDefID: never;
+};
+/**
+ * Distinguishes the different kinds of TypeDefs.
+ */
+export declare enum TypeDefKind {
+    /**
+     * A boolean value
+     */
+    Booleankind = "BooleanKind",
+    /**
+     * An integer value
+     */
+    Integerkind = "IntegerKind",
+    /**
+     * A list of values all having the same type.
+     *
+     * Always paired with a ListTypeDef.
+     */
+    Listkind = "ListKind",
+    /**
+     * A named type defined in the GraphQL schema, with fields and functions.
+     *
+     * Always paired with an ObjectTypeDef.
+     */
+    Objectkind = "ObjectKind",
+    /**
+     * A string value
+     */
+    Stringkind = "StringKind",
+    /**
+     * A special kind used to signify that no value is returned.
+     *
+     * This is used for functions that have no return value. The outer TypeDef
+     * specifying this Kind is always Optional, as the Void is never actually
+     * represented.
+     */
+    Voidkind = "VoidKind"
+}
+/**
+ * The absense of a value.
+ *
+ * A Null Void is used as a placeholder for resolvers that do not return anything.
+ */
+export type Void = string & {
+    __Void: never;
+};
 export type __TypeEnumValuesOpts = {
     includeDeprecated?: boolean;
 };
@@ -611,22 +793,21 @@ export declare class CacheVolume extends BaseClient {
         queryTree?: QueryTree[];
         host?: string;
         sessionToken?: string;
-    }, _id?: CacheID);
-    id(): Promise<CacheID>;
+    }, _id?: CacheVolumeID);
+    id(): Promise<CacheVolumeID>;
 }
 /**
  * An OCI-compatible container, also known as a docker container.
  */
 export declare class Container extends BaseClient {
-    private readonly _endpoint?;
+    private readonly _id?;
     private readonly _envVariable?;
     private readonly _export?;
-    private readonly _hostname?;
-    private readonly _id?;
     private readonly _imageRef?;
     private readonly _label?;
     private readonly _platform?;
     private readonly _publish?;
+    private readonly _shellEndpoint?;
     private readonly _stderr?;
     private readonly _stdout?;
     private readonly _sync?;
@@ -639,7 +820,31 @@ export declare class Container extends BaseClient {
         queryTree?: QueryTree[];
         host?: string;
         sessionToken?: string;
-    }, _endpoint?: string, _envVariable?: string, _export?: boolean, _hostname?: string, _id?: ContainerID, _imageRef?: string, _label?: string, _platform?: Platform, _publish?: string, _stderr?: string, _stdout?: string, _sync?: ContainerID, _user?: string, _workdir?: string);
+    }, _id?: ContainerID, _envVariable?: string, _export?: boolean, _imageRef?: string, _label?: string, _platform?: Platform, _publish?: string, _shellEndpoint?: string, _stderr?: string, _stdout?: string, _sync?: ContainerID, _user?: string, _workdir?: string);
+    /**
+     * A unique identifier for this container.
+     */
+    id(): Promise<ContainerID>;
+    /**
+     * Turn the container into a Service.
+     *
+     * Be sure to set any exposed ports before this conversion.
+     */
+    asService(): Service;
+    /**
+     * Returns a File representing the container serialized to a tarball.
+     * @param opts.platformVariants Identifiers for other platform specific containers.
+     * Used for multi-platform image.
+     * @param opts.forcedCompression Force each layer of the image to use the specified compression algorithm.
+     * If this is unset, then if a layer already has a compressed blob in the engine's
+     * cache, that will be used (this can result in a mix of compression algorithms for
+     * different layers). If this is unset and a layer has no compressed blob in the
+     * engine's cache, then it will be compressed using Gzip.
+     * @param opts.mediaTypes Use the specified media types for the image's layers. Defaults to OCI, which
+     * is largely compatible with most recent container runtimes, but Docker may be needed
+     * for older runtimes without OCI support.
+     */
+    asTarball(opts?: ContainerAsTarballOpts): File;
     /**
      * Initializes this container from a Dockerfile build.
      * @param context Directory context used by the Dockerfile.
@@ -668,18 +873,6 @@ export declare class Container extends BaseClient {
      * @param path The path of the directory to retrieve (e.g., "./src").
      */
     directory(path: string): Directory;
-    /**
-     * Retrieves an endpoint that clients can use to reach this container.
-     *
-     * If no port is specified, the first exposed port is used. If none exist an error is returned.
-     *
-     * If a scheme is specified, a URL is returned. Otherwise, a host:port pair is returned.
-     *
-     * Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
-     * @param opts.port The exposed port number for the endpoint
-     * @param opts.scheme Return a URL with the given scheme, eg. http for http://
-     */
-    endpoint(opts?: ContainerEndpointOpts): Promise<string>;
     /**
      * Retrieves entrypoint to be prepended to the arguments of all commands.
      */
@@ -717,8 +910,6 @@ export declare class Container extends BaseClient {
      *
      * This includes ports already exposed by the image, even if not
      * explicitly added with dagger.
-     *
-     * Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
      */
     exposedPorts(): Promise<Port[]>;
     /**
@@ -735,16 +926,6 @@ export declare class Container extends BaseClient {
      * Formatted as [host]/[user]/[repo]:[tag] (e.g., "docker.io/dagger/dagger:main").
      */
     from(address: string): Container;
-    /**
-     * Retrieves a hostname which can be used by clients to reach this container.
-     *
-     * Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
-     */
-    hostname(): Promise<string>;
-    /**
-     * A unique identifier for this container.
-     */
-    id(): Promise<ContainerID>;
     /**
      * The unique image reference which can only be retrieved immediately after the 'Container.From' call.
      */
@@ -758,7 +939,7 @@ export declare class Container extends BaseClient {
      * @param opts.tag Identifies the tag to import from the archive, if the archive bundles
      * multiple tags.
      */
-    import(source: File, opts?: ContainerImportOpts): Container;
+    import_(source: File, opts?: ContainerImportOpts): Container;
     /**
      * Retrieves the value of the specified label.
      */
@@ -806,6 +987,13 @@ export declare class Container extends BaseClient {
      * Retrieves this container's root filesystem. Mounts are not included.
      */
     rootfs(): Directory;
+    /**
+     * Return a websocket endpoint that, if connected to, will start the container with a TTY streamed
+     * over the websocket.
+     *
+     * Primarily intended for internal use with the dagger CLI.
+     */
+    shellEndpoint(): Promise<string>;
     /**
      * The error stream of the last executed command.
      *
@@ -884,8 +1072,6 @@ export declare class Container extends BaseClient {
      * Exposed ports serve two purposes:
      *   - For health checks and introspection, when running services
      *   - For setting the EXPOSE OCI field when publishing the container
-     *
-     * Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
      * @param port Port number to expose
      * @param opts.protocol Transport layer network protocol
      * @param opts.description Optional port description
@@ -1016,12 +1202,10 @@ export declare class Container extends BaseClient {
      * The service will be reachable from the container via the provided hostname alias.
      *
      * The service dependency will also convey to any files or directories produced by the container.
-     *
-     * Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
      * @param alias A name that can be used to reach the service from the container
      * @param service Identifier of the service container
      */
-    withServiceBinding(alias: string, service: Container): Container;
+    withServiceBinding(alias: string, service: Service): Container;
     /**
      * Retrieves this container plus a socket forwarded to the given Unix socket path.
      * @param path Location of the forwarded Unix socket (e.g., "/tmp/socket").
@@ -1050,8 +1234,6 @@ export declare class Container extends BaseClient {
     withoutEnvVariable(name: string): Container;
     /**
      * Unexpose a previously exposed port.
-     *
-     * Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
      * @param port Port number to unexpose
      * @param opts.protocol Port protocol to unexpose
      */
@@ -1099,8 +1281,8 @@ export declare class Container extends BaseClient {
  * A directory.
  */
 export declare class Directory extends BaseClient {
-    private readonly _export?;
     private readonly _id?;
+    private readonly _export?;
     private readonly _sync?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
@@ -1109,7 +1291,25 @@ export declare class Directory extends BaseClient {
         queryTree?: QueryTree[];
         host?: string;
         sessionToken?: string;
-    }, _export?: boolean, _id?: DirectoryID, _sync?: DirectoryID);
+    }, _id?: DirectoryID, _export?: boolean, _sync?: DirectoryID);
+    /**
+     * The content-addressed identifier of the directory.
+     */
+    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.
+     *
+     * 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.
+     */
+    asModule(opts?: DirectoryAsModuleOpts): Module_;
     /**
      * Gets the difference between this directory and an another directory.
      * @param other Identifier of the directory to compare.
@@ -1148,10 +1348,6 @@ export declare class Directory extends BaseClient {
      * @param path Location of the file to retrieve (e.g., "README.md").
      */
     file(path: string): File;
-    /**
-     * The content-addressed identifier of the directory.
-     */
-    id(): Promise<DirectoryID>;
     /**
      * Creates a named sub-pipeline
      * @param name Pipeline name.
@@ -1244,13 +1440,42 @@ export declare class EnvVariable extends BaseClient {
      */
     value(): Promise<string>;
 }
+/**
+ * A definition of a field on a custom object defined in a Module.
+ * A field on an object has a static value, as opposed to a function on an
+ * object whose value is computed by invoking code (and can accept arguments).
+ */
+export declare class FieldTypeDef extends BaseClient {
+    private readonly _description?;
+    private readonly _name?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent?: {
+        queryTree?: QueryTree[];
+        host?: string;
+        sessionToken?: string;
+    }, _description?: string, _name?: string);
+    /**
+     * A doc string for the field, if any
+     */
+    description(): Promise<string>;
+    /**
+     * The name of the field in the object
+     */
+    name(): Promise<string>;
+    /**
+     * The type of the field
+     */
+    typeDef(): TypeDef;
+}
 /**
  * A file.
  */
 export declare class File extends BaseClient {
+    private readonly _id?;
     private readonly _contents?;
     private readonly _export?;
-    private readonly _id?;
     private readonly _size?;
     private readonly _sync?;
     /**
@@ -1260,7 +1485,11 @@ export declare class File extends BaseClient {
         queryTree?: QueryTree[];
         host?: string;
         sessionToken?: string;
-    }, _contents?: string, _export?: boolean, _id?: FileID, _size?: number, _sync?: FileID);
+    }, _id?: FileID, _contents?: string, _export?: boolean, _size?: number, _sync?: FileID);
+    /**
+     * Retrieves the content-addressed identifier of the file.
+     */
+    id(): Promise<FileID>;
     /**
      * Retrieves the contents of the file.
      */
@@ -1272,10 +1501,6 @@ export declare class File extends BaseClient {
      * the file will be created in that directory.
      */
     export(path: string, opts?: FileExportOpts): Promise<boolean>;
-    /**
-     * Retrieves the content-addressed identifier of the file.
-     */
-    id(): Promise<FileID>;
     /**
      * Gets the size of the file, in bytes.
      */
@@ -1299,9 +1524,16 @@ export declare class File extends BaseClient {
     with(arg: (param: File) => File): File;
 }
 /**
- * A git ref (tag, branch or commit).
+ * Function represents a resolver provided by a Module.
+ *
+ * A function always evaluates against a parent object and is given a set of
+ * named arguments.
  */
-export declare class GitRef extends BaseClient {
+export declare class Function_ extends BaseClient {
+    private readonly _id?;
+    private readonly _call?;
+    private readonly _description?;
+    private readonly _name?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
@@ -1309,31 +1541,227 @@ export declare class GitRef extends BaseClient {
         queryTree?: QueryTree[];
         host?: string;
         sessionToken?: string;
-    });
+    }, _id?: FunctionID, _call?: JSON, _description?: string, _name?: string);
     /**
-     * The filesystem tree at this ref.
+     * The ID of the function
      */
-    tree(opts?: GitRefTreeOpts): Directory;
-}
-/**
- * A git repository.
- */
-export declare class GitRepository extends BaseClient {
+    id(): Promise<FunctionID>;
     /**
-     * Constructor is used for internal usage only, do not create object from it.
+     * Arguments accepted by this function, if any
      */
-    constructor(parent?: {
-        queryTree?: QueryTree[];
-        host?: string;
-        sessionToken?: string;
-    });
+    args(): Promise<FunctionArg[]>;
     /**
-     * Returns details on one branch.
-     * @param name Branch's name (e.g., "main").
+     * Execute this function using dynamic input+output types.
+     *
+     * Typically, it's preferable to invoke a function using a type
+     * safe graphql query rather than using this call field. However,
+     * call is useful for some advanced use cases where dynamically
+     * loading arbitrary modules and invoking functions in them is
+     * required.
      */
-    branch(name: string): GitRef;
+    call(opts?: FunctionCallOpts): Promise<JSON>;
     /**
-     * Returns details on one commit.
+     * A doc string for the function, if any
+     */
+    description(): Promise<string>;
+    /**
+     * The name of the function
+     */
+    name(): Promise<string>;
+    /**
+     * The type returned by this function
+     */
+    returnType(): TypeDef;
+    /**
+     * Returns the function with the provided argument
+     * @param name The name of the argument
+     * @param typeDef The type of the argument
+     * @param opts.description A doc string for the argument, if any
+     * @param opts.defaultValue A default value to use for this argument if not explicitly set by the caller, if any
+     */
+    withArg(name: string, typeDef: TypeDef, opts?: FunctionWithArgOpts): Function_;
+    /**
+     * Returns the function with the doc string
+     */
+    withDescription(description: string): Function_;
+    /**
+     * Call the provided function with current Function.
+     *
+     * This is useful for reusability and readability by not breaking the calling chain.
+     */
+    with(arg: (param: Function_) => Function_): Function_;
+}
+/**
+ * An argument accepted by a function.
+ *
+ * This is a specification for an argument at function definition time, not an
+ * argument passed at function call time.
+ */
+export declare class FunctionArg extends BaseClient {
+    private readonly _id?;
+    private readonly _defaultValue?;
+    private readonly _description?;
+    private readonly _name?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent?: {
+        queryTree?: QueryTree[];
+        host?: string;
+        sessionToken?: string;
+    }, _id?: FunctionArgID, _defaultValue?: JSON, _description?: string, _name?: string);
+    /**
+     * The ID of the argument
+     */
+    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
+     */
+    name(): Promise<string>;
+    /**
+     * The type of the argument
+     */
+    typeDef(): TypeDef;
+}
+export declare class FunctionCall extends BaseClient {
+    private readonly _name?;
+    private readonly _parent?;
+    private readonly _parentName?;
+    private readonly _returnValue?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent?: {
+        queryTree?: QueryTree[];
+        host?: string;
+        sessionToken?: string;
+    }, _name?: string, _parent?: JSON, _parentName?: string, _returnValue?: Void);
+    /**
+     * 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.
+     * The value should be a string of the JSON serialization of the return value.
+     */
+    returnValue(value: JSON): Promise<Void>;
+}
+export declare class FunctionCallArgValue extends BaseClient {
+    private readonly _name?;
+    private readonly _value?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent?: {
+        queryTree?: QueryTree[];
+        host?: string;
+        sessionToken?: string;
+    }, _name?: string, _value?: JSON);
+    /**
+     * The name of the argument.
+     */
+    name(): Promise<string>;
+    /**
+     * The value of the argument represented as a string of the JSON serialization.
+     */
+    value(): Promise<JSON>;
+}
+export declare class GeneratedCode extends BaseClient {
+    private readonly _id?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent?: {
+        queryTree?: QueryTree[];
+        host?: string;
+        sessionToken?: string;
+    }, _id?: GeneratedCodeID);
+    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
+     */
+    withVCSGeneratedPaths(paths: string[]): GeneratedCode;
+    /**
+     * Set the list of paths to ignore in version control
+     */
+    withVCSIgnoredPaths(paths: string[]): GeneratedCode;
+    /**
+     * Call the provided function with current GeneratedCode.
+     *
+     * This is useful for reusability and readability by not breaking the calling chain.
+     */
+    with(arg: (param: GeneratedCode) => GeneratedCode): GeneratedCode;
+}
+/**
+ * A git ref (tag, branch or commit).
+ */
+export declare class GitRef extends BaseClient {
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent?: {
+        queryTree?: QueryTree[];
+        host?: string;
+        sessionToken?: string;
+    });
+    /**
+     * The filesystem tree at this ref.
+     */
+    tree(opts?: GitRefTreeOpts): Directory;
+}
+/**
+ * A git repository.
+ */
+export declare class GitRepository extends BaseClient {
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent?: {
+        queryTree?: QueryTree[];
+        host?: string;
+        sessionToken?: string;
+    });
+    /**
+     * Returns details on one branch.
+     * @param name Branch's name (e.g., "main").
+     */
+    branch(name: string): GitRef;
+    /**
+     * Returns details on one commit.
      * @param id Identifier of the commit (e.g., "b6315d8f2810962c601af73f86831f6866ea798b").
      */
     commit(id: string): GitRef;
@@ -1367,6 +1795,17 @@ export declare class Host extends BaseClient {
      * @param path Location of the file to retrieve (e.g., "README.md").
      */
     file(path: string): File;
+    /**
+     * Creates a service that forwards traffic to a specified address via the host.
+     * @param ports Ports to expose via the service, forwarding through the host network.
+     *
+     * If a port's frontend is unspecified or 0, it defaults to the same as the
+     * backend port.
+     *
+     * An empty set of ports is not valid; an error will be returned.
+     * @param opts.host Upstream host to forward traffic to.
+     */
+    service(ports: PortForward[], opts?: HostServiceOpts): Service;
     /**
      * Sets a secret given a user-defined name and the file path on the host, and returns the secret.
      * The file is limited to a size of 512000 bytes.
@@ -1374,6 +1813,25 @@ export declare class Host extends BaseClient {
      * @param path Location of the file to set as a secret.
      */
     setSecretFile(name: string, path: string): Secret;
+    /**
+     * Creates a tunnel that forwards traffic from the host to a service.
+     * @param service Service to send traffic from the tunnel.
+     * @param opts.native Map each service port to the same port on the host, as if the service were
+     * running natively.
+     *
+     * Note: enabling may result in port conflicts.
+     * @param opts.ports Configure explicit port forwarding rules for the tunnel.
+     *
+     * If a port's frontend is unspecified or 0, a random port will be chosen by
+     * the host.
+     *
+     * If no ports are given, all of the service's ports are forwarded. If native
+     * is true, each port maps to the same port on the host. If native is false,
+     * each port maps to a random port chosen by the host.
+     *
+     * If ports are given and native is true, the ports are additive.
+     */
+    tunnel(service: Service, opts?: HostTunnelOpts): Service;
     /**
      * Accesses a Unix socket on the host.
      * @param path Location of the Unix socket (e.g., "/var/run/docker.sock").
@@ -1404,12 +1862,9 @@ export declare class Label extends BaseClient {
     value(): Promise<string>;
 }
 /**
- * A port exposed by a container.
+ * A definition of a list type in a Module.
  */
-export declare class Port extends BaseClient {
-    private readonly _description?;
-    private readonly _port?;
-    private readonly _protocol?;
+export declare class ListTypeDef extends BaseClient {
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
@@ -1417,26 +1872,19 @@ export declare class Port extends BaseClient {
         queryTree?: QueryTree[];
         host?: string;
         sessionToken?: string;
-    }, _description?: string, _port?: number, _protocol?: NetworkProtocol);
-    /**
-     * The port description.
-     */
-    description(): Promise<string>;
-    /**
-     * The port number.
-     */
-    port(): Promise<number>;
+    });
     /**
-     * The transport layer network protocol.
+     * The type of the elements in the list
      */
-    protocol(): Promise<NetworkProtocol>;
+    elementTypeDef(): TypeDef;
 }
-/**
- * A collection of Dagger resources that can be queried and invoked.
- */
-export declare class Project extends BaseClient {
+export declare class Module_ extends BaseClient {
     private readonly _id?;
+    private readonly _description?;
     private readonly _name?;
+    private readonly _sdk?;
+    private readonly _serve?;
+    private readonly _sourceDirectorySubPath?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
@@ -1444,38 +1892,71 @@ export declare class Project extends BaseClient {
         queryTree?: QueryTree[];
         host?: string;
         sessionToken?: string;
-    }, _id?: ProjectID, _name?: string);
+    }, _id?: ModuleID, _description?: string, _name?: string, _sdk?: string, _serve?: Void, _sourceDirectorySubPath?: string);
+    /**
+     * The ID of the module
+     */
+    id(): Promise<ModuleID>;
     /**
-     * Commands provided by this project
+     * Modules used by this module
      */
-    commands(): Promise<ProjectCommand[]>;
+    dependencies(): Promise<Module_[]>;
     /**
-     * A unique identifier for this project.
+     * The dependencies as configured by the module
      */
-    id(): Promise<ProjectID>;
+    dependencyConfig(): Promise<string[]>;
+    /**
+     * The doc string of the module, if any
+     */
+    description(): Promise<string>;
     /**
-     * Initialize this project from the given directory and config path
+     * The code generated by the SDK's runtime
      */
-    load(source: Directory, configPath: string): Project;
+    generatedCode(): GeneratedCode;
     /**
-     * Name of the project
+     * The name of the module
      */
     name(): Promise<string>;
     /**
-     * Call the provided function with current Project.
+     * Objects served by this module
+     */
+    objects(): Promise<TypeDef[]>;
+    /**
+     * The SDK used by this module. Either a name of a builtin SDK or a module ref pointing to the SDK's implementation.
+     */
+    sdk(): Promise<string>;
+    /**
+     * Serve a module's API in the current session.
+     *     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>;
+    /**
+     * The directory containing the module's source code
+     */
+    sourceDirectory(): Directory;
+    /**
+     * The module's subpath within the source directory
+     */
+    sourceDirectorySubPath(): Promise<string>;
+    /**
+     * This module plus the given Object type and associated functions
+     */
+    withObject(object: TypeDef): Module_;
+    /**
+     * Call the provided function with current Module.
      *
      * This is useful for reusability and readability by not breaking the calling chain.
      */
-    with(arg: (param: Project) => Project): Project;
+    with(arg: (param: Module_) => Module_): Module_;
 }
 /**
- * A command defined in a project that can be invoked from the CLI.
+ * Static configuration for a module (e.g. parsed contents of dagger.json)
  */
-export declare class ProjectCommand extends BaseClient {
-    private readonly _description?;
-    private readonly _id?;
+export declare class ModuleConfig extends BaseClient {
     private readonly _name?;
-    private readonly _resultType?;
+    private readonly _root?;
+    private readonly _sdk?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
@@ -1483,36 +1964,36 @@ export declare class ProjectCommand extends BaseClient {
         queryTree?: QueryTree[];
         host?: string;
         sessionToken?: string;
-    }, _description?: string, _id?: ProjectCommandID, _name?: string, _resultType?: string);
+    }, _name?: string, _root?: string, _sdk?: string);
     /**
-     * Documentation for what this command does.
+     * Modules that this module depends on.
      */
-    description(): Promise<string>;
+    dependencies(): Promise<string[]>;
     /**
-     * Flags accepted by this command.
+     * Exclude these file globs when loading the module root.
      */
-    flags(): Promise<ProjectCommandFlag[]>;
+    exclude(): Promise<string[]>;
     /**
-     * A unique identifier for this command.
+     * Include only these file globs when loading the module root.
      */
-    id(): Promise<ProjectCommandID>;
+    include(): Promise<string[]>;
     /**
-     * The name of the command.
+     * The name of the module.
      */
     name(): Promise<string>;
     /**
-     * The name of the type returned by this command.
+     * The root directory of the module's project, which may be above the module source code.
      */
-    resultType(): Promise<string>;
+    root(): Promise<string>;
     /**
-     * Subcommands, if any, that this command provides.
+     * Either the name of a built-in SDK ('go', 'python', etc.) OR a module reference pointing to the SDK's module implementation.
      */
-    subcommands(): Promise<ProjectCommand[]>;
+    sdk(): Promise<string>;
 }
 /**
- * A flag accepted by a project command.
+ * A definition of a custom object defined in a Module.
  */
-export declare class ProjectCommandFlag extends BaseClient {
+export declare class ObjectTypeDef extends BaseClient {
     private readonly _description?;
     private readonly _name?;
     /**
@@ -1524,14 +2005,50 @@ export declare class ProjectCommandFlag extends BaseClient {
         sessionToken?: string;
     }, _description?: string, _name?: string);
     /**
-     * Documentation for what this flag sets.
+     * The doc string for the object, if any
      */
     description(): Promise<string>;
     /**
-     * The name of the flag.
+     * 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>;
 }
+/**
+ * A port exposed by a container.
+ */
+export declare class Port extends BaseClient {
+    private readonly _description?;
+    private readonly _port?;
+    private readonly _protocol?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent?: {
+        queryTree?: QueryTree[];
+        host?: string;
+        sessionToken?: string;
+    }, _description?: string, _port?: number, _protocol?: NetworkProtocol);
+    /**
+     * The port description.
+     */
+    description(): Promise<string>;
+    /**
+     * The port number.
+     */
+    port(): Promise<number>;
+    /**
+     * The transport layer network protocol.
+     */
+    protocol(): Promise<NetworkProtocol>;
+}
 export declare class Client extends BaseClient {
     private readonly _checkVersionCompatibility?;
     private readonly _defaultPlatform?;
@@ -1554,25 +2071,44 @@ export declare class Client extends BaseClient {
      */
     checkVersionCompatibility(version: string): Promise<boolean>;
     /**
-     * Loads a container from ID.
+     * Creates a scratch container or loads one by ID.
      *
-     * Null ID returns an empty container (scratch).
-     * Optional platform argument initializes new containers to execute and publish as that platform.
-     * Platform defaults to that of the builder's host.
+     * Optional platform argument initializes new containers to execute and publish
+     * as that platform. Platform defaults to that of the builder's host.
      */
     container(opts?: ClientContainerOpts): Container;
+    /**
+     * The FunctionCall context that the SDK caller is currently executing in.
+     * If the caller is not currently executing in a function, this will return
+     * an error.
+     */
+    currentFunctionCall(): FunctionCall;
+    /**
+     * The module currently being served in the session, if any.
+     */
+    currentModule(): Module_;
     /**
      * The default platform of the builder.
      */
     defaultPlatform(): Promise<Platform>;
     /**
-     * Load a directory by ID. No argument produces an empty directory.
+     * Creates an empty directory or loads one by ID.
      */
     directory(opts?: ClientDirectoryOpts): Directory;
     /**
      * Loads a file by ID.
+     * @deprecated Use loadFileFromID instead.
      */
     file(id: FileID): File;
+    /**
+     * Create a function.
+     */
+    function_(name: string, returnType: TypeDef): Function_;
+    /**
+     * Create a code generation result, given a directory containing the generated
+     * code.
+     */
+    generatedCode(code: Directory): GeneratedCode;
     /**
      * Queries a git repository.
      * @param url Url of the git repository.
@@ -1592,6 +2128,62 @@ export declare class Client extends BaseClient {
      * @param opts.experimentalServiceHost A service which must be started before the URL is fetched.
      */
     http(url: string, opts?: ClientHttpOpts): File;
+    /**
+     * Load a CacheVolume from its ID.
+     */
+    loadCacheVolumeFromID(id: CacheVolumeID): CacheVolume;
+    /**
+     * Loads a container from an ID.
+     */
+    loadContainerFromID(id: ContainerID): Container;
+    /**
+     * Load a Directory from its ID.
+     */
+    loadDirectoryFromID(id: DirectoryID): Directory;
+    /**
+     * Load a File from its ID.
+     */
+    loadFileFromID(id: FileID): File;
+    /**
+     * Load a function argument by ID.
+     */
+    loadFunctionArgFromID(id: FunctionArgID): FunctionArg;
+    /**
+     * Load a function by ID.
+     */
+    loadFunctionFromID(id: FunctionID): Function_;
+    /**
+     * Load a GeneratedCode by ID.
+     */
+    loadGeneratedCodeFromID(id: GeneratedCodeID): GeneratedCode;
+    /**
+     * Load a module by ID.
+     */
+    loadModuleFromID(id: ModuleID): Module_;
+    /**
+     * Load a Secret from its ID.
+     */
+    loadSecretFromID(id: SecretID): Secret;
+    /**
+     * Loads a service from ID.
+     */
+    loadServiceFromID(id: ServiceID): Service;
+    /**
+     * Load a Socket from its ID.
+     */
+    loadSocketFromID(id: SocketID): Socket;
+    /**
+     * Load a TypeDef by ID.
+     */
+    loadTypeDefFromID(id: TypeDefID): TypeDef;
+    /**
+     * Create a new module.
+     */
+    module_(): Module_;
+    /**
+     * Load the static configuration for a module from the given source directory and optional subpath.
+     */
+    moduleConfig(sourceDirectory: Directory, opts?: ClientModuleConfigOpts): ModuleConfig;
     /**
      * Creates a named sub-pipeline.
      * @param name Pipeline name.
@@ -1599,16 +2191,9 @@ export declare class Client extends BaseClient {
      * @param opts.labels Pipeline labels.
      */
     pipeline(name: string, opts?: ClientPipelineOpts): Client;
-    /**
-     * Load a project from ID.
-     */
-    project(opts?: ClientProjectOpts): Project;
-    /**
-     * Load a project command from ID.
-     */
-    projectCommand(opts?: ClientProjectCommandOpts): ProjectCommand;
     /**
      * Loads a secret from its ID.
+     * @deprecated Use loadSecretFromID instead
      */
     secret(id: SecretID): Secret;
     /**
@@ -1620,8 +2205,13 @@ export declare class Client extends BaseClient {
     setSecret(name: string, plaintext: string): Secret;
     /**
      * Loads a socket by its ID.
+     * @deprecated Use loadSocketFromID instead.
      */
     socket(opts?: ClientSocketOpts): Socket;
+    /**
+     * Create a new TypeDef.
+     */
+    typeDef(): TypeDef;
     /**
      * Call the provided function with current Client.
      *
@@ -1652,6 +2242,53 @@ export declare class Secret extends BaseClient {
      */
     plaintext(): Promise<string>;
 }
+export declare class Service extends BaseClient {
+    private readonly _id?;
+    private readonly _endpoint?;
+    private readonly _hostname?;
+    private readonly _start?;
+    private readonly _stop?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent?: {
+        queryTree?: QueryTree[];
+        host?: string;
+        sessionToken?: string;
+    }, _id?: ServiceID, _endpoint?: string, _hostname?: string, _start?: ServiceID, _stop?: ServiceID);
+    /**
+     * A unique identifier for this service.
+     */
+    id(): Promise<ServiceID>;
+    /**
+     * Retrieves an endpoint that clients can use to reach this container.
+     *
+     * If no port is specified, the first exposed port is used. If none exist an error is returned.
+     *
+     * If a scheme is specified, a URL is returned. Otherwise, a host:port pair is returned.
+     * @param opts.port The exposed port number for the endpoint
+     * @param opts.scheme Return a URL with the given scheme, eg. http for http://
+     */
+    endpoint(opts?: ServiceEndpointOpts): Promise<string>;
+    /**
+     * Retrieves a hostname which can be used by clients to reach this container.
+     */
+    hostname(): Promise<string>;
+    /**
+     * Retrieves the list of ports provided by the service.
+     */
+    ports(): Promise<Port[]>;
+    /**
+     * Start the service and wait for its health checks to succeed.
+     *
+     * Services bound to a Container do not need to be manually started.
+     */
+    start(): Promise<Service>;
+    /**
+     * Stop the service.
+     */
+    stop(): Promise<Service>;
+}
 export declare class Socket extends BaseClient {
     private readonly _id?;
     /**
@@ -1667,5 +2304,77 @@ export declare class Socket extends BaseClient {
      */
     id(): Promise<SocketID>;
 }
+/**
+ * A definition of a parameter or return type in a Module.
+ */
+export declare class TypeDef extends BaseClient {
+    private readonly _id?;
+    private readonly _kind?;
+    private readonly _optional?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent?: {
+        queryTree?: QueryTree[];
+        host?: string;
+        sessionToken?: string;
+    }, _id?: TypeDefID, _kind?: TypeDefKind, _optional?: boolean);
+    id(): Promise<TypeDefID>;
+    /**
+     * 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 static field for an Object TypeDef, failing if the type is not an object.
+     * @param name The name of the field in the object
+     * @param typeDef The type of the field
+     * @param opts.description A doc string for the field, if any
+     */
+    withField(name: string, typeDef: TypeDef, opts?: TypeDefWithFieldOpts): TypeDef;
+    /**
+     * Adds a function for an Object TypeDef, failing if the type is not an object.
+     */
+    withFunction(function_: Function_): TypeDef;
+    /**
+     * Sets the kind of the type.
+     */
+    withKind(kind: TypeDefKind): TypeDef;
+    /**
+     * Returns a TypeDef of kind List with the provided type for its elements.
+     */
+    withListOf(elementType: TypeDef): TypeDef;
+    /**
+     * Returns a TypeDef of kind Object with the provided name.
+     *
+     * Note that an object's fields and functions may be omitted if the intent is
+     * only to refer to an object. This is how functions are able to return their
+     * own object, or any other circular reference.
+     */
+    withObject(name: string, opts?: TypeDefWithObjectOpts): TypeDef;
+    /**
+     * Sets whether this type can be set to null.
+     */
+    withOptional(optional: boolean): TypeDef;
+    /**
+     * Call the provided function with current TypeDef.
+     *
+     * This is useful for reusability and readability by not breaking the calling chain.
+     */
+    with(arg: (param: TypeDef) => TypeDef): TypeDef;
+}
 export {};
 //# sourceMappingURL=client.gen.d.ts.map