@pnpm/napi 12.8.2 → 12.9.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @pnpm/napi
 
+## 12.9.0
+
+### Minor Changes
+
+- `install()` accepts a `readPackageHookChecksum` option. The checksum is recorded as the lockfile's `pnpmfileChecksum`. While it stays the same, installs with a `readPackageHook` reuse the resolved dependencies in the lockfile. Without it, an install with a hook that has to update the lockfile resolves all dependencies again.
+
+### Patch Changes
+
+- The install summary shows a `link:` dependency as `+ name <- path` again, and the Node.js API's `hideLinkedPkgsDiff` reporter option leaves matching linked dependencies out of the summary.
+
 ## 12.8.2
 
 ### Patch Changes

package/README.md

@@ -1,6 +1,6 @@
 # @pnpm/napi
 
-Node.js bindings for pnpm v12's Rust engine (pacquet), exposing pnpm's
+Node.js bindings for the pnpm engine, exposing pnpm's
 programmatic API — install, rebuild, dependency resolution, and pack — to a
 JavaScript host. The reference consumer is [Bit](https://bit.dev), which drives
 pnpm entirely through its programmatic API.
@@ -26,7 +26,7 @@ See [`index.d.ts`](./index.d.ts) for the full typed contract.
 
 | Export | Purpose |
 | --- | --- |
-| `install(options, onLog?, readPackageHook?, onOutput?)` | Install in-memory importers (single or workspace); `readPackageHook` transforms each resolved dependency manifest (must be synchronous). Returns `{ stats, depsRequiringBuild?, storeDir }`. |
+| `install(options, onLog?, readPackageHook?, onOutput?)` | Install in-memory importers (single or workspace); `readPackageHook` transforms each resolved dependency manifest (must be synchronous). Pass `options.readPackageHookChecksum` so installs reuse the lockfile while the hook is unchanged. Returns `{ stats, depsRequiringBuild?, storeDir }`. |
 | `rebuild(options, onLog?, selectedNames?, onOutput?)` | Re-run dependency build scripts against a materialized install (frozen path). |
 | `resolveDependency(wanted, options)` | Resolve an npm-registry specifier to `{ id, manifest, resolvedVia, … }`. |
 | `pack(options, onLog?)` | Build a publishable `.tgz` from a project directory. |
@@ -36,7 +36,7 @@ See [`index.d.ts`](./index.d.ts) for the full typed contract.
 | `readLockfile(options)` / `writeLockfile(options)` | Read and write `pnpm-lock.yaml` (or the current lockfile under the virtual store) with the engine's own parser and emitter. |
 | `filterLockfileByImporters(lockfile, importerIds, options?)` | Narrow a lockfile to the transitive closure of what the named importers reach. |
 | `readModulesManifest(modulesDir)` | The `.modules.yaml` state of an installed `node_modules`. |
-| `engineVersion()` | Version string of the underlying Rust engine (pacquet). |
+| `engineVersion()` | Version string of the pnpm engine. |
 | `getPeerDependencyIssues(options)` | Resolve the in-memory importers without writing an install and return missing or incompatible peer dependencies by importer. `autoInstallPeers` defaults to `false` for this query. |
 
 ### Output
@@ -50,7 +50,7 @@ however it likes.
 By default the rendered chunks go to stdout. Pass `onOutput` to receive them
 instead, for a host that has redirected its own output at the JavaScript
 level (a monkey-patched `process.stdout.write`, a stream forwarding to a
-remote terminal) where a write from Rust would bypass the redirection. Pass
+remote terminal) where a write from the engine would bypass the redirection. Pass
 `reporter.width` alongside it: the engine cannot see where those chunks end
 up.
 
@@ -75,9 +75,9 @@ the named importers keep only the dependency groups asked for, and
 `renderDependents` returns them rendered as a string — it prints nothing
 itself — mirroring the split between
 `@pnpm/deps.inspection.tree-builder` and `@pnpm/deps.inspection.list`. The
-split is also what replaces that API's `nameFormatter` callback: the tree
-walk is synchronous Rust and cannot call back into JavaScript, so a host
-that renames nodes after a manifest field asks for the field via
+walk cannot call back into JavaScript, so that API's `nameFormatter`
+callback has no counterpart here: a host that renames nodes after a
+manifest field asks for the field via
 `manifestFields`, writes `displayName` onto the returned trees, and passes
 them back to be rendered.
 

package/index.d.ts

@@ -1,9 +1,9 @@
 /**
- * Node API bindings for the pnpm v12 Rust engine (pacquet).
+ * Node.js bindings for the pnpm engine.
  *
- * Shapes intentionally mirror the pnpm v11 TypeScript programmatic API
- * (`@pnpm/installing.deps-installer`, `@pnpm/installing.client`) so that
- * consumers migrating from the TS engine keep their call sites stable.
+ * Shapes mirror the programmatic API of `@pnpm/installing.deps-installer`
+ * and `@pnpm/installing.client`, so call sites written for those packages
+ * carry over.
  */
 
 export interface PackageManifest {
@@ -250,6 +250,14 @@ export interface InstallOptions extends SharedEngineOptions {
    * at all).
    */
   reporter?: ReporterOptions
+  /**
+   * Recorded as the lockfile's `pnpmfileChecksum` for the `readPackageHook`
+   * passed to the same call. Change it whenever the hook's behavior changes.
+   * The lockfile is reused while it stays the same. Without it the engine
+   * cannot tell whether the hook changed, so every install with a hook
+   * resolves again.
+   */
+  readPackageHookChecksum?: string
 }
 
 /** pnpm's `peerDependencyRules`. */
@@ -304,9 +312,7 @@ export interface ReporterOptions {
    * packages-diff summary — an entry is linked when it was symlinked in
    * rather than materialized from the store. A host that links its own
    * runtime into every project silences that noise without silencing the
-   * same packages when they are really installed. The Rust counterpart of
-   * the TypeScript reporter's `filterPkgsDiff` callback, which cannot
-   * cross the addon boundary.
+   * same packages when they are really installed.
    */
   hideLinkedPkgsDiff?: string[]
   /** Verbosity ceiling. Defaults to `'info'`. */
@@ -332,7 +338,7 @@ export interface ReporterOptions {
  * Receives each rendered output chunk instead of the engine writing it to
  * a file descriptor. For a host that has redirected its own output at the
  * JavaScript level — a monkey-patched `process.stdout.write`, a stream
- * that forwards to a remote terminal — where a write from Rust would
+ * that forwards to a remote terminal — where a write from the engine would
  * bypass the redirection. Chunks arrive in order and already carry their
  * newlines and cursor-control sequences; write them verbatim.
  */
@@ -361,6 +367,7 @@ export interface InstallResult {
  * @param readPackageHook a **synchronous** `(manifest, resolvedDir?) => manifest`
  *   transform applied to every resolved dependency manifest during resolution
  *   (the `readPackage` hook). Must return the manifest object, not a promise.
+ *   Pass `options.readPackageHookChecksum` to let installs reuse the lockfile.
  * @param onOutput receives the rendered output of `options.reporter`
  *   instead of the engine writing it to stdout/stderr.
  */
@@ -605,11 +612,9 @@ export interface DependentsOptions {
   virtualStoreDirMaxLength?: number
   /**
    * `package.json` fields to project onto every package node as
-   * `manifest`. This is what the TypeScript tree-builder's `nameFormatter`
-   * callback is for: the walk is synchronous Rust and cannot call back
-   * into JavaScript, so a host that renames nodes after a manifest field
-   * asks for that field here, writes `displayName` on the returned trees,
-   * and passes them to {@link renderDependents}. Nodes whose manifest is
+   * `manifest`. A host that renames nodes after a manifest field asks for
+   * that field here, writes `displayName` on the returned trees, and
+   * passes them to {@link renderDependents}. Nodes whose manifest is
    * unreadable — and every workspace-project node — carry none.
    */
   manifestFields?: string[]
@@ -787,5 +792,5 @@ export function filterLockfileByImporters<Lockfile = LockfileFile>(
  */
 export function readModulesManifest(modulesDir: string): Promise<Record<string, unknown> | null>
 
-/** Version of the underlying Rust engine (pacquet). */
+/** Version of the pnpm engine. */
 export function engineVersion(): string

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnpm/napi",
-  "version": "12.8.2",
+  "version": "12.9.0",
   "description": "Node.js addon bindings for the pnpm v12 Rust engine (pacquet)",
   "keywords": [
     "pnpm",
@@ -28,20 +28,20 @@
     "THIRD-PARTY-NOTICES.md"
   ],
   "optionalDependencies": {
-    "@pnpm/napi.win32-x64": "12.8.2",
-    "@pnpm/napi.win32-arm64": "12.8.2",
-    "@pnpm/napi.darwin-x64": "12.8.2",
-    "@pnpm/napi.darwin-arm64": "12.8.2",
-    "@pnpm/napi.linux-x64": "12.8.2",
-    "@pnpm/napi.linux-arm64": "12.8.2",
-    "@pnpm/napi.linux-riscv64": "12.8.2",
-    "@pnpm/napi.linux-ppc64": "12.8.2",
-    "@pnpm/napi.linux-s390x": "12.8.2",
-    "@pnpm/napi.linux-x64-musl": "12.8.2",
-    "@pnpm/napi.linux-arm64-musl": "12.8.2",
-    "@pnpm/napi.freebsd-x64": "12.8.2",
-    "@pnpm/napi.android-arm64": "12.8.2",
-    "@pnpm/napi.android-x64": "12.8.2"
+    "@pnpm/napi.win32-x64": "12.9.0",
+    "@pnpm/napi.win32-arm64": "12.9.0",
+    "@pnpm/napi.darwin-x64": "12.9.0",
+    "@pnpm/napi.darwin-arm64": "12.9.0",
+    "@pnpm/napi.linux-x64": "12.9.0",
+    "@pnpm/napi.linux-arm64": "12.9.0",
+    "@pnpm/napi.linux-riscv64": "12.9.0",
+    "@pnpm/napi.linux-ppc64": "12.9.0",
+    "@pnpm/napi.linux-s390x": "12.9.0",
+    "@pnpm/napi.linux-x64-musl": "12.9.0",
+    "@pnpm/napi.linux-arm64-musl": "12.9.0",
+    "@pnpm/napi.freebsd-x64": "12.9.0",
+    "@pnpm/napi.android-arm64": "12.9.0",
+    "@pnpm/napi.android-x64": "12.9.0"
   },
   "scripts": {
     "generate-packages": "node scripts/generate-packages.mjs"