@runtimed/node 0.5.5 → 0.5.6-nightly.36546986351
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 +148 -5
- package/package.json +24 -11
- package/src/binding.cjs +53 -52
- package/src/binding.d.ts +39 -2
- package/src/execution-store.cjs +397 -0
- package/src/execution-store.d.cts +66 -0
- package/src/index.d.ts +52 -43
- package/src/relay.d.ts +10 -1
- package/src/session.cjs +8 -68
package/README.md
CHANGED
|
@@ -52,6 +52,48 @@ through the same local daemon used by nteract desktop.
|
|
|
52
52
|
|
|
53
53
|
## Embedding a notebook frontend
|
|
54
54
|
|
|
55
|
+
### Explicit project manifest creation
|
|
56
|
+
|
|
57
|
+
The local Node host can create a missing `environment.yml` after the user or
|
|
58
|
+
host explicitly requests it. Supply an existing absolute directory and the
|
|
59
|
+
desired Conda specs; opening a notebook never calls this helper automatically.
|
|
60
|
+
|
|
61
|
+
```js
|
|
62
|
+
const { initializeEnvironmentYml } = require("@runtimed/node");
|
|
63
|
+
|
|
64
|
+
const manifestPath = await initializeEnvironmentYml({
|
|
65
|
+
directory: "/absolute/path/to/project",
|
|
66
|
+
name: "analysis",
|
|
67
|
+
python: ">=3.11,<3.13",
|
|
68
|
+
dependencies: ["numpy>=2,<3", "pandas"],
|
|
69
|
+
channels: ["conda-forge"],
|
|
70
|
+
});
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
The helper validates the manifest with the same parser as daemon discovery,
|
|
74
|
+
then publishes the complete file without replacing an existing file or symlink.
|
|
75
|
+
The helper checks for an existing `environment.yaml` before creating anything.
|
|
76
|
+
Hosts must coordinate with other writers creating that alternate filename; only
|
|
77
|
+
publication of `environment.yml` itself is atomic. On Unix, new manifest
|
|
78
|
+
permissions honor the host process's umask.
|
|
79
|
+
It rejects invalid specs and missing/unwritable directories. The name is optional;
|
|
80
|
+
channel priority follows the supplied array. Python can be specified in `python`
|
|
81
|
+
or `dependencies`, but not both. This initializer supports Conda dependencies;
|
|
82
|
+
pip subsections and other manifest formats remain separate work.
|
|
83
|
+
|
|
84
|
+
This is a local filesystem operation for a host process that already has write
|
|
85
|
+
authority over the chosen directory. It is not exposed by the Electron renderer
|
|
86
|
+
bridge or a remote notebook request. It does not contact the daemon, install
|
|
87
|
+
packages, approve environment trust, or launch/change a running kernel.
|
|
88
|
+
|
|
89
|
+
Open or reopen a notebook in that directory to use normal project discovery.
|
|
90
|
+
Existing project precedence still applies (`pyproject.toml`, `pixi.toml`, then
|
|
91
|
+
`environment.yml`). Installing an environment and launching a kernel use the
|
|
92
|
+
usual explicit launch and approval flow. Creation does not change the environment
|
|
93
|
+
of a notebook that is already running.
|
|
94
|
+
|
|
95
|
+
### Notebook relay
|
|
96
|
+
|
|
55
97
|
`@runtimed/node/relay` exposes the native byte pipe used by desktop notebook
|
|
56
98
|
hosts. The browser/WASM frontend remains the Automerge peer; Node owns the
|
|
57
99
|
daemon socket, handshake, framing, and liveness heartbeat and forwards opaque
|
|
@@ -75,17 +117,22 @@ Hosts that supervise the daemon can use `defaultSocketPath()`,
|
|
|
75
117
|
`socketPathForChannel("stable" | "nightly")`, and
|
|
76
118
|
`queryDaemonInfo({ socketPath })` from the same subpath. The explicit channel
|
|
77
119
|
resolver is useful when the host's release channel differs from the package's
|
|
78
|
-
compile-time default. The query returns `null`
|
|
79
|
-
|
|
80
|
-
|
|
120
|
+
compile-time default. The query returns `null` when metadata is unavailable,
|
|
121
|
+
including absent or unready endpoints and older daemons that cannot answer the
|
|
122
|
+
query. A responding daemon returns `protocolVersion`, `daemonApiVersion`, and
|
|
123
|
+
an optional `compatibilityError` computed by the shared Rust client checker.
|
|
124
|
+
The semantic API version is zero when the daemon does not report it. Hosts can
|
|
125
|
+
surface the diagnostic without duplicating supported-version policy in JavaScript;
|
|
126
|
+
the probe never starts or replaces a daemon.
|
|
81
127
|
|
|
82
128
|
`RelaySession.info.daemonVersion` is the identity carried by that notebook's
|
|
83
129
|
exact handshake. It is intentionally left undefined when an older daemon omits
|
|
84
130
|
it rather than being filled from a later pool query, which could race a daemon
|
|
85
131
|
restart. Treat that artifact version as diagnostic metadata. Compatibility is
|
|
86
132
|
determined by the negotiated protocol number and, for optional semantics, the
|
|
87
|
-
capabilities advertised by the connection.
|
|
88
|
-
|
|
133
|
+
capabilities advertised by the connection. The pool probe is a compatibility
|
|
134
|
+
preflight and diagnostic, not authentication or proof about a later notebook
|
|
135
|
+
connection: the daemon can change between the probe and that connection.
|
|
89
136
|
|
|
90
137
|
Frames include the one-byte notebook frame discriminator and omit the daemon
|
|
91
138
|
socket's length prefix; an empty buffer is not a frame and is rejected. The
|
|
@@ -258,6 +305,15 @@ sessions.
|
|
|
258
305
|
and startup error details.
|
|
259
306
|
- `Session.syncEnvironment()` installs recorded notebook dependencies.
|
|
260
307
|
- `Session.saveNotebook(path?)` saves the notebook.
|
|
308
|
+
- `Session.confirmNotebookSync()` returns the current NotebookDoc heads after
|
|
309
|
+
the connected local daemon accepts them. Later edits are outside that receipt.
|
|
310
|
+
Timeout, close, disconnect, rejected edits, and unsupported daemons reject the
|
|
311
|
+
promise; there is no best-effort fallback. A missing handshake capability
|
|
312
|
+
rejects before sending a request, leaving older daemon sessions usable.
|
|
313
|
+
Persistent local rooms journal edits
|
|
314
|
+
before acknowledging them, while ephemeral rooms promise acceptance only.
|
|
315
|
+
This does not export an `.ipynb`, acknowledge other document streams, or confirm
|
|
316
|
+
hosted persistence. Hosted bridge rooms currently reject this operation.
|
|
261
317
|
- `Session.close()` releases the daemon connection.
|
|
262
318
|
|
|
263
319
|
## Daemon Requirements
|
|
@@ -295,5 +351,92 @@ installed through `@runtimed/node`:
|
|
|
295
351
|
|
|
296
352
|
- `@runtimed/node-darwin-arm64`
|
|
297
353
|
- `@runtimed/node-linux-x64-gnu`
|
|
354
|
+
- `@runtimed/node-linux-arm64-gnu` (publication requires the bootstrap described in `RELEASING.md`)
|
|
355
|
+
- `@runtimed/node-win32-x64-msvc`
|
|
356
|
+
- `@runtimed/node-win32-arm64-msvc`
|
|
298
357
|
|
|
299
358
|
They contain only the compiled native `.node` binary for their target platform.
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
### Shared execution state
|
|
362
|
+
|
|
363
|
+
Each `Session` owns `session.executions`, the same synchronous execution-store
|
|
364
|
+
implementation used by the React frontend. Native execution changesets update
|
|
365
|
+
this store before `executionViewChanges$` emits. Command APIs and pi's existing
|
|
366
|
+
changeset subscription are unchanged. Construction adds no readiness promise,
|
|
367
|
+
transport, timer, or WASM instance.
|
|
368
|
+
|
|
369
|
+
```js
|
|
370
|
+
const store = session.executions;
|
|
371
|
+
const unsubscribe = store.subscribeExecutionById(executionId)(() => {
|
|
372
|
+
console.log(store.getExecutionById(executionId));
|
|
373
|
+
});
|
|
374
|
+
console.log(store.getExecutionById(executionId)); // initial read
|
|
375
|
+
// Later:
|
|
376
|
+
unsubscribe();
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
`getExecutionView()` now returns a cached, immutable snapshot, not a mutable
|
|
380
|
+
copy. Entity snapshots and output-ID arrays are owned and frozen by the store;
|
|
381
|
+
unchanged output membership retains its array identity. Make an explicit copy
|
|
382
|
+
if mutable data is needed. Retained snapshots do not change after later events.
|
|
383
|
+
Removing an execution also clears its current cell pointer, even if its snapshot
|
|
384
|
+
has not arrived. An explicit queue update without a notebook projection clears
|
|
385
|
+
the notebook queue; an absent queue field leaves it unchanged.
|
|
386
|
+
`setNotebookQueueProjection()` updates the notebook projection in an existing
|
|
387
|
+
aggregate queue before notifying subscribers. Before any runtime queue arrives,
|
|
388
|
+
the aggregate queue stays `null`; a cell-only projection cannot infer execution
|
|
389
|
+
queue membership.
|
|
390
|
+
|
|
391
|
+
Subscriptions invalidate synchronously per write. A changeset is applied in
|
|
392
|
+
upsert, removal, pointer, then queue order; it is not one atomic notification.
|
|
393
|
+
Listeners added during delivery begin on a subsequent notification, unsubscribed
|
|
394
|
+
listeners are skipped, and listener errors do not stop other listeners.
|
|
395
|
+
Unsubscribe functions are idempotent, including when the same callback is later
|
|
396
|
+
registered again.
|
|
397
|
+
`close()` disposes native subscriptions and completes the RxJS streams; owners
|
|
398
|
+
must release their store subscriptions too. The last state remains readable.
|
|
399
|
+
|
|
400
|
+
The implementation source is `packages/runtimed/src/execution-store.ts`.
|
|
401
|
+
`build:stores` generates this package's CommonJS module and declarations;
|
|
402
|
+
`check:stores` checks freshness and runs before packing. The published package
|
|
403
|
+
does not depend on the private TypeScript workspace package.
|
|
404
|
+
|
|
405
|
+
A small framework-neutral readable adapter in
|
|
406
|
+
`packages/runtimed/examples/execution-readable.ts` demonstrates Svelte's initial
|
|
407
|
+
value and unsubscribe contract. It wraps the same instance and holds no second
|
|
408
|
+
copy of notebook state. Cells, output content, and a complete Svelte shell are
|
|
409
|
+
separate follow-ups.
|
|
410
|
+
|
|
411
|
+
### Session status
|
|
412
|
+
|
|
413
|
+
`session.sessionStatus$` forwards the native `SyncStatus` JSON unchanged.
|
|
414
|
+
`connection` is `"Connected"` or `"Disconnected"`; `notebook_doc` is `"Pending"`,
|
|
415
|
+
`"Syncing"`, or `"Interactive"`; `runtime_state` is `"Pending"`, `"Syncing"`, or
|
|
416
|
+
`"Ready"`. `initial_load` is `"NotNeeded"`, `"Streaming"`, `"Ready"`, or
|
|
417
|
+
`{ Failed: { reason: string } }`. These are case-sensitive values, distinct
|
|
418
|
+
from the session-control wire representation. Subscribe to detect connection
|
|
419
|
+
loss and bootstrap failures; `close()` completes the stream.
|
|
420
|
+
Callers using the earlier lowercase declarations or `initial_load.phase` must
|
|
421
|
+
update their comparisons to these native values; runtime serialization is unchanged.
|
|
422
|
+
|
|
423
|
+
### Native session verification
|
|
424
|
+
|
|
425
|
+
Build the native binding and daemon, then run the callback and shared-store
|
|
426
|
+
contract against an isolated daemon without a Python kernel:
|
|
427
|
+
|
|
428
|
+
```bash
|
|
429
|
+
pnpm --dir packages/runtimed-node build:debug
|
|
430
|
+
pnpm --dir packages/runtimed-node typecheck:contracts
|
|
431
|
+
cargo xtask artifacts ensure runtime,sift,renderer
|
|
432
|
+
cargo build -p runtimed
|
|
433
|
+
RUNTIMED_NODE_NATIVE_INTEGRATION=1 \
|
|
434
|
+
pnpm test:run packages/runtimed-node/tests/native-session.test.ts
|
|
435
|
+
```
|
|
436
|
+
|
|
437
|
+
Add `RUNTIMED_NODE_EXECUTION_INTEGRATION=1` to exercise Python execution,
|
|
438
|
+
reruns, progress callbacks, and retained snapshots too. This creates a notebook
|
|
439
|
+
environment with `ipykernel` and may download Python packages. The suite starts
|
|
440
|
+
and stops its own daemon and disables background environment pools.
|
|
441
|
+
CI runs this Python execution and recovery coverage in a separate step with both
|
|
442
|
+
flags enabled.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@runtimed/node",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.6-nightly.36546986351",
|
|
4
4
|
"description": "Node.js bindings for controlling nteract runtimed notebooks and Python kernels.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "BSD-3-Clause",
|
|
@@ -53,38 +53,51 @@
|
|
|
53
53
|
"src/session.cjs",
|
|
54
54
|
"src/napi-observables.cjs",
|
|
55
55
|
"src/binding.cjs",
|
|
56
|
-
"src/binding.d.ts"
|
|
56
|
+
"src/binding.d.ts",
|
|
57
|
+
"src/execution-store.cjs",
|
|
58
|
+
"src/execution-store.d.cts"
|
|
57
59
|
],
|
|
58
60
|
"napi": {
|
|
59
61
|
"binaryName": "runtimed-node",
|
|
60
62
|
"targets": [
|
|
61
63
|
"aarch64-apple-darwin",
|
|
62
64
|
"x86_64-unknown-linux-gnu",
|
|
63
|
-
"
|
|
65
|
+
"aarch64-unknown-linux-gnu",
|
|
66
|
+
"x86_64-pc-windows-msvc",
|
|
67
|
+
"aarch64-pc-windows-msvc"
|
|
64
68
|
]
|
|
65
69
|
},
|
|
66
70
|
"dependencies": {
|
|
67
71
|
"rxjs": "^7.8.2"
|
|
68
72
|
},
|
|
69
73
|
"optionalDependencies": {
|
|
70
|
-
"@runtimed/node-darwin-arm64": "0.5.
|
|
71
|
-
"@runtimed/node-linux-x64-gnu": "0.5.
|
|
72
|
-
"@runtimed/node-win32-x64-msvc": "0.5.
|
|
74
|
+
"@runtimed/node-darwin-arm64": "0.5.6-nightly.36546986351",
|
|
75
|
+
"@runtimed/node-linux-x64-gnu": "0.5.6-nightly.36546986351",
|
|
76
|
+
"@runtimed/node-win32-x64-msvc": "0.5.6-nightly.36546986351"
|
|
73
77
|
},
|
|
74
78
|
"publishConfig": {
|
|
75
79
|
"access": "public"
|
|
76
80
|
},
|
|
77
81
|
"devDependencies": {
|
|
78
|
-
"@napi-rs/cli": "^3.6.2"
|
|
82
|
+
"@napi-rs/cli": "^3.6.2",
|
|
83
|
+
"typescript": "~5.8.3"
|
|
84
|
+
},
|
|
85
|
+
"nteractRelease": {
|
|
86
|
+
"channel": "nightly",
|
|
87
|
+
"sourceSha": "d6959be66205165cb1d422d29fbf9b54a3b80d54",
|
|
88
|
+
"runId": "36546986351"
|
|
79
89
|
},
|
|
80
90
|
"scripts": {
|
|
81
91
|
"assemble:platform": "node scripts/assemble-platform-package.mjs",
|
|
82
|
-
"build": "napi build --platform --release --js binding.cjs --dts binding.d.ts --manifest-path ../../crates/runtimed-node/Cargo.toml --output-dir src",
|
|
83
|
-
"build:debug": "napi build --platform --js binding.cjs --dts binding.d.ts --manifest-path ../../crates/runtimed-node/Cargo.toml --output-dir src",
|
|
92
|
+
"build": "pnpm build:stores && napi build --platform --release --js binding.cjs --dts binding.d.ts --manifest-path ../../crates/runtimed-node/Cargo.toml --output-dir src",
|
|
93
|
+
"build:debug": "pnpm build:stores && napi build --platform --js binding.cjs --dts binding.d.ts --manifest-path ../../crates/runtimed-node/Cargo.toml --output-dir src",
|
|
84
94
|
"pack:platform:dry-run": "node scripts/assemble-platform-package.mjs --pack-dry-run",
|
|
85
95
|
"pack:dry-run": "pnpm pack --dry-run",
|
|
86
96
|
"smoke": "node -e \"const m = require('./src/index.cjs'); console.log('defaultSocketPath:', m.defaultSocketPath());\"",
|
|
87
97
|
"smoke:relay": "node scripts/smoke-relay.cjs",
|
|
88
|
-
"smoke:api": "node scripts/smoke-api.cjs"
|
|
98
|
+
"smoke:api": "node scripts/smoke-api.cjs",
|
|
99
|
+
"build:stores": "node scripts/build-execution-store.mjs",
|
|
100
|
+
"typecheck:contracts": "tsc --project tsconfig.contracts.json",
|
|
101
|
+
"check:stores": "node scripts/build-execution-store.mjs --check"
|
|
89
102
|
}
|
|
90
|
-
}
|
|
103
|
+
}
|
package/src/binding.cjs
CHANGED
|
@@ -77,8 +77,8 @@ function requireNative() {
|
|
|
77
77
|
try {
|
|
78
78
|
const binding = require('@runtimed/node-android-arm64')
|
|
79
79
|
const bindingPackageVersion = require('@runtimed/node-android-arm64/package.json').version
|
|
80
|
-
if (bindingPackageVersion !== '0.5.
|
|
81
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
80
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
81
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
82
82
|
}
|
|
83
83
|
return binding
|
|
84
84
|
} catch (e) {
|
|
@@ -93,8 +93,8 @@ function requireNative() {
|
|
|
93
93
|
try {
|
|
94
94
|
const binding = require('@runtimed/node-android-arm-eabi')
|
|
95
95
|
const bindingPackageVersion = require('@runtimed/node-android-arm-eabi/package.json').version
|
|
96
|
-
if (bindingPackageVersion !== '0.5.
|
|
97
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
96
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
97
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
98
98
|
}
|
|
99
99
|
return binding
|
|
100
100
|
} catch (e) {
|
|
@@ -114,8 +114,8 @@ function requireNative() {
|
|
|
114
114
|
try {
|
|
115
115
|
const binding = require('@runtimed/node-win32-x64-gnu')
|
|
116
116
|
const bindingPackageVersion = require('@runtimed/node-win32-x64-gnu/package.json').version
|
|
117
|
-
if (bindingPackageVersion !== '0.5.
|
|
118
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
117
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
118
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
119
119
|
}
|
|
120
120
|
return binding
|
|
121
121
|
} catch (e) {
|
|
@@ -130,8 +130,8 @@ function requireNative() {
|
|
|
130
130
|
try {
|
|
131
131
|
const binding = require('@runtimed/node-win32-x64-msvc')
|
|
132
132
|
const bindingPackageVersion = require('@runtimed/node-win32-x64-msvc/package.json').version
|
|
133
|
-
if (bindingPackageVersion !== '0.5.
|
|
134
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
133
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
134
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
135
135
|
}
|
|
136
136
|
return binding
|
|
137
137
|
} catch (e) {
|
|
@@ -147,8 +147,8 @@ function requireNative() {
|
|
|
147
147
|
try {
|
|
148
148
|
const binding = require('@runtimed/node-win32-ia32-msvc')
|
|
149
149
|
const bindingPackageVersion = require('@runtimed/node-win32-ia32-msvc/package.json').version
|
|
150
|
-
if (bindingPackageVersion !== '0.5.
|
|
151
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
150
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
151
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
152
152
|
}
|
|
153
153
|
return binding
|
|
154
154
|
} catch (e) {
|
|
@@ -163,8 +163,8 @@ function requireNative() {
|
|
|
163
163
|
try {
|
|
164
164
|
const binding = require('@runtimed/node-win32-arm64-msvc')
|
|
165
165
|
const bindingPackageVersion = require('@runtimed/node-win32-arm64-msvc/package.json').version
|
|
166
|
-
if (bindingPackageVersion !== '0.5.
|
|
167
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
166
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
167
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
168
168
|
}
|
|
169
169
|
return binding
|
|
170
170
|
} catch (e) {
|
|
@@ -182,8 +182,8 @@ function requireNative() {
|
|
|
182
182
|
try {
|
|
183
183
|
const binding = require('@runtimed/node-darwin-universal')
|
|
184
184
|
const bindingPackageVersion = require('@runtimed/node-darwin-universal/package.json').version
|
|
185
|
-
if (bindingPackageVersion !== '0.5.
|
|
186
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
185
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
186
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
187
187
|
}
|
|
188
188
|
return binding
|
|
189
189
|
} catch (e) {
|
|
@@ -198,8 +198,8 @@ function requireNative() {
|
|
|
198
198
|
try {
|
|
199
199
|
const binding = require('@runtimed/node-darwin-x64')
|
|
200
200
|
const bindingPackageVersion = require('@runtimed/node-darwin-x64/package.json').version
|
|
201
|
-
if (bindingPackageVersion !== '0.5.
|
|
202
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
201
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
202
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
203
203
|
}
|
|
204
204
|
return binding
|
|
205
205
|
} catch (e) {
|
|
@@ -214,8 +214,8 @@ function requireNative() {
|
|
|
214
214
|
try {
|
|
215
215
|
const binding = require('@runtimed/node-darwin-arm64')
|
|
216
216
|
const bindingPackageVersion = require('@runtimed/node-darwin-arm64/package.json').version
|
|
217
|
-
if (bindingPackageVersion !== '0.5.
|
|
218
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
217
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
218
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
219
219
|
}
|
|
220
220
|
return binding
|
|
221
221
|
} catch (e) {
|
|
@@ -234,8 +234,8 @@ function requireNative() {
|
|
|
234
234
|
try {
|
|
235
235
|
const binding = require('@runtimed/node-freebsd-x64')
|
|
236
236
|
const bindingPackageVersion = require('@runtimed/node-freebsd-x64/package.json').version
|
|
237
|
-
if (bindingPackageVersion !== '0.5.
|
|
238
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
237
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
238
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
239
239
|
}
|
|
240
240
|
return binding
|
|
241
241
|
} catch (e) {
|
|
@@ -250,8 +250,8 @@ function requireNative() {
|
|
|
250
250
|
try {
|
|
251
251
|
const binding = require('@runtimed/node-freebsd-arm64')
|
|
252
252
|
const bindingPackageVersion = require('@runtimed/node-freebsd-arm64/package.json').version
|
|
253
|
-
if (bindingPackageVersion !== '0.5.
|
|
254
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
253
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
254
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
255
255
|
}
|
|
256
256
|
return binding
|
|
257
257
|
} catch (e) {
|
|
@@ -271,8 +271,8 @@ function requireNative() {
|
|
|
271
271
|
try {
|
|
272
272
|
const binding = require('@runtimed/node-linux-x64-musl')
|
|
273
273
|
const bindingPackageVersion = require('@runtimed/node-linux-x64-musl/package.json').version
|
|
274
|
-
if (bindingPackageVersion !== '0.5.
|
|
275
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
274
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
275
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
276
276
|
}
|
|
277
277
|
return binding
|
|
278
278
|
} catch (e) {
|
|
@@ -287,8 +287,8 @@ function requireNative() {
|
|
|
287
287
|
try {
|
|
288
288
|
const binding = require('@runtimed/node-linux-x64-gnu')
|
|
289
289
|
const bindingPackageVersion = require('@runtimed/node-linux-x64-gnu/package.json').version
|
|
290
|
-
if (bindingPackageVersion !== '0.5.
|
|
291
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
290
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
291
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
292
292
|
}
|
|
293
293
|
return binding
|
|
294
294
|
} catch (e) {
|
|
@@ -305,8 +305,8 @@ function requireNative() {
|
|
|
305
305
|
try {
|
|
306
306
|
const binding = require('@runtimed/node-linux-arm64-musl')
|
|
307
307
|
const bindingPackageVersion = require('@runtimed/node-linux-arm64-musl/package.json').version
|
|
308
|
-
if (bindingPackageVersion !== '0.5.
|
|
309
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
308
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
309
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
310
310
|
}
|
|
311
311
|
return binding
|
|
312
312
|
} catch (e) {
|
|
@@ -321,8 +321,8 @@ function requireNative() {
|
|
|
321
321
|
try {
|
|
322
322
|
const binding = require('@runtimed/node-linux-arm64-gnu')
|
|
323
323
|
const bindingPackageVersion = require('@runtimed/node-linux-arm64-gnu/package.json').version
|
|
324
|
-
if (bindingPackageVersion !== '0.5.
|
|
325
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
324
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
325
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
326
326
|
}
|
|
327
327
|
return binding
|
|
328
328
|
} catch (e) {
|
|
@@ -339,8 +339,8 @@ function requireNative() {
|
|
|
339
339
|
try {
|
|
340
340
|
const binding = require('@runtimed/node-linux-arm-musleabihf')
|
|
341
341
|
const bindingPackageVersion = require('@runtimed/node-linux-arm-musleabihf/package.json').version
|
|
342
|
-
if (bindingPackageVersion !== '0.5.
|
|
343
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
342
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
343
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
344
344
|
}
|
|
345
345
|
return binding
|
|
346
346
|
} catch (e) {
|
|
@@ -355,8 +355,8 @@ function requireNative() {
|
|
|
355
355
|
try {
|
|
356
356
|
const binding = require('@runtimed/node-linux-arm-gnueabihf')
|
|
357
357
|
const bindingPackageVersion = require('@runtimed/node-linux-arm-gnueabihf/package.json').version
|
|
358
|
-
if (bindingPackageVersion !== '0.5.
|
|
359
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
358
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
359
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
360
360
|
}
|
|
361
361
|
return binding
|
|
362
362
|
} catch (e) {
|
|
@@ -373,8 +373,8 @@ function requireNative() {
|
|
|
373
373
|
try {
|
|
374
374
|
const binding = require('@runtimed/node-linux-loong64-musl')
|
|
375
375
|
const bindingPackageVersion = require('@runtimed/node-linux-loong64-musl/package.json').version
|
|
376
|
-
if (bindingPackageVersion !== '0.5.
|
|
377
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
376
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
377
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
378
378
|
}
|
|
379
379
|
return binding
|
|
380
380
|
} catch (e) {
|
|
@@ -389,8 +389,8 @@ function requireNative() {
|
|
|
389
389
|
try {
|
|
390
390
|
const binding = require('@runtimed/node-linux-loong64-gnu')
|
|
391
391
|
const bindingPackageVersion = require('@runtimed/node-linux-loong64-gnu/package.json').version
|
|
392
|
-
if (bindingPackageVersion !== '0.5.
|
|
393
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
392
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
393
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
394
394
|
}
|
|
395
395
|
return binding
|
|
396
396
|
} catch (e) {
|
|
@@ -407,8 +407,8 @@ function requireNative() {
|
|
|
407
407
|
try {
|
|
408
408
|
const binding = require('@runtimed/node-linux-riscv64-musl')
|
|
409
409
|
const bindingPackageVersion = require('@runtimed/node-linux-riscv64-musl/package.json').version
|
|
410
|
-
if (bindingPackageVersion !== '0.5.
|
|
411
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
410
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
411
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
412
412
|
}
|
|
413
413
|
return binding
|
|
414
414
|
} catch (e) {
|
|
@@ -423,8 +423,8 @@ function requireNative() {
|
|
|
423
423
|
try {
|
|
424
424
|
const binding = require('@runtimed/node-linux-riscv64-gnu')
|
|
425
425
|
const bindingPackageVersion = require('@runtimed/node-linux-riscv64-gnu/package.json').version
|
|
426
|
-
if (bindingPackageVersion !== '0.5.
|
|
427
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
426
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
427
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
428
428
|
}
|
|
429
429
|
return binding
|
|
430
430
|
} catch (e) {
|
|
@@ -440,8 +440,8 @@ function requireNative() {
|
|
|
440
440
|
try {
|
|
441
441
|
const binding = require('@runtimed/node-linux-ppc64-gnu')
|
|
442
442
|
const bindingPackageVersion = require('@runtimed/node-linux-ppc64-gnu/package.json').version
|
|
443
|
-
if (bindingPackageVersion !== '0.5.
|
|
444
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
443
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
444
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
445
445
|
}
|
|
446
446
|
return binding
|
|
447
447
|
} catch (e) {
|
|
@@ -456,8 +456,8 @@ function requireNative() {
|
|
|
456
456
|
try {
|
|
457
457
|
const binding = require('@runtimed/node-linux-s390x-gnu')
|
|
458
458
|
const bindingPackageVersion = require('@runtimed/node-linux-s390x-gnu/package.json').version
|
|
459
|
-
if (bindingPackageVersion !== '0.5.
|
|
460
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
459
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
460
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
461
461
|
}
|
|
462
462
|
return binding
|
|
463
463
|
} catch (e) {
|
|
@@ -476,8 +476,8 @@ function requireNative() {
|
|
|
476
476
|
try {
|
|
477
477
|
const binding = require('@runtimed/node-openharmony-arm64')
|
|
478
478
|
const bindingPackageVersion = require('@runtimed/node-openharmony-arm64/package.json').version
|
|
479
|
-
if (bindingPackageVersion !== '0.5.
|
|
480
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
479
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
480
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
481
481
|
}
|
|
482
482
|
return binding
|
|
483
483
|
} catch (e) {
|
|
@@ -492,8 +492,8 @@ function requireNative() {
|
|
|
492
492
|
try {
|
|
493
493
|
const binding = require('@runtimed/node-openharmony-x64')
|
|
494
494
|
const bindingPackageVersion = require('@runtimed/node-openharmony-x64/package.json').version
|
|
495
|
-
if (bindingPackageVersion !== '0.5.
|
|
496
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
495
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
496
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
497
497
|
}
|
|
498
498
|
return binding
|
|
499
499
|
} catch (e) {
|
|
@@ -508,8 +508,8 @@ function requireNative() {
|
|
|
508
508
|
try {
|
|
509
509
|
const binding = require('@runtimed/node-openharmony-arm')
|
|
510
510
|
const bindingPackageVersion = require('@runtimed/node-openharmony-arm/package.json').version
|
|
511
|
-
if (bindingPackageVersion !== '0.5.
|
|
512
|
-
throw new Error(`Native binding package version mismatch, expected 0.5.
|
|
511
|
+
if (bindingPackageVersion !== '0.5.6-nightly.36546986351' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
512
|
+
throw new Error(`Native binding package version mismatch, expected 0.5.6-nightly.36546986351 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
513
513
|
}
|
|
514
514
|
return binding
|
|
515
515
|
} catch (e) {
|
|
@@ -586,6 +586,7 @@ module.exports.CreateNotebookEnvironmentMode = nativeBinding.CreateNotebookEnvir
|
|
|
586
586
|
module.exports.createRelay = nativeBinding.createRelay
|
|
587
587
|
module.exports.defaultSocketPath = nativeBinding.defaultSocketPath
|
|
588
588
|
module.exports.getExecutionResult = nativeBinding.getExecutionResult
|
|
589
|
+
module.exports.initializeEnvironmentYml = nativeBinding.initializeEnvironmentYml
|
|
589
590
|
module.exports.listActiveNotebooks = nativeBinding.listActiveNotebooks
|
|
590
591
|
module.exports.openNotebook = nativeBinding.openNotebook
|
|
591
592
|
module.exports.openNotebookPath = nativeBinding.openNotebookPath
|
package/src/binding.d.ts
CHANGED
|
@@ -40,8 +40,10 @@ export declare class Session {
|
|
|
40
40
|
*
|
|
41
41
|
* Callback receives the same JSON shape as `CellResult`, emitted whenever
|
|
42
42
|
* the RuntimeStateDoc entry for the execution changes. The subscription
|
|
43
|
-
* ends after
|
|
44
|
-
*
|
|
43
|
+
* ends after a terminal execution snapshot, kernel failure after the
|
|
44
|
+
* execution has been observed, or connection close. An execution that
|
|
45
|
+
* never appears stays pending until the subscription is disposed or the
|
|
46
|
+
* connection closes.
|
|
45
47
|
*/
|
|
46
48
|
onExecutionProgress(executionId: string, cellId: string | undefined | null, callback: (arg0: string) => void): EventSubscription
|
|
47
49
|
/**
|
|
@@ -68,6 +70,13 @@ export declare class Session {
|
|
|
68
70
|
* `NotebookDoc` + `RuntimeStateDoc` + `CommsDoc` snapshot triplet.
|
|
69
71
|
*/
|
|
70
72
|
exportSnapshotPair(): Promise<SnapshotPair>
|
|
73
|
+
/**
|
|
74
|
+
* Acknowledge the current NotebookDoc frontier at the connected daemon.
|
|
75
|
+
* Returns the captured heads; later edits are not covered. Rejects on
|
|
76
|
+
* timeout, close, disconnect, unsupported peers, or daemon rejection.
|
|
77
|
+
* This does not save an .ipynb or acknowledge other document streams.
|
|
78
|
+
*/
|
|
79
|
+
confirmNotebookSync(): Promise<Array<string>>
|
|
71
80
|
/** Close the session and release the underlying connection. */
|
|
72
81
|
close(): Promise<void>
|
|
73
82
|
/**
|
|
@@ -273,6 +282,11 @@ export interface CreateRelayOptions {
|
|
|
273
282
|
/** Daemon metadata needed by a Node host before it opens a notebook relay. */
|
|
274
283
|
export interface DaemonInfo {
|
|
275
284
|
version: string
|
|
285
|
+
protocolVersion: number
|
|
286
|
+
/** Zero means the daemon predates semantic API version reporting. */
|
|
287
|
+
daemonApiVersion: number
|
|
288
|
+
/** Shared Rust compatibility diagnostic; absent when supported by this client. */
|
|
289
|
+
compatibilityError?: string
|
|
276
290
|
socketPath: string
|
|
277
291
|
isDevMode: boolean
|
|
278
292
|
blobPort?: number
|
|
@@ -329,6 +343,29 @@ export interface GetExecutionResultOptions {
|
|
|
329
343
|
socketPath?: string
|
|
330
344
|
}
|
|
331
345
|
|
|
346
|
+
/**
|
|
347
|
+
* Create environment.yml without overwriting an existing file or symlink.
|
|
348
|
+
*
|
|
349
|
+
* This uses the local Node process's filesystem authority. It does not contact
|
|
350
|
+
* the daemon, install packages, approve trust, or launch/change a kernel.
|
|
351
|
+
* Returns the absolute path of the newly created manifest.
|
|
352
|
+
*/
|
|
353
|
+
export declare function initializeEnvironmentYml(options: InitializeEnvironmentYmlOptions): Promise<string>
|
|
354
|
+
|
|
355
|
+
/** Options for the local host's explicit manifest creation request. */
|
|
356
|
+
export interface InitializeEnvironmentYmlOptions {
|
|
357
|
+
/** An existing absolute directory the host is authorized to write. */
|
|
358
|
+
directory: string
|
|
359
|
+
/** Optional environment name: letters, numbers, '.', '_' and '-'. */
|
|
360
|
+
name?: string
|
|
361
|
+
/** Conda match specs; pip subsections are not supported by this initializer. */
|
|
362
|
+
dependencies: Array<string>
|
|
363
|
+
/** Optional Python version constraint, e.g. "3.12" or ">=3.11,<3.13". */
|
|
364
|
+
python?: string
|
|
365
|
+
/** At least one channel, in priority order. No channels are inferred. */
|
|
366
|
+
channels: Array<string>
|
|
367
|
+
}
|
|
368
|
+
|
|
332
369
|
/** A notebook cell snapshot. */
|
|
333
370
|
export interface JsCellSnapshot {
|
|
334
371
|
id: string
|