@dagger.io/dagger 0.13.6 → 0.14.0
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.
- package/dist/api/client.gen.d.ts +313 -176
- package/dist/api/client.gen.d.ts.map +1 -1
- package/dist/api/client.gen.js +828 -522
- package/dist/provisioning/default.d.ts +1 -1
- package/dist/provisioning/default.js +1 -1
- package/package.json +1 -1
package/dist/api/client.gen.d.ts
CHANGED
|
@@ -262,6 +262,10 @@ export type ContainerWithExecOpts = {
|
|
|
262
262
|
* Redirect the command's standard error to a file in the container (e.g., "/tmp/stderr").
|
|
263
263
|
*/
|
|
264
264
|
redirectStderr?: string;
|
|
265
|
+
/**
|
|
266
|
+
* Exit codes this command is allowed to exit with without error
|
|
267
|
+
*/
|
|
268
|
+
expect?: ReturnType;
|
|
265
269
|
/**
|
|
266
270
|
* Provides Dagger access to the executed command.
|
|
267
271
|
*
|
|
@@ -517,30 +521,6 @@ export type CurrentModuleWorkdirOpts = {
|
|
|
517
521
|
export type CurrentModuleID = string & {
|
|
518
522
|
__CurrentModuleID: never;
|
|
519
523
|
};
|
|
520
|
-
/**
|
|
521
|
-
* The `DaggerEngineCacheEntryID` scalar type represents an identifier for an object of type DaggerEngineCacheEntry.
|
|
522
|
-
*/
|
|
523
|
-
export type DaggerEngineCacheEntryID = string & {
|
|
524
|
-
__DaggerEngineCacheEntryID: never;
|
|
525
|
-
};
|
|
526
|
-
/**
|
|
527
|
-
* The `DaggerEngineCacheEntrySetID` scalar type represents an identifier for an object of type DaggerEngineCacheEntrySet.
|
|
528
|
-
*/
|
|
529
|
-
export type DaggerEngineCacheEntrySetID = string & {
|
|
530
|
-
__DaggerEngineCacheEntrySetID: never;
|
|
531
|
-
};
|
|
532
|
-
/**
|
|
533
|
-
* The `DaggerEngineCacheID` scalar type represents an identifier for an object of type DaggerEngineCache.
|
|
534
|
-
*/
|
|
535
|
-
export type DaggerEngineCacheID = string & {
|
|
536
|
-
__DaggerEngineCacheID: never;
|
|
537
|
-
};
|
|
538
|
-
/**
|
|
539
|
-
* The `DaggerEngineID` scalar type represents an identifier for an object of type DaggerEngine.
|
|
540
|
-
*/
|
|
541
|
-
export type DaggerEngineID = string & {
|
|
542
|
-
__DaggerEngineID: never;
|
|
543
|
-
};
|
|
544
524
|
export type DirectoryAsModuleOpts = {
|
|
545
525
|
/**
|
|
546
526
|
* An optional subpath of the directory which contains the module's configuration file.
|
|
@@ -651,6 +631,30 @@ export type DirectoryWithNewFileOpts = {
|
|
|
651
631
|
export type DirectoryID = string & {
|
|
652
632
|
__DirectoryID: never;
|
|
653
633
|
};
|
|
634
|
+
/**
|
|
635
|
+
* The `EngineCacheEntryID` scalar type represents an identifier for an object of type EngineCacheEntry.
|
|
636
|
+
*/
|
|
637
|
+
export type EngineCacheEntryID = string & {
|
|
638
|
+
__EngineCacheEntryID: never;
|
|
639
|
+
};
|
|
640
|
+
/**
|
|
641
|
+
* The `EngineCacheEntrySetID` scalar type represents an identifier for an object of type EngineCacheEntrySet.
|
|
642
|
+
*/
|
|
643
|
+
export type EngineCacheEntrySetID = string & {
|
|
644
|
+
__EngineCacheEntrySetID: never;
|
|
645
|
+
};
|
|
646
|
+
/**
|
|
647
|
+
* The `EngineCacheID` scalar type represents an identifier for an object of type EngineCache.
|
|
648
|
+
*/
|
|
649
|
+
export type EngineCacheID = string & {
|
|
650
|
+
__EngineCacheID: never;
|
|
651
|
+
};
|
|
652
|
+
/**
|
|
653
|
+
* The `EngineID` scalar type represents an identifier for an object of type Engine.
|
|
654
|
+
*/
|
|
655
|
+
export type EngineID = string & {
|
|
656
|
+
__EngineID: never;
|
|
657
|
+
};
|
|
654
658
|
/**
|
|
655
659
|
* The `EnumTypeDefID` scalar type represents an identifier for an object of type EnumTypeDef.
|
|
656
660
|
*/
|
|
@@ -710,6 +714,7 @@ export type FunctionWithArgOpts = {
|
|
|
710
714
|
* Patterns to ignore when loading the contextual argument value.
|
|
711
715
|
*/
|
|
712
716
|
ignore?: string[];
|
|
717
|
+
sourceMap?: SourceMap;
|
|
713
718
|
};
|
|
714
719
|
/**
|
|
715
720
|
* The `FunctionArgID` scalar type represents an identifier for an object of type FunctionArg.
|
|
@@ -1034,6 +1039,23 @@ export type ClientModuleSourceOpts = {
|
|
|
1034
1039
|
export type ClientSecretOpts = {
|
|
1035
1040
|
accessor?: string;
|
|
1036
1041
|
};
|
|
1042
|
+
/**
|
|
1043
|
+
* Expected return type of an execution
|
|
1044
|
+
*/
|
|
1045
|
+
export declare enum ReturnType {
|
|
1046
|
+
/**
|
|
1047
|
+
* Any execution (exit codes 0-127)
|
|
1048
|
+
*/
|
|
1049
|
+
Any = "ANY",
|
|
1050
|
+
/**
|
|
1051
|
+
* A failed execution (exit codes 1-127)
|
|
1052
|
+
*/
|
|
1053
|
+
Failure = "FAILURE",
|
|
1054
|
+
/**
|
|
1055
|
+
* A successful execution (exit code 0)
|
|
1056
|
+
*/
|
|
1057
|
+
Success = "SUCCESS"
|
|
1058
|
+
}
|
|
1037
1059
|
/**
|
|
1038
1060
|
* The `ScalarTypeDefID` scalar type represents an identifier for an object of type ScalarTypeDef.
|
|
1039
1061
|
*/
|
|
@@ -1086,6 +1108,12 @@ export type ServiceID = string & {
|
|
|
1086
1108
|
export type SocketID = string & {
|
|
1087
1109
|
__SocketID: never;
|
|
1088
1110
|
};
|
|
1111
|
+
/**
|
|
1112
|
+
* The `SourceMapID` scalar type represents an identifier for an object of type SourceMap.
|
|
1113
|
+
*/
|
|
1114
|
+
export type SourceMapID = string & {
|
|
1115
|
+
__SourceMapID: never;
|
|
1116
|
+
};
|
|
1089
1117
|
/**
|
|
1090
1118
|
* The `TerminalID` scalar type represents an identifier for an object of type Terminal.
|
|
1091
1119
|
*/
|
|
@@ -1097,24 +1125,38 @@ export type TypeDefWithEnumOpts = {
|
|
|
1097
1125
|
* A doc string for the enum, if any
|
|
1098
1126
|
*/
|
|
1099
1127
|
description?: string;
|
|
1128
|
+
/**
|
|
1129
|
+
* The source map for the enum definition.
|
|
1130
|
+
*/
|
|
1131
|
+
sourceMap?: SourceMap;
|
|
1100
1132
|
};
|
|
1101
1133
|
export type TypeDefWithEnumValueOpts = {
|
|
1102
1134
|
/**
|
|
1103
1135
|
* A doc string for the value, if any
|
|
1104
1136
|
*/
|
|
1105
1137
|
description?: string;
|
|
1138
|
+
/**
|
|
1139
|
+
* The source map for the enum value definition.
|
|
1140
|
+
*/
|
|
1141
|
+
sourceMap?: SourceMap;
|
|
1106
1142
|
};
|
|
1107
1143
|
export type TypeDefWithFieldOpts = {
|
|
1108
1144
|
/**
|
|
1109
1145
|
* A doc string for the field, if any
|
|
1110
1146
|
*/
|
|
1111
1147
|
description?: string;
|
|
1148
|
+
/**
|
|
1149
|
+
* The source map for the field definition.
|
|
1150
|
+
*/
|
|
1151
|
+
sourceMap?: SourceMap;
|
|
1112
1152
|
};
|
|
1113
1153
|
export type TypeDefWithInterfaceOpts = {
|
|
1114
1154
|
description?: string;
|
|
1155
|
+
sourceMap?: SourceMap;
|
|
1115
1156
|
};
|
|
1116
1157
|
export type TypeDefWithObjectOpts = {
|
|
1117
1158
|
description?: string;
|
|
1159
|
+
sourceMap?: SourceMap;
|
|
1118
1160
|
};
|
|
1119
1161
|
export type TypeDefWithScalarOpts = {
|
|
1120
1162
|
description?: string;
|
|
@@ -1217,6 +1259,7 @@ export declare class CacheVolume extends BaseClient {
|
|
|
1217
1259
|
export declare class Container extends BaseClient {
|
|
1218
1260
|
private readonly _id?;
|
|
1219
1261
|
private readonly _envVariable?;
|
|
1262
|
+
private readonly _exitCode?;
|
|
1220
1263
|
private readonly _export?;
|
|
1221
1264
|
private readonly _imageRef?;
|
|
1222
1265
|
private readonly _label?;
|
|
@@ -1234,7 +1277,7 @@ export declare class Container extends BaseClient {
|
|
|
1234
1277
|
constructor(parent?: {
|
|
1235
1278
|
queryTree?: QueryTree[];
|
|
1236
1279
|
ctx: Context;
|
|
1237
|
-
}, _id?: ContainerID, _envVariable?: string, _export?: string, _imageRef?: string, _label?: string, _platform?: Platform, _publish?: string, _stderr?: string, _stdout?: string, _sync?: ContainerID, _up?: Void, _user?: string, _workdir?: string);
|
|
1280
|
+
}, _id?: ContainerID, _envVariable?: string, _exitCode?: number, _export?: string, _imageRef?: string, _label?: string, _platform?: Platform, _publish?: string, _stderr?: string, _stdout?: string, _sync?: ContainerID, _up?: Void, _user?: string, _workdir?: string);
|
|
1238
1281
|
/**
|
|
1239
1282
|
* A unique identifier for this Container.
|
|
1240
1283
|
*/
|
|
@@ -1296,6 +1339,12 @@ export declare class Container extends BaseClient {
|
|
|
1296
1339
|
* Retrieves the list of environment variables passed to commands.
|
|
1297
1340
|
*/
|
|
1298
1341
|
envVariables: () => Promise<EnvVariable[]>;
|
|
1342
|
+
/**
|
|
1343
|
+
* The exit code of the last executed command.
|
|
1344
|
+
*
|
|
1345
|
+
* Returns an error if no command was set.
|
|
1346
|
+
*/
|
|
1347
|
+
exitCode: () => Promise<number>;
|
|
1299
1348
|
/**
|
|
1300
1349
|
* EXPERIMENTAL API! Subject to change/removal at any time.
|
|
1301
1350
|
*
|
|
@@ -1407,13 +1456,13 @@ export declare class Container extends BaseClient {
|
|
|
1407
1456
|
/**
|
|
1408
1457
|
* The error stream of the last executed command.
|
|
1409
1458
|
*
|
|
1410
|
-
*
|
|
1459
|
+
* Returns an error if no command was set.
|
|
1411
1460
|
*/
|
|
1412
1461
|
stderr: () => Promise<string>;
|
|
1413
1462
|
/**
|
|
1414
1463
|
* The output stream of the last executed command.
|
|
1415
1464
|
*
|
|
1416
|
-
*
|
|
1465
|
+
* Returns an error if no command was set.
|
|
1417
1466
|
*/
|
|
1418
1467
|
stdout: () => Promise<string>;
|
|
1419
1468
|
/**
|
|
@@ -1501,6 +1550,7 @@ export declare class Container extends BaseClient {
|
|
|
1501
1550
|
* @param opts.stdin Content to write to the command's standard input before closing (e.g., "Hello world").
|
|
1502
1551
|
* @param opts.redirectStdout Redirect the command's standard output to a file in the container (e.g., "/tmp/stdout").
|
|
1503
1552
|
* @param opts.redirectStderr Redirect the command's standard error to a file in the container (e.g., "/tmp/stderr").
|
|
1553
|
+
* @param opts.expect Exit codes this command is allowed to exit with without error
|
|
1504
1554
|
* @param opts.experimentalPrivilegedNesting Provides Dagger access to the executed command.
|
|
1505
1555
|
*
|
|
1506
1556
|
* Do not use this option unless you trust the command being executed; the command being executed WILL BE GRANTED FULL ACCESS TO YOUR HOST FILESYSTEM.
|
|
@@ -1551,10 +1601,6 @@ export declare class Container extends BaseClient {
|
|
|
1551
1601
|
* @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").
|
|
1552
1602
|
*/
|
|
1553
1603
|
withFiles: (path: string, sources: File[], opts?: ContainerWithFilesOpts) => Container;
|
|
1554
|
-
/**
|
|
1555
|
-
* Indicate that subsequent operations should be featured more prominently in the UI.
|
|
1556
|
-
*/
|
|
1557
|
-
withFocus: () => Container;
|
|
1558
1604
|
/**
|
|
1559
1605
|
* Retrieves this container plus the given label.
|
|
1560
1606
|
* @param name The name of the label (e.g., "org.opencontainers.artifact.created").
|
|
@@ -1734,12 +1780,6 @@ export declare class Container extends BaseClient {
|
|
|
1734
1780
|
* @param opts.expand Replace "${VAR}" or "$VAR" in the value of paths according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
|
|
1735
1781
|
*/
|
|
1736
1782
|
withoutFiles: (paths: string[], opts?: ContainerWithoutFilesOpts) => Container;
|
|
1737
|
-
/**
|
|
1738
|
-
* Indicate that subsequent operations should not be featured more prominently in the UI.
|
|
1739
|
-
*
|
|
1740
|
-
* This is the initial state of all containers.
|
|
1741
|
-
*/
|
|
1742
|
-
withoutFocus: () => Container;
|
|
1743
1783
|
/**
|
|
1744
1784
|
* Retrieves this container minus the given environment label.
|
|
1745
1785
|
* @param name The name of the label to remove (e.g., "org.opencontainers.artifact.created").
|
|
@@ -1830,131 +1870,6 @@ export declare class CurrentModule extends BaseClient {
|
|
|
1830
1870
|
*/
|
|
1831
1871
|
workdirFile: (path: string) => File;
|
|
1832
1872
|
}
|
|
1833
|
-
/**
|
|
1834
|
-
* The Dagger engine configuration and state
|
|
1835
|
-
*/
|
|
1836
|
-
export declare class DaggerEngine extends BaseClient {
|
|
1837
|
-
private readonly _id?;
|
|
1838
|
-
/**
|
|
1839
|
-
* Constructor is used for internal usage only, do not create object from it.
|
|
1840
|
-
*/
|
|
1841
|
-
constructor(parent?: {
|
|
1842
|
-
queryTree?: QueryTree[];
|
|
1843
|
-
ctx: Context;
|
|
1844
|
-
}, _id?: DaggerEngineID);
|
|
1845
|
-
/**
|
|
1846
|
-
* A unique identifier for this DaggerEngine.
|
|
1847
|
-
*/
|
|
1848
|
-
id: () => Promise<DaggerEngineID>;
|
|
1849
|
-
/**
|
|
1850
|
-
* The local (on-disk) cache for the Dagger engine
|
|
1851
|
-
*/
|
|
1852
|
-
localCache: () => DaggerEngineCache;
|
|
1853
|
-
}
|
|
1854
|
-
/**
|
|
1855
|
-
* A cache storage for the Dagger engine
|
|
1856
|
-
*/
|
|
1857
|
-
export declare class DaggerEngineCache extends BaseClient {
|
|
1858
|
-
private readonly _id?;
|
|
1859
|
-
private readonly _keepBytes?;
|
|
1860
|
-
private readonly _prune?;
|
|
1861
|
-
/**
|
|
1862
|
-
* Constructor is used for internal usage only, do not create object from it.
|
|
1863
|
-
*/
|
|
1864
|
-
constructor(parent?: {
|
|
1865
|
-
queryTree?: QueryTree[];
|
|
1866
|
-
ctx: Context;
|
|
1867
|
-
}, _id?: DaggerEngineCacheID, _keepBytes?: number, _prune?: Void);
|
|
1868
|
-
/**
|
|
1869
|
-
* A unique identifier for this DaggerEngineCache.
|
|
1870
|
-
*/
|
|
1871
|
-
id: () => Promise<DaggerEngineCacheID>;
|
|
1872
|
-
/**
|
|
1873
|
-
* The current set of entries in the cache
|
|
1874
|
-
*/
|
|
1875
|
-
entrySet: () => DaggerEngineCacheEntrySet;
|
|
1876
|
-
/**
|
|
1877
|
-
* The maximum bytes to keep in the cache without pruning, after which automatic pruning may kick in.
|
|
1878
|
-
*/
|
|
1879
|
-
keepBytes: () => Promise<number>;
|
|
1880
|
-
/**
|
|
1881
|
-
* Prune the cache of releaseable entries
|
|
1882
|
-
*/
|
|
1883
|
-
prune: () => Promise<void>;
|
|
1884
|
-
}
|
|
1885
|
-
/**
|
|
1886
|
-
* An individual cache entry in a cache entry set
|
|
1887
|
-
*/
|
|
1888
|
-
export declare class DaggerEngineCacheEntry extends BaseClient {
|
|
1889
|
-
private readonly _id?;
|
|
1890
|
-
private readonly _activelyUsed?;
|
|
1891
|
-
private readonly _createdTimeUnixNano?;
|
|
1892
|
-
private readonly _description?;
|
|
1893
|
-
private readonly _diskSpaceBytes?;
|
|
1894
|
-
private readonly _mostRecentUseTimeUnixNano?;
|
|
1895
|
-
/**
|
|
1896
|
-
* Constructor is used for internal usage only, do not create object from it.
|
|
1897
|
-
*/
|
|
1898
|
-
constructor(parent?: {
|
|
1899
|
-
queryTree?: QueryTree[];
|
|
1900
|
-
ctx: Context;
|
|
1901
|
-
}, _id?: DaggerEngineCacheEntryID, _activelyUsed?: boolean, _createdTimeUnixNano?: number, _description?: string, _diskSpaceBytes?: number, _mostRecentUseTimeUnixNano?: number);
|
|
1902
|
-
/**
|
|
1903
|
-
* A unique identifier for this DaggerEngineCacheEntry.
|
|
1904
|
-
*/
|
|
1905
|
-
id: () => Promise<DaggerEngineCacheEntryID>;
|
|
1906
|
-
/**
|
|
1907
|
-
* Whether the cache entry is actively being used.
|
|
1908
|
-
*/
|
|
1909
|
-
activelyUsed: () => Promise<boolean>;
|
|
1910
|
-
/**
|
|
1911
|
-
* The time the cache entry was created, in Unix nanoseconds.
|
|
1912
|
-
*/
|
|
1913
|
-
createdTimeUnixNano: () => Promise<number>;
|
|
1914
|
-
/**
|
|
1915
|
-
* The description of the cache entry.
|
|
1916
|
-
*/
|
|
1917
|
-
description: () => Promise<string>;
|
|
1918
|
-
/**
|
|
1919
|
-
* The disk space used by the cache entry.
|
|
1920
|
-
*/
|
|
1921
|
-
diskSpaceBytes: () => Promise<number>;
|
|
1922
|
-
/**
|
|
1923
|
-
* The most recent time the cache entry was used, in Unix nanoseconds.
|
|
1924
|
-
*/
|
|
1925
|
-
mostRecentUseTimeUnixNano: () => Promise<number>;
|
|
1926
|
-
}
|
|
1927
|
-
/**
|
|
1928
|
-
* A set of cache entries returned by a query to a cache
|
|
1929
|
-
*/
|
|
1930
|
-
export declare class DaggerEngineCacheEntrySet extends BaseClient {
|
|
1931
|
-
private readonly _id?;
|
|
1932
|
-
private readonly _diskSpaceBytes?;
|
|
1933
|
-
private readonly _entryCount?;
|
|
1934
|
-
/**
|
|
1935
|
-
* Constructor is used for internal usage only, do not create object from it.
|
|
1936
|
-
*/
|
|
1937
|
-
constructor(parent?: {
|
|
1938
|
-
queryTree?: QueryTree[];
|
|
1939
|
-
ctx: Context;
|
|
1940
|
-
}, _id?: DaggerEngineCacheEntrySetID, _diskSpaceBytes?: number, _entryCount?: number);
|
|
1941
|
-
/**
|
|
1942
|
-
* A unique identifier for this DaggerEngineCacheEntrySet.
|
|
1943
|
-
*/
|
|
1944
|
-
id: () => Promise<DaggerEngineCacheEntrySetID>;
|
|
1945
|
-
/**
|
|
1946
|
-
* The total disk space used by the cache entries in this set.
|
|
1947
|
-
*/
|
|
1948
|
-
diskSpaceBytes: () => Promise<number>;
|
|
1949
|
-
/**
|
|
1950
|
-
* The list of individual cache entries in the set
|
|
1951
|
-
*/
|
|
1952
|
-
entries: () => Promise<DaggerEngineCacheEntry[]>;
|
|
1953
|
-
/**
|
|
1954
|
-
* The number of cache entries in this set.
|
|
1955
|
-
*/
|
|
1956
|
-
entryCount: () => Promise<number>;
|
|
1957
|
-
}
|
|
1958
1873
|
/**
|
|
1959
1874
|
* A directory.
|
|
1960
1875
|
*/
|
|
@@ -2108,6 +2023,144 @@ export declare class Directory extends BaseClient {
|
|
|
2108
2023
|
*/
|
|
2109
2024
|
with: (arg: (param: Directory) => Directory) => Directory;
|
|
2110
2025
|
}
|
|
2026
|
+
/**
|
|
2027
|
+
* The Dagger engine configuration and state
|
|
2028
|
+
*/
|
|
2029
|
+
export declare class Engine extends BaseClient {
|
|
2030
|
+
private readonly _id?;
|
|
2031
|
+
/**
|
|
2032
|
+
* Constructor is used for internal usage only, do not create object from it.
|
|
2033
|
+
*/
|
|
2034
|
+
constructor(parent?: {
|
|
2035
|
+
queryTree?: QueryTree[];
|
|
2036
|
+
ctx: Context;
|
|
2037
|
+
}, _id?: EngineID);
|
|
2038
|
+
/**
|
|
2039
|
+
* A unique identifier for this Engine.
|
|
2040
|
+
*/
|
|
2041
|
+
id: () => Promise<EngineID>;
|
|
2042
|
+
/**
|
|
2043
|
+
* The local (on-disk) cache for the Dagger engine
|
|
2044
|
+
*/
|
|
2045
|
+
localCache: () => EngineCache;
|
|
2046
|
+
}
|
|
2047
|
+
/**
|
|
2048
|
+
* A cache storage for the Dagger engine
|
|
2049
|
+
*/
|
|
2050
|
+
export declare class EngineCache extends BaseClient {
|
|
2051
|
+
private readonly _id?;
|
|
2052
|
+
private readonly _keepBytes?;
|
|
2053
|
+
private readonly _maxUsedSpace?;
|
|
2054
|
+
private readonly _minFreeSpace?;
|
|
2055
|
+
private readonly _prune?;
|
|
2056
|
+
private readonly _reservedSpace?;
|
|
2057
|
+
/**
|
|
2058
|
+
* Constructor is used for internal usage only, do not create object from it.
|
|
2059
|
+
*/
|
|
2060
|
+
constructor(parent?: {
|
|
2061
|
+
queryTree?: QueryTree[];
|
|
2062
|
+
ctx: Context;
|
|
2063
|
+
}, _id?: EngineCacheID, _keepBytes?: number, _maxUsedSpace?: number, _minFreeSpace?: number, _prune?: Void, _reservedSpace?: number);
|
|
2064
|
+
/**
|
|
2065
|
+
* A unique identifier for this EngineCache.
|
|
2066
|
+
*/
|
|
2067
|
+
id: () => Promise<EngineCacheID>;
|
|
2068
|
+
/**
|
|
2069
|
+
* The current set of entries in the cache
|
|
2070
|
+
*/
|
|
2071
|
+
entrySet: () => EngineCacheEntrySet;
|
|
2072
|
+
/**
|
|
2073
|
+
* The maximum bytes to keep in the cache without pruning, after which automatic pruning may kick in.
|
|
2074
|
+
* @deprecated Use minFreeSpace instead.
|
|
2075
|
+
*/
|
|
2076
|
+
keepBytes: () => Promise<number>;
|
|
2077
|
+
/**
|
|
2078
|
+
* The maximum bytes to keep in the cache without pruning.
|
|
2079
|
+
*/
|
|
2080
|
+
maxUsedSpace: () => Promise<number>;
|
|
2081
|
+
/**
|
|
2082
|
+
* The target amount of free disk space the garbage collector will attempt to leave.
|
|
2083
|
+
*/
|
|
2084
|
+
minFreeSpace: () => Promise<number>;
|
|
2085
|
+
/**
|
|
2086
|
+
* Prune the cache of releaseable entries
|
|
2087
|
+
*/
|
|
2088
|
+
prune: () => Promise<void>;
|
|
2089
|
+
reservedSpace: () => Promise<number>;
|
|
2090
|
+
}
|
|
2091
|
+
/**
|
|
2092
|
+
* An individual cache entry in a cache entry set
|
|
2093
|
+
*/
|
|
2094
|
+
export declare class EngineCacheEntry extends BaseClient {
|
|
2095
|
+
private readonly _id?;
|
|
2096
|
+
private readonly _activelyUsed?;
|
|
2097
|
+
private readonly _createdTimeUnixNano?;
|
|
2098
|
+
private readonly _description?;
|
|
2099
|
+
private readonly _diskSpaceBytes?;
|
|
2100
|
+
private readonly _mostRecentUseTimeUnixNano?;
|
|
2101
|
+
/**
|
|
2102
|
+
* Constructor is used for internal usage only, do not create object from it.
|
|
2103
|
+
*/
|
|
2104
|
+
constructor(parent?: {
|
|
2105
|
+
queryTree?: QueryTree[];
|
|
2106
|
+
ctx: Context;
|
|
2107
|
+
}, _id?: EngineCacheEntryID, _activelyUsed?: boolean, _createdTimeUnixNano?: number, _description?: string, _diskSpaceBytes?: number, _mostRecentUseTimeUnixNano?: number);
|
|
2108
|
+
/**
|
|
2109
|
+
* A unique identifier for this EngineCacheEntry.
|
|
2110
|
+
*/
|
|
2111
|
+
id: () => Promise<EngineCacheEntryID>;
|
|
2112
|
+
/**
|
|
2113
|
+
* Whether the cache entry is actively being used.
|
|
2114
|
+
*/
|
|
2115
|
+
activelyUsed: () => Promise<boolean>;
|
|
2116
|
+
/**
|
|
2117
|
+
* The time the cache entry was created, in Unix nanoseconds.
|
|
2118
|
+
*/
|
|
2119
|
+
createdTimeUnixNano: () => Promise<number>;
|
|
2120
|
+
/**
|
|
2121
|
+
* The description of the cache entry.
|
|
2122
|
+
*/
|
|
2123
|
+
description: () => Promise<string>;
|
|
2124
|
+
/**
|
|
2125
|
+
* The disk space used by the cache entry.
|
|
2126
|
+
*/
|
|
2127
|
+
diskSpaceBytes: () => Promise<number>;
|
|
2128
|
+
/**
|
|
2129
|
+
* The most recent time the cache entry was used, in Unix nanoseconds.
|
|
2130
|
+
*/
|
|
2131
|
+
mostRecentUseTimeUnixNano: () => Promise<number>;
|
|
2132
|
+
}
|
|
2133
|
+
/**
|
|
2134
|
+
* A set of cache entries returned by a query to a cache
|
|
2135
|
+
*/
|
|
2136
|
+
export declare class EngineCacheEntrySet extends BaseClient {
|
|
2137
|
+
private readonly _id?;
|
|
2138
|
+
private readonly _diskSpaceBytes?;
|
|
2139
|
+
private readonly _entryCount?;
|
|
2140
|
+
/**
|
|
2141
|
+
* Constructor is used for internal usage only, do not create object from it.
|
|
2142
|
+
*/
|
|
2143
|
+
constructor(parent?: {
|
|
2144
|
+
queryTree?: QueryTree[];
|
|
2145
|
+
ctx: Context;
|
|
2146
|
+
}, _id?: EngineCacheEntrySetID, _diskSpaceBytes?: number, _entryCount?: number);
|
|
2147
|
+
/**
|
|
2148
|
+
* A unique identifier for this EngineCacheEntrySet.
|
|
2149
|
+
*/
|
|
2150
|
+
id: () => Promise<EngineCacheEntrySetID>;
|
|
2151
|
+
/**
|
|
2152
|
+
* The total disk space used by the cache entries in this set.
|
|
2153
|
+
*/
|
|
2154
|
+
diskSpaceBytes: () => Promise<number>;
|
|
2155
|
+
/**
|
|
2156
|
+
* The list of individual cache entries in the set
|
|
2157
|
+
*/
|
|
2158
|
+
entries: () => Promise<EngineCacheEntry[]>;
|
|
2159
|
+
/**
|
|
2160
|
+
* The number of cache entries in this set.
|
|
2161
|
+
*/
|
|
2162
|
+
entryCount: () => Promise<number>;
|
|
2163
|
+
}
|
|
2111
2164
|
/**
|
|
2112
2165
|
* A definition of a custom enum defined in a Module.
|
|
2113
2166
|
*/
|
|
@@ -2135,6 +2188,10 @@ export declare class EnumTypeDef extends BaseClient {
|
|
|
2135
2188
|
* The name of the enum.
|
|
2136
2189
|
*/
|
|
2137
2190
|
name: () => Promise<string>;
|
|
2191
|
+
/**
|
|
2192
|
+
* The location of this enum declaration.
|
|
2193
|
+
*/
|
|
2194
|
+
sourceMap: () => SourceMap;
|
|
2138
2195
|
/**
|
|
2139
2196
|
* If this EnumTypeDef is associated with a Module, the name of the module. Unset otherwise.
|
|
2140
2197
|
*/
|
|
@@ -2170,6 +2227,10 @@ export declare class EnumValueTypeDef extends BaseClient {
|
|
|
2170
2227
|
* The name of the enum value.
|
|
2171
2228
|
*/
|
|
2172
2229
|
name: () => Promise<string>;
|
|
2230
|
+
/**
|
|
2231
|
+
* The location of this enum value declaration.
|
|
2232
|
+
*/
|
|
2233
|
+
sourceMap: () => SourceMap;
|
|
2173
2234
|
}
|
|
2174
2235
|
/**
|
|
2175
2236
|
* An environment variable name and value.
|
|
@@ -2226,6 +2287,10 @@ export declare class FieldTypeDef extends BaseClient {
|
|
|
2226
2287
|
* The name of the field in lowerCamelCase format.
|
|
2227
2288
|
*/
|
|
2228
2289
|
name: () => Promise<string>;
|
|
2290
|
+
/**
|
|
2291
|
+
* The location of this field declaration.
|
|
2292
|
+
*/
|
|
2293
|
+
sourceMap: () => SourceMap;
|
|
2229
2294
|
/**
|
|
2230
2295
|
* The type of the field.
|
|
2231
2296
|
*/
|
|
@@ -2335,6 +2400,10 @@ export declare class Function_ extends BaseClient {
|
|
|
2335
2400
|
* The type returned by the function.
|
|
2336
2401
|
*/
|
|
2337
2402
|
returnType: () => TypeDef;
|
|
2403
|
+
/**
|
|
2404
|
+
* The location of this function declaration.
|
|
2405
|
+
*/
|
|
2406
|
+
sourceMap: () => SourceMap;
|
|
2338
2407
|
/**
|
|
2339
2408
|
* Returns the function with the provided argument
|
|
2340
2409
|
* @param name The name of the argument
|
|
@@ -2350,6 +2419,11 @@ export declare class Function_ extends BaseClient {
|
|
|
2350
2419
|
* @param description The doc string to set.
|
|
2351
2420
|
*/
|
|
2352
2421
|
withDescription: (description: string) => Function_;
|
|
2422
|
+
/**
|
|
2423
|
+
* Returns the function with the given source map.
|
|
2424
|
+
* @param sourceMap The source map for the function definition.
|
|
2425
|
+
*/
|
|
2426
|
+
withSourceMap: (sourceMap: SourceMap) => Function_;
|
|
2353
2427
|
/**
|
|
2354
2428
|
* Call the provided function with current Function.
|
|
2355
2429
|
*
|
|
@@ -2399,6 +2473,10 @@ export declare class FunctionArg extends BaseClient {
|
|
|
2399
2473
|
* The name of the argument in lowerCamelCase format.
|
|
2400
2474
|
*/
|
|
2401
2475
|
name: () => Promise<string>;
|
|
2476
|
+
/**
|
|
2477
|
+
* The location of this arg declaration.
|
|
2478
|
+
*/
|
|
2479
|
+
sourceMap: () => SourceMap;
|
|
2402
2480
|
/**
|
|
2403
2481
|
* The type of the argument.
|
|
2404
2482
|
*/
|
|
@@ -2788,6 +2866,10 @@ export declare class InterfaceTypeDef extends BaseClient {
|
|
|
2788
2866
|
* The name of the interface.
|
|
2789
2867
|
*/
|
|
2790
2868
|
name: () => Promise<string>;
|
|
2869
|
+
/**
|
|
2870
|
+
* The location of this interface declaration.
|
|
2871
|
+
*/
|
|
2872
|
+
sourceMap: () => SourceMap;
|
|
2791
2873
|
/**
|
|
2792
2874
|
* If this InterfaceTypeDef is associated with a Module, the name of the module. Unset otherwise.
|
|
2793
2875
|
*/
|
|
@@ -3226,6 +3308,10 @@ export declare class ObjectTypeDef extends BaseClient {
|
|
|
3226
3308
|
* The name of the object.
|
|
3227
3309
|
*/
|
|
3228
3310
|
name: () => Promise<string>;
|
|
3311
|
+
/**
|
|
3312
|
+
* The location of this object declaration.
|
|
3313
|
+
*/
|
|
3314
|
+
sourceMap: () => SourceMap;
|
|
3229
3315
|
/**
|
|
3230
3316
|
* If this ObjectTypeDef is associated with a Module, the name of the module. Unset otherwise.
|
|
3231
3317
|
*/
|
|
@@ -3324,10 +3410,6 @@ export declare class Client extends BaseClient {
|
|
|
3324
3410
|
* The TypeDef representations of the objects currently being served in the session.
|
|
3325
3411
|
*/
|
|
3326
3412
|
currentTypeDefs: () => Promise<TypeDef[]>;
|
|
3327
|
-
/**
|
|
3328
|
-
* The Dagger engine container configuration and state
|
|
3329
|
-
*/
|
|
3330
|
-
daggerEngine: () => DaggerEngine;
|
|
3331
3413
|
/**
|
|
3332
3414
|
* The default platform of the engine.
|
|
3333
3415
|
*/
|
|
@@ -3336,6 +3418,10 @@ export declare class Client extends BaseClient {
|
|
|
3336
3418
|
* Creates an empty directory.
|
|
3337
3419
|
*/
|
|
3338
3420
|
directory: () => Directory;
|
|
3421
|
+
/**
|
|
3422
|
+
* The Dagger engine container configuration and state
|
|
3423
|
+
*/
|
|
3424
|
+
engine: () => Engine;
|
|
3339
3425
|
/**
|
|
3340
3426
|
* Creates a function.
|
|
3341
3427
|
* @param name Name of the function, in its original format from the implementation language.
|
|
@@ -3382,25 +3468,25 @@ export declare class Client extends BaseClient {
|
|
|
3382
3468
|
*/
|
|
3383
3469
|
loadCurrentModuleFromID: (id: CurrentModuleID) => CurrentModule;
|
|
3384
3470
|
/**
|
|
3385
|
-
* Load a
|
|
3471
|
+
* Load a Directory from its ID.
|
|
3386
3472
|
*/
|
|
3387
|
-
|
|
3473
|
+
loadDirectoryFromID: (id: DirectoryID) => Directory;
|
|
3388
3474
|
/**
|
|
3389
|
-
* Load a
|
|
3475
|
+
* Load a EngineCacheEntry from its ID.
|
|
3390
3476
|
*/
|
|
3391
|
-
|
|
3477
|
+
loadEngineCacheEntryFromID: (id: EngineCacheEntryID) => EngineCacheEntry;
|
|
3392
3478
|
/**
|
|
3393
|
-
* Load a
|
|
3479
|
+
* Load a EngineCacheEntrySet from its ID.
|
|
3394
3480
|
*/
|
|
3395
|
-
|
|
3481
|
+
loadEngineCacheEntrySetFromID: (id: EngineCacheEntrySetID) => EngineCacheEntrySet;
|
|
3396
3482
|
/**
|
|
3397
|
-
* Load a
|
|
3483
|
+
* Load a EngineCache from its ID.
|
|
3398
3484
|
*/
|
|
3399
|
-
|
|
3485
|
+
loadEngineCacheFromID: (id: EngineCacheID) => EngineCache;
|
|
3400
3486
|
/**
|
|
3401
|
-
* Load a
|
|
3487
|
+
* Load a Engine from its ID.
|
|
3402
3488
|
*/
|
|
3403
|
-
|
|
3489
|
+
loadEngineFromID: (id: EngineID) => Engine;
|
|
3404
3490
|
/**
|
|
3405
3491
|
* Load a EnumTypeDef from its ID.
|
|
3406
3492
|
*/
|
|
@@ -3517,6 +3603,10 @@ export declare class Client extends BaseClient {
|
|
|
3517
3603
|
* Load a Socket from its ID.
|
|
3518
3604
|
*/
|
|
3519
3605
|
loadSocketFromID: (id: SocketID) => Socket;
|
|
3606
|
+
/**
|
|
3607
|
+
* Load a SourceMap from its ID.
|
|
3608
|
+
*/
|
|
3609
|
+
loadSourceMapFromID: (id: SourceMapID) => SourceMap;
|
|
3520
3610
|
/**
|
|
3521
3611
|
* Load a Terminal from its ID.
|
|
3522
3612
|
*/
|
|
@@ -3555,6 +3645,13 @@ export declare class Client extends BaseClient {
|
|
|
3555
3645
|
* @param plaintext The plaintext of the secret
|
|
3556
3646
|
*/
|
|
3557
3647
|
setSecret: (name: string, plaintext: string) => Secret;
|
|
3648
|
+
/**
|
|
3649
|
+
* Creates source map metadata.
|
|
3650
|
+
* @param filename The filename from the module source.
|
|
3651
|
+
* @param line The line number within the filename.
|
|
3652
|
+
* @param column The column number within the line.
|
|
3653
|
+
*/
|
|
3654
|
+
sourceMap: (filename: string, line: number, column: number) => SourceMap;
|
|
3558
3655
|
/**
|
|
3559
3656
|
* Create a new TypeDef.
|
|
3560
3657
|
*/
|
|
@@ -3710,6 +3807,43 @@ export declare class Socket extends BaseClient {
|
|
|
3710
3807
|
*/
|
|
3711
3808
|
id: () => Promise<SocketID>;
|
|
3712
3809
|
}
|
|
3810
|
+
/**
|
|
3811
|
+
* Source location information.
|
|
3812
|
+
*/
|
|
3813
|
+
export declare class SourceMap extends BaseClient {
|
|
3814
|
+
private readonly _id?;
|
|
3815
|
+
private readonly _column?;
|
|
3816
|
+
private readonly _filename?;
|
|
3817
|
+
private readonly _line?;
|
|
3818
|
+
private readonly _module?;
|
|
3819
|
+
/**
|
|
3820
|
+
* Constructor is used for internal usage only, do not create object from it.
|
|
3821
|
+
*/
|
|
3822
|
+
constructor(parent?: {
|
|
3823
|
+
queryTree?: QueryTree[];
|
|
3824
|
+
ctx: Context;
|
|
3825
|
+
}, _id?: SourceMapID, _column?: number, _filename?: string, _line?: number, _module?: string);
|
|
3826
|
+
/**
|
|
3827
|
+
* A unique identifier for this SourceMap.
|
|
3828
|
+
*/
|
|
3829
|
+
id: () => Promise<SourceMapID>;
|
|
3830
|
+
/**
|
|
3831
|
+
* The column number within the line.
|
|
3832
|
+
*/
|
|
3833
|
+
column: () => Promise<number>;
|
|
3834
|
+
/**
|
|
3835
|
+
* The filename from the module source.
|
|
3836
|
+
*/
|
|
3837
|
+
filename: () => Promise<string>;
|
|
3838
|
+
/**
|
|
3839
|
+
* The line number within the filename.
|
|
3840
|
+
*/
|
|
3841
|
+
line: () => Promise<number>;
|
|
3842
|
+
/**
|
|
3843
|
+
* The module dependency this was declared in.
|
|
3844
|
+
*/
|
|
3845
|
+
module_: () => Promise<string>;
|
|
3846
|
+
}
|
|
3713
3847
|
/**
|
|
3714
3848
|
* An interactive terminal that clients can connect to.
|
|
3715
3849
|
*/
|
|
@@ -3794,12 +3928,14 @@ export declare class TypeDef extends BaseClient {
|
|
|
3794
3928
|
* Note that an enum's values may be omitted if the intent is only to refer to an enum. This is how functions are able to return their own, or any other circular reference.
|
|
3795
3929
|
* @param name The name of the enum
|
|
3796
3930
|
* @param opts.description A doc string for the enum, if any
|
|
3931
|
+
* @param opts.sourceMap The source map for the enum definition.
|
|
3797
3932
|
*/
|
|
3798
3933
|
withEnum: (name: string, opts?: TypeDefWithEnumOpts) => TypeDef;
|
|
3799
3934
|
/**
|
|
3800
3935
|
* Adds a static value for an Enum TypeDef, failing if the type is not an enum.
|
|
3801
3936
|
* @param value The name of the value in the enum
|
|
3802
3937
|
* @param opts.description A doc string for the value, if any
|
|
3938
|
+
* @param opts.sourceMap The source map for the enum value definition.
|
|
3803
3939
|
*/
|
|
3804
3940
|
withEnumValue: (value: string, opts?: TypeDefWithEnumValueOpts) => TypeDef;
|
|
3805
3941
|
/**
|
|
@@ -3807,6 +3943,7 @@ export declare class TypeDef extends BaseClient {
|
|
|
3807
3943
|
* @param name The name of the field in the object
|
|
3808
3944
|
* @param typeDef The type of the field
|
|
3809
3945
|
* @param opts.description A doc string for the field, if any
|
|
3946
|
+
* @param opts.sourceMap The source map for the field definition.
|
|
3810
3947
|
*/
|
|
3811
3948
|
withField: (name: string, typeDef: TypeDef, opts?: TypeDefWithFieldOpts) => TypeDef;
|
|
3812
3949
|
/**
|