favacli 0.0.9 → 0.0.10

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/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

@@ -16,7 +16,7 @@ const [, , ...args] = process.argv;
 const cli = new Cli({
     binaryLabel: 'FavaCli',
     binaryName: `favacli`,
-    binaryVersion: '0.0.8',
+    binaryVersion: '0.0.10',
 });
 cli.register(VaultCreateCommand);
 cli.register(VaultDeleteCommand);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "favacli",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "",
   "type": "module",
   "author": "",