@landstrip/landstrip-api 0.19.13 → 0.19.14

package/README.md

@@ -1,60 +1,43 @@
 # @landstrip/landstrip-api
 
-Node.js wrapper, native binaries, and TypeScript types for the Landstrip sandbox.
-Requires Node.js 18 or newer; binaries are provided for Linux, macOS, and Windows
-on x64 and arm64.
+Node.js wrapper and types for Landstrip. Requires Node.js ≥18; native binaries
+support Linux, macOS, and Windows on x64/arm64.
 
-## Install and run
+## Install
 
 ```sh
 npm install --save-dev @landstrip/landstrip-api
-npx landstrip run -p policy.json -- cargo test
 ```
 
-See the [quick start](../../README.md#quick-start) for an example policy and
-[landstrip(1)](../landstrip/man/man1/landstrip.1) for CLI options, policy rules,
-and platform limits.
+See the [quick start](../../README.md#quick-start) for a policy and CLI example;
+[landstrip(1)](../landstrip/man/man1/landstrip.1) covers policy and platform limits.
 
 ## Node.js API
 
 ```js
-const { execFileSync } = require('node:child_process');
-const { binaryPath } = require('@landstrip/landstrip-api');
+const { execFileSync } = require("node:child_process");
+const { binaryPath } = require("@landstrip/landstrip-api");
 
-execFileSync(binaryPath(), ['run', '-p', 'policy.json', '--', 'cargo', 'test'], {
-  stdio: 'inherit',
+execFileSync(binaryPath(), ["run", "-p", "policy.json", "--", "cargo", "test"], {
+  stdio: "inherit",
 });
 ```
 
-`binaryPath()` returns the installed native binary's canonical path and checks
-that it belongs to an official Landstrip package. It throws if the platform is
-unsupported, the binary is missing, or package ownership cannot be verified.
-`packageName()` returns the platform's binary package name. Both accept optional
-`platform` and `arch` arguments, defaulting to the current process.
+`binaryPath()` resolves an official installed binary or throws; `packageName()`
+returns its package name. Both accept `platform` and `arch`, defaulting to the
+current process.
 
-The package exports [`LandstripTrap` and `LandstripControlResponse`](lib/index.d.ts)
-for structured events and Linux broker replies. Runtime traps and approval
-queries are Linux-only; macOS's `--trap` reports setup and launch failures.
-Descriptor lifetimes and the reply protocol are covered in the manual.
+Types: [`LandstripTrap`, `LandstripControlResponse`](lib/index.d.ts).
+Proxy helpers: [`/proxy`](lib/proxy.d.ts). [`/shared`](lib/shared.d.ts) provides:
 
-Integration helpers are exported through [`/shared`](lib/shared.d.ts) and
-[`/proxy`](lib/proxy.d.ts).
-
-`decodeLandstripTrap(value)` and `parseTrapLine(line)` from `/shared` return a
-validated `LandstripTrap`, or `null` for malformed input. Extra fields are
-preserved. Missing or unknown denial states are normalized to `info`, never
-queries; query IDs must be decimal `u64` strings and nonzero for queries.
-`isQueryTrap(trap)` narrows validated events to `LandstripQueryTrap` with
-`state: 'query'`. The declarations include all five native mechanisms and the
-current Windows error codes; the previously declared `POLICY_TCP_BIND_UNSUPPORTED`
-code remains accepted alongside `POLICY_LOCAL_BINDING_UNSUPPORTED`.
-
-`writeLandstripPolicyFile(policy, prefix = 'landstrip-')` from `/shared` writes
-`policy.json` and returns `{ dir, path }`. The caller owns `dir` and must remove it
-with `rmSync(dir, { recursive: true, force: true })` after use. Serialization
-happens before directory creation; failed writes remove partial files and their
-directory. If cleanup also fails, an `AggregateError` reports both errors and the
-directory path.
+- `decodeLandstripTrap(value)` / `parseTrapLine(line)`: validated trap or `null`.
+  Extra fields survive; missing/unknown denial states become `info`, never queries.
+- `isQueryTrap(trap)`: narrows validated events to `LandstripQueryTrap`.
+  Query IDs are decimal `u64` strings, nonzero for queries.
+- `writeLandstripPolicyFile(policy, prefix = 'landstrip-')`: returns `{ dir, path }`.
+  Remove `dir` with `rmSync(dir, { recursive: true, force: true })` after use.
+  Failed writes clean up; failed cleanup reports both errors and the directory
+  path in an `AggregateError`.
 
 ## Development
 
@@ -62,5 +45,5 @@ Run `make ci` from the repository root.
 
 ## License
 
-[Apache-2.0](LICENSE). The bundled native binary is
+[Apache-2.0](LICENSE); bundled native binaries are
 [LGPL-3.0-or-later](../landstrip/LICENSE).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@landstrip/landstrip-api",
-  "version": "0.19.13",
+  "version": "0.19.14",
   "description": "Sandbox runner using Landlock, Seatbelt, and AppContainer",
   "license": "Apache-2.0",
   "homepage": "https://github.com/landstrip/landstrip#readme",
@@ -40,12 +40,12 @@
     "ipaddr.js": "^2.5.0"
   },
   "optionalDependencies": {
-    "@landstrip/landstrip-darwin-arm64": "0.19.13",
-    "@landstrip/landstrip-darwin-x64": "0.19.13",
-    "@landstrip/landstrip-linux-x64": "0.19.13",
-    "@landstrip/landstrip-linux-arm64": "0.19.13",
-    "@landstrip/landstrip-win32-x64": "0.19.13",
-    "@landstrip/landstrip-win32-arm64": "0.19.13"
+    "@landstrip/landstrip-darwin-arm64": "0.19.14",
+    "@landstrip/landstrip-darwin-x64": "0.19.14",
+    "@landstrip/landstrip-linux-x64": "0.19.14",
+    "@landstrip/landstrip-linux-arm64": "0.19.14",
+    "@landstrip/landstrip-win32-x64": "0.19.14",
+    "@landstrip/landstrip-win32-arm64": "0.19.14"
   },
   "publishConfig": {
     "access": "public"