(feat): list backups added to command-line ... (#40)

* (feat): list backups added to command-line ...

* (ref): applied some code formatting

* (ref): startup params

Author: SystemFiles

package.json

@@ -9,7 +9,7 @@
     "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
   },
   "scripts": {
-    "start": "NODE_ENV=dev tsc && node dist/app.js backup --name test-ref --source ~/Documents/Personal --dest ./dev",
+    "start": "NODE_ENV=dev tsc && node dist/app.js restore --ref 1bc41083-afd2-4b5e-8270-5e475844ba50 --dest ./dev/restore",
     "build": "NODE_ENV=production tsc",
     "lint": "NODE_ENV=test eslint \"{src,libs,test}/**/*.ts\" --fix",
     "test": "echo \"WARN: no test specified\" && exit 0"

src/app.ts

@@ -1,7 +1,7 @@
 #! /usr/bin/env node
 
 // Entrypoint to application
-import { makeBackup } from './common/commands/backup.js'
+import { listBackups, makeBackup } from './common/commands/backup.js'
 import { parseArgs } from './common/commands/parsing.js'
 import { restoreBackup } from './common/commands/restore.js'
 import { ppRecord, sayHello } from './common/functions.js'
@@ -14,8 +14,8 @@ const cmdArgs = parseArgs()
 
 const run = async () => {
 	sayHello()
-	// Handle: Perform all app configurations first
 
+	// Handle: Perform all app configurations first
 	if (cmdArgs['_'].toString() === 'config') {
 		const conf = AppConfig.getInstance()
 		const options = Object.keys(cmdArgs).slice(1)
@@ -62,6 +62,13 @@ const run = async () => {
 			log(`Backup with ID, ${res}, successfully restored to ${cmdArgs['dest']}`)
 			break
 		}
+		case 'list': {
+			const err = await listBackups(cmdArgs['name'])
+			if (err) {
+				log(`Could not list backups. Reason: ${err.message}`)
+			}
+			break
+		}
 		default: {
 			log(`WARN: Invalid command specified`)
 			process.exit(2)

src/common/commands/backup.ts

@@ -2,6 +2,7 @@ import ora from 'ora'
 import { resolve } from 'path/posix'
 import { cwd } from 'process'
 import { BackupManager } from '../../lib/backup.js'
+import { DatabaseManager } from '../../lib/database.js'
 import { log } from '../../lib/logger.js'
 import { BackupRecord } from '../types.js'
 
@@ -27,6 +28,36 @@ export async function makeBackup(
 		return [ null, err ]
 	}
 }
+export async function listBackups(name?: string): Promise<Error> {
+	const db: DatabaseManager = DatabaseManager.getInstance()
+	const [ records, err ] = await db.findAllRecords()
+	if (err) return err
+	let fRecords = records
+
+	if (name && name.length > 0) {
+		// Filter by name
+		fRecords = fRecords.filter((r) => r.name.match(name))
+	}
+
+	if (fRecords.length === 0) {
+		log(`No records were found ...`)
+		return
+	}
+
+	const tableData = fRecords.map((r) => {
+		return {
+			id: r.id,
+			name: r.name,
+			created: r.created,
+			type: r.type,
+			size: `${Math.round(r.bytelength / 1024 / 1024)}MB`
+		}
+	})
+
+	// Print the result
+	log(`Found a total of ${fRecords.length} record(s) matching list criteria...`)
+	console.table(tableData)
+}
 
 export async function differentialBackup(
 	name: string,

src/common/commands/parsing.ts

@@ -28,6 +28,17 @@ export function parseArgs():
 			})
 	})
 
+	cmd.command(
+		'list',
+		'displays a list of all backups that are currently known by the system. Use --name to filter backups by name',
+		(yargs) => {
+			return yargs.option('name', {
+				describe: 'An optional variable used for some info commands to refine info operations',
+				type: 'string'
+			})
+		}
+	)
+
 	// Configure custom backups
 	cmd.command('backup', 'performs a custom backup of a select directory(s)', (yargs) => {
 		return yargs

src/lib/database.ts

@@ -40,6 +40,14 @@ export class DatabaseManager {
 		}
 	}
 
+	async findAllRecords(): Promise<[BackupRecord[], Error]> {
+		try {
+			return [ this.dbClient.data.backups, null ]
+		} catch (err) {
+			return [ null, err ]
+		}
+	}
+
 	findRecordById(id: string, table: RecordTable = RecordTable.BACKUPS): [BackupRecord, Error] {
 		try {
 			let backup: BackupRecord