@elaraai/e3-api-client 0.0.2-beta.1 → 0.0.2-beta.2
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/src/index.d.ts +1 -0
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +2 -0
- package/dist/src/index.js.map +1 -1
- package/dist/src/platform.d.ts +1484 -0
- package/dist/src/platform.d.ts.map +1 -0
- package/dist/src/platform.js +1224 -0
- package/dist/src/platform.js.map +1 -0
- package/package.json +6 -3
|
@@ -0,0 +1,1484 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) 2025 Elara AI Pty Ltd
|
|
3
|
+
* Licensed under BSL 1.1. See LICENSE for details.
|
|
4
|
+
*/
|
|
5
|
+
import { StringType, IntegerType, BlobType, NullType, ArrayType, StructType } from '@elaraai/east';
|
|
6
|
+
import type { PlatformFunction } from '@elaraai/east/internal';
|
|
7
|
+
/**
|
|
8
|
+
* Gets repository status information.
|
|
9
|
+
*
|
|
10
|
+
* Returns statistics about the e3 repository including object count, package count,
|
|
11
|
+
* and workspace count. Use this to monitor repository health and size.
|
|
12
|
+
*
|
|
13
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
14
|
+
* in East programs running on Node.js.
|
|
15
|
+
*
|
|
16
|
+
* @param url - Base URL of the e3 API server
|
|
17
|
+
* @returns Repository status including object, package, and workspace counts
|
|
18
|
+
*
|
|
19
|
+
* @throws {EastError} When request fails:
|
|
20
|
+
* - Network error
|
|
21
|
+
* - Server unavailable
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* const getStatus = East.function([StringType], RepositoryStatusType, ($, url) => {
|
|
26
|
+
* return Platform.repoStatus(url);
|
|
27
|
+
* });
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
export declare const platform_repo_status: import("@elaraai/east").AsyncPlatformDefinition<[StringType], StructType<{
|
|
31
|
+
path: StringType;
|
|
32
|
+
objectCount: IntegerType;
|
|
33
|
+
packageCount: IntegerType;
|
|
34
|
+
workspaceCount: IntegerType;
|
|
35
|
+
}>>;
|
|
36
|
+
/**
|
|
37
|
+
* Runs garbage collection on the repository.
|
|
38
|
+
*
|
|
39
|
+
* Removes unreferenced objects from the object store to free disk space.
|
|
40
|
+
* Use dryRun mode to preview what would be deleted without actually deleting.
|
|
41
|
+
*
|
|
42
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
43
|
+
* in East programs running on Node.js.
|
|
44
|
+
*
|
|
45
|
+
* @param url - Base URL of the e3 API server
|
|
46
|
+
* @param options - GC options (dryRun to preview, minAge for object age filter)
|
|
47
|
+
* @returns GC result with counts and freed bytes
|
|
48
|
+
*
|
|
49
|
+
* @throws {EastError} When request fails:
|
|
50
|
+
* - Network error
|
|
51
|
+
* - Server unavailable
|
|
52
|
+
*
|
|
53
|
+
* @example
|
|
54
|
+
* ```ts
|
|
55
|
+
* const runGc = East.function([StringType, GcRequestType], GcResultType, ($, url, options) => {
|
|
56
|
+
* return Platform.repoGc(url, options);
|
|
57
|
+
* });
|
|
58
|
+
* ```
|
|
59
|
+
*/
|
|
60
|
+
export declare const platform_repo_gc: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StructType<{
|
|
61
|
+
dryRun: import("@elaraai/east").BooleanType;
|
|
62
|
+
minAge: import("@elaraai/east").OptionType<IntegerType>;
|
|
63
|
+
}>], StructType<{
|
|
64
|
+
deletedObjects: IntegerType;
|
|
65
|
+
deletedPartials: IntegerType;
|
|
66
|
+
retainedObjects: IntegerType;
|
|
67
|
+
skippedYoung: IntegerType;
|
|
68
|
+
bytesFreed: IntegerType;
|
|
69
|
+
}>>;
|
|
70
|
+
/**
|
|
71
|
+
* Lists all packages in the repository.
|
|
72
|
+
*
|
|
73
|
+
* Returns an array of package summaries including name and version.
|
|
74
|
+
*
|
|
75
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
76
|
+
* in East programs running on Node.js.
|
|
77
|
+
*
|
|
78
|
+
* @param url - Base URL of the e3 API server
|
|
79
|
+
* @returns Array of package info (name, version)
|
|
80
|
+
*
|
|
81
|
+
* @throws {EastError} When request fails:
|
|
82
|
+
* - Network error
|
|
83
|
+
* - Server unavailable
|
|
84
|
+
*
|
|
85
|
+
* @example
|
|
86
|
+
* ```ts
|
|
87
|
+
* const listPackages = East.function([StringType], ArrayType(PackageListItemType), ($, url) => {
|
|
88
|
+
* return Platform.packageList(url);
|
|
89
|
+
* });
|
|
90
|
+
* ```
|
|
91
|
+
*/
|
|
92
|
+
export declare const platform_package_list: import("@elaraai/east").AsyncPlatformDefinition<[StringType], ArrayType<StructType<{
|
|
93
|
+
name: StringType;
|
|
94
|
+
version: StringType;
|
|
95
|
+
}>>>;
|
|
96
|
+
/**
|
|
97
|
+
* Gets a package object by name and version.
|
|
98
|
+
*
|
|
99
|
+
* Returns the complete package object including tasks, data structure, and metadata.
|
|
100
|
+
*
|
|
101
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
102
|
+
* in East programs running on Node.js.
|
|
103
|
+
*
|
|
104
|
+
* @param url - Base URL of the e3 API server
|
|
105
|
+
* @param name - Package name
|
|
106
|
+
* @param version - Package version
|
|
107
|
+
* @returns Package object
|
|
108
|
+
*
|
|
109
|
+
* @throws {EastError} When request fails:
|
|
110
|
+
* - Package not found
|
|
111
|
+
* - Network error
|
|
112
|
+
*
|
|
113
|
+
* @example
|
|
114
|
+
* ```ts
|
|
115
|
+
* const getPackage = East.function([StringType, StringType, StringType], PackageObjectType, ($, url, name, version) => {
|
|
116
|
+
* return Platform.packageGet(url, name, version);
|
|
117
|
+
* });
|
|
118
|
+
* ```
|
|
119
|
+
*/
|
|
120
|
+
export declare const platform_package_get: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType], StructType<{
|
|
121
|
+
tasks: import("@elaraai/east").DictType<StringType, StringType>;
|
|
122
|
+
data: StructType<{
|
|
123
|
+
structure: import("@elaraai/east").RecursiveType<import("@elaraai/east").VariantType<{
|
|
124
|
+
value: import("@elaraai/east").RecursiveType<import("@elaraai/east").VariantType<{
|
|
125
|
+
Never: import("@elaraai/east").NullType;
|
|
126
|
+
Null: import("@elaraai/east").NullType;
|
|
127
|
+
Boolean: import("@elaraai/east").NullType;
|
|
128
|
+
Integer: import("@elaraai/east").NullType;
|
|
129
|
+
Float: import("@elaraai/east").NullType;
|
|
130
|
+
String: import("@elaraai/east").NullType;
|
|
131
|
+
DateTime: import("@elaraai/east").NullType;
|
|
132
|
+
Blob: import("@elaraai/east").NullType;
|
|
133
|
+
Ref: import("@elaraai/east").RecursiveTypeMarker;
|
|
134
|
+
Array: import("@elaraai/east").RecursiveTypeMarker;
|
|
135
|
+
Set: import("@elaraai/east").RecursiveTypeMarker;
|
|
136
|
+
Dict: StructType<{
|
|
137
|
+
key: import("@elaraai/east").RecursiveTypeMarker;
|
|
138
|
+
value: import("@elaraai/east").RecursiveTypeMarker;
|
|
139
|
+
}>;
|
|
140
|
+
Struct: import("@elaraai/east").ArrayType<StructType<{
|
|
141
|
+
name: StringType;
|
|
142
|
+
type: import("@elaraai/east").RecursiveTypeMarker;
|
|
143
|
+
}>>;
|
|
144
|
+
Variant: import("@elaraai/east").ArrayType<StructType<{
|
|
145
|
+
name: StringType;
|
|
146
|
+
type: import("@elaraai/east").RecursiveTypeMarker;
|
|
147
|
+
}>>;
|
|
148
|
+
Recursive: import("@elaraai/east").IntegerType;
|
|
149
|
+
Function: StructType<{
|
|
150
|
+
inputs: import("@elaraai/east").ArrayType<import("@elaraai/east").RecursiveTypeMarker>;
|
|
151
|
+
output: import("@elaraai/east").RecursiveTypeMarker;
|
|
152
|
+
}>;
|
|
153
|
+
AsyncFunction: StructType<{
|
|
154
|
+
inputs: import("@elaraai/east").ArrayType<import("@elaraai/east").RecursiveTypeMarker>;
|
|
155
|
+
output: import("@elaraai/east").RecursiveTypeMarker;
|
|
156
|
+
}>;
|
|
157
|
+
}>>;
|
|
158
|
+
struct: import("@elaraai/east").DictType<StringType, import("@elaraai/east").RecursiveTypeMarker>;
|
|
159
|
+
}>>;
|
|
160
|
+
value: StringType;
|
|
161
|
+
}>;
|
|
162
|
+
}>>;
|
|
163
|
+
/**
|
|
164
|
+
* Imports a package from a zip archive.
|
|
165
|
+
*
|
|
166
|
+
* Takes a zip archive containing a package and imports it into the repository.
|
|
167
|
+
*
|
|
168
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
169
|
+
* in East programs running on Node.js.
|
|
170
|
+
*
|
|
171
|
+
* @param url - Base URL of the e3 API server
|
|
172
|
+
* @param archive - Zip archive as bytes
|
|
173
|
+
* @returns Import result with package info and object count
|
|
174
|
+
*
|
|
175
|
+
* @throws {EastError} When request fails:
|
|
176
|
+
* - Invalid package format
|
|
177
|
+
* - Package already exists
|
|
178
|
+
* - Network error
|
|
179
|
+
*
|
|
180
|
+
* @example
|
|
181
|
+
* ```ts
|
|
182
|
+
* const importPackage = East.function([StringType, BlobType], PackageImportResultType, ($, url, archive) => {
|
|
183
|
+
* return Platform.packageImport(url, archive);
|
|
184
|
+
* });
|
|
185
|
+
* ```
|
|
186
|
+
*/
|
|
187
|
+
export declare const platform_package_import: import("@elaraai/east").AsyncPlatformDefinition<[StringType, BlobType], StructType<{
|
|
188
|
+
name: StringType;
|
|
189
|
+
version: StringType;
|
|
190
|
+
packageHash: StringType;
|
|
191
|
+
objectCount: IntegerType;
|
|
192
|
+
}>>;
|
|
193
|
+
/**
|
|
194
|
+
* Exports a package as a zip archive.
|
|
195
|
+
*
|
|
196
|
+
* Returns a zip archive containing the package that can be transferred or stored.
|
|
197
|
+
*
|
|
198
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
199
|
+
* in East programs running on Node.js.
|
|
200
|
+
*
|
|
201
|
+
* @param url - Base URL of the e3 API server
|
|
202
|
+
* @param name - Package name
|
|
203
|
+
* @param version - Package version
|
|
204
|
+
* @returns Zip archive as bytes
|
|
205
|
+
*
|
|
206
|
+
* @throws {EastError} When request fails:
|
|
207
|
+
* - Package not found
|
|
208
|
+
* - Network error
|
|
209
|
+
*
|
|
210
|
+
* @example
|
|
211
|
+
* ```ts
|
|
212
|
+
* const exportPackage = East.function([StringType, StringType, StringType], BlobType, ($, url, name, version) => {
|
|
213
|
+
* return Platform.packageExport(url, name, version);
|
|
214
|
+
* });
|
|
215
|
+
* ```
|
|
216
|
+
*/
|
|
217
|
+
export declare const platform_package_export: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType], BlobType>;
|
|
218
|
+
/**
|
|
219
|
+
* Removes a package from the repository.
|
|
220
|
+
*
|
|
221
|
+
* Deletes a package by name and version. Does not affect objects referenced by other packages.
|
|
222
|
+
*
|
|
223
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
224
|
+
* in East programs running on Node.js.
|
|
225
|
+
*
|
|
226
|
+
* @param url - Base URL of the e3 API server
|
|
227
|
+
* @param name - Package name
|
|
228
|
+
* @param version - Package version
|
|
229
|
+
* @returns null on success
|
|
230
|
+
*
|
|
231
|
+
* @throws {EastError} When request fails:
|
|
232
|
+
* - Package not found
|
|
233
|
+
* - Network error
|
|
234
|
+
*
|
|
235
|
+
* @example
|
|
236
|
+
* ```ts
|
|
237
|
+
* const removePackage = East.function([StringType, StringType, StringType], NullType, ($, url, name, version) => {
|
|
238
|
+
* return Platform.packageRemove(url, name, version);
|
|
239
|
+
* });
|
|
240
|
+
* ```
|
|
241
|
+
*/
|
|
242
|
+
export declare const platform_package_remove: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType], NullType>;
|
|
243
|
+
/**
|
|
244
|
+
* Lists all workspaces in the repository.
|
|
245
|
+
*
|
|
246
|
+
* Returns an array of workspace summaries including deployment status.
|
|
247
|
+
*
|
|
248
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
249
|
+
* in East programs running on Node.js.
|
|
250
|
+
*
|
|
251
|
+
* @param url - Base URL of the e3 API server
|
|
252
|
+
* @returns Array of workspace info
|
|
253
|
+
*
|
|
254
|
+
* @throws {EastError} When request fails:
|
|
255
|
+
* - Network error
|
|
256
|
+
* - Server unavailable
|
|
257
|
+
*
|
|
258
|
+
* @example
|
|
259
|
+
* ```ts
|
|
260
|
+
* const listWorkspaces = East.function([StringType], ArrayType(WorkspaceInfoType), ($, url) => {
|
|
261
|
+
* return Platform.workspaceList(url);
|
|
262
|
+
* });
|
|
263
|
+
* ```
|
|
264
|
+
*/
|
|
265
|
+
export declare const platform_workspace_list: import("@elaraai/east").AsyncPlatformDefinition<[StringType], ArrayType<StructType<{
|
|
266
|
+
name: StringType;
|
|
267
|
+
deployed: import("@elaraai/east").BooleanType;
|
|
268
|
+
packageName: import("@elaraai/east").OptionType<StringType>;
|
|
269
|
+
packageVersion: import("@elaraai/east").OptionType<StringType>;
|
|
270
|
+
}>>>;
|
|
271
|
+
/**
|
|
272
|
+
* Creates a new empty workspace.
|
|
273
|
+
*
|
|
274
|
+
* Creates a workspace with the given name that can be used to deploy packages.
|
|
275
|
+
*
|
|
276
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
277
|
+
* in East programs running on Node.js.
|
|
278
|
+
*
|
|
279
|
+
* @param url - Base URL of the e3 API server
|
|
280
|
+
* @param name - Workspace name
|
|
281
|
+
* @returns Created workspace info
|
|
282
|
+
*
|
|
283
|
+
* @throws {EastError} When request fails:
|
|
284
|
+
* - Workspace already exists
|
|
285
|
+
* - Network error
|
|
286
|
+
*
|
|
287
|
+
* @example
|
|
288
|
+
* ```ts
|
|
289
|
+
* const createWorkspace = East.function([StringType, StringType], WorkspaceInfoType, ($, url, name) => {
|
|
290
|
+
* return Platform.workspaceCreate(url, name);
|
|
291
|
+
* });
|
|
292
|
+
* ```
|
|
293
|
+
*/
|
|
294
|
+
export declare const platform_workspace_create: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType], StructType<{
|
|
295
|
+
name: StringType;
|
|
296
|
+
deployed: import("@elaraai/east").BooleanType;
|
|
297
|
+
packageName: import("@elaraai/east").OptionType<StringType>;
|
|
298
|
+
packageVersion: import("@elaraai/east").OptionType<StringType>;
|
|
299
|
+
}>>;
|
|
300
|
+
/**
|
|
301
|
+
* Gets workspace state including deployed package info.
|
|
302
|
+
*
|
|
303
|
+
* Returns the full workspace state including the deployed package and current root hash.
|
|
304
|
+
*
|
|
305
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
306
|
+
* in East programs running on Node.js.
|
|
307
|
+
*
|
|
308
|
+
* @param url - Base URL of the e3 API server
|
|
309
|
+
* @param name - Workspace name
|
|
310
|
+
* @returns Workspace state
|
|
311
|
+
*
|
|
312
|
+
* @throws {EastError} When request fails:
|
|
313
|
+
* - Workspace not found
|
|
314
|
+
* - Network error
|
|
315
|
+
*
|
|
316
|
+
* @example
|
|
317
|
+
* ```ts
|
|
318
|
+
* const getWorkspace = East.function([StringType, StringType], WorkspaceStateType, ($, url, name) => {
|
|
319
|
+
* return Platform.workspaceGet(url, name);
|
|
320
|
+
* });
|
|
321
|
+
* ```
|
|
322
|
+
*/
|
|
323
|
+
export declare const platform_workspace_get: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType], StructType<{
|
|
324
|
+
packageName: StringType;
|
|
325
|
+
packageVersion: StringType;
|
|
326
|
+
packageHash: StringType;
|
|
327
|
+
deployedAt: import("@elaraai/east").DateTimeType;
|
|
328
|
+
rootHash: StringType;
|
|
329
|
+
rootUpdatedAt: import("@elaraai/east").DateTimeType;
|
|
330
|
+
}>>;
|
|
331
|
+
/**
|
|
332
|
+
* Gets comprehensive workspace status.
|
|
333
|
+
*
|
|
334
|
+
* Returns detailed status including all datasets, tasks, lock info, and summary counts.
|
|
335
|
+
* Use this to monitor execution progress after calling dataflowStart.
|
|
336
|
+
*
|
|
337
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
338
|
+
* in East programs running on Node.js.
|
|
339
|
+
*
|
|
340
|
+
* @param url - Base URL of the e3 API server
|
|
341
|
+
* @param name - Workspace name
|
|
342
|
+
* @returns Workspace status with datasets, tasks, and summary
|
|
343
|
+
*
|
|
344
|
+
* @throws {EastError} When request fails:
|
|
345
|
+
* - Workspace not found
|
|
346
|
+
* - Network error
|
|
347
|
+
*
|
|
348
|
+
* @example
|
|
349
|
+
* ```ts
|
|
350
|
+
* const getStatus = East.function([StringType, StringType], WorkspaceStatusResultType, ($, url, name) => {
|
|
351
|
+
* return Platform.workspaceStatus(url, name);
|
|
352
|
+
* });
|
|
353
|
+
* ```
|
|
354
|
+
*/
|
|
355
|
+
export declare const platform_workspace_status: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType], StructType<{
|
|
356
|
+
workspace: StringType;
|
|
357
|
+
lock: import("@elaraai/east").OptionType<StructType<{
|
|
358
|
+
pid: IntegerType;
|
|
359
|
+
acquiredAt: StringType;
|
|
360
|
+
bootId: import("@elaraai/east").OptionType<StringType>;
|
|
361
|
+
command: import("@elaraai/east").OptionType<StringType>;
|
|
362
|
+
}>>;
|
|
363
|
+
datasets: ArrayType<StructType<{
|
|
364
|
+
path: StringType;
|
|
365
|
+
status: import("@elaraai/east").VariantType<{
|
|
366
|
+
unset: NullType;
|
|
367
|
+
stale: NullType;
|
|
368
|
+
'up-to-date': NullType;
|
|
369
|
+
}>;
|
|
370
|
+
hash: import("@elaraai/east").OptionType<StringType>;
|
|
371
|
+
isTaskOutput: import("@elaraai/east").BooleanType;
|
|
372
|
+
producedBy: import("@elaraai/east").OptionType<StringType>;
|
|
373
|
+
}>>;
|
|
374
|
+
tasks: ArrayType<StructType<{
|
|
375
|
+
name: StringType;
|
|
376
|
+
hash: StringType;
|
|
377
|
+
status: import("@elaraai/east").VariantType<{
|
|
378
|
+
'up-to-date': StructType<{
|
|
379
|
+
cached: import("@elaraai/east").BooleanType;
|
|
380
|
+
}>;
|
|
381
|
+
ready: NullType;
|
|
382
|
+
waiting: StructType<{
|
|
383
|
+
reason: StringType;
|
|
384
|
+
}>;
|
|
385
|
+
'in-progress': StructType<{
|
|
386
|
+
pid: import("@elaraai/east").OptionType<IntegerType>;
|
|
387
|
+
startedAt: import("@elaraai/east").OptionType<StringType>;
|
|
388
|
+
}>;
|
|
389
|
+
failed: StructType<{
|
|
390
|
+
exitCode: IntegerType;
|
|
391
|
+
completedAt: import("@elaraai/east").OptionType<StringType>;
|
|
392
|
+
}>;
|
|
393
|
+
error: StructType<{
|
|
394
|
+
message: StringType;
|
|
395
|
+
completedAt: import("@elaraai/east").OptionType<StringType>;
|
|
396
|
+
}>;
|
|
397
|
+
'stale-running': StructType<{
|
|
398
|
+
pid: import("@elaraai/east").OptionType<IntegerType>;
|
|
399
|
+
startedAt: import("@elaraai/east").OptionType<StringType>;
|
|
400
|
+
}>;
|
|
401
|
+
}>;
|
|
402
|
+
inputs: ArrayType<StringType>;
|
|
403
|
+
output: StringType;
|
|
404
|
+
dependsOn: ArrayType<StringType>;
|
|
405
|
+
}>>;
|
|
406
|
+
summary: StructType<{
|
|
407
|
+
datasets: StructType<{
|
|
408
|
+
total: IntegerType;
|
|
409
|
+
unset: IntegerType;
|
|
410
|
+
stale: IntegerType;
|
|
411
|
+
upToDate: IntegerType;
|
|
412
|
+
}>;
|
|
413
|
+
tasks: StructType<{
|
|
414
|
+
total: IntegerType;
|
|
415
|
+
upToDate: IntegerType;
|
|
416
|
+
ready: IntegerType;
|
|
417
|
+
waiting: IntegerType;
|
|
418
|
+
inProgress: IntegerType;
|
|
419
|
+
failed: IntegerType;
|
|
420
|
+
error: IntegerType;
|
|
421
|
+
staleRunning: IntegerType;
|
|
422
|
+
}>;
|
|
423
|
+
}>;
|
|
424
|
+
}>>;
|
|
425
|
+
/**
|
|
426
|
+
* Removes a workspace.
|
|
427
|
+
*
|
|
428
|
+
* Deletes a workspace and all its data. Cannot be undone.
|
|
429
|
+
*
|
|
430
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
431
|
+
* in East programs running on Node.js.
|
|
432
|
+
*
|
|
433
|
+
* @param url - Base URL of the e3 API server
|
|
434
|
+
* @param name - Workspace name
|
|
435
|
+
* @returns null on success
|
|
436
|
+
*
|
|
437
|
+
* @throws {EastError} When request fails:
|
|
438
|
+
* - Workspace not found
|
|
439
|
+
* - Network error
|
|
440
|
+
*
|
|
441
|
+
* @example
|
|
442
|
+
* ```ts
|
|
443
|
+
* const removeWorkspace = East.function([StringType, StringType], NullType, ($, url, name) => {
|
|
444
|
+
* return Platform.workspaceRemove(url, name);
|
|
445
|
+
* });
|
|
446
|
+
* ```
|
|
447
|
+
*/
|
|
448
|
+
export declare const platform_workspace_remove: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType], NullType>;
|
|
449
|
+
/**
|
|
450
|
+
* Deploys a package to a workspace.
|
|
451
|
+
*
|
|
452
|
+
* Sets up the workspace with the specified package's data structure and tasks.
|
|
453
|
+
*
|
|
454
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
455
|
+
* in East programs running on Node.js.
|
|
456
|
+
*
|
|
457
|
+
* @param url - Base URL of the e3 API server
|
|
458
|
+
* @param name - Workspace name
|
|
459
|
+
* @param packageRef - Package reference (name or name@version)
|
|
460
|
+
* @returns null on success
|
|
461
|
+
*
|
|
462
|
+
* @throws {EastError} When request fails:
|
|
463
|
+
* - Workspace not found
|
|
464
|
+
* - Package not found
|
|
465
|
+
* - Network error
|
|
466
|
+
*
|
|
467
|
+
* @example
|
|
468
|
+
* ```ts
|
|
469
|
+
* const deploy = East.function([StringType, StringType, StringType], NullType, ($, url, workspace, packageRef) => {
|
|
470
|
+
* return Platform.workspaceDeploy(url, workspace, packageRef);
|
|
471
|
+
* });
|
|
472
|
+
* ```
|
|
473
|
+
*/
|
|
474
|
+
export declare const platform_workspace_deploy: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType], NullType>;
|
|
475
|
+
/**
|
|
476
|
+
* Exports workspace as a package zip archive.
|
|
477
|
+
*
|
|
478
|
+
* Creates a zip archive of the workspace that can be imported elsewhere.
|
|
479
|
+
*
|
|
480
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
481
|
+
* in East programs running on Node.js.
|
|
482
|
+
*
|
|
483
|
+
* @param url - Base URL of the e3 API server
|
|
484
|
+
* @param name - Workspace name
|
|
485
|
+
* @returns Zip archive as bytes
|
|
486
|
+
*
|
|
487
|
+
* @throws {EastError} When request fails:
|
|
488
|
+
* - Workspace not found
|
|
489
|
+
* - Network error
|
|
490
|
+
*
|
|
491
|
+
* @example
|
|
492
|
+
* ```ts
|
|
493
|
+
* const exportWorkspace = East.function([StringType, StringType], BlobType, ($, url, name) => {
|
|
494
|
+
* return Platform.workspaceExport(url, name);
|
|
495
|
+
* });
|
|
496
|
+
* ```
|
|
497
|
+
*/
|
|
498
|
+
export declare const platform_workspace_export: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType], BlobType>;
|
|
499
|
+
/**
|
|
500
|
+
* Lists field names at root of workspace dataset tree.
|
|
501
|
+
*
|
|
502
|
+
* Returns the top-level field names in the workspace's data tree.
|
|
503
|
+
*
|
|
504
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
505
|
+
* in East programs running on Node.js.
|
|
506
|
+
*
|
|
507
|
+
* @param url - Base URL of the e3 API server
|
|
508
|
+
* @param workspace - Workspace name
|
|
509
|
+
* @returns Array of field names at root
|
|
510
|
+
*
|
|
511
|
+
* @throws {EastError} When request fails:
|
|
512
|
+
* - Workspace not found
|
|
513
|
+
* - Network error
|
|
514
|
+
*
|
|
515
|
+
* @example
|
|
516
|
+
* ```ts
|
|
517
|
+
* const listDatasets = East.function([StringType, StringType], ArrayType(StringType), ($, url, workspace) => {
|
|
518
|
+
* return Platform.datasetList(url, workspace);
|
|
519
|
+
* });
|
|
520
|
+
* ```
|
|
521
|
+
*/
|
|
522
|
+
export declare const platform_dataset_list: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType], ArrayType<StringType>>;
|
|
523
|
+
/**
|
|
524
|
+
* Lists field names at a path in workspace dataset tree.
|
|
525
|
+
*
|
|
526
|
+
* Returns field names at the specified path in the workspace's data tree.
|
|
527
|
+
*
|
|
528
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
529
|
+
* in East programs running on Node.js.
|
|
530
|
+
*
|
|
531
|
+
* @param url - Base URL of the e3 API server
|
|
532
|
+
* @param workspace - Workspace name
|
|
533
|
+
* @param path - Path to the dataset
|
|
534
|
+
* @returns Array of field names at path
|
|
535
|
+
*
|
|
536
|
+
* @throws {EastError} When request fails:
|
|
537
|
+
* - Workspace not found
|
|
538
|
+
* - Path not found
|
|
539
|
+
* - Network error
|
|
540
|
+
*
|
|
541
|
+
* @example
|
|
542
|
+
* ```ts
|
|
543
|
+
* const listAt = East.function([StringType, StringType, TreePathType], ArrayType(StringType), ($, url, workspace, path) => {
|
|
544
|
+
* return Platform.datasetListAt(url, workspace, path);
|
|
545
|
+
* });
|
|
546
|
+
* ```
|
|
547
|
+
*/
|
|
548
|
+
export declare const platform_dataset_list_at: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, ArrayType<import("@elaraai/east").VariantType<{
|
|
549
|
+
field: StringType;
|
|
550
|
+
}>>], ArrayType<StringType>>;
|
|
551
|
+
/**
|
|
552
|
+
* Gets a dataset value as raw BEAST2 bytes.
|
|
553
|
+
*
|
|
554
|
+
* Returns the raw BEAST2 encoded data for a dataset.
|
|
555
|
+
* Use decodeBeast2 or decodeBeast2For to decode with the appropriate type.
|
|
556
|
+
*
|
|
557
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
558
|
+
* in East programs running on Node.js.
|
|
559
|
+
*
|
|
560
|
+
* @param url - Base URL of the e3 API server
|
|
561
|
+
* @param workspace - Workspace name
|
|
562
|
+
* @param path - Path to the dataset
|
|
563
|
+
* @returns Raw BEAST2 bytes
|
|
564
|
+
*
|
|
565
|
+
* @throws {EastError} When request fails:
|
|
566
|
+
* - Workspace not found
|
|
567
|
+
* - Dataset not found
|
|
568
|
+
* - Network error
|
|
569
|
+
*
|
|
570
|
+
* @example
|
|
571
|
+
* ```ts
|
|
572
|
+
* const getData = East.function([StringType, StringType, TreePathType], BlobType, ($, url, workspace, path) => {
|
|
573
|
+
* return Platform.datasetGet(url, workspace, path);
|
|
574
|
+
* });
|
|
575
|
+
* ```
|
|
576
|
+
*/
|
|
577
|
+
export declare const platform_dataset_get: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, ArrayType<import("@elaraai/east").VariantType<{
|
|
578
|
+
field: StringType;
|
|
579
|
+
}>>], BlobType>;
|
|
580
|
+
/**
|
|
581
|
+
* Sets a dataset value from raw BEAST2 bytes.
|
|
582
|
+
*
|
|
583
|
+
* Stores the BEAST2 encoded data at the specified dataset path.
|
|
584
|
+
*
|
|
585
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
586
|
+
* in East programs running on Node.js.
|
|
587
|
+
*
|
|
588
|
+
* @param url - Base URL of the e3 API server
|
|
589
|
+
* @param workspace - Workspace name
|
|
590
|
+
* @param path - Path to the dataset
|
|
591
|
+
* @param data - Raw BEAST2 encoded value
|
|
592
|
+
* @returns null on success
|
|
593
|
+
*
|
|
594
|
+
* @throws {EastError} When request fails:
|
|
595
|
+
* - Workspace not found
|
|
596
|
+
* - Invalid path
|
|
597
|
+
* - Network error
|
|
598
|
+
*
|
|
599
|
+
* @example
|
|
600
|
+
* ```ts
|
|
601
|
+
* const setData = East.function([StringType, StringType, TreePathType, BlobType], NullType, ($, url, workspace, path, data) => {
|
|
602
|
+
* return Platform.datasetSet(url, workspace, path, data);
|
|
603
|
+
* });
|
|
604
|
+
* ```
|
|
605
|
+
*/
|
|
606
|
+
export declare const platform_dataset_set: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, ArrayType<import("@elaraai/east").VariantType<{
|
|
607
|
+
field: StringType;
|
|
608
|
+
}>>, BlobType], NullType>;
|
|
609
|
+
/**
|
|
610
|
+
* Lists tasks in a workspace.
|
|
611
|
+
*
|
|
612
|
+
* Returns an array of task summaries including name and hash.
|
|
613
|
+
*
|
|
614
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
615
|
+
* in East programs running on Node.js.
|
|
616
|
+
*
|
|
617
|
+
* @param url - Base URL of the e3 API server
|
|
618
|
+
* @param workspace - Workspace name
|
|
619
|
+
* @returns Array of task info (name, hash)
|
|
620
|
+
*
|
|
621
|
+
* @throws {EastError} When request fails:
|
|
622
|
+
* - Workspace not found
|
|
623
|
+
* - Workspace not deployed
|
|
624
|
+
* - Network error
|
|
625
|
+
*
|
|
626
|
+
* @example
|
|
627
|
+
* ```ts
|
|
628
|
+
* const listTasks = East.function([StringType, StringType], ArrayType(TaskListItemType), ($, url, workspace) => {
|
|
629
|
+
* return Platform.taskList(url, workspace);
|
|
630
|
+
* });
|
|
631
|
+
* ```
|
|
632
|
+
*/
|
|
633
|
+
export declare const platform_task_list: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType], ArrayType<StructType<{
|
|
634
|
+
name: StringType;
|
|
635
|
+
hash: StringType;
|
|
636
|
+
}>>>;
|
|
637
|
+
/**
|
|
638
|
+
* Gets task details including runner and typed inputs/outputs.
|
|
639
|
+
*
|
|
640
|
+
* Returns the complete task definition including command IR and input/output paths.
|
|
641
|
+
*
|
|
642
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
643
|
+
* in East programs running on Node.js.
|
|
644
|
+
*
|
|
645
|
+
* @param url - Base URL of the e3 API server
|
|
646
|
+
* @param workspace - Workspace name
|
|
647
|
+
* @param name - Task name
|
|
648
|
+
* @returns Task details
|
|
649
|
+
*
|
|
650
|
+
* @throws {EastError} When request fails:
|
|
651
|
+
* - Workspace not found
|
|
652
|
+
* - Task not found
|
|
653
|
+
* - Network error
|
|
654
|
+
*
|
|
655
|
+
* @example
|
|
656
|
+
* ```ts
|
|
657
|
+
* const getTask = East.function([StringType, StringType, StringType], TaskDetailsType, ($, url, workspace, name) => {
|
|
658
|
+
* return Platform.taskGet(url, workspace, name);
|
|
659
|
+
* });
|
|
660
|
+
* ```
|
|
661
|
+
*/
|
|
662
|
+
export declare const platform_task_get: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType], StructType<{
|
|
663
|
+
name: StringType;
|
|
664
|
+
hash: StringType;
|
|
665
|
+
commandIr: StringType;
|
|
666
|
+
inputs: ArrayType<ArrayType<import("@elaraai/east").VariantType<{
|
|
667
|
+
field: StringType;
|
|
668
|
+
}>>>;
|
|
669
|
+
output: ArrayType<import("@elaraai/east").VariantType<{
|
|
670
|
+
field: StringType;
|
|
671
|
+
}>>;
|
|
672
|
+
}>>;
|
|
673
|
+
/**
|
|
674
|
+
* Starts dataflow execution on a workspace (non-blocking).
|
|
675
|
+
*
|
|
676
|
+
* Returns immediately after spawning execution in background.
|
|
677
|
+
* Use workspaceStatus to poll for progress.
|
|
678
|
+
*
|
|
679
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
680
|
+
* in East programs running on Node.js.
|
|
681
|
+
*
|
|
682
|
+
* @param url - Base URL of the e3 API server
|
|
683
|
+
* @param workspace - Workspace name
|
|
684
|
+
* @param options - Execution options (concurrency, force, filter)
|
|
685
|
+
* @returns null on success
|
|
686
|
+
*
|
|
687
|
+
* @throws {EastError} When request fails:
|
|
688
|
+
* - Workspace not found
|
|
689
|
+
* - Workspace locked
|
|
690
|
+
* - Network error
|
|
691
|
+
*
|
|
692
|
+
* @example
|
|
693
|
+
* ```ts
|
|
694
|
+
* const start = East.function([StringType, StringType, DataflowRequestType], NullType, ($, url, workspace, options) => {
|
|
695
|
+
* return Platform.dataflowStart(url, workspace, options);
|
|
696
|
+
* });
|
|
697
|
+
* ```
|
|
698
|
+
*/
|
|
699
|
+
export declare const platform_dataflow_start: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StructType<{
|
|
700
|
+
concurrency: import("@elaraai/east").OptionType<IntegerType>;
|
|
701
|
+
force: import("@elaraai/east").BooleanType;
|
|
702
|
+
filter: import("@elaraai/east").OptionType<StringType>;
|
|
703
|
+
}>], NullType>;
|
|
704
|
+
/**
|
|
705
|
+
* Executes dataflow on a workspace (blocking).
|
|
706
|
+
*
|
|
707
|
+
* Waits for execution to complete and returns the result with per-task outcomes.
|
|
708
|
+
*
|
|
709
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
710
|
+
* in East programs running on Node.js.
|
|
711
|
+
*
|
|
712
|
+
* @param url - Base URL of the e3 API server
|
|
713
|
+
* @param workspace - Workspace name
|
|
714
|
+
* @param options - Execution options (concurrency, force, filter)
|
|
715
|
+
* @returns Dataflow execution result
|
|
716
|
+
*
|
|
717
|
+
* @throws {EastError} When request fails:
|
|
718
|
+
* - Workspace not found
|
|
719
|
+
* - Workspace locked
|
|
720
|
+
* - Network error
|
|
721
|
+
*
|
|
722
|
+
* @example
|
|
723
|
+
* ```ts
|
|
724
|
+
* const execute = East.function([StringType, StringType, DataflowRequestType], DataflowResultType, ($, url, workspace, options) => {
|
|
725
|
+
* return Platform.dataflowExecute(url, workspace, options);
|
|
726
|
+
* });
|
|
727
|
+
* ```
|
|
728
|
+
*/
|
|
729
|
+
export declare const platform_dataflow_execute: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StructType<{
|
|
730
|
+
concurrency: import("@elaraai/east").OptionType<IntegerType>;
|
|
731
|
+
force: import("@elaraai/east").BooleanType;
|
|
732
|
+
filter: import("@elaraai/east").OptionType<StringType>;
|
|
733
|
+
}>], StructType<{
|
|
734
|
+
success: import("@elaraai/east").BooleanType;
|
|
735
|
+
executed: IntegerType;
|
|
736
|
+
cached: IntegerType;
|
|
737
|
+
failed: IntegerType;
|
|
738
|
+
skipped: IntegerType;
|
|
739
|
+
tasks: ArrayType<StructType<{
|
|
740
|
+
name: StringType;
|
|
741
|
+
cached: import("@elaraai/east").BooleanType;
|
|
742
|
+
state: import("@elaraai/east").VariantType<{
|
|
743
|
+
success: NullType;
|
|
744
|
+
failed: StructType<{
|
|
745
|
+
exitCode: IntegerType;
|
|
746
|
+
}>;
|
|
747
|
+
error: StructType<{
|
|
748
|
+
message: StringType;
|
|
749
|
+
}>;
|
|
750
|
+
skipped: NullType;
|
|
751
|
+
}>;
|
|
752
|
+
duration: import("@elaraai/east").FloatType;
|
|
753
|
+
}>>;
|
|
754
|
+
duration: import("@elaraai/east").FloatType;
|
|
755
|
+
}>>;
|
|
756
|
+
/**
|
|
757
|
+
* Gets the dependency graph for a workspace.
|
|
758
|
+
*
|
|
759
|
+
* Returns the task dependency graph showing which tasks depend on which others.
|
|
760
|
+
*
|
|
761
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
762
|
+
* in East programs running on Node.js.
|
|
763
|
+
*
|
|
764
|
+
* @param url - Base URL of the e3 API server
|
|
765
|
+
* @param workspace - Workspace name
|
|
766
|
+
* @returns Dataflow graph with tasks and dependencies
|
|
767
|
+
*
|
|
768
|
+
* @throws {EastError} When request fails:
|
|
769
|
+
* - Workspace not found
|
|
770
|
+
* - Network error
|
|
771
|
+
*
|
|
772
|
+
* @example
|
|
773
|
+
* ```ts
|
|
774
|
+
* const getGraph = East.function([StringType, StringType], DataflowGraphType, ($, url, workspace) => {
|
|
775
|
+
* return Platform.dataflowGraph(url, workspace);
|
|
776
|
+
* });
|
|
777
|
+
* ```
|
|
778
|
+
*/
|
|
779
|
+
export declare const platform_dataflow_graph: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType], StructType<{
|
|
780
|
+
tasks: ArrayType<StructType<{
|
|
781
|
+
name: StringType;
|
|
782
|
+
hash: StringType;
|
|
783
|
+
inputs: ArrayType<StringType>;
|
|
784
|
+
output: StringType;
|
|
785
|
+
dependsOn: ArrayType<StringType>;
|
|
786
|
+
}>>;
|
|
787
|
+
}>>;
|
|
788
|
+
/**
|
|
789
|
+
* Log request options type.
|
|
790
|
+
*/
|
|
791
|
+
export declare const LogOptionsType: StructType<{
|
|
792
|
+
stream: StringType;
|
|
793
|
+
offset: IntegerType;
|
|
794
|
+
limit: IntegerType;
|
|
795
|
+
}>;
|
|
796
|
+
/**
|
|
797
|
+
* Reads task logs from a workspace.
|
|
798
|
+
*
|
|
799
|
+
* Returns a chunk of log data from the specified task's stdout or stderr.
|
|
800
|
+
*
|
|
801
|
+
* This is a platform function for the East language, enabling e3 API operations
|
|
802
|
+
* in East programs running on Node.js.
|
|
803
|
+
*
|
|
804
|
+
* @param url - Base URL of the e3 API server
|
|
805
|
+
* @param workspace - Workspace name
|
|
806
|
+
* @param task - Task name
|
|
807
|
+
* @param options - Log options (stream, offset, limit)
|
|
808
|
+
* @returns Log chunk with data and metadata
|
|
809
|
+
*
|
|
810
|
+
* @throws {EastError} When request fails:
|
|
811
|
+
* - Workspace not found
|
|
812
|
+
* - Task not found
|
|
813
|
+
* - Network error
|
|
814
|
+
*
|
|
815
|
+
* @example
|
|
816
|
+
* ```ts
|
|
817
|
+
* const getLogs = East.function([StringType, StringType, StringType, LogOptionsType], LogChunkType, ($, url, workspace, task, options) => {
|
|
818
|
+
* return Platform.taskLogs(url, workspace, task, options);
|
|
819
|
+
* });
|
|
820
|
+
* ```
|
|
821
|
+
*/
|
|
822
|
+
export declare const platform_task_logs: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StructType<{
|
|
823
|
+
stream: StringType;
|
|
824
|
+
offset: IntegerType;
|
|
825
|
+
limit: IntegerType;
|
|
826
|
+
}>], StructType<{
|
|
827
|
+
data: StringType;
|
|
828
|
+
offset: IntegerType;
|
|
829
|
+
size: IntegerType;
|
|
830
|
+
totalSize: IntegerType;
|
|
831
|
+
complete: import("@elaraai/east").BooleanType;
|
|
832
|
+
}>>;
|
|
833
|
+
/**
|
|
834
|
+
* Node.js implementation of e3 API platform functions.
|
|
835
|
+
*
|
|
836
|
+
* Pass this array to {@link East.compileAsync} to enable e3 API operations.
|
|
837
|
+
*/
|
|
838
|
+
declare const PlatformImpl: PlatformFunction[];
|
|
839
|
+
/**
|
|
840
|
+
* Grouped e3 API platform functions.
|
|
841
|
+
*
|
|
842
|
+
* Provides e3 repository, package, workspace, dataset, task, and execution operations
|
|
843
|
+
* for East programs running on Node.js.
|
|
844
|
+
*
|
|
845
|
+
* @example
|
|
846
|
+
* ```ts
|
|
847
|
+
* import { East, StringType } from "@elaraai/east";
|
|
848
|
+
* import { Platform, RepositoryStatusType } from "@elaraai/e3-api-client";
|
|
849
|
+
*
|
|
850
|
+
* const getStatus = East.function([StringType], RepositoryStatusType, ($, url) => {
|
|
851
|
+
* return Platform.repoStatus(url);
|
|
852
|
+
* });
|
|
853
|
+
*
|
|
854
|
+
* const compiled = await East.compileAsync(getStatus.toIR(), Platform.Implementation);
|
|
855
|
+
* const status = await compiled("http://localhost:3000");
|
|
856
|
+
* console.log(status.objectCount);
|
|
857
|
+
* ```
|
|
858
|
+
*/
|
|
859
|
+
export declare const Platform: {
|
|
860
|
+
/**
|
|
861
|
+
* Gets repository status information.
|
|
862
|
+
*
|
|
863
|
+
* Returns statistics about the e3 repository including object count, package count,
|
|
864
|
+
* and workspace count.
|
|
865
|
+
*
|
|
866
|
+
* @param url - Base URL of the e3 API server
|
|
867
|
+
* @returns Repository status
|
|
868
|
+
*
|
|
869
|
+
* @example
|
|
870
|
+
* ```ts
|
|
871
|
+
* const getStatus = East.function([StringType], RepositoryStatusType, ($, url) => {
|
|
872
|
+
* return Platform.repoStatus(url);
|
|
873
|
+
* });
|
|
874
|
+
*
|
|
875
|
+
* const compiled = await East.compileAsync(getStatus.toIR(), Platform.Implementation);
|
|
876
|
+
* await compiled("http://localhost:3000");
|
|
877
|
+
* ```
|
|
878
|
+
*/
|
|
879
|
+
readonly repoStatus: import("@elaraai/east").AsyncPlatformDefinition<[StringType], StructType<{
|
|
880
|
+
path: StringType;
|
|
881
|
+
objectCount: IntegerType;
|
|
882
|
+
packageCount: IntegerType;
|
|
883
|
+
workspaceCount: IntegerType;
|
|
884
|
+
}>>;
|
|
885
|
+
/**
|
|
886
|
+
* Runs garbage collection on the repository.
|
|
887
|
+
*
|
|
888
|
+
* Removes unreferenced objects from the object store to free disk space.
|
|
889
|
+
*
|
|
890
|
+
* @param url - Base URL of the e3 API server
|
|
891
|
+
* @param options - GC options
|
|
892
|
+
* @returns GC result with counts and freed bytes
|
|
893
|
+
*
|
|
894
|
+
* @example
|
|
895
|
+
* ```ts
|
|
896
|
+
* const runGc = East.function([StringType, GcRequestType], GcResultType, ($, url, options) => {
|
|
897
|
+
* return Platform.repoGc(url, options);
|
|
898
|
+
* });
|
|
899
|
+
*
|
|
900
|
+
* const compiled = await East.compileAsync(runGc.toIR(), Platform.Implementation);
|
|
901
|
+
* await compiled("http://localhost:3000", { dryRun: true, minAge: { type: "none", value: null } });
|
|
902
|
+
* ```
|
|
903
|
+
*/
|
|
904
|
+
readonly repoGc: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StructType<{
|
|
905
|
+
dryRun: import("@elaraai/east").BooleanType;
|
|
906
|
+
minAge: import("@elaraai/east").OptionType<IntegerType>;
|
|
907
|
+
}>], StructType<{
|
|
908
|
+
deletedObjects: IntegerType;
|
|
909
|
+
deletedPartials: IntegerType;
|
|
910
|
+
retainedObjects: IntegerType;
|
|
911
|
+
skippedYoung: IntegerType;
|
|
912
|
+
bytesFreed: IntegerType;
|
|
913
|
+
}>>;
|
|
914
|
+
/**
|
|
915
|
+
* Lists all packages in the repository.
|
|
916
|
+
*
|
|
917
|
+
* @param url - Base URL of the e3 API server
|
|
918
|
+
* @returns Array of package info
|
|
919
|
+
*/
|
|
920
|
+
readonly packageList: import("@elaraai/east").AsyncPlatformDefinition<[StringType], ArrayType<StructType<{
|
|
921
|
+
name: StringType;
|
|
922
|
+
version: StringType;
|
|
923
|
+
}>>>;
|
|
924
|
+
/**
|
|
925
|
+
* Gets a package object by name and version.
|
|
926
|
+
*
|
|
927
|
+
* @param url - Base URL of the e3 API server
|
|
928
|
+
* @param name - Package name
|
|
929
|
+
* @param version - Package version
|
|
930
|
+
* @returns Package object
|
|
931
|
+
*/
|
|
932
|
+
readonly packageGet: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType], StructType<{
|
|
933
|
+
tasks: import("@elaraai/east").DictType<StringType, StringType>;
|
|
934
|
+
data: StructType<{
|
|
935
|
+
structure: import("@elaraai/east").RecursiveType<import("@elaraai/east").VariantType<{
|
|
936
|
+
value: import("@elaraai/east").RecursiveType<import("@elaraai/east").VariantType<{
|
|
937
|
+
Never: import("@elaraai/east").NullType;
|
|
938
|
+
Null: import("@elaraai/east").NullType;
|
|
939
|
+
Boolean: import("@elaraai/east").NullType;
|
|
940
|
+
Integer: import("@elaraai/east").NullType;
|
|
941
|
+
Float: import("@elaraai/east").NullType;
|
|
942
|
+
String: import("@elaraai/east").NullType;
|
|
943
|
+
DateTime: import("@elaraai/east").NullType;
|
|
944
|
+
Blob: import("@elaraai/east").NullType;
|
|
945
|
+
Ref: import("@elaraai/east").RecursiveTypeMarker;
|
|
946
|
+
Array: import("@elaraai/east").RecursiveTypeMarker;
|
|
947
|
+
Set: import("@elaraai/east").RecursiveTypeMarker;
|
|
948
|
+
Dict: StructType<{
|
|
949
|
+
key: import("@elaraai/east").RecursiveTypeMarker;
|
|
950
|
+
value: import("@elaraai/east").RecursiveTypeMarker;
|
|
951
|
+
}>;
|
|
952
|
+
Struct: import("@elaraai/east").ArrayType<StructType<{
|
|
953
|
+
name: StringType;
|
|
954
|
+
type: import("@elaraai/east").RecursiveTypeMarker;
|
|
955
|
+
}>>;
|
|
956
|
+
Variant: import("@elaraai/east").ArrayType<StructType<{
|
|
957
|
+
name: StringType;
|
|
958
|
+
type: import("@elaraai/east").RecursiveTypeMarker;
|
|
959
|
+
}>>;
|
|
960
|
+
Recursive: import("@elaraai/east").IntegerType;
|
|
961
|
+
Function: StructType<{
|
|
962
|
+
inputs: import("@elaraai/east").ArrayType<import("@elaraai/east").RecursiveTypeMarker>;
|
|
963
|
+
output: import("@elaraai/east").RecursiveTypeMarker;
|
|
964
|
+
}>;
|
|
965
|
+
AsyncFunction: StructType<{
|
|
966
|
+
inputs: import("@elaraai/east").ArrayType<import("@elaraai/east").RecursiveTypeMarker>;
|
|
967
|
+
output: import("@elaraai/east").RecursiveTypeMarker;
|
|
968
|
+
}>;
|
|
969
|
+
}>>;
|
|
970
|
+
struct: import("@elaraai/east").DictType<StringType, import("@elaraai/east").RecursiveTypeMarker>;
|
|
971
|
+
}>>;
|
|
972
|
+
value: StringType;
|
|
973
|
+
}>;
|
|
974
|
+
}>>;
|
|
975
|
+
/**
|
|
976
|
+
* Imports a package from a zip archive.
|
|
977
|
+
*
|
|
978
|
+
* @param url - Base URL of the e3 API server
|
|
979
|
+
* @param archive - Zip archive as bytes
|
|
980
|
+
* @returns Import result
|
|
981
|
+
*/
|
|
982
|
+
readonly packageImport: import("@elaraai/east").AsyncPlatformDefinition<[StringType, BlobType], StructType<{
|
|
983
|
+
name: StringType;
|
|
984
|
+
version: StringType;
|
|
985
|
+
packageHash: StringType;
|
|
986
|
+
objectCount: IntegerType;
|
|
987
|
+
}>>;
|
|
988
|
+
/**
|
|
989
|
+
* Exports a package as a zip archive.
|
|
990
|
+
*
|
|
991
|
+
* @param url - Base URL of the e3 API server
|
|
992
|
+
* @param name - Package name
|
|
993
|
+
* @param version - Package version
|
|
994
|
+
* @returns Zip archive as bytes
|
|
995
|
+
*/
|
|
996
|
+
readonly packageExport: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType], BlobType>;
|
|
997
|
+
/**
|
|
998
|
+
* Removes a package from the repository.
|
|
999
|
+
*
|
|
1000
|
+
* @param url - Base URL of the e3 API server
|
|
1001
|
+
* @param name - Package name
|
|
1002
|
+
* @param version - Package version
|
|
1003
|
+
* @returns null on success
|
|
1004
|
+
*/
|
|
1005
|
+
readonly packageRemove: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType], NullType>;
|
|
1006
|
+
/**
|
|
1007
|
+
* Lists all workspaces in the repository.
|
|
1008
|
+
*
|
|
1009
|
+
* @param url - Base URL of the e3 API server
|
|
1010
|
+
* @returns Array of workspace info
|
|
1011
|
+
*/
|
|
1012
|
+
readonly workspaceList: import("@elaraai/east").AsyncPlatformDefinition<[StringType], ArrayType<StructType<{
|
|
1013
|
+
name: StringType;
|
|
1014
|
+
deployed: import("@elaraai/east").BooleanType;
|
|
1015
|
+
packageName: import("@elaraai/east").OptionType<StringType>;
|
|
1016
|
+
packageVersion: import("@elaraai/east").OptionType<StringType>;
|
|
1017
|
+
}>>>;
|
|
1018
|
+
/**
|
|
1019
|
+
* Creates a new empty workspace.
|
|
1020
|
+
*
|
|
1021
|
+
* @param url - Base URL of the e3 API server
|
|
1022
|
+
* @param name - Workspace name
|
|
1023
|
+
* @returns Created workspace info
|
|
1024
|
+
*/
|
|
1025
|
+
readonly workspaceCreate: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType], StructType<{
|
|
1026
|
+
name: StringType;
|
|
1027
|
+
deployed: import("@elaraai/east").BooleanType;
|
|
1028
|
+
packageName: import("@elaraai/east").OptionType<StringType>;
|
|
1029
|
+
packageVersion: import("@elaraai/east").OptionType<StringType>;
|
|
1030
|
+
}>>;
|
|
1031
|
+
/**
|
|
1032
|
+
* Gets workspace state including deployed package info.
|
|
1033
|
+
*
|
|
1034
|
+
* @param url - Base URL of the e3 API server
|
|
1035
|
+
* @param name - Workspace name
|
|
1036
|
+
* @returns Workspace state
|
|
1037
|
+
*/
|
|
1038
|
+
readonly workspaceGet: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType], StructType<{
|
|
1039
|
+
packageName: StringType;
|
|
1040
|
+
packageVersion: StringType;
|
|
1041
|
+
packageHash: StringType;
|
|
1042
|
+
deployedAt: import("@elaraai/east").DateTimeType;
|
|
1043
|
+
rootHash: StringType;
|
|
1044
|
+
rootUpdatedAt: import("@elaraai/east").DateTimeType;
|
|
1045
|
+
}>>;
|
|
1046
|
+
/**
|
|
1047
|
+
* Gets comprehensive workspace status.
|
|
1048
|
+
*
|
|
1049
|
+
* @param url - Base URL of the e3 API server
|
|
1050
|
+
* @param name - Workspace name
|
|
1051
|
+
* @returns Workspace status with datasets, tasks, and summary
|
|
1052
|
+
*/
|
|
1053
|
+
readonly workspaceStatus: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType], StructType<{
|
|
1054
|
+
workspace: StringType;
|
|
1055
|
+
lock: import("@elaraai/east").OptionType<StructType<{
|
|
1056
|
+
pid: IntegerType;
|
|
1057
|
+
acquiredAt: StringType;
|
|
1058
|
+
bootId: import("@elaraai/east").OptionType<StringType>;
|
|
1059
|
+
command: import("@elaraai/east").OptionType<StringType>;
|
|
1060
|
+
}>>;
|
|
1061
|
+
datasets: ArrayType<StructType<{
|
|
1062
|
+
path: StringType;
|
|
1063
|
+
status: import("@elaraai/east").VariantType<{
|
|
1064
|
+
unset: NullType;
|
|
1065
|
+
stale: NullType;
|
|
1066
|
+
'up-to-date': NullType;
|
|
1067
|
+
}>;
|
|
1068
|
+
hash: import("@elaraai/east").OptionType<StringType>;
|
|
1069
|
+
isTaskOutput: import("@elaraai/east").BooleanType;
|
|
1070
|
+
producedBy: import("@elaraai/east").OptionType<StringType>;
|
|
1071
|
+
}>>;
|
|
1072
|
+
tasks: ArrayType<StructType<{
|
|
1073
|
+
name: StringType;
|
|
1074
|
+
hash: StringType;
|
|
1075
|
+
status: import("@elaraai/east").VariantType<{
|
|
1076
|
+
'up-to-date': StructType<{
|
|
1077
|
+
cached: import("@elaraai/east").BooleanType;
|
|
1078
|
+
}>;
|
|
1079
|
+
ready: NullType;
|
|
1080
|
+
waiting: StructType<{
|
|
1081
|
+
reason: StringType;
|
|
1082
|
+
}>;
|
|
1083
|
+
'in-progress': StructType<{
|
|
1084
|
+
pid: import("@elaraai/east").OptionType<IntegerType>;
|
|
1085
|
+
startedAt: import("@elaraai/east").OptionType<StringType>;
|
|
1086
|
+
}>;
|
|
1087
|
+
failed: StructType<{
|
|
1088
|
+
exitCode: IntegerType;
|
|
1089
|
+
completedAt: import("@elaraai/east").OptionType<StringType>;
|
|
1090
|
+
}>;
|
|
1091
|
+
error: StructType<{
|
|
1092
|
+
message: StringType;
|
|
1093
|
+
completedAt: import("@elaraai/east").OptionType<StringType>;
|
|
1094
|
+
}>;
|
|
1095
|
+
'stale-running': StructType<{
|
|
1096
|
+
pid: import("@elaraai/east").OptionType<IntegerType>;
|
|
1097
|
+
startedAt: import("@elaraai/east").OptionType<StringType>;
|
|
1098
|
+
}>;
|
|
1099
|
+
}>;
|
|
1100
|
+
inputs: ArrayType<StringType>;
|
|
1101
|
+
output: StringType;
|
|
1102
|
+
dependsOn: ArrayType<StringType>;
|
|
1103
|
+
}>>;
|
|
1104
|
+
summary: StructType<{
|
|
1105
|
+
datasets: StructType<{
|
|
1106
|
+
total: IntegerType;
|
|
1107
|
+
unset: IntegerType;
|
|
1108
|
+
stale: IntegerType;
|
|
1109
|
+
upToDate: IntegerType;
|
|
1110
|
+
}>;
|
|
1111
|
+
tasks: StructType<{
|
|
1112
|
+
total: IntegerType;
|
|
1113
|
+
upToDate: IntegerType;
|
|
1114
|
+
ready: IntegerType;
|
|
1115
|
+
waiting: IntegerType;
|
|
1116
|
+
inProgress: IntegerType;
|
|
1117
|
+
failed: IntegerType;
|
|
1118
|
+
error: IntegerType;
|
|
1119
|
+
staleRunning: IntegerType;
|
|
1120
|
+
}>;
|
|
1121
|
+
}>;
|
|
1122
|
+
}>>;
|
|
1123
|
+
/**
|
|
1124
|
+
* Removes a workspace.
|
|
1125
|
+
*
|
|
1126
|
+
* @param url - Base URL of the e3 API server
|
|
1127
|
+
* @param name - Workspace name
|
|
1128
|
+
* @returns null on success
|
|
1129
|
+
*/
|
|
1130
|
+
readonly workspaceRemove: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType], NullType>;
|
|
1131
|
+
/**
|
|
1132
|
+
* Deploys a package to a workspace.
|
|
1133
|
+
*
|
|
1134
|
+
* @param url - Base URL of the e3 API server
|
|
1135
|
+
* @param name - Workspace name
|
|
1136
|
+
* @param packageRef - Package reference
|
|
1137
|
+
* @returns null on success
|
|
1138
|
+
*/
|
|
1139
|
+
readonly workspaceDeploy: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType], NullType>;
|
|
1140
|
+
/**
|
|
1141
|
+
* Exports workspace as a package zip archive.
|
|
1142
|
+
*
|
|
1143
|
+
* @param url - Base URL of the e3 API server
|
|
1144
|
+
* @param name - Workspace name
|
|
1145
|
+
* @returns Zip archive as bytes
|
|
1146
|
+
*/
|
|
1147
|
+
readonly workspaceExport: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType], BlobType>;
|
|
1148
|
+
/**
|
|
1149
|
+
* Lists field names at root of workspace dataset tree.
|
|
1150
|
+
*
|
|
1151
|
+
* @param url - Base URL of the e3 API server
|
|
1152
|
+
* @param workspace - Workspace name
|
|
1153
|
+
* @returns Array of field names
|
|
1154
|
+
*/
|
|
1155
|
+
readonly datasetList: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType], ArrayType<StringType>>;
|
|
1156
|
+
/**
|
|
1157
|
+
* Lists field names at a path in workspace dataset tree.
|
|
1158
|
+
*
|
|
1159
|
+
* @param url - Base URL of the e3 API server
|
|
1160
|
+
* @param workspace - Workspace name
|
|
1161
|
+
* @param path - Path to the dataset
|
|
1162
|
+
* @returns Array of field names
|
|
1163
|
+
*/
|
|
1164
|
+
readonly datasetListAt: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, ArrayType<import("@elaraai/east").VariantType<{
|
|
1165
|
+
field: StringType;
|
|
1166
|
+
}>>], ArrayType<StringType>>;
|
|
1167
|
+
/**
|
|
1168
|
+
* Gets a dataset value as raw BEAST2 bytes.
|
|
1169
|
+
*
|
|
1170
|
+
* @param url - Base URL of the e3 API server
|
|
1171
|
+
* @param workspace - Workspace name
|
|
1172
|
+
* @param path - Path to the dataset
|
|
1173
|
+
* @returns Raw BEAST2 bytes
|
|
1174
|
+
*/
|
|
1175
|
+
readonly datasetGet: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, ArrayType<import("@elaraai/east").VariantType<{
|
|
1176
|
+
field: StringType;
|
|
1177
|
+
}>>], BlobType>;
|
|
1178
|
+
/**
|
|
1179
|
+
* Sets a dataset value from raw BEAST2 bytes.
|
|
1180
|
+
*
|
|
1181
|
+
* @param url - Base URL of the e3 API server
|
|
1182
|
+
* @param workspace - Workspace name
|
|
1183
|
+
* @param path - Path to the dataset
|
|
1184
|
+
* @param data - Raw BEAST2 encoded value
|
|
1185
|
+
* @returns null on success
|
|
1186
|
+
*/
|
|
1187
|
+
readonly datasetSet: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, ArrayType<import("@elaraai/east").VariantType<{
|
|
1188
|
+
field: StringType;
|
|
1189
|
+
}>>, BlobType], NullType>;
|
|
1190
|
+
/**
|
|
1191
|
+
* Lists tasks in a workspace.
|
|
1192
|
+
*
|
|
1193
|
+
* @param url - Base URL of the e3 API server
|
|
1194
|
+
* @param workspace - Workspace name
|
|
1195
|
+
* @returns Array of task info
|
|
1196
|
+
*/
|
|
1197
|
+
readonly taskList: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType], ArrayType<StructType<{
|
|
1198
|
+
name: StringType;
|
|
1199
|
+
hash: StringType;
|
|
1200
|
+
}>>>;
|
|
1201
|
+
/**
|
|
1202
|
+
* Gets task details.
|
|
1203
|
+
*
|
|
1204
|
+
* @param url - Base URL of the e3 API server
|
|
1205
|
+
* @param workspace - Workspace name
|
|
1206
|
+
* @param name - Task name
|
|
1207
|
+
* @returns Task details
|
|
1208
|
+
*/
|
|
1209
|
+
readonly taskGet: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType], StructType<{
|
|
1210
|
+
name: StringType;
|
|
1211
|
+
hash: StringType;
|
|
1212
|
+
commandIr: StringType;
|
|
1213
|
+
inputs: ArrayType<ArrayType<import("@elaraai/east").VariantType<{
|
|
1214
|
+
field: StringType;
|
|
1215
|
+
}>>>;
|
|
1216
|
+
output: ArrayType<import("@elaraai/east").VariantType<{
|
|
1217
|
+
field: StringType;
|
|
1218
|
+
}>>;
|
|
1219
|
+
}>>;
|
|
1220
|
+
/**
|
|
1221
|
+
* Starts dataflow execution (non-blocking).
|
|
1222
|
+
*
|
|
1223
|
+
* @param url - Base URL of the e3 API server
|
|
1224
|
+
* @param workspace - Workspace name
|
|
1225
|
+
* @param options - Execution options
|
|
1226
|
+
* @returns null on success
|
|
1227
|
+
*/
|
|
1228
|
+
readonly dataflowStart: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StructType<{
|
|
1229
|
+
concurrency: import("@elaraai/east").OptionType<IntegerType>;
|
|
1230
|
+
force: import("@elaraai/east").BooleanType;
|
|
1231
|
+
filter: import("@elaraai/east").OptionType<StringType>;
|
|
1232
|
+
}>], NullType>;
|
|
1233
|
+
/**
|
|
1234
|
+
* Executes dataflow (blocking).
|
|
1235
|
+
*
|
|
1236
|
+
* @param url - Base URL of the e3 API server
|
|
1237
|
+
* @param workspace - Workspace name
|
|
1238
|
+
* @param options - Execution options
|
|
1239
|
+
* @returns Dataflow execution result
|
|
1240
|
+
*/
|
|
1241
|
+
readonly dataflowExecute: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StructType<{
|
|
1242
|
+
concurrency: import("@elaraai/east").OptionType<IntegerType>;
|
|
1243
|
+
force: import("@elaraai/east").BooleanType;
|
|
1244
|
+
filter: import("@elaraai/east").OptionType<StringType>;
|
|
1245
|
+
}>], StructType<{
|
|
1246
|
+
success: import("@elaraai/east").BooleanType;
|
|
1247
|
+
executed: IntegerType;
|
|
1248
|
+
cached: IntegerType;
|
|
1249
|
+
failed: IntegerType;
|
|
1250
|
+
skipped: IntegerType;
|
|
1251
|
+
tasks: ArrayType<StructType<{
|
|
1252
|
+
name: StringType;
|
|
1253
|
+
cached: import("@elaraai/east").BooleanType;
|
|
1254
|
+
state: import("@elaraai/east").VariantType<{
|
|
1255
|
+
success: NullType;
|
|
1256
|
+
failed: StructType<{
|
|
1257
|
+
exitCode: IntegerType;
|
|
1258
|
+
}>;
|
|
1259
|
+
error: StructType<{
|
|
1260
|
+
message: StringType;
|
|
1261
|
+
}>;
|
|
1262
|
+
skipped: NullType;
|
|
1263
|
+
}>;
|
|
1264
|
+
duration: import("@elaraai/east").FloatType;
|
|
1265
|
+
}>>;
|
|
1266
|
+
duration: import("@elaraai/east").FloatType;
|
|
1267
|
+
}>>;
|
|
1268
|
+
/**
|
|
1269
|
+
* Gets the dependency graph for a workspace.
|
|
1270
|
+
*
|
|
1271
|
+
* @param url - Base URL of the e3 API server
|
|
1272
|
+
* @param workspace - Workspace name
|
|
1273
|
+
* @returns Dataflow graph
|
|
1274
|
+
*/
|
|
1275
|
+
readonly dataflowGraph: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType], StructType<{
|
|
1276
|
+
tasks: ArrayType<StructType<{
|
|
1277
|
+
name: StringType;
|
|
1278
|
+
hash: StringType;
|
|
1279
|
+
inputs: ArrayType<StringType>;
|
|
1280
|
+
output: StringType;
|
|
1281
|
+
dependsOn: ArrayType<StringType>;
|
|
1282
|
+
}>>;
|
|
1283
|
+
}>>;
|
|
1284
|
+
/**
|
|
1285
|
+
* Reads task logs from a workspace.
|
|
1286
|
+
*
|
|
1287
|
+
* @param url - Base URL of the e3 API server
|
|
1288
|
+
* @param workspace - Workspace name
|
|
1289
|
+
* @param task - Task name
|
|
1290
|
+
* @param options - Log options
|
|
1291
|
+
* @returns Log chunk
|
|
1292
|
+
*/
|
|
1293
|
+
readonly taskLogs: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StructType<{
|
|
1294
|
+
stream: StringType;
|
|
1295
|
+
offset: IntegerType;
|
|
1296
|
+
limit: IntegerType;
|
|
1297
|
+
}>], StructType<{
|
|
1298
|
+
data: StringType;
|
|
1299
|
+
offset: IntegerType;
|
|
1300
|
+
size: IntegerType;
|
|
1301
|
+
totalSize: IntegerType;
|
|
1302
|
+
complete: import("@elaraai/east").BooleanType;
|
|
1303
|
+
}>>;
|
|
1304
|
+
/**
|
|
1305
|
+
* Node.js implementation of e3 API platform functions.
|
|
1306
|
+
*
|
|
1307
|
+
* Pass this to {@link East.compileAsync} to enable e3 API operations.
|
|
1308
|
+
*/
|
|
1309
|
+
readonly Implementation: PlatformFunction[];
|
|
1310
|
+
/**
|
|
1311
|
+
* Type definitions for platform operations.
|
|
1312
|
+
*/
|
|
1313
|
+
readonly Types: {
|
|
1314
|
+
readonly RepositoryStatus: StructType<{
|
|
1315
|
+
path: StringType;
|
|
1316
|
+
objectCount: IntegerType;
|
|
1317
|
+
packageCount: IntegerType;
|
|
1318
|
+
workspaceCount: IntegerType;
|
|
1319
|
+
}>;
|
|
1320
|
+
readonly GcRequest: StructType<{
|
|
1321
|
+
dryRun: import("@elaraai/east").BooleanType;
|
|
1322
|
+
minAge: import("@elaraai/east").OptionType<IntegerType>;
|
|
1323
|
+
}>;
|
|
1324
|
+
readonly GcResult: StructType<{
|
|
1325
|
+
deletedObjects: IntegerType;
|
|
1326
|
+
deletedPartials: IntegerType;
|
|
1327
|
+
retainedObjects: IntegerType;
|
|
1328
|
+
skippedYoung: IntegerType;
|
|
1329
|
+
bytesFreed: IntegerType;
|
|
1330
|
+
}>;
|
|
1331
|
+
readonly PackageListItem: StructType<{
|
|
1332
|
+
name: StringType;
|
|
1333
|
+
version: StringType;
|
|
1334
|
+
}>;
|
|
1335
|
+
readonly PackageImportResult: StructType<{
|
|
1336
|
+
name: StringType;
|
|
1337
|
+
version: StringType;
|
|
1338
|
+
packageHash: StringType;
|
|
1339
|
+
objectCount: IntegerType;
|
|
1340
|
+
}>;
|
|
1341
|
+
readonly WorkspaceInfo: StructType<{
|
|
1342
|
+
name: StringType;
|
|
1343
|
+
deployed: import("@elaraai/east").BooleanType;
|
|
1344
|
+
packageName: import("@elaraai/east").OptionType<StringType>;
|
|
1345
|
+
packageVersion: import("@elaraai/east").OptionType<StringType>;
|
|
1346
|
+
}>;
|
|
1347
|
+
readonly WorkspaceStatusResult: StructType<{
|
|
1348
|
+
workspace: StringType;
|
|
1349
|
+
lock: import("@elaraai/east").OptionType<StructType<{
|
|
1350
|
+
pid: IntegerType;
|
|
1351
|
+
acquiredAt: StringType;
|
|
1352
|
+
bootId: import("@elaraai/east").OptionType<StringType>;
|
|
1353
|
+
command: import("@elaraai/east").OptionType<StringType>;
|
|
1354
|
+
}>>;
|
|
1355
|
+
datasets: ArrayType<StructType<{
|
|
1356
|
+
path: StringType;
|
|
1357
|
+
status: import("@elaraai/east").VariantType<{
|
|
1358
|
+
unset: NullType;
|
|
1359
|
+
stale: NullType;
|
|
1360
|
+
'up-to-date': NullType;
|
|
1361
|
+
}>;
|
|
1362
|
+
hash: import("@elaraai/east").OptionType<StringType>;
|
|
1363
|
+
isTaskOutput: import("@elaraai/east").BooleanType;
|
|
1364
|
+
producedBy: import("@elaraai/east").OptionType<StringType>;
|
|
1365
|
+
}>>;
|
|
1366
|
+
tasks: ArrayType<StructType<{
|
|
1367
|
+
name: StringType;
|
|
1368
|
+
hash: StringType;
|
|
1369
|
+
status: import("@elaraai/east").VariantType<{
|
|
1370
|
+
'up-to-date': StructType<{
|
|
1371
|
+
cached: import("@elaraai/east").BooleanType;
|
|
1372
|
+
}>;
|
|
1373
|
+
ready: NullType;
|
|
1374
|
+
waiting: StructType<{
|
|
1375
|
+
reason: StringType;
|
|
1376
|
+
}>;
|
|
1377
|
+
'in-progress': StructType<{
|
|
1378
|
+
pid: import("@elaraai/east").OptionType<IntegerType>;
|
|
1379
|
+
startedAt: import("@elaraai/east").OptionType<StringType>;
|
|
1380
|
+
}>;
|
|
1381
|
+
failed: StructType<{
|
|
1382
|
+
exitCode: IntegerType;
|
|
1383
|
+
completedAt: import("@elaraai/east").OptionType<StringType>;
|
|
1384
|
+
}>;
|
|
1385
|
+
error: StructType<{
|
|
1386
|
+
message: StringType;
|
|
1387
|
+
completedAt: import("@elaraai/east").OptionType<StringType>;
|
|
1388
|
+
}>;
|
|
1389
|
+
'stale-running': StructType<{
|
|
1390
|
+
pid: import("@elaraai/east").OptionType<IntegerType>;
|
|
1391
|
+
startedAt: import("@elaraai/east").OptionType<StringType>;
|
|
1392
|
+
}>;
|
|
1393
|
+
}>;
|
|
1394
|
+
inputs: ArrayType<StringType>;
|
|
1395
|
+
output: StringType;
|
|
1396
|
+
dependsOn: ArrayType<StringType>;
|
|
1397
|
+
}>>;
|
|
1398
|
+
summary: StructType<{
|
|
1399
|
+
datasets: StructType<{
|
|
1400
|
+
total: IntegerType;
|
|
1401
|
+
unset: IntegerType;
|
|
1402
|
+
stale: IntegerType;
|
|
1403
|
+
upToDate: IntegerType;
|
|
1404
|
+
}>;
|
|
1405
|
+
tasks: StructType<{
|
|
1406
|
+
total: IntegerType;
|
|
1407
|
+
upToDate: IntegerType;
|
|
1408
|
+
ready: IntegerType;
|
|
1409
|
+
waiting: IntegerType;
|
|
1410
|
+
inProgress: IntegerType;
|
|
1411
|
+
failed: IntegerType;
|
|
1412
|
+
error: IntegerType;
|
|
1413
|
+
staleRunning: IntegerType;
|
|
1414
|
+
}>;
|
|
1415
|
+
}>;
|
|
1416
|
+
}>;
|
|
1417
|
+
readonly TaskListItem: StructType<{
|
|
1418
|
+
name: StringType;
|
|
1419
|
+
hash: StringType;
|
|
1420
|
+
}>;
|
|
1421
|
+
readonly TaskDetails: StructType<{
|
|
1422
|
+
name: StringType;
|
|
1423
|
+
hash: StringType;
|
|
1424
|
+
commandIr: StringType;
|
|
1425
|
+
inputs: ArrayType<ArrayType<import("@elaraai/east").VariantType<{
|
|
1426
|
+
field: StringType;
|
|
1427
|
+
}>>>;
|
|
1428
|
+
output: ArrayType<import("@elaraai/east").VariantType<{
|
|
1429
|
+
field: StringType;
|
|
1430
|
+
}>>;
|
|
1431
|
+
}>;
|
|
1432
|
+
readonly DataflowRequest: StructType<{
|
|
1433
|
+
concurrency: import("@elaraai/east").OptionType<IntegerType>;
|
|
1434
|
+
force: import("@elaraai/east").BooleanType;
|
|
1435
|
+
filter: import("@elaraai/east").OptionType<StringType>;
|
|
1436
|
+
}>;
|
|
1437
|
+
readonly DataflowGraph: StructType<{
|
|
1438
|
+
tasks: ArrayType<StructType<{
|
|
1439
|
+
name: StringType;
|
|
1440
|
+
hash: StringType;
|
|
1441
|
+
inputs: ArrayType<StringType>;
|
|
1442
|
+
output: StringType;
|
|
1443
|
+
dependsOn: ArrayType<StringType>;
|
|
1444
|
+
}>>;
|
|
1445
|
+
}>;
|
|
1446
|
+
readonly DataflowResult: StructType<{
|
|
1447
|
+
success: import("@elaraai/east").BooleanType;
|
|
1448
|
+
executed: IntegerType;
|
|
1449
|
+
cached: IntegerType;
|
|
1450
|
+
failed: IntegerType;
|
|
1451
|
+
skipped: IntegerType;
|
|
1452
|
+
tasks: ArrayType<StructType<{
|
|
1453
|
+
name: StringType;
|
|
1454
|
+
cached: import("@elaraai/east").BooleanType;
|
|
1455
|
+
state: import("@elaraai/east").VariantType<{
|
|
1456
|
+
success: NullType;
|
|
1457
|
+
failed: StructType<{
|
|
1458
|
+
exitCode: IntegerType;
|
|
1459
|
+
}>;
|
|
1460
|
+
error: StructType<{
|
|
1461
|
+
message: StringType;
|
|
1462
|
+
}>;
|
|
1463
|
+
skipped: NullType;
|
|
1464
|
+
}>;
|
|
1465
|
+
duration: import("@elaraai/east").FloatType;
|
|
1466
|
+
}>>;
|
|
1467
|
+
duration: import("@elaraai/east").FloatType;
|
|
1468
|
+
}>;
|
|
1469
|
+
readonly LogChunk: StructType<{
|
|
1470
|
+
data: StringType;
|
|
1471
|
+
offset: IntegerType;
|
|
1472
|
+
size: IntegerType;
|
|
1473
|
+
totalSize: IntegerType;
|
|
1474
|
+
complete: import("@elaraai/east").BooleanType;
|
|
1475
|
+
}>;
|
|
1476
|
+
readonly LogOptions: StructType<{
|
|
1477
|
+
stream: StringType;
|
|
1478
|
+
offset: IntegerType;
|
|
1479
|
+
limit: IntegerType;
|
|
1480
|
+
}>;
|
|
1481
|
+
};
|
|
1482
|
+
};
|
|
1483
|
+
export { PlatformImpl };
|
|
1484
|
+
//# sourceMappingURL=platform.d.ts.map
|