@fnndsc/brasa 0.56.1 → 0.56.3

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

@@ -1,22 +1,536 @@
 import { type CommandEnvelope } from '@fnndsc/menu';
+import { type CommandDeclaration } from '../../core/commandDeclaration.js';
+/** `files <list|search|inspect>`: the declaration. */
+export declare const filesCommand: CommandDeclaration<{
+    readonly subcommands: {
+        readonly list: {
+            readonly summary: "List the records, 20 to a page, under a path when one is given";
+            readonly operands: readonly [{
+                readonly name: "path";
+                readonly kind: "cfsPath";
+                readonly optional: true;
+                readonly summary: "The ChRIS path the records are under";
+            }];
+            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 records 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 record has";
+        };
+        readonly fieldslist: {
+            readonly summary: "The same as inspect";
+        };
+    };
+}>;
+/** `links <list|search|inspect>`: the declaration. */
+export declare const linksCommand: CommandDeclaration<{
+    readonly subcommands: {
+        readonly list: {
+            readonly summary: "List the records, 20 to a page, under a path when one is given";
+            readonly operands: readonly [{
+                readonly name: "path";
+                readonly kind: "cfsPath";
+                readonly optional: true;
+                readonly summary: "The ChRIS path the records are under";
+            }];
+            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 records 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 record has";
+        };
+        readonly fieldslist: {
+            readonly summary: "The same as inspect";
+        };
+    };
+}>;
+/** `dirs <list|search|inspect>`: the declaration. */
+export declare const dirsCommand: CommandDeclaration<{
+    readonly subcommands: {
+        readonly list: {
+            readonly summary: "List the records, 20 to a page, under a path when one is given";
+            readonly operands: readonly [{
+                readonly name: "path";
+                readonly kind: "cfsPath";
+                readonly optional: true;
+                readonly summary: "The ChRIS path the records are under";
+            }];
+            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 records 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 record has";
+        };
+        readonly fieldslist: {
+            readonly summary: "The same as inspect";
+        };
+    };
+}>;
 /**
- * Handles files commands.
+ * `files` over words already split: the declaration's parse and handler.
  *
  * @param args - command arguments.
  * @returns An envelope carrying the files listing or fields.
+ *
+ * @example
+ * ```ts
+ * await builtin_files(['list', '/home/chris/uploads']);
+ * ```
  */
 export declare function builtin_files(args: string[]): Promise<CommandEnvelope>;
 /**
- * Handles links commands.
+ * `links` over words already split: the declaration's parse and handler.
  *
  * @param args - command arguments.
  * @returns An envelope carrying the links listing or fields.
+ *
+ * @example
+ * ```ts
+ * await builtin_links(['list']);
+ * ```
  */
 export declare function builtin_links(args: string[]): Promise<CommandEnvelope>;
 /**
- * Handles dirs commands.
+ * `dirs` over words already split: the declaration's parse and handler.
  *
  * @param args - command arguments.
  * @returns An envelope carrying the dirs listing or fields.
+ *
+ * @example
+ * ```ts
+ * await builtin_dirs(['list']);
+ * ```
  */
 export declare function builtin_dirs(args: string[]): Promise<CommandEnvelope>;