@badisi/xbw 1.0.8 → 2.0.1

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2013-2021 Badisi
+Copyright © 2013-2022 Badisi
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/README.md

@@ -1,34 +1,58 @@
 # @badisi/xbw
 
-NodeJS module utility which provides helpful functions to read and/or verify xbox 360 backup iso files
+🎮 NodeJS module utility which provides helpful functions to read and/or verify xbox360 backup iso files.
 
 [![npm version](https://img.shields.io/npm/v/@badisi/xbw.svg?color=blue&logo=npm)][npm]
-[![npm donwloads](https://img.shields.io/npm/dw/@badisi/xbw.svg?color=blue&logo=npm)][npm-dl]
+[![npm donwloads](https://img.shields.io/npm/dw/@badisi/xbw.svg?color=7986CB&logo=npm)][npm-dl]
 [![license](https://img.shields.io/badge/license-custom-ff69b4)][license]
 
-[![dependency status](https://img.shields.io/david/badisi/xbw.svg)][david-deps]
+![darwin-x64](https://img.shields.io/badge/darwin-x64-green)
+![linux-x64](https://img.shields.io/badge/linux-x64-green)
+![win32-x64](https://img.shields.io/badge/win32-x64-green)
+![win32-ia32](https://img.shields.io/badge/win32-ia32-green)
 
 
 ## Installation
 
-`xbw` is pre-built for node and electron.
+**xbw** is pre-built for `node >= 12` and `electron` on latest ****macos****, ****linux**** and ****windows****.
 
 ```sh
-$ npm install @badisi/xbw --save
+npm install -g @badisi/xbw
 ```
 
 ```sh
-$ yarn add @badisi/xbw
+yarn global add @badisi/xbw
 ```
 
 ## Usage
 
-```js
-const { verifyWithAbgx360, getIsosInfo } = require('@badisi/xbw');
+```
+$ xbw --help
+
+  Usage:
+    $ xbw <command> <file|folder...> [--help] [options]
+
+  Global Commands:
+    verify .... Verify backup iso files integrity against abgx360
+    info ...... Extract information from backup iso files
+
+  Examples:
+    $ xbw info backup.iso
+    $ xbw info backup1.iso backup2.iso path/to/backups/folder/
+    $ xbw verify backup.iso --corrupt --af3 --patchgarbage --patchitanyway
+    $ xbw verify backup1.iso backup2.iso path/to/backups/folder
+    $ xbw verify backup.iso --html > output-file.html
 ```
 
+## API
 
-## Methods
+This package can also be installed locally and used as an API.
+
+```js
+const { getIsosInfo, verifyWithAbgx360 } = require('@badisi/xbw');
+```
+
+---------------------------------------
 
 * [getIsosInfo](#getIsosInfo)
 * [verifyWithAbgx360](#verifyWithAbgx360)
@@ -87,7 +111,7 @@ console.log(isosInfo);
 
 ---------------------------------------
 
-<a name="verifiyWithAbgx360"></a>
+<a name="verifyWithAbgx360"></a>
 
 ### verifyWithAbgx360(isoPaths: string[], options?: AbgxOptions, onProgress?: (progress: string) => void): Promise<AbgxFile[]>
 
@@ -124,7 +148,7 @@ const abgxOptions = {
     html: true
 };
 
-verifiedWithAbgx360(files, options, (progress) => console.log(progress))
+verifiedWithAbgx360(files, options, console.log)
     .then(results => console.log(results))
     .catch(error => console.error(error));
 // => [{
@@ -145,7 +169,7 @@ Credit
 License
 -------
 
-Copyright © 2013-2021 [Badisi](https://github.com/Badisi)
+Copyright © 2013-2022 [Badisi](https://github.com/Badisi)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/bin/xbw

@@ -0,0 +1,54 @@
+#!/usr/bin/env node
+
+'use strict';
+
+(async () => {
+    const { version } = require('../package.json');
+    const { verifyWithAbgx360, getIsosInfo } = require('../index.js');
+    const { blue, bold, cyan, dim, gray, green, italic, red, white } = require('@colors/colors/safe');
+
+    const args = process.argv.slice(2);
+
+    // Patch console.error so that it is printed in red color
+    const originalConsoleError = console.error;
+    console.error = (message) => originalConsoleError(red(message));
+
+    // Parse command line arguments
+    try {
+        switch (args.shift()) {
+            case 'verify':
+                await verifyWithAbgx360(args, undefined, console.log);
+                break;
+            case 'info':
+                console.log(cyan(JSON.stringify(getIsosInfo(args), null, 2)));
+                break;
+            default:
+                console.log(blue(bold('        _')));
+                console.log(blue(bold('  __  _| |____      __')));
+                console.log(blue(bold('  \\ \\/ / \'_ \\ \\ /\\ / /')));
+                console.log(blue(bold('   >  <| |_) \\ V  V / ')));
+                console.log(`${blue(bold('  /_/\\_\\_.__/ \\_/\\_/'))} ${green(italic(`v${version}`))}`);
+                console.log();
+                console.log(`  ${white(bold('Usage:'))}`);
+                console.log();
+                console.log(`    ${gray('$')} ${cyan('xbw <command> <file|folder...>')} ${cyan(dim('[--help] [options]'))}`);
+                console.log();
+                console.log(`  ${white(bold('Global Commands:'))}`);
+                console.log();
+                console.log(`    ${cyan('verify')} ${gray('.'.repeat(4))} ${white('Verify backup iso files integrity against abgx360')}`);
+                console.log(`    ${cyan('info')} ${gray('.'.repeat(6))} ${white('Extract information from backup iso files')}`);
+                console.log();
+                console.log(`  ${white(bold('Examples:'))}`);
+                console.log();
+                console.log(`    ${gray('$')} ${cyan('xbw info backup.iso')}`);
+                console.log(`    ${gray('$')} ${cyan('xbw info backup1.iso backup2.iso path/to/backups/folder/')}`);
+                console.log(`    ${gray('$')} ${cyan('xbw verify backup.iso --corrupt --af3 --patchgarbage --patchitanyway')}`);
+                console.log(`    ${gray('$')} ${cyan('xbw verify backup1.iso backup2.iso path/to/backups/folder')}`);
+                console.log(`    ${gray('$')} ${cyan('xbw verify backup.iso --html > output-file.html')}`);
+                console.log();
+                break;
+        }
+    } catch (error) {
+        console.error(error.message);
+    }
+})();

package/index.d.ts

@@ -1,4 +1,3 @@
-export function verifyWithAbgx360(isoPaths: string[], options?: AbgxOptions, onProgress?: (progress: string) => void): Promise<AbgxFile[]>;
 export function getIsosInfo(isoPaths: string[]): IsoInfo[];
 export enum Region {
     REGION_FREE = 'REGION_FREE',
@@ -19,6 +18,17 @@ export enum Region {
     NTSC_U = 'NTSC_U',
     NTSCU_UNKNOW = 'NTSCU_UNKNOWN'
 }
+export interface IsoInfo {
+    file: string;
+    titleId: string;
+    mediaId: string;
+    discCount: number;
+    discNumber: number;
+    regions: Region[];
+    isValid: boolean;
+}
+
+export function verifyWithAbgx360(isoPaths: string[], options?: AbgxOptions, onProgress?: (progress: string) => void): Promise<AbgxFile[]>;
 export enum AbgxStatus {
     VERIFIED = 0,
     ERROR = -1,
@@ -124,12 +134,3 @@ export interface AbgxOptions {
     lang: number;
     speed: number;
 }
-export interface IsoInfo {
-    file: string;
-    titleId: string;
-    mediaId: string;
-    discCount: number;
-    discNumber: number;
-    regions: Region[];
-    isValid: boolean;
-}

package/index.js

@@ -1,60 +1,112 @@
-const xbw = require('bindings')('xbw');
+// @ts-check
 
-function verifyWithAbgx360(isoPaths, options, onProgress) {
-    if (Array.isArray(isoPaths)) {
-        const abgxOptions = (!options) ? [] : Object
-            .keys(options)
-            .map((key) => {
-                if (typeof options[key] === 'string') {
-                    return `--${key} ${options[key]}`;
-                } else if (typeof options[key] === 'number') {
-                    return `--${key} ${String(options[key])}`;
-                }
-                return `--${key}`;
-            })
-            .join(' ')
-            .split(' ');
+const xbw = require('node-gyp-build')(__dirname);
+const { lstatSync, readdirSync, existsSync } = require('fs');
+const { join } = require('path');
 
+/** @param {string[]} args */
+const getIsoFilesFromArgs = (args = []) => {
+    const files = [];
+    args
+        .filter(arg => !arg.startsWith('-'))
+        .forEach(arg => {
+            if (existsSync(arg) && lstatSync(arg).isDirectory()) {
+                files.push(...readdirSync(arg).reduce((files, itemName) => {
+                    const itemPath = join(arg, itemName);
+                    if (lstatSync(itemPath).isDirectory()) {
+                        return [...files, ...getIsoFilesFromArgs([itemPath])];
+                    }
+                    return /** @type {string[]} */(itemName.endsWith('.iso') ? [...files, itemPath] : files);
+                }, /** @type {string[]} */([])));
+            } else {
+                files.push(arg);
+            }
+        });
+    return files;
+};
+
+/** @type {import('./index').verifyWithAbgx360} */
+const verifyWithAbgx360 = (args = [], options, onProgress) => {
+    if (Array.isArray(args)) {
+        const isoPaths = args.filter(arg => !arg.startsWith('-'));
+        const files = getIsoFilesFromArgs(isoPaths);
+        if (isoPaths.length && !files.length) {
+            throw new Error('Error: xbw.verifyWithAbgx360: no ISO files were found');
+        }
+
+        let abgxOptions = ['--help'];
+        if (files.length) {
+            abgxOptions = args.filter(arg => arg.startsWith('-'));
+            if (options) {
+                /**
+                 * TypeScript is not smart enough to figure out what filter() does.
+                 * So we need to cast the result as being string[] and not (string | undefined)[].
+                 */
+                const items = /** @type {string[]} */(Object
+                    .keys(options)
+                    .map(key => {
+                        if (typeof options[key] === 'string') {
+                            return `--${key} ${options[key]}`;
+                        } else if (typeof options[key] === 'number') {
+                            return `--${key} ${String(options[key])}`;
+                        } else if (options[key] === false) {
+                            return undefined; // no-op
+                        }
+                        return `--${key}`;
+                    })
+                    .filter(option => option)); // filter out the no-op
+                abgxOptions.push(...items);
+            }
+        }
         return new Promise((resolve, reject) => {
             xbw.verifyWithAbgx360(
-                abgxOptions.concat(isoPaths),
-                (results, error) => {
+                abgxOptions.concat(files),
+                (/** @type {any} */ error, /** @type {any[]} */ results, /** @type {string} */ progress) => {
+                    if (progress && onProgress) {
+                        if (progress.includes('<loader>')) {
+                            progress = progress.replace(' ', '&nbsp;');
+                        }
+                        onProgress(progress);
+                    }
                     if (error) {
                         return reject(error);
                     }
-                    return resolve(isoPaths.map((isoPath, index) => {
-                        return { file: isoPath, status: results[index] };
-                    }));
-                },
-                (progress) => {
-                    if (onProgress) {
-                        onProgress(progress);
+                    if (results) {
+                        return resolve(files.map((file, index) => {
+                            return { file, status: results?.[index] ?? -1 };
+                        }));
                     }
                 }
             );
         });
     } else {
-        throw 'Error: verifyWithAbgx360: `files` parameter should be of type Array';
+        throw new Error('Error: xbw.verifyWithAbgx360: `args` parameter should be of type Array');
     }
-}
+};
 
-function getIsosInfo(isoPaths) {
+/** @type {import('./index').getIsosInfo} */
+const getIsosInfo = (isoPaths = []) => {
     if (Array.isArray(isoPaths)) {
-        return isoPaths?.map(isoPath => {
-            try {
-                return {
-                    ...xbw.getIsoInfo(isoPath),
-                    isValid: true
-                };
-            } catch (error) {
-                console.error(`${error.message}\n${isoPath}`);
-                return { file: isoPath, isValid: false };
-            }
-        });
+        const files = getIsoFilesFromArgs(isoPaths);
+        if (files.length) {
+            return files.map(file => {
+                try {
+                    return {
+                        ...xbw.getIsoInfo(file),
+                        isValid: true
+                    };
+                } catch (error) {
+                    console.error(`Error: xbw.getIsosInfo: ${error.message}\n    for file: ${file}`);
+                    return { file, isValid: false };
+                }
+            });
+        } else {
+            throw new Error('Error: xbw.getIsosInfo: no ISO files were found');
+        }
     } else {
-        throw 'Error: getIsosInfo: `files` parameter should be of type Array';
+        throw new Error('Error: xbw.getIsosInfo: `isoPaths` parameter should be of type Array');
     }
-}
+};
 
 module.exports = {
     verifyWithAbgx360,

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@badisi/xbw",
-    "version": "1.0.8",
-    "description": "Utility to read and/or verify xbox 360 backup iso files",
+    "version": "2.0.1",
+    "description": "Utility to read and/or verify xbox360 backup iso files",
     "homepage": "https://github.com/Badisi/xbw",
     "license": "SEE LICENSE IN file",
     "author": {
@@ -9,6 +9,9 @@
     },
     "main": "./index.js",
     "types": "./index.d.ts",
+    "bin": {
+        "xbw": "./bin/xbw"
+    },
     "repository": {
         "type": "git",
         "url": "https://github.com/Badisi/xbw.git"
@@ -19,17 +22,20 @@
         "xkey",
         "xbox360",
         "abgx",
+        "abgx360",
         "nodejs",
+        "iso",
         "v8"
     ],
     "engines": {
-        "node": ">=8.5.0"
+        "node": ">= 12"
     },
     "scripts": {
-        "install": "prebuild-install --tag-prefix='v'"
+        "install": "node-gyp-build"
     },
     "dependencies": {
-        "bindings": "^1.5.0",
-        "prebuild-install": "^6.0.1"
+        "@colors/colors": "^1.5.0",
+        "node-addon-api": "^5.0.0",
+        "node-gyp-build": "^4.5.0"
     }
 }