@orkestrel/terminal 0.0.11 → 0.0.13

package/dist/src/core/index.d.cts

@@ -68,15 +68,17 @@ export declare function confirmReduce(state: ReturnType<typeof createConfirmStat
 export declare function confirmView(state: ReturnType<typeof createConfirmState>): string;
 
 /**
- * The single control BYTE → key descriptor table {@link import('./helpers.js').parseKey}
- * consults for the one-byte keys. Each entry carries the canonical `name` and whether it is a
- * `ctrl` combination. The source of truth for the single-byte key decode; frozen.
+ * The control BYTE (or CRLF pair) → key descriptor table {@link import('./helpers.js').parseKey}
+ * consults for the one-byte keys and the two-byte CRLF Enter chunk. Each entry carries the
+ * canonical `name` and whether it is a `ctrl` combination. The source of truth for that decode;
+ * frozen.
  *
  * @remarks
- * `return` / `newline` map to `return` (one canonical Enter name); `delete` / `backspace` both
- * map to `backspace` (the two Backspace bytes); the Ctrl combos (`c` / `d` / `u` / `a` / `e`)
- * carry `ctrl: true` so a reducer can match `key.ctrl && key.name === 'c'`. `escape` / `tab` /
- * `space` are plain named keys.
+ * `return` / `newline` / `return + newline` all map to `return` (one canonical Enter name) — a
+ * terminal or a paste can deliver Enter as `\r`, `\n`, or the `\r\n` pair in one chunk;
+ * `delete` / `backspace` both map to `backspace` (the two Backspace bytes); the Ctrl combos
+ * (`c` / `d` / `u` / `a` / `e`) carry `ctrl: true` so a reducer can match
+ * `key.ctrl && key.name === 'c'`. `escape` / `tab` / `space` are plain named keys.
  */
 export declare const CONTROL_NAMES: Readonly<Record<string, {
     readonly name: string;
@@ -672,15 +674,15 @@ export declare interface ParkRequest {
 
 /**
  * Decode one keypress's bytes into a {@link KeyEvent} — total, never throws. A `Uint8Array` is
- * read as UTF-8; the resulting string is matched against the known control bytes
- * ({@link CONTROL_NAMES}) and escape sequences ({@link SEQUENCE_NAMES}), falling back to a
+ * read as UTF-8; the resulting string is matched against the known control bytes and the CRLF
+ * pair ({@link CONTROL_NAMES}) and escape sequences ({@link SEQUENCE_NAMES}), falling back to a
  * single printable character. An unrecognized sequence yields `name: ''` with the raw `sequence`
  * preserved.
  *
  * @remarks
  * - **Single control byte.** A one-character control input (`return` / `backspace` / `tab` /
- *   `escape` / `space`, or a Ctrl combo `c` / `d` / `u` / `a` / `e`) is looked up in
- *   {@link CONTROL_NAMES}, carrying its `ctrl` flag.
+ *   `escape` / `space`, or a Ctrl combo `c` / `d` / `u` / `a` / `e`), or the two-byte `\r\n`
+ *   CRLF pair, is looked up in {@link CONTROL_NAMES}, carrying its `ctrl` flag.
  * - **Escape sequence.** A multi-byte ESC sequence (`up` / `down` / `left` / `right` in BOTH the
  *   `ESC[A` and `ESCOA` forms, plus `home` / `end` / `delete`) is looked up in
  *   {@link SEQUENCE_NAMES} and flagged `meta`.
@@ -696,6 +698,7 @@ export declare interface ParkRequest {
  * @example
  * ```ts
  * parseKey('\r')        // { name: 'return', sequence: '\r', ctrl: false, meta: false, shift: false }
+ * parseKey('\r\n')      // { name: 'return', sequence: '\r\n', ctrl: false, meta: false, shift: false }
  * parseKey('\x1b[A')    // { name: 'up', sequence: '\x1b[A', ctrl: false, meta: true, shift: false }
  * parseKey('A')         // { name: 'A', sequence: 'A', ctrl: false, meta: false, shift: true }
  * parseKey('\x03')      // { name: 'c', sequence: '\x03', ctrl: true, meta: false, shift: false }

package/dist/src/core/index.d.ts

@@ -68,15 +68,17 @@ export declare function confirmReduce(state: ReturnType<typeof createConfirmStat
 export declare function confirmView(state: ReturnType<typeof createConfirmState>): string;
 
 /**
- * The single control BYTE → key descriptor table {@link import('./helpers.js').parseKey}
- * consults for the one-byte keys. Each entry carries the canonical `name` and whether it is a
- * `ctrl` combination. The source of truth for the single-byte key decode; frozen.
+ * The control BYTE (or CRLF pair) → key descriptor table {@link import('./helpers.js').parseKey}
+ * consults for the one-byte keys and the two-byte CRLF Enter chunk. Each entry carries the
+ * canonical `name` and whether it is a `ctrl` combination. The source of truth for that decode;
+ * frozen.
  *
  * @remarks
- * `return` / `newline` map to `return` (one canonical Enter name); `delete` / `backspace` both
- * map to `backspace` (the two Backspace bytes); the Ctrl combos (`c` / `d` / `u` / `a` / `e`)
- * carry `ctrl: true` so a reducer can match `key.ctrl && key.name === 'c'`. `escape` / `tab` /
- * `space` are plain named keys.
+ * `return` / `newline` / `return + newline` all map to `return` (one canonical Enter name) — a
+ * terminal or a paste can deliver Enter as `\r`, `\n`, or the `\r\n` pair in one chunk;
+ * `delete` / `backspace` both map to `backspace` (the two Backspace bytes); the Ctrl combos
+ * (`c` / `d` / `u` / `a` / `e`) carry `ctrl: true` so a reducer can match
+ * `key.ctrl && key.name === 'c'`. `escape` / `tab` / `space` are plain named keys.
  */
 export declare const CONTROL_NAMES: Readonly<Record<string, {
     readonly name: string;
@@ -672,15 +674,15 @@ export declare interface ParkRequest {
 
 /**
  * Decode one keypress's bytes into a {@link KeyEvent} — total, never throws. A `Uint8Array` is
- * read as UTF-8; the resulting string is matched against the known control bytes
- * ({@link CONTROL_NAMES}) and escape sequences ({@link SEQUENCE_NAMES}), falling back to a
+ * read as UTF-8; the resulting string is matched against the known control bytes and the CRLF
+ * pair ({@link CONTROL_NAMES}) and escape sequences ({@link SEQUENCE_NAMES}), falling back to a
  * single printable character. An unrecognized sequence yields `name: ''` with the raw `sequence`
  * preserved.
  *
  * @remarks
  * - **Single control byte.** A one-character control input (`return` / `backspace` / `tab` /
- *   `escape` / `space`, or a Ctrl combo `c` / `d` / `u` / `a` / `e`) is looked up in
- *   {@link CONTROL_NAMES}, carrying its `ctrl` flag.
+ *   `escape` / `space`, or a Ctrl combo `c` / `d` / `u` / `a` / `e`), or the two-byte `\r\n`
+ *   CRLF pair, is looked up in {@link CONTROL_NAMES}, carrying its `ctrl` flag.
  * - **Escape sequence.** A multi-byte ESC sequence (`up` / `down` / `left` / `right` in BOTH the
  *   `ESC[A` and `ESCOA` forms, plus `home` / `end` / `delete`) is looked up in
  *   {@link SEQUENCE_NAMES} and flagged `meta`.
@@ -696,6 +698,7 @@ export declare interface ParkRequest {
  * @example
  * ```ts
  * parseKey('\r')        // { name: 'return', sequence: '\r', ctrl: false, meta: false, shift: false }
+ * parseKey('\r\n')      // { name: 'return', sequence: '\r\n', ctrl: false, meta: false, shift: false }
  * parseKey('\x1b[A')    // { name: 'up', sequence: '\x1b[A', ctrl: false, meta: true, shift: false }
  * parseKey('A')         // { name: 'A', sequence: 'A', ctrl: false, meta: false, shift: true }
  * parseKey('\x03')      // { name: 'c', sequence: '\x03', ctrl: true, meta: false, shift: false }

package/dist/src/core/index.js

@@ -68,15 +68,17 @@ var SEQUENCE_NAMES = Object.freeze({
 	[`${KEY_CSI}8~`]: "end"
 });
 /**
-* The single control BYTE → key descriptor table {@link import('./helpers.js').parseKey}
-* consults for the one-byte keys. Each entry carries the canonical `name` and whether it is a
-* `ctrl` combination. The source of truth for the single-byte key decode; frozen.
+* The control BYTE (or CRLF pair) → key descriptor table {@link import('./helpers.js').parseKey}
+* consults for the one-byte keys and the two-byte CRLF Enter chunk. Each entry carries the
+* canonical `name` and whether it is a `ctrl` combination. The source of truth for that decode;
+* frozen.
 *
 * @remarks
-* `return` / `newline` map to `return` (one canonical Enter name); `delete` / `backspace` both
-* map to `backspace` (the two Backspace bytes); the Ctrl combos (`c` / `d` / `u` / `a` / `e`)
-* carry `ctrl: true` so a reducer can match `key.ctrl && key.name === 'c'`. `escape` / `tab` /
-* `space` are plain named keys.
+* `return` / `newline` / `return + newline` all map to `return` (one canonical Enter name) — a
+* terminal or a paste can deliver Enter as `\r`, `\n`, or the `\r\n` pair in one chunk;
+* `delete` / `backspace` both map to `backspace` (the two Backspace bytes); the Ctrl combos
+* (`c` / `d` / `u` / `a` / `e`) carry `ctrl: true` so a reducer can match
+* `key.ctrl && key.name === 'c'`. `escape` / `tab` / `space` are plain named keys.
 */
 var CONTROL_NAMES = Object.freeze({
 	["\r"]: Object.freeze({
@@ -87,6 +89,11 @@ var CONTROL_NAMES = Object.freeze({
 		name: "return",
 		ctrl: false
 	}),
+	[`\r
+`]: Object.freeze({
+		name: "return",
+		ctrl: false
+	}),
 	["	"]: Object.freeze({
 		name: "tab",
 		ctrl: false
@@ -339,15 +346,15 @@ var isTerminalSnapshot = recordOf({
 //#region src/core/helpers.ts
 /**
 * Decode one keypress's bytes into a {@link KeyEvent} — total, never throws. A `Uint8Array` is
-* read as UTF-8; the resulting string is matched against the known control bytes
-* ({@link CONTROL_NAMES}) and escape sequences ({@link SEQUENCE_NAMES}), falling back to a
+* read as UTF-8; the resulting string is matched against the known control bytes and the CRLF
+* pair ({@link CONTROL_NAMES}) and escape sequences ({@link SEQUENCE_NAMES}), falling back to a
 * single printable character. An unrecognized sequence yields `name: ''` with the raw `sequence`
 * preserved.
 *
 * @remarks
 * - **Single control byte.** A one-character control input (`return` / `backspace` / `tab` /
-*   `escape` / `space`, or a Ctrl combo `c` / `d` / `u` / `a` / `e`) is looked up in
-*   {@link CONTROL_NAMES}, carrying its `ctrl` flag.
+*   `escape` / `space`, or a Ctrl combo `c` / `d` / `u` / `a` / `e`), or the two-byte `\r\n`
+*   CRLF pair, is looked up in {@link CONTROL_NAMES}, carrying its `ctrl` flag.
 * - **Escape sequence.** A multi-byte ESC sequence (`up` / `down` / `left` / `right` in BOTH the
 *   `ESC[A` and `ESCOA` forms, plus `home` / `end` / `delete`) is looked up in
 *   {@link SEQUENCE_NAMES} and flagged `meta`.
@@ -363,6 +370,7 @@ var isTerminalSnapshot = recordOf({
 * @example
 * ```ts
 * parseKey('\r')        // { name: 'return', sequence: '\r', ctrl: false, meta: false, shift: false }
+* parseKey('\r\n')      // { name: 'return', sequence: '\r\n', ctrl: false, meta: false, shift: false }
 * parseKey('\x1b[A')    // { name: 'up', sequence: '\x1b[A', ctrl: false, meta: true, shift: false }
 * parseKey('A')         // { name: 'A', sequence: 'A', ctrl: false, meta: false, shift: true }
 * parseKey('\x03')      // { name: 'c', sequence: '\x03', ctrl: true, meta: false, shift: false }