@dagger.io/dagger 0.6.3 → 0.6.4

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

@@ -136,6 +136,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 +174,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 = {
     /**
@@ -484,7 +496,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 +504,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.
  */
@@ -600,28 +619,6 @@ export type __TypeFieldsOpts = {
  */
 export declare class CacheVolume extends BaseClient {
     id(): Promise<CacheID>;
-    /**
-     * 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;
 }
 /**
  * An OCI-compatible container, also known as a docker container.
@@ -692,6 +689,7 @@ export declare class Container extends BaseClient {
      * 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.
+     * @deprecated Use sync instead.
      */
     exitCode(): Promise<number>;
     /**
@@ -708,6 +706,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>;
     /**
@@ -800,6 +801,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>;
     /**
@@ -910,6 +914,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").
@@ -1052,6 +1061,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 +1094,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;
 }
@@ -1153,6 +1153,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 +1209,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;
 }
@@ -1239,28 +1227,6 @@ 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.
@@ -1290,6 +1256,10 @@ export declare class File extends BaseClient {
      * 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 +1268,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;
 }
@@ -1324,36 +1278,10 @@ export declare class File extends BaseClient {
  * A git ref (tag, branch or commit).
  */
 export declare class GitRef extends BaseClient {
-    /**
-     * The digest of the current value of this ref.
-     */
-    digest(): Promise<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.
@@ -1364,10 +1292,6 @@ export declare class GitRepository extends BaseClient {
      * @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,32 +1302,6 @@ 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.
@@ -1438,28 +1336,6 @@ export declare class Host extends BaseClient {
      * @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.
@@ -1474,28 +1350,6 @@ export declare class HostVariable extends BaseClient {
      * 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.
@@ -1509,28 +1363,6 @@ 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.
@@ -1548,28 +1380,6 @@ 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.
@@ -1592,25 +1402,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;
 }
@@ -1642,28 +1436,6 @@ 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.
@@ -1677,28 +1449,6 @@ 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 {
     /**
@@ -1775,6 +1525,12 @@ 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.
@@ -1788,56 +1544,12 @@ 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 {
     /**
      * 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