@dagger.io/dagger 0.19.3 → 0.19.5

package/dist/src/api/client.gen.js

@@ -112,6 +112,47 @@ function ExistsTypeNameToValue(name) {
             return name;
     }
 }
+/**
+ * The behavior configured for function result caching.
+ */
+export var FunctionCachePolicy;
+(function (FunctionCachePolicy) {
+    FunctionCachePolicy["Default"] = "Default";
+    FunctionCachePolicy["Never"] = "Never";
+    FunctionCachePolicy["PerSession"] = "PerSession";
+})(FunctionCachePolicy || (FunctionCachePolicy = {}));
+/**
+ * Utility function to convert a FunctionCachePolicy value to its name so
+ * it can be uses as argument to call a exposed function.
+ */
+function FunctionCachePolicyValueToName(value) {
+    switch (value) {
+        case FunctionCachePolicy.Default:
+            return "Default";
+        case FunctionCachePolicy.Never:
+            return "Never";
+        case FunctionCachePolicy.PerSession:
+            return "PerSession";
+        default:
+            return value;
+    }
+}
+/**
+ * Utility function to convert a FunctionCachePolicy name to its value so
+ * it can be properly used inside the module runtime.
+ */
+function FunctionCachePolicyNameToValue(name) {
+    switch (name) {
+        case "Default":
+            return FunctionCachePolicy.Default;
+        case "Never":
+            return FunctionCachePolicy.Never;
+        case "PerSession":
+            return FunctionCachePolicy.PerSession;
+        default:
+            return name;
+    }
+}
 /**
  * Compression algorithm to use for image layers.
  */
@@ -1561,6 +1602,7 @@ export class Container extends BaseClient {
      * @param source Identifier of the directory to write
      * @param opts.exclude Patterns to exclude in the written directory (e.g. ["node_modules/**", ".gitignore", ".git/"]).
      * @param opts.include Patterns to include in the written directory (e.g. ["*.go", "go.mod", "go.sum"]).
+     * @param opts.gitignore Apply .gitignore rules when writing the directory.
      * @param opts.owner A user:group to set for the directory and its contents.
      *
      * The user and group can either be an ID (1000:1000) or a name (foo:bar).
@@ -2094,6 +2136,7 @@ export class CurrentModule extends BaseClient {
      * @param path Location of the directory to access (e.g., ".").
      * @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.*"]).
+     * @param opts.gitignore Apply .gitignore filter rules inside the directory
      */
     workdir = (path, opts) => {
         const ctx = this._ctx.select("workdir", { path, ...opts });
@@ -2292,6 +2335,7 @@ export class Directory extends BaseClient {
      * Return a snapshot with some paths included or excluded
      * @param opts.exclude If set, paths matching one of these glob patterns is excluded from the new snapshot. Example: ["node_modules/", ".git*", ".env"]
      * @param opts.include If set, only paths matching one of these glob patterns is included in the new snapshot. Example: (e.g., ["app/", "package.*"]).
+     * @param opts.gitignore If set, apply .gitignore rules when filtering the directory.
      */
     filter = (opts) => {
         const ctx = this._ctx.select("filter", { ...opts });
@@ -2384,6 +2428,7 @@ export class Directory extends BaseClient {
      * @param source Identifier of the directory to copy.
      * @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.*"]).
+     * @param opts.gitignore Apply .gitignore filter rules inside the directory
      * @param opts.owner A user:group to set for the copied directory and its contents.
      *
      * The user and group must be an ID (1000:1000), not a name (foo:bar).
@@ -2541,6 +2586,14 @@ export class Engine extends BaseClient {
         const response = await ctx.execute();
         return response;
     };
+    /**
+     * The list of connected client IDs
+     */
+    clients = async () => {
+        const ctx = this._ctx.select("clients");
+        const response = await ctx.execute();
+        return response;
+    };
     /**
      * The local (on-disk) cache for the Dagger engine
      */
@@ -2894,15 +2947,17 @@ export class EnumTypeDef extends BaseClient {
  */
 export class EnumValueTypeDef extends BaseClient {
     _id = undefined;
+    _deprecated = undefined;
     _description = undefined;
     _name = undefined;
     _value = undefined;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx, _id, _description, _name, _value) {
+    constructor(ctx, _id, _deprecated, _description, _name, _value) {
         super(ctx);
         this._id = _id;
+        this._deprecated = _deprecated;
         this._description = _description;
         this._name = _name;
         this._value = _value;
@@ -2918,6 +2973,17 @@ export class EnumValueTypeDef extends BaseClient {
         const response = await ctx.execute();
         return response;
     };
+    /**
+     * The reason this enum member is deprecated, if any.
+     */
+    deprecated = async () => {
+        if (this._deprecated) {
+            return this._deprecated;
+        }
+        const ctx = this._ctx.select("deprecated");
+        const response = await ctx.execute();
+        return response;
+    };
     /**
      * A doc string for the enum member, if any.
      */
@@ -3808,14 +3874,16 @@ export class ErrorValue extends BaseClient {
  */
 export class FieldTypeDef extends BaseClient {
     _id = undefined;
+    _deprecated = undefined;
     _description = undefined;
     _name = undefined;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx, _id, _description, _name) {
+    constructor(ctx, _id, _deprecated, _description, _name) {
         super(ctx);
         this._id = _id;
+        this._deprecated = _deprecated;
         this._description = _description;
         this._name = _name;
     }
@@ -3830,6 +3898,17 @@ export class FieldTypeDef extends BaseClient {
         const response = await ctx.execute();
         return response;
     };
+    /**
+     * The reason this enum member is deprecated, if any.
+     */
+    deprecated = async () => {
+        if (this._deprecated) {
+            return this._deprecated;
+        }
+        const ctx = this._ctx.select("deprecated");
+        const response = await ctx.execute();
+        return response;
+    };
     /**
      * A doc string for the field, if any.
      */
@@ -4066,14 +4145,16 @@ export class File extends BaseClient {
  */
 export class Function_ extends BaseClient {
     _id = undefined;
+    _deprecated = undefined;
     _description = undefined;
     _name = undefined;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx, _id, _description, _name) {
+    constructor(ctx, _id, _deprecated, _description, _name) {
         super(ctx);
         this._id = _id;
+        this._deprecated = _deprecated;
         this._description = _description;
         this._name = _name;
     }
@@ -4096,6 +4177,17 @@ export class Function_ extends BaseClient {
         const response = await ctx.execute();
         return response.map((r) => new Client(ctx.copy()).loadFunctionArgFromID(r.id));
     };
+    /**
+     * The reason this function is deprecated, if any.
+     */
+    deprecated = async () => {
+        if (this._deprecated) {
+            return this._deprecated;
+        }
+        const ctx = this._ctx.select("deprecated");
+        const response = await ctx.execute();
+        return response;
+    };
     /**
      * A doc string for the function, if any.
      */
@@ -4141,11 +4233,36 @@ export class Function_ extends BaseClient {
      * @param opts.defaultPath If the argument is a Directory or File type, default to load path from context directory, relative to root directory.
      * @param opts.ignore Patterns to ignore when loading the contextual argument value.
      * @param opts.sourceMap The source map for the argument definition.
+     * @param opts.deprecated If deprecated, the reason or migration path.
      */
     withArg = (name, typeDef, opts) => {
         const ctx = this._ctx.select("withArg", { name, typeDef, ...opts });
         return new Function_(ctx);
     };
+    /**
+     * Returns the function updated to use the provided cache policy.
+     * @param policy The cache policy to use.
+     * @param opts.timeToLive The TTL for the cache policy, if applicable. Provided as a duration string, e.g. "5m", "1h30s".
+     */
+    withCachePolicy = (policy, opts) => {
+        const metadata = {
+            policy: { is_enum: true, value_to_name: FunctionCachePolicyValueToName },
+        };
+        const ctx = this._ctx.select("withCachePolicy", {
+            policy,
+            ...opts,
+            __metadata: metadata,
+        });
+        return new Function_(ctx);
+    };
+    /**
+     * Returns the function with the provided deprecation reason.
+     * @param opts.reason Reason or migration path describing the deprecation.
+     */
+    withDeprecated = (opts) => {
+        const ctx = this._ctx.select("withDeprecated", { ...opts });
+        return new Function_(ctx);
+    };
     /**
      * Returns the function with the given doc string.
      * @param description The doc string to set.
@@ -4180,16 +4297,18 @@ export class FunctionArg extends BaseClient {
     _id = undefined;
     _defaultPath = undefined;
     _defaultValue = undefined;
+    _deprecated = undefined;
     _description = undefined;
     _name = undefined;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx, _id, _defaultPath, _defaultValue, _description, _name) {
+    constructor(ctx, _id, _defaultPath, _defaultValue, _deprecated, _description, _name) {
         super(ctx);
         this._id = _id;
         this._defaultPath = _defaultPath;
         this._defaultValue = _defaultValue;
+        this._deprecated = _deprecated;
         this._description = _description;
         this._name = _name;
     }
@@ -4226,6 +4345,17 @@ export class FunctionArg extends BaseClient {
         const response = await ctx.execute();
         return response;
     };
+    /**
+     * The reason this function is deprecated, if any.
+     */
+    deprecated = async () => {
+        if (this._deprecated) {
+            return this._deprecated;
+        }
+        const ctx = this._ctx.select("deprecated");
+        const response = await ctx.execute();
+        return response;
+    };
     /**
      * A doc string for the argument, if any.
      */
@@ -4651,6 +4781,13 @@ export class GitRepository extends BaseClient {
         const response = await ctx.execute();
         return response;
     };
+    /**
+     * Returns the changeset of uncommitted changes in the git repository.
+     */
+    uncommitted = () => {
+        const ctx = this._ctx.select("uncommitted");
+        return new Changeset(ctx);
+    };
     /**
      * The URL of the git repository.
      */
@@ -6011,6 +6148,14 @@ export class ModuleSource extends BaseClient {
         const response = await ctx.execute();
         return new Client(ctx.copy()).loadModuleSourceFromID(response);
     };
+    /**
+     * The toolchains referenced by the module source.
+     */
+    toolchains = async () => {
+        const ctx = this._ctx.select("toolchains").select("id");
+        const response = await ctx.execute();
+        return response.map((r) => new Client(ctx.copy()).loadModuleSourceFromID(r.id));
+    };
     /**
      * User-defined defaults read from local .env files
      */
@@ -6102,6 +6247,14 @@ export class ModuleSource extends BaseClient {
         const ctx = this._ctx.select("withSourceSubpath", { path });
         return new ModuleSource(ctx);
     };
+    /**
+     * Add toolchains to the module source.
+     * @param toolchains The toolchain modules to add.
+     */
+    withToolchains = (toolchains) => {
+        const ctx = this._ctx.select("withToolchains", { toolchains });
+        return new ModuleSource(ctx);
+    };
     /**
      * Update the blueprint module to the latest version.
      */
@@ -6117,6 +6270,14 @@ export class ModuleSource extends BaseClient {
         const ctx = this._ctx.select("withUpdateDependencies", { dependencies });
         return new ModuleSource(ctx);
     };
+    /**
+     * Update one or more toolchains.
+     * @param toolchains The toolchains to update.
+     */
+    withUpdateToolchains = (toolchains) => {
+        const ctx = this._ctx.select("withUpdateToolchains", { toolchains });
+        return new ModuleSource(ctx);
+    };
     /**
      * Update one or more clients.
      * @param clients The clients to update
@@ -6156,6 +6317,14 @@ export class ModuleSource extends BaseClient {
         const ctx = this._ctx.select("withoutExperimentalFeatures", { features });
         return new ModuleSource(ctx);
     };
+    /**
+     * Remove the provided toolchains from the module source.
+     * @param toolchains The toolchains to remove.
+     */
+    withoutToolchains = (toolchains) => {
+        const ctx = this._ctx.select("withoutToolchains", { toolchains });
+        return new ModuleSource(ctx);
+    };
     /**
      * Call the provided function with current ModuleSource.
      *
@@ -6170,15 +6339,17 @@ export class ModuleSource extends BaseClient {
  */
 export class ObjectTypeDef extends BaseClient {
     _id = undefined;
+    _deprecated = undefined;
     _description = undefined;
     _name = undefined;
     _sourceModuleName = undefined;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx, _id, _description, _name, _sourceModuleName) {
+    constructor(ctx, _id, _deprecated, _description, _name, _sourceModuleName) {
         super(ctx);
         this._id = _id;
+        this._deprecated = _deprecated;
         this._description = _description;
         this._name = _name;
         this._sourceModuleName = _sourceModuleName;
@@ -6201,6 +6372,17 @@ export class ObjectTypeDef extends BaseClient {
         const ctx = this._ctx.select("constructor");
         return new Function_(ctx);
     };
+    /**
+     * The reason this enum member is deprecated, if any.
+     */
+    deprecated = async () => {
+        if (this._deprecated) {
+            return this._deprecated;
+        }
+        const ctx = this._ctx.select("deprecated");
+        const response = await ctx.execute();
+        return response;
+    };
     /**
      * The doc string for the object, if any.
      */
@@ -6992,13 +7174,15 @@ export class Client extends BaseClient {
  */
 export class SDKConfig extends BaseClient {
     _id = undefined;
+    _debug = undefined;
     _source = undefined;
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(ctx, _id, _source) {
+    constructor(ctx, _id, _debug, _source) {
         super(ctx);
         this._id = _id;
+        this._debug = _debug;
         this._source = _source;
     }
     /**
@@ -7012,6 +7196,17 @@ export class SDKConfig extends BaseClient {
         const response = await ctx.execute();
         return response;
     };
+    /**
+     * Whether to start the SDK runtime in debug mode with an interactive terminal.
+     */
+    debug = async () => {
+        if (this._debug) {
+            return this._debug;
+        }
+        const ctx = this._ctx.select("debug");
+        const response = await ctx.execute();
+        return response;
+    };
     /**
      * Source of the SDK. Either a name of a builtin SDK or a module source ref string pointing to the SDK's implementation.
      */
@@ -7691,6 +7886,7 @@ export class TypeDef extends BaseClient {
      * @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.
+     * @param opts.deprecated If deprecated, the reason or migration path.
      */
     withEnumMember = (name, opts) => {
         const ctx = this._ctx.select("withEnumMember", { name, ...opts });
@@ -7701,6 +7897,7 @@ export class TypeDef extends BaseClient {
      * @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.
+     * @param opts.deprecated If deprecated, the reason or migration path.
      * @deprecated Use withEnumMember instead
      */
     withEnumValue = (value, opts) => {
@@ -7713,6 +7910,7 @@ export class TypeDef extends BaseClient {
      * @param typeDef The type of the field
      * @param opts.description A doc string for the field, if any
      * @param opts.sourceMap The source map for the field definition.
+     * @param opts.deprecated If deprecated, the reason or migration path.
      */
     withField = (name, typeDef, opts) => {
         const ctx = this._ctx.select("withField", { name, typeDef, ...opts });

package/dist/src/module/decorators.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../../src/module/decorators.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,eAAO,MAAM,MAAM,wEAAkB,CAAA;AAErC;;;;;GAKG;AACH,eAAO,MAAM,IAAI,gFAoCqtC,CAAC,8BApCtsC,CAAA;AAEjC;;;;;;GAMG;AACH,eAAO,MAAM,KAAK,qEAAiB,CAAA;AAEnC;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,wEAAoB,CAAA;AAEzC;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,QAAQ,yIAAoB,CAAA"}
+{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../../src/module/decorators.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,eAAO,MAAM,MAAM,wEAAkB,CAAA;AAErC;;;;;GAKG;AACH,eAAO,MAAM,IAAI,gFAoC2rD,CAAC,8BApC5qD,CAAA;AAEjC;;;;;;GAMG;AACH,eAAO,MAAM,KAAK,qEAAiB,CAAA;AAEnC;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,wEAAoB,CAAA;AAEzC;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,QAAQ,yIAAoB,CAAA"}

package/dist/src/module/entrypoint/register.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../../../../src/module/entrypoint/register.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,SAAS,EAET,QAAQ,EACR,OAAO,EAGR,MAAM,yBAAyB,CAAA;AAChC,OAAO,EACL,eAAe,IAAI,SAAS,EAC5B,iBAAiB,IAAI,WAAW,EAChC,cAAc,IAAI,MAAM,EACxB,YAAY,EAEZ,cAAc,EACf,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,oDAAoD,CAAA;AAU5F,qBAAa,QAAQ;IACP,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,YAAY;IAEjD;;OAEG;IACG,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC;IAgF9B;;OAEG;IACH,cAAc,CAAC,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,GAAG,SAAS;IAInE;;OAEG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,uBAAuB,GAAG,SAAS;IAQ7D;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,SAAS,GAAG,CAAC,GAAG,EAAE,SAAS,KAAK,SAAS;IAkDtD;;;;;;;OAOG;IACH,sBAAsB,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,GAAG,SAAS;CA4BjE"}
+{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../../../../src/module/entrypoint/register.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,SAAS,EAET,QAAQ,EACR,OAAO,EAQR,MAAM,yBAAyB,CAAA;AAChC,OAAO,EACL,eAAe,IAAI,SAAS,EAC5B,iBAAiB,IAAI,WAAW,EAChC,cAAc,IAAI,MAAM,EACxB,YAAY,EAEZ,cAAc,EACf,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,oDAAoD,CAAA;AAU5F,qBAAa,QAAQ;IACP,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,YAAY;IAEjD;;OAEG;IACG,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC;IAyF9B;;OAEG;IACH,cAAc,CAAC,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,GAAG,SAAS;IAInE;;OAEG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,uBAAuB,GAAG,SAAS;IAgC7D;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,SAAS,GAAG,CAAC,GAAG,EAAE,SAAS,KAAK,SAAS;IAmDtD;;;;;;;OAOG;IACH,sBAAsB,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,GAAG,SAAS;CA4BjE"}

package/dist/src/module/entrypoint/register.js

@@ -1,4 +1,4 @@
-import { dag, TypeDefKind, } from "../../api/client.gen.js";
+import { dag, TypeDefKind, FunctionCachePolicy, } from "../../api/client.gen.js";
 export class Register {
     module;
     constructor(module) {
@@ -16,11 +16,13 @@ export class Register {
         }
         // For each class scanned, register its type, method and properties in the module.
         Object.values(this.module.objects).forEach((object) => {
-            // Register the class Typedef object in Dagger
-            let typeDef = dag.typeDef().withObject(object.name, {
+            const objectOpts = {
                 description: object.description,
                 sourceMap: addSourceMap(object),
-            });
+                deprecated: object.deprecated,
+            };
+            // Register the class Typedef object in Dagger
+            let typeDef = dag.typeDef().withObject(object.name, objectOpts);
             // Register all functions (methods) to this object
             Object.values(object.methods).forEach((method) => {
                 typeDef = typeDef.withFunction(this.addFunction(method));
@@ -28,10 +30,12 @@ export class Register {
             // Register all fields that belong to this object
             Object.values(object.properties).forEach((field) => {
                 if (field.isExposed) {
-                    typeDef = typeDef.withField(field.alias ?? field.name, addTypeDef(field.type), {
+                    const fieldOpts = {
                         description: field.description,
                         sourceMap: addSourceMap(field),
-                    });
+                        deprecated: field.deprecated,
+                    };
+                    typeDef = typeDef.withField(field.alias ?? field.name, addTypeDef(field.type), fieldOpts);
                 }
             });
             if (object._constructor) {
@@ -47,11 +51,13 @@ export class Register {
                 sourceMap: addSourceMap(enum_),
             });
             Object.values(enum_.values).forEach((value) => {
-                typeDef = typeDef.withEnumMember(value.name, {
+                const memberOpts = {
                     value: value.value,
                     description: value.description,
                     sourceMap: addSourceMap(value),
-                });
+                    deprecated: value.deprecated,
+                };
+                typeDef = typeDef.withEnumMember(value.name, memberOpts);
             });
             mod = mod.withEnum(typeDef);
         });
@@ -77,11 +83,32 @@ export class Register {
      * Create a function in the Dagger API.
      */
     addFunction(fct) {
-        return dag
+        let fnDef = dag
             .function_(fct.alias ?? fct.name, addTypeDef(fct.returnType))
             .withDescription(fct.description)
             .withSourceMap(addSourceMap(fct))
             .with(this.addArg(fct.arguments));
+        switch (fct.cache) {
+            case "never": {
+                fnDef = fnDef.withCachePolicy(FunctionCachePolicy.Never);
+                break;
+            }
+            case "session": {
+                fnDef = fnDef.withCachePolicy(FunctionCachePolicy.PerSession);
+                break;
+            }
+            case "": {
+                break;
+            }
+            default: {
+                const opts = { timeToLive: fct.cache };
+                fnDef = fnDef.withCachePolicy(FunctionCachePolicy.Default, opts);
+            }
+        }
+        if (fct.deprecated !== undefined) {
+            fnDef = fnDef.withDeprecated({ reason: fct.deprecated });
+        }
+        return fnDef;
     }
     /**
      * Register all arguments in the function.
@@ -92,6 +119,7 @@ export class Register {
                 const opts = {
                     description: arg.description,
                     sourceMap: addSourceMap(arg),
+                    deprecated: arg.deprecated,
                 };
                 let typeDef = addTypeDef(arg.type);
                 if (arg.isOptional) {

package/dist/src/module/introspector/dagger_module/argument.d.ts

@@ -12,6 +12,7 @@ export declare class DaggerArgument extends Locatable {
     private readonly ast;
     name: string;
     description: string;
+    deprecated?: string;
     private _typeRef?;
     type?: TypeDef<TypeDefKind>;
     isVariadic: boolean;
@@ -36,6 +37,7 @@ export declare class DaggerArgument extends Locatable {
     toJSON(): {
         name: string;
         description: string;
+        deprecated: string | undefined;
         type: TypeDef<TypeDefKind> | undefined;
         isVariadic: boolean;
         isNullable: boolean;

package/dist/src/module/introspector/dagger_module/argument.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"argument.d.ts","sourceRoot":"","sources":["../../../../../src/module/introspector/dagger_module/argument.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,YAAY,CAAA;AAE3B,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAGxD,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AACvC,OAAO,EACL,GAAG,EAGJ,MAAM,+BAA+B,CAAA;AAEtC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE3C,MAAM,MAAM,eAAe,GAAG;IAAE,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAAA;CAAE,CAAA;AAEhE,qBAAa,cAAe,SAAQ,SAAS;IAezC,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,GAAG;IAff,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IAC1B,OAAO,CAAC,QAAQ,CAAC,CAAQ;IAClB,IAAI,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAA;IAC3B,UAAU,EAAE,OAAO,CAAA;IACnB,UAAU,EAAE,OAAO,CAAA;IACnB,UAAU,EAAE,OAAO,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,YAAY,CAAC,EAAE,GAAG,CAAA;IAEzB,OAAO,CAAC,MAAM,CAAW;gBAGN,IAAI,EAAE,EAAE,CAAC,oBAAoB,EAC7B,GAAG,EAAE,GAAG;IA+B3B;;;;;OAKG;IACH,OAAO,CAAC,OAAO;IAWf,OAAO,CAAC,aAAa;IAgBrB,OAAO,CAAC,eAAe;IAShB,YAAY,IAAI,MAAM,GAAG,SAAS;IAWlC,mBAAmB,CAAC,UAAU,EAAE,UAAU;IAmBjD,MAAM;;;;;;;;;;;CAaP"}
+{"version":3,"file":"argument.d.ts","sourceRoot":"","sources":["../../../../../src/module/introspector/dagger_module/argument.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,YAAY,CAAA;AAE3B,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAGxD,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AACvC,OAAO,EACL,GAAG,EAGJ,MAAM,+BAA+B,CAAA;AAEtC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE3C,MAAM,MAAM,eAAe,GAAG;IAAE,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAAA;CAAE,CAAA;AAEhE,qBAAa,cAAe,SAAQ,SAAS;IAgBzC,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,GAAG;IAhBf,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IAC1B,OAAO,CAAC,QAAQ,CAAC,CAAQ;IAClB,IAAI,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAA;IAC3B,UAAU,EAAE,OAAO,CAAA;IACnB,UAAU,EAAE,OAAO,CAAA;IACnB,UAAU,EAAE,OAAO,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,YAAY,CAAC,EAAE,GAAG,CAAA;IAEzB,OAAO,CAAC,MAAM,CAAW;gBAGN,IAAI,EAAE,EAAE,CAAC,oBAAoB,EAC7B,GAAG,EAAE,GAAG;IAuC3B;;;;;OAKG;IACH,OAAO,CAAC,OAAO;IAWf,OAAO,CAAC,aAAa;IAgBrB,OAAO,CAAC,eAAe;IAShB,YAAY,IAAI,MAAM,GAAG,SAAS;IAWlC,mBAAmB,CAAC,UAAU,EAAE,UAAU;IAmBjD,MAAM;;;;;;;;;;;;CAcP"}

package/dist/src/module/introspector/dagger_module/argument.js

@@ -9,6 +9,7 @@ export class DaggerArgument extends Locatable {
     ast;
     name;
     description;
+    deprecated;
     _typeRef;
     type;
     isVariadic;
@@ -24,16 +25,21 @@ export class DaggerArgument extends Locatable {
         this.ast = ast;
         this.symbol = this.ast.getSymbolOrThrow(node.name);
         this.name = this.node.name.getText();
-        this.description = this.ast.getDocFromSymbol(this.symbol);
+        const { description, deprecated } = this.ast.getSymbolDoc(this.symbol);
+        this.description = description;
+        this.deprecated = deprecated;
         this.defaultValue = this.getDefaultValue();
         this.isVariadic = this.node.dotDotDotToken !== undefined;
         this.isNullable = this.getIsNullable();
         this.isOptional =
-            this.isVariadic || // if arguments has ...
+            this.isVariadic || // if argument has ...
                 (this.defaultValue === undefined && // if argument has a default value that couldn't be resolved.
                     this.node.initializer !== undefined) ||
                 this.isNullable || // if argument is nullable
                 this.node.questionToken !== undefined; // if argument has ?
+        if (this.deprecated !== undefined && !this.isOptional) {
+            throw new IntrospectionError(`argument ${this.name} is required and cannot be deprecated at ${AST.getNodePosition(this.node)}.`);
+        }
         const decoratorArguments = this.ast.getDecoratorArgument(this.node, ARGUMENT_DECORATOR, "object");
         if (decoratorArguments) {
             this.ignore = decoratorArguments.ignore;
@@ -99,6 +105,7 @@ export class DaggerArgument extends Locatable {
         return {
             name: this.name,
             description: this.description,
+            deprecated: this.deprecated,
             type: this.type,
             isVariadic: this.isVariadic,
             isNullable: this.isNullable,

package/dist/src/module/introspector/dagger_module/enum.d.ts

@@ -14,12 +14,14 @@ export declare class DaggerEnumValue extends Locatable implements DaggerEnumBase
     name: string;
     value: string;
     description: string;
+    deprecated?: string;
     private symbol;
     constructor(node: ts.EnumMember, ast: AST);
     toJSON(): {
         name: string;
         value: string;
         description: string;
+        deprecated: string | undefined;
     };
 }
 export declare class DaggerEnum extends Locatable implements DaggerEnumBase {

package/dist/src/module/introspector/dagger_module/enum.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"enum.d.ts","sourceRoot":"","sources":["../../../../../src/module/introspector/dagger_module/enum.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAA;AAG3B,OAAO,EAAE,GAAG,EAAE,MAAM,+BAA+B,CAAA;AACnD,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AACnE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE1C,MAAM,MAAM,WAAW,GAAG;IAAE,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;CAAE,CAAA;AACxD,MAAM,MAAM,gBAAgB,GAAG;IAAE,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,CAAA;CAAE,CAAA;AAElE,qBAAa,eAAgB,SAAQ,SAAU,YAAW,mBAAmB;IAQzE,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,GAAG;IARf,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IAE1B,OAAO,CAAC,MAAM,CAAW;gBAGN,IAAI,EAAE,EAAE,CAAC,UAAU,EACnB,GAAG,EAAE,GAAG;IAiB3B,MAAM;;;;;CAOP;AAED,qBAAa,UAAW,SAAQ,SAAU,YAAW,cAAc;IAQ/D,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,GAAG;IARf,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,gBAAgB,CAAK;IAEpC,OAAO,CAAC,MAAM,CAAW;gBAGN,IAAI,EAAE,EAAE,CAAC,eAAe,EACxB,GAAG,EAAE,GAAG;IAgB3B,MAAM;;;;;CAOP"}
+{"version":3,"file":"enum.d.ts","sourceRoot":"","sources":["../../../../../src/module/introspector/dagger_module/enum.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAA;AAG3B,OAAO,EAAE,GAAG,EAAE,MAAM,+BAA+B,CAAA;AACnD,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AACnE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE1C,MAAM,MAAM,WAAW,GAAG;IAAE,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;CAAE,CAAA;AACxD,MAAM,MAAM,gBAAgB,GAAG;IAAE,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,CAAA;CAAE,CAAA;AAElE,qBAAa,eAAgB,SAAQ,SAAU,YAAW,mBAAmB;IASzE,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,GAAG;IATf,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IAE1B,OAAO,CAAC,MAAM,CAAW;gBAGN,IAAI,EAAE,EAAE,CAAC,UAAU,EACnB,GAAG,EAAE,GAAG;IAmB3B,MAAM;;;;;;CAQP;AAED,qBAAa,UAAW,SAAQ,SAAU,YAAW,cAAc;IAQ/D,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,GAAG;IARf,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,gBAAgB,CAAK;IAEpC,OAAO,CAAC,MAAM,CAAW;gBAGN,IAAI,EAAE,EAAE,CAAC,eAAe,EACxB,GAAG,EAAE,GAAG;IAgB3B,MAAM;;;;;CAOP"}

package/dist/src/module/introspector/dagger_module/enum.js

@@ -7,6 +7,7 @@ export class DaggerEnumValue extends Locatable {
     name;
     value;
     description;
+    deprecated;
     symbol;
     constructor(node, ast) {
         super(node);
@@ -14,7 +15,9 @@ export class DaggerEnumValue extends Locatable {
         this.ast = ast;
         this.symbol = this.ast.getSymbolOrThrow(this.node.name);
         this.name = this.node.name.getText();
-        this.description = this.ast.getDocFromSymbol(this.symbol);
+        const { description, deprecated } = this.ast.getSymbolDoc(this.symbol);
+        this.description = description;
+        this.deprecated = deprecated;
         const initializer = this.node.initializer;
         if (!initializer) {
             throw new IntrospectionError(`enum ${this.name} at ${AST.getNodePosition(this.node)} has no value set to its member.`);
@@ -26,6 +29,7 @@ export class DaggerEnumValue extends Locatable {
             name: this.name,
             value: this.value,
             description: this.description,
+            deprecated: this.deprecated,
         };
     }
 }

package/dist/src/module/introspector/dagger_module/enumBase.d.ts

@@ -3,6 +3,7 @@ export interface DaggerEnumBaseValue extends Locatable {
     name: string;
     value: string;
     description: string;
+    deprecated?: string;
 }
 export type DaggerEnumBaseValues = {
     [name: string]: DaggerEnumBaseValue;