@elaraai/e3-api-client 0.0.2-beta.12 → 0.0.2-beta.13
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/README.md +1 -1
- package/dist/src/datasets.d.ts +25 -4
- package/dist/src/datasets.d.ts.map +1 -1
- package/dist/src/datasets.js +45 -8
- package/dist/src/datasets.js.map +1 -1
- package/dist/src/executions.d.ts +40 -8
- package/dist/src/executions.d.ts.map +1 -1
- package/dist/src/executions.js +59 -27
- package/dist/src/executions.js.map +1 -1
- package/dist/src/http.d.ts +23 -4
- package/dist/src/http.d.ts.map +1 -1
- package/dist/src/http.js +68 -8
- package/dist/src/http.js.map +1 -1
- package/dist/src/index.d.ts +7 -5
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +6 -4
- package/dist/src/index.js.map +1 -1
- package/dist/src/packages.d.ts +16 -5
- package/dist/src/packages.d.ts.map +1 -1
- package/dist/src/packages.js +20 -10
- package/dist/src/packages.js.map +1 -1
- package/dist/src/platform.d.ts +62 -878
- package/dist/src/platform.d.ts.map +1 -1
- package/dist/src/platform.js +99 -891
- package/dist/src/platform.js.map +1 -1
- package/dist/src/repository.d.ts +80 -5
- package/dist/src/repository.d.ts.map +1 -1
- package/dist/src/repository.js +128 -8
- package/dist/src/repository.js.map +1 -1
- package/dist/src/tasks.d.ts +19 -3
- package/dist/src/tasks.d.ts.map +1 -1
- package/dist/src/tasks.js +23 -5
- package/dist/src/tasks.js.map +1 -1
- package/dist/src/types.d.ts +486 -1
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/types.js +209 -2
- package/dist/src/types.js.map +1 -1
- package/dist/src/workspaces.d.ts +22 -7
- package/dist/src/workspaces.d.ts.map +1 -1
- package/dist/src/workspaces.js +28 -14
- package/dist/src/workspaces.js.map +1 -1
- package/package.json +2 -2
package/dist/src/platform.d.ts
CHANGED
|
@@ -4,120 +4,27 @@
|
|
|
4
4
|
*/
|
|
5
5
|
import { StringType, IntegerType, BlobType, NullType, ArrayType, StructType } from '@elaraai/east';
|
|
6
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<{
|
|
7
|
+
export declare const platform_repo_status: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType], StructType<{
|
|
31
8
|
readonly path: StringType;
|
|
32
9
|
readonly objectCount: IntegerType;
|
|
33
10
|
readonly packageCount: IntegerType;
|
|
34
11
|
readonly workspaceCount: IntegerType;
|
|
35
12
|
}>>;
|
|
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<{
|
|
13
|
+
export declare const platform_repo_gc: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StructType<{
|
|
61
14
|
readonly dryRun: import("@elaraai/east").BooleanType;
|
|
62
15
|
readonly minAge: import("@elaraai/east").OptionType<IntegerType>;
|
|
63
|
-
}
|
|
16
|
+
}>, StringType], StructType<{
|
|
64
17
|
readonly deletedObjects: IntegerType;
|
|
65
18
|
readonly deletedPartials: IntegerType;
|
|
66
19
|
readonly retainedObjects: IntegerType;
|
|
67
20
|
readonly skippedYoung: IntegerType;
|
|
68
21
|
readonly bytesFreed: IntegerType;
|
|
69
22
|
}>>;
|
|
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<{
|
|
23
|
+
export declare const platform_package_list: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType], ArrayType<StructType<{
|
|
93
24
|
readonly name: StringType;
|
|
94
25
|
readonly version: StringType;
|
|
95
26
|
}>>>;
|
|
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<{
|
|
27
|
+
export declare const platform_package_get: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType, StringType], StructType<{
|
|
121
28
|
readonly tasks: import("@elaraai/east").DictType<StringType, StringType>;
|
|
122
29
|
readonly data: StructType<{
|
|
123
30
|
readonly structure: import("@elaraai/east").RecursiveType<import("@elaraai/east").VariantType<{
|
|
@@ -160,167 +67,27 @@ export declare const platform_package_get: import("@elaraai/east").AsyncPlatform
|
|
|
160
67
|
readonly value: StringType;
|
|
161
68
|
}>;
|
|
162
69
|
}>>;
|
|
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<{
|
|
70
|
+
export declare const platform_package_import: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, BlobType, StringType], StructType<{
|
|
188
71
|
readonly name: StringType;
|
|
189
72
|
readonly version: StringType;
|
|
190
73
|
readonly packageHash: StringType;
|
|
191
74
|
readonly objectCount: IntegerType;
|
|
192
75
|
}>>;
|
|
193
|
-
|
|
194
|
-
|
|
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<{
|
|
76
|
+
export declare const platform_package_export: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType, StringType], BlobType>;
|
|
77
|
+
export declare const platform_package_remove: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType, StringType], NullType>;
|
|
78
|
+
export declare const platform_workspace_list: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType], ArrayType<StructType<{
|
|
266
79
|
readonly name: StringType;
|
|
267
80
|
readonly deployed: import("@elaraai/east").BooleanType;
|
|
268
81
|
readonly packageName: import("@elaraai/east").OptionType<StringType>;
|
|
269
82
|
readonly packageVersion: import("@elaraai/east").OptionType<StringType>;
|
|
270
83
|
}>>>;
|
|
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<{
|
|
84
|
+
export declare const platform_workspace_create: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType], StructType<{
|
|
295
85
|
readonly name: StringType;
|
|
296
86
|
readonly deployed: import("@elaraai/east").BooleanType;
|
|
297
87
|
readonly packageName: import("@elaraai/east").OptionType<StringType>;
|
|
298
88
|
readonly packageVersion: import("@elaraai/east").OptionType<StringType>;
|
|
299
89
|
}>>;
|
|
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<{
|
|
90
|
+
export declare const platform_workspace_get: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType], StructType<{
|
|
324
91
|
readonly packageName: StringType;
|
|
325
92
|
readonly packageVersion: StringType;
|
|
326
93
|
readonly packageHash: StringType;
|
|
@@ -328,31 +95,7 @@ export declare const platform_workspace_get: import("@elaraai/east").AsyncPlatfo
|
|
|
328
95
|
readonly rootHash: StringType;
|
|
329
96
|
readonly rootUpdatedAt: import("@elaraai/east").DateTimeType;
|
|
330
97
|
}>>;
|
|
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<{
|
|
98
|
+
export declare const platform_workspace_status: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType], StructType<{
|
|
356
99
|
readonly workspace: StringType;
|
|
357
100
|
readonly lock: import("@elaraai/east").OptionType<StructType<{
|
|
358
101
|
readonly pid: IntegerType;
|
|
@@ -422,244 +165,24 @@ export declare const platform_workspace_status: import("@elaraai/east").AsyncPla
|
|
|
422
165
|
}>;
|
|
423
166
|
}>;
|
|
424
167
|
}>>;
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
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<{
|
|
168
|
+
export declare const platform_workspace_remove: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType], NullType>;
|
|
169
|
+
export declare const platform_workspace_deploy: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType, StringType], NullType>;
|
|
170
|
+
export declare const platform_workspace_export: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType], BlobType>;
|
|
171
|
+
export declare const platform_dataset_list: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType], ArrayType<StringType>>;
|
|
172
|
+
export declare const platform_dataset_list_at: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, ArrayType<import("@elaraai/east").VariantType<{
|
|
549
173
|
readonly field: StringType;
|
|
550
|
-
}
|
|
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<{
|
|
174
|
+
}>>, StringType], ArrayType<StringType>>;
|
|
175
|
+
export declare const platform_dataset_get: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, ArrayType<import("@elaraai/east").VariantType<{
|
|
578
176
|
readonly field: StringType;
|
|
579
|
-
}
|
|
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<{
|
|
177
|
+
}>>, StringType], BlobType>;
|
|
178
|
+
export declare const platform_dataset_set: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, ArrayType<import("@elaraai/east").VariantType<{
|
|
607
179
|
readonly 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<{
|
|
180
|
+
}>>, BlobType, StringType], NullType>;
|
|
181
|
+
export declare const platform_task_list: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType], ArrayType<StructType<{
|
|
634
182
|
readonly name: StringType;
|
|
635
183
|
readonly hash: StringType;
|
|
636
184
|
}>>>;
|
|
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<{
|
|
185
|
+
export declare const platform_task_get: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType, StringType], StructType<{
|
|
663
186
|
readonly name: StringType;
|
|
664
187
|
readonly hash: StringType;
|
|
665
188
|
readonly commandIr: StringType;
|
|
@@ -670,67 +193,16 @@ export declare const platform_task_get: import("@elaraai/east").AsyncPlatformDef
|
|
|
670
193
|
readonly field: StringType;
|
|
671
194
|
}>>;
|
|
672
195
|
}>>;
|
|
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<{
|
|
196
|
+
export declare const platform_dataflow_start: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StructType<{
|
|
700
197
|
readonly concurrency: import("@elaraai/east").OptionType<IntegerType>;
|
|
701
198
|
readonly force: import("@elaraai/east").BooleanType;
|
|
702
199
|
readonly filter: import("@elaraai/east").OptionType<StringType>;
|
|
703
|
-
}
|
|
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<{
|
|
200
|
+
}>, StringType], NullType>;
|
|
201
|
+
export declare const platform_dataflow_execute: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StructType<{
|
|
730
202
|
readonly concurrency: import("@elaraai/east").OptionType<IntegerType>;
|
|
731
203
|
readonly force: import("@elaraai/east").BooleanType;
|
|
732
204
|
readonly filter: import("@elaraai/east").OptionType<StringType>;
|
|
733
|
-
}
|
|
205
|
+
}>, StringType], StructType<{
|
|
734
206
|
readonly success: import("@elaraai/east").BooleanType;
|
|
735
207
|
readonly executed: IntegerType;
|
|
736
208
|
readonly cached: IntegerType;
|
|
@@ -753,30 +225,7 @@ export declare const platform_dataflow_execute: import("@elaraai/east").AsyncPla
|
|
|
753
225
|
}>>;
|
|
754
226
|
readonly duration: import("@elaraai/east").FloatType;
|
|
755
227
|
}>>;
|
|
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<{
|
|
228
|
+
export declare const platform_dataflow_graph: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType], StructType<{
|
|
780
229
|
readonly tasks: ArrayType<StructType<{
|
|
781
230
|
readonly name: StringType;
|
|
782
231
|
readonly hash: StringType;
|
|
@@ -785,151 +234,45 @@ export declare const platform_dataflow_graph: import("@elaraai/east").AsyncPlatf
|
|
|
785
234
|
readonly dependsOn: ArrayType<StringType>;
|
|
786
235
|
}>>;
|
|
787
236
|
}>>;
|
|
788
|
-
/**
|
|
789
|
-
* Log request options type.
|
|
790
|
-
*/
|
|
791
237
|
export declare const LogOptionsType: StructType<{
|
|
792
238
|
readonly stream: StringType;
|
|
793
239
|
readonly offset: IntegerType;
|
|
794
240
|
readonly limit: IntegerType;
|
|
795
241
|
}>;
|
|
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<{
|
|
242
|
+
export declare const platform_task_logs: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType, StructType<{
|
|
823
243
|
readonly stream: StringType;
|
|
824
244
|
readonly offset: IntegerType;
|
|
825
245
|
readonly limit: IntegerType;
|
|
826
|
-
}
|
|
246
|
+
}>, StringType], StructType<{
|
|
827
247
|
readonly data: StringType;
|
|
828
248
|
readonly offset: IntegerType;
|
|
829
249
|
readonly size: IntegerType;
|
|
830
250
|
readonly totalSize: IntegerType;
|
|
831
251
|
readonly complete: import("@elaraai/east").BooleanType;
|
|
832
252
|
}>>;
|
|
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
253
|
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
254
|
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<{
|
|
255
|
+
readonly repoStatus: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType], StructType<{
|
|
880
256
|
readonly path: StringType;
|
|
881
257
|
readonly objectCount: IntegerType;
|
|
882
258
|
readonly packageCount: IntegerType;
|
|
883
259
|
readonly workspaceCount: IntegerType;
|
|
884
260
|
}>>;
|
|
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<{
|
|
261
|
+
readonly repoGc: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StructType<{
|
|
905
262
|
readonly dryRun: import("@elaraai/east").BooleanType;
|
|
906
263
|
readonly minAge: import("@elaraai/east").OptionType<IntegerType>;
|
|
907
|
-
}
|
|
264
|
+
}>, StringType], StructType<{
|
|
908
265
|
readonly deletedObjects: IntegerType;
|
|
909
266
|
readonly deletedPartials: IntegerType;
|
|
910
267
|
readonly retainedObjects: IntegerType;
|
|
911
268
|
readonly skippedYoung: IntegerType;
|
|
912
269
|
readonly bytesFreed: IntegerType;
|
|
913
270
|
}>>;
|
|
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<{
|
|
271
|
+
readonly packageList: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType], ArrayType<StructType<{
|
|
921
272
|
readonly name: StringType;
|
|
922
273
|
readonly version: StringType;
|
|
923
274
|
}>>>;
|
|
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<{
|
|
275
|
+
readonly packageGet: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType, StringType], StructType<{
|
|
933
276
|
readonly tasks: import("@elaraai/east").DictType<StringType, StringType>;
|
|
934
277
|
readonly data: StructType<{
|
|
935
278
|
readonly structure: import("@elaraai/east").RecursiveType<import("@elaraai/east").VariantType<{
|
|
@@ -972,70 +315,27 @@ export declare const Platform: {
|
|
|
972
315
|
readonly value: StringType;
|
|
973
316
|
}>;
|
|
974
317
|
}>>;
|
|
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<{
|
|
318
|
+
readonly packageImport: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, BlobType, StringType], StructType<{
|
|
983
319
|
readonly name: StringType;
|
|
984
320
|
readonly version: StringType;
|
|
985
321
|
readonly packageHash: StringType;
|
|
986
322
|
readonly objectCount: IntegerType;
|
|
987
323
|
}>>;
|
|
988
|
-
|
|
989
|
-
|
|
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<{
|
|
324
|
+
readonly packageExport: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType, StringType], BlobType>;
|
|
325
|
+
readonly packageRemove: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType, StringType], NullType>;
|
|
326
|
+
readonly workspaceList: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType], ArrayType<StructType<{
|
|
1013
327
|
readonly name: StringType;
|
|
1014
328
|
readonly deployed: import("@elaraai/east").BooleanType;
|
|
1015
329
|
readonly packageName: import("@elaraai/east").OptionType<StringType>;
|
|
1016
330
|
readonly packageVersion: import("@elaraai/east").OptionType<StringType>;
|
|
1017
331
|
}>>>;
|
|
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<{
|
|
332
|
+
readonly workspaceCreate: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType], StructType<{
|
|
1026
333
|
readonly name: StringType;
|
|
1027
334
|
readonly deployed: import("@elaraai/east").BooleanType;
|
|
1028
335
|
readonly packageName: import("@elaraai/east").OptionType<StringType>;
|
|
1029
336
|
readonly packageVersion: import("@elaraai/east").OptionType<StringType>;
|
|
1030
337
|
}>>;
|
|
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<{
|
|
338
|
+
readonly workspaceGet: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType], StructType<{
|
|
1039
339
|
readonly packageName: StringType;
|
|
1040
340
|
readonly packageVersion: StringType;
|
|
1041
341
|
readonly packageHash: StringType;
|
|
@@ -1043,14 +343,7 @@ export declare const Platform: {
|
|
|
1043
343
|
readonly rootHash: StringType;
|
|
1044
344
|
readonly rootUpdatedAt: import("@elaraai/east").DateTimeType;
|
|
1045
345
|
}>>;
|
|
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<{
|
|
346
|
+
readonly workspaceStatus: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType], StructType<{
|
|
1054
347
|
readonly workspace: StringType;
|
|
1055
348
|
readonly lock: import("@elaraai/east").OptionType<StructType<{
|
|
1056
349
|
readonly pid: IntegerType;
|
|
@@ -1120,93 +413,24 @@ export declare const Platform: {
|
|
|
1120
413
|
}>;
|
|
1121
414
|
}>;
|
|
1122
415
|
}>>;
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1127
|
-
|
|
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<{
|
|
416
|
+
readonly workspaceRemove: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType], NullType>;
|
|
417
|
+
readonly workspaceDeploy: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType, StringType], NullType>;
|
|
418
|
+
readonly workspaceExport: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType], BlobType>;
|
|
419
|
+
readonly datasetList: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType], ArrayType<StringType>>;
|
|
420
|
+
readonly datasetListAt: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, ArrayType<import("@elaraai/east").VariantType<{
|
|
1165
421
|
readonly field: StringType;
|
|
1166
|
-
}
|
|
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<{
|
|
422
|
+
}>>, StringType], ArrayType<StringType>>;
|
|
423
|
+
readonly datasetGet: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, ArrayType<import("@elaraai/east").VariantType<{
|
|
1176
424
|
readonly field: StringType;
|
|
1177
|
-
}
|
|
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<{
|
|
425
|
+
}>>, StringType], BlobType>;
|
|
426
|
+
readonly datasetSet: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, ArrayType<import("@elaraai/east").VariantType<{
|
|
1188
427
|
readonly 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<{
|
|
428
|
+
}>>, BlobType, StringType], NullType>;
|
|
429
|
+
readonly taskList: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType], ArrayType<StructType<{
|
|
1198
430
|
readonly name: StringType;
|
|
1199
431
|
readonly hash: StringType;
|
|
1200
432
|
}>>>;
|
|
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<{
|
|
433
|
+
readonly taskGet: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType, StringType], StructType<{
|
|
1210
434
|
readonly name: StringType;
|
|
1211
435
|
readonly hash: StringType;
|
|
1212
436
|
readonly commandIr: StringType;
|
|
@@ -1217,32 +441,16 @@ export declare const Platform: {
|
|
|
1217
441
|
readonly field: StringType;
|
|
1218
442
|
}>>;
|
|
1219
443
|
}>>;
|
|
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<{
|
|
444
|
+
readonly dataflowStart: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StructType<{
|
|
1229
445
|
readonly concurrency: import("@elaraai/east").OptionType<IntegerType>;
|
|
1230
446
|
readonly force: import("@elaraai/east").BooleanType;
|
|
1231
447
|
readonly filter: import("@elaraai/east").OptionType<StringType>;
|
|
1232
|
-
}
|
|
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<{
|
|
448
|
+
}>, StringType], NullType>;
|
|
449
|
+
readonly dataflowExecute: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StructType<{
|
|
1242
450
|
readonly concurrency: import("@elaraai/east").OptionType<IntegerType>;
|
|
1243
451
|
readonly force: import("@elaraai/east").BooleanType;
|
|
1244
452
|
readonly filter: import("@elaraai/east").OptionType<StringType>;
|
|
1245
|
-
}
|
|
453
|
+
}>, StringType], StructType<{
|
|
1246
454
|
readonly success: import("@elaraai/east").BooleanType;
|
|
1247
455
|
readonly executed: IntegerType;
|
|
1248
456
|
readonly cached: IntegerType;
|
|
@@ -1265,14 +473,7 @@ export declare const Platform: {
|
|
|
1265
473
|
}>>;
|
|
1266
474
|
readonly duration: import("@elaraai/east").FloatType;
|
|
1267
475
|
}>>;
|
|
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<{
|
|
476
|
+
readonly dataflowGraph: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType], StructType<{
|
|
1276
477
|
readonly tasks: ArrayType<StructType<{
|
|
1277
478
|
readonly name: StringType;
|
|
1278
479
|
readonly hash: StringType;
|
|
@@ -1281,35 +482,18 @@ export declare const Platform: {
|
|
|
1281
482
|
readonly dependsOn: ArrayType<StringType>;
|
|
1282
483
|
}>>;
|
|
1283
484
|
}>>;
|
|
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<{
|
|
485
|
+
readonly taskLogs: import("@elaraai/east").AsyncPlatformDefinition<[StringType, StringType, StringType, StringType, StructType<{
|
|
1294
486
|
readonly stream: StringType;
|
|
1295
487
|
readonly offset: IntegerType;
|
|
1296
488
|
readonly limit: IntegerType;
|
|
1297
|
-
}
|
|
489
|
+
}>, StringType], StructType<{
|
|
1298
490
|
readonly data: StringType;
|
|
1299
491
|
readonly offset: IntegerType;
|
|
1300
492
|
readonly size: IntegerType;
|
|
1301
493
|
readonly totalSize: IntegerType;
|
|
1302
494
|
readonly complete: import("@elaraai/east").BooleanType;
|
|
1303
495
|
}>>;
|
|
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
496
|
readonly Implementation: PlatformFunction[];
|
|
1310
|
-
/**
|
|
1311
|
-
* Type definitions for platform operations.
|
|
1312
|
-
*/
|
|
1313
497
|
readonly Types: {
|
|
1314
498
|
readonly RepositoryStatus: StructType<{
|
|
1315
499
|
readonly path: StringType;
|