@caleb-collar/steamcmd 1.0.0-alpha.1 → 1.1.0

package/dist/steamcmd.mjs

@@ -0,0 +1,28 @@
+/**
+ * @module steamcmd
+ * @description ESM wrapper for steamcmd module
+ */
+
+import { createRequire } from 'module'
+const require = createRequire(import.meta.url)
+
+const steamcmd = require('./steamcmd.js')
+
+// Named exports
+export const install = steamcmd.install
+export const isInstalled = steamcmd.isInstalled
+export const ensureInstalled = steamcmd.ensureInstalled
+export const getInfo = steamcmd.getInfo
+export const SteamCmdError = steamcmd.SteamCmdError
+export const DownloadError = steamcmd.DownloadError
+export const InstallError = steamcmd.InstallError
+export const downloadWithProgress = steamcmd.downloadWithProgress
+export const installWithProgress = steamcmd.installWithProgress
+export const getInstalledApps = steamcmd.getInstalledApps
+export const update = steamcmd.update
+export const validate = steamcmd.validate
+export const getInstalledVersion = steamcmd.getInstalledVersion
+export const createProgressEmitter = steamcmd.createProgressEmitter
+
+// Default export
+export default steamcmd

package/package.json

@@ -1,35 +1,41 @@
 {
   "name": "@caleb-collar/steamcmd",
-  "version": "1.0.0-alpha.1",
+  "version": "1.1.0",
   "description": "Node.js wrapper for SteamCMD - download, install, and manage Steam applications programmatically",
-  "main": "src/steamcmd.js",
-  "module": "src/steamcmd.mjs",
-  "types": "types/steamcmd.d.ts",
+  "main": "dist/steamcmd.js",
+  "module": "dist/steamcmd.mjs",
+  "types": "dist/steamcmd.d.ts",
   "exports": {
     ".": {
       "import": {
-        "types": "./types/steamcmd.d.ts",
-        "default": "./src/steamcmd.mjs"
+        "types": "./dist/steamcmd.d.ts",
+        "default": "./dist/steamcmd.mjs"
       },
       "require": {
-        "types": "./types/steamcmd.d.ts",
-        "default": "./src/steamcmd.js"
+        "types": "./dist/steamcmd.d.ts",
+        "default": "./dist/steamcmd.js"
       }
     }
   },
   "scripts": {
-    "lint": "standard --verbose **/*.js bin/*",
+    "build": "tsc && npm run build:esm-wrapper",
+    "build:esm-wrapper": "node -e \"const fs=require('fs');fs.writeFileSync('dist/steamcmd.mjs',fs.readFileSync('src/steamcmd.mjs.template','utf8'))\"",
+    "clean": "rimraf dist docs",
+    "docs": "typedoc --out docs src/steamcmd.ts",
+    "prepublishOnly": "npm run clean && npm run build",
+    "lint": "biome check .",
+    "lint:fix": "biome check --write .",
+    "format": "biome format --write .",
     "test": "vitest run",
     "test:watch": "vitest",
     "test:coverage": "vitest run --coverage"
   },
   "bin": {
-    "steamcmd": "./bin/steamcmd"
+    "steamcmd": "bin/steamcmd"
   },
   "files": [
-    "src/",
+    "dist/",
     "bin/",
-    "types/",
     "README.md",
     "LICENSE",
     "CHANGELOG.md"
@@ -64,8 +70,13 @@
     "unzipper": "^0.12.3"
   },
   "devDependencies": {
+    "@biomejs/biome": "^2.3.13",
+    "@types/node": "^25.1.0",
+    "@types/unzipper": "^0.10.11",
     "@vitest/coverage-v8": "^4.0.18",
-    "standard": "^17.1.2",
+    "rimraf": "^6.1.2",
+    "typedoc": "^0.28.16",
+    "typescript": "^5.9.3",
     "vitest": "^4.0.18"
   }
 }

package/src/download.js

@@ -1,220 +0,0 @@
-/**
- * @module steamcmd/download
- * @description Downloads and extracts SteamCMD for the current platform
- * @private
- */
-
-const https = require('https')
-const fs = require('fs')
-const tar = require('tar')
-const unzip = require('unzipper')
-const { EventEmitter } = require('events')
-
-const env = require('./env')
-
-/**
- * SteamCMD download URLs by platform
- */
-const DOWNLOAD_URLS = {
-  darwin:
-    'https://steamcdn-a.akamaihd.net/client/installer/steamcmd_osx.tar.gz',
-  linux:
-    'https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz',
-  win32: 'https://steamcdn-a.akamaihd.net/client/installer/steamcmd.zip'
-}
-
-/**
- * Custom error class for download failures
- */
-class DownloadError extends Error {
-  constructor (message, code) {
-    super(message)
-    this.name = 'DownloadError'
-    this.code = code
-  }
-}
-
-/**
- * Download and extract SteamCMD for the current platform
- * @param {Object} [options] - Download options
- * @param {Function} [options.onProgress] - Progress callback(progress) with { phase, percent, bytesDownloaded, totalBytes }
- * @param {Function} [callback] - Optional callback(err). If omitted, returns a Promise.
- * @returns {Promise<void>|undefined} Promise if no callback provided
- *
- * @example
- * // With progress callback
- * await download({
- *   onProgress: (progress) => {
- *     console.log(`${progress.phase}: ${progress.percent}%`);
- *   }
- * });
- */
-function download (options, callback) {
-  // Handle legacy signature: download(callback)
-  if (typeof options === 'function') {
-    callback = options
-    options = {}
-  }
-  options = options || {}
-
-  // Support Promise-based usage
-  if (typeof callback !== 'function') {
-    return new Promise((resolve, reject) => {
-      download(options, (err) => {
-        if (err) reject(err)
-        else resolve()
-      })
-    })
-  }
-
-  const onProgress =
-    typeof options.onProgress === 'function' ? options.onProgress : () => {}
-
-  const platform = env.platform()
-  const url = DOWNLOAD_URLS[platform]
-  const destDir = env.directory()
-
-  if (!url) {
-    callback(
-      new DownloadError(
-        `Unsupported platform: ${platform}`,
-        'UNSUPPORTED_PLATFORM'
-      )
-    )
-    return
-  }
-
-  // Ensure destination directory exists
-  try {
-    fs.mkdirSync(destDir, { recursive: true })
-  } catch (err) {
-    callback(
-      new DownloadError(
-        `Failed to create directory ${destDir}: ${err.message}`,
-        'DIRECTORY_ERROR'
-      )
-    )
-    return
-  }
-
-  onProgress({
-    phase: 'starting',
-    percent: 0,
-    bytesDownloaded: 0,
-    totalBytes: 0
-  })
-
-  https
-    .get(url, (res) => {
-      if (res.statusCode !== 200) {
-        callback(
-          new DownloadError(
-            `Failed to download SteamCMD: HTTP ${res.statusCode}`,
-            'HTTP_ERROR'
-          )
-        )
-        return
-      }
-
-      const totalBytes = parseInt(res.headers['content-length'], 10) || 0
-      let bytesDownloaded = 0
-
-      res.on('data', (chunk) => {
-        bytesDownloaded += chunk.length
-        const percent =
-          totalBytes > 0 ? Math.round((bytesDownloaded / totalBytes) * 100) : 0
-        onProgress({
-          phase: 'downloading',
-          percent,
-          bytesDownloaded,
-          totalBytes
-        })
-      })
-
-      if (platform === 'darwin' || platform === 'linux') {
-        res
-          .pipe(tar.x({ cwd: destDir }))
-          .on('error', (err) => {
-            callback(
-              new DownloadError(
-                `Failed to extract tar archive: ${err.message}`,
-                'EXTRACT_ERROR'
-              )
-            )
-          })
-          .on('finish', () => {
-            onProgress({
-              phase: 'complete',
-              percent: 100,
-              bytesDownloaded,
-              totalBytes
-            })
-            callback(null)
-          })
-      } else if (platform === 'win32') {
-        res
-          .pipe(unzip.Extract({ path: destDir }))
-          .on('error', (err) => {
-            callback(
-              new DownloadError(
-                `Failed to extract zip archive: ${err.message}`,
-                'EXTRACT_ERROR'
-              )
-            )
-          })
-          .on('close', () => {
-            onProgress({
-              phase: 'complete',
-              percent: 100,
-              bytesDownloaded,
-              totalBytes
-            })
-            callback(null)
-          })
-      }
-    })
-    .on('error', (err) => {
-      callback(
-        new DownloadError(`Network error: ${err.message}`, 'NETWORK_ERROR')
-      )
-    })
-}
-
-/**
- * Download SteamCMD with EventEmitter-based progress
- * @param {Object} [options] - Download options
- * @returns {EventEmitter} Emitter that fires 'progress', 'error', and 'complete' events
- *
- * @example
- * const emitter = downloadWithProgress();
- * emitter.on('progress', (p) => console.log(`${p.percent}%`));
- * emitter.on('complete', () => console.log('Done!'));
- * emitter.on('error', (err) => console.error(err));
- */
-function downloadWithProgress (options) {
-  const emitter = new EventEmitter()
-
-  // Run download in next tick to allow event binding
-  process.nextTick(() => {
-    download(
-      {
-        ...options,
-        onProgress: (progress) => emitter.emit('progress', progress)
-      },
-      (err) => {
-        if (err) {
-          emitter.emit('error', err)
-        } else {
-          emitter.emit('complete')
-        }
-      }
-    )
-  })
-
-  return emitter
-}
-
-module.exports = download
-module.exports.downloadWithProgress = downloadWithProgress
-module.exports.DownloadError = DownloadError
-module.exports.DOWNLOAD_URLS = DOWNLOAD_URLS

package/src/env.js

@@ -1,66 +0,0 @@
-/**
- * @module steamcmd/env
- * @description Platform detection and path resolution for SteamCMD
- * @private
- */
-
-const os = require('os')
-const path = require('path')
-const envPaths = require('env-paths')
-
-const paths = envPaths('steamcmd', { suffix: '' })
-
-/**
- * Supported platforms for SteamCMD
- */
-const SUPPORTED_PLATFORMS = ['linux', 'darwin', 'win32']
-
-/**
- * Get the SteamCMD installation directory
- * @returns {string} Path to the SteamCMD directory
- */
-function directory () {
-  return paths.data
-}
-
-/**
- * Get the current platform
- * @returns {string} The current OS platform
- */
-function platform () {
-  return os.platform()
-}
-
-/**
- * Check if the current platform is supported
- * @returns {boolean} True if platform is supported
- */
-function isPlatformSupported () {
-  return SUPPORTED_PLATFORMS.includes(platform())
-}
-
-/**
- * Get the path to the SteamCMD executable
- * @returns {string|null} Path to executable or null if unsupported platform
- */
-function executable () {
-  const plat = platform()
-
-  if (plat === 'linux' || plat === 'darwin') {
-    return path.resolve(directory(), 'steamcmd.sh')
-  }
-
-  if (plat === 'win32') {
-    return path.resolve(directory(), 'steamcmd.exe')
-  }
-
-  return null
-}
-
-module.exports = {
-  directory,
-  executable,
-  platform,
-  isPlatformSupported,
-  SUPPORTED_PLATFORMS
-}