@nidl/client 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,43 @@
+# Licence
+
+nidl is dual-licensed under either of
+
+- Apache License, Version 2.0 ([LICENSE-APACHE](./LICENSE-APACHE))
+- MIT License ([LICENSE-MIT](./LICENSE-MIT))
+
+at your option. This is the Rust ecosystem's customary dual licence, and it is what the
+great majority of this project's own dependencies already use.
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for
+inclusion in this work by you, as defined in the Apache-2.0 licence, shall be dual
+licensed as above, without any additional terms or conditions.
+
+## Third-party notice
+
+This notice is scoped to what each build contains, as
+`.hermes/artifacts/plugin-cli-foundation/F-DEPENDENCY-SECURITY-AUDIT.md` s.2 records it. Its
+obligations are recorded here rather than left to be discovered.
+
+**The headless binary** (`nidl-core`, built without default features: what a handed build
+contains) has one dependency under a copyleft licence:
+
+**`option-ext`** (MPL-2.0), used unmodified, reached through `dirs` → `dirs-sys`. MPL-2.0 is
+file-level copyleft: the obligation attaches to modifications of MPL-licensed *files*, not
+to the work that links them. nidl modifies none, so what is owed is the notice above and
+availability of that component's source, which is published at its own repository. It
+places no constraint on nidl's own terms.
+
+Everything else in the headless binary's dependency graph is permissive. No crate in it is under
+GPL, LGPL or AGPL.
+
+**The desktop app** (built with default features, and not distributed today) also contains the
+four MPL-2.0 crates of its webview's CSS stack, each used unmodified, with the same obligation as
+`option-ext`: **`cssparser`**, **`cssparser-macros`**, **`dtoa-short`** and **`selectors`**. No
+crate in it is under GPL, LGPL or AGPL either.
+
+**The website** (`@nidl/web`, private, and not distributed) depends on
+**`@img/sharp-libvips-darwin-arm64`** (LGPL-3.0-or-later), a prebuilt image library reached through
+`next` → `sharp`. Publishing the website would make its LGPL obligation live.
+
+`tests/licence_notice_test.rs` reads both Rust dependency graphs, and fails when a copyleft crate in
+either is not named here or a crate under GPL, LGPL or AGPL appears.

package/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Criss Moldovan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,157 @@
-# Temporary Holding Version
+# @nidl/client
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Drive a running [nidl](https://github.com/crissmoldovan/nidl) core from a Node program, over its
+local socket, or over HTTPS to its remote port on another machine.
+
+```js
+import { connect } from "@nidl/client";
+
+const nidl = await connect(); // the core serving ~/.nidl; or connect({ dataDir })
+if (nidl.has("targets.list")) {
+  const { targets } = await nidl.command("targets.list");
+}
+```
+
+- **It never starts a core.** When none is running, `connect()` fails with code `not_running`
+  and says how to start one: `nidl serve --data-dir ~/.nidl`, or open the nidl app.
+- **It checks the socket's folder first:** each folder on the way is yours or root's and not
+  writable by others, the control folder is `0700`, the core's record is a private file
+  describing this folder's core, and the socket is the one that record names. A check that fails
+  throws code `unsafe_folder`. Node cannot ask the operating system who is at the other end of a
+  socket, so this library cannot check the peer's user; the Python and Rust libraries can.
+- **It is an app, not the owner.** It connects as the `app` client kind: it can read, draft,
+  preview and apply, but credential commands, such as connecting an account or unlocking
+  credentials, are refused with `requires_owner_action`. Those are yours to run, from the CLI or
+  the desktop.
+- **Command names are typed.** `command()` takes a `CommandName`, one of `COMMAND_NAMES`: the
+  commands an app may run, generated from the core's registry. A misspelled name, a credential
+  command or `pools.lend` is a type error. Call a command a newer core offers with a cast:
+  `nidl.command("its.name" as CommandName)`. Results are plain JSON.
+- **Each call is one connection:** the folder is checked, the core says hello, the command runs,
+  the connection closes.
+
+Errors are `NidlError`s with a `code` for programs, a `message` for people, and an `outcome`:
+`not_started`, or `unknown` when the connection was lost after the command was sent, since it may
+have run.
+
+| Code | Meaning |
+| --- | --- |
+| `not_running` | no core serves this folder |
+| `unsafe_folder` | the socket's folder failed a check |
+| `not_offered` | this core does not have that command; update nidl |
+| `version_conflict` | the core speaks another protocol version |
+| `path_too_long` | the socket's path is longer than the platform allows |
+| `timeout` | no answer within `timeoutMs` (10 seconds by default) |
+| `protocol_error` | the core's reply broke the protocol |
+| anything else | the core's own refusal, such as `not_found` or `requires_owner_action` |
+
+## A core on another machine
+
+When a machine's owner has turned on nidl's remote port there (`nidl remote enable`) and issued you
+a remote token (`nidl remote-tokens issue`), connect to that core by its URL, `https://HOST:PORT`:
+
+```js
+const nidl = await connect({
+  url: "https://nidl.example:8443",
+  token: process.env.NIDL_TOKEN,
+  fingerprint: "sha256:…", // as `nidl remote status` shows it on that machine
+});
+```
+
+- **The certificate is checked before the token is sent.** With a fingerprint, only nidl's own
+  certificate with that fingerprint is accepted, as SSH remembers a host's key; the handshake still
+  proves the server holds its key. Without one, the certificate must be one Node trusts for the URL's
+  host, as when the owner serves a certificate of their own. Anything else fails with
+  `untrusted_certificate`, and nothing is sent.
+- **The token's scope decides what runs.** A `read` token lists and reads. An `operate` token also
+  drafts targets, refreshes catalogs and readings, and previews and applies routing. Neither runs
+  credential commands or starts paid model checks: those stay with the owner at the machine
+  (`requires_owner_action`).
+- **`nidl.identity`** has no `root` or `instanceNonce` for a remote core, which does not say what names
+  its files; it says the token's `scope`.
+- **Each call is one HTTPS connection** to the remote port, closed after the answer.
+
+The remote codes, beside those above: `unauthorized` (the token is unknown, revoked or expired),
+`untrusted_certificate` (the certificate is not the one expected; nothing was sent), `throttled`
+(too many failed attempts from this address; wait a minute), `invalid_input` (the URL, token or
+fingerprint is malformed, or the command is over 1 MiB), `unavailable` (the machine could not be
+reached, or its core is busy or not serving), and `unsupported` (that nidl's remote port takes no
+commands; update it there).
+
+## Lending your project's key, and reporting readings
+
+Another program can use nidl for its own accounts once the owner has made it a project there
+(`nidl projects create`), with a **borrowed** account for each API key it holds
+(`nidl projects add-account`, mode `borrowed`) and an API target with an app token
+(`nidl targets create`, `nidl app-tokens issue`). Your program lends nidl its key for as long as it
+wants requests to the target's endpoint, `/h/<target>/v1/…`, routed with it, and takes it back:
+
+```js
+const lease = await nidl.lend(accountId, apiKey, { appToken: process.env.NIDL_APP_TOKEN, expiresInSeconds: 3600 });
+// ... calls to the target's endpoint route with the key while the lease lives ...
+await nidl.withdraw(accountId);
+```
+
+- **The key travels in the socket's secret frame,** never in a command's arguments, so
+  `command("pools.lend")` is refused with `invalid_input`. nidl keeps it in memory only, never on
+  disk, for 60 seconds to 12 hours (an hour unless you say) and never past the app token. It is
+  dropped when the lease expires, when you withdraw it, when the owner revokes the token or removes
+  its target, and when the core stops. Lend again to renew it.
+- **The app token proves the account is your project's.** A token of another project's target, a
+  revoked or expired one, or none, is refused with `not_authorized`.
+- **On this machine only.** `lend` and `withdraw` on a remote core fail with `unsupported` before
+  anything is sent.
+- The lease is `{accountId, lentAt, expiresAt, lentBy}`, `lentBy` being your app token's id. It
+  never holds the key.
+
+A JavaScript string cannot be wiped; the frame's own bytes are overwritten once the socket has
+taken them.
+
+An **observed** account is one nidl never holds a key for, a subscription for instance, whose quota
+your program reports so the owner sees it beside their own:
+
+```js
+await nidl.observe(accountId, [{ key: "five_hour", percent: 37.5, resetsAt: "2026-10-21T15:00:00Z" }]);
+```
+
+At most 16 windows, each a `key`, a `percent` from 0 to 100, and optionally a `label` and a
+`resetsAt`, captured within the last 24 hours (now, unless you say). On a remote core this needs an
+`operate` token bound to your project (`nidl remote-tokens issue` with its `project`).
+
+
+## In a Trigger.dev task
+
+A task can run its own nidl core in its container, from a **task vault** you export at your
+machine (`nidl task-vault export`) and give the task as two secrets, `NIDL_TASK_VAULT` and
+`NIDL_TASK_VAULT_KEY`:
+
+```js
+import { startTaskCore } from "@nidl/client";
+
+const nidl = await startTaskCore(); // once per process; a warm worker reuses it
+process.env.ANTHROPIC_BASE_URL = nidl.baseUrl; // http://127.0.0.1:<port>/h/<target>
+process.env.ANTHROPIC_API_KEY = nidl.appToken;
+```
+
+- It removes both secrets from `process.env` before anything else runs, writes them to private
+  files, opens the task vault, serves it with `--stop-with-parent` and unlocks it with its key
+  file. It needs `@nidl/cli` beside it (or `executable`), both kept out of the bundle
+  (`build.external`).
+- Its folder is made in the temporary folder, or in the home folder when someone else may write to
+  the temporary one, as anyone may to `/tmp`; `directory` names another. A start that fails removes
+  what it wrote and can be called again; `stop()` removes the folder once the core has stopped.
+- Linux only, where Trigger.dev deploys run. Otherwise a task reaches the hub with an app token.
+- Codes: `not_configured` (no secrets), `not_installed` (no `@nidl/cli`), `timeout`,
+  `unavailable`, or the core's own, such as `invalid_input` for a vault that does not open.
+
+The whole path, the hub's included, is in
+[docs/integrations/trigger-dev.md](https://github.com/crissmoldovan/nidl/blob/main/docs/integrations/trigger-dev.md).
+
+Long-running commands return an operation id: poll it with `nidl.command("operations.get", { operationId })`.
+
+Results are JavaScript values, so a whole number above 2^53 loses precision, as it does in any
+`JSON.parse`. nidl's results do not carry such numbers today.
+
+The protocol is described in
+[docs/protocol/nidl-core-protocol.md](https://github.com/crissmoldovan/nidl/blob/main/docs/protocol/nidl-core-protocol.md).
+Node 22 or later, on macOS or Linux. No dependencies: the remote port uses Node's own `tls` and `http`.

package/dist/commands.generated.d.ts

@@ -0,0 +1,3 @@
+export declare const COMMAND_NAMES: readonly ["accounts.get", "accounts.list", "accounts.update", "catalog.refresh", "catalog.search", "commands.list", "costs.get", "custom_harnesses.list", "custom_harnesses.remove", "custom_harnesses.save", "generations.list", "generations.preview", "generations.retire", "generations.stop", "launch.apply", "launch.preview", "launch.remove", "launch.status", "mappings.suggest", "mappings.validate", "monitor.probe_now", "monitor.start", "monitor.status", "monitor.stop", "operations.get", "plugins.disable", "plugins.enable", "plugins.lifecycle", "plugins.lifecycle_preview", "plugins.list", "pools.withdraw", "presets.get", "presets.list", "presets.validate", "probes.costs", "probes.history", "projects.list", "providers.list", "readings.observe", "remote.status", "routing.apply", "routing.disable", "routing.disable_preview", "routing.preview", "routing.status", "routing_presets.list", "routing_presets.remove", "routing_presets.save", "runtime.version", "targets.clone", "targets.create", "targets.get", "targets.list", "targets.preset_refresh_apply", "targets.preset_refresh_preview", "targets.remove", "targets.save", "usage.get", "watchers.add_model", "watchers.disable", "watchers.enable", "watchers.get", "watchers.history", "watchers.refresh", "watchers.remove_model"];
+export type CommandName = (typeof COMMAND_NAMES)[number];
+//# sourceMappingURL=commands.generated.d.ts.map

package/dist/commands.generated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commands.generated.d.ts","sourceRoot":"","sources":["../src/commands.generated.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,aAAa,mwCAkEhB,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC"}

package/dist/commands.generated.js

@@ -0,0 +1,72 @@
+// Generated from the core's command registry. Do not edit by hand: the core's test
+// `client_command_names_test` fails when this file differs, and prints it as it should be.
+// The commands an app may run: none of the owner's credential commands, and not `pools.lend`, which
+// `lend()` sends with its key in the socket's secret frame.
+export const COMMAND_NAMES = [
+    "accounts.get",
+    "accounts.list",
+    "accounts.update",
+    "catalog.refresh",
+    "catalog.search",
+    "commands.list",
+    "costs.get",
+    "custom_harnesses.list",
+    "custom_harnesses.remove",
+    "custom_harnesses.save",
+    "generations.list",
+    "generations.preview",
+    "generations.retire",
+    "generations.stop",
+    "launch.apply",
+    "launch.preview",
+    "launch.remove",
+    "launch.status",
+    "mappings.suggest",
+    "mappings.validate",
+    "monitor.probe_now",
+    "monitor.start",
+    "monitor.status",
+    "monitor.stop",
+    "operations.get",
+    "plugins.disable",
+    "plugins.enable",
+    "plugins.lifecycle",
+    "plugins.lifecycle_preview",
+    "plugins.list",
+    "pools.withdraw",
+    "presets.get",
+    "presets.list",
+    "presets.validate",
+    "probes.costs",
+    "probes.history",
+    "projects.list",
+    "providers.list",
+    "readings.observe",
+    "remote.status",
+    "routing.apply",
+    "routing.disable",
+    "routing.disable_preview",
+    "routing.preview",
+    "routing.status",
+    "routing_presets.list",
+    "routing_presets.remove",
+    "routing_presets.save",
+    "runtime.version",
+    "targets.clone",
+    "targets.create",
+    "targets.get",
+    "targets.list",
+    "targets.preset_refresh_apply",
+    "targets.preset_refresh_preview",
+    "targets.remove",
+    "targets.save",
+    "usage.get",
+    "watchers.add_model",
+    "watchers.disable",
+    "watchers.enable",
+    "watchers.get",
+    "watchers.history",
+    "watchers.refresh",
+    "watchers.remove_model",
+];
+//# sourceMappingURL=commands.generated.js.map

package/dist/commands.generated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commands.generated.js","sourceRoot":"","sources":["../src/commands.generated.ts"],"names":[],"mappings":"AAAA,mFAAmF;AACnF,2FAA2F;AAC3F,oGAAoG;AACpG,4DAA4D;AAC5D,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,cAAc;IACd,eAAe;IACf,iBAAiB;IACjB,iBAAiB;IACjB,gBAAgB;IAChB,eAAe;IACf,WAAW;IACX,uBAAuB;IACvB,yBAAyB;IACzB,uBAAuB;IACvB,kBAAkB;IAClB,qBAAqB;IACrB,oBAAoB;IACpB,kBAAkB;IAClB,cAAc;IACd,gBAAgB;IAChB,eAAe;IACf,eAAe;IACf,kBAAkB;IAClB,mBAAmB;IACnB,mBAAmB;IACnB,eAAe;IACf,gBAAgB;IAChB,cAAc;IACd,gBAAgB;IAChB,iBAAiB;IACjB,gBAAgB;IAChB,mBAAmB;IACnB,2BAA2B;IAC3B,cAAc;IACd,gBAAgB;IAChB,aAAa;IACb,cAAc;IACd,kBAAkB;IAClB,cAAc;IACd,gBAAgB;IAChB,eAAe;IACf,gBAAgB;IAChB,kBAAkB;IAClB,eAAe;IACf,eAAe;IACf,iBAAiB;IACjB,yBAAyB;IACzB,iBAAiB;IACjB,gBAAgB;IAChB,sBAAsB;IACtB,wBAAwB;IACxB,sBAAsB;IACtB,iBAAiB;IACjB,eAAe;IACf,gBAAgB;IAChB,aAAa;IACb,cAAc;IACd,8BAA8B;IAC9B,gCAAgC;IAChC,gBAAgB;IAChB,cAAc;IACd,WAAW;IACX,oBAAoB;IACpB,kBAAkB;IAClB,iBAAiB;IACjB,cAAc;IACd,kBAAkB;IAClB,kBAAkB;IAClB,uBAAuB;CACf,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,136 @@
+import type { CommandName } from "./commands.generated.js";
+export declare const VERSION = "0.1.0";
+/** PQ4: how a key is lent. */
+export interface LendOptions {
+    /** An app token of one of the account's project's targets: how an app proves its project. */
+    appToken?: string;
+    /** How long the lease lasts, 60 to 43,200 seconds; an hour unless given. */
+    expiresInSeconds?: number;
+}
+/** PQ4: one window of an observed account's reading. */
+export interface ObservedWindow {
+    key: string;
+    percent: number;
+    label?: string;
+    resetsAt?: string;
+}
+export interface ConnectOptions {
+    /** The core's data folder. Defaults to `~/.nidl`. */
+    dataDir?: string;
+    /** How long one call may take, in milliseconds. Defaults to 10 seconds. */
+    timeoutMs?: number;
+    /** A core on another machine: its remote port, `https://HOST:PORT`. Instead of `dataDir`. */
+    url?: string;
+    /** The remote token `nidl remote-tokens issue` gave, for `url`. */
+    token?: string;
+    /**
+     * `sha256:` and 64 hex digits, as `nidl remote status` shows it: only the certificate with this
+     * fingerprint is accepted. Without it, the certificate must be one Node trusts for the URL's host.
+     */
+    fingerprint?: string;
+}
+/**
+ * The core's identity, as its hello returns it. Fields this version does not know are kept. A
+ * remote core does not say what names its files (`root`, `instanceNonce`), and says the token's
+ * `scope` instead.
+ */
+export interface Identity {
+    root?: {
+        device: string;
+        inode: string;
+    };
+    instanceNonce?: string;
+    apiMajor: number;
+    apiMinor: number;
+    coreVersion: string;
+    commands: string[];
+    scope?: string;
+    [field: string]: unknown;
+}
+/**
+ * Why a call failed. `code` is for programs and `message` for people. `outcome` says whether
+ * anything happened: `not_started`, or `unknown` when the connection was lost after the request
+ * was sent.
+ */
+export declare class NidlError extends Error {
+    readonly code: string;
+    readonly outcome: string;
+    readonly name = "NidlError";
+    constructor(code: string, message: string, outcome?: string);
+}
+/**
+ * Connect to the core serving `dataDir`, or, with `url` and `token`, to the core whose remote port
+ * is at `url`; then say hello once to prove it answers.
+ */
+export declare function connect(options?: ConnectOptions): Promise<Nidl>;
+export declare class Nidl {
+    #private;
+    /** The data folder of the core on this machine; undefined for a remote core. */
+    readonly dataDir: string | undefined;
+    private readonly timeoutMs;
+    private readonly remote?;
+    /** @internal Use `connect()`. */
+    constructor(
+    /** The data folder of the core on this machine; undefined for a remote core. */
+    dataDir: string | undefined, timeoutMs: number, remote?: Remote | undefined);
+    /** The core's identity from the latest hello. */
+    get identity(): Identity;
+    /** Whether the core offers a command, by the latest hello. */
+    has(name: string): boolean;
+    /**
+     * Run one command and return its result, or throw a `NidlError`. Each call opens its own
+     * connection, checks the folder again and says hello again. `name` is one an app may run
+     * (CL8); a newer core's command is called with a cast, `"its.name" as CommandName`.
+     */
+    command(name: CommandName, args?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * PQ4 (docs/specs/nidl-external-pools.md s.6 item 1): lend `apiKey` to the borrowed account
+     * `accountId` of the core on this machine. An app proves the account's project with
+     * `appToken`, an app token of one of that project's targets. The key travels in the socket's
+     * secret frame, never in the command's arguments, and never through the remote port. A
+     * JavaScript string cannot be wiped; the frame's own bytes are overwritten once written.
+     */
+    lend(accountId: string, apiKey: string, options?: LendOptions): Promise<unknown>;
+    /**
+     * PQ4: end the lease of the borrowed account `accountId` on the core on this machine.
+     * Withdrawing none is not an error: the result says whether there was one.
+     */
+    withdraw(accountId: string): Promise<unknown>;
+    /**
+     * PQ4: report an observed account's quota readings, on this machine or through the remote port
+     * with a remote token bound to the account's project. `capturedAt` (RFC 3339) defaults to now.
+     */
+    observe(accountId: string, windows: ObservedWindow[], capturedAt?: string): Promise<unknown>;
+    private onThisMachine;
+    private offered;
+    /** @internal Say hello on a fresh connection and keep the identity. */
+    refresh(): Promise<void>;
+    /** `secret`, when given, is the secret frame written right after the command's line (PQ4). */
+    private exchange;
+}
+/**
+ * A core's remote port: one TLS connection per call, closed after the answer. The certificate is
+ * checked once the handshake is done and before anything is written, so a token is never sent to a
+ * server that is not the core's. With a pin, the handshake's own signature still proves the server
+ * holds the pinned certificate's key.
+ */
+declare class Remote {
+    #private;
+    private readonly host;
+    private readonly port;
+    private readonly authority;
+    private readonly pin;
+    constructor(url: string, token: string, fingerprint: string | undefined);
+    hello(deadline: number): Promise<Identity>;
+    command(name: string, args: unknown, deadline: number): Promise<unknown>;
+    /** A reply or an identity for 200, a reply for the 403 and 502 that carry one; otherwise the error the status names. */
+    private answer;
+    private untrusted;
+    /** A TLS connection whose certificate has been checked, before anything is written on it. */
+    private secured;
+    /** One request on one connection, every step within `deadline`. */
+    private exchange;
+}
+export { COMMAND_NAMES, type CommandName } from "./commands.generated.js";
+export { openTaskCore, startTaskCore, TASK_VAULT_KEY_VARIABLE, TASK_VAULT_VARIABLE, type TaskCore, type TaskCoreOptions, } from "./task.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAG3D,eAAO,MAAM,OAAO,UAAU,CAAC;AAW/B,8BAA8B;AAC9B,MAAM,WAAW,WAAW;IAC1B,6FAA6F;IAC7F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4EAA4E;IAC5E,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,wDAAwD;AACxD,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,qDAAqD;IACrD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2EAA2E;IAC3E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,6FAA6F;IAC7F,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB,IAAI,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IACzC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAIhC,QAAQ,CAAC,IAAI,EAAE,MAAM;IAErB,QAAQ,CAAC,OAAO,EAAE,MAAM;IAL1B,SAAkB,IAAI,eAAe;gBAG1B,IAAI,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,EACN,OAAO,GAAE,MAAsB;CAI3C;AAED;;;GAGG;AACH,wBAAsB,OAAO,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAgBzE;AAED,qBAAa,IAAI;;IAKb,gFAAgF;IAChF,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IAL1B,iCAAiC;;IAE/B,gFAAgF;IACvE,OAAO,EAAE,MAAM,GAAG,SAAS,EACnB,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,YAAA;IAGlC,iDAAiD;IACjD,IAAI,QAAQ,IAAI,QAAQ,CAKvB;IAED,8DAA8D;IAC9D,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI1B;;;;OAIG;IACG,OAAO,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IActF;;;;;;OAMG;IACG,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAqB1F;;;OAGG;IACG,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAKnD;;;OAGG;IACG,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAMlG,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,OAAO;IASf,uEAAuE;IACjE,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI9B,8FAA8F;YAChF,QAAQ;CAgCvB;AA8dD;;;;;GAKG;AACH,cAAM,MAAM;;IACV,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAqB;gBAI7B,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,SAAS;IASjE,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAuB1C,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAS9E,wHAAwH;IACxH,OAAO,CAAC,MAAM;IAmCd,OAAO,CAAC,SAAS;IAQjB,6FAA6F;IAC7F,OAAO,CAAC,OAAO;IA4Cf,mEAAmE;YACrD,QAAQ;CA0EvB;AAGD,OAAO,EAAE,aAAa,EAAE,KAAK,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAG1E,OAAO,EACL,YAAY,EACZ,aAAa,EACb,uBAAuB,EACvB,mBAAmB,EACnB,KAAK,QAAQ,EACb,KAAK,eAAe,GACrB,MAAM,WAAW,CAAC"}