@photostructure/fs-metadata 1.4.1 → 2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@photostructure/fs-metadata",
-  "version": "1.4.1",
+  "version": "2.0.0",
   "description": "Cross-platform native filesystem metadata retrieval for Node.js",
   "homepage": "https://photostructure.github.io/fs-metadata/",
   "types": "./dist/index.d.ts",
@@ -13,7 +13,7 @@
         "default": "./dist/index.cjs"
       },
       "import": {
-        "types": "./dist/index.d.ts",
+        "types": "./dist/index.d.mts",
         "default": "./dist/index.mjs"
       }
     },
@@ -46,6 +46,8 @@
     "lint:native": "tsx scripts/clang-tidy.ts",
     "lint:tsc": "tsc --noEmit",
     "lint:eslint": "eslint",
+    "// check:exports": "verify package.json exports + type declarations resolve correctly (arethetypeswrong). Requires `npm run build:dist` first.",
+    "check:exports": "attw --pack .",
     "fmt": "run-p fmt:*",
     "// fmt:cpp": "on ubuntu: `sudo apt install clang-format`. Note that windows emits `invalid format` with this || true approach, but it works and is better than introducing Yet Another Script Script (like scripts/clang-format.mjs).",
     "fmt:cpp": "clang-format --style=LLVM -i src/*.cpp src/*/*.cpp src/*/*.h || echo \"problem with clang-format\"",
@@ -68,7 +70,7 @@
     "access": "public"
   },
   "engines": {
-    "node": ">=20.0.0"
+    "node": ">=22"
   },
   "os": [
     "darwin",
@@ -90,32 +92,33 @@
     "cross-platform"
   ],
   "dependencies": {
-    "node-addon-api": "^8.7.0",
+    "node-addon-api": "^8.8.0",
     "node-gyp-build": "^4.8.4"
   },
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.3",
     "@types/jest": "^30.0.0",
-    "@types/node": "^25.6.0",
+    "@types/node": "^25.9.1",
     "@types/semver": "^7.7.1",
     "cross-env": "^10.1.0",
     "del-cli": "^7.0.0",
     "eslint": "9.39.1",
     "eslint-plugin-regexp": "^3.1.0",
     "eslint-plugin-security": "^4.0.0",
-    "globals": "^17.5.0",
-    "jest": "^30.3.0",
-    "jest-environment-node": "^30.3.0",
+    "globals": "^17.6.0",
+    "jest": "^30.4.2",
+    "jest-environment-node": "^30.4.1",
     "jest-extended": "^7.0.0",
     "node-gyp": "^12.3.0",
-    "npm-check-updates": "^22.0.1",
-    "npm-run-all2": "8.0.4",
+    "npm-check-updates": "^22.2.2",
+    "npm-run-all2": "9.0.1",
     "prebuildify": "^6.0.1",
     "prettier": "^3.8.3",
     "prettier-plugin-organize-imports": "4.3.0",
-    "terser": "^5.46.2",
-    "ts-jest": "^29.4.9",
+    "terser": "^5.48.0",
+    "ts-jest": "^29.4.11",
     "tsup": "^8.5.1",
-    "tsx": "^4.21.0",
+    "tsx": "^4.22.4",
     "typedoc": "^0.28.19",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.57.2"

package/scripts/post-build.mjs

@@ -7,15 +7,24 @@ import { fileURLToPath } from "node:url";
 const __dirname = dirname(fileURLToPath(import.meta.url));
 const distDir = join(__dirname, "..", "dist");
 
-// Copy .d.ts to .d.cts for CommonJS type safety
-async function createCjsTypes() {
+// Copy .d.ts to .d.cts and .d.mts so each exports condition resolves to a
+// declaration file whose module format matches its JavaScript counterpart.
+//
+// Without a .d.mts file, the `import` condition's types (`index.d.ts`) are
+// interpreted as CommonJS (the package has no `"type": "module"`), while the
+// resolved JavaScript (`index.mjs`) is ESM. That mismatch is the "Masquerading
+// as CJS" / FalseCJS problem reported by arethetypeswrong. A .d.cts pairs with
+// the CJS `.cjs` output; a .d.mts pairs with the ESM `.mjs` output.
+async function createDualTypes() {
   try {
     await copyFile(join(distDir, "index.d.ts"), join(distDir, "index.d.cts"));
     console.log("Created index.d.cts for CommonJS type safety");
+    await copyFile(join(distDir, "index.d.ts"), join(distDir, "index.d.mts"));
+    console.log("Created index.d.mts for ESM type safety");
   } catch (error) {
-    console.error("Error creating .d.cts file:", error);
+    console.error("Error creating dual declaration files:", error);
     process.exit(1);
   }
 }
 
-createCjsTypes();
+createDualTypes();

package/scripts/prebuildify-wrapper.ts

@@ -21,6 +21,11 @@ console.log(`Building for platform: ${currentPlatform}, arch: ${currentArch}`);
 // Set up environment variables to help node-gyp
 const env = { ...process.env };
 
+// Architecture-specific compiler defines for Windows. Tracked in a local so we
+// can log the value we set without reading it back out of the environment
+// (which CodeQL flags as clear-text logging of process environment data).
+let clDefines: string | undefined;
+
 // Set architecture-specific defines for Windows
 if (currentPlatform === "win32") {
   // Try various environment variables that might work
@@ -30,9 +35,13 @@ if (currentPlatform === "win32") {
 
   // Try setting compiler flags directly
   if (currentArch === "x64") {
-    env.CL = "/D_M_X64 /D_WIN64 /D_AMD64_";
+    clDefines = "/D_M_X64 /D_WIN64 /D_AMD64_";
   } else if (currentArch === "arm64") {
-    env.CL = "/D_M_ARM64 /D_WIN64";
+    clDefines = "/D_M_ARM64 /D_WIN64";
+  }
+
+  if (clDefines) {
+    env.CL = clDefines;
   }
 }
 
@@ -53,8 +62,8 @@ if (process.argv.length > 2) {
 }
 
 console.log(`Running: prebuildify ${args.join(" ")}`);
-if (currentPlatform === "win32" && env.CL) {
-  console.log(`CL environment variable: ${env.CL}`);
+if (currentPlatform === "win32" && clDefines) {
+  console.log(`CL environment variable: ${clDefines}`);
 }
 
 // Spawn prebuildify with the arguments

package/scripts/precommit.ts

@@ -36,6 +36,10 @@ run({ cmd: "npm run fmt", desc: "Formatting code" });
 run({ cmd: "npm run lint", desc: "Running linting checks" });
 run({ cmd: "npm run docs", desc: "TypeDoc generation" });
 run({ cmd: "npm run build:dist", desc: "Building distribution files" });
+run({
+  cmd: "npm run check:exports",
+  desc: "Verifying package exports & type declarations (arethetypeswrong)",
+});
 
 // Detect if we're using glibc (vs musl)
 // Check process.report for musl loader - if not found, assume glibc

package/src/common/metadata_worker.h

@@ -14,7 +14,8 @@ protected:
 
   MetadataWorkerBase(const std::string &path,
                      const Napi::Promise::Deferred &deferred)
-      : SafeAsyncWorker(deferred.Env()), mountPoint(path), deferred_(deferred) {}
+      : SafeAsyncWorker(deferred.Env()), mountPoint(path), deferred_(deferred) {
+  }
 
   void OnError(const Napi::Error &error) override {
     Napi::HandleScope scope(Env());

package/src/common/shutdown.h

@@ -4,9 +4,9 @@
 // can never escape AsyncWorker callbacks.
 //
 // Why this exists: AsyncWorker::OnWorkComplete can run during
-// node::FreeEnvironment cleanup. If napi_resolve_deferred / napi_reject_deferred
-// fail at that point (env tearing down), node-addon-api throws a C++
-// Napi::Error. With NAPI_CPP_EXCEPTIONS the rethrow path inside
+// node::FreeEnvironment cleanup. If napi_resolve_deferred /
+// napi_reject_deferred fail at that point (env tearing down), node-addon-api
+// throws a C++ Napi::Error. With NAPI_CPP_EXCEPTIONS the rethrow path inside
 // WrapVoidCallback then calls ThrowAsJavaScriptException, which can also fail,
 // letting the C++ exception escape into a libuv cleanup hook frame that has
 // no catch - terminate() / SIGABRT.
@@ -150,9 +150,7 @@ protected:
 
   void SetError(const std::string &error) { error_ = error; }
 
-  bool IsShuttingDown() const {
-    return FSMeta::IsShuttingDown(shutdownState_);
-  }
+  bool IsShuttingDown() const { return FSMeta::IsShuttingDown(shutdownState_); }
 
 private:
   std::shared_ptr<ShutdownState> shutdownState_;

package/src/fs.ts

@@ -10,7 +10,10 @@ import { withTimeout } from "./async";
  */
 export async function statAsync(
   path: PathLike,
-  options?: StatOptions & { bigint?: false },
+  // `throwIfNoEntry?: true` selects the overload that resolves to
+  // Promise<Stats> rather than Promise<Stats | undefined>; this wrapper always
+  // throws (rather than returning undefined) when the path doesn't exist.
+  options?: StatOptions & { bigint?: false; throwIfNoEntry?: true },
 ): Promise<Stats> {
   return stat(path, options);
 }