@pnpm/store.pkg-finder 1000.0.0-0

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2016 Rico Sta. Cruz and other contributors
+Copyright (c) 2016-2026 Zoltan Kochan and other contributors
+
+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

@@ -0,0 +1,40 @@
+# @pnpm/store.pkg-finder
+
+Resolves a package's file index from the content-addressable store (CAFS) and returns a uniform `Map<string, string>` mapping filenames to absolute paths on disk.
+
+## Usage
+
+```ts
+import { readPackageFileMap } from '@pnpm/store.pkg-finder'
+
+const files = await readPackageFileMap(
+  resolution,  // { integrity?, tarball?, directory?, type? }
+  packageId,
+  {
+    storeDir: '/home/user/.local/share/pnpm/store/v10',
+    lockfileDir: '/home/user/project',
+    virtualStoreDirMaxLength: 120,
+  }
+)
+
+if (files) {
+  const manifestPath = files.get('package.json')
+  const licensePath = files.get('LICENSE')
+}
+```
+
+## Supported resolution types
+
+- **Directory** (`type: 'directory'`): fetches the file list from the local directory.
+- **Integrity** (`integrity` field): looks up the index file in CAFS by integrity hash.
+- **Tarball** (`tarball` field): looks up the index file by package directory name.
+
+Returns `undefined` for unsupported resolution types.
+
+## Note on side effects
+
+This function returns only the original package files. Files added or removed by post-install scripts (side effects) are not included. Use the raw `PackageFilesIndex` from `@pnpm/store.cafs` if you need side-effect files.
+
+## License
+
+MIT

package/lib/index.d.ts

@@ -0,0 +1,25 @@
+import { type Resolution } from '@pnpm/resolver-base';
+export interface ReadPackageFileMapOptions {
+    storeDir: string;
+    lockfileDir: string;
+    virtualStoreDirMaxLength: number;
+}
+/**
+ * Reads the file index for a package and returns a `Map<string, string>`
+ * mapping filenames to absolute paths on disk.
+ *
+ * Handles three types of package resolutions:
+ * - Directory packages: fetches the file list from the local directory
+ * - Packages with integrity: looks up the index file in the CAFS by integrity hash
+ * - Tarball packages: looks up the index file by package directory name
+ *
+ * For CAFS packages, the content-addressed digests are resolved to file
+ * paths upfront, so callers get a uniform map regardless of resolution type.
+ *
+ * Note: this function does not include files from side effects (post-install
+ * scripts). Use the raw `PackageFilesIndex` if you need side-effect files.
+ *
+ * Returns `undefined` if the resolution type is unsupported, letting callers
+ * decide how to handle this case. Throws if the index file cannot be read.
+ */
+export declare function readPackageFileMap(packageResolution: Resolution, packageId: string, opts: ReadPackageFileMapOptions): Promise<Map<string, string> | undefined>;

package/lib/index.js

@@ -0,0 +1,49 @@
+import path from 'path';
+import { depPathToFilename, parse } from '@pnpm/dependency-path';
+import { fetchFromDir } from '@pnpm/directory-fetcher';
+import { readMsgpackFile } from '@pnpm/fs.msgpack-file';
+import { getFilePathByModeInCafs, getIndexFilePathInCafs } from '@pnpm/store.cafs';
+/**
+ * Reads the file index for a package and returns a `Map<string, string>`
+ * mapping filenames to absolute paths on disk.
+ *
+ * Handles three types of package resolutions:
+ * - Directory packages: fetches the file list from the local directory
+ * - Packages with integrity: looks up the index file in the CAFS by integrity hash
+ * - Tarball packages: looks up the index file by package directory name
+ *
+ * For CAFS packages, the content-addressed digests are resolved to file
+ * paths upfront, so callers get a uniform map regardless of resolution type.
+ *
+ * Note: this function does not include files from side effects (post-install
+ * scripts). Use the raw `PackageFilesIndex` if you need side-effect files.
+ *
+ * Returns `undefined` if the resolution type is unsupported, letting callers
+ * decide how to handle this case. Throws if the index file cannot be read.
+ */
+export async function readPackageFileMap(packageResolution, packageId, opts) {
+    if (packageResolution.type === 'directory') {
+        const localInfo = await fetchFromDir(path.join(opts.lockfileDir, packageResolution.directory), {});
+        return localInfo.filesMap;
+    }
+    const isPackageWithIntegrity = 'integrity' in packageResolution;
+    let pkgIndexFilePath;
+    if (isPackageWithIntegrity) {
+        const parsedId = parse(packageId);
+        pkgIndexFilePath = getIndexFilePathInCafs(opts.storeDir, packageResolution.integrity, parsedId.nonSemverVersion ?? `${parsedId.name}@${parsedId.version}`);
+    }
+    else if (!packageResolution.type && 'tarball' in packageResolution && packageResolution.tarball) {
+        const packageDirInStore = depPathToFilename(parse(packageId).nonSemverVersion ?? packageId, opts.virtualStoreDirMaxLength);
+        pkgIndexFilePath = path.join(opts.storeDir, packageDirInStore, 'integrity.mpk');
+    }
+    else {
+        return undefined;
+    }
+    const { files: indexFiles } = await readMsgpackFile(pkgIndexFilePath);
+    const files = new Map();
+    for (const [name, info] of indexFiles) {
+        files.set(name, getFilePathByModeInCafs(opts.storeDir, info.digest, info.mode));
+    }
+    return files;
+}
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAE,iBAAiB,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAA;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAEvD,OAAO,EAAE,uBAAuB,EAAE,sBAAsB,EAA0B,MAAM,kBAAkB,CAAA;AAQ1G;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,iBAA6B,EAC7B,SAAiB,EACjB,IAA+B,EACW;IAC1C,IAAI,iBAAiB,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QAC3C,MAAM,SAAS,GAAG,MAAM,YAAY,CAClC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,iBAAiB,CAAC,SAAS,CAAC,EACxD,EAAE,CACH,CAAA;QACD,OAAO,SAAS,CAAC,QAAQ,CAAA;IAC3B,CAAC;IAED,MAAM,sBAAsB,GAAG,WAAW,IAAI,iBAAiB,CAAA;IAE/D,IAAI,gBAAwB,CAAA;IAC5B,IAAI,sBAAsB,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAC,CAAA;QACjC,gBAAgB,GAAG,sBAAsB,CACvC,IAAI,CAAC,QAAQ,EACb,iBAAiB,CAAC,SAAmB,EACrC,QAAQ,CAAC,gBAAgB,IAAI,GAAG,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,OAAO,EAAE,CACpE,CAAA;IACH,CAAC;SAAM,IAAI,CAAC,iBAAiB,CAAC,IAAI,IAAI,SAAS,IAAI,iBAAiB,IAAI,iBAAiB,CAAC,OAAO,EAAE,CAAC;QAClG,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,gBAAgB,IAAI,SAAS,EAAE,IAAI,CAAC,wBAAwB,CAAC,CAAA;QAC1H,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAC1B,IAAI,CAAC,QAAQ,EACb,iBAAiB,EACjB,eAAe,CAChB,CAAA;IACH,CAAC;SAAM,CAAC;QACN,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,MAAM,eAAe,CAAoB,gBAAgB,CAAC,CAAA;IACxF,MAAM,KAAK,GAAG,IAAI,GAAG,EAAkB,CAAA;IACvC,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,UAAU,EAAE,CAAC;QACtC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IACjF,CAAC;IACD,OAAO,KAAK,CAAA;AAAA,CACb"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@pnpm/store.pkg-finder",
+  "version": "1000.0.0-0",
+  "description": "Read a package's file map from the content-addressable store",
+  "keywords": [
+    "pnpm",
+    "pnpm11"
+  ],
+  "license": "MIT",
+  "funding": "https://opencollective.com/pnpm",
+  "repository": "https://github.com/pnpm/pnpm/tree/main/store/pkg-finder",
+  "homepage": "https://github.com/pnpm/pnpm/tree/main/store/pkg-finder#readme",
+  "bugs": {
+    "url": "https://github.com/pnpm/pnpm/issues"
+  },
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "files": [
+    "lib",
+    "!*.map"
+  ],
+  "dependencies": {
+    "@pnpm/directory-fetcher": "1000.1.14",
+    "@pnpm/fs.msgpack-file": "1100.0.0-0",
+    "@pnpm/resolver-base": "1005.1.0",
+    "@pnpm/dependency-path": "1001.1.3",
+    "@pnpm/store.cafs": "1000.0.19"
+  },
+  "devDependencies": {
+    "@pnpm/store.pkg-finder": "1000.0.0-0"
+  },
+  "engines": {
+    "node": ">=22.13"
+  },
+  "jest": {
+    "preset": "@pnpm/jest-config"
+  },
+  "scripts": {
+    "lint": "eslint \"src/**/*.ts\"",
+    "compile": "tsgo --build && pnpm run lint --fix",
+    "test": "pnpm run compile"
+  }
+}