@dagger.io/core 1.0.0-beta.25 → 1.0.0-beta.28
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/client.gen.d.ts +264 -91
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/client.gen.js +381 -148
- package/package.json +2 -2
package/dist/client.gen.d.ts
CHANGED
|
@@ -477,6 +477,10 @@ export type ContainerDirectoryOpts = {
|
|
|
477
477
|
* Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
|
|
478
478
|
*/
|
|
479
479
|
expand?: boolean;
|
|
480
|
+
/**
|
|
481
|
+
* Repair symlinks that directory selection would break. Resolve targets across the root filesystem and directory or file mounts. Preserve working relative links and links that already have no target. Cache, volume, tmpfs, secret, and socket mounts cause an error if selection, a resolved link, or mount target resolution needs their contents.
|
|
482
|
+
*/
|
|
483
|
+
resolveBrokenSymlinks?: boolean;
|
|
480
484
|
};
|
|
481
485
|
export type ContainerExistsOpts = {
|
|
482
486
|
/**
|
|
@@ -574,7 +578,7 @@ export type ContainerFromOpts = {
|
|
|
574
578
|
/**
|
|
575
579
|
* Allow HTTPS registry communication without verifying the server certificate.
|
|
576
580
|
*/
|
|
577
|
-
|
|
581
|
+
insecureSkipTlsVerify?: boolean;
|
|
578
582
|
/**
|
|
579
583
|
* Ignore the workspace lockfile for this lookup.
|
|
580
584
|
*/
|
|
@@ -644,7 +648,7 @@ export type ContainerPublishOpts = {
|
|
|
644
648
|
/**
|
|
645
649
|
* Allow HTTPS registry communication without verifying the server certificate.
|
|
646
650
|
*/
|
|
647
|
-
|
|
651
|
+
insecureSkipTlsVerify?: boolean;
|
|
648
652
|
/**
|
|
649
653
|
* Clamp the image's timestamps to this time, so that rebuilding unchanged files produces identical layers.
|
|
650
654
|
*
|
|
@@ -1260,6 +1264,12 @@ export type DirectoryAsWorkspaceOpts = {
|
|
|
1260
1264
|
*/
|
|
1261
1265
|
cwd?: string;
|
|
1262
1266
|
};
|
|
1267
|
+
export type DirectoryDirectoryOpts = {
|
|
1268
|
+
/**
|
|
1269
|
+
* Repair symlinks that directory selection would break. Copy targets from this directory into the result. Preserve working relative links and links that already have no target.
|
|
1270
|
+
*/
|
|
1271
|
+
resolveBrokenSymlinks?: boolean;
|
|
1272
|
+
};
|
|
1263
1273
|
export type DirectoryDockerBuildOpts = {
|
|
1264
1274
|
/**
|
|
1265
1275
|
* Path to the Dockerfile to use (e.g., "frontend.Dockerfile").
|
|
@@ -1636,6 +1646,12 @@ export type FileSearchOpts = {
|
|
|
1636
1646
|
paths?: string[];
|
|
1637
1647
|
globs?: string[];
|
|
1638
1648
|
};
|
|
1649
|
+
export type FileSyncOpts = {
|
|
1650
|
+
/**
|
|
1651
|
+
* Also key the file by its content, so that what consumes it is cached across any two recipes that produce the same file. This hashes the file unless it already has a content key.
|
|
1652
|
+
*/
|
|
1653
|
+
keyByContent?: boolean;
|
|
1654
|
+
};
|
|
1639
1655
|
export type FileWithReplacedOpts = {
|
|
1640
1656
|
/**
|
|
1641
1657
|
* Replace all occurrences of the pattern.
|
|
@@ -1732,9 +1748,9 @@ export type FunctionWithDeprecatedOpts = {
|
|
|
1732
1748
|
* The behavior configured for function result caching.
|
|
1733
1749
|
*/
|
|
1734
1750
|
export declare enum FunctionCachePolicy {
|
|
1735
|
-
Default = "
|
|
1736
|
-
Never = "
|
|
1737
|
-
PerSession = "
|
|
1751
|
+
Default = "DEFAULT",
|
|
1752
|
+
Never = "NEVER",
|
|
1753
|
+
PerSession = "PER_SESSION"
|
|
1738
1754
|
}
|
|
1739
1755
|
/**
|
|
1740
1756
|
* Utility function to convert a FunctionCachePolicy value to its name so
|
|
@@ -1845,7 +1861,7 @@ export type GitRefPushOpts = {
|
|
|
1845
1861
|
/**
|
|
1846
1862
|
* Optional lease: a full lowercase object ID allows replacement only if the remote ref still has that value. Checked even for up-to-date pushes. Empty or omitted uses normal non-force rules, creating the ref if it does not exist.
|
|
1847
1863
|
*/
|
|
1848
|
-
|
|
1864
|
+
expectedRemoteSha?: string;
|
|
1849
1865
|
};
|
|
1850
1866
|
export type GitRefTreeOpts = {
|
|
1851
1867
|
/**
|
|
@@ -2047,11 +2063,10 @@ export declare function IdentifierWordKindNameToValue(name: string): IdentifierW
|
|
|
2047
2063
|
* Compression algorithm to use for image layers.
|
|
2048
2064
|
*/
|
|
2049
2065
|
export declare enum ImageLayerCompression {
|
|
2050
|
-
|
|
2051
|
-
|
|
2052
|
-
|
|
2053
|
-
|
|
2054
|
-
Zstd = "Zstd"
|
|
2066
|
+
Estargz = "ESTARGZ",
|
|
2067
|
+
Gzip = "GZIP",
|
|
2068
|
+
Uncompressed = "UNCOMPRESSED",
|
|
2069
|
+
Zstd = "ZSTD"
|
|
2055
2070
|
}
|
|
2056
2071
|
/**
|
|
2057
2072
|
* Utility function to convert a ImageLayerCompression value to its name so
|
|
@@ -2067,10 +2082,8 @@ export declare function ImageLayerCompressionNameToValue(name: string): ImageLay
|
|
|
2067
2082
|
* Mediatypes to use in published or exported image metadata.
|
|
2068
2083
|
*/
|
|
2069
2084
|
export declare enum ImageMediaTypes {
|
|
2070
|
-
Docker = "
|
|
2071
|
-
|
|
2072
|
-
Oci = "OCIMediaTypes",
|
|
2073
|
-
OciMediaTypes = "OCIMediaTypes"
|
|
2085
|
+
Docker = "DOCKER",
|
|
2086
|
+
Oci = "OCI"
|
|
2074
2087
|
}
|
|
2075
2088
|
/**
|
|
2076
2089
|
* Utility function to convert a ImageMediaTypes value to its name so
|
|
@@ -2395,6 +2408,16 @@ export type ModuleServeOpts = {
|
|
|
2395
2408
|
*/
|
|
2396
2409
|
entrypoint?: boolean;
|
|
2397
2410
|
};
|
|
2411
|
+
export type ModuleSourceClientSchemaIntrospectionJsonOpts = {
|
|
2412
|
+
/**
|
|
2413
|
+
* The engine version of the client the schema is generated for, e.g. the engineVersion of the module that depends on this one: core is described as that client sees it, capped at this engine's version.
|
|
2414
|
+
*
|
|
2415
|
+
* This module is still loaded at the engine version it declares, and so named by its own naming rules, as the engine serves it to such a client. Defaults to this module's own engine version.
|
|
2416
|
+
*
|
|
2417
|
+
* Use this rather than withEngineVersion, which makes this module declare another version and so changes its names.
|
|
2418
|
+
*/
|
|
2419
|
+
clientVersion?: string;
|
|
2420
|
+
};
|
|
2398
2421
|
/**
|
|
2399
2422
|
* Experimental features of a module
|
|
2400
2423
|
*/
|
|
@@ -2435,6 +2458,18 @@ export declare function ModuleSourceKindValueToName(value: ModuleSourceKind): st
|
|
|
2435
2458
|
* it can be properly used inside the module runtime.
|
|
2436
2459
|
*/
|
|
2437
2460
|
export declare function ModuleSourceKindNameToValue(name: string): ModuleSourceKind;
|
|
2461
|
+
export type NamingFormatIdentifiersOpts = {
|
|
2462
|
+
/**
|
|
2463
|
+
* How to write acronyms and terms where a word starts with a capital.
|
|
2464
|
+
*/
|
|
2465
|
+
acronyms?: AcronymStyle;
|
|
2466
|
+
};
|
|
2467
|
+
export type NamingModuleOpts = {
|
|
2468
|
+
/**
|
|
2469
|
+
* The module's original name, when it's loaded under another (as a dependency alias): its main object and namespaced type names are spelled after it. Defaults to name.
|
|
2470
|
+
*/
|
|
2471
|
+
originalName?: string;
|
|
2472
|
+
};
|
|
2438
2473
|
/**
|
|
2439
2474
|
* Transport layer network protocol associated to a port.
|
|
2440
2475
|
*/
|
|
@@ -2569,16 +2604,6 @@ export type ClientFileOpts = {
|
|
|
2569
2604
|
*/
|
|
2570
2605
|
permissions?: number;
|
|
2571
2606
|
};
|
|
2572
|
-
export type ClientFormatIdentifiersOpts = {
|
|
2573
|
-
/**
|
|
2574
|
-
* How to write acronyms and terms where a word starts with a capital.
|
|
2575
|
-
*/
|
|
2576
|
-
acronyms?: AcronymStyle;
|
|
2577
|
-
/**
|
|
2578
|
-
* The engine version whose naming dictionary to parse the names with, e.g. the __schemaVersion of a schema being generated. Defaults to the caller's engine version.
|
|
2579
|
-
*/
|
|
2580
|
-
version?: string;
|
|
2581
|
-
};
|
|
2582
2607
|
export type ClientGitOpts = {
|
|
2583
2608
|
/**
|
|
2584
2609
|
* DEPRECATED: Set to true to keep .git directory.
|
|
@@ -2665,6 +2690,12 @@ export type ClientModuleSourceOpts = {
|
|
|
2665
2690
|
*/
|
|
2666
2691
|
requireKind?: ModuleSourceKind;
|
|
2667
2692
|
};
|
|
2693
|
+
export type ClientNamingOpts = {
|
|
2694
|
+
/**
|
|
2695
|
+
* The engine version to answer for, e.g. the engine version a module declares. Defaults to the caller's. Normalized as a module's is: a version past the engine's is capped at the engine's own.
|
|
2696
|
+
*/
|
|
2697
|
+
version?: string;
|
|
2698
|
+
};
|
|
2668
2699
|
export type ClientSecretOpts = {
|
|
2669
2700
|
/**
|
|
2670
2701
|
* If set, the given string will be used as the cache key for this secret. This means that any secrets with the same cache key will be considered equivalent in terms of cache lookups, even if they have different URIs or plaintext values.
|
|
@@ -4128,11 +4159,11 @@ export declare class ClientFilesyncMirror extends BaseClient {
|
|
|
4128
4159
|
*/
|
|
4129
4160
|
export declare class Cloud extends BaseClient {
|
|
4130
4161
|
private readonly _id?;
|
|
4131
|
-
private readonly
|
|
4162
|
+
private readonly _traceUrl?;
|
|
4132
4163
|
/**
|
|
4133
4164
|
* Constructor is used for internal usage only, do not create object from it.
|
|
4134
4165
|
*/
|
|
4135
|
-
constructor(ctx?: Context, _id?: ID,
|
|
4166
|
+
constructor(ctx?: Context, _id?: ID, _traceUrl?: string);
|
|
4136
4167
|
/**
|
|
4137
4168
|
* A unique identifier for this Cloud.
|
|
4138
4169
|
*/
|
|
@@ -4140,7 +4171,7 @@ export declare class Cloud extends BaseClient {
|
|
|
4140
4171
|
/**
|
|
4141
4172
|
* The trace URL for the current session
|
|
4142
4173
|
*/
|
|
4143
|
-
|
|
4174
|
+
traceUrl: () => Promise<string>;
|
|
4144
4175
|
}
|
|
4145
4176
|
export declare class CollectionDelta extends BaseClient {
|
|
4146
4177
|
private readonly _id?;
|
|
@@ -4299,6 +4330,7 @@ export declare class Container extends BaseClient {
|
|
|
4299
4330
|
* Mounts are included.
|
|
4300
4331
|
* @param path The path of the directory to retrieve (e.g., "./src").
|
|
4301
4332
|
* @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").
|
|
4333
|
+
* @param opts.resolveBrokenSymlinks Repair symlinks that directory selection would break. Resolve targets across the root filesystem and directory or file mounts. Preserve working relative links and links that already have no target. Cache, volume, tmpfs, secret, and socket mounts cause an error if selection, a resolved link, or mount target resolution needs their contents.
|
|
4302
4334
|
*/
|
|
4303
4335
|
directory: (path: string, opts?: ContainerDirectoryOpts) => Directory;
|
|
4304
4336
|
/**
|
|
@@ -4336,17 +4368,17 @@ export declare class Container extends BaseClient {
|
|
|
4336
4368
|
* Configures all available GPUs on the host to be accessible to this container.
|
|
4337
4369
|
*
|
|
4338
4370
|
* This currently works for Nvidia devices only.
|
|
4339
|
-
* @deprecated Use "
|
|
4371
|
+
* @deprecated Use "withGpu" instead.
|
|
4340
4372
|
*/
|
|
4341
|
-
|
|
4373
|
+
experimentalWithAllGpus: () => Container;
|
|
4342
4374
|
/**
|
|
4343
4375
|
* Configures the provided list of devices to be accessible to this container.
|
|
4344
4376
|
*
|
|
4345
4377
|
* This currently works for Nvidia devices only.
|
|
4346
4378
|
* @param devices List of devices to be accessible to this container.
|
|
4347
|
-
* @deprecated Use "
|
|
4379
|
+
* @deprecated Use "withGpu" instead, which exposes all GPUs available on the host.
|
|
4348
4380
|
*/
|
|
4349
|
-
|
|
4381
|
+
experimentalWithGpu: (devices: string[]) => Container;
|
|
4350
4382
|
/**
|
|
4351
4383
|
* Writes the container as an OCI tarball to the destination file path on the host.
|
|
4352
4384
|
*
|
|
@@ -4412,7 +4444,7 @@ export declare class Container extends BaseClient {
|
|
|
4412
4444
|
* @param opts.protocol Protocol to use for registry communication.
|
|
4413
4445
|
*
|
|
4414
4446
|
* Defaults to "HTTPS". Use "HTTP" only for plain HTTP registries.
|
|
4415
|
-
* @param opts.
|
|
4447
|
+
* @param opts.insecureSkipTlsVerify Allow HTTPS registry communication without verifying the server certificate.
|
|
4416
4448
|
* @param opts.noLock Ignore the workspace lockfile for this lookup.
|
|
4417
4449
|
*/
|
|
4418
4450
|
from: (address: string, opts?: ContainerFromOpts) => Container;
|
|
@@ -4482,7 +4514,7 @@ export declare class Container extends BaseClient {
|
|
|
4482
4514
|
* @param opts.protocol Protocol to use for registry communication.
|
|
4483
4515
|
*
|
|
4484
4516
|
* Defaults to "HTTPS". Use "HTTP" only for plain HTTP registries.
|
|
4485
|
-
* @param opts.
|
|
4517
|
+
* @param opts.insecureSkipTlsVerify Allow HTTPS registry communication without verifying the server certificate.
|
|
4486
4518
|
* @param opts.sourceDateEpoch Clamp the image's timestamps to this time, so that rebuilding unchanged files produces identical layers.
|
|
4487
4519
|
*
|
|
4488
4520
|
* Formatted in seconds following Unix epoch (e.g., 1672531199). File timestamps in every layer and the image's creation times that are later than this are set to it, as with BuildKit's rewrite-timestamp and SOURCE_DATE_EPOCH. Every layer is rewritten, so this costs time on each export.
|
|
@@ -4706,7 +4738,7 @@ export declare class Container extends BaseClient {
|
|
|
4706
4738
|
*
|
|
4707
4739
|
* This currently works with NVIDIA devices only, and requires the engine to run with GPU support enabled.
|
|
4708
4740
|
*/
|
|
4709
|
-
|
|
4741
|
+
withGpu: () => Container;
|
|
4710
4742
|
/**
|
|
4711
4743
|
* Retrieves this container plus the given label.
|
|
4712
4744
|
* @param name The name of the label (e.g., "org.opencontainers.artifact.created").
|
|
@@ -5034,6 +5066,13 @@ export declare class CurrentModule extends BaseClient {
|
|
|
5034
5066
|
* The name of the module being executed in
|
|
5035
5067
|
*/
|
|
5036
5068
|
name: () => Promise<string>;
|
|
5069
|
+
/**
|
|
5070
|
+
* The names the engine gives this module's own declarations: the same as its source's ModuleSource.naming, for module runtimes, which have no ModuleSource.
|
|
5071
|
+
*
|
|
5072
|
+
* It answers for the module under its own name (ModuleSource.moduleName), by the naming rules of the version the module is named by. A workspace or toolchain that loads the module under another name namespaces its types under that name instead, which this doesn't reflect.
|
|
5073
|
+
* @experimental
|
|
5074
|
+
*/
|
|
5075
|
+
naming: () => ModuleNaming;
|
|
5037
5076
|
/**
|
|
5038
5077
|
* The directory containing the module's source code loaded into the engine (plus any generated code that may have been created).
|
|
5039
5078
|
*/
|
|
@@ -5163,8 +5202,9 @@ export declare class Directory extends BaseClient {
|
|
|
5163
5202
|
/**
|
|
5164
5203
|
* Retrieves a directory at the given path.
|
|
5165
5204
|
* @param path Location of the directory to retrieve. Example: "/src"
|
|
5205
|
+
* @param opts.resolveBrokenSymlinks Repair symlinks that directory selection would break. Copy targets from this directory into the result. Preserve working relative links and links that already have no target.
|
|
5166
5206
|
*/
|
|
5167
|
-
directory: (path: string) => Directory;
|
|
5207
|
+
directory: (path: string, opts?: DirectoryDirectoryOpts) => Directory;
|
|
5168
5208
|
/**
|
|
5169
5209
|
* Use Dockerfile compatibility to build a container from this directory. Only use this function for Dockerfile compatibility. Otherwise use the native Container type directly, it is feature-complete and supports all Dockerfile features.
|
|
5170
5210
|
* @param opts.dockerfile Path to the Dockerfile to use (e.g., "frontend.Dockerfile").
|
|
@@ -5335,6 +5375,15 @@ export declare class Directory extends BaseClient {
|
|
|
5335
5375
|
* @experimental
|
|
5336
5376
|
*/
|
|
5337
5377
|
withPatchFile: (patch: File, opts?: DirectoryWithPatchFileOpts) => Directory;
|
|
5378
|
+
/**
|
|
5379
|
+
* Retrieves this directory, declared as made for the given platform.
|
|
5380
|
+
*
|
|
5381
|
+
* Declare a result whose contents are the same whichever platform made them, such as a Go package compiled for a platform by any platform's Go toolchain. An engine of another platform that makes the same directory for the same platform then finds this one, and the other way around.
|
|
5382
|
+
*
|
|
5383
|
+
* The contents are not checked: a declared result that depends on the platform it was made on can be found where it doesn't belong.
|
|
5384
|
+
* @param platform The platform the directory's contents are for (e.g., "linux/arm64").
|
|
5385
|
+
*/
|
|
5386
|
+
withPlatform: (platform: Platform) => Directory;
|
|
5338
5387
|
/**
|
|
5339
5388
|
* Return a snapshot with a symlink
|
|
5340
5389
|
* @param target Location of the file or directory to link to (e.g., "/existing/file").
|
|
@@ -5868,7 +5917,7 @@ export declare class File extends BaseClient {
|
|
|
5868
5917
|
/**
|
|
5869
5918
|
* Parse the file contents as JSON.
|
|
5870
5919
|
*/
|
|
5871
|
-
|
|
5920
|
+
asJson: () => JSONValue;
|
|
5872
5921
|
/**
|
|
5873
5922
|
* Change the owner of the file recursively.
|
|
5874
5923
|
* @param owner A user:group to set for the file.
|
|
@@ -5941,8 +5990,9 @@ export declare class File extends BaseClient {
|
|
|
5941
5990
|
stat: () => Promise<Stat | null>;
|
|
5942
5991
|
/**
|
|
5943
5992
|
* Force evaluation in the engine.
|
|
5993
|
+
* @param opts.keyByContent Also key the file by its content, so that what consumes it is cached across any two recipes that produce the same file. This hashes the file unless it already has a content key.
|
|
5944
5994
|
*/
|
|
5945
|
-
sync: () => Promise<File>;
|
|
5995
|
+
sync: (opts?: FileSyncOpts) => Promise<File>;
|
|
5946
5996
|
/**
|
|
5947
5997
|
* Retrieves this file with its name set to the given name.
|
|
5948
5998
|
* @param name Name to set file to.
|
|
@@ -6237,11 +6287,11 @@ export declare class GeneratedCode extends BaseClient {
|
|
|
6237
6287
|
/**
|
|
6238
6288
|
* Set the list of paths to mark generated in version control.
|
|
6239
6289
|
*/
|
|
6240
|
-
|
|
6290
|
+
withVcsGeneratedPaths: (paths: string[]) => GeneratedCode;
|
|
6241
6291
|
/**
|
|
6242
6292
|
* Set the list of paths to ignore in version control.
|
|
6243
6293
|
*/
|
|
6244
|
-
|
|
6294
|
+
withVcsIgnoredPaths: (paths: string[]) => GeneratedCode;
|
|
6245
6295
|
/**
|
|
6246
6296
|
* Call the provided function with current GeneratedCode.
|
|
6247
6297
|
*
|
|
@@ -6307,7 +6357,7 @@ export declare class GitBundle extends BaseClient {
|
|
|
6307
6357
|
/**
|
|
6308
6358
|
* Commits that must already exist wherever this bundle is applied.
|
|
6309
6359
|
*/
|
|
6310
|
-
|
|
6360
|
+
prerequisiteShas: () => Promise<string[]>;
|
|
6311
6361
|
/**
|
|
6312
6362
|
* Refs advertised by the bundle and the object IDs they resolve to.
|
|
6313
6363
|
*/
|
|
@@ -6367,11 +6417,11 @@ export declare class GitCommit extends BaseClient {
|
|
|
6367
6417
|
private readonly _messageHeadline?;
|
|
6368
6418
|
private readonly _sha?;
|
|
6369
6419
|
private readonly _shortSha?;
|
|
6370
|
-
private readonly
|
|
6420
|
+
private readonly _treeSha?;
|
|
6371
6421
|
/**
|
|
6372
6422
|
* Constructor is used for internal usage only, do not create object from it.
|
|
6373
6423
|
*/
|
|
6374
|
-
constructor(ctx?: Context, _id?: ID, _authorEmail?: string, _authorName?: string, _authoredDate?: string, _committedDate?: string, _committerEmail?: string, _committerName?: string, _message?: string, _messageBody?: string, _messageHeadline?: string, _sha?: string, _shortSha?: string,
|
|
6424
|
+
constructor(ctx?: Context, _id?: ID, _authorEmail?: string, _authorName?: string, _authoredDate?: string, _committedDate?: string, _committerEmail?: string, _committerName?: string, _message?: string, _messageBody?: string, _messageHeadline?: string, _sha?: string, _shortSha?: string, _treeSha?: string);
|
|
6375
6425
|
/**
|
|
6376
6426
|
* A unique identifier for this GitCommit.
|
|
6377
6427
|
*/
|
|
@@ -6453,7 +6503,7 @@ export declare class GitCommit extends BaseClient {
|
|
|
6453
6503
|
*
|
|
6454
6504
|
* Commits with identical trees have identical contents and file modes.
|
|
6455
6505
|
*/
|
|
6456
|
-
|
|
6506
|
+
treeSha: () => Promise<string>;
|
|
6457
6507
|
}
|
|
6458
6508
|
/**
|
|
6459
6509
|
* A receipt for a completed Git push. Reading or replaying the receipt does not push again.
|
|
@@ -6461,13 +6511,13 @@ export declare class GitCommit extends BaseClient {
|
|
|
6461
6511
|
export declare class GitPushResult extends BaseClient {
|
|
6462
6512
|
private readonly _id?;
|
|
6463
6513
|
private readonly _disposition?;
|
|
6464
|
-
private readonly
|
|
6514
|
+
private readonly _previousSha?;
|
|
6465
6515
|
private readonly _ref?;
|
|
6466
6516
|
private readonly _sha?;
|
|
6467
6517
|
/**
|
|
6468
6518
|
* Constructor is used for internal usage only, do not create object from it.
|
|
6469
6519
|
*/
|
|
6470
|
-
constructor(ctx?: Context, _id?: ID, _disposition?: GitPushDisposition,
|
|
6520
|
+
constructor(ctx?: Context, _id?: ID, _disposition?: GitPushDisposition, _previousSha?: string, _ref?: string, _sha?: string);
|
|
6471
6521
|
/**
|
|
6472
6522
|
* A unique identifier for this GitPushResult.
|
|
6473
6523
|
*/
|
|
@@ -6479,7 +6529,7 @@ export declare class GitPushResult extends BaseClient {
|
|
|
6479
6529
|
/**
|
|
6480
6530
|
* The previous remote object ID; empty when the ref was created.
|
|
6481
6531
|
*/
|
|
6482
|
-
|
|
6532
|
+
previousSha: () => Promise<string>;
|
|
6483
6533
|
/**
|
|
6484
6534
|
* The fully qualified remote ref.
|
|
6485
6535
|
*/
|
|
@@ -6495,14 +6545,14 @@ export declare class GitPushResult extends BaseClient {
|
|
|
6495
6545
|
export declare class GitRef extends BaseClient {
|
|
6496
6546
|
private readonly _id?;
|
|
6497
6547
|
private readonly _commit?;
|
|
6498
|
-
private readonly
|
|
6548
|
+
private readonly _commitSha?;
|
|
6499
6549
|
private readonly _contains?;
|
|
6500
6550
|
private readonly _name?;
|
|
6501
6551
|
private readonly _ref?;
|
|
6502
6552
|
/**
|
|
6503
6553
|
* Constructor is used for internal usage only, do not create object from it.
|
|
6504
6554
|
*/
|
|
6505
|
-
constructor(ctx?: Context, _id?: ID, _commit?: string,
|
|
6555
|
+
constructor(ctx?: Context, _id?: ID, _commit?: string, _commitSha?: string, _contains?: boolean, _name?: string, _ref?: string);
|
|
6506
6556
|
/**
|
|
6507
6557
|
* A unique identifier for this GitRef.
|
|
6508
6558
|
*/
|
|
@@ -6520,13 +6570,13 @@ export declare class GitRef extends BaseClient {
|
|
|
6520
6570
|
asWorkspace: (opts?: GitRefAsWorkspaceOpts) => Workspace;
|
|
6521
6571
|
/**
|
|
6522
6572
|
* The resolved commit id at this ref.
|
|
6523
|
-
* @deprecated Use "
|
|
6573
|
+
* @deprecated Use "commitSha" instead.
|
|
6524
6574
|
*/
|
|
6525
6575
|
commit: () => Promise<string>;
|
|
6526
6576
|
/**
|
|
6527
6577
|
* The resolved commit SHA at this ref.
|
|
6528
6578
|
*/
|
|
6529
|
-
|
|
6579
|
+
commitSha: () => Promise<string>;
|
|
6530
6580
|
/**
|
|
6531
6581
|
* Find the best common ancestor between this ref and another ref.
|
|
6532
6582
|
* @param other The other ref to compare against.
|
|
@@ -6559,7 +6609,7 @@ export declare class GitRef extends BaseClient {
|
|
|
6559
6609
|
* @param opts.to Destination remote repository. Defaults to the origin remote's push routing, or the source's repository URL when none is registered. Required when the source has no remote URL.
|
|
6560
6610
|
* @param opts.remote Name of a registered remote to push to (see GitRepository.withRemote). Defaults to origin. The remote's push URLs, or its URL, become the destination; more than one push URL requires an explicit to instead.
|
|
6561
6611
|
* @param opts.branch Destination branch; a refs/ prefix is used verbatim. Defaults to this ref's branch name. Required for detached and non-branch refs.
|
|
6562
|
-
* @param opts.
|
|
6612
|
+
* @param opts.expectedRemoteSha Optional lease: a full lowercase object ID allows replacement only if the remote ref still has that value. Checked even for up-to-date pushes. Empty or omitted uses normal non-force rules, creating the ref if it does not exist.
|
|
6563
6613
|
*/
|
|
6564
6614
|
push: (opts?: GitRefPushOpts) => GitPushResult;
|
|
6565
6615
|
/**
|
|
@@ -6670,7 +6720,7 @@ export declare class GitRepository extends BaseClient {
|
|
|
6670
6720
|
* Returns details of a commit.
|
|
6671
6721
|
* @param id Identifier of the commit (e.g., "b6315d8f2810962c601af73f86831f6866ea798b").
|
|
6672
6722
|
*
|
|
6673
|
-
* May be abbreviated to an unambiguous hex prefix (4-40 characters), which is expanded
|
|
6723
|
+
* May be abbreviated to an unambiguous hex prefix (4-40 characters), which is expanded to the full SHA. A remote repository that has not fetched the commit yet fetches the history of the refs it advertises to find it.
|
|
6674
6724
|
*/
|
|
6675
6725
|
commit: (id: string) => GitCommit;
|
|
6676
6726
|
/**
|
|
@@ -6696,7 +6746,7 @@ export declare class GitRepository extends BaseClient {
|
|
|
6696
6746
|
* Returns details of a ref.
|
|
6697
6747
|
* @param name Ref's name (can be a commit identifier, a tag name, a branch name, or a fully-qualified ref).
|
|
6698
6748
|
*
|
|
6699
|
-
* Commit identifiers may be abbreviated: an unambiguous hex prefix (4-40 characters) of a commit SHA resolves like git rev-parse, with named refs taking precedence
|
|
6749
|
+
* Commit identifiers may be abbreviated: an unambiguous hex prefix (4-40 characters) of a commit SHA resolves like git rev-parse, with named refs taking precedence, to the full SHA. A remote repository that has not fetched the commit yet fetches the history of the refs it advertises to find it, so only commits reachable from those refs can be abbreviated.
|
|
6700
6750
|
*
|
|
6701
6751
|
* The name may be followed by git revision suffixes, applied left to right: `~N` follows first parents N times and `^N` selects the Nth parent (`~` and `^` mean 1, `^0` is the commit itself), e.g. `HEAD~3`, `main^2` or `abc1234~2`. The result is a detached ref of the resulting commit; remote repositories fetch the history the walk needs. Other git revision syntax (`^{...}`, `@{...}`, `:path`, ranges) is not supported.
|
|
6702
6752
|
*
|
|
@@ -7265,7 +7315,7 @@ export declare class LLM extends BaseClient {
|
|
|
7265
7315
|
* @param name The name of the MCP server
|
|
7266
7316
|
* @param service The MCP service to run and communicate with over stdio
|
|
7267
7317
|
*/
|
|
7268
|
-
|
|
7318
|
+
withMcpServer: (name: string, service: Service) => LLM;
|
|
7269
7319
|
/**
|
|
7270
7320
|
* Change the model for the rest of the conversation. The message history is preserved; the new model takes effect on the next step.
|
|
7271
7321
|
* @param model The model to use, e.g. "claude-sonnet-4-5" or "gpt-5.4".
|
|
@@ -7688,7 +7738,7 @@ export declare class Module_ extends BaseClient {
|
|
|
7688
7738
|
*
|
|
7689
7739
|
* Note: this is in the context of a module, so some core types may be hidden.
|
|
7690
7740
|
*/
|
|
7691
|
-
|
|
7741
|
+
introspectionSchemaJson: () => File;
|
|
7692
7742
|
/**
|
|
7693
7743
|
* The name of the module
|
|
7694
7744
|
*/
|
|
@@ -7774,6 +7824,74 @@ export declare class ModuleConfigClient extends BaseClient {
|
|
|
7774
7824
|
*/
|
|
7775
7825
|
generator: () => Promise<string>;
|
|
7776
7826
|
}
|
|
7827
|
+
/**
|
|
7828
|
+
* The names the engine gives a module's own declarations, by the naming rules of the version the module is named by.
|
|
7829
|
+
*
|
|
7830
|
+
* Every list-taking field answers in input order.
|
|
7831
|
+
*/
|
|
7832
|
+
export declare class ModuleNaming extends BaseClient {
|
|
7833
|
+
private readonly _id?;
|
|
7834
|
+
private readonly _mainObject?;
|
|
7835
|
+
private readonly _name?;
|
|
7836
|
+
private readonly _originalName?;
|
|
7837
|
+
private readonly _version?;
|
|
7838
|
+
/**
|
|
7839
|
+
* Constructor is used for internal usage only, do not create object from it.
|
|
7840
|
+
*/
|
|
7841
|
+
constructor(ctx?: Context, _id?: ID, _mainObject?: string, _name?: string, _originalName?: string, _version?: string);
|
|
7842
|
+
/**
|
|
7843
|
+
* A unique identifier for this ModuleNaming.
|
|
7844
|
+
*/
|
|
7845
|
+
id: () => Promise<ID>;
|
|
7846
|
+
/**
|
|
7847
|
+
* The schema names of enum members this module declares, in input order: SCREAMING_SNAKE_CASE.
|
|
7848
|
+
*
|
|
7849
|
+
* A name already written in GraphQL's enum member convention (HTTP2, P_256) is kept as it is. With the engine's identifier naming rules, Arm64 is ARM64 and GitHub is GITHUB; with the legacy strcase rules, Arm64 is ARM_64.
|
|
7850
|
+
*
|
|
7851
|
+
* Errors on a name the module's naming rules can't parse (non-ASCII, no letters or digits, or over 256 bytes). The legacy rules name anything.
|
|
7852
|
+
* @param names The enum member names as the module's source declares them.
|
|
7853
|
+
*/
|
|
7854
|
+
enumMemberNames: (names: string[]) => Promise<string[]>;
|
|
7855
|
+
/**
|
|
7856
|
+
* The schema names of functions, object fields and function arguments this module declares, including interface functions and their arguments, in input order.
|
|
7857
|
+
*
|
|
7858
|
+
* With the engine's identifier naming rules, acronyms are written like words: getURL is getUrl, baseURL is baseUrl, HTTPClient is httpClient. With the legacy strcase rules, HTTPClient is httpclient and e2eTest is e2ETest.
|
|
7859
|
+
*
|
|
7860
|
+
* Errors on a name the module's naming rules can't parse (non-ASCII, no letters or digits, or over 256 bytes). The legacy rules name anything.
|
|
7861
|
+
* @param names The function, field and argument names as the module's source declares them.
|
|
7862
|
+
*/
|
|
7863
|
+
fieldNames: (names: string[]) => Promise<string[]>;
|
|
7864
|
+
/**
|
|
7865
|
+
* Which of the candidates, the names of objects this module declares, the engine takes as the module's main object; null if none.
|
|
7866
|
+
*
|
|
7867
|
+
* The engine finds the main object by the module's name, in any casing: the first candidate, in input order, whose name normalizes to the same type name as the module's, or is spelled as that type name already (K8STools for module k8s-tools, by either rules: strcase spells k8s-tools K8STools, though it would normalize K8STools again to K8Stools). Failing that, with the engine's identifier naming rules only, the only candidate spelled the same once lowercased without word boundaries (Sha256Sum for module sha256sum); several such candidates are ambiguous, and give null.
|
|
7868
|
+
*
|
|
7869
|
+
* Errors on a name the module's naming rules can't parse (non-ASCII, no letters or digits, or over 256 bytes). The legacy rules name anything.
|
|
7870
|
+
* @param candidates The object names as the module's source declares them.
|
|
7871
|
+
*/
|
|
7872
|
+
mainObject: (candidates: string[]) => Promise<string>;
|
|
7873
|
+
/**
|
|
7874
|
+
* The module's name, which namespaces its types.
|
|
7875
|
+
*/
|
|
7876
|
+
name: () => Promise<string>;
|
|
7877
|
+
/**
|
|
7878
|
+
* The module's original name, which its main object and namespaced type names are spelled after. It differs from name when the module is loaded under another name, as a dependency alias.
|
|
7879
|
+
*/
|
|
7880
|
+
originalName: () => Promise<string>;
|
|
7881
|
+
/**
|
|
7882
|
+
* The schema names of objects, interfaces and enums this module declares, as the engine installs them: namespaced under the module's name, in input order.
|
|
7883
|
+
*
|
|
7884
|
+
* A name is prefixed with the module's name unless it already starts with the module's name on a word boundary. With the engine's identifier naming rules: HttpClient in module my-mod is MyModHTTPClient; Postman in module post is PostPostman, while PostMan stays PostMan; K8STools in module k8s-tools is K8sTools, the module's own name. With the legacy strcase rules, HttpClient in module my-mod is MyModHttpClient.
|
|
7885
|
+
*
|
|
7886
|
+
* Errors on a name the module's naming rules can't parse (non-ASCII, no letters or digits, or over 256 bytes). The legacy rules name anything.
|
|
7887
|
+
* @param names The type names as the module's source declares them.
|
|
7888
|
+
*/
|
|
7889
|
+
typeNames: (names: string[]) => Promise<string[]>;
|
|
7890
|
+
/**
|
|
7891
|
+
* The normalized engine version whose naming rules name the module.
|
|
7892
|
+
*/
|
|
7893
|
+
version: () => Promise<string>;
|
|
7894
|
+
}
|
|
7777
7895
|
/**
|
|
7778
7896
|
* The source needed to load and run a module, along with any metadata about the source such as versions/urls/etc.
|
|
7779
7897
|
*/
|
|
@@ -7785,8 +7903,8 @@ export declare class ModuleSource extends BaseClient {
|
|
|
7785
7903
|
private readonly _configExists?;
|
|
7786
7904
|
private readonly _digest?;
|
|
7787
7905
|
private readonly _engineVersion?;
|
|
7788
|
-
private readonly
|
|
7789
|
-
private readonly
|
|
7906
|
+
private readonly _htmlRepoUrl?;
|
|
7907
|
+
private readonly _htmlUrl?;
|
|
7790
7908
|
private readonly _kind?;
|
|
7791
7909
|
private readonly _localContextDirectoryPath?;
|
|
7792
7910
|
private readonly _moduleName?;
|
|
@@ -7801,7 +7919,7 @@ export declare class ModuleSource extends BaseClient {
|
|
|
7801
7919
|
/**
|
|
7802
7920
|
* Constructor is used for internal usage only, do not create object from it.
|
|
7803
7921
|
*/
|
|
7804
|
-
constructor(ctx?: Context, _id?: ID, _asString?: string, _cloneRef?: string, _commit?: string, _configExists?: boolean, _digest?: string, _engineVersion?: string,
|
|
7922
|
+
constructor(ctx?: Context, _id?: ID, _asString?: string, _cloneRef?: string, _commit?: string, _configExists?: boolean, _digest?: string, _engineVersion?: string, _htmlRepoUrl?: string, _htmlUrl?: string, _kind?: ModuleSourceKind, _localContextDirectoryPath?: string, _moduleName?: string, _moduleOriginalName?: string, _originalSubpath?: string, _pin?: string, _repoRootPath?: string, _sourceRootSubpath?: string, _sourceSubpath?: string, _sync?: ID, _version?: string);
|
|
7805
7923
|
/**
|
|
7806
7924
|
* A unique identifier for this ModuleSource.
|
|
7807
7925
|
*/
|
|
@@ -7822,9 +7940,14 @@ export declare class ModuleSource extends BaseClient {
|
|
|
7822
7940
|
/**
|
|
7823
7941
|
* The client-facing introspection schema JSON file for this module source.
|
|
7824
7942
|
*
|
|
7825
|
-
* This is the schema consumed by client codegen: unlike
|
|
7943
|
+
* This is the schema consumed by client codegen: unlike introspectionSchemaJson (the module-facing schema), it hides no core types and installs this module (reached via dag.<moduleName>) so a generated client can bind it. The module's dependencies are excluded: a client is generated for a single module plus core, not its dependency graph.
|
|
7944
|
+
* @param opts.clientVersion The engine version of the client the schema is generated for, e.g. the engineVersion of the module that depends on this one: core is described as that client sees it, capped at this engine's version.
|
|
7945
|
+
*
|
|
7946
|
+
* This module is still loaded at the engine version it declares, and so named by its own naming rules, as the engine serves it to such a client. Defaults to this module's own engine version.
|
|
7947
|
+
*
|
|
7948
|
+
* Use this rather than withEngineVersion, which makes this module declare another version and so changes its names.
|
|
7826
7949
|
*/
|
|
7827
|
-
|
|
7950
|
+
clientSchemaIntrospectionJson: (opts?: ModuleSourceClientSchemaIntrospectionJsonOpts) => File;
|
|
7828
7951
|
/**
|
|
7829
7952
|
* The ref to clone the root of the git repo from. Only valid for git sources.
|
|
7830
7953
|
*/
|
|
@@ -7880,11 +8003,11 @@ export declare class ModuleSource extends BaseClient {
|
|
|
7880
8003
|
/**
|
|
7881
8004
|
* The URL to access the web view of the repository (e.g., GitHub, GitLab, Bitbucket).
|
|
7882
8005
|
*/
|
|
7883
|
-
|
|
8006
|
+
htmlRepoUrl: () => Promise<string>;
|
|
7884
8007
|
/**
|
|
7885
8008
|
* The URL to the source's git repo in a web browser. Only valid for git sources.
|
|
7886
8009
|
*/
|
|
7887
|
-
|
|
8010
|
+
htmlUrl: () => Promise<string>;
|
|
7888
8011
|
/**
|
|
7889
8012
|
* The introspection schema JSON file for this module source.
|
|
7890
8013
|
*
|
|
@@ -7892,7 +8015,7 @@ export declare class ModuleSource extends BaseClient {
|
|
|
7892
8015
|
*
|
|
7893
8016
|
* Note: this is in the context of a module, so some core types may be hidden.
|
|
7894
8017
|
*/
|
|
7895
|
-
|
|
8018
|
+
introspectionSchemaJson: () => File;
|
|
7896
8019
|
/**
|
|
7897
8020
|
* The kind of module source (currently local, git or dir).
|
|
7898
8021
|
*/
|
|
@@ -7909,6 +8032,17 @@ export declare class ModuleSource extends BaseClient {
|
|
|
7909
8032
|
* The original name of the module as read from the module config file (or set for the first time with the withName API).
|
|
7910
8033
|
*/
|
|
7911
8034
|
moduleOriginalName: () => Promise<string>;
|
|
8035
|
+
/**
|
|
8036
|
+
* The names the engine gives this module's own declarations, by the naming rules of the version the module is named by: its engine version, capped at the engine's own.
|
|
8037
|
+
*
|
|
8038
|
+
* Modules declaring a version before the identifier casing cut get the legacy strcase names; later ones get the engine's identifier naming rules.
|
|
8039
|
+
*
|
|
8040
|
+
* For SDK codegen, which must reproduce these names before the module is loaded: this reads only the source's name, original name and engine version, so it answers before the module's entrypoint is generated.
|
|
8041
|
+
*
|
|
8042
|
+
* It answers for the module under its own name (moduleName). A workspace or toolchain that loads the module under another name namespaces its types under that name instead, which this doesn't reflect.
|
|
8043
|
+
* @experimental
|
|
8044
|
+
*/
|
|
8045
|
+
naming: () => ModuleNaming;
|
|
7912
8046
|
/**
|
|
7913
8047
|
* The original subpath used when instantiating this module source, relative to the context directory.
|
|
7914
8048
|
*/
|
|
@@ -7997,7 +8131,7 @@ export declare class ModuleSource extends BaseClient {
|
|
|
7997
8131
|
* Update the module source with a new SDK.
|
|
7998
8132
|
* @param source The SDK source to set.
|
|
7999
8133
|
*/
|
|
8000
|
-
|
|
8134
|
+
withSdk: (source: string) => ModuleSource;
|
|
8001
8135
|
/**
|
|
8002
8136
|
* Update the module source with a new source subpath.
|
|
8003
8137
|
* @param path The path to set as the source subpath. Must be relative to the module source's source root directory.
|
|
@@ -8063,6 +8197,49 @@ export declare class ModuleSource extends BaseClient {
|
|
|
8063
8197
|
*/
|
|
8064
8198
|
with: (arg: (param: ModuleSource) => ModuleSource) => ModuleSource;
|
|
8065
8199
|
}
|
|
8200
|
+
/**
|
|
8201
|
+
* The engine's identifier naming rules at an engine version.
|
|
8202
|
+
*/
|
|
8203
|
+
export declare class Naming extends BaseClient {
|
|
8204
|
+
private readonly _id?;
|
|
8205
|
+
private readonly _version?;
|
|
8206
|
+
/**
|
|
8207
|
+
* Constructor is used for internal usage only, do not create object from it.
|
|
8208
|
+
*/
|
|
8209
|
+
constructor(ctx?: Context, _id?: ID, _version?: string);
|
|
8210
|
+
/**
|
|
8211
|
+
* A unique identifier for this Naming.
|
|
8212
|
+
*/
|
|
8213
|
+
id: () => Promise<ID>;
|
|
8214
|
+
/**
|
|
8215
|
+
* The acronyms and terms used to parse and format identifiers.
|
|
8216
|
+
*/
|
|
8217
|
+
dictionary: () => Promise<NamingTerm[]>;
|
|
8218
|
+
/**
|
|
8219
|
+
* Format many names at once, for codegen. Returns them in input order.
|
|
8220
|
+
* @param names The names to format, in any casing.
|
|
8221
|
+
* @param casing The casing to format the names in.
|
|
8222
|
+
* @param opts.acronyms How to write acronyms and terms where a word starts with a capital.
|
|
8223
|
+
*/
|
|
8224
|
+
formatIdentifiers: (names: string[], casing: Casing, opts?: NamingFormatIdentifiersOpts) => Promise<string[]>;
|
|
8225
|
+
/**
|
|
8226
|
+
* Parse a name in any casing into words.
|
|
8227
|
+
*
|
|
8228
|
+
* Known acronyms and terms come from the naming dictionary; everything else falls back to the case heuristic. Errors on non-ASCII input, input with no letters or digits, or input over 256 bytes.
|
|
8229
|
+
* @param name The name to parse.
|
|
8230
|
+
*/
|
|
8231
|
+
identifier: (name: string) => Identifier;
|
|
8232
|
+
/**
|
|
8233
|
+
* The names the engine gives the declarations of a module named by these rules.
|
|
8234
|
+
* @param name The module's name, which namespaces its types.
|
|
8235
|
+
* @param opts.originalName The module's original name, when it's loaded under another (as a dependency alias): its main object and namespaced type names are spelled after it. Defaults to name.
|
|
8236
|
+
*/
|
|
8237
|
+
module_: (name: string, opts?: NamingModuleOpts) => ModuleNaming;
|
|
8238
|
+
/**
|
|
8239
|
+
* The normalized engine version these rules answer for.
|
|
8240
|
+
*/
|
|
8241
|
+
version: () => Promise<string>;
|
|
8242
|
+
}
|
|
8066
8243
|
/**
|
|
8067
8244
|
* An entry in the naming dictionary.
|
|
8068
8245
|
*/
|
|
@@ -8311,15 +8488,6 @@ export declare class Client extends BaseClient {
|
|
|
8311
8488
|
* @param opts.permissions Permissions of the new file. Example: 0600
|
|
8312
8489
|
*/
|
|
8313
8490
|
file: (name: string, contents: string, opts?: ClientFileOpts) => File;
|
|
8314
|
-
/**
|
|
8315
|
-
* Format many names at once, for codegen. Returns them in input order.
|
|
8316
|
-
* @param names The names to format, in any casing.
|
|
8317
|
-
* @param casing The casing to format the names in.
|
|
8318
|
-
* @param opts.acronyms How to write acronyms and terms where a word starts with a capital.
|
|
8319
|
-
* @param opts.version The engine version whose naming dictionary to parse the names with, e.g. the __schemaVersion of a schema being generated. Defaults to the caller's engine version.
|
|
8320
|
-
* @experimental
|
|
8321
|
-
*/
|
|
8322
|
-
formatIdentifiers: (names: string[], casing: Casing, opts?: ClientFormatIdentifiersOpts) => Promise<string[]>;
|
|
8323
8491
|
/**
|
|
8324
8492
|
* Creates a function.
|
|
8325
8493
|
* @param name Name of the function, in its original format from the implementation language.
|
|
@@ -8360,14 +8528,6 @@ export declare class Client extends BaseClient {
|
|
|
8360
8528
|
* @param opts.experimentalServiceHost A service which must be started before the URL is fetched.
|
|
8361
8529
|
*/
|
|
8362
8530
|
http: (url: string, opts?: ClientHttpOpts) => File;
|
|
8363
|
-
/**
|
|
8364
|
-
* Parse a name in any casing into words.
|
|
8365
|
-
*
|
|
8366
|
-
* Known acronyms and terms come from the naming dictionary; everything else falls back to the case heuristic. Errors on non-ASCII input, input with no letters or digits, or input over 256 bytes.
|
|
8367
|
-
* @param name The name to parse.
|
|
8368
|
-
* @experimental
|
|
8369
|
-
*/
|
|
8370
|
-
identifier: (name: string) => Identifier;
|
|
8371
8531
|
/**
|
|
8372
8532
|
* Initialize a JSON value
|
|
8373
8533
|
*/
|
|
@@ -8401,10 +8561,11 @@ export declare class Client extends BaseClient {
|
|
|
8401
8561
|
*/
|
|
8402
8562
|
moduleSource: (refString: string, opts?: ClientModuleSourceOpts) => ModuleSource;
|
|
8403
8563
|
/**
|
|
8404
|
-
* The
|
|
8564
|
+
* The engine's identifier naming rules at an engine version.
|
|
8565
|
+
* @param opts.version The engine version to answer for, e.g. the engine version a module declares. Defaults to the caller's. Normalized as a module's is: a version past the engine's is capped at the engine's own.
|
|
8405
8566
|
* @experimental
|
|
8406
8567
|
*/
|
|
8407
|
-
|
|
8568
|
+
naming: (opts?: ClientNamingOpts) => Naming;
|
|
8408
8569
|
/**
|
|
8409
8570
|
* Load any object by its ID.
|
|
8410
8571
|
*/
|
|
@@ -9406,17 +9567,17 @@ export declare class Workspace extends BaseClient {
|
|
|
9406
9567
|
*/
|
|
9407
9568
|
withModule: (ref: string, opts?: WorkspaceWithModuleOpts) => Workspace;
|
|
9408
9569
|
/**
|
|
9409
|
-
* Return this workspace with a directory mounted
|
|
9570
|
+
* Return this workspace with a directory mounted at the given path, without mutating the source.
|
|
9410
9571
|
*
|
|
9411
|
-
* Mounted content is readable through the normal workspace file tools but shadows the source at the mount path and stays out of the pending changeset: it
|
|
9572
|
+
* Mounted content is readable and editable through the normal workspace file tools but shadows the source at the mount path and stays out of the pending changeset: neither it nor edits to it appear in changes or are exported. Use withoutMount to remove the mount.
|
|
9412
9573
|
* @param path Location of the mounted directory. Relative paths resolve from the workspace cwd.
|
|
9413
9574
|
* @param source Directory to mount.
|
|
9414
9575
|
*/
|
|
9415
9576
|
withMountedDirectory: (path: string, source: Directory) => Workspace;
|
|
9416
9577
|
/**
|
|
9417
|
-
* Return this workspace with a file mounted
|
|
9578
|
+
* Return this workspace with a file mounted at the given path, without mutating the source.
|
|
9418
9579
|
*
|
|
9419
|
-
* Mounted content is readable through the normal workspace file tools but shadows the source at the mount path and stays out of the pending changeset: it
|
|
9580
|
+
* Mounted content is readable and editable through the normal workspace file tools but shadows the source at the mount path and stays out of the pending changeset: neither it nor edits to it appear in changes or are exported. Use withoutMount to remove the mount.
|
|
9420
9581
|
* @param path Location of the mounted file. Relative paths resolve from the workspace cwd.
|
|
9421
9582
|
* @param source File to mount.
|
|
9422
9583
|
*/
|
|
@@ -9439,7 +9600,7 @@ export declare class Workspace extends BaseClient {
|
|
|
9439
9600
|
/**
|
|
9440
9601
|
* Return this workspace with the given Git-compatible patch file applied, without mutating the source.
|
|
9441
9602
|
*
|
|
9442
|
-
* Paths in the patch are relative to the workspace root, whatever its cwd, as `git diff` writes them.
|
|
9603
|
+
* Paths in the patch are relative to the workspace root, whatever its cwd, as `git diff` writes them. Sections for paths in a mount apply to the mounted content; a section cannot move a file across a mount boundary or delete a mount point.
|
|
9443
9604
|
* @param patch File containing the patch to apply
|
|
9444
9605
|
* @param opts.onConflict How to handle hunks that no longer apply to the target content: fail (default), or apply what fits and leave git-style conflict markers where it doesn't.
|
|
9445
9606
|
* @experimental
|
|
@@ -9464,7 +9625,7 @@ export declare class Workspace extends BaseClient {
|
|
|
9464
9625
|
* @param opts.here Write to the workspace config directory at the workspace cwd.
|
|
9465
9626
|
* @param opts.asSdkName Optional override for the SDK name conventionally derived from the installed module name.
|
|
9466
9627
|
*/
|
|
9467
|
-
|
|
9628
|
+
withSdk: (ref: string, opts?: WorkspaceWithSdkOpts) => Workspace;
|
|
9468
9629
|
/**
|
|
9469
9630
|
* Return this workspace with the selected module clients updated.
|
|
9470
9631
|
*
|
|
@@ -9575,7 +9736,7 @@ export declare class Workspace extends BaseClient {
|
|
|
9575
9736
|
* @param name Name of the installed SDK entry to remove.
|
|
9576
9737
|
* @param opts.here Write to the workspace config directory at the workspace cwd.
|
|
9577
9738
|
*/
|
|
9578
|
-
|
|
9739
|
+
withoutSdk: (name: string, opts?: WorkspaceWithoutSdkOpts) => Workspace;
|
|
9579
9740
|
/**
|
|
9580
9741
|
* Call the provided function with current Workspace.
|
|
9581
9742
|
*
|
|
@@ -9835,6 +9996,18 @@ export declare class WorkspaceSDK extends BaseClient {
|
|
|
9835
9996
|
* The module reference this SDK was installed from.
|
|
9836
9997
|
*/
|
|
9837
9998
|
ref: () => Promise<string>;
|
|
9999
|
+
/**
|
|
10000
|
+
* The value a setting records in this SDK's scope settings, as a native JSON value.
|
|
10001
|
+
*
|
|
10002
|
+
* Reads [sdks.<name>.scopes."<scope>".settings] from the workspace config, in the scope whose key resolves to path. The setting key is matched without regard to case.
|
|
10003
|
+
*
|
|
10004
|
+
* Null when no scope resolves to path, or the scope records no such setting. Fails when the config is invalid, path escapes the workspace root, key matches several recorded settings, or the value cannot be represented as JSON.
|
|
10005
|
+
*
|
|
10006
|
+
* Fails when this SDK is no longer installed in the workspace config, even if Workspace.sdk returned it earlier.
|
|
10007
|
+
* @param path Scope path, relative to the workspace cwd or absolute from the workspace root.
|
|
10008
|
+
* @param key Setting name, matched without regard to case.
|
|
10009
|
+
*/
|
|
10010
|
+
scopeSetting: (path: string, key: string) => Promise<JSONValue | null>;
|
|
9838
10011
|
}
|
|
9839
10012
|
export declare const dag: Client;
|
|
9840
10013
|
//# sourceMappingURL=client.gen.d.ts.map
|