@thirtified/eudi-dev 0.0.0-stage → 0.1.0

package/LICENSE

@@ -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 2026 Julian Dreissig
+
+   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/README.md

@@ -1,3 +1,224 @@
-# Temporary Holding Version
+# @thirtified/eudi-dev
 
-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.
+[![CI](https://github.com/thirtified/eudi-dev-node/actions/workflows/ci.yml/badge.svg)](https://github.com/thirtified/eudi-dev-node/actions/workflows/ci.yml)
+[![npm](https://img.shields.io/npm/v/@thirtified/eudi-dev)](https://www.npmjs.com/package/@thirtified/eudi-dev)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+
+Typed Node.js wrapper for the [eudi-dev](https://github.com/eudi-dev/eudi-dev) CLI (Apache-2.0). It is built for integration tests that need to issue, decode and validate EUDI credentials (SD-JWT VC, JWT VC, mdoc) and work with the wallet's trusted lists and registrar.
+
+The package does not bind to the Go code. It runs the CLI with `--json`, which upstream treats as a stable interface (ADR 0020): exactly one JSON document on stdout, messages on stderr, and within a major version fields are only added, never removed.
+
+**Scope:** CLI commands only. It does not start `wallet serve` and has no HTTP client for the wallet API.
+
+Targets eudi-dev **v3.10.1**. Any v3.x binary is accepted. No runtime dependencies besides the platform package with the binary.
+
+## Install
+
+```bash
+pnpm add -D @thirtified/eudi-dev
+# or: npm install --save-dev @thirtified/eudi-dev
+```
+
+The eudi-dev binary comes in one npm package per platform, listed as `optionalDependencies` with exact versions. The package manager installs only the one that matches your OS and CPU. Nothing is downloaded at install time or at runtime, and there is no install script.
+
+| Platform | Package | Upstream asset |
+|---|---|---|
+| macOS arm64 | `@thirtified/eudi-dev-darwin-arm64` | `eudi-v3.10.1-darwin-arm64` |
+| macOS x64 | `@thirtified/eudi-dev-darwin-x64` | `eudi-v3.10.1-darwin-amd64` |
+| Linux x64 | `@thirtified/eudi-dev-linux-x64` | `eudi-v3.10.1-linux-amd64` |
+| Linux arm64 | `@thirtified/eudi-dev-linux-arm64` | `eudi-v3.10.1-linux-arm64` |
+
+Windows isn't supported yet. Upstream publishes `eudi-v3.10.1-windows-amd64.exe`, and you can point `EUDI_DEV_BIN` at it, but the wrapper is untested on Windows.
+
+Each package contains the upstream release binary unchanged, checked against the release's `checksums.txt` (SHA-256) when it was built, plus upstream's Apache-2.0 `LICENSE`. Its README and the `eudiDev` field in its `package.json` record the release and the hash.
+
+The binary is found in this order:
+
+1. the `bin` option of `EudiDev.create()`
+2. the `EUDI_DEV_BIN` environment variable, for example a binary from `go build` or Homebrew
+3. the platform package
+
+### If the platform package is missing
+
+`EudiDev.create()` throws an `EudiDevBinaryError` that names the package. The usual causes:
+
+- Optional dependencies were left out (npm `--omit=optional`, pnpm `--no-optional`, or `omit=optional` in `.npmrc`). Install without leaving them out.
+- `package-lock.json` was created on another OS and has no entry for your platform's package ([npm/cli#4828](https://github.com/npm/cli/issues/4828)). Delete `node_modules` and `package-lock.json` and run `npm install` again. pnpm's lockfile lists every platform, so this doesn't happen with pnpm.
+- `node_modules` was installed on another platform than the one it runs on, for example on a Mac and then mounted into a Linux container. With pnpm, list both platforms under `supportedArchitectures` in `pnpm-workspace.yaml`. With npm, install inside the container.
+- Your platform isn't one of the four above. Set `EUDI_DEV_BIN`.
+
+With Yarn PnP the packages are unplugged (`preferUnplugged`), so the binary is a real file on disk.
+
+The macOS binaries are ad-hoc signed by the Go linker, not notarised. Files installed by npm or pnpm carry no quarantine attribute, so they run.
+
+## Usage
+
+```ts
+import { EudiDev } from '@thirtified/eudi-dev';
+
+await using eudi = await EudiDev.create(); // own temp EUDI_DEV_HOME, removed on dispose
+
+// Issue with an ephemeral key, then decode and validate
+const { credential, publicJwk } = await eudi.issue.sdjwt({ pid: true, omit: ['sex'] });
+const decoded = await eudi.decode(credential);
+const result = await eudi.validate(credential, { key: publicJwk, haip: true });
+result.valid;               // false when a type/expiry/integrity/signature/status check fails
+result.error;               // "signature: ..." for the first failing check
+result.report.checks;       // every check, typed
+result.report.haipFindings; // informational
+
+// DCQL query for every claim of a credential
+const query = await eudi.dcql(credential);
+
+// mdoc and plain JWT VC
+await eudi.issue.mdoc({ pid: true, docType: 'eu.europa.ec.eudi.pid.1' });
+await eudi.issue.jwt({ claims: { name: 'Test', age: 30 } });
+```
+
+A failing `validate` does **not** throw. It returns `valid: false` along with the report. Everything else throws `EudiDevError` when the command fails.
+
+### Inputs
+
+Commands that read a credential take an `Input`:
+
+- `string | Uint8Array`: the content itself, sent on stdin, so there is no argv length limit
+- `{ path }`: a file. It must exist, because upstream would read a missing path as raw input.
+- `{ url }`: an http(s) URL that eudi-dev fetches
+
+File-valued options (`key`, `trustedList`, `cert`, `csr`, `dcql`, `claims`, `ca`) take the content, `{ path }`, or `{ url }` where upstream accepts one. Content is written to a private temp file for the duration of the call. JSON options (`claims`, a JWK `key`, a DCQL `dcql`) also accept plain objects.
+
+### Wallet, trust and registrar (local state)
+
+These commands work on the wallet in the instance's `EUDI_DEV_HOME`, which is created on first use. Pass `home` to keep state between instances.
+
+```ts
+const issued = await eudi.issue.sdjwt({ pid: true, wallet: true }); // issued.id
+const trustedList = await eudi.trust.show({ vct: 'urn:eudi:pid:1' }); // signed JWT
+await eudi.validate(issued.credential, { trustedList, statusList: false });
+
+const caPem = await eudi.trust.caCert();
+const caJwks = await eudi.trust.caJwks();
+
+const rp = await eudi.registrar.verifiers.add({ name: 'Shop', purpose: 'Age check', dcql: query });
+const id = rp.identifier[0]!.identifier;
+const { registrationCertificate, verifierInfo } = await eudi.registrar.registrationCert({ identifier: id });
+await eudi.registrar.revoke({ identifier: id });
+await eudi.registrar.issuers.add({ name: 'Diplomas Inc', attestations: ['dc+sd-jwt:urn:example:diploma:1'] });
+await eudi.registrar.accessCert({ identifier: id, csr: { path: 'verifier.csr' } });
+await eudi.registrar.enrol({ relyingParty: { tradeName: 'X' }, access: { csr: csrPem } });
+```
+
+A wallet-issued credential points to the wallet's own status list, which only `wallet serve` serves. Without a running server, validate it with `statusList: false`.
+
+### Escape hatches
+
+- Every wrapper takes `extraArgs` for flags it doesn't model, plus `timeoutMs` and `signal`.
+- `eudi.run<T>(['templates', 'list'])` runs any command with `--json` and returns `{ document, stdout, stderr }`.
+- `new Runner({ bin, home })` gives the bare runner without the version check.
+- `resolveBinary()` returns the binary path the lookup above finds, and `platformPackage()` the package for a platform.
+
+### Isolation
+
+Each call runs with:
+
+- `EUDI_DEV_HOME` set to the instance's home
+- `NO_COLOR=1` and `--no-color`
+- every inherited `EUDI_DEV_*` variable removed, so a developer's `EUDI_DEV_STORAGE` or `EUDI_DEV_SEED` cannot change results. Opt out with `inheritEudiEnv: true`. Add variables with `env`.
+
+`EudiDev.create()` runs `eudi version` and refuses a major version other than 3 unless you pass `allowAnyVersion: true`. `dev` builds are accepted.
+
+### Errors
+
+`EudiDevError` has `message` (the last stderr line, which is the error cobra printed), `stderr`, `stdout`, `exitCode` (eudi-dev uses only 0 and 1), `signal`, `timedOut`, `args`, and `document` (the JSON document, if one was printed before the failure). `EudiDevBinaryError` covers a missing or non-executable binary and an unsupported major version.
+
+## Types
+
+The `--json` document types (`ValidateReport`, `DecodedSdJwt`, `DecodedMdoc`, `Check`, `StatusResult`, `RelyingParty`, `TrustOverview`, …) are written by hand from the Go structs at v3.10.1. Upstream publishes no schema for them. Every object type also accepts unknown keys, so fields added in later v3 releases still type-check. `decode` of OpenID4VCI offers, OpenID4VP requests and trusted lists returns a plain `JsonObject`.
+
+## Development
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for setup and pull requests. In short:
+
+```bash
+pnpm install
+pnpm run typecheck
+pnpm test                  # unit tests against a fake binary (node:test, Node 22+)
+pnpm run test:integration  # real binary: EUDI_DEV_BIN or the platform package
+pnpm run lint             # Biome (lint:fix to fix); lint:package runs publint and attw
+pnpm run build
+```
+
+The pnpm version is pinned in `packageManager` (enable it with `corepack enable`, or install that version). `pnpm-workspace.yaml` denies esbuild's install script (`allowBuilds`). tsx doesn't need it, and pnpm otherwise stops the install to ask.
+
+Before the platform packages are on npm, or to test a new upstream release, build your own platform's package into `node_modules`. If a later `pnpm install` prunes it, run it again:
+
+```bash
+node scripts/build-platform-packages.mjs --only current --out node_modules/@thirtified
+```
+
+## Platform packages
+
+`scripts/build-platform-packages.mjs` builds them (Node only, no dependencies):
+
+```bash
+node scripts/build-platform-packages.mjs            # all four into npm/, upstream tag from src/version.ts
+node scripts/build-platform-packages.mjs --help     # all options
+```
+
+It downloads the release's `checksums.txt` and the four assets, fails on any SHA-256 mismatch without writing anything, and writes `npm/eudi-dev-<os>-<cpu>/` with `bin/eudi` (mode 0755), `package.json`, `LICENSE` (from the upstream tag) and `README.md`. `--base-url` points it at a mirror (`file:` URLs work). Node's `fetch` ignores `HTTPS_PROXY`; behind a proxy run it with `NODE_USE_ENV_PROXY=1` (Node 22.21+ / 24).
+
+### Versions
+
+- A platform package has the upstream version without the `v`: `3.10.1` for `v3.10.1`.
+- To fix the packaging of the same upstream release, add `-<n>`: `3.10.1-1`, `3.10.1-2`. npm can't republish a version, and it ignores `+build` metadata. Being a semver prerelease, `3.10.1-1` sorts below `3.10.1`, which doesn't matter because the main package pins exact versions.
+- The main package has its own version and pins the platform packages exactly in `optionalDependencies`. `--sync-main` writes those pins.
+
+### Releasing
+
+`.github/workflows/release.yml` runs on a tag `v<package.json version>` or by hand:
+
+1. It builds the platform packages at the version pinned in `optionalDependencies`, and checks that all four pins agree (`--verify-main`).
+2. It stages each one with `npm stage publish --provenance`, skipping versions already published or staged.
+3. Then it tests, builds and stages `@thirtified/eudi-dev`.
+4. You approve the staged versions with 2FA, on npmjs.com or with `npm stage list <pkg>` and `npm stage approve <id>`. The job summary lists them. **Approve the four platform packages first, then the main package.** npm skips a missing optional dependency silently, so a live main package without its platform packages installs without a binary.
+
+Nothing goes live without that 2FA approval. Both jobs run in the `npm` GitHub environment, which holds `NPM_TOKEN`: a granular token limited to staging. You can later replace it with npm trusted publishing, allowing only staging: `npm trust github <pkg> --repo thirtified/eudi-dev-node --file release.yml --env npm --allow-stage-publish`. `package.json` needs a `repository` field that matches the GitHub repo, for provenance. The platform packages take theirs from it, falling back to `$GITHUB_REPOSITORY`.
+
+The repo uses pnpm (the version is pinned in `packageManager`) for installing, building and testing. Publishing uses the npm CLI (`npm stage publish`), because provenance, staging and trusted publishing are defined for it. pnpm skips an optional dependency it can't fetch, so `pnpm install --frozen-lockfile` passes even while a platform package isn't on npm yet. After the platform packages are published, run `pnpm install` and commit the updated `pnpm-lock.yaml`.
+
+The unit tests use `test/fixtures/fake-eudi.mjs`, which follows the same JSON contract and logs each call, so the tests can check argument building, temp files, stdin and the environment. The fake binary is a shebang script, so the tests need macOS or Linux.
+
+### First release
+
+npm can stage versions only of packages that already exist, so publish the first version of all five packages from your machine, with 2FA:
+
+```bash
+pnpm install && pnpm run lint && pnpm test
+node scripts/build-platform-packages.mjs --verify-main     # all four into npm/, checksum-verified
+for dir in npm/*/; do npm publish "$dir" --access public --provenance=false; done
+npm publish --provenance=false                             # the main package, last
+```
+
+`--provenance=false` is needed because provenance can only be generated in CI, and `publishConfig` turns it on. These first versions therefore carry no provenance. Every later release goes through the workflow and has it.
+
+## Updating upstream
+
+The [upstream watch](.github/workflows/upstream-watch.yml) workflow opens an issue with these steps when eudi-dev publishes a new release.
+
+1. Bump `EUDI_DEV_VERSION` in `src/version.ts`.
+2. Run `node scripts/build-platform-packages.mjs --only current --out node_modules/@thirtified --sync-main`. This pins the new version in `optionalDependencies` and installs your platform's package locally.
+3. Check `CHANGELOG.md` upstream for new flags and fields, and add them to the option and result types.
+4. Run `pnpm run test:integration`.
+5. Bump the main package version and update `CHANGELOG.md`, then tag and push to release. Afterwards run `pnpm install` and commit the lockfile.
+
+## Security
+
+See [SECURITY.md](SECURITY.md). Report vulnerabilities privately, not as public issues.
+
+## License
+
+[Apache-2.0](LICENSE) © Julian Dreissig.
+
+The platform packages contain the unmodified [eudi-dev](https://github.com/eudi-dev/eudi-dev) release binaries, © Dominik Schlosser, also under Apache-2.0. Each package carries upstream's `LICENSE`.
+
+This project isn't affiliated with or endorsed by the eudi-dev project or the European Commission. "EUDI" refers to the EU Digital Identity Wallet framework.

package/dist/binary.d.ts

@@ -0,0 +1,42 @@
+/**
+ * One per-platform npm package that ships the upstream release binary.
+ * `scripts/build-platform-packages.mjs` builds them from the same table.
+ */
+export interface PlatformPackage {
+    /** npm package name, e.g. `@thirtified/eudi-dev-linux-x64`. */
+    name: string;
+    /** Node `process.platform` value (`os` in package.json). */
+    os: 'darwin' | 'linux';
+    /** Node `process.arch` value (`cpu` in package.json). */
+    cpu: 'arm64' | 'x64';
+    /** Path of the binary inside the package. */
+    binPath: 'bin/eudi';
+}
+/** The platform packages listed in `optionalDependencies`. */
+export declare const PLATFORM_PACKAGES: readonly PlatformPackage[];
+export interface ResolveBinaryOptions {
+    /** Use this binary and skip the lookup. Takes precedence over `EUDI_DEV_BIN`. */
+    bin?: string;
+    /** Override the detected platform (mainly for tests). Default `process.platform`. */
+    platform?: NodeJS.Platform;
+    /** Override the detected architecture (mainly for tests). Default `process.arch`. */
+    arch?: string;
+    /**
+     * Resolves a module specifier to a file path (mainly for tests). Default
+     * `createRequire(import.meta.url).resolve`.
+     */
+    resolve?: (specifier: string) => string;
+}
+/**
+ * The platform package for a Node platform and architecture. There is none
+ * for Windows yet; `EUDI_DEV_BIN` can point to upstream's `eudi.exe`, untested.
+ */
+export declare function platformPackage(platform?: NodeJS.Platform, arch?: string): PlatformPackage;
+/**
+ * Finds the eudi-dev binary.
+ *
+ * Order: `options.bin`, `EUDI_DEV_BIN`, then the binary in the platform
+ * package (for example `@thirtified/eudi-dev-linux-x64`) that npm installed
+ * as an optional dependency.
+ */
+export declare function resolveBinary(options?: ResolveBinaryOptions): Promise<string>;

package/dist/binary.js

@@ -0,0 +1,76 @@
+import { access, constants, stat } from 'node:fs/promises';
+import { createRequire } from 'node:module';
+import { EudiDevBinaryError } from './errors.js';
+/** The platform packages listed in `optionalDependencies`. */
+export const PLATFORM_PACKAGES = [
+    { name: '@thirtified/eudi-dev-darwin-arm64', os: 'darwin', cpu: 'arm64', binPath: 'bin/eudi' },
+    { name: '@thirtified/eudi-dev-darwin-x64', os: 'darwin', cpu: 'x64', binPath: 'bin/eudi' },
+    { name: '@thirtified/eudi-dev-linux-x64', os: 'linux', cpu: 'x64', binPath: 'bin/eudi' },
+    { name: '@thirtified/eudi-dev-linux-arm64', os: 'linux', cpu: 'arm64', binPath: 'bin/eudi' },
+];
+/**
+ * The platform package for a Node platform and architecture. There is none
+ * for Windows yet; `EUDI_DEV_BIN` can point to upstream's `eudi.exe`, untested.
+ */
+export function platformPackage(platform = process.platform, arch = process.arch) {
+    const pkg = PLATFORM_PACKAGES.find((p) => p.os === platform && p.cpu === arch);
+    if (!pkg) {
+        throw new EudiDevBinaryError(`eudi-dev publishes no binary for ${platform}/${arch}. Set EUDI_DEV_BIN to an eudi binary you built with "go build".`);
+    }
+    return pkg;
+}
+async function isExecutableFile(path) {
+    try {
+        const s = await stat(path);
+        if (!s.isFile())
+            return false;
+        if (process.platform !== 'win32')
+            await access(path, constants.X_OK);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Finds the eudi-dev binary.
+ *
+ * Order: `options.bin`, `EUDI_DEV_BIN`, then the binary in the platform
+ * package (for example `@thirtified/eudi-dev-linux-x64`) that npm installed
+ * as an optional dependency.
+ */
+export async function resolveBinary(options = {}) {
+    const explicit = options.bin ?? process.env.EUDI_DEV_BIN;
+    if (explicit) {
+        if (!(await isExecutableFile(explicit))) {
+            const source = options.bin ? 'bin option' : 'EUDI_DEV_BIN';
+            throw new EudiDevBinaryError(`${source} points to ${explicit}, which is not an executable file`);
+        }
+        return explicit;
+    }
+    const platform = options.platform ?? process.platform;
+    const arch = options.arch ?? process.arch;
+    const pkg = platformPackage(platform, arch);
+    const specifier = `${pkg.name}/${pkg.binPath}`;
+    const resolve = options.resolve ?? createRequire(import.meta.url).resolve;
+    let path;
+    try {
+        path = resolve(specifier);
+    }
+    catch (err) {
+        throw new EudiDevBinaryError([
+            `The eudi-dev binary package ${pkg.name} is not installed.`,
+            `It is an optional dependency of @thirtified/eudi-dev, and npm skips it when:`,
+            `  - optional dependencies are left out (--omit=optional, --no-optional, or omit=optional in .npmrc or NPM_CONFIG_OMIT)`,
+            `  - package-lock.json was created on another OS or CPU and has no entry for it (npm/cli#4828).`,
+            `    Delete node_modules and package-lock.json, then run "npm install" again.`,
+            `  - this platform (${platform}/${arch}) is not supported`,
+            `Set EUDI_DEV_BIN to an eudi binary to skip the lookup.`,
+        ].join('\n'), { cause: err });
+    }
+    if (!(await isExecutableFile(path))) {
+        throw new EudiDevBinaryError(`${path} from ${pkg.name} is not an executable file. Reinstall the package, or set EUDI_DEV_BIN to an eudi binary.`);
+    }
+    return path;
+}
+//# sourceMappingURL=binary.js.map

package/dist/binary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"binary.js","sourceRoot":"","sources":["../src/binary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAiBjD,8DAA8D;AAC9D,MAAM,CAAC,MAAM,iBAAiB,GAA+B;IAC3D,EAAE,IAAI,EAAE,mCAAmC,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE;IAC9F,EAAE,IAAI,EAAE,iCAAiC,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE;IAC1F,EAAE,IAAI,EAAE,gCAAgC,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE;IACxF,EAAE,IAAI,EAAE,kCAAkC,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE;CAC7F,CAAC;AAgBF;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,WAA4B,OAAO,CAAC,QAAQ,EAAE,OAAe,OAAO,CAAC,IAAI;IACvG,MAAM,GAAG,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,IAAI,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC;IAC/E,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,kBAAkB,CAC1B,oCAAoC,QAAQ,IAAI,IAAI,iEAAiE,CACtH,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,IAAY;IAC1C,IAAI,CAAC;QACH,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3B,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE;YAAE,OAAO,KAAK,CAAC;QAC9B,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO;YAAE,MAAM,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;QACrE,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,UAAgC,EAAE;IACpE,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;IACzD,IAAI,QAAQ,EAAE,CAAC;QACb,IAAI,CAAC,CAAC,MAAM,gBAAgB,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;YACxC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,cAAc,CAAC;YAC3D,MAAM,IAAI,kBAAkB,CAAC,GAAG,MAAM,cAAc,QAAQ,mCAAmC,CAAC,CAAC;QACnG,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC;IACtD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAC1C,MAAM,GAAG,GAAG,eAAe,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC5C,MAAM,SAAS,GAAG,GAAG,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;IAC/C,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC;IAE1E,IAAI,IAAY,CAAC;IACjB,IAAI,CAAC;QACH,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,IAAI,kBAAkB,CAC1B;YACE,+BAA+B,GAAG,CAAC,IAAI,oBAAoB;YAC3D,8EAA8E;YAC9E,wHAAwH;YACxH,gGAAgG;YAChG,8EAA8E;YAC9E,sBAAsB,QAAQ,IAAI,IAAI,oBAAoB;YAC1D,wDAAwD;SACzD,CAAC,IAAI,CAAC,IAAI,CAAC,EACZ,EAAE,KAAK,EAAE,GAAG,EAAE,CACf,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,CAAC,MAAM,gBAAgB,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,kBAAkB,CAC1B,GAAG,IAAI,SAAS,GAAG,CAAC,IAAI,2FAA2F,CACpH,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}