@fnndsc/brasa 0.56.2 → 0.56.4

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

@@ -1,8 +1,480 @@
 import { type CommandEnvelope } from '@fnndsc/menu';
 /**
- * Handles feed commands.
+ * `feed [[listing options] | list | search | inspect | create | note | comments | comment | rm | tree | diagram] …`: the declaration.
  *
- * @param args - command arguments.
- * @returns An envelope carrying the rendered feed output.
+ * @example
+ * ```ts
+ * commands_register({ declarations: [feedCommand] }, 'backend');
+ * ```
+ */
+export declare const feedCommand: import("../../core/commandDeclaration.js").CommandDeclaration<{
+    readonly bare: {
+        readonly summary: "List the feeds, as list does";
+        readonly options: {
+            readonly user: {
+                readonly long: "user";
+                readonly summary: "Only this user's feeds (an administrator)";
+                readonly value: {
+                    readonly name: "username";
+                    readonly kind: "word";
+                };
+            };
+            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 feeds, 20 to a page";
+            readonly options: {
+                readonly user: {
+                    readonly long: "user";
+                    readonly summary: "Only this user's feeds (an administrator)";
+                    readonly value: {
+                        readonly name: "username";
+                        readonly kind: "word";
+                    };
+                };
+                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 feeds a filter matches (list --search <term>)";
+            readonly operands: readonly [{
+                readonly name: "term";
+                readonly kind: "word";
+                readonly summary: "The filter, field:value, or part of a name";
+            }];
+            readonly options: {
+                readonly user: {
+                    readonly long: "user";
+                    readonly summary: "Only this user's feeds (an administrator)";
+                    readonly value: {
+                        readonly name: "username";
+                        readonly kind: "word";
+                    };
+                };
+                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 feed has";
+        };
+        readonly create: {
+            readonly summary: "Create a feed from data folders in ChRIS";
+            readonly operands: readonly [{
+                readonly name: "paths";
+                readonly kind: "cfsPath";
+                readonly optional: true;
+                readonly repeat: true;
+                readonly summary: "The data folders the feed starts from";
+            }];
+            readonly options: {
+                readonly dirs: {
+                    readonly long: "dirs";
+                    readonly summary: "The data folders, comma-separated";
+                    readonly value: {
+                        readonly name: "path,…";
+                        readonly kind: "word";
+                    };
+                };
+                readonly params: {
+                    readonly long: "params";
+                    readonly summary: "The feed's fields, as name:value pairs";
+                    readonly value: {
+                        readonly name: "params";
+                        readonly kind: "word";
+                    };
+                };
+            };
+        };
+        readonly note: {
+            readonly summary: "Show a feed's note; with --title or --content, change it; with edit, open it in the editor (edit /proc/jobs/feed_N/note)";
+            readonly operands: readonly [{
+                readonly name: "edit";
+                readonly kind: "enum";
+                readonly values: readonly ["edit"];
+                readonly optional: true;
+                readonly summary: "Open the note in the editor";
+            }, {
+                readonly name: "feed";
+                readonly kind: "int";
+                readonly min: 1;
+                readonly summary: "The feed's id";
+            }];
+            readonly options: {
+                readonly title: {
+                    readonly long: "title";
+                    readonly summary: "The title";
+                    readonly value: {
+                        readonly name: "text";
+                        readonly kind: "word";
+                    };
+                };
+                readonly content: {
+                    readonly long: "content";
+                    readonly summary: "The text";
+                    readonly value: {
+                        readonly name: "text";
+                        readonly kind: "word";
+                    };
+                };
+            };
+        };
+        readonly comments: {
+            readonly summary: "List the comments on a feed";
+            readonly operands: readonly [{
+                readonly name: "feed";
+                readonly kind: "int";
+                readonly min: 1;
+                readonly summary: "The feed's id";
+            }];
+        };
+        readonly comment: {
+            readonly summary: "Add a comment to a feed, or edit or delete one";
+            readonly operands: readonly [{
+                readonly name: "op";
+                readonly kind: "enum";
+                readonly values: readonly ["add", "edit", "delete"];
+                readonly summary: "What to do";
+            }, {
+                readonly name: "feed";
+                readonly kind: "int";
+                readonly min: 1;
+                readonly summary: "The feed's id";
+            }, {
+                readonly name: "comment";
+                readonly kind: "int";
+                readonly min: 1;
+                readonly optional: true;
+                readonly summary: "The comment's id, to edit or delete it";
+            }];
+            readonly options: {
+                readonly title: {
+                    readonly long: "title";
+                    readonly summary: "The title";
+                    readonly value: {
+                        readonly name: "text";
+                        readonly kind: "word";
+                    };
+                };
+                readonly content: {
+                    readonly long: "content";
+                    readonly summary: "The text";
+                    readonly value: {
+                        readonly name: "text";
+                        readonly kind: "word";
+                    };
+                };
+            };
+        };
+        readonly rm: {
+            readonly summary: "Remove a feed and everything in it; asks first";
+            readonly operands: readonly [{
+                readonly name: "feed";
+                readonly kind: "feed";
+                readonly optional: true;
+                readonly repeat: true;
+                readonly summary: "An id, feed_N, an exact title or a unique search; none for the feed you are in";
+            }];
+            readonly options: {
+                readonly force: {
+                    readonly short: "f";
+                    readonly long: "force";
+                    readonly summary: "Remove without asking";
+                };
+            };
+        };
+        readonly tree: {
+            readonly summary: "Draw the feed's plugin-instance DAG";
+            readonly operands: readonly [{
+                readonly name: "feed";
+                readonly kind: "feed";
+                readonly optional: true;
+                readonly repeat: true;
+                readonly summary: "An id, feed_N, an exact title or a unique search; none for the feed you are in";
+            }];
+            readonly options: {
+                readonly focus: {
+                    readonly long: "focus";
+                    readonly summary: "Scope the tree to one node's subtree";
+                    readonly value: {
+                        readonly name: "id";
+                        readonly kind: "int";
+                        readonly min: 1;
+                    };
+                };
+                readonly maxNodes: {
+                    readonly long: "max-nodes";
+                    readonly summary: "Draw at most this many nodes (0 draws them all)";
+                    readonly value: {
+                        readonly name: "n";
+                        readonly kind: "int";
+                        readonly min: 0;
+                    };
+                };
+                readonly flat: {
+                    readonly long: "flat";
+                    readonly summary: "Draw every node, not collapsing siblings of one shape";
+                };
+            };
+        };
+        readonly diagram: {
+            readonly summary: "Draw the DAG as tree does, carrying it as a model; with --signalflow, write it as SignalFlow YAML";
+            readonly operands: readonly [{
+                readonly name: "feed";
+                readonly kind: "feed";
+                readonly optional: true;
+                readonly repeat: true;
+                readonly summary: "An id, feed_N, an exact title or a unique search; none for the feed you are in";
+            }];
+            readonly options: {
+                readonly signalflow: {
+                    readonly long: "signalflow";
+                    readonly summary: "Write the DAG as SignalFlow YAML (feed diagram --signalflow 42 | signalflow -)";
+                };
+                readonly focus: {
+                    readonly long: "focus";
+                    readonly summary: "Scope the tree to one node's subtree";
+                    readonly value: {
+                        readonly name: "id";
+                        readonly kind: "int";
+                        readonly min: 1;
+                    };
+                };
+                readonly maxNodes: {
+                    readonly long: "max-nodes";
+                    readonly summary: "Draw at most this many nodes (0 draws them all)";
+                    readonly value: {
+                        readonly name: "n";
+                        readonly kind: "int";
+                        readonly min: 0;
+                    };
+                };
+                readonly flat: {
+                    readonly long: "flat";
+                    readonly summary: "Draw every node, not collapsing siblings of one shape";
+                };
+            };
+        };
+        readonly share: {
+            readonly summary: "Retired: setfacl and chmod share a feed";
+            readonly operands: readonly [{
+                readonly name: "words";
+                readonly kind: "word";
+                readonly optional: true;
+                readonly repeat: true;
+                readonly summary: "Anything; it says which verb to use";
+            }];
+        };
+    };
+}>;
+/**
+ * `feed` over words already split: the declaration's parse and handler.
+ *
+ * @param args - The words after `feed`.
+ * @returns The answer, or the refusal of a bad line.
+ *
+ * @example
+ * ```ts
+ * await builtin_feed(['tree', 'feed_12']);
+ * ```
  */
 export declare function builtin_feed(args: string[]): Promise<CommandEnvelope>;