favacli 0.0.7 → 0.0.10

package/build/BaseCommand.mjs

@@ -19,12 +19,12 @@ class BaseCommand extends Command {
     async execute() {
         const { lockedRepresentationString, settings } = await init();
         this.settings = settings;
-        if (lockedRepresentationString) {
-            this.twoFaLib = await loadVault(lockedRepresentationString, this.verbose);
+        if (lockedRepresentationString && this.requireTwoFaLib) {
+            this.twoFaLib = await loadVault(lockedRepresentationString, settings, this.verbose);
         }
         else {
             if (this.requireTwoFaLib) {
-                throw new Error('TwoFaLib is required');
+                throw new Error('No vault loaded, was it created?');
             }
         }
         const json = await this.exec();

package/build/BaseListOutputCommand.d.mts

@@ -0,0 +1,11 @@
+import type { EntryMeta, EntryMetaWithToken } from 'favalib';
+import BaseCommand from './BaseCommand.mjs';
+import formatters from './formatters/index.mjs';
+import { JsonArray } from 'type-fest';
+export type Formatter = (entries: (EntryMeta | EntryMetaWithToken)[]) => JsonArray;
+declare abstract class BaseListOutputCommand extends BaseCommand {
+    abstract getList(): EntryMeta[] | EntryMetaWithToken[];
+    format: (typeof formatters)[0]["name"] | undefined;
+    exec(): Promise<JsonArray>;
+}
+export default BaseListOutputCommand;

package/build/BaseListOutputCommand.mjs

@@ -0,0 +1,33 @@
+import { Option } from 'clipanion';
+import BaseCommand from './BaseCommand.mjs';
+import generateEntriesTable from './utils/generateEntriesTable.mjs';
+import formatters from './formatters/index.mjs';
+const formattersMap = new Map(formatters.map((f) => [f.name, f.formatter]));
+class BaseListOutputCommand extends BaseCommand {
+    constructor() {
+        super(...arguments);
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+        this.format = Option.String('--format', {
+            description: 'formatter',
+        });
+    }
+    // eslint-disable-next-line @typescript-eslint/require-await
+    async exec() {
+        let formatter = (json) => json;
+        if (this.format) {
+            const selectedFormatter = formattersMap.get(this.format);
+            if (!selectedFormatter) {
+                throw new Error(`Formatter ${this.format} not found`);
+            }
+            formatter = selectedFormatter;
+        }
+        const list = this.getList();
+        if (list.length === 0) {
+            this.context.stdout.write('No entries\n');
+            return formatter([]);
+        }
+        this.output(generateEntriesTable(list));
+        return formatter(list);
+    }
+}
+export default BaseListOutputCommand;

package/build/commands/entries/list.d.mts

@@ -1,9 +1,9 @@
-import BaseCommand from '../../BaseCommand.mjs';
-declare class EntriesListCommand extends BaseCommand {
+import BaseListOutputCommand from '../../BaseListOutputCommand.mjs';
+declare class EntriesListCommand extends BaseListOutputCommand {
     static paths: string[][];
     static usage: import("clipanion").Usage;
     requireTwoFaLib: boolean;
     withTokens: boolean | undefined;
-    exec(): Promise<0 | readonly import("type-fest").JsonValue[]>;
+    getList(): import("favalib").EntryMeta[];
 }
 export default EntriesListCommand;

package/build/commands/entries/list.mjs

@@ -1,7 +1,6 @@
 import { Option } from 'clipanion';
-import BaseCommand from '../../BaseCommand.mjs';
-import generateEntriesTable from '../../utils/generateEntriesTable.mjs';
-class EntriesListCommand extends BaseCommand {
+import BaseListOutputCommand from '../../BaseListOutputCommand.mjs';
+class EntriesListCommand extends BaseListOutputCommand {
     constructor() {
         super(...arguments);
         this.requireTwoFaLib = true;
@@ -10,12 +9,12 @@ class EntriesListCommand extends BaseCommand {
         });
     }
     static { this.paths = [['entries', 'list']]; }
-    static { this.usage = BaseCommand.Usage({
+    static { this.usage = BaseListOutputCommand.Usage({
         category: 'Entries',
         description: 'List all stored 2FA entries',
         details: `
       This command displays a table of all stored two-factor authentication entries.
-      
+
       When used with --withTokens, it will also show the current TOTP codes for each entry.
     `,
         examples: [
@@ -23,7 +22,7 @@ class EntriesListCommand extends BaseCommand {
             ['List entries with current TOTP tokens', 'entries list --withTokens'],
         ],
     }); }
-    async exec() {
+    getList() {
         let entries;
         if (this.withTokens) {
             entries = this.twoFaLib.vault.listEntriesMetas(true);
@@ -31,12 +30,7 @@ class EntriesListCommand extends BaseCommand {
         else {
             entries = this.twoFaLib.vault.listEntriesMetas(false);
         }
-        if (entries.length === 0) {
-            this.context.stdout.write('No entries\n');
-            return 0;
-        }
-        this.output(generateEntriesTable(entries));
-        return Promise.resolve(entries);
+        return entries;
     }
 }
 export default EntriesListCommand;

package/build/commands/entries/search.d.mts

@@ -1,11 +1,10 @@
-import type { JsonArray } from 'type-fest';
-import BaseCommand from '../../BaseCommand.mjs';
-declare class EntriesSearchCommand extends BaseCommand {
+import BaseListOutputCommand from '../../BaseListOutputCommand.mjs';
+declare class EntriesSearchCommand extends BaseListOutputCommand {
     static paths: string[][];
     static usage: import("clipanion").Usage;
     requireTwoFaLib: boolean;
     withTokens: boolean | undefined;
     query: string;
-    exec(): Promise<JsonArray>;
+    getList(): import("favalib").EntryMeta[];
 }
 export default EntriesSearchCommand;

package/build/commands/entries/search.mjs

@@ -1,7 +1,6 @@
 import { Option } from 'clipanion';
-import BaseCommand from '../../BaseCommand.mjs';
-import generateEntriesTable from '../../utils/generateEntriesTable.mjs';
-class EntriesSearchCommand extends BaseCommand {
+import BaseListOutputCommand from '../../BaseListOutputCommand.mjs';
+class EntriesSearchCommand extends BaseListOutputCommand {
     constructor() {
         super(...arguments);
         this.requireTwoFaLib = true;
@@ -11,12 +10,12 @@ class EntriesSearchCommand extends BaseCommand {
         this.query = Option.String({ required: true });
     }
     static { this.paths = [['entries', 'search']]; }
-    static { this.usage = BaseCommand.Usage({
+    static { this.usage = BaseListOutputCommand.Usage({
         category: 'Entries',
         description: 'Search for stored 2FA entries',
         details: `
       This command searches through all stored two-factor authentication entries.
-      
+
       The search query will match against entry names and issuers.
       When used with --withTokens, it will also show the current TOTP codes for matching entries.
     `,
@@ -28,7 +27,7 @@ class EntriesSearchCommand extends BaseCommand {
             ],
         ],
     }); }
-    async exec() {
+    getList() {
         let filteredEntries;
         if (this.withTokens) {
             filteredEntries = this.twoFaLib.vault.searchEntriesMetas(this.query, true);
@@ -36,13 +35,7 @@ class EntriesSearchCommand extends BaseCommand {
         else {
             filteredEntries = this.twoFaLib.vault.searchEntriesMetas(this.query, false);
         }
-        if (filteredEntries.length === 0) {
-            this.output('No matching entries found.\n');
-            return [];
-        }
-        const out = generateEntriesTable(filteredEntries);
-        this.output(out);
-        return Promise.resolve(filteredEntries);
+        return filteredEntries;
     }
 }
 export default EntriesSearchCommand;

package/build/commands/vault/create.mjs

@@ -17,7 +17,7 @@ class VaultCreateCommand extends BaseCommand {
         description: 'Create a new encrypted vault',
         details: `
       This command creates a new encrypted vault file to store your 2FA entries.
-      
+
       You will be prompted to enter a passphrase that will be used to encrypt the vault.
       The passphrase will be securely stored in your system's keychain.
     `,
@@ -30,11 +30,11 @@ class VaultCreateCommand extends BaseCommand {
         }));
         const { twoFaLib } = await twoFaLibVaultCreationUtils.createNewTwoFaLibVault(passphrase);
         twoFaLib.addEventListener(TwoFaLibEvent.Changed, (ev) => {
-            return fs.writeFile('vault.json', ev.detail.newLockedRepresentationString);
+            return fs.writeFile(this.settings.vaultLocation, ev.detail.newLockedRepresentationString);
         });
         await Promise.all([
             twoFaLib.forceSave(),
-            keytar.setPassword('2falib', 'vault-passphrase', passphrase),
+            keytar.setPassword('favacli', 'vault-passphrase', passphrase),
         ]);
         return { success: true };
     }

package/build/commands/vault/delete.d.mts

@@ -0,0 +1,14 @@
+import BaseCommand from '../../BaseCommand.mjs';
+declare class VaultDeleteCommand extends BaseCommand {
+    static paths: string[][];
+    requireTwoFaLib: boolean;
+    static usage: import("clipanion").Usage;
+    exec(): Promise<{
+        success: boolean;
+        cancelled: boolean;
+    } | {
+        success: boolean;
+        cancelled?: undefined;
+    }>;
+}
+export default VaultDeleteCommand;

package/build/commands/vault/delete.mjs

@@ -0,0 +1,33 @@
+import fs from 'node:fs/promises';
+import { confirm } from '@inquirer/prompts';
+import BaseCommand from '../../BaseCommand.mjs';
+class VaultDeleteCommand extends BaseCommand {
+    constructor() {
+        super(...arguments);
+        this.requireTwoFaLib = false;
+    }
+    static { this.paths = [['vault', 'delete']]; }
+    static { this.usage = BaseCommand.Usage({
+        category: 'Vault',
+        description: 'Delete the current vault',
+        details: `
+      This command deletes the current vault file.
+      You will be asked to confirm before deletion.
+    `,
+        examples: [['Delete the current vault', 'vault delete']],
+    }); }
+    async exec() {
+        const shouldDelete = await confirm({
+            message: 'Are you sure you want to delete the vault? This action cannot be undone.',
+            default: false,
+        });
+        if (!shouldDelete) {
+            this.output('Vault deletion cancelled.\n');
+            return { success: false, cancelled: true };
+        }
+        await fs.rm(this.settings.vaultLocation);
+        this.output('Vault deleted successfully.\n');
+        return { success: true };
+    }
+}
+export default VaultDeleteCommand;

package/build/formatters/alfred.d.mts

@@ -0,0 +1,6 @@
+import { Formatter } from '../BaseListOutputCommand.mjs';
+declare const _default: {
+    name: "alfred";
+    formatter: Formatter;
+};
+export default _default;

package/build/formatters/alfred.mjs

@@ -0,0 +1,6 @@
+const alfredFormatter = (entries) => entries.map((entry) => ({
+    title: entry.issuer,
+    subtitle: entry.name,
+    arg: entry.token?.otp,
+}));
+export default { name: 'alfred', formatter: alfredFormatter };

package/build/formatters/index.d.mts

@@ -0,0 +1,5 @@
+declare const formatters: {
+    name: "alfred";
+    formatter: import("../BaseListOutputCommand.mjs").Formatter;
+}[];
+export default formatters;

package/build/formatters/index.mjs

@@ -0,0 +1,3 @@
+import alfredFormatter from './alfred.mjs';
+const formatters = [alfredFormatter];
+export default formatters;

package/build/main.mjs

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 import { Cli, Builtins } from 'clipanion';
 import VaultCreateCommand from './commands/vault/create.mjs';
+import VaultDeleteCommand from './commands/vault/delete.mjs';
 import EntriesAddCommand from './commands/entries/add.mjs';
 import EntriesListCommand from './commands/entries/list.mjs';
 import EntriesSearchCommand from './commands/entries/search.mjs';
@@ -11,21 +12,18 @@ const nodeRuntimeMajorVersion = parseInt(process.version.split('.')[0]);
 if (nodeRuntimeMajorVersion < 20) {
     throw new Error('Node.js version must be 20 or higher');
 }
-const [...args] = process.argv;
+const [, , ...args] = process.argv;
 const cli = new Cli({
     binaryLabel: 'FavaCli',
     binaryName: `favacli`,
-    binaryVersion: '0.0.7',
+    binaryVersion: '0.0.10',
 });
 cli.register(VaultCreateCommand);
+cli.register(VaultDeleteCommand);
 cli.register(EntriesAddCommand);
 cli.register(EntriesListCommand);
 cli.register(EntriesSearchCommand);
 cli.register(SyncSetServerUrlCommand);
 cli.register(SyncConnect);
 cli.register(Builtins.HelpCommand);
-if (args[0].endsWith('node')) {
-    args.splice(0, 1);
-    args.splice(0, 1);
-}
 void cli.runExit(args);

package/build/utils/init.d.mts

@@ -1,8 +1,9 @@
 import type { LockedRepresentationString } from 'favalib';
-import type { EmptyObject } from 'type-fest';
-export type Settings = EmptyObject;
+export interface Settings {
+    vaultLocation: string;
+}
 declare const init: () => Promise<{
-    settings: EmptyObject;
+    settings: Settings;
     lockedRepresentationString: LockedRepresentationString;
 }>;
 export default init;

package/build/utils/init.mjs

@@ -1,5 +1,9 @@
 import fs from 'node:fs/promises';
-const defaultSettings = {};
+import path from 'node:path';
+import envPaths from 'env-paths';
+const getDefaultSettings = () => ({
+    vaultLocation: path.join(envPaths('favacli').data, 'vault.json'),
+});
 const readFile = async (path) => {
     try {
         return (await fs.readFile(path)).toString();
@@ -18,13 +22,21 @@ const readJSONFile = async (path) => {
     }
     return JSON.parse(contents);
 };
+const ensureDirectoriesExists = async (...paths) => {
+    for (const p of paths) {
+        const directory = path.dirname(p);
+        await fs.mkdir(directory, { recursive: true });
+    }
+};
 const init = async () => {
-    let settings = await readJSONFile('settings.json');
+    const settingsLocation = path.join(envPaths('favacli').config, 'settings.json');
+    let settings = await readJSONFile(settingsLocation);
     if (!settings) {
-        settings = defaultSettings;
-        await fs.writeFile('settings.json', JSON.stringify(settings, null, 2));
+        settings = getDefaultSettings();
+        await ensureDirectoriesExists(settingsLocation, settings.vaultLocation);
+        await fs.writeFile(settingsLocation, JSON.stringify(settings, null, 2));
     }
-    const lockedRepresentationString = (await readFile('vault.json'));
+    const lockedRepresentationString = (await readFile(settings.vaultLocation));
     return { settings, lockedRepresentationString };
 };
 export default init;

package/build/utils/loadVault.d.mts

@@ -1,3 +1,4 @@
 import { type LockedRepresentationString } from 'favalib';
-declare const loadVault: (vaultData: LockedRepresentationString, verbose?: boolean) => Promise<import("favalib").TwoFaLib>;
+import { Settings } from './init.mjs';
+declare const loadVault: (vaultData: LockedRepresentationString, settings: Settings, verbose?: boolean) => Promise<import("favalib").TwoFaLib>;
 export default loadVault;

package/build/utils/loadVault.mjs

@@ -4,11 +4,11 @@ import { getTwoFaLibVaultCreationUtils, TwoFaLibEvent, } from 'favalib';
 import NodeCryptoProvider from 'favalib/cryptoProviders/node';
 const cryptoLib = new NodeCryptoProvider();
 const twoFaLibVaultCreationUtils = getTwoFaLibVaultCreationUtils(cryptoLib, 'cli', ['cli']);
-const loadVault = async (vaultData, verbose = false) => {
-    const passphrase = (await keytar.getPassword('2falib', 'vault-passphrase'));
+const loadVault = async (vaultData, settings, verbose = false) => {
+    const passphrase = (await keytar.getPassword('favacli', 'vault-passphrase'));
     const twoFaLib = await twoFaLibVaultCreationUtils.loadTwoFaLibFromLockedRepesentation(vaultData, passphrase);
     twoFaLib.addEventListener(TwoFaLibEvent.Changed, (ev) => {
-        return fs.writeFile('vault.json', ev.detail.newLockedRepresentationString);
+        return fs.writeFile(settings.vaultLocation, ev.detail.newLockedRepresentationString);
     });
     twoFaLib.addEventListener(TwoFaLibEvent.Log, (ev) => {
         if (ev.detail.severity !== 'info' || verbose) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "favacli",
-  "version": "0.0.7",
+  "version": "0.0.10",
   "description": "",
   "type": "module",
   "author": "",
@@ -9,7 +9,8 @@
     "@inquirer/prompts": "^7.0.1",
     "bufferutil": "^4.0.8",
     "clipanion": "^4.0.0-rc.4",
-    "favalib": "^0.0.1",
+    "env-paths": "^3.0.0",
+    "favalib": "^0.0.2",
     "keytar": "^7.9.0",
     "node-loader": "^2.0.0",
     "ts-loader": "^9.5.1",