@pproenca/webcodecs-ffmpeg-non-free 0.1.2 → 0.1.4

package/install.js

@@ -1,14 +1,31 @@
 #!/usr/bin/env node
 /**
  * Fallback installer for when optionalDependencies are disabled.
- * Attempts to locate the platform-specific package or provides guidance.
+ * @module install
  */
 
+'use strict';
+
 const os = require('os');
 const fs = require('fs');
 
+// ----- Type Definitions -----
+
+/**
+ * @typedef {Object} PlatformInfo
+ * @property {string} os
+ * @property {string} cpu
+ * @property {string} [libc]
+ */
+
+/** @typedef {'darwin-arm64' | 'darwin-x64' | 'linux-x64' | 'linux-x64-musl' | 'linux-arm64' | 'win32-x64' | 'win32-arm64'} PlatformKey */
+
+// ----- Constants -----
+
 const TIER_SUFFIX = '-non-free';
+const PACKAGE_SCOPE = '@pproenca/webcodecs-ffmpeg';
 
+/** @type {Record<PlatformKey, PlatformInfo>} */
 const PLATFORMS = {
   'darwin-arm64': { os: 'darwin', cpu: 'arm64' },
   'darwin-x64': { os: 'darwin', cpu: 'x64' },
@@ -19,19 +36,26 @@ const PLATFORMS = {
   'win32-arm64': { os: 'win32', cpu: 'arm64' },
 };
 
+// ----- Platform Detection -----
+
 /**
- * Detect if running on musl libc (Alpine Linux, etc.)
+ * Detects if the current system uses musl libc (Alpine Linux, etc.)
+ * @returns {boolean} True if running on musl libc
  */
 function isMusl() {
   if (os.platform() !== 'linux') return false;
   try {
-    const arch = os.arch() === 'x64' ? 'x86_64' : os.arch();
-    return fs.existsSync(`/lib/ld-musl-${arch}.so.1`);
+    const muslArch = os.arch() === 'x64' ? 'x86_64' : os.arch();
+    return fs.existsSync(`/lib/ld-musl-${muslArch}.so.1`);
   } catch {
     return false;
   }
 }
 
+/**
+ * Gets the platform key for the current system
+ * @returns {string} Platform key (e.g., 'darwin-arm64', 'linux-x64-musl')
+ */
 function getPlatformKey() {
   const platform = os.platform();
   const arch = os.arch();
@@ -41,10 +65,20 @@ function getPlatformKey() {
   return `${platform}-${arch}`;
 }
 
+/**
+ * Gets the package name for a platform key
+ * @param {string} platformKey
+ * @returns {string} Full package name
+ */
 function getPackageName(platformKey) {
-  return `@pproenca/webcodecs-ffmpeg-${platformKey}-non-free`;
+  return `${PACKAGE_SCOPE}-${platformKey}${TIER_SUFFIX}`;
 }
 
+/**
+ * Checks if a package is installed
+ * @param {string} packageName
+ * @returns {boolean} True if the package can be resolved
+ */
 function checkInstalled(packageName) {
   try {
     require.resolve(packageName);
@@ -54,6 +88,8 @@ function checkInstalled(packageName) {
   }
 }
 
+// ----- Main -----
+
 function main() {
   const platformKey = getPlatformKey();
 
@@ -66,11 +102,9 @@ function main() {
   const packageName = getPackageName(platformKey);
 
   if (checkInstalled(packageName)) {
-    // Package was installed via optionalDependencies - all good
     process.exit(0);
   }
 
-  // Package not found - provide guidance
   console.warn(`[ffmpeg] Warning: Platform package not found: ${packageName}`);
   console.warn('[ffmpeg] This usually happens when --no-optional or --ignore-optional is used.');
   console.warn(`[ffmpeg] To install manually: npm install ${packageName}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pproenca/webcodecs-ffmpeg-non-free",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Prebuilt FFmpeg with all codecs including GPL x264/x265 - auto-selects platform",
   "author": "Pedro Proenca",
   "homepage": "https://github.com/pproenca/webcodecs-ffmpeg",
@@ -23,11 +23,11 @@
     "./package": "./package.json"
   },
   "optionalDependencies": {
-    "@pproenca/webcodecs-ffmpeg-darwin-arm64-non-free": "0.1.2",
-    "@pproenca/webcodecs-ffmpeg-darwin-x64-non-free": "0.1.2",
-    "@pproenca/webcodecs-ffmpeg-linux-arm64-non-free": "0.1.2",
-    "@pproenca/webcodecs-ffmpeg-linux-x64-non-free": "0.1.2",
-    "@pproenca/webcodecs-ffmpeg-linux-x64-musl-non-free": "0.1.2"
+    "@pproenca/webcodecs-ffmpeg-darwin-arm64-non-free": "0.1.4",
+    "@pproenca/webcodecs-ffmpeg-darwin-x64-non-free": "0.1.4",
+    "@pproenca/webcodecs-ffmpeg-linux-arm64-non-free": "0.1.4",
+    "@pproenca/webcodecs-ffmpeg-linux-x64-non-free": "0.1.4",
+    "@pproenca/webcodecs-ffmpeg-linux-x64-musl-non-free": "0.1.4"
   },
   "scripts": {
     "postinstall": "node install.js"

package/resolve.js

@@ -1,56 +1,92 @@
 /**
  * Resolves platform-specific package paths for binding.gyp.
+ * @module resolve
  *
- * Usage in binding.gyp:
- *   "library_dirs": ["<!(node -p \"require('@pproenca/webcodecs-ffmpeg-non-free/resolve').lib\")"]
- *   PKG_CONFIG_PATH: "<!(node -p \"require('@pproenca/webcodecs-ffmpeg-non-free/resolve').pkgconfig\")"
+ * @example
+ * // In binding.gyp:
+ * "library_dirs": ["<!(node -p \"require('@pproenca/webcodecs-ffmpeg-non-free/resolve').lib\")"]
+ * "PKG_CONFIG_PATH": "<!(node -p \"require('@pproenca/webcodecs-ffmpeg-non-free/resolve').pkgconfig\")"
  */
+
+'use strict';
+
 const os = require('os');
 const fs = require('fs');
 const path = require('path');
 
+// ----- Constants -----
+
 const TIER_SUFFIX = '-non-free';
+const PACKAGE_SCOPE = '@pproenca/webcodecs-ffmpeg';
+
+// ----- Platform Detection -----
 
 /**
- * Detect if running on musl libc (Alpine Linux, etc.)
+ * Detects if the current system uses musl libc (Alpine Linux, etc.)
+ * @returns {boolean} True if running on musl libc
  */
 function isMusl() {
   if (os.platform() !== 'linux') return false;
   try {
-    const arch = os.arch() === 'x64' ? 'x86_64' : os.arch();
-    return fs.existsSync(`/lib/ld-musl-${arch}.so.1`);
+    const muslArch = os.arch() === 'x64' ? 'x86_64' : os.arch();
+    return fs.existsSync(`/lib/ld-musl-${muslArch}.so.1`);
   } catch {
     return false;
   }
 }
 
+/** @type {string | null} */
+let cachedPkgPath = null;
+
+/**
+ * Resolves the platform-specific package path
+ * @returns {string} Absolute path to the platform package directory
+ * @throws {Error} If no suitable platform package is found
+ */
 function getPlatformPkgPath() {
+  if (cachedPkgPath) return cachedPkgPath;
+
   const platform = os.platform();
   const arch = os.arch();
 
   // Try musl-specific package first on Linux x64
   if (platform === 'linux' && arch === 'x64' && isMusl()) {
-    const muslPkg = `@pproenca/webcodecs-ffmpeg-linux-x64-musl${TIER_SUFFIX}`;
+    const muslPkg = `${PACKAGE_SCOPE}-linux-x64-musl${TIER_SUFFIX}`;
     try {
-      return path.dirname(require.resolve(`${muslPkg}/lib`));
+      cachedPkgPath = path.dirname(require.resolve(`${muslPkg}/lib`));
+      return cachedPkgPath;
     } catch {
       // Fall through to glibc package
     }
   }
 
-  const pkgName = `@pproenca/webcodecs-ffmpeg-${platform}-${arch}${TIER_SUFFIX}`;
+  const pkgName = `${PACKAGE_SCOPE}-${platform}-${arch}${TIER_SUFFIX}`;
   try {
-    return path.dirname(require.resolve(`${pkgName}/lib`));
-  } catch (e) {
-    throw new Error(`Platform package not found: ${pkgName}. Install it with: npm install ${pkgName}`);
+    cachedPkgPath = path.dirname(require.resolve(`${pkgName}/lib`));
+    return cachedPkgPath;
+  } catch {
+    throw new Error(
+      `Platform package not found: ${pkgName}. Install it with: npm install ${pkgName}`
+    );
   }
 }
 
+// ----- Exports -----
+
 module.exports = {
+  /**
+   * Path to the lib directory containing FFmpeg static libraries
+   * @type {string}
+   */
   get lib() {
     return path.join(getPlatformPkgPath(), 'lib');
   },
+
+  /**
+   * Path to the pkgconfig directory for pkg-config integration
+   * @type {string}
+   */
   get pkgconfig() {
     return path.join(getPlatformPkgPath(), 'lib', 'pkgconfig');
-  }
+  },
 };