@dagger.io/dagger 0.6.3 → 0.8.0

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

@@ -98,30 +98,6 @@ export type ContainerEndpointOpts = {
      */
     scheme?: string;
 };
-export type ContainerExecOpts = {
-    /**
-     * Command to run instead of the container's default command (e.g., ["run", "main.go"]).
-     */
-    args?: string[];
-    /**
-     * Content to write to the command's standard input before closing (e.g., "Hello world").
-     */
-    stdin?: string;
-    /**
-     * Redirect the command's standard output to a file in the container (e.g., "/tmp/stdout").
-     */
-    redirectStdout?: string;
-    /**
-     * Redirect the command's standard error to a file in the container (e.g., "/tmp/stderr").
-     */
-    redirectStderr?: string;
-    /**
-     * Provide dagger access to the executed command.
-     * Do not use this option unless you trust the command being executed.
-     * The command being executed WILL BE GRANTED FULL ACCESS TO YOUR HOST FILESYSTEM.
-     */
-    experimentalPrivilegedNesting?: boolean;
-};
 export type ContainerExportOpts = {
     /**
      * Identifiers for other platform specific containers.
@@ -136,6 +112,12 @@ export type ContainerExportOpts = {
      * engine's cache, then it will be compressed using Gzip.
      */
     forcedCompression?: ImageLayerCompression;
+    /**
+     * Use the specified media types for the exported 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 ContainerImportOpts = {
     /**
@@ -168,6 +150,12 @@ export type ContainerPublishOpts = {
      * engine's cache, then it will be compressed using Gzip.
      */
     forcedCompression?: ImageLayerCompression;
+    /**
+     * Use the specified media types for the published image's layers. Defaults to OCI, which
+     * is largely compatible with most recent registries, but Docker may be needed for older
+     * registries without OCI support.
+     */
+    mediaTypes?: ImageMediaTypes;
 };
 export type ContainerWithDefaultArgsOpts = {
     /**
@@ -467,16 +455,6 @@ export type HostDirectoryOpts = {
      */
     include?: string[];
 };
-export type HostWorkdirOpts = {
-    /**
-     * 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[];
-};
 /**
  * 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.
  */
@@ -484,7 +462,7 @@ export type ID = string & {
     __ID: never;
 };
 /**
- * Compression algorithm to use for image layers
+ * Compression algorithm to use for image layers.
  */
 export declare enum ImageLayerCompression {
     Estargz = 0,
@@ -492,6 +470,13 @@ export declare enum ImageLayerCompression {
     Uncompressed = 2,
     Zstd = 3
 }
+/**
+ * Mediatypes to use in published or exported image metadata.
+ */
+export declare enum ImageMediaTypes {
+    Dockermediatypes = 0,
+    Ocimediatypes = 1
+}
 /**
  * Transport layer network protocol associated to a port.
  */
@@ -599,34 +584,43 @@ export type __TypeFieldsOpts = {
  * A directory whose contents persist across runs.
  */
 export declare class CacheVolume extends BaseClient {
-    id(): Promise<CacheID>;
+    private readonly _id?;
     /**
-     * Chain objects together
-     * @example
-     * ```ts
-     *	function AddAFewMounts(c) {
-     *			return c
-     *			.withMountedDirectory("/foo", new Client().host().directory("/Users/slumbering/forks/dagger"))
-     *			.withMountedDirectory("/bar", new Client().host().directory("/Users/slumbering/forks/dagger/sdk/nodejs"))
-     *	}
-     *
-     * connect(async (client) => {
-     *		const tree = await client
-     *			.container()
-     *			.from("alpine")
-     *			.withWorkdir("/foo")
-     *			.with(AddAFewMounts)
-     *			.withExec(["ls", "-lh"])
-     *			.stdout()
-     * })
-     *```
-     */
-    with(arg: (param: CacheVolume) => CacheVolume): CacheVolume;
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent?: {
+        queryTree?: QueryTree[];
+        host?: string;
+        sessionToken?: string;
+    }, _id?: CacheID);
+    id(): Promise<CacheID>;
 }
 /**
  * An OCI-compatible container, also known as a docker container.
  */
 export declare class Container extends BaseClient {
+    private readonly _endpoint?;
+    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 _stderr?;
+    private readonly _stdout?;
+    private readonly _sync?;
+    private readonly _user?;
+    private readonly _workdir?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent?: {
+        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);
     /**
      * Initializes this container from a Dockerfile build.
      * @param context Directory context used by the Dockerfile.
@@ -676,24 +670,6 @@ export declare class Container extends BaseClient {
      * Retrieves the list of environment variables passed to commands.
      */
     envVariables(): Promise<EnvVariable[]>;
-    /**
-     * Retrieves this container after executing the specified command inside it.
-     * @param opts.args Command to run instead of the container's default command (e.g., ["run", "main.go"]).
-     * @param opts.stdin Content to write to the command's standard input before closing (e.g., "Hello world").
-     * @param opts.redirectStdout Redirect the command's standard output to a file in the container (e.g., "/tmp/stdout").
-     * @param opts.redirectStderr Redirect the command's standard error to a file in the container (e.g., "/tmp/stderr").
-     * @param opts.experimentalPrivilegedNesting Provide dagger access to the executed command.
-     * Do not use this option unless you trust the command being executed.
-     * The command being executed WILL BE GRANTED FULL ACCESS TO YOUR HOST FILESYSTEM.
-     * @deprecated Replaced by withExec.
-     */
-    exec(opts?: ContainerExecOpts): Container;
-    /**
-     * Exit code of the last executed command. Zero means success.
-     *
-     * Will execute default command if none is set, or error if there's no default.
-     */
-    exitCode(): Promise<number>;
     /**
      * Writes the container as an OCI tarball to the destination file path on the host for the specified platform variants.
      *
@@ -708,6 +684,9 @@ export declare class Container extends BaseClient {
      * 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 exported 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.
      */
     export(path: string, opts?: ContainerExportOpts): Promise<boolean>;
     /**
@@ -733,11 +712,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 this container's root filesystem. Mounts are not included.
-     * @deprecated Replaced by rootfs.
-     */
-    fs(): Directory;
     /**
      * Retrieves a hostname which can be used by clients to reach this container.
      *
@@ -800,6 +774,9 @@ export declare class Container extends BaseClient {
      * 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 published image's layers. Defaults to OCI, which
+     * is largely compatible with most recent registries, but Docker may be needed for older
+     * registries without OCI support.
      */
     publish(address: string, opts?: ContainerPublishOpts): Promise<string>;
     /**
@@ -891,11 +868,6 @@ export declare class Container extends BaseClient {
      * @param opts.description Optional port description
      */
     withExposedPort(port: number, opts?: ContainerWithExposedPortOpts): Container;
-    /**
-     * Initializes this container from this DirectoryID.
-     * @deprecated Replaced by withRootfs.
-     */
-    withFS(id: Directory): Container;
     /**
      * Retrieves this container plus the contents of the given file copied to the given path.
      * @param path Location of the copied file (e.g., "/tmp/file.txt").
@@ -910,6 +882,11 @@ export declare class Container extends BaseClient {
      * If the group is omitted, it defaults to the same as the user.
      */
     withFile(path: string, source: File, opts?: ContainerWithFileOpts): Container;
+    /**
+     * Indicate that subsequent operations should be featured more prominently in
+     * the UI.
+     */
+    withFocus(): Container;
     /**
      * Retrieves this container plus the given label.
      * @param name The name of the label (e.g., "org.opencontainers.artifact.created").
@@ -996,7 +973,7 @@ export declare class Container extends BaseClient {
     /**
      * Initializes this container from this DirectoryID.
      */
-    withRootfs(id: Directory): Container;
+    withRootfs(directory: Directory): Container;
     /**
      * Retrieves this container plus an env variable containing the given secret.
      * @param name The name of the secret variable (e.g., "API_SECRET").
@@ -1052,6 +1029,13 @@ export declare class Container extends BaseClient {
      * @param opts.protocol Port protocol to unexpose
      */
     withoutExposedPort(port: number, opts?: ContainerWithoutExposedPortOpts): Container;
+    /**
+     * Indicate that subsequent operations should not be featured more prominently
+     * in the UI.
+     *
+     * This is the initial state of all containers.
+     */
+    withoutFocus(): Container;
     /**
      * Retrieves this container minus the given environment label.
      * @param name The name of the label to remove (e.g., "org.opencontainers.artifact.created").
@@ -1078,25 +1062,9 @@ export declare class Container extends BaseClient {
      */
     workdir(): Promise<string>;
     /**
-     * Chain objects together
-     * @example
-     * ```ts
-     *	function AddAFewMounts(c) {
-     *			return c
-     *			.withMountedDirectory("/foo", new Client().host().directory("/Users/slumbering/forks/dagger"))
-     *			.withMountedDirectory("/bar", new Client().host().directory("/Users/slumbering/forks/dagger/sdk/nodejs"))
-     *	}
-     *
-     * connect(async (client) => {
-     *		const tree = await client
-     *			.container()
-     *			.from("alpine")
-     *			.withWorkdir("/foo")
-     *			.with(AddAFewMounts)
-     *			.withExec(["ls", "-lh"])
-     *			.stdout()
-     * })
-     *```
+     * Call the provided function with current Container.
+     *
+     * This is useful for reusability and readability by not breaking the calling chain.
      */
     with(arg: (param: Container) => Container): Container;
 }
@@ -1104,6 +1072,17 @@ export declare class Container extends BaseClient {
  * A directory.
  */
 export declare class Directory extends BaseClient {
+    private readonly _export?;
+    private readonly _id?;
+    private readonly _sync?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent?: {
+        queryTree?: QueryTree[];
+        host?: string;
+        sessionToken?: string;
+    }, _export?: boolean, _id?: DirectoryID, _sync?: DirectoryID);
     /**
      * Gets the difference between this directory and an another directory.
      * @param other Identifier of the directory to compare.
@@ -1153,6 +1132,10 @@ export declare class Directory extends BaseClient {
      * @param opts.labels Pipeline labels.
      */
     pipeline(name: string, opts?: DirectoryPipelineOpts): Directory;
+    /**
+     * Force evaluation in the engine.
+     */
+    sync(): Promise<Directory>;
     /**
      * Retrieves this directory plus a directory written at the given path.
      * @param path Location of the written directory (e.g., "/src/").
@@ -1205,25 +1188,9 @@ export declare class Directory extends BaseClient {
      */
     withoutFile(path: string): Directory;
     /**
-     * Chain objects together
-     * @example
-     * ```ts
-     *	function AddAFewMounts(c) {
-     *			return c
-     *			.withMountedDirectory("/foo", new Client().host().directory("/Users/slumbering/forks/dagger"))
-     *			.withMountedDirectory("/bar", new Client().host().directory("/Users/slumbering/forks/dagger/sdk/nodejs"))
-     *	}
-     *
-     * connect(async (client) => {
-     *		const tree = await client
-     *			.container()
-     *			.from("alpine")
-     *			.withWorkdir("/foo")
-     *			.with(AddAFewMounts)
-     *			.withExec(["ls", "-lh"])
-     *			.stdout()
-     * })
-     *```
+     * Call the provided function with current Directory.
+     *
+     * This is useful for reusability and readability by not breaking the calling chain.
      */
     with(arg: (param: Directory) => Directory): Directory;
 }
@@ -1231,6 +1198,16 @@ export declare class Directory extends BaseClient {
  * A simple key value object that represents an environment variable.
  */
 export declare class EnvVariable 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?: string);
     /**
      * The environment variable name.
      */
@@ -1239,33 +1216,24 @@ export declare class EnvVariable extends BaseClient {
      * The environment variable value.
      */
     value(): Promise<string>;
-    /**
-     * Chain objects together
-     * @example
-     * ```ts
-     *	function AddAFewMounts(c) {
-     *			return c
-     *			.withMountedDirectory("/foo", new Client().host().directory("/Users/slumbering/forks/dagger"))
-     *			.withMountedDirectory("/bar", new Client().host().directory("/Users/slumbering/forks/dagger/sdk/nodejs"))
-     *	}
-     *
-     * connect(async (client) => {
-     *		const tree = await client
-     *			.container()
-     *			.from("alpine")
-     *			.withWorkdir("/foo")
-     *			.with(AddAFewMounts)
-     *			.withExec(["ls", "-lh"])
-     *			.stdout()
-     * })
-     *```
-     */
-    with(arg: (param: EnvVariable) => EnvVariable): EnvVariable;
 }
 /**
  * A file.
  */
 export declare class File extends BaseClient {
+    private readonly _contents?;
+    private readonly _export?;
+    private readonly _id?;
+    private readonly _size?;
+    private readonly _sync?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent?: {
+        queryTree?: QueryTree[];
+        host?: string;
+        sessionToken?: string;
+    }, _contents?: string, _export?: boolean, _id?: FileID, _size?: number, _sync?: FileID);
     /**
      * Retrieves the contents of the file.
      */
@@ -1281,15 +1249,14 @@ export declare class File extends BaseClient {
      * Retrieves the content-addressed identifier of the file.
      */
     id(): Promise<FileID>;
-    /**
-     * Retrieves a secret referencing the contents of this file.
-     * @deprecated insecure, leaves secret in cache. Superseded by setSecret
-     */
-    secret(): Secret;
     /**
      * Gets the size of the file, in bytes.
      */
     size(): Promise<number>;
+    /**
+     * Force evaluation in the engine.
+     */
+    sync(): Promise<File>;
     /**
      * Retrieves this file with its created/modified timestamps set to the given time.
      * @param timestamp Timestamp to set dir/files in.
@@ -1298,25 +1265,9 @@ export declare class File extends BaseClient {
      */
     withTimestamps(timestamp: number): File;
     /**
-     * Chain objects together
-     * @example
-     * ```ts
-     *	function AddAFewMounts(c) {
-     *			return c
-     *			.withMountedDirectory("/foo", new Client().host().directory("/Users/slumbering/forks/dagger"))
-     *			.withMountedDirectory("/bar", new Client().host().directory("/Users/slumbering/forks/dagger/sdk/nodejs"))
-     *	}
-     *
-     * connect(async (client) => {
-     *		const tree = await client
-     *			.container()
-     *			.from("alpine")
-     *			.withWorkdir("/foo")
-     *			.with(AddAFewMounts)
-     *			.withExec(["ls", "-lh"])
-     *			.stdout()
-     * })
-     *```
+     * Call the provided function with current File.
+     *
+     * This is useful for reusability and readability by not breaking the calling chain.
      */
     with(arg: (param: File) => File): File;
 }
@@ -1325,49 +1276,35 @@ export declare class File extends BaseClient {
  */
 export declare class GitRef extends BaseClient {
     /**
-     * The digest of the current value of this ref.
+     * Constructor is used for internal usage only, do not create object from it.
      */
-    digest(): Promise<string>;
+    constructor(parent?: {
+        queryTree?: QueryTree[];
+        host?: string;
+        sessionToken?: string;
+    });
     /**
      * The filesystem tree at this ref.
      */
     tree(opts?: GitRefTreeOpts): Directory;
-    /**
-     * Chain objects together
-     * @example
-     * ```ts
-     *	function AddAFewMounts(c) {
-     *			return c
-     *			.withMountedDirectory("/foo", new Client().host().directory("/Users/slumbering/forks/dagger"))
-     *			.withMountedDirectory("/bar", new Client().host().directory("/Users/slumbering/forks/dagger/sdk/nodejs"))
-     *	}
-     *
-     * connect(async (client) => {
-     *		const tree = await client
-     *			.container()
-     *			.from("alpine")
-     *			.withWorkdir("/foo")
-     *			.with(AddAFewMounts)
-     *			.withExec(["ls", "-lh"])
-     *			.stdout()
-     * })
-     *```
-     */
-    with(arg: (param: GitRef) => GitRef): GitRef;
 }
 /**
  * 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;
-    /**
-     * Lists of branches on the repository.
-     */
-    branches(): Promise<string[]>;
     /**
      * Returns details on one commit.
      * @param id Identifier of the commit (e.g., "b6315d8f2810962c601af73f86831f6866ea798b").
@@ -1378,37 +1315,19 @@ export declare class GitRepository extends BaseClient {
      * @param name Tag's name (e.g., "v0.3.9").
      */
     tag(name: string): GitRef;
-    /**
-     * Lists of tags on the repository.
-     */
-    tags(): Promise<string[]>;
-    /**
-     * Chain objects together
-     * @example
-     * ```ts
-     *	function AddAFewMounts(c) {
-     *			return c
-     *			.withMountedDirectory("/foo", new Client().host().directory("/Users/slumbering/forks/dagger"))
-     *			.withMountedDirectory("/bar", new Client().host().directory("/Users/slumbering/forks/dagger/sdk/nodejs"))
-     *	}
-     *
-     * connect(async (client) => {
-     *		const tree = await client
-     *			.container()
-     *			.from("alpine")
-     *			.withWorkdir("/foo")
-     *			.with(AddAFewMounts)
-     *			.withExec(["ls", "-lh"])
-     *			.stdout()
-     * })
-     *```
-     */
-    with(arg: (param: GitRepository) => GitRepository): GitRepository;
 }
 /**
  * Information about the host execution environment.
  */
 export declare class Host extends BaseClient {
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent?: {
+        queryTree?: QueryTree[];
+        host?: string;
+        sessionToken?: string;
+    });
     /**
      * Accesses a directory on the host.
      * @param path Location of the directory to access (e.g., ".").
@@ -1416,91 +1335,38 @@ export declare class Host extends BaseClient {
      * @param opts.include Include only artifacts that match the given pattern (e.g., ["app/", "package.*"]).
      */
     directory(path: string, opts?: HostDirectoryOpts): Directory;
-    /**
-     * Accesses an environment variable on the host.
-     * @param name Name of the environment variable (e.g., "PATH").
-     */
-    envVariable(name: string): HostVariable;
     /**
      * Accesses a file on the host.
      * @param path Location of the file to retrieve (e.g., "README.md").
      */
     file(path: string): File;
+    /**
+     * 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.
+     * @param name The user defined name for this secret.
+     * @param path Location of the file to set as a secret.
+     */
+    setSecretFile(name: string, path: string): Secret;
     /**
      * Accesses a Unix socket on the host.
      * @param path Location of the Unix socket (e.g., "/var/run/docker.sock").
      */
     unixSocket(path: string): Socket;
-    /**
-     * Retrieves the current working directory on the host.
-     * @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.*"]).
-     * @deprecated Use directory with path set to '.' instead.
-     */
-    workdir(opts?: HostWorkdirOpts): Directory;
-    /**
-     * Chain objects together
-     * @example
-     * ```ts
-     *	function AddAFewMounts(c) {
-     *			return c
-     *			.withMountedDirectory("/foo", new Client().host().directory("/Users/slumbering/forks/dagger"))
-     *			.withMountedDirectory("/bar", new Client().host().directory("/Users/slumbering/forks/dagger/sdk/nodejs"))
-     *	}
-     *
-     * connect(async (client) => {
-     *		const tree = await client
-     *			.container()
-     *			.from("alpine")
-     *			.withWorkdir("/foo")
-     *			.with(AddAFewMounts)
-     *			.withExec(["ls", "-lh"])
-     *			.stdout()
-     * })
-     *```
-     */
-    with(arg: (param: Host) => Host): Host;
-}
-/**
- * An environment variable on the host environment.
- */
-export declare class HostVariable extends BaseClient {
-    /**
-     * A secret referencing the value of this variable.
-     * @deprecated been superseded by setSecret
-     */
-    secret(): Secret;
-    /**
-     * The value of this variable.
-     */
-    value(): Promise<string>;
-    /**
-     * Chain objects together
-     * @example
-     * ```ts
-     *	function AddAFewMounts(c) {
-     *			return c
-     *			.withMountedDirectory("/foo", new Client().host().directory("/Users/slumbering/forks/dagger"))
-     *			.withMountedDirectory("/bar", new Client().host().directory("/Users/slumbering/forks/dagger/sdk/nodejs"))
-     *	}
-     *
-     * connect(async (client) => {
-     *		const tree = await client
-     *			.container()
-     *			.from("alpine")
-     *			.withWorkdir("/foo")
-     *			.with(AddAFewMounts)
-     *			.withExec(["ls", "-lh"])
-     *			.stdout()
-     * })
-     *```
-     */
-    with(arg: (param: HostVariable) => HostVariable): HostVariable;
 }
 /**
  * A simple key value object that represents a label.
  */
 export declare class Label 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?: string);
     /**
      * The label name.
      */
@@ -1509,33 +1375,22 @@ export declare class Label extends BaseClient {
      * The label value.
      */
     value(): Promise<string>;
-    /**
-     * Chain objects together
-     * @example
-     * ```ts
-     *	function AddAFewMounts(c) {
-     *			return c
-     *			.withMountedDirectory("/foo", new Client().host().directory("/Users/slumbering/forks/dagger"))
-     *			.withMountedDirectory("/bar", new Client().host().directory("/Users/slumbering/forks/dagger/sdk/nodejs"))
-     *	}
-     *
-     * connect(async (client) => {
-     *		const tree = await client
-     *			.container()
-     *			.from("alpine")
-     *			.withWorkdir("/foo")
-     *			.with(AddAFewMounts)
-     *			.withExec(["ls", "-lh"])
-     *			.stdout()
-     * })
-     *```
-     */
-    with(arg: (param: Label) => Label): Label;
 }
 /**
  * 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.
      */
@@ -1548,33 +1403,21 @@ export declare class Port extends BaseClient {
      * The transport layer network protocol.
      */
     protocol(): Promise<NetworkProtocol>;
-    /**
-     * Chain objects together
-     * @example
-     * ```ts
-     *	function AddAFewMounts(c) {
-     *			return c
-     *			.withMountedDirectory("/foo", new Client().host().directory("/Users/slumbering/forks/dagger"))
-     *			.withMountedDirectory("/bar", new Client().host().directory("/Users/slumbering/forks/dagger/sdk/nodejs"))
-     *	}
-     *
-     * connect(async (client) => {
-     *		const tree = await client
-     *			.container()
-     *			.from("alpine")
-     *			.withWorkdir("/foo")
-     *			.with(AddAFewMounts)
-     *			.withExec(["ls", "-lh"])
-     *			.stdout()
-     * })
-     *```
-     */
-    with(arg: (param: Port) => Port): Port;
 }
 /**
  * A collection of Dagger resources that can be queried and invoked.
  */
 export declare class Project extends BaseClient {
+    private readonly _id?;
+    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?: ProjectID, _name?: string);
     /**
      * Commands provided by this project
      */
@@ -1592,25 +1435,9 @@ export declare class Project extends BaseClient {
      */
     name(): Promise<string>;
     /**
-     * Chain objects together
-     * @example
-     * ```ts
-     *	function AddAFewMounts(c) {
-     *			return c
-     *			.withMountedDirectory("/foo", new Client().host().directory("/Users/slumbering/forks/dagger"))
-     *			.withMountedDirectory("/bar", new Client().host().directory("/Users/slumbering/forks/dagger/sdk/nodejs"))
-     *	}
-     *
-     * connect(async (client) => {
-     *		const tree = await client
-     *			.container()
-     *			.from("alpine")
-     *			.withWorkdir("/foo")
-     *			.with(AddAFewMounts)
-     *			.withExec(["ls", "-lh"])
-     *			.stdout()
-     * })
-     *```
+     * Call the provided function with current Project.
+     *
+     * This is useful for reusability and readability by not breaking the calling chain.
      */
     with(arg: (param: Project) => Project): Project;
 }
@@ -1618,6 +1445,18 @@ export declare class Project extends BaseClient {
  * A command defined in a project that can be invoked from the CLI.
  */
 export declare class ProjectCommand extends BaseClient {
+    private readonly _description?;
+    private readonly _id?;
+    private readonly _name?;
+    private readonly _resultType?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent?: {
+        queryTree?: QueryTree[];
+        host?: string;
+        sessionToken?: string;
+    }, _description?: string, _id?: ProjectCommandID, _name?: string, _resultType?: string);
     /**
      * Documentation for what this command does.
      */
@@ -1642,33 +1481,21 @@ export declare class ProjectCommand extends BaseClient {
      * Subcommands, if any, that this command provides.
      */
     subcommands(): Promise<ProjectCommand[]>;
-    /**
-     * Chain objects together
-     * @example
-     * ```ts
-     *	function AddAFewMounts(c) {
-     *			return c
-     *			.withMountedDirectory("/foo", new Client().host().directory("/Users/slumbering/forks/dagger"))
-     *			.withMountedDirectory("/bar", new Client().host().directory("/Users/slumbering/forks/dagger/sdk/nodejs"))
-     *	}
-     *
-     * connect(async (client) => {
-     *		const tree = await client
-     *			.container()
-     *			.from("alpine")
-     *			.withWorkdir("/foo")
-     *			.with(AddAFewMounts)
-     *			.withExec(["ls", "-lh"])
-     *			.stdout()
-     * })
-     *```
-     */
-    with(arg: (param: ProjectCommand) => ProjectCommand): ProjectCommand;
 }
 /**
  * A flag accepted by a project command.
  */
 export declare class ProjectCommandFlag 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);
     /**
      * Documentation for what this flag sets.
      */
@@ -1677,35 +1504,28 @@ export declare class ProjectCommandFlag extends BaseClient {
      * The name of the flag.
      */
     name(): Promise<string>;
-    /**
-     * Chain objects together
-     * @example
-     * ```ts
-     *	function AddAFewMounts(c) {
-     *			return c
-     *			.withMountedDirectory("/foo", new Client().host().directory("/Users/slumbering/forks/dagger"))
-     *			.withMountedDirectory("/bar", new Client().host().directory("/Users/slumbering/forks/dagger/sdk/nodejs"))
-     *	}
-     *
-     * connect(async (client) => {
-     *		const tree = await client
-     *			.container()
-     *			.from("alpine")
-     *			.withWorkdir("/foo")
-     *			.with(AddAFewMounts)
-     *			.withExec(["ls", "-lh"])
-     *			.stdout()
-     * })
-     *```
-     */
-    with(arg: (param: ProjectCommandFlag) => ProjectCommandFlag): ProjectCommandFlag;
 }
-export default class Client extends BaseClient {
+export declare class Client extends BaseClient {
+    private readonly _checkVersionCompatibility?;
+    private readonly _defaultPlatform?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent?: {
+        queryTree?: QueryTree[];
+        host?: string;
+        sessionToken?: string;
+    }, _checkVersionCompatibility?: boolean, _defaultPlatform?: Platform);
     /**
      * Constructs a cache volume for a given cache key.
      * @param key A string identifier to target this cache volume (e.g., "modules-cache").
      */
     cacheVolume(key: string): CacheVolume;
+    /**
+     * Checks if the current Dagger Engine is compatible with an SDK's required version.
+     * @param version The SDK's required version.
+     */
+    checkVersionCompatibility(version: string): Promise<boolean>;
     /**
      * Loads a container from ID.
      *
@@ -1775,11 +1595,27 @@ export default class Client extends BaseClient {
      * Loads a socket by its ID.
      */
     socket(opts?: ClientSocketOpts): Socket;
+    /**
+     * Call the provided function with current Client.
+     *
+     * This is useful for reusability and readability by not breaking the calling chain.
+     */
+    with(arg: (param: Client) => Client): Client;
 }
 /**
  * A reference to a secret value, which can be handled more safely than the value itself.
  */
 export declare class Secret extends BaseClient {
+    private readonly _id?;
+    private readonly _plaintext?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent?: {
+        queryTree?: QueryTree[];
+        host?: string;
+        sessionToken?: string;
+    }, _id?: SecretID, _plaintext?: string);
     /**
      * The identifier for this secret.
      */
@@ -1788,56 +1624,21 @@ export declare class Secret extends BaseClient {
      * The value of this secret.
      */
     plaintext(): Promise<string>;
-    /**
-     * Chain objects together
-     * @example
-     * ```ts
-     *	function AddAFewMounts(c) {
-     *			return c
-     *			.withMountedDirectory("/foo", new Client().host().directory("/Users/slumbering/forks/dagger"))
-     *			.withMountedDirectory("/bar", new Client().host().directory("/Users/slumbering/forks/dagger/sdk/nodejs"))
-     *	}
-     *
-     * connect(async (client) => {
-     *		const tree = await client
-     *			.container()
-     *			.from("alpine")
-     *			.withWorkdir("/foo")
-     *			.with(AddAFewMounts)
-     *			.withExec(["ls", "-lh"])
-     *			.stdout()
-     * })
-     *```
-     */
-    with(arg: (param: Secret) => Secret): Secret;
 }
 export declare class Socket 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?: SocketID);
     /**
      * The content-addressed identifier of the socket.
      */
     id(): Promise<SocketID>;
-    /**
-     * Chain objects together
-     * @example
-     * ```ts
-     *	function AddAFewMounts(c) {
-     *			return c
-     *			.withMountedDirectory("/foo", new Client().host().directory("/Users/slumbering/forks/dagger"))
-     *			.withMountedDirectory("/bar", new Client().host().directory("/Users/slumbering/forks/dagger/sdk/nodejs"))
-     *	}
-     *
-     * connect(async (client) => {
-     *		const tree = await client
-     *			.container()
-     *			.from("alpine")
-     *			.withWorkdir("/foo")
-     *			.with(AddAFewMounts)
-     *			.withExec(["ls", "-lh"])
-     *			.stdout()
-     * })
-     *```
-     */
-    with(arg: (param: Socket) => Socket): Socket;
 }
 export {};
 //# sourceMappingURL=client.gen.d.ts.map