@pnpm/napi 12.0.0-beta.1 → 12.0.0-beta.3

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @pnpm/napi
 
+## 12.0.0-beta.3
+
+### Minor Changes
+
+- `readConfig` now returns `explicitSettings` — the camelCase names of settings the config cascade set explicitly — so hosts that layer the resolved config over their own defaults can forward only the values the user actually configured.
+
+- Added a `returnListOfDepsRequiringBuild` install option. When it is set, `InstallResult.depsRequiringBuild` lists the dep path of every package whose files carry install scripts, whether or not the scripts were allowed to run, matching the TypeScript CLI's option of the same name. An install that computes no list, such as one served from the lockfile, leaves the field undefined.
+
+## 12.0.0-beta.2
+
+### Minor Changes
+
+- Added `readConfig(options)`: resolves the configuration the engine's own installs use — registries with their resolved `Authorization` headers, `authHeaderByUri`, proxy, TLS, network limits, store/cache directories, and install behavior settings from the `.npmrc` / `pnpm-workspace.yaml` cascade — so hosts that embed the engine no longer need a JavaScript config reader.
+
 ## 12.0.0-beta.1
 
 ### Minor Changes

package/index.d.ts

@@ -197,6 +197,15 @@ export interface InstallOptions extends SharedEngineOptions {
    * `InstallResult.depsRequiringBuild` instead.
    */
   strictDepBuilds?: boolean
+  /**
+   * Report in `InstallResult.depsRequiringBuild` the dep path of every
+   * package whose files carry install scripts, regardless of the
+   * allow-build policy. The list is computed only when a fresh resolve
+   * materializes `node_modules`; an install served from the
+   * frozen-lockfile path (or `lockfileOnly`) leaves the field undefined
+   * so the embedder keeps its previously recorded list.
+   */
+  returnListOfDepsRequiringBuild?: boolean
   /** Customizations for how peer-dependency mismatches are treated. */
   peerDependencyRules?: PeerDependencyRules
 }
@@ -214,7 +223,13 @@ export interface InstallResult {
     removed: number
     linkedToRoot: number
   }
-  /** Dep paths whose build scripts were skipped and require approval to run. */
+  /**
+   * With `returnListOfDepsRequiringBuild`: the dep path of every package
+   * whose files carry install scripts, whether or not the scripts were
+   * allowed to run; undefined when the install did not compute the list
+   * (see the option). Without it: the dep paths whose build scripts were
+   * skipped and require approval to run.
+   */
   depsRequiringBuild?: string[]
   /** The resolved content-addressable store directory used by this install. */
   storeDir: string
@@ -329,5 +344,92 @@ export interface ParsedBareSpecifier {
 /** Parses/validates a dependency specifier. Returns null for unparsable input. */
 export function parseBareSpecifier(spec: string, alias?: string): ParsedBareSpecifier | null
 
+export interface ReadConfigOptions {
+  /**
+   * Directory whose config cascade to resolve — its `.npmrc`, the enclosing
+   * workspace's `pnpm-workspace.yaml` and `.npmrc`, the user and global
+   * config files, and `npm_config_*` environment variables.
+   */
+  dir: string
+}
+
+/** One configured registry: the `default` entry plus one per `@scope`. */
+export interface ResolvedRegistry {
+  /** `"default"` or the package scope (`"@teambit"`). */
+  name: string
+  url: string
+  /**
+   * Ready-to-send `Authorization` header for this registry, when the config
+   * carries a static credential for it. `tokenHelper` credentials are not
+   * executed here and yield no header.
+   */
+  authHeader?: string
+}
+
+export interface ResolvedConfig {
+  registries: ResolvedRegistry[]
+  /**
+   * Static `Authorization` headers keyed by nerf-darted registry URI
+   * (`//host[:port]/path/`) — the shape `install`'s `authHeaderByUri`
+   * accepts.
+   */
+  authHeaderByUri: Record<string, string>
+  httpProxy?: string
+  httpsProxy?: string
+  /** `true` (bypass every proxy) or a comma-separated host list. */
+  noProxy?: boolean | string
+  /** PEM-encoded CA certificates (`ca` / `cafile` already merged). */
+  ca?: string[]
+  cert?: string
+  key?: string
+  strictSsl?: boolean
+  storeDir: string
+  cacheDir: string
+  virtualStoreDirMaxLength: number
+  networkConcurrency: number
+  maxSockets?: number
+  fetchRetries: number
+  fetchRetryFactor: number
+  fetchRetryMintimeout: number
+  fetchRetryMaxtimeout: number
+  fetchTimeout: number
+  /**
+   * The explicitly configured user agent, when the cascade set one. The
+   * engine's own computed default is omitted — an embedder that passes
+   * nothing back to `install` gets that same default.
+   */
+  userAgent?: string
+  engineStrict: boolean
+  nodeVersion?: string
+  /** `"auto"` / `"hardlink"` / `"copy"` / `"clone"` / `"clone-or-copy"`. */
+  packageImportMethod: string
+  hoistPattern?: string[]
+  publicHoistPattern?: string[]
+  /**
+   * The legacy `shamefullyHoist` flag; `publicHoistPattern` already
+   * reflects it, exposed for embedders that branch on the flag itself.
+   */
+  shamefullyHoist: boolean
+  /**
+   * The engine's pnpm home directory (`PNPM_HOME` or the platform default) —
+   * not a per-project setting. Absent when no home directory is resolvable.
+   */
+  pnpmHomeDir?: string
+  /**
+   * The camelCase names of settings the cascade set explicitly
+   * (`pnpm-workspace.yaml`, the global config, `pnpm_config_*` env vars).
+   * Every other projected value is an engine default; an embedder that
+   * layers this config over its own must forward only the explicit ones.
+   */
+  explicitSettings: string[]
+}
+
+/**
+ * Resolve the configuration the engine's own installs use — registries,
+ * credentials, proxy, TLS, and network settings from the `.npmrc` cascade —
+ * so the embedder needs no JavaScript config reader.
+ */
+export function readConfig(options: ReadConfigOptions): ResolvedConfig
+
 /** Version of the underlying Rust engine (pacquet). */
 export function engineVersion(): string

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnpm/napi",
-  "version": "12.0.0-beta.1",
+  "version": "12.0.0-beta.3",
   "description": "Node.js addon bindings for the pnpm v12 Rust engine (pacquet)",
   "keywords": [
     "pnpm",
@@ -27,14 +27,14 @@
     "README.md"
   ],
   "optionalDependencies": {
-    "@pnpm/napi.win32-x64": "12.0.0-beta.1",
-    "@pnpm/napi.win32-arm64": "12.0.0-beta.1",
-    "@pnpm/napi.darwin-x64": "12.0.0-beta.1",
-    "@pnpm/napi.darwin-arm64": "12.0.0-beta.1",
-    "@pnpm/napi.linux-x64": "12.0.0-beta.1",
-    "@pnpm/napi.linux-arm64": "12.0.0-beta.1",
-    "@pnpm/napi.linux-x64-musl": "12.0.0-beta.1",
-    "@pnpm/napi.linux-arm64-musl": "12.0.0-beta.1"
+    "@pnpm/napi.win32-x64": "12.0.0-beta.3",
+    "@pnpm/napi.win32-arm64": "12.0.0-beta.3",
+    "@pnpm/napi.darwin-x64": "12.0.0-beta.3",
+    "@pnpm/napi.darwin-arm64": "12.0.0-beta.3",
+    "@pnpm/napi.linux-x64": "12.0.0-beta.3",
+    "@pnpm/napi.linux-arm64": "12.0.0-beta.3",
+    "@pnpm/napi.linux-x64-musl": "12.0.0-beta.3",
+    "@pnpm/napi.linux-arm64-musl": "12.0.0-beta.3"
   },
   "scripts": {
     "generate-packages": "node scripts/generate-packages.mjs"