@fnndsc/brasa 0.56.2 → 0.56.3

package/dist/builtins/res/tag.d.ts

@@ -1,8 +1,249 @@
 import { CommandEnvelope } from '@fnndsc/menu';
 /**
- * Builtin handler for the `tag` command.
+ * `tag [[listing options] | list [listing options] | search <term> [listing options] | inspect]`: the declaration.
  *
- * @param args - Parsed command arguments for the tag command.
- * @returns An envelope carrying the tag listing or fields.
+ * @example
+ * ```ts
+ * commands_register({ declarations: [tagCommand] }, 'backend');
+ * ```
+ */
+export declare const tagCommand: import("../../core/commandDeclaration.js").CommandDeclaration<{
+    readonly bare: {
+        readonly summary: "List the tags, as list does";
+        readonly options: {
+            readonly all: {
+                readonly long: "all";
+                readonly summary: "Fetch every page";
+            };
+            readonly limit: {
+                readonly long: "limit";
+                readonly summary: "Page size (default 20)";
+                readonly value: {
+                    readonly name: "n";
+                    readonly kind: "int";
+                    readonly min: 1;
+                };
+            };
+            readonly offset: {
+                readonly long: "offset";
+                readonly summary: "Start this many rows in";
+                readonly value: {
+                    readonly name: "n";
+                    readonly kind: "int";
+                    readonly min: 0;
+                };
+            };
+            readonly page: {
+                readonly long: "page";
+                readonly summary: "Page size, when --limit is not given";
+                readonly value: {
+                    readonly name: "n";
+                    readonly kind: "int";
+                    readonly min: 1;
+                };
+            };
+            readonly fields: {
+                readonly long: "fields";
+                readonly summary: "The columns to show, comma-separated (inspect names them)";
+                readonly value: {
+                    readonly name: "field,…";
+                    readonly kind: "word";
+                };
+            };
+            readonly search: {
+                readonly long: "search";
+                readonly summary: "Filter by field:value, comma-separated (inspect names the fields)";
+                readonly value: {
+                    readonly name: "field:value";
+                    readonly kind: "word";
+                };
+            };
+            readonly sort: {
+                readonly long: "sort";
+                readonly summary: "Sort by a field";
+                readonly value: {
+                    readonly name: "field";
+                    readonly kind: "word";
+                };
+            };
+            readonly reverse: {
+                readonly long: "reverse";
+                readonly summary: "Reverse the sort";
+            };
+            readonly table: {
+                readonly long: "table";
+                readonly summary: "Tabular output";
+            };
+            readonly csv: {
+                readonly long: "csv";
+                readonly summary: "CSV output";
+            };
+        };
+    };
+    readonly subcommands: {
+        readonly list: {
+            readonly summary: "List the tags, 20 to a page";
+            readonly options: {
+                readonly all: {
+                    readonly long: "all";
+                    readonly summary: "Fetch every page";
+                };
+                readonly limit: {
+                    readonly long: "limit";
+                    readonly summary: "Page size (default 20)";
+                    readonly value: {
+                        readonly name: "n";
+                        readonly kind: "int";
+                        readonly min: 1;
+                    };
+                };
+                readonly offset: {
+                    readonly long: "offset";
+                    readonly summary: "Start this many rows in";
+                    readonly value: {
+                        readonly name: "n";
+                        readonly kind: "int";
+                        readonly min: 0;
+                    };
+                };
+                readonly page: {
+                    readonly long: "page";
+                    readonly summary: "Page size, when --limit is not given";
+                    readonly value: {
+                        readonly name: "n";
+                        readonly kind: "int";
+                        readonly min: 1;
+                    };
+                };
+                readonly fields: {
+                    readonly long: "fields";
+                    readonly summary: "The columns to show, comma-separated (inspect names them)";
+                    readonly value: {
+                        readonly name: "field,…";
+                        readonly kind: "word";
+                    };
+                };
+                readonly search: {
+                    readonly long: "search";
+                    readonly summary: "Filter by field:value, comma-separated (inspect names the fields)";
+                    readonly value: {
+                        readonly name: "field:value";
+                        readonly kind: "word";
+                    };
+                };
+                readonly sort: {
+                    readonly long: "sort";
+                    readonly summary: "Sort by a field";
+                    readonly value: {
+                        readonly name: "field";
+                        readonly kind: "word";
+                    };
+                };
+                readonly reverse: {
+                    readonly long: "reverse";
+                    readonly summary: "Reverse the sort";
+                };
+                readonly table: {
+                    readonly long: "table";
+                    readonly summary: "Tabular output";
+                };
+                readonly csv: {
+                    readonly long: "csv";
+                    readonly summary: "CSV output";
+                };
+            };
+        };
+        readonly search: {
+            readonly summary: "List the tags a filter matches (list --search <term>)";
+            readonly operands: readonly [{
+                readonly name: "term";
+                readonly kind: "word";
+                readonly summary: "The filter, field:value (inspect names the fields)";
+            }];
+            readonly options: {
+                readonly all: {
+                    readonly long: "all";
+                    readonly summary: "Fetch every page";
+                };
+                readonly limit: {
+                    readonly long: "limit";
+                    readonly summary: "Page size (default 20)";
+                    readonly value: {
+                        readonly name: "n";
+                        readonly kind: "int";
+                        readonly min: 1;
+                    };
+                };
+                readonly offset: {
+                    readonly long: "offset";
+                    readonly summary: "Start this many rows in";
+                    readonly value: {
+                        readonly name: "n";
+                        readonly kind: "int";
+                        readonly min: 0;
+                    };
+                };
+                readonly page: {
+                    readonly long: "page";
+                    readonly summary: "Page size, when --limit is not given";
+                    readonly value: {
+                        readonly name: "n";
+                        readonly kind: "int";
+                        readonly min: 1;
+                    };
+                };
+                readonly fields: {
+                    readonly long: "fields";
+                    readonly summary: "The columns to show, comma-separated (inspect names them)";
+                    readonly value: {
+                        readonly name: "field,…";
+                        readonly kind: "word";
+                    };
+                };
+                readonly search: {
+                    readonly long: "search";
+                    readonly summary: "Filter by field:value, comma-separated (inspect names the fields)";
+                    readonly value: {
+                        readonly name: "field:value";
+                        readonly kind: "word";
+                    };
+                };
+                readonly sort: {
+                    readonly long: "sort";
+                    readonly summary: "Sort by a field";
+                    readonly value: {
+                        readonly name: "field";
+                        readonly kind: "word";
+                    };
+                };
+                readonly reverse: {
+                    readonly long: "reverse";
+                    readonly summary: "Reverse the sort";
+                };
+                readonly table: {
+                    readonly long: "table";
+                    readonly summary: "Tabular output";
+                };
+                readonly csv: {
+                    readonly long: "csv";
+                    readonly summary: "CSV output";
+                };
+            };
+        };
+        readonly inspect: {
+            readonly summary: "Name the fields a tag has";
+        };
+    };
+}>;
+/**
+ * `tag` over words already split: the declaration's parse and handler.
+ *
+ * @param args - The words after `tag`.
+ * @returns The answer, or the refusal of a bad line.
+ *
+ * @example
+ * ```ts
+ * await builtin_tag(['list', '--all']);
+ * ```
  */
 export declare function builtin_tag(args: string[]): Promise<CommandEnvelope>;

package/dist/builtins/res/tag.js

@@ -1,59 +1,115 @@
 /**
- * @file Builtin tag command.
+ * @file `tag` and `tags`: CUBE's tags, listed, searched, and their fields
+ * named. A feed wears a tag through `setfattr`; this lists the tags there are.
  *
- * Subcommands: list, search, inspect
- * Singular/plural aliases: tag / tags
+ * Declared in one record (`tagCommand`, `tags` among its aliases):
+ * the subcommands and the listing options every resource command reads.
+ *
+ * Key components:
+ * - tagCommand: the declaration, answered as `tag` and `tags`.
+ * - builtin_tag: the declaration run over words already split.
+ *
+ * @module
  */
 import chalk from 'chalk';
-import { commandArgs_process, cliOptions_extract, resourceListOptions_refusal, resourceSearchTerm_refusal, resourceSearch_args } from '../utils.js';
 import { tags_fetchList } from '@fnndsc/chili/commands/tags/list.js';
 import { tagFields_fetch } from '@fnndsc/chili/commands/tags/fields.js';
 import { table_render } from '@fnndsc/chili/screen/screen.js';
 import { envelope_ok, envelope_error } from '@fnndsc/menu';
 import { exitCode_set } from '../../core/handlerRun.js';
+import { command_declare } from '../../core/commandDeclaration.js';
+import { declaredCommand_run } from '../../core/commandParse.js';
+import { RESOURCE_LIST_OPTIONS_GRAMMAR, resourceListBag_build } from './resourceList.js';
 /**
- * Builtin handler for the `tag` command.
+ * Lists the tags a listing's options ask for.
  *
- * @param args - Parsed command arguments for the tag command.
- * @returns An envelope carrying the tag listing or fields.
+ * @param options - The bag chili's listing reads.
+ * @returns The table, or that there are none, or the error.
  */
-export async function builtin_tag(args) {
-    const parsed = commandArgs_process(args);
-    const subcommand = parsed._[0];
-    if (!subcommand || subcommand === 'list') {
-        const refusal = resourceListOptions_refusal('tag', parsed);
-        if (refusal !== null) {
-            exitCode_set(1);
-            return envelope_error('', undefined, `${chalk.red(refusal)}\n`);
-        }
-        try {
-            const { tags, selectedFields, totalCount } = await tags_fetchList(cliOptions_extract(parsed));
-            if (tags.length === 0) {
-                return envelope_ok(`${chalk.gray('No tags found.')}\n`);
-            }
-            return envelope_ok(table_render(tags, selectedFields, { title: { title: 'Tags', justification: 'center' }, pagination: totalCount !== undefined ? { shown: tags.length, total: totalCount } : undefined }));
-        }
-        catch (e) {
-            exitCode_set(1);
-            return envelope_error('', undefined, `${chalk.red(`tag error: ${e instanceof Error ? e.message : String(e)}`)}\n`);
+async function tagList_render(options) {
+    try {
+        const { tags, selectedFields, totalCount } = await tags_fetchList(options);
+        if (tags.length === 0) {
+            return envelope_ok(`${chalk.gray('No tags found.')}\n`);
         }
+        return envelope_ok(table_render(tags, selectedFields, { title: { title: 'Tags', justification: 'center' }, pagination: totalCount !== undefined ? { shown: tags.length, total: totalCount } : undefined }));
     }
-    if (subcommand === 'search') {
-        const refusal = resourceSearchTerm_refusal('tag', parsed);
-        if (refusal !== null) {
-            exitCode_set(1);
-            return envelope_error('', undefined, `${chalk.red(refusal)}\n`);
-        }
-        return builtin_tag(resourceSearch_args(parsed));
+    catch (e) {
+        exitCode_set(1);
+        return envelope_error('', undefined, `${chalk.red(`tag error: ${e instanceof Error ? e.message : String(e)}`)}\n`);
     }
-    if (subcommand === 'inspect') {
-        const fields = await tagFields_fetch();
-        if (fields && fields.length > 0) {
-            return envelope_ok(table_render(fields.map((f) => ({ field: f })), ['field'], { title: { title: 'Tag fields', justification: 'center' } }));
-        }
-        return envelope_ok(`${chalk.gray('No fields found for tags.')}\n`);
+}
+/**
+ * Names the fields a tag has.
+ *
+ * @returns The fields' table, or that there are none.
+ */
+async function tagFields_render() {
+    const fields = await tagFields_fetch();
+    if (fields && fields.length > 0) {
+        return envelope_ok(table_render(fields.map((f) => ({ field: f })), ['field'], { title: { title: 'Tag fields', justification: 'center' } }));
     }
-    exitCode_set(1);
-    return envelope_error(`${chalk.red(`Unknown subcommand: ${subcommand}. Usage: tags <list|search|inspect>`)}\n`);
+    return envelope_ok(`${chalk.gray('No fields found for tags.')}\n`);
+}
+/** What a `tag` line may hold. */
+const TAG_GRAMMAR = {
+    bare: { summary: 'List the tags, as list does', options: RESOURCE_LIST_OPTIONS_GRAMMAR },
+    subcommands: {
+        list: { summary: 'List the tags, 20 to a page', options: RESOURCE_LIST_OPTIONS_GRAMMAR },
+        search: {
+            summary: 'List the tags a filter matches (list --search <term>)',
+            operands: [{ name: 'term', kind: 'word', summary: 'The filter, field:value (inspect names the fields)' }],
+            options: RESOURCE_LIST_OPTIONS_GRAMMAR,
+        },
+        inspect: { summary: 'Name the fields a tag has' },
+    },
+};
+/**
+ * Runs one `tag` line.
+ *
+ * @param args - The line, parsed.
+ * @returns The listing, the fields, or the error.
+ */
+async function tag_run(args) {
+    switch (args.subcommand) {
+        case null:
+        case 'list': return tagList_render(resourceListBag_build(args.options));
+        case 'search': return tagList_render(resourceListBag_build(args.options, args.operands.term));
+        case 'inspect': return tagFields_render();
+    }
+}
+/**
+ * `tag [[listing options] | list [listing options] | search <term> [listing options] | inspect]`: the declaration.
+ *
+ * @example
+ * ```ts
+ * commands_register({ declarations: [tagCommand] }, 'backend');
+ * ```
+ */
+export const tagCommand = command_declare({
+    name: 'tag',
+    aliases: ['tags'],
+    grammar: TAG_GRAMMAR,
+    help: {
+        summary: "CUBE's tags: list them, search them, name their fields",
+        description: "List the tags in CUBE, a page at a time or every page, filtered by a field:value search and in the columns asked for; inspect names the fields a tag has. tag and tags are one command. A feed wears a tag through setfattr -n tag -v <name>.",
+        category: 'Resources',
+        examples: ['tags list', 'tags list --all --sort name', 'tags search name:brain', 'tags inspect'],
+    },
+    handler: tag_run,
+});
+/**
+ * `tag` over words already split: the declaration's parse and handler.
+ *
+ * @param args - The words after `tag`.
+ * @returns The answer, or the refusal of a bad line.
+ *
+ * @example
+ * ```ts
+ * await builtin_tag(['list', '--all']);
+ * ```
+ */
+export async function builtin_tag(args) {
+    return declaredCommand_run(tagCommand, args);
 }
 //# sourceMappingURL=tag.js.map

package/dist/builtins/res/tag.js.map

@@ -1 +1 @@
-{"version":3,"file":"tag.js","sourceRoot":"","sources":["../../../src/builtins/res/tag.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,mBAAmB,EAAc,kBAAkB,EAAE,2BAA2B,EAAE,0BAA0B,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAChK,OAAO,EAAE,cAAc,EAAiB,MAAM,qCAAqC,CAAC;AACpF,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAE9D,OAAO,EAAmB,WAAW,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC5E,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,IAAc;IAC9C,MAAM,MAAM,GAAe,mBAAmB,CAAC,IAAI,CAAC,CAAC;IACrD,MAAM,UAAU,GAAuB,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAEnD,IAAI,CAAC,UAAU,IAAI,UAAU,KAAK,MAAM,EAAE,CAAC;QACzC,MAAM,OAAO,GAAkB,2BAA2B,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC1E,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACrB,YAAY,CAAC,CAAC,CAAC,CAAC;YAChB,OAAO,cAAc,CAAC,EAAE,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAClE,CAAC;QACD,IAAI,CAAC;YACH,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,UAAU,EAAE,GAAkB,MAAM,cAAc,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7G,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAAC,OAAO,WAAW,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;YAAC,CAAC;YACnF,OAAO,WAAW,CAAC,YAAY,CAAC,IAAI,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,UAAU,EAAE,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QAC9M,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,YAAY,CAAC,CAAC,CAAC,CAAC;YAChB,OAAO,cAAc,CAAC,EAAE,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QACrH,CAAC;IACH,CAAC;IAED,IAAI,UAAU,KAAK,QAAQ,EAAE,CAAC;QAC5B,MAAM,OAAO,GAAkB,0BAA0B,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACzE,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACrB,YAAY,CAAC,CAAC,CAAC,CAAC;YAChB,OAAO,cAAc,CAAC,EAAE,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAClE,CAAC;QACD,OAAO,WAAW,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,MAAM,MAAM,GAAoB,MAAM,eAAe,EAAE,CAAC;QACxD,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,OAAO,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;QACtJ,CAAC;QACD,OAAO,WAAW,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;IACrE,CAAC;IAED,YAAY,CAAC,CAAC,CAAC,CAAC;IAChB,OAAO,cAAc,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,uBAAuB,UAAU,qCAAqC,CAAC,IAAI,CAAC,CAAC;AAClH,CAAC"}
+{"version":3,"file":"tag.js","sourceRoot":"","sources":["../../../src/builtins/res/tag.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,cAAc,EAAiB,MAAM,qCAAqC,CAAC;AACpF,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAE9D,OAAO,EAAmB,WAAW,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC5E,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,eAAe,EAA8C,MAAM,kCAAkC,CAAC;AAC/G,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,6BAA6B,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAEzF;;;;;GAKG;AACH,KAAK,UAAU,cAAc,CAAC,OAAmB;IAC/C,IAAI,CAAC;QACH,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,UAAU,EAAE,GAAkB,MAAM,cAAc,CAAC,OAAO,CAAC,CAAC;QAC1F,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAAC,OAAO,WAAW,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAAC,CAAC;QACnF,OAAO,WAAW,CAAC,YAAY,CAAC,IAAI,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,UAAU,EAAE,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IAC9M,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,YAAY,CAAC,CAAC,CAAC,CAAC;QAChB,OAAO,cAAc,CAAC,EAAE,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;IACrH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,gBAAgB;IAC7B,MAAM,MAAM,GAAoB,MAAM,eAAe,EAAE,CAAC;IACxD,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,OAAO,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;IACtJ,CAAC;IACD,OAAO,WAAW,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;AACrE,CAAC;AAED,kCAAkC;AAClC,MAAM,WAAW,GAAG;IAClB,IAAI,EAAE,EAAE,OAAO,EAAE,6BAA6B,EAAE,OAAO,EAAE,6BAA6B,EAAE;IACxF,WAAW,EAAE;QACX,IAAI,EAAE,EAAE,OAAO,EAAE,6BAA6B,EAAE,OAAO,EAAE,6BAA6B,EAAE;QACxF,MAAM,EAAE;YACN,OAAO,EAAE,uDAAuD;YAChE,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,oDAAoD,EAAE,CAAC;YACzG,OAAO,EAAE,6BAA6B;SACvC;QACD,OAAO,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE;KAClD;CACgC,CAAC;AAEpC;;;;;GAKG;AACH,KAAK,UAAU,OAAO,CAAC,IAA0C;IAC/D,QAAQ,IAAI,CAAC,UAAU,EAAE,CAAC;QACxB,KAAK,IAAI,CAAC;QACV,KAAK,MAAM,CAAC,CAAC,OAAO,cAAc,CAAC,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QACxE,KAAK,QAAQ,CAAC,CAAC,OAAO,cAAc,CAAC,qBAAqB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9F,KAAK,SAAS,CAAC,CAAC,OAAO,gBAAgB,EAAE,CAAC;IAC5C,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,eAAe,CAAC;IACxC,IAAI,EAAE,KAAK;IACX,OAAO,EAAE,CAAC,MAAM,CAAC;IACjB,OAAO,EAAE,WAAW;IACpB,IAAI,EAAE;QACJ,OAAO,EAAE,wDAAwD;QACjE,WAAW,EAAE,+OAA+O;QAC5P,QAAQ,EAAE,WAAW;QACrB,QAAQ,EAAE,CAAC,WAAW,EAAE,6BAA6B,EAAE,wBAAwB,EAAE,cAAc,CAAC;KACjG;IACD,OAAO,EAAE,OAAO;CACjB,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,IAAc;IAC9C,OAAO,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;AAC/C,CAAC"}

package/dist/builtins/res/user.d.ts

@@ -1,8 +1,127 @@
 import { type CommandEnvelope } from '@fnndsc/menu';
+/** What a `user` line may hold: one operation on one account. */
+declare const USER_GRAMMAR: {
+    readonly subcommands: {
+        readonly add: {
+            readonly summary: "Make a local account: prompts for its email, then a hidden password twice";
+            readonly operands: readonly [{
+                readonly name: "username";
+                readonly kind: "word";
+                readonly summary: "The CUBE-local account";
+            }];
+        };
+        readonly inspect: {
+            readonly summary: "Show a local account";
+            readonly operands: readonly [{
+                readonly name: "username";
+                readonly kind: "word";
+                readonly summary: "The CUBE-local account";
+            }];
+        };
+        readonly disable: {
+            readonly summary: "Disable a local account";
+            readonly operands: readonly [{
+                readonly name: "username";
+                readonly kind: "word";
+                readonly summary: "The CUBE-local account";
+            }];
+        };
+        readonly enable: {
+            readonly summary: "Enable a disabled local account";
+            readonly operands: readonly [{
+                readonly name: "username";
+                readonly kind: "word";
+                readonly summary: "The CUBE-local account";
+            }];
+        };
+        readonly remove: {
+            readonly summary: "Remove a local account";
+            readonly operands: readonly [{
+                readonly name: "username";
+                readonly kind: "word";
+                readonly summary: "The CUBE-local account";
+            }];
+        };
+    };
+};
+/** One operation `user` performs. */
+export type UserVerb = keyof typeof USER_GRAMMAR.subcommands;
 /**
- * Handles targeted local-account lifecycle commands.
+ * `user <add|inspect|disable|enable|remove> <username>`: the declaration.
  *
- * @param args - Parsed command arguments beginning with an account operation.
- * @returns Envelope containing a local-account result or operation error.
+ * @example
+ * ```ts
+ * commands_register({ declarations: [userCommand] }, 'backend');
+ * ```
+ */
+export declare const userCommand: import("../../core/commandDeclaration.js").CommandDeclaration<{
+    readonly subcommands: {
+        readonly add: {
+            readonly summary: "Make a local account: prompts for its email, then a hidden password twice";
+            readonly operands: readonly [{
+                readonly name: "username";
+                readonly kind: "word";
+                readonly summary: "The CUBE-local account";
+            }];
+        };
+        readonly inspect: {
+            readonly summary: "Show a local account";
+            readonly operands: readonly [{
+                readonly name: "username";
+                readonly kind: "word";
+                readonly summary: "The CUBE-local account";
+            }];
+        };
+        readonly disable: {
+            readonly summary: "Disable a local account";
+            readonly operands: readonly [{
+                readonly name: "username";
+                readonly kind: "word";
+                readonly summary: "The CUBE-local account";
+            }];
+        };
+        readonly enable: {
+            readonly summary: "Enable a disabled local account";
+            readonly operands: readonly [{
+                readonly name: "username";
+                readonly kind: "word";
+                readonly summary: "The CUBE-local account";
+            }];
+        };
+        readonly remove: {
+            readonly summary: "Remove a local account";
+            readonly operands: readonly [{
+                readonly name: "username";
+                readonly kind: "word";
+                readonly summary: "The CUBE-local account";
+            }];
+        };
+    };
+}>;
+/**
+ * `user` over words already split: the declaration's parse and handler.
+ *
+ * @param args - The words after `user`.
+ * @returns The account operation's result, or the refusal of a bad line.
+ *
+ * @example
+ * ```ts
+ * await builtin_user(['disable', 'jack.bivowac']);
+ * ```
  */
 export declare function builtin_user(args: string[]): Promise<CommandEnvelope>;
+/**
+ * Performs one local-account lifecycle operation, after making sure the
+ * identity may administer accounts.
+ *
+ * @param verb - The operation.
+ * @param username - The local account it acts on.
+ * @returns Envelope containing a local-account result or operation error.
+ *
+ * @example
+ * ```ts
+ * await user_run('inspect', 'jack.bivowac');
+ * ```
+ */
+export declare function user_run(verb: UserVerb, username: string): Promise<CommandEnvelope>;
+export {};