@pnpm/lockfile.fs 1100.1.2 → 1100.1.3

package/lib/read.d.ts

@@ -1,4 +1,4 @@
-import type { LockfileObject } from '@pnpm/lockfile.types';
+import type { LockfileFile, LockfileObject } from '@pnpm/lockfile.types';
 import type { ProjectId } from '@pnpm/types';
 export declare function readCurrentLockfile(pnpmInternalDir: string, opts: {
     wantedVersions?: string[];
@@ -19,6 +19,20 @@ export declare function readWantedLockfile(pkgPath: string, opts: {
     useGitBranchLockfile?: boolean;
     mergeGitBranchLockfiles?: boolean;
 }): Promise<LockfileObject | null>;
+/**
+ * Read the wanted lockfile in its on-disk shape ({@link LockfileFile}),
+ * skipping the conversion to the in-memory {@link LockfileObject}.
+ *
+ * Use this when the caller needs the exact serialized form — e.g. to
+ * forward the lockfile to a server that speaks the on-disk format —
+ * rather than the in-process representation.
+ */
+export declare function readWantedLockfileFile(pkgPath: string, opts: {
+    wantedVersions?: string[];
+    ignoreIncompatible: boolean;
+    useGitBranchLockfile?: boolean;
+    mergeGitBranchLockfiles?: boolean;
+}): Promise<LockfileFile | null>;
 export declare function wantedLockfileHasMergeConflictsSync(pkgPath: string): boolean;
 export declare function createLockfileObject(importerIds: ProjectId[], opts: {
     lockfileVersion: string;

package/lib/read.js

@@ -11,7 +11,7 @@ import stripBom from 'strip-bom';
 import { LockfileBreakingChangeError } from './errors/index.js';
 import { getGitBranchLockfileNames } from './gitBranchLockfile.js';
 import { autofixMergeConflicts, isDiff } from './gitMergeFile.js';
-import { convertToLockfileObject } from './lockfileFormatConverters.js';
+import { convertToLockfileFile, convertToLockfileObject } from './lockfileFormatConverters.js';
 import { getWantedLockfileName } from './lockfileName.js';
 import { lockfileLogger as logger } from './logger.js';
 import { extractMainDocument } from './yamlDocuments.js';
@@ -28,6 +28,17 @@ export async function readWantedLockfileAndAutofixConflicts(pkgPath, opts) {
 export async function readWantedLockfile(pkgPath, opts) {
     return (await _readWantedLockfile(pkgPath, opts)).lockfile;
 }
+/**
+ * Read the wanted lockfile in its on-disk shape ({@link LockfileFile}),
+ * skipping the conversion to the in-memory {@link LockfileObject}.
+ *
+ * Use this when the caller needs the exact serialized form — e.g. to
+ * forward the lockfile to a server that speaks the on-disk format —
+ * rather than the in-process representation.
+ */
+export async function readWantedLockfileFile(pkgPath, opts) {
+    return (await _readWantedLockfile(pkgPath, opts)).lockfileFile;
+}
 export function wantedLockfileHasMergeConflictsSync(pkgPath) {
     try {
         const lockfileRawContent = stripBom(fs.readFileSync(path.join(pkgPath, WANTED_LOCKFILE), 'utf8'));
@@ -52,6 +63,7 @@ opts) {
         }
         return {
             lockfile: null,
+            lockfileFile: null,
             hadConflicts: false,
         };
     }
@@ -60,13 +72,16 @@ opts) {
     if (!lockfileRawContent.trim()) {
         return {
             lockfile: null,
+            lockfileFile: null,
             hadConflicts: false,
         };
     }
     let lockfile;
+    let lockfileFile;
     let hadConflicts;
     try {
-        lockfile = convertToLockfileObject(yaml.load(lockfileRawContent)); // eslint-disable-line
+        lockfileFile = yaml.load(lockfileRawContent);
+        lockfile = convertToLockfileObject(lockfileFile);
         hadConflicts = false;
     }
     catch (err) {
@@ -75,6 +90,7 @@ opts) {
         }
         hadConflicts = true;
         lockfile = autofixMergeConflicts(lockfileRawContent);
+        lockfileFile = convertToLockfileFile(lockfile);
         logger.info({
             message: `Merge conflict detected in ${WANTED_LOCKFILE} and successfully merged`,
             prefix,
@@ -96,7 +112,7 @@ opts) {
                 }
                 return true;
             })) {
-            return { lockfile, hadConflicts };
+            return { lockfile, lockfileFile, hadConflicts };
         }
     }
     if (opts.ignoreIncompatible) {
@@ -104,7 +120,7 @@ opts) {
             message: `Ignoring not compatible lockfile at ${lockfilePath}`,
             prefix,
         });
-        return { lockfile: null, hadConflicts: false };
+        return { lockfile: null, lockfileFile: null, hadConflicts: false };
     }
     throw new LockfileBreakingChangeError(lockfilePath);
 }
@@ -134,13 +150,14 @@ async function _readWantedLockfile(pkgPath, opts) {
             lockfileNames.unshift(gitBranchLockfileName);
         }
     }
-    let result = { lockfile: null, hadConflicts: false };
+    let result = { lockfile: null, lockfileFile: null, hadConflicts: false };
     /* eslint-disable no-await-in-loop */
     for (const lockfileName of lockfileNames) {
         result = await _read(path.join(pkgPath, lockfileName), pkgPath, { ...opts, autofixMergeConflicts: true });
         if (result.lockfile) {
             if (opts.mergeGitBranchLockfiles) {
                 result.lockfile = await _mergeGitBranchLockfiles(result.lockfile, pkgPath, pkgPath, opts);
+                result.lockfileFile = result.lockfile ? convertToLockfileFile(result.lockfile) : null;
             }
             break;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnpm/lockfile.fs",
-  "version": "1100.1.2",
+  "version": "1100.1.3",
   "description": "Read/write pnpm-lock.yaml files",
   "keywords": [
     "pnpm",
@@ -10,7 +10,10 @@
   ],
   "license": "MIT",
   "funding": "https://opencollective.com/pnpm",
-  "repository": "https://github.com/pnpm/pnpm/tree/main/lockfile/fs",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pnpm/pnpm/tree/main/lockfile/fs"
+  },
   "homepage": "https://github.com/pnpm/pnpm/tree/main/lockfile/fs#readme",
   "bugs": {
     "url": "https://github.com/pnpm/pnpm/issues"
@@ -36,13 +39,13 @@
     "write-file-atomic": "^7.0.1",
     "@pnpm/constants": "1100.0.0",
     "@pnpm/error": "1100.0.0",
-    "@pnpm/lockfile.types": "1100.0.8",
-    "@pnpm/network.git-utils": "1100.0.1",
-    "@pnpm/lockfile.merger": "1100.0.8",
+    "@pnpm/deps.path": "1100.0.6",
+    "@pnpm/lockfile.types": "1100.0.9",
+    "@pnpm/lockfile.utils": "1100.0.11",
+    "@pnpm/types": "1101.3.0",
     "@pnpm/object.key-sorting": "1100.0.0",
-    "@pnpm/types": "1101.2.0",
-    "@pnpm/lockfile.utils": "1100.0.10",
-    "@pnpm/deps.path": "1100.0.5"
+    "@pnpm/network.git-utils": "1100.0.1",
+    "@pnpm/lockfile.merger": "1100.0.9"
   },
   "peerDependencies": {
     "@pnpm/logger": "^1001.0.1"
@@ -57,8 +60,8 @@
     "tempy": "3.0.0",
     "write-yaml-file": "^6.0.0",
     "yaml-tag": "1.1.0",
-    "@pnpm/lockfile.fs": "1100.1.2",
-    "@pnpm/logger": "1100.0.0"
+    "@pnpm/logger": "1100.0.0",
+    "@pnpm/lockfile.fs": "1100.1.3"
   },
   "engines": {
     "node": ">=22.13"