@uniflowed/tui 0.0.0-alpha.18 → 0.15.0

package/capability.js

@@ -42,17 +42,20 @@ export type ColorChoice = "auto" | "always" | "never";
 
 /** The environment variables that influence terminal rendering. */
 export type TerminalEnv = {
-  readonly NO_COLOR?: string,
-  readonly FORCE_COLOR?: string,
-  readonly CLICOLOR?: string,
-  readonly CLICOLOR_FORCE?: string,
-  readonly TERM?: string,
-  readonly COLORTERM?: string,
-  readonly COLUMNS?: string,
-  readonly LINES?: string,
-  readonly LC_ALL?: string,
-  readonly LC_CTYPE?: string,
-  readonly LANG?: string,
+  readonly NO_COLOR?: string | void,
+  readonly FORCE_COLOR?: string | void,
+  readonly CLICOLOR?: string | void,
+  readonly CLICOLOR_FORCE?: string | void,
+  readonly TERM?: string | void,
+  readonly COLORTERM?: string | void,
+  readonly COLUMNS?: string | void,
+  readonly LINES?: string | void,
+  readonly LC_ALL?: string | void,
+  readonly LC_CTYPE?: string | void,
+  readonly LANG?: string | void,
+  // `process.env` names every variable the process has, and this type
+  // only the ones rendering reads.
+  ...
 };
 
 /** The resolved rendering capability of one stream. */
@@ -263,7 +266,7 @@ const usable = (value: number | void): number | null =>
  * Resolve how big the terminal is.
  *
  * Precedence, highest first — this list is `crates/uf_term/src/capability.rs`'s
- * `detect_size`, chain for chain, and `tests/library/tui.test.js` compares the
+ * `detect_size`, chain for chain, and `npm/tui/tui.test.js` compares the
  * two rather than believing this sentence:
  *
  * 1. `COLUMNS` and `LINES`, each on its own. POSIX makes them the override,

package/cells.js

@@ -185,7 +185,7 @@ export type Rect = {
 /** A frame of blanks, `width` by `height`. */
 export function createFrame(width: number, height: number): Frame {
   const size = Math.max(0, width * height);
-  const chars = new Array(size);
+  const chars = new Array<string>(size);
   for (let i = 0; i < size; i += 1) {
     chars[i] = " ";
   }

package/clipboard.js

@@ -0,0 +1,61 @@
+// @flow
+//
+// The terminal clipboard this package implements: OSC 52, write-only.
+//
+// OSC 52 is not a clipboard *service* in the browser sense. It is an escape
+// sequence sent to the terminal emulator, and the emulator may accept it,
+// ignore it, ask the reader, or cap the payload. There is no acknowledgement
+// on the same stream, so `copy()` reports whether uf could ask, not whether a
+// terminal eventually changed its clipboard.
+
+/** What `useClipboard()` hands back. */
+export type Clipboard = {
+  /** Put text on the terminal clipboard. */
+  copy(text: string): boolean,
+  /** Whether this renderer has a clipboard transport at all. */
+  supported: boolean,
+};
+
+const ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+
+/** A clipboard for renderers that have nowhere to send OSC 52. */
+export const unsupportedClipboard: Clipboard = {
+  supported: false,
+  copy() {
+    return false;
+  },
+};
+
+/** A clipboard that writes OSC 52 to a terminal stream. */
+export function osc52Clipboard(write: (chunk: string) => mixed): Clipboard {
+  return {
+    supported: true,
+    copy(text: string): boolean {
+      write(osc52(text));
+      return true;
+    },
+  };
+}
+
+/** Encode text as the OSC 52 "copy to clipboard" sequence. */
+export function osc52(text: string): string {
+  return `\u001b]52;c;${base64Utf8(text)}\u0007`;
+}
+
+function base64Utf8(text: string): string {
+  return base64Bytes(new TextEncoder().encode(text));
+}
+
+function base64Bytes(bytes: Uint8Array): string {
+  let out = "";
+  for (let at = 0; at < bytes.length; at += 3) {
+    const first = bytes[at];
+    const second = bytes[at + 1];
+    const third = bytes[at + 2];
+    out += ALPHABET[first >> 2];
+    out += ALPHABET[((first & 0b00000011) << 4) | ((second ?? 0) >> 4)];
+    out += second == null ? "=" : ALPHABET[((second & 0b00001111) << 2) | ((third ?? 0) >> 6)];
+    out += third == null ? "=" : ALPHABET[third & 0b00111111];
+  }
+  return out;
+}