@elaraai/e3-core 0.0.1-alpha.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.
Files changed (63) hide show
  1. package/LICENSE.md +50 -0
  2. package/README.md +103 -0
  3. package/dist/src/dataflow.d.ts +136 -0
  4. package/dist/src/dataflow.d.ts.map +1 -0
  5. package/dist/src/dataflow.js +562 -0
  6. package/dist/src/dataflow.js.map +1 -0
  7. package/dist/src/errors.d.ts +125 -0
  8. package/dist/src/errors.d.ts.map +1 -0
  9. package/dist/src/errors.js +211 -0
  10. package/dist/src/errors.js.map +1 -0
  11. package/dist/src/executions.d.ts +176 -0
  12. package/dist/src/executions.d.ts.map +1 -0
  13. package/dist/src/executions.js +585 -0
  14. package/dist/src/executions.js.map +1 -0
  15. package/dist/src/formats.d.ts +38 -0
  16. package/dist/src/formats.d.ts.map +1 -0
  17. package/dist/src/formats.js +115 -0
  18. package/dist/src/formats.js.map +1 -0
  19. package/dist/src/gc.d.ts +54 -0
  20. package/dist/src/gc.d.ts.map +1 -0
  21. package/dist/src/gc.js +233 -0
  22. package/dist/src/gc.js.map +1 -0
  23. package/dist/src/index.d.ts +25 -0
  24. package/dist/src/index.d.ts.map +1 -0
  25. package/dist/src/index.js +72 -0
  26. package/dist/src/index.js.map +1 -0
  27. package/dist/src/objects.d.ts +62 -0
  28. package/dist/src/objects.d.ts.map +1 -0
  29. package/dist/src/objects.js +245 -0
  30. package/dist/src/objects.js.map +1 -0
  31. package/dist/src/packages.d.ts +93 -0
  32. package/dist/src/packages.d.ts.map +1 -0
  33. package/dist/src/packages.js +370 -0
  34. package/dist/src/packages.js.map +1 -0
  35. package/dist/src/repository.d.ts +38 -0
  36. package/dist/src/repository.d.ts.map +1 -0
  37. package/dist/src/repository.js +103 -0
  38. package/dist/src/repository.js.map +1 -0
  39. package/dist/src/tasks.d.ts +63 -0
  40. package/dist/src/tasks.d.ts.map +1 -0
  41. package/dist/src/tasks.js +145 -0
  42. package/dist/src/tasks.js.map +1 -0
  43. package/dist/src/test-helpers.d.ts +44 -0
  44. package/dist/src/test-helpers.d.ts.map +1 -0
  45. package/dist/src/test-helpers.js +141 -0
  46. package/dist/src/test-helpers.js.map +1 -0
  47. package/dist/src/trees.d.ts +178 -0
  48. package/dist/src/trees.d.ts.map +1 -0
  49. package/dist/src/trees.js +636 -0
  50. package/dist/src/trees.js.map +1 -0
  51. package/dist/src/workspaceLock.d.ts +67 -0
  52. package/dist/src/workspaceLock.d.ts.map +1 -0
  53. package/dist/src/workspaceLock.js +217 -0
  54. package/dist/src/workspaceLock.js.map +1 -0
  55. package/dist/src/workspaceStatus.d.ts +126 -0
  56. package/dist/src/workspaceStatus.d.ts.map +1 -0
  57. package/dist/src/workspaceStatus.js +352 -0
  58. package/dist/src/workspaceStatus.js.map +1 -0
  59. package/dist/src/workspaces.d.ts +150 -0
  60. package/dist/src/workspaces.d.ts.map +1 -0
  61. package/dist/src/workspaces.js +390 -0
  62. package/dist/src/workspaces.js.map +1 -0
  63. package/package.json +59 -0
@@ -0,0 +1,67 @@
1
+ /**
2
+ * Copyright (c) 2025 Elara AI Pty Ltd
3
+ * Licensed under BSL 1.1. See LICENSE for details.
4
+ */
5
+ import { type LockHolder } from './errors.js';
6
+ /**
7
+ * Handle to a held workspace lock.
8
+ * Call release() when done to free the lock.
9
+ */
10
+ export interface WorkspaceLockHandle {
11
+ /** The workspace name this lock is for */
12
+ readonly workspace: string;
13
+ /** Path to the lock file */
14
+ readonly lockPath: string;
15
+ /** Release the lock. Safe to call multiple times. */
16
+ release(): Promise<void>;
17
+ }
18
+ /**
19
+ * Options for acquiring a workspace lock.
20
+ */
21
+ export interface AcquireLockOptions {
22
+ /**
23
+ * If true, wait for the lock to become available instead of failing immediately.
24
+ * Default: false (fail fast if locked)
25
+ */
26
+ wait?: boolean;
27
+ /**
28
+ * Timeout in milliseconds when wait=true. Default: 30000 (30 seconds)
29
+ */
30
+ timeout?: number;
31
+ }
32
+ /**
33
+ * Get the lock file path for a workspace.
34
+ */
35
+ export declare function workspaceLockPath(repoPath: string, workspace: string): string;
36
+ /**
37
+ * Acquire an exclusive lock on a workspace.
38
+ *
39
+ * Uses Linux flock() for kernel-managed locking. The lock is automatically
40
+ * released when the process exits (even on crash/kill).
41
+ *
42
+ * @param repoPath - Path to .e3 repository
43
+ * @param workspace - Workspace name to lock
44
+ * @param options - Lock acquisition options
45
+ * @returns Lock handle - call release() when done
46
+ * @throws {WorkspaceLockError} If workspace is locked by another process
47
+ *
48
+ * @example
49
+ * ```typescript
50
+ * const lock = await acquireWorkspaceLock(repoPath, 'production');
51
+ * try {
52
+ * await dataflowExecute(repoPath, 'production', { lock });
53
+ * } finally {
54
+ * await lock.release();
55
+ * }
56
+ * ```
57
+ */
58
+ export declare function acquireWorkspaceLock(repoPath: string, workspace: string, options?: AcquireLockOptions): Promise<WorkspaceLockHandle>;
59
+ /**
60
+ * Check if a workspace is currently locked.
61
+ *
62
+ * @param repoPath - Path to .e3 repository
63
+ * @param workspace - Workspace name to check
64
+ * @returns Lock holder info if locked, null if not locked
65
+ */
66
+ export declare function getWorkspaceLockHolder(repoPath: string, workspace: string): Promise<LockHolder | null>;
67
+ //# sourceMappingURL=workspaceLock.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"workspaceLock.d.ts","sourceRoot":"","sources":["../../src/workspaceLock.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAmBH,OAAO,EAAsB,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AAOlE;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,0CAA0C;IAC1C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,4BAA4B;IAC5B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,qDAAqD;IACrD,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAcD;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAE7E;AAgCD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAsB,oBAAoB,CACxC,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,mBAAmB,CAAC,CAiD9B;AAsFD;;;;;;GAMG;AACH,wBAAsB,sBAAsB,CAC1C,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAoB5B"}
@@ -0,0 +1,217 @@
1
+ /**
2
+ * Copyright (c) 2025 Elara AI Pty Ltd
3
+ * Licensed under BSL 1.1. See LICENSE for details.
4
+ */
5
+ /**
6
+ * Workspace locking for safe concurrent access.
7
+ *
8
+ * Provides exclusive locks on workspaces to prevent concurrent dataflow
9
+ * executions or writes that could corrupt workspace state. Uses Linux
10
+ * flock() for automatic lock release on process death.
11
+ *
12
+ * Lock mechanism:
13
+ * - Uses flock(LOCK_EX | LOCK_NB) via the `flock` command for kernel-managed locking
14
+ * - Lock is automatically released when the process dies (kernel handles this)
15
+ * - Metadata (PID, bootId, startTime) written to lock file for diagnostics
16
+ * - Stale lock detection via bootId comparison (handles system restarts)
17
+ */
18
+ import * as fs from 'fs/promises';
19
+ import * as path from 'path';
20
+ import { spawn } from 'child_process';
21
+ import { WorkspaceLockError } from './errors.js';
22
+ import { getBootId, getPidStartTime, isProcessAlive } from './executions.js';
23
+ /**
24
+ * Get the lock file path for a workspace.
25
+ */
26
+ export function workspaceLockPath(repoPath, workspace) {
27
+ return path.join(repoPath, 'workspaces', `${workspace}.lock`);
28
+ }
29
+ /**
30
+ * Read lock metadata from a lock file.
31
+ * Returns null if file doesn't exist or is invalid.
32
+ */
33
+ async function readLockMetadata(lockPath) {
34
+ try {
35
+ const data = await fs.readFile(lockPath, 'utf-8');
36
+ return JSON.parse(data);
37
+ }
38
+ catch {
39
+ return null;
40
+ }
41
+ }
42
+ /**
43
+ * Convert internal metadata to public LockHolder interface.
44
+ */
45
+ function metadataToHolder(metadata) {
46
+ return {
47
+ pid: metadata.pid,
48
+ acquiredAt: metadata.acquiredAt,
49
+ bootId: metadata.bootId,
50
+ startTime: metadata.startTime,
51
+ command: metadata.command,
52
+ };
53
+ }
54
+ // =============================================================================
55
+ // Lock Acquisition
56
+ // =============================================================================
57
+ /**
58
+ * Acquire an exclusive lock on a workspace.
59
+ *
60
+ * Uses Linux flock() for kernel-managed locking. The lock is automatically
61
+ * released when the process exits (even on crash/kill).
62
+ *
63
+ * @param repoPath - Path to .e3 repository
64
+ * @param workspace - Workspace name to lock
65
+ * @param options - Lock acquisition options
66
+ * @returns Lock handle - call release() when done
67
+ * @throws {WorkspaceLockError} If workspace is locked by another process
68
+ *
69
+ * @example
70
+ * ```typescript
71
+ * const lock = await acquireWorkspaceLock(repoPath, 'production');
72
+ * try {
73
+ * await dataflowExecute(repoPath, 'production', { lock });
74
+ * } finally {
75
+ * await lock.release();
76
+ * }
77
+ * ```
78
+ */
79
+ export async function acquireWorkspaceLock(repoPath, workspace, options = {}) {
80
+ const lockPath = workspaceLockPath(repoPath, workspace);
81
+ // Ensure workspaces directory exists
82
+ await fs.mkdir(path.dirname(lockPath), { recursive: true });
83
+ // Gather our process identification
84
+ const pid = process.pid;
85
+ const bootId = await getBootId();
86
+ const startTime = await getPidStartTime(pid);
87
+ const command = process.argv.join(' ');
88
+ const acquiredAt = new Date().toISOString();
89
+ const metadata = { pid, bootId, startTime, acquiredAt, command };
90
+ // Try to acquire flock via subprocess
91
+ // The subprocess holds the lock and we communicate with it via stdin/signals
92
+ const flockProcess = await tryAcquireFlock(lockPath, metadata, options);
93
+ if (!flockProcess) {
94
+ // Failed to acquire - read metadata to report who has it
95
+ const existingMetadata = await readLockMetadata(lockPath);
96
+ const holder = existingMetadata ? metadataToHolder(existingMetadata) : undefined;
97
+ throw new WorkspaceLockError(workspace, holder);
98
+ }
99
+ // Lock acquired! Create handle
100
+ let released = false;
101
+ const handle = {
102
+ workspace,
103
+ lockPath,
104
+ async release() {
105
+ if (released)
106
+ return;
107
+ released = true;
108
+ // Kill the flock subprocess to release the lock
109
+ flockProcess.kill('SIGTERM');
110
+ // Clean up lock file (best effort)
111
+ try {
112
+ await fs.unlink(lockPath);
113
+ }
114
+ catch {
115
+ // Ignore - file might already be gone
116
+ }
117
+ },
118
+ };
119
+ return handle;
120
+ }
121
+ /**
122
+ * Try to acquire flock using a subprocess.
123
+ *
124
+ * We spawn `flock --nonblock <lockfile> cat` which:
125
+ * 1. Tries to acquire exclusive lock (non-blocking)
126
+ * 2. If successful, runs `cat` which blocks reading stdin forever
127
+ * 3. We keep the subprocess alive to hold the lock
128
+ * 4. When we kill the subprocess, the lock is released
129
+ *
130
+ * Returns the subprocess if lock acquired, null if lock is held by another.
131
+ */
132
+ async function tryAcquireFlock(lockPath, metadata, options) {
133
+ // First, check if there's a stale lock we can clean up
134
+ await checkAndCleanStaleLock(lockPath);
135
+ const args = options.wait
136
+ ? ['--timeout', String((options.timeout ?? 30000) / 1000), lockPath, 'cat']
137
+ : ['--nonblock', lockPath, 'cat'];
138
+ const child = spawn('flock', args, {
139
+ stdio: ['pipe', 'pipe', 'pipe'],
140
+ detached: false,
141
+ });
142
+ return new Promise((resolve) => {
143
+ let resolved = false;
144
+ // If flock fails to acquire, it exits with code 1
145
+ child.on('error', () => {
146
+ if (!resolved) {
147
+ resolved = true;
148
+ resolve(null);
149
+ }
150
+ });
151
+ child.on('exit', () => {
152
+ if (!resolved) {
153
+ resolved = true;
154
+ // Exit code 1 means lock is held by another
155
+ resolve(null);
156
+ }
157
+ });
158
+ // Give flock a moment to either acquire or fail
159
+ // If it's still running after 100ms, we have the lock
160
+ setTimeout(() => {
161
+ if (!resolved && !child.killed && child.exitCode === null) {
162
+ resolved = true;
163
+ // Write metadata to lock file now that we have the lock
164
+ // Use void to explicitly ignore the promise (metadata is informational only)
165
+ void fs.writeFile(lockPath, JSON.stringify(metadata, null, 2)).catch(() => { });
166
+ resolve(child);
167
+ }
168
+ }, 100);
169
+ });
170
+ }
171
+ /**
172
+ * Check if a lock file exists with stale metadata and clean it up.
173
+ * A lock is stale if the holder process no longer exists.
174
+ */
175
+ async function checkAndCleanStaleLock(lockPath) {
176
+ const metadata = await readLockMetadata(lockPath);
177
+ if (!metadata)
178
+ return;
179
+ // Check if the process that created this lock is still alive
180
+ const alive = await isProcessAlive(metadata.pid, metadata.startTime, metadata.bootId);
181
+ if (!alive) {
182
+ // Stale lock - try to remove it
183
+ try {
184
+ await fs.unlink(lockPath);
185
+ }
186
+ catch {
187
+ // Ignore - another process might have cleaned it up
188
+ }
189
+ }
190
+ }
191
+ /**
192
+ * Check if a workspace is currently locked.
193
+ *
194
+ * @param repoPath - Path to .e3 repository
195
+ * @param workspace - Workspace name to check
196
+ * @returns Lock holder info if locked, null if not locked
197
+ */
198
+ export async function getWorkspaceLockHolder(repoPath, workspace) {
199
+ const lockPath = workspaceLockPath(repoPath, workspace);
200
+ const metadata = await readLockMetadata(lockPath);
201
+ if (!metadata)
202
+ return null;
203
+ // Check if the holder is still alive
204
+ const alive = await isProcessAlive(metadata.pid, metadata.startTime, metadata.bootId);
205
+ if (!alive) {
206
+ // Stale lock - clean it up and report as not locked
207
+ try {
208
+ await fs.unlink(lockPath);
209
+ }
210
+ catch {
211
+ // Ignore
212
+ }
213
+ return null;
214
+ }
215
+ return metadataToHolder(metadata);
216
+ }
217
+ //# sourceMappingURL=workspaceLock.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"workspaceLock.js","sourceRoot":"","sources":["../../src/workspaceLock.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,KAAK,EAAqB,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAmB,MAAM,aAAa,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AA8C7E;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,QAAgB,EAAE,SAAiB;IACnE,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,EAAE,GAAG,SAAS,OAAO,CAAC,CAAC;AAChE,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,gBAAgB,CAAC,QAAgB;IAC9C,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAiB,CAAC;IAC1C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,gBAAgB,CAAC,QAAsB;IAC9C,OAAO;QACL,GAAG,EAAE,QAAQ,CAAC,GAAG;QACjB,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,SAAS,EAAE,QAAQ,CAAC,SAAS;QAC7B,OAAO,EAAE,QAAQ,CAAC,OAAO;KAC1B,CAAC;AACJ,CAAC;AAED,gFAAgF;AAChF,mBAAmB;AACnB,gFAAgF;AAEhF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,QAAgB,EAChB,SAAiB,EACjB,UAA8B,EAAE;IAEhC,MAAM,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAExD,qCAAqC;IACrC,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAE5D,oCAAoC;IACpC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IACxB,MAAM,MAAM,GAAG,MAAM,SAAS,EAAE,CAAC;IACjC,MAAM,SAAS,GAAG,MAAM,eAAe,CAAC,GAAG,CAAC,CAAC;IAC7C,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvC,MAAM,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAE5C,MAAM,QAAQ,GAAiB,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;IAE/E,sCAAsC;IACtC,6EAA6E;IAC7E,MAAM,YAAY,GAAG,MAAM,eAAe,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAExE,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,yDAAyD;QACzD,MAAM,gBAAgB,GAAG,MAAM,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,gBAAgB,CAAC,CAAC,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACjF,MAAM,IAAI,kBAAkB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED,+BAA+B;IAC/B,IAAI,QAAQ,GAAG,KAAK,CAAC;IAErB,MAAM,MAAM,GAAwB;QAClC,SAAS;QACT,QAAQ;QACR,KAAK,CAAC,OAAO;YACX,IAAI,QAAQ;gBAAE,OAAO;YACrB,QAAQ,GAAG,IAAI,CAAC;YAEhB,gDAAgD;YAChD,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAE7B,mCAAmC;YACnC,IAAI,CAAC;gBACH,MAAM,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC5B,CAAC;YAAC,MAAM,CAAC;gBACP,sCAAsC;YACxC,CAAC;QACH,CAAC;KACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,eAAe,CAC5B,QAAgB,EAChB,QAAsB,EACtB,OAA2B;IAE3B,uDAAuD;IACvD,MAAM,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAEvC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI;QACvB,CAAC,CAAC,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC;QAC3E,CAAC,CAAC,CAAC,YAAY,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IAEpC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE;QACjC,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;QAC/B,QAAQ,EAAE,KAAK;KAChB,CAAC,CAAC;IAEH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,IAAI,QAAQ,GAAG,KAAK,CAAC;QAErB,kDAAkD;QAClD,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACrB,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,QAAQ,GAAG,IAAI,CAAC;gBAChB,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;YACpB,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,QAAQ,GAAG,IAAI,CAAC;gBAChB,4CAA4C;gBAC5C,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,gDAAgD;QAChD,sDAAsD;QACtD,UAAU,CAAC,GAAG,EAAE;YACd,IAAI,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;gBAC1D,QAAQ,GAAG,IAAI,CAAC;gBAEhB,wDAAwD;gBACxD,6EAA6E;gBAC7E,KAAK,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;gBAE/E,OAAO,CAAC,KAAK,CAAC,CAAC;YACjB,CAAC;QACH,CAAC,EAAE,GAAG,CAAC,CAAC;IACV,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,sBAAsB,CAAC,QAAgB;IACpD,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAClD,IAAI,CAAC,QAAQ;QAAE,OAAO;IAEtB,6DAA6D;IAC7D,MAAM,KAAK,GAAG,MAAM,cAAc,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAEtF,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,gCAAgC;QAChC,IAAI,CAAC;YACH,MAAM,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC5B,CAAC;QAAC,MAAM,CAAC;YACP,oDAAoD;QACtD,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,QAAgB,EAChB,SAAiB;IAEjB,MAAM,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACxD,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAElD,IAAI,CAAC,QAAQ;QAAE,OAAO,IAAI,CAAC;IAE3B,qCAAqC;IACrC,MAAM,KAAK,GAAG,MAAM,cAAc,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAEtF,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,oDAAoD;QACpD,IAAI,CAAC;YACH,MAAM,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC5B,CAAC;QAAC,MAAM,CAAC;YACP,SAAS;QACX,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,gBAAgB,CAAC,QAAQ,CAAC,CAAC;AACpC,CAAC"}
@@ -0,0 +1,126 @@
1
+ /**
2
+ * Copyright (c) 2025 Elara AI Pty Ltd
3
+ * Licensed under BSL 1.1. See LICENSE for details.
4
+ */
5
+ import { type LockHolder } from './errors.js';
6
+ /**
7
+ * Status of a dataset in the workspace.
8
+ */
9
+ export type DatasetStatus = {
10
+ type: 'unset';
11
+ } | {
12
+ type: 'stale';
13
+ } | {
14
+ type: 'up-to-date';
15
+ };
16
+ /**
17
+ * Status of a task in the workspace.
18
+ */
19
+ export type TaskStatus = {
20
+ type: 'up-to-date';
21
+ cached: boolean;
22
+ } | {
23
+ type: 'ready';
24
+ } | {
25
+ type: 'waiting';
26
+ reason: string;
27
+ } | {
28
+ type: 'in-progress';
29
+ pid?: number;
30
+ startedAt?: string;
31
+ } | {
32
+ type: 'failed';
33
+ exitCode: number;
34
+ completedAt?: string;
35
+ } | {
36
+ type: 'error';
37
+ message: string;
38
+ completedAt?: string;
39
+ } | {
40
+ type: 'stale-running';
41
+ pid?: number;
42
+ startedAt?: string;
43
+ };
44
+ /**
45
+ * Information about a dataset in the status report.
46
+ */
47
+ export interface DatasetStatusInfo {
48
+ /** Dataset path (e.g., "inputs.sales_data") */
49
+ path: string;
50
+ /** Current status */
51
+ status: DatasetStatus;
52
+ /** Hash of current value (if set) */
53
+ hash: string | null;
54
+ /** True if this is a task output */
55
+ isTaskOutput: boolean;
56
+ /** Name of task that produces this (if any) */
57
+ producedBy: string | null;
58
+ }
59
+ /**
60
+ * Information about a task in the status report.
61
+ */
62
+ export interface TaskStatusInfo {
63
+ /** Task name */
64
+ name: string;
65
+ /** Task hash */
66
+ hash: string;
67
+ /** Current status */
68
+ status: TaskStatus;
69
+ /** Input dataset paths */
70
+ inputs: string[];
71
+ /** Output dataset path */
72
+ output: string;
73
+ /** Tasks this one depends on */
74
+ dependsOn: string[];
75
+ }
76
+ /**
77
+ * Complete workspace status report.
78
+ */
79
+ export interface WorkspaceStatusResult {
80
+ /** Workspace name */
81
+ workspace: string;
82
+ /** Lock status - null if not locked */
83
+ lock: LockHolder | null;
84
+ /** Status of all datasets */
85
+ datasets: DatasetStatusInfo[];
86
+ /** Status of all tasks */
87
+ tasks: TaskStatusInfo[];
88
+ /** Summary counts */
89
+ summary: {
90
+ datasets: {
91
+ total: number;
92
+ unset: number;
93
+ stale: number;
94
+ upToDate: number;
95
+ };
96
+ tasks: {
97
+ total: number;
98
+ upToDate: number;
99
+ ready: number;
100
+ waiting: number;
101
+ inProgress: number;
102
+ failed: number;
103
+ error: number;
104
+ staleRunning: number;
105
+ };
106
+ };
107
+ }
108
+ /**
109
+ * Get comprehensive status of a workspace.
110
+ *
111
+ * Performs a dry-run analysis of the workspace to determine:
112
+ * - Whether the workspace is locked (and by whom)
113
+ * - Status of each dataset (unset, stale, up-to-date)
114
+ * - Status of each task (up-to-date, ready, waiting, in-progress)
115
+ *
116
+ * This is a read-only operation that does not modify workspace state
117
+ * and does not require acquiring a lock.
118
+ *
119
+ * @param repoPath - Path to .e3 repository
120
+ * @param ws - Workspace name
121
+ * @returns Complete status report
122
+ * @throws {WorkspaceNotFoundError} If workspace doesn't exist
123
+ * @throws {WorkspaceNotDeployedError} If workspace has no package deployed
124
+ */
125
+ export declare function workspaceStatus(repoPath: string, ws: string): Promise<WorkspaceStatusResult>;
126
+ //# sourceMappingURL=workspaceStatus.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"workspaceStatus.d.ts","sourceRoot":"","sources":["../../src/workspaceStatus.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA6BH,OAAO,EAIL,KAAK,UAAU,EAChB,MAAM,aAAa,CAAC;AASrB;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GACjB;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GACjB;IAAE,IAAI,EAAE,YAAY,CAAA;CAAE,CAAC;AAE3B;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,GACvC;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GACjB;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACnC;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GACzD;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAC1D;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GACxD;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,+CAA+C;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,MAAM,EAAE,aAAa,CAAC;IACtB,qCAAqC;IACrC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,oCAAoC;IACpC,YAAY,EAAE,OAAO,CAAC;IACtB,+CAA+C;IAC/C,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,MAAM,EAAE,UAAU,CAAC;IACnB,0BAA0B;IAC1B,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,qBAAqB;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,uCAAuC;IACvC,IAAI,EAAE,UAAU,GAAG,IAAI,CAAC;IACxB,6BAA6B;IAC7B,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B,0BAA0B;IAC1B,KAAK,EAAE,cAAc,EAAE,CAAC;IACxB,qBAAqB;IACrB,OAAO,EAAE;QACP,QAAQ,EAAE;YACR,KAAK,EAAE,MAAM,CAAC;YACd,KAAK,EAAE,MAAM,CAAC;YACd,KAAK,EAAE,MAAM,CAAC;YACd,QAAQ,EAAE,MAAM,CAAC;SAClB,CAAC;QACF,KAAK,EAAE;YACL,KAAK,EAAE,MAAM,CAAC;YACd,QAAQ,EAAE,MAAM,CAAC;YACjB,KAAK,EAAE,MAAM,CAAC;YACd,OAAO,EAAE,MAAM,CAAC;YAChB,UAAU,EAAE,MAAM,CAAC;YACnB,MAAM,EAAE,MAAM,CAAC;YACf,KAAK,EAAE,MAAM,CAAC;YACd,YAAY,EAAE,MAAM,CAAC;SACtB,CAAC;KACH,CAAC;CACH;AA8CD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,eAAe,CACnC,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,MAAM,GACT,OAAO,CAAC,qBAAqB,CAAC,CA8JhC"}