@effected/lockfiles 0.2.2 → 0.3.0

package/LockfileFormat.js

@@ -21,32 +21,59 @@ const LockfileFormat = Schema.Literals([
 	"yarn"
 ]);
 const FILENAMES = {
-	bun: "bun.lock",
-	npm: "package-lock.json",
-	pnpm: "pnpm-lock.yaml",
-	yarn: "yarn.lock"
+	bun: ["bun.lock", "bun.lockb"],
+	npm: ["package-lock.json", "npm-shrinkwrap.json"],
+	pnpm: ["pnpm-lock.yaml"],
+	yarn: ["yarn.lock"]
 };
 /**
 * The conventional lockfile filename for a format: `"bun.lock"`,
 * `"package-lock.json"`, `"pnpm-lock.yaml"` or `"yarn.lock"`.
 *
+* @remarks
+* The primary name only — the first element of {@link filenamesFor}, which is
+* what detection that must also see the genuine alternates should use.
+*
+* @public
+*/
+const filenameFor = (format) => FILENAMES[format][0];
+/**
+* Every filename a format is genuinely written under, primary first.
+*
+* @remarks
+* Real detection needs more than the conventional name: npm honours
+* `npm-shrinkwrap.json` (and prefers it over `package-lock.json` when both
+* exist — the ordering here is conventional-name-first, not npm's own
+* precedence), and bun has shipped two formats, the current text `bun.lock`
+* and the older **binary** `bun.lockb`. pnpm and yarn each have exactly one.
+*
+* Only genuine *lockfile* spellings appear here. Files that merely influence
+* what an install resolves to — `pnpm-workspace.yaml`, `.pnpmfile.cjs`, yarn's
+* PnP artifacts — are a consumer's cache policy, not alternates of the
+* lockfile.
+*
+* Two deliberate asymmetries with the rest of this module: `bun.lockb` is a
+* detection alternate but not a parse target (`Lockfile.parse` takes text; the
+* binary format fails typed), and {@link fromFilename} keeps answering for the
+* primary names only.
+*
 * @public
 */
-const filenameFor = (format) => FILENAMES[format];
+const filenamesFor = (format) => FILENAMES[format];
 /**
 * The format a lockfile filename identifies, if any.
 *
 * @remarks
 * Matches exact conventional filenames only (`"bun.lock"`,
-* `"package-lock.json"`, `"pnpm-lock.yaml"`, `"yarn.lock"`) — paths and
-* other spellings return `Option.none()`.
+* `"package-lock.json"`, `"pnpm-lock.yaml"`, `"yarn.lock"`) — paths, other
+* spellings and the {@link filenamesFor} alternates return `Option.none()`.
 *
 * @public
 */
 const fromFilename = (name) => {
-	for (const format of LockfileFormat.literals) if (FILENAMES[format] === name) return Option.some(format);
+	for (const format of LockfileFormat.literals) if (FILENAMES[format][0] === name) return Option.some(format);
 	return Option.none();
 };
 
 //#endregion
-export { LockfileFormat, filenameFor, fromFilename };
+export { LockfileFormat, filenameFor, filenamesFor, fromFilename };

package/index.d.ts

@@ -85,16 +85,43 @@ type LockfileFormat = typeof LockfileFormat.Type;
  * The conventional lockfile filename for a format: `"bun.lock"`,
  * `"package-lock.json"`, `"pnpm-lock.yaml"` or `"yarn.lock"`.
  *
+ * @remarks
+ * The primary name only — the first element of {@link filenamesFor}, which is
+ * what detection that must also see the genuine alternates should use.
+ *
  * @public
  */
 declare const filenameFor: (format: LockfileFormat) => string;
+/**
+ * Every filename a format is genuinely written under, primary first.
+ *
+ * @remarks
+ * Real detection needs more than the conventional name: npm honours
+ * `npm-shrinkwrap.json` (and prefers it over `package-lock.json` when both
+ * exist — the ordering here is conventional-name-first, not npm's own
+ * precedence), and bun has shipped two formats, the current text `bun.lock`
+ * and the older **binary** `bun.lockb`. pnpm and yarn each have exactly one.
+ *
+ * Only genuine *lockfile* spellings appear here. Files that merely influence
+ * what an install resolves to — `pnpm-workspace.yaml`, `.pnpmfile.cjs`, yarn's
+ * PnP artifacts — are a consumer's cache policy, not alternates of the
+ * lockfile.
+ *
+ * Two deliberate asymmetries with the rest of this module: `bun.lockb` is a
+ * detection alternate but not a parse target (`Lockfile.parse` takes text; the
+ * binary format fails typed), and {@link fromFilename} keeps answering for the
+ * primary names only.
+ *
+ * @public
+ */
+declare const filenamesFor: (format: LockfileFormat) => readonly [string, ...ReadonlyArray<string>];
 /**
  * The format a lockfile filename identifies, if any.
  *
  * @remarks
  * Matches exact conventional filenames only (`"bun.lock"`,
- * `"package-lock.json"`, `"pnpm-lock.yaml"`, `"yarn.lock"`) — paths and
- * other spellings return `Option.none()`.
+ * `"package-lock.json"`, `"pnpm-lock.yaml"`, `"yarn.lock"`) — paths, other
+ * spellings and the {@link filenamesFor} alternates return `Option.none()`.
  *
  * @public
  */
@@ -463,5 +490,5 @@ declare class LockfileIntegrity extends LockfileIntegrity_base {
   static compare(lockfile: Lockfile, manifests: ReadonlyArray<WorkspaceManifest>): LockfileIntegrity;
 }
 //#endregion
-export { BunExtension, ImporterDependency, Lockfile, LockfileFormat, LockfileFramingError, LockfileImporter, LockfileIntegrity, LockfileParseError, type PnpmCatalogs, PnpmExtension, ResolvedPackage, WorkspaceDependency, WorkspaceManifest, filenameFor, fromFilename };
+export { BunExtension, ImporterDependency, Lockfile, LockfileFormat, LockfileFramingError, LockfileImporter, LockfileIntegrity, LockfileParseError, type PnpmCatalogs, PnpmExtension, ResolvedPackage, WorkspaceDependency, WorkspaceManifest, filenameFor, filenamesFor, fromFilename };
 //# sourceMappingURL=index.d.ts.map

package/index.js

@@ -4,8 +4,8 @@ import { LockfileImporter } from "./LockfileImporter.js";
 import { ResolvedPackage } from "./ResolvedPackage.js";
 import { WorkspaceDependency } from "./WorkspaceDependency.js";
 import { PnpmExtension } from "./PnpmExtension.js";
-import { LockfileFormat, filenameFor, fromFilename } from "./LockfileFormat.js";
+import { LockfileFormat, filenameFor, filenamesFor, fromFilename } from "./LockfileFormat.js";
 import { Lockfile, LockfileFramingError, LockfileParseError } from "./Lockfile.js";
 import { LockfileIntegrity, WorkspaceManifest } from "./LockfileIntegrity.js";
 
-export { BunExtension, ImporterDependency, Lockfile, LockfileFormat, LockfileFramingError, LockfileImporter, LockfileIntegrity, LockfileParseError, PnpmExtension, ResolvedPackage, WorkspaceDependency, WorkspaceManifest, filenameFor, fromFilename };
+export { BunExtension, ImporterDependency, Lockfile, LockfileFormat, LockfileFramingError, LockfileImporter, LockfileIntegrity, LockfileParseError, PnpmExtension, ResolvedPackage, WorkspaceDependency, WorkspaceManifest, filenameFor, filenamesFor, fromFilename };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effected/lockfiles",
-	"version": "0.2.2",
+	"version": "0.3.0",
 	"private": false,
 	"description": "Pure lockfile parsing for bun, npm, pnpm and yarn Berry into one unified Effect schema model, with pure integrity checking against workspace manifests.",
 	"keywords": [
@@ -41,8 +41,8 @@
 	},
 	"peerDependencies": {
 		"@effected/jsonc": "~0.5.1",
-		"@effected/npm": "~0.6.0",
-		"@effected/semver": "~0.2.1",
+		"@effected/npm": "~0.8.0",
+		"@effected/semver": "~0.3.0",
 		"@effected/yaml": "~0.6.0",
 		"effect": "4.0.0-beta.101"
 	},