@dagger.io/dagger 0.15.4 → 0.16.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -567,15 +567,17 @@ export type DirectoryAsModuleOpts = {
|
|
|
567
567
|
/**
|
|
568
568
|
* An optional subpath of the directory which contains the module's configuration file.
|
|
569
569
|
*
|
|
570
|
-
* This is needed when the module code is in a subdirectory but requires parent directories to be loaded in order to execute. For example, the module source code may need a go.mod, project.toml, package.json, etc. file from a parent directory.
|
|
571
|
-
*
|
|
572
570
|
* If not set, the module source code is loaded from the root of the directory.
|
|
573
571
|
*/
|
|
574
572
|
sourceRootPath?: string;
|
|
573
|
+
};
|
|
574
|
+
export type DirectoryAsModuleSourceOpts = {
|
|
575
575
|
/**
|
|
576
|
-
*
|
|
576
|
+
* An optional subpath of the directory which contains the module's configuration file.
|
|
577
|
+
*
|
|
578
|
+
* If not set, the module source code is loaded from the root of the directory.
|
|
577
579
|
*/
|
|
578
|
-
|
|
580
|
+
sourceRootPath?: string;
|
|
579
581
|
};
|
|
580
582
|
export type DirectoryDockerBuildOpts = {
|
|
581
583
|
/**
|
|
@@ -797,12 +799,6 @@ export type FunctionID = string & {
|
|
|
797
799
|
export type GeneratedCodeID = string & {
|
|
798
800
|
__GeneratedCodeID: never;
|
|
799
801
|
};
|
|
800
|
-
/**
|
|
801
|
-
* The `GitModuleSourceID` scalar type represents an identifier for an object of type GitModuleSource.
|
|
802
|
-
*/
|
|
803
|
-
export type GitModuleSourceID = string & {
|
|
804
|
-
__GitModuleSourceID: never;
|
|
805
|
-
};
|
|
806
802
|
export type GitRefTreeOpts = {
|
|
807
803
|
/**
|
|
808
804
|
* Set to true to discard .git directory.
|
|
@@ -921,52 +917,12 @@ export type LabelID = string & {
|
|
|
921
917
|
export type ListTypeDefID = string & {
|
|
922
918
|
__ListTypeDefID: never;
|
|
923
919
|
};
|
|
924
|
-
/**
|
|
925
|
-
* The `LocalModuleSourceID` scalar type represents an identifier for an object of type LocalModuleSource.
|
|
926
|
-
*/
|
|
927
|
-
export type LocalModuleSourceID = string & {
|
|
928
|
-
__LocalModuleSourceID: never;
|
|
929
|
-
};
|
|
930
|
-
export type ModuleWithSourceOpts = {
|
|
931
|
-
/**
|
|
932
|
-
* The engine version to upgrade to.
|
|
933
|
-
*/
|
|
934
|
-
engineVersion?: string;
|
|
935
|
-
};
|
|
936
|
-
/**
|
|
937
|
-
* The `ModuleDependencyID` scalar type represents an identifier for an object of type ModuleDependency.
|
|
938
|
-
*/
|
|
939
|
-
export type ModuleDependencyID = string & {
|
|
940
|
-
__ModuleDependencyID: never;
|
|
941
|
-
};
|
|
942
920
|
/**
|
|
943
921
|
* The `ModuleID` scalar type represents an identifier for an object of type Module.
|
|
944
922
|
*/
|
|
945
923
|
export type ModuleID = string & {
|
|
946
924
|
__ModuleID: never;
|
|
947
925
|
};
|
|
948
|
-
export type ModuleSourceAsModuleOpts = {
|
|
949
|
-
/**
|
|
950
|
-
* The engine version to upgrade to.
|
|
951
|
-
*/
|
|
952
|
-
engineVersion?: string;
|
|
953
|
-
};
|
|
954
|
-
export type ModuleSourceResolveDirectoryFromCallerOpts = {
|
|
955
|
-
/**
|
|
956
|
-
* If set, the name of the view to apply to the path.
|
|
957
|
-
*/
|
|
958
|
-
viewName?: string;
|
|
959
|
-
/**
|
|
960
|
-
* Patterns to ignore when loading the directory.
|
|
961
|
-
*/
|
|
962
|
-
ignore?: string[];
|
|
963
|
-
};
|
|
964
|
-
export type ModuleSourceWithInitOpts = {
|
|
965
|
-
/**
|
|
966
|
-
* Merge module dependencies into the current project's
|
|
967
|
-
*/
|
|
968
|
-
merge?: boolean;
|
|
969
|
-
};
|
|
970
926
|
/**
|
|
971
927
|
* The `ModuleSourceID` scalar type represents an identifier for an object of type ModuleSource.
|
|
972
928
|
*/
|
|
@@ -977,15 +933,10 @@ export type ModuleSourceID = string & {
|
|
|
977
933
|
* The kind of module source.
|
|
978
934
|
*/
|
|
979
935
|
export declare enum ModuleSourceKind {
|
|
936
|
+
DirSource = "DIR_SOURCE",
|
|
980
937
|
GitSource = "GIT_SOURCE",
|
|
981
938
|
LocalSource = "LOCAL_SOURCE"
|
|
982
939
|
}
|
|
983
|
-
/**
|
|
984
|
-
* The `ModuleSourceViewID` scalar type represents an identifier for an object of type ModuleSourceView.
|
|
985
|
-
*/
|
|
986
|
-
export type ModuleSourceViewID = string & {
|
|
987
|
-
__ModuleSourceViewID: never;
|
|
988
|
-
};
|
|
989
940
|
/**
|
|
990
941
|
* Transport layer network protocol associated to a port.
|
|
991
942
|
*/
|
|
@@ -1073,25 +1024,23 @@ export type ClientHttpOpts = {
|
|
|
1073
1024
|
export type ClientLoadSecretFromNameOpts = {
|
|
1074
1025
|
accessor?: string;
|
|
1075
1026
|
};
|
|
1076
|
-
export type ClientModuleDependencyOpts = {
|
|
1077
|
-
/**
|
|
1078
|
-
* If set, the name to use for the dependency. Otherwise, once installed to a parent module, the name of the dependency module will be used by default.
|
|
1079
|
-
*/
|
|
1080
|
-
name?: string;
|
|
1081
|
-
};
|
|
1082
1027
|
export type ClientModuleSourceOpts = {
|
|
1083
1028
|
/**
|
|
1084
1029
|
* The pinned version of the module source
|
|
1085
1030
|
*/
|
|
1086
1031
|
refPin?: string;
|
|
1087
1032
|
/**
|
|
1088
|
-
* If true,
|
|
1033
|
+
* If true, do not attempt to find dagger.json in a parent directory of the provided path. Only relevant for local module sources.
|
|
1089
1034
|
*/
|
|
1090
|
-
|
|
1035
|
+
disableFindUp?: boolean;
|
|
1091
1036
|
/**
|
|
1092
|
-
*
|
|
1037
|
+
* If true, do not error out if the provided ref string is a local path and does not exist yet. Useful when initializing new modules in directories that don't exist yet.
|
|
1093
1038
|
*/
|
|
1094
|
-
|
|
1039
|
+
allowNotExists?: boolean;
|
|
1040
|
+
/**
|
|
1041
|
+
* If set, error out if the ref string is not of the provided requireKind.
|
|
1042
|
+
*/
|
|
1043
|
+
requireKind?: ModuleSourceKind;
|
|
1095
1044
|
};
|
|
1096
1045
|
/**
|
|
1097
1046
|
* Expected return type of an execution
|
|
@@ -1966,15 +1915,19 @@ export declare class Directory extends BaseClient {
|
|
|
1966
1915
|
*/
|
|
1967
1916
|
id: () => Promise<DirectoryID>;
|
|
1968
1917
|
/**
|
|
1969
|
-
* Load the directory as a Dagger module
|
|
1918
|
+
* Load the directory as a Dagger module source
|
|
1970
1919
|
* @param opts.sourceRootPath An optional subpath of the directory which contains the module's configuration file.
|
|
1971
1920
|
*
|
|
1972
|
-
* This is needed when the module code is in a subdirectory but requires parent directories to be loaded in order to execute. For example, the module source code may need a go.mod, project.toml, package.json, etc. file from a parent directory.
|
|
1973
|
-
*
|
|
1974
1921
|
* If not set, the module source code is loaded from the root of the directory.
|
|
1975
|
-
* @param opts.engineVersion The engine version to upgrade to.
|
|
1976
1922
|
*/
|
|
1977
1923
|
asModule: (opts?: DirectoryAsModuleOpts) => Module_;
|
|
1924
|
+
/**
|
|
1925
|
+
* Load the directory as a Dagger module source
|
|
1926
|
+
* @param opts.sourceRootPath An optional subpath of the directory which contains the module's configuration file.
|
|
1927
|
+
*
|
|
1928
|
+
* If not set, the module source code is loaded from the root of the directory.
|
|
1929
|
+
*/
|
|
1930
|
+
asModuleSource: (opts?: DirectoryAsModuleSourceOpts) => ModuleSource;
|
|
1978
1931
|
/**
|
|
1979
1932
|
* Gets the difference between this directory and an another directory.
|
|
1980
1933
|
* @param other Identifier of the directory to compare.
|
|
@@ -2650,59 +2603,6 @@ export declare class GeneratedCode extends BaseClient {
|
|
|
2650
2603
|
*/
|
|
2651
2604
|
with: (arg: (param: GeneratedCode) => GeneratedCode) => GeneratedCode;
|
|
2652
2605
|
}
|
|
2653
|
-
/**
|
|
2654
|
-
* Module source originating from a git repo.
|
|
2655
|
-
*/
|
|
2656
|
-
export declare class GitModuleSource extends BaseClient {
|
|
2657
|
-
private readonly _id?;
|
|
2658
|
-
private readonly _cloneRef?;
|
|
2659
|
-
private readonly _commit?;
|
|
2660
|
-
private readonly _htmlRepoURL?;
|
|
2661
|
-
private readonly _htmlURL?;
|
|
2662
|
-
private readonly _root?;
|
|
2663
|
-
private readonly _rootSubpath?;
|
|
2664
|
-
private readonly _version?;
|
|
2665
|
-
/**
|
|
2666
|
-
* Constructor is used for internal usage only, do not create object from it.
|
|
2667
|
-
*/
|
|
2668
|
-
constructor(ctx?: Context, _id?: GitModuleSourceID, _cloneRef?: string, _commit?: string, _htmlRepoURL?: string, _htmlURL?: string, _root?: string, _rootSubpath?: string, _version?: string);
|
|
2669
|
-
/**
|
|
2670
|
-
* A unique identifier for this GitModuleSource.
|
|
2671
|
-
*/
|
|
2672
|
-
id: () => Promise<GitModuleSourceID>;
|
|
2673
|
-
/**
|
|
2674
|
-
* The ref to clone the root of the git repo from
|
|
2675
|
-
*/
|
|
2676
|
-
cloneRef: () => Promise<string>;
|
|
2677
|
-
/**
|
|
2678
|
-
* The resolved commit of the git repo this source points to.
|
|
2679
|
-
*/
|
|
2680
|
-
commit: () => Promise<string>;
|
|
2681
|
-
/**
|
|
2682
|
-
* The directory containing everything needed to load load and use the module.
|
|
2683
|
-
*/
|
|
2684
|
-
contextDirectory: () => Directory;
|
|
2685
|
-
/**
|
|
2686
|
-
* The URL to access the web view of the repository (e.g., GitHub, GitLab, Bitbucket)
|
|
2687
|
-
*/
|
|
2688
|
-
htmlRepoURL: () => Promise<string>;
|
|
2689
|
-
/**
|
|
2690
|
-
* The URL to the source's git repo in a web browser
|
|
2691
|
-
*/
|
|
2692
|
-
htmlURL: () => Promise<string>;
|
|
2693
|
-
/**
|
|
2694
|
-
* The clean module name of the root of the module
|
|
2695
|
-
*/
|
|
2696
|
-
root: () => Promise<string>;
|
|
2697
|
-
/**
|
|
2698
|
-
* The path to the root of the module source under the context directory. This directory contains its configuration file. It also contains its source code (possibly as a subdirectory).
|
|
2699
|
-
*/
|
|
2700
|
-
rootSubpath: () => Promise<string>;
|
|
2701
|
-
/**
|
|
2702
|
-
* The specified version of the git repo this source points to.
|
|
2703
|
-
*/
|
|
2704
|
-
version: () => Promise<string>;
|
|
2705
|
-
}
|
|
2706
2606
|
/**
|
|
2707
2607
|
* A git ref (tag, branch, or commit).
|
|
2708
2608
|
*/
|
|
@@ -2955,34 +2855,6 @@ export declare class ListTypeDef extends BaseClient {
|
|
|
2955
2855
|
*/
|
|
2956
2856
|
elementTypeDef: () => TypeDef;
|
|
2957
2857
|
}
|
|
2958
|
-
/**
|
|
2959
|
-
* Module source that that originates from a path locally relative to an arbitrary directory.
|
|
2960
|
-
*/
|
|
2961
|
-
export declare class LocalModuleSource extends BaseClient {
|
|
2962
|
-
private readonly _id?;
|
|
2963
|
-
private readonly _relHostPath?;
|
|
2964
|
-
private readonly _rootSubpath?;
|
|
2965
|
-
/**
|
|
2966
|
-
* Constructor is used for internal usage only, do not create object from it.
|
|
2967
|
-
*/
|
|
2968
|
-
constructor(ctx?: Context, _id?: LocalModuleSourceID, _relHostPath?: string, _rootSubpath?: string);
|
|
2969
|
-
/**
|
|
2970
|
-
* A unique identifier for this LocalModuleSource.
|
|
2971
|
-
*/
|
|
2972
|
-
id: () => Promise<LocalModuleSourceID>;
|
|
2973
|
-
/**
|
|
2974
|
-
* The directory containing everything needed to load load and use the module.
|
|
2975
|
-
*/
|
|
2976
|
-
contextDirectory: () => Directory;
|
|
2977
|
-
/**
|
|
2978
|
-
* The relative path to the module root from the host directory
|
|
2979
|
-
*/
|
|
2980
|
-
relHostPath: () => Promise<string>;
|
|
2981
|
-
/**
|
|
2982
|
-
* The path to the root of the module source under the context directory. This directory contains its configuration file. It also contains its source code (possibly as a subdirectory).
|
|
2983
|
-
*/
|
|
2984
|
-
rootSubpath: () => Promise<string>;
|
|
2985
|
-
}
|
|
2986
2858
|
/**
|
|
2987
2859
|
* A Dagger module.
|
|
2988
2860
|
*/
|
|
@@ -2991,22 +2863,19 @@ export declare class Module_ extends BaseClient {
|
|
|
2991
2863
|
private readonly _description?;
|
|
2992
2864
|
private readonly _name?;
|
|
2993
2865
|
private readonly _serve?;
|
|
2866
|
+
private readonly _sync?;
|
|
2994
2867
|
/**
|
|
2995
2868
|
* Constructor is used for internal usage only, do not create object from it.
|
|
2996
2869
|
*/
|
|
2997
|
-
constructor(ctx?: Context, _id?: ModuleID, _description?: string, _name?: string, _serve?: Void);
|
|
2870
|
+
constructor(ctx?: Context, _id?: ModuleID, _description?: string, _name?: string, _serve?: Void, _sync?: ModuleID);
|
|
2998
2871
|
/**
|
|
2999
2872
|
* A unique identifier for this Module.
|
|
3000
2873
|
*/
|
|
3001
2874
|
id: () => Promise<ModuleID>;
|
|
3002
2875
|
/**
|
|
3003
|
-
*
|
|
2876
|
+
* The dependencies of the module.
|
|
3004
2877
|
*/
|
|
3005
2878
|
dependencies: () => Promise<Module_[]>;
|
|
3006
|
-
/**
|
|
3007
|
-
* The dependencies as configured by the module.
|
|
3008
|
-
*/
|
|
3009
|
-
dependencyConfig: () => Promise<ModuleDependency[]>;
|
|
3010
2879
|
/**
|
|
3011
2880
|
* The doc string of the module, if any
|
|
3012
2881
|
*/
|
|
@@ -3018,15 +2887,7 @@ export declare class Module_ extends BaseClient {
|
|
|
3018
2887
|
/**
|
|
3019
2888
|
* The generated files and directories made on top of the module source's context directory.
|
|
3020
2889
|
*/
|
|
3021
|
-
generatedContextDiff: () => Directory;
|
|
3022
|
-
/**
|
|
3023
|
-
* The module source's context plus any configuration and source files created by codegen.
|
|
3024
|
-
*/
|
|
3025
2890
|
generatedContextDirectory: () => Directory;
|
|
3026
|
-
/**
|
|
3027
|
-
* Retrieves the module with the objects loaded via its SDK.
|
|
3028
|
-
*/
|
|
3029
|
-
initialize: () => Module_;
|
|
3030
2891
|
/**
|
|
3031
2892
|
* Interfaces served by this module.
|
|
3032
2893
|
*/
|
|
@@ -3057,6 +2918,10 @@ export declare class Module_ extends BaseClient {
|
|
|
3057
2918
|
* The source for the module.
|
|
3058
2919
|
*/
|
|
3059
2920
|
source: () => ModuleSource;
|
|
2921
|
+
/**
|
|
2922
|
+
* Forces evaluation of the module, including any loading into the engine and associated validation.
|
|
2923
|
+
*/
|
|
2924
|
+
sync: () => Promise<Module_>;
|
|
3060
2925
|
/**
|
|
3061
2926
|
* Retrieves the module with the given description
|
|
3062
2927
|
* @param description The description to set
|
|
@@ -3074,12 +2939,6 @@ export declare class Module_ extends BaseClient {
|
|
|
3074
2939
|
* This module plus the given Object type and associated functions.
|
|
3075
2940
|
*/
|
|
3076
2941
|
withObject: (object: TypeDef) => Module_;
|
|
3077
|
-
/**
|
|
3078
|
-
* Retrieves the module with basic configuration loaded if present.
|
|
3079
|
-
* @param source The module source to initialize from.
|
|
3080
|
-
* @param opts.engineVersion The engine version to upgrade to.
|
|
3081
|
-
*/
|
|
3082
|
-
withSource: (source: ModuleSource, opts?: ModuleWithSourceOpts) => Module_;
|
|
3083
2942
|
/**
|
|
3084
2943
|
* Call the provided function with current Module.
|
|
3085
2944
|
*
|
|
@@ -3087,100 +2946,104 @@ export declare class Module_ extends BaseClient {
|
|
|
3087
2946
|
*/
|
|
3088
2947
|
with: (arg: (param: Module_) => Module_) => Module_;
|
|
3089
2948
|
}
|
|
3090
|
-
/**
|
|
3091
|
-
* The configuration of dependency of a module.
|
|
3092
|
-
*/
|
|
3093
|
-
export declare class ModuleDependency extends BaseClient {
|
|
3094
|
-
private readonly _id?;
|
|
3095
|
-
private readonly _name?;
|
|
3096
|
-
/**
|
|
3097
|
-
* Constructor is used for internal usage only, do not create object from it.
|
|
3098
|
-
*/
|
|
3099
|
-
constructor(ctx?: Context, _id?: ModuleDependencyID, _name?: string);
|
|
3100
|
-
/**
|
|
3101
|
-
* A unique identifier for this ModuleDependency.
|
|
3102
|
-
*/
|
|
3103
|
-
id: () => Promise<ModuleDependencyID>;
|
|
3104
|
-
/**
|
|
3105
|
-
* The name of the dependency module.
|
|
3106
|
-
*/
|
|
3107
|
-
name: () => Promise<string>;
|
|
3108
|
-
/**
|
|
3109
|
-
* The source for the dependency module.
|
|
3110
|
-
*/
|
|
3111
|
-
source: () => ModuleSource;
|
|
3112
|
-
}
|
|
3113
2949
|
/**
|
|
3114
2950
|
* The source needed to load and run a module, along with any metadata about the source such as versions/urls/etc.
|
|
3115
2951
|
*/
|
|
3116
2952
|
export declare class ModuleSource extends BaseClient {
|
|
3117
2953
|
private readonly _id?;
|
|
3118
2954
|
private readonly _asString?;
|
|
2955
|
+
private readonly _cloneRef?;
|
|
2956
|
+
private readonly _commit?;
|
|
3119
2957
|
private readonly _configExists?;
|
|
3120
2958
|
private readonly _digest?;
|
|
2959
|
+
private readonly _engineVersion?;
|
|
2960
|
+
private readonly _htmlRepoURL?;
|
|
2961
|
+
private readonly _htmlURL?;
|
|
3121
2962
|
private readonly _kind?;
|
|
2963
|
+
private readonly _localContextDirectoryPath?;
|
|
3122
2964
|
private readonly _moduleName?;
|
|
3123
2965
|
private readonly _moduleOriginalName?;
|
|
3124
2966
|
private readonly _pin?;
|
|
3125
|
-
private readonly
|
|
2967
|
+
private readonly _repoRootPath?;
|
|
3126
2968
|
private readonly _sourceRootSubpath?;
|
|
3127
2969
|
private readonly _sourceSubpath?;
|
|
2970
|
+
private readonly _sync?;
|
|
2971
|
+
private readonly _version?;
|
|
3128
2972
|
/**
|
|
3129
2973
|
* Constructor is used for internal usage only, do not create object from it.
|
|
3130
2974
|
*/
|
|
3131
|
-
constructor(ctx?: Context, _id?: ModuleSourceID, _asString?: string, _configExists?: boolean, _digest?: string, _kind?: ModuleSourceKind, _moduleName?: string, _moduleOriginalName?: string, _pin?: string,
|
|
2975
|
+
constructor(ctx?: Context, _id?: ModuleSourceID, _asString?: string, _cloneRef?: string, _commit?: string, _configExists?: boolean, _digest?: string, _engineVersion?: string, _htmlRepoURL?: string, _htmlURL?: string, _kind?: ModuleSourceKind, _localContextDirectoryPath?: string, _moduleName?: string, _moduleOriginalName?: string, _pin?: string, _repoRootPath?: string, _sourceRootSubpath?: string, _sourceSubpath?: string, _sync?: ModuleSourceID, _version?: string);
|
|
3132
2976
|
/**
|
|
3133
2977
|
* A unique identifier for this ModuleSource.
|
|
3134
2978
|
*/
|
|
3135
2979
|
id: () => Promise<ModuleSourceID>;
|
|
3136
2980
|
/**
|
|
3137
|
-
*
|
|
2981
|
+
* Load the source as a module. If this is a local source, the parent directory must have been provided during module source creation
|
|
3138
2982
|
*/
|
|
3139
|
-
|
|
2983
|
+
asModule: () => Module_;
|
|
3140
2984
|
/**
|
|
3141
|
-
*
|
|
2985
|
+
* A human readable ref string representation of this module source.
|
|
3142
2986
|
*/
|
|
3143
|
-
|
|
2987
|
+
asString: () => Promise<string>;
|
|
3144
2988
|
/**
|
|
3145
|
-
*
|
|
3146
|
-
* @param opts.engineVersion The engine version to upgrade to.
|
|
2989
|
+
* The ref to clone the root of the git repo from. Only valid for git sources.
|
|
3147
2990
|
*/
|
|
3148
|
-
|
|
2991
|
+
cloneRef: () => Promise<string>;
|
|
3149
2992
|
/**
|
|
3150
|
-
*
|
|
2993
|
+
* The resolved commit of the git repo this source points to. Only valid for git sources.
|
|
3151
2994
|
*/
|
|
3152
|
-
|
|
2995
|
+
commit: () => Promise<string>;
|
|
3153
2996
|
/**
|
|
3154
|
-
*
|
|
2997
|
+
* Whether an existing dagger.json for the module was found.
|
|
3155
2998
|
*/
|
|
3156
2999
|
configExists: () => Promise<boolean>;
|
|
3157
3000
|
/**
|
|
3158
|
-
* The directory
|
|
3001
|
+
* The full directory loaded for the module source, including the source code as a subdirectory.
|
|
3159
3002
|
*/
|
|
3160
3003
|
contextDirectory: () => Directory;
|
|
3161
3004
|
/**
|
|
3162
|
-
* The
|
|
3005
|
+
* The dependencies of the module source.
|
|
3163
3006
|
*/
|
|
3164
|
-
dependencies: () => Promise<
|
|
3007
|
+
dependencies: () => Promise<ModuleSource[]>;
|
|
3165
3008
|
/**
|
|
3166
|
-
*
|
|
3009
|
+
* A content-hash of the module source. Module sources with the same digest will output the same generated context and convert into the same module instance.
|
|
3167
3010
|
*/
|
|
3168
3011
|
digest: () => Promise<string>;
|
|
3169
3012
|
/**
|
|
3170
3013
|
* The directory containing the module configuration and source code (source code may be in a subdir).
|
|
3171
|
-
* @param path
|
|
3014
|
+
* @param path A subpath from the source directory to select.
|
|
3172
3015
|
*/
|
|
3173
3016
|
directory: (path: string) => Directory;
|
|
3174
3017
|
/**
|
|
3175
|
-
* The
|
|
3018
|
+
* The engine version of the module.
|
|
3019
|
+
*/
|
|
3020
|
+
engineVersion: () => Promise<string>;
|
|
3021
|
+
/**
|
|
3022
|
+
* The generated files and directories made on top of the module source's context directory.
|
|
3023
|
+
*/
|
|
3024
|
+
generatedContextDirectory: () => Directory;
|
|
3025
|
+
/**
|
|
3026
|
+
* The URL to access the web view of the repository (e.g., GitHub, GitLab, Bitbucket). Only valid for git sources.
|
|
3027
|
+
*/
|
|
3028
|
+
htmlRepoURL: () => Promise<string>;
|
|
3029
|
+
/**
|
|
3030
|
+
* The URL to the source's git repo in a web browser. Only valid for git sources.
|
|
3031
|
+
*/
|
|
3032
|
+
htmlURL: () => Promise<string>;
|
|
3033
|
+
/**
|
|
3034
|
+
* The kind of module source (currently local, git or dir).
|
|
3176
3035
|
*/
|
|
3177
3036
|
kind: () => Promise<ModuleSourceKind>;
|
|
3178
3037
|
/**
|
|
3179
|
-
*
|
|
3038
|
+
* The full absolute path to the context directory on the caller's host filesystem that this module source is loaded from. Only valid for local module sources.
|
|
3039
|
+
*/
|
|
3040
|
+
localContextDirectoryPath: () => Promise<string>;
|
|
3041
|
+
/**
|
|
3042
|
+
* The name of the module, including any setting via the withName API.
|
|
3180
3043
|
*/
|
|
3181
3044
|
moduleName: () => Promise<string>;
|
|
3182
3045
|
/**
|
|
3183
|
-
* The original name of the module
|
|
3046
|
+
* The original name of the module as read from the module's dagger.json (or set for the first time with the withName API).
|
|
3184
3047
|
*/
|
|
3185
3048
|
moduleOriginalName: () => Promise<string>;
|
|
3186
3049
|
/**
|
|
@@ -3188,57 +3051,44 @@ export declare class ModuleSource extends BaseClient {
|
|
|
3188
3051
|
*/
|
|
3189
3052
|
pin: () => Promise<string>;
|
|
3190
3053
|
/**
|
|
3191
|
-
* The path to the
|
|
3192
|
-
*/
|
|
3193
|
-
resolveContextPathFromCaller: () => Promise<string>;
|
|
3194
|
-
/**
|
|
3195
|
-
* Resolve the provided module source arg as a dependency relative to this module source.
|
|
3196
|
-
* @param dep The dependency module source to resolve.
|
|
3054
|
+
* The import path corresponding to the root of the git repo this source points to. Only valid for git sources.
|
|
3197
3055
|
*/
|
|
3198
|
-
|
|
3056
|
+
repoRootPath: () => Promise<string>;
|
|
3199
3057
|
/**
|
|
3200
|
-
*
|
|
3201
|
-
* @param path The path on the caller's filesystem to load.
|
|
3202
|
-
* @param opts.viewName If set, the name of the view to apply to the path.
|
|
3203
|
-
* @param opts.ignore Patterns to ignore when loading the directory.
|
|
3058
|
+
* The SDK configuration of the module.
|
|
3204
3059
|
*/
|
|
3205
|
-
|
|
3206
|
-
/**
|
|
3207
|
-
* Load the source from its path on the caller's filesystem, including only needed+configured files and directories. Only valid for local sources.
|
|
3208
|
-
*/
|
|
3209
|
-
resolveFromCaller: () => ModuleSource;
|
|
3060
|
+
sdk: () => SDKConfig;
|
|
3210
3061
|
/**
|
|
3211
|
-
* The path relative to context
|
|
3062
|
+
* The path, relative to the context directory, that contains the module's dagger.json.
|
|
3212
3063
|
*/
|
|
3213
3064
|
sourceRootSubpath: () => Promise<string>;
|
|
3214
3065
|
/**
|
|
3215
|
-
* The path
|
|
3066
|
+
* The path to the directory containing the module's source code, relative to the context directory.
|
|
3216
3067
|
*/
|
|
3217
3068
|
sourceSubpath: () => Promise<string>;
|
|
3218
3069
|
/**
|
|
3219
|
-
*
|
|
3220
|
-
* @param name The name of the view to retrieve.
|
|
3070
|
+
* Forces evaluation of the module source, including any loading into the engine and associated validation.
|
|
3221
3071
|
*/
|
|
3222
|
-
|
|
3072
|
+
sync: () => Promise<ModuleSource>;
|
|
3223
3073
|
/**
|
|
3224
|
-
* The
|
|
3074
|
+
* The specified version of the git repo this source points to. Only valid for git sources.
|
|
3225
3075
|
*/
|
|
3226
|
-
|
|
3227
|
-
/**
|
|
3228
|
-
* Update the module source with a new context directory. Only valid for local sources.
|
|
3229
|
-
* @param dir The directory to set as the context directory.
|
|
3230
|
-
*/
|
|
3231
|
-
withContextDirectory: (dir: Directory) => ModuleSource;
|
|
3076
|
+
version: () => Promise<string>;
|
|
3232
3077
|
/**
|
|
3233
3078
|
* Append the provided dependencies to the module source's dependency list.
|
|
3234
3079
|
* @param dependencies The dependencies to append.
|
|
3235
3080
|
*/
|
|
3236
|
-
withDependencies: (dependencies:
|
|
3081
|
+
withDependencies: (dependencies: ModuleSource[]) => ModuleSource;
|
|
3237
3082
|
/**
|
|
3238
|
-
*
|
|
3239
|
-
* @param
|
|
3083
|
+
* Upgrade the engine version of the module to the given value.
|
|
3084
|
+
* @param version The engine version to upgrade to.
|
|
3240
3085
|
*/
|
|
3241
|
-
|
|
3086
|
+
withEngineVersion: (version: string) => ModuleSource;
|
|
3087
|
+
/**
|
|
3088
|
+
* Update the module source with additional include patterns for files+directories from its context that are required for building it
|
|
3089
|
+
* @param patterns The new additional include patterns.
|
|
3090
|
+
*/
|
|
3091
|
+
withIncludes: (patterns: string[]) => ModuleSource;
|
|
3242
3092
|
/**
|
|
3243
3093
|
* Update the module source with a new name.
|
|
3244
3094
|
* @param name The name to set.
|
|
@@ -3251,7 +3101,7 @@ export declare class ModuleSource extends BaseClient {
|
|
|
3251
3101
|
withSDK: (source: string) => ModuleSource;
|
|
3252
3102
|
/**
|
|
3253
3103
|
* Update the module source with a new source subpath.
|
|
3254
|
-
* @param path The path to set as the source subpath.
|
|
3104
|
+
* @param path The path to set as the source subpath. Must be relative to the module source's source root directory.
|
|
3255
3105
|
*/
|
|
3256
3106
|
withSourceSubpath: (path: string) => ModuleSource;
|
|
3257
3107
|
/**
|
|
@@ -3259,12 +3109,6 @@ export declare class ModuleSource extends BaseClient {
|
|
|
3259
3109
|
* @param dependencies The dependencies to update.
|
|
3260
3110
|
*/
|
|
3261
3111
|
withUpdateDependencies: (dependencies: string[]) => ModuleSource;
|
|
3262
|
-
/**
|
|
3263
|
-
* Update the module source with a new named view.
|
|
3264
|
-
* @param name The name of the view to set.
|
|
3265
|
-
* @param patterns The patterns to set as the view filters.
|
|
3266
|
-
*/
|
|
3267
|
-
withView: (name: string, patterns: string[]) => ModuleSource;
|
|
3268
3112
|
/**
|
|
3269
3113
|
* Remove the provided dependencies from the module source's dependency list.
|
|
3270
3114
|
* @param dependencies The dependencies to remove.
|
|
@@ -3277,29 +3121,6 @@ export declare class ModuleSource extends BaseClient {
|
|
|
3277
3121
|
*/
|
|
3278
3122
|
with: (arg: (param: ModuleSource) => ModuleSource) => ModuleSource;
|
|
3279
3123
|
}
|
|
3280
|
-
/**
|
|
3281
|
-
* A named set of path filters that can be applied to directory arguments provided to functions.
|
|
3282
|
-
*/
|
|
3283
|
-
export declare class ModuleSourceView extends BaseClient {
|
|
3284
|
-
private readonly _id?;
|
|
3285
|
-
private readonly _name?;
|
|
3286
|
-
/**
|
|
3287
|
-
* Constructor is used for internal usage only, do not create object from it.
|
|
3288
|
-
*/
|
|
3289
|
-
constructor(ctx?: Context, _id?: ModuleSourceViewID, _name?: string);
|
|
3290
|
-
/**
|
|
3291
|
-
* A unique identifier for this ModuleSourceView.
|
|
3292
|
-
*/
|
|
3293
|
-
id: () => Promise<ModuleSourceViewID>;
|
|
3294
|
-
/**
|
|
3295
|
-
* The name of the view
|
|
3296
|
-
*/
|
|
3297
|
-
name: () => Promise<string>;
|
|
3298
|
-
/**
|
|
3299
|
-
* The patterns of the view used to filter paths
|
|
3300
|
-
*/
|
|
3301
|
-
patterns: () => Promise<string[]>;
|
|
3302
|
-
}
|
|
3303
3124
|
/**
|
|
3304
3125
|
* A definition of a custom object defined in a Module.
|
|
3305
3126
|
*/
|
|
@@ -3550,10 +3371,6 @@ export declare class Client extends BaseClient {
|
|
|
3550
3371
|
* Load a GeneratedCode from its ID.
|
|
3551
3372
|
*/
|
|
3552
3373
|
loadGeneratedCodeFromID: (id: GeneratedCodeID) => GeneratedCode;
|
|
3553
|
-
/**
|
|
3554
|
-
* Load a GitModuleSource from its ID.
|
|
3555
|
-
*/
|
|
3556
|
-
loadGitModuleSourceFromID: (id: GitModuleSourceID) => GitModuleSource;
|
|
3557
3374
|
/**
|
|
3558
3375
|
* Load a GitRef from its ID.
|
|
3559
3376
|
*/
|
|
@@ -3582,14 +3399,6 @@ export declare class Client extends BaseClient {
|
|
|
3582
3399
|
* Load a ListTypeDef from its ID.
|
|
3583
3400
|
*/
|
|
3584
3401
|
loadListTypeDefFromID: (id: ListTypeDefID) => ListTypeDef;
|
|
3585
|
-
/**
|
|
3586
|
-
* Load a LocalModuleSource from its ID.
|
|
3587
|
-
*/
|
|
3588
|
-
loadLocalModuleSourceFromID: (id: LocalModuleSourceID) => LocalModuleSource;
|
|
3589
|
-
/**
|
|
3590
|
-
* Load a ModuleDependency from its ID.
|
|
3591
|
-
*/
|
|
3592
|
-
loadModuleDependencyFromID: (id: ModuleDependencyID) => ModuleDependency;
|
|
3593
3402
|
/**
|
|
3594
3403
|
* Load a Module from its ID.
|
|
3595
3404
|
*/
|
|
@@ -3598,10 +3407,6 @@ export declare class Client extends BaseClient {
|
|
|
3598
3407
|
* Load a ModuleSource from its ID.
|
|
3599
3408
|
*/
|
|
3600
3409
|
loadModuleSourceFromID: (id: ModuleSourceID) => ModuleSource;
|
|
3601
|
-
/**
|
|
3602
|
-
* Load a ModuleSourceView from its ID.
|
|
3603
|
-
*/
|
|
3604
|
-
loadModuleSourceViewFromID: (id: ModuleSourceViewID) => ModuleSourceView;
|
|
3605
3410
|
/**
|
|
3606
3411
|
* Load a ObjectTypeDef from its ID.
|
|
3607
3412
|
*/
|
|
@@ -3651,17 +3456,12 @@ export declare class Client extends BaseClient {
|
|
|
3651
3456
|
*/
|
|
3652
3457
|
module_: () => Module_;
|
|
3653
3458
|
/**
|
|
3654
|
-
* Create a new module
|
|
3655
|
-
* @param source The source of the dependency
|
|
3656
|
-
* @param opts.name If set, the name to use for the dependency. Otherwise, once installed to a parent module, the name of the dependency module will be used by default.
|
|
3657
|
-
*/
|
|
3658
|
-
moduleDependency: (source: ModuleSource, opts?: ClientModuleDependencyOpts) => ModuleDependency;
|
|
3659
|
-
/**
|
|
3660
|
-
* Create a new module source instance from a source ref string.
|
|
3459
|
+
* Create a new module source instance from a source ref string
|
|
3661
3460
|
* @param refString The string ref representation of the module source
|
|
3662
3461
|
* @param opts.refPin The pinned version of the module source
|
|
3663
|
-
* @param opts.
|
|
3664
|
-
* @param opts.
|
|
3462
|
+
* @param opts.disableFindUp If true, do not attempt to find dagger.json in a parent directory of the provided path. Only relevant for local module sources.
|
|
3463
|
+
* @param opts.allowNotExists If true, do not error out if the provided ref string is a local path and does not exist yet. Useful when initializing new modules in directories that don't exist yet.
|
|
3464
|
+
* @param opts.requireKind If set, error out if the ref string is not of the provided requireKind.
|
|
3665
3465
|
*/
|
|
3666
3466
|
moduleSource: (refString: string, opts?: ClientModuleSourceOpts) => ModuleSource;
|
|
3667
3467
|
/**
|