@dagger.io/dagger 0.18.9 → 0.18.11

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

@@ -53,6 +53,12 @@ export declare enum CacheSharingMode {
 export type CacheVolumeID = string & {
     __CacheVolumeID: never;
 };
+/**
+ * The `CloudID` scalar type represents an identifier for an object of type Cloud.
+ */
+export type CloudID = string & {
+    __CloudID: never;
+};
 export type ContainerAsServiceOpts = {
     /**
      * Command to run instead of the container's default command (e.g., ["go", "run", "main.go"]).
@@ -483,6 +489,12 @@ export type ContainerWithNewFileOpts = {
      */
     expand?: boolean;
 };
+export type ContainerWithSymlinkOpts = {
+    /**
+     * Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
+     */
+    expand?: boolean;
+};
 export type ContainerWithUnixSocketOpts = {
     /**
      * A user:group to set for the mounted socket.
@@ -696,6 +708,12 @@ export type DirectoryID = string & {
 export type EngineCacheEntrySetOpts = {
     key?: string;
 };
+export type EngineCachePruneOpts = {
+    /**
+     * Use the engine-wide default pruning policy if true, otherwise prune the whole cache of any releasable entries.
+     */
+    useDefaultPolicy?: boolean;
+};
 /**
  * The `EngineCacheEntryID` scalar type represents an identifier for an object of type EngineCacheEntry.
  */
@@ -929,7 +947,9 @@ export declare enum ImageLayerCompression {
  * Mediatypes to use in published or exported image metadata.
  */
 export declare enum ImageMediaTypes {
+    Docker = "DOCKER",
     Dockermediatypes = "DockerMediaTypes",
+    Oci = "OCI",
     Ocimediatypes = "OCIMediaTypes"
 }
 /**
@@ -992,12 +1012,6 @@ export type ModuleConfigClientID = string & {
 export type ModuleID = string & {
     __ModuleID: never;
 };
-export type ModuleSourceWithClientOpts = {
-    /**
-     * Generate in developer mode
-     */
-    dev?: boolean;
-};
 /**
  * The `ModuleSourceID` scalar type represents an identifier for an object of type ModuleSource.
  */
@@ -1008,8 +1022,11 @@ export type ModuleSourceID = string & {
  * The kind of module source.
  */
 export declare enum ModuleSourceKind {
+    Dir = "DIR",
     DirSource = "DIR_SOURCE",
+    Git = "GIT",
     GitSource = "GIT_SOURCE",
+    Local = "LOCAL",
     LocalSource = "LOCAL_SOURCE"
 }
 /**
@@ -1063,9 +1080,6 @@ export type PortForward = {
 export type PortID = string & {
     __PortID: never;
 };
-export type ClientCacheVolumeOpts = {
-    namespace?: string;
-};
 export type ClientContainerOpts = {
     /**
      * Platform to initialize the container with. Defaults to the native platform of the current engine
@@ -1101,6 +1115,10 @@ export type ClientGitOpts = {
      * Set SSH auth socket
      */
     sshAuthSocket?: Socket;
+    /**
+     * Username used to populate the password during basic HTTP Authorization
+     */
+    httpAuthUsername?: string;
     /**
      * Secret used to populate the password during basic HTTP Authorization
      */
@@ -1267,6 +1285,20 @@ export type TypeDefWithEnumOpts = {
      */
     sourceMap?: SourceMap;
 };
+export type TypeDefWithEnumMemberOpts = {
+    /**
+     * The value of the member in the enum
+     */
+    value?: string;
+    /**
+     * A doc string for the member, if any
+     */
+    description?: string;
+    /**
+     * The source map for the enum member definition.
+     */
+    sourceMap?: SourceMap;
+};
 export type TypeDefWithEnumValueOpts = {
     /**
      * A doc string for the value, if any
@@ -1308,54 +1340,108 @@ export type TypeDefID = string & {
  * Distinguishes the different kinds of TypeDefs.
  */
 export declare enum TypeDefKind {
+    /**
+     * A boolean value.
+     */
+    Boolean = "BOOLEAN",
     /**
      * A boolean value.
      */
     BooleanKind = "BOOLEAN_KIND",
+    /**
+     * A GraphQL enum type and its values
+     *
+     * Always paired with an EnumTypeDef.
+     */
+    Enum = "ENUM",
     /**
      * A GraphQL enum type and its values
      *
      * Always paired with an EnumTypeDef.
      */
     EnumKind = "ENUM_KIND",
+    /**
+     * A float value.
+     */
+    Float = "FLOAT",
     /**
      * A float value.
      */
     FloatKind = "FLOAT_KIND",
+    /**
+     * A graphql input type, used only when representing the core API via TypeDefs.
+     */
+    Input = "INPUT",
     /**
      * A graphql input type, used only when representing the core API via TypeDefs.
      */
     InputKind = "INPUT_KIND",
+    /**
+     * An integer value.
+     */
+    Integer = "INTEGER",
     /**
      * An integer value.
      */
     IntegerKind = "INTEGER_KIND",
     /**
-     * A named type of functions that can be matched+implemented by other objects+interfaces.
+     * Always paired with an InterfaceTypeDef.
      *
+     * A named type of functions that can be matched+implemented by other objects+interfaces.
+     */
+    Interface = "INTERFACE",
+    /**
      * Always paired with an InterfaceTypeDef.
+     *
+     * A named type of functions that can be matched+implemented by other objects+interfaces.
      */
     InterfaceKind = "INTERFACE_KIND",
     /**
-     * A list of values all having the same type.
+     * Always paired with a ListTypeDef.
      *
+     * A list of values all having the same type.
+     */
+    List = "LIST",
+    /**
      * Always paired with a ListTypeDef.
+     *
+     * A list of values all having the same type.
      */
     ListKind = "LIST_KIND",
     /**
-     * A named type defined in the GraphQL schema, with fields and functions.
+     * Always paired with an ObjectTypeDef.
      *
+     * A named type defined in the GraphQL schema, with fields and functions.
+     */
+    Object = "OBJECT",
+    /**
      * Always paired with an ObjectTypeDef.
+     *
+     * A named type defined in the GraphQL schema, with fields and functions.
      */
     ObjectKind = "OBJECT_KIND",
+    /**
+     * A scalar value of any basic kind.
+     */
+    Scalar = "SCALAR",
     /**
      * A scalar value of any basic kind.
      */
     ScalarKind = "SCALAR_KIND",
+    /**
+     * A string value.
+     */
+    String = "STRING",
     /**
      * A string value.
      */
     StringKind = "STRING_KIND",
+    /**
+     * 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.
+     */
+    Void = "VOID",
     /**
      * A special kind used to signify that no value is returned.
      *
@@ -1396,6 +1482,10 @@ export declare class Binding extends BaseClient {
      * Retrieve the binding value, as type CacheVolume
      */
     asCacheVolume: () => CacheVolume;
+    /**
+     * Retrieve the binding value, as type Cloud
+     */
+    asCloud: () => Cloud;
     /**
      * Retrieve the binding value, as type Container
      */
@@ -1483,6 +1573,25 @@ export declare class CacheVolume extends BaseClient {
      */
     id: () => Promise<CacheVolumeID>;
 }
+/**
+ * Dagger Cloud configuration and state
+ */
+export declare class Cloud extends BaseClient {
+    private readonly _id?;
+    private readonly _traceURL?;
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(ctx?: Context, _id?: CloudID, _traceURL?: string);
+    /**
+     * A unique identifier for this Cloud.
+     */
+    id: () => Promise<CloudID>;
+    /**
+     * The trace URL for the current session
+     */
+    traceURL: () => Promise<string>;
+}
 /**
  * An OCI-compatible container, also known as a Docker container.
  */
@@ -1945,7 +2054,7 @@ export declare class Container extends BaseClient {
      */
     withSecretVariable: (name: string, secret: Secret) => Container;
     /**
-     * Establish a runtime dependency on a from a container to a network service.
+     * Establish a runtime dependency from a container to a network service.
      *
      * The service will be started automatically when needed and detached when it is no longer needed, executing the default command if none is set.
      *
@@ -1956,6 +2065,13 @@ export declare class Container extends BaseClient {
      * @param service The target service
      */
     withServiceBinding: (alias: string, service: Service) => Container;
+    /**
+     * Return a snapshot with a symlink
+     * @param target Location of the file or directory to link to (e.g., "/existing/file").
+     * @param linkName Location where the symbolic link will be created (e.g., "/new-file-link").
+     * @param opts.expand Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
+     */
+    withSymlink: (target: string, linkName: string, opts?: ContainerWithSymlinkOpts) => 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").
@@ -2250,6 +2366,12 @@ export declare class Directory extends BaseClient {
      * @param opts.permissions Permissions of the new file. Example: 0600
      */
     withNewFile: (path: string, contents: string, opts?: DirectoryWithNewFileOpts) => Directory;
+    /**
+     * Return a snapshot with a symlink
+     * @param target Location of the file or directory to link to (e.g., "/existing/file").
+     * @param linkName Location where the symbolic link will be created (e.g., "/new-file-link").
+     */
+    withSymlink: (target: string, linkName: string) => Directory;
     /**
      * Retrieves this directory with all file/dir timestamps set to the given time.
      * @param timestamp Timestamp to set dir/files in.
@@ -2335,8 +2457,9 @@ export declare class EngineCache extends BaseClient {
     minFreeSpace: () => Promise<number>;
     /**
      * Prune the cache of releaseable entries
+     * @param opts.useDefaultPolicy Use the engine-wide default pruning policy if true, otherwise prune the whole cache of any releasable entries.
      */
-    prune: () => Promise<void>;
+    prune: (opts?: EngineCachePruneOpts) => Promise<void>;
     /**
      * The minimum amount of disk space this policy is guaranteed to retain.
      */
@@ -2433,6 +2556,10 @@ export declare class EnumTypeDef extends BaseClient {
      * A doc string for the enum, if any.
      */
     description: () => Promise<string>;
+    /**
+     * The members of the enum.
+     */
+    members: () => Promise<EnumValueTypeDef[]>;
     /**
      * The name of the enum.
      */
@@ -2446,7 +2573,7 @@ export declare class EnumTypeDef extends BaseClient {
      */
     sourceModuleName: () => Promise<string>;
     /**
-     * The values of the enum.
+     * @deprecated use members instead
      */
     values: () => Promise<EnumValueTypeDef[]>;
 }
@@ -2457,26 +2584,31 @@ export declare class EnumValueTypeDef extends BaseClient {
     private readonly _id?;
     private readonly _description?;
     private readonly _name?;
+    private readonly _value?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx?: Context, _id?: EnumValueTypeDefID, _description?: string, _name?: string);
+    constructor(ctx?: Context, _id?: EnumValueTypeDefID, _description?: string, _name?: string, _value?: string);
     /**
      * A unique identifier for this EnumValueTypeDef.
      */
     id: () => Promise<EnumValueTypeDefID>;
     /**
-     * A doc string for the enum value, if any.
+     * A doc string for the enum member, if any.
      */
     description: () => Promise<string>;
     /**
-     * The name of the enum value.
+     * The name of the enum member.
      */
     name: () => Promise<string>;
     /**
-     * The location of this enum value declaration.
+     * The location of this enum member declaration.
      */
     sourceMap: () => SourceMap;
+    /**
+     * The value of the enum member
+     */
+    value: () => Promise<string>;
 }
 export declare class Env extends BaseClient {
     private readonly _id?;
@@ -2517,6 +2649,19 @@ export declare class Env extends BaseClient {
      * @param description A description of the desired value of the binding
      */
     withCacheVolumeOutput: (name: string, description: string) => Env;
+    /**
+     * Create or update a binding of type Cloud in the environment
+     * @param name The name of the binding
+     * @param value The Cloud value to assign to the binding
+     * @param description The purpose of the input
+     */
+    withCloudInput: (name: string, value: Cloud, description: string) => Env;
+    /**
+     * Declare a desired Cloud output to be assigned in the environment
+     * @param name The name of the binding
+     * @param description A description of the desired value of the binding
+     */
+    withCloudOutput: (name: string, description: string) => Env;
     /**
      * Create or update a binding of type Container in the environment
      * @param name The name of the binding
@@ -3589,21 +3734,16 @@ export declare class Module_ extends BaseClient {
  */
 export declare class ModuleConfigClient extends BaseClient {
     private readonly _id?;
-    private readonly _dev?;
     private readonly _directory?;
     private readonly _generator?;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx?: Context, _id?: ModuleConfigClientID, _dev?: boolean, _directory?: string, _generator?: string);
+    constructor(ctx?: Context, _id?: ModuleConfigClientID, _directory?: string, _generator?: string);
     /**
      * A unique identifier for this ModuleConfigClient.
      */
     id: () => Promise<ModuleConfigClientID>;
-    /**
-     * If true, generate the client in developer mode.
-     */
-    dev: () => Promise<boolean>;
     /**
      * The directory the client is generated in.
      */
@@ -3754,9 +3894,8 @@ export declare class ModuleSource extends BaseClient {
      * Update the module source with a new client to generate.
      * @param generator The generator to use
      * @param outputDir The output directory for the generated client.
-     * @param opts.dev Generate in developer mode
      */
-    withClient: (generator: string, outputDir: string, opts?: ModuleSourceWithClientOpts) => ModuleSource;
+    withClient: (generator: string, outputDir: string) => ModuleSource;
     /**
      * Append the provided dependencies to the module source's dependency list.
      * @param dependencies The dependencies to append.
@@ -3906,7 +4045,11 @@ export declare class Client extends BaseClient {
      * 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, opts?: ClientCacheVolumeOpts) => CacheVolume;
+    cacheVolume: (key: string) => CacheVolume;
+    /**
+     * Dagger Cloud configuration and state
+     */
+    cloud: () => Cloud;
     /**
      * Creates a scratch container, with no image or metadata.
      *
@@ -3979,6 +4122,7 @@ export declare class Client extends BaseClient {
      * @param opts.keepGitDir DEPRECATED: Set to true to keep .git directory.
      * @param opts.sshKnownHosts Set SSH known hosts
      * @param opts.sshAuthSocket Set SSH auth socket
+     * @param opts.httpAuthUsername Username used to populate the password during basic HTTP Authorization
      * @param opts.httpAuthToken Secret used to populate the password during basic HTTP Authorization
      * @param opts.httpAuthHeader Secret used to populate the Authorization HTTP header
      * @param opts.experimentalServiceHost A service which must be started before the repo is fetched.
@@ -4012,6 +4156,10 @@ export declare class Client extends BaseClient {
      * Load a CacheVolume from its ID.
      */
     loadCacheVolumeFromID: (id: CacheVolumeID) => CacheVolume;
+    /**
+     * Load a Cloud from its ID.
+     */
+    loadCloudFromID: (id: CloudID) => Cloud;
     /**
      * Load a Container from its ID.
      */
@@ -4500,11 +4648,20 @@ export declare class TypeDef extends BaseClient {
      * @param opts.sourceMap The source map for the enum definition.
      */
     withEnum: (name: string, opts?: TypeDefWithEnumOpts) => TypeDef;
+    /**
+     * Adds a static value for an Enum TypeDef, failing if the type is not an enum.
+     * @param name The name of the member in the enum
+     * @param opts.value The value of the member in the enum
+     * @param opts.description A doc string for the member, if any
+     * @param opts.sourceMap The source map for the enum member definition.
+     */
+    withEnumMember: (name: string, opts?: TypeDefWithEnumMemberOpts) => TypeDef;
     /**
      * Adds a static value for an Enum TypeDef, failing if the type is not an enum.
      * @param value The name of the value in the enum
      * @param opts.description A doc string for the value, if any
      * @param opts.sourceMap The source map for the enum value definition.
+     * @deprecated Use withEnumMember instead
      */
     withEnumValue: (value: string, opts?: TypeDefWithEnumValueOpts) => TypeDef;
     /**