caique 0.1.1 → 0.3.0

package/dist/spec.js

@@ -1,23 +1,7 @@
-/**
- * What a prompt *is*, before anything draws one (R1).
- *
- * A `PromptSpec` hangs off an option, not off a call site, and that is the whole
- * inversion: the option is the thing that exists in the manifest, in `--help`, in the MCP
- * tool schema and on the command line, and the prompt is one more projection of it. A
- * program written this way can be answered by a flag, by an environment variable, by a
- * config file or by a person, and nothing in it has to know which happened.
- *
- * Nothing here imports a runtime, a stream or a terminal. This file is data.
- */
-/** `--output-dir`, which is what a refusal has to say to be actionable. */
+export const BUILT_IN_KINDS = new Set(['text', 'confirm', 'select', 'multiselect', 'password', 'path']);
 export function flagOf(option) {
     return `--${option}`;
 }
-/**
- * A `select` without choices, or a `confirm` with them, is a spec that cannot be drawn.
- * Caught here rather than in the widget, so a program with a malformed prompt fails on the
- * first run instead of the first time someone reaches that option.
- */
 export function problemWith(spec) {
     const needsChoices = spec.kind === 'select' || spec.kind === 'multiselect';
     if (needsChoices && (spec.choices === undefined || spec.choices.length === 0))
@@ -28,4 +12,3 @@ export function problemWith(spec) {
         return 'a prompt needs a message: it is what a person is asked, and what an agent is told when it cannot be';
     return undefined;
 }
-//# sourceMappingURL=spec.js.map

package/dist/terminal.d.ts

@@ -1,5 +1,6 @@
 import { type Io } from './ask.js';
-/** The stream pair a terminal Io is built over: `process.stdin` and `process.stdout`. */
+import { type Runtime } from './runtime.js';
+/** The stream pair a terminal Io is built over: a `Runtime`'s `stdin` and its `stdout`. */
 export interface Streams {
     input: NodeJS.ReadableStream & {
         isTTY?: boolean;
@@ -8,13 +9,18 @@ export interface Streams {
         isTTY?: boolean;
     };
 }
+/** A runtime's two streams as the pair `createIo` takes — the mapping, written down once. */
+export declare const streamsOf: (runtime: Runtime) => Streams;
 /**
  * A reader and writer over a real stream pair.
  *
  * The reader resolves `undefined` when the stream ends, which `ask()` reads as a
  * cancellation — `Ctrl-D` and a closed pipe both arrive that way, and both mean nobody is
  * going to type.
+ *
+ * With no argument it builds over the real process, read when it is called and not at
+ * import: a program that wants the terminal it was started in writes `createIo()`.
  */
-export declare function createIo(streams: Streams): Io & {
+export declare function createIo(streams?: Streams): Io & {
     close: () => void;
 };

package/dist/terminal.js

@@ -1,43 +1,16 @@
-/**
- * A `Reader` and `Writer` over real streams — the one file in this package that touches a
- * terminal, and the reason `ask()` can be used by a program rather than only by a test.
- *
- * Everything above this is strings in and strings out. That is deliberate: the widgets, the
- * decision and the binding are all testable without a PTY, and this is the thin layer that
- * has to be got right once. It reads lines through `node:readline`, which handles the
- * line editing, the backspace and the `Ctrl-D` a person expects.
- *
- * **Hiding a password happens here**, because this is the only layer that knows what echo
- * is. `ask()` says which prompts are hidden; nothing above has to remember to mute anything,
- * and a widget cannot leak a secret by writing it, since no widget writes what it read.
- */
 import { createInterface } from 'node:readline';
-import {} from './ask.js';
-/** Accepts a chunk and writes nothing: what a muted stream's `write` does. */
+import { processRuntime } from './runtime.js';
+export const streamsOf = (runtime) => ({ input: runtime.stdin, output: runtime.stdout });
 const swallow = () => true;
-/**
- * `readline` echoes what it reads. For a hidden answer the echo is suppressed by
- * intercepting the interface's own output for the duration of the question — not by
- * turning the terminal's echo off, which would leave it off if the process died mid-prompt.
- */
 function mute(rl, streams) {
     const target = rl.output ?? streams.output;
     const original = target.write.bind(target);
-    // `readline` writes the prompt through the same stream it echoes through, so the prompt
-    // has already been written by the time this is installed: everything after it is input.
     target.write = swallow;
     return () => {
         target.write = original;
     };
 }
-/**
- * A reader and writer over a real stream pair.
- *
- * The reader resolves `undefined` when the stream ends, which `ask()` reads as a
- * cancellation — `Ctrl-D` and a closed pipe both arrive that way, and both mean nobody is
- * going to type.
- */
-export function createIo(streams) {
+export function createIo(streams = streamsOf(processRuntime())) {
     const rl = createInterface({ input: streams.input, output: streams.output, terminal: streams.output.isTTY === true });
     let ended = false;
     rl.once('close', () => {
@@ -64,8 +37,6 @@ export function createIo(streams) {
             }
             finally {
                 unmute?.();
-                // The newline the person typed was swallowed with the echo; put it back so the
-                // next question does not start on the same line as the hidden answer.
                 if (hidden)
                     streams.output.write('\n');
             }
@@ -78,4 +49,3 @@ export function createIo(streams) {
     };
     return { reader, writer, close: () => rl.close() };
 }
-//# sourceMappingURL=terminal.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "caique",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "The parrot that always answers back, and the boat that goes between ship and shore. Prompts that are flags first, so agents answer before they are asked and non-TTY callers get an error naming the flag, never a hang. Drop-in path for inquirer and clack.",
   "license": "MIT",
   "type": "module",
@@ -23,16 +23,32 @@
       "import": "./dist/binding.js",
       "default": "./dist/binding.js"
     },
+    "./clack": {
+      "types": "./dist/clack.d.ts",
+      "import": "./dist/clack.js",
+      "default": "./dist/clack.js"
+    },
     "./decide": {
       "types": "./dist/decide.d.ts",
       "import": "./dist/decide.js",
       "default": "./dist/decide.js"
     },
+    "./inquirer": {
+      "types": "./dist/inquirer.d.ts",
+      "import": "./dist/inquirer.js",
+      "default": "./dist/inquirer.js"
+    },
+    "./plugin": {
+      "types": "./dist/plugin.d.ts",
+      "import": "./dist/plugin.js",
+      "default": "./dist/plugin.js"
+    },
     "./raw": {
       "types": "./dist/raw.d.ts",
       "import": "./dist/raw.js",
       "default": "./dist/raw.js"
     },
+    "./schema.json": "./dist/schema.json",
     "./spec": {
       "types": "./dist/spec.d.ts",
       "import": "./dist/spec.js",
@@ -50,7 +66,7 @@
     "!dist/**/*.test.*"
   ],
   "scripts": {
-    "build": "tsc -p tsconfig.build.json",
+    "build": "tsc -p tsconfig.build.json && node ../../scripts/schema-to-dist.mjs && node ../../scripts/strip-comments.mjs dist",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "test": "vitest run --passWithNoTests",
     "coverage": "vitest run --coverage.enabled",
@@ -76,6 +92,10 @@
     "agent",
     "non-tty"
   ],
+  "dependencies": {
+    "closeout": "^0.2.1",
+    "linegauge": "^0.3.1"
+  },
   "devDependencies": {
     "vitest": "^5.0.0"
   }