WebTerminal API extension with onOutput function, some API fixes

Author: nikitaeverywhere

package.json

@@ -5,7 +5,7 @@
   "printableName": "Cache Web Terminal",
   "description": "Web-based terminal emulator for Caché administering.",
   "author": "ZitRo",
-  "version": "4.3.1",
+  "version": "4.4.0",
   "gaID": "UA-83005064-2",
   "releaseNumber": 26,
   "scripts": {

src/client/js/index.js

@@ -10,6 +10,8 @@ import { get, getURLParams } from "./lib";
 
 let onAuthHandlers = [],
     userInputHandlers = [],
+    outputHandlers = [],
+    bufferedOutput = [],
     AUTHORIZED = false,
     terminal = null;
 
@@ -33,9 +35,30 @@ export function authDone () {
     onAuthHandlers.forEach(h => h(terminal));
 }
 
-export function onUserInput (text, mode) {
+export const inputActivated = () => {
+    if (bufferedOutput.length) {
+        for (const handler of outputHandlers) {
+            if (handler.stream)
+                continue;
+            handler.callback(bufferedOutput);
+        }
+        bufferedOutput = [];
+    }
+};
+
+export const onUserInput = (text, mode) => {
     userInputHandlers.forEach((h) => h(text, mode));
-}
+    bufferedOutput = [];
+};
+
+export const onOutput = (string) => {
+    bufferedOutput.push(string);
+    for (const handler of outputHandlers) {
+        if (!handler.stream)
+            continue;
+        handler.callback([ string ]);
+    }
+};
 
 /**
  * Register the callback which will be executed right after terminal is initialized. This callback
@@ -58,14 +81,43 @@ Terminal.prototype.MODE_PROMPT = 1;
 Terminal.prototype.MODE_SQL = 2;
 Terminal.prototype.MODE_READ = 3;
 Terminal.prototype.MODE_READ_CHAR = 4;
-Terminal.prototype.MODE_SPECIAL = 1;
+Terminal.prototype.MODE_SPECIAL = 5;
+
+/**
+ * Function accepts the callback, which is fired when user enter a command, character or a string.
+ * @param {{ [stream]: boolean=false, [callback]: function }} [options]
+ * @param {terminalOutputCallback} callback
+ * @returns {function} - Your callback.
+ */
+Terminal.prototype.onOutput = function (options, callback) {
+    if (!options || typeof options === "function") {
+        callback = options || (() => { throw new Error("onOutput: no callback provided!"); });
+        options = {};
+    }
+    if (typeof options.stream === "undefined")
+        options.stream = false;
+    options.callback = callback;
+    outputHandlers.push(options);
+    return callback;
+};
+
+/**
+ * Handles output both in stream or prompt mode.
+ * @callback terminalOutputCallback
+ * @param {string[]} - Output data presented as an array of string chunks. You can get the full
+ *                     output as a single string by doing chunks.join("").
+ */
 
 /**
  * Function accepts the callback, which is fired when user enter a command, character or a string.
  * @param {terminalUserEntryCallback} callback
+ * @returns {function} - Your callback.
  */
 Terminal.prototype.onUserInput = function (callback) {
+    if (typeof callback !== "function")
+        throw new Error("onUserInput: no callback provided!");
     userInputHandlers.push(callback);
+    return callback;
 };
 
 /**

src/client/js/input/index.js

@@ -87,6 +87,8 @@ export function prompt (text, options = {}, callback = null, specialEnabled = tr
     PROMPT_CLEARED = false;
     SPECIAL_ENABLED = specialEnabled;
 
+    terminal.inputActivated();
+
     if (text)
         output.print(text);
 
@@ -145,6 +147,7 @@ export function getKey (options = {}, callback) {
     INPUT_MODE = Terminal.prototype.MODE_READ_CHAR;
 
     // for mobile devices the keyboard needs to appear
+    terminal.inputActivated();
     showInput();
     focusInput();
     caret.hide();
@@ -391,7 +394,7 @@ function getSelectionText() {
     let text = "";
     if (window.getSelection) {
         text = window.getSelection().toString();
-    } else if (document.selection && document.selection.type != "Control") {
+    } else if (document.selection && document.selection.type !== "Control") {
         text = document.selection.createRange().text;
     }
     return text;

src/client/js/output/index.js

@@ -5,6 +5,7 @@ import { ESC_CHARS_MASK, applyEscapeSequence } from "./escStateMachine";
 import esc from "./esc";
 import * as input from "../input";
 import { onInit } from "../init";
+import { onOutput } from "../index";
 
 const LINE_UPDATE_TIMEOUT = 10;
 
@@ -120,15 +121,14 @@ let tabs = [];
 
 export function print (text) {
 
+    onOutput(text);
     stack += text;
     if (!INITIALIZED)
         return;
     freeStack();
 
 }
 
-window.pr = print;
-
 export function printLine (text) {
     print(`${ text }\r\n`);
 }
@@ -502,7 +502,7 @@ function sizeChanged () {
         let m = `[WebTerminal] Size calculations delayed for 25s due to WebTerminal is not`
             + ` attached to the page. If this message doesn't stop appearing, check if`
             + ` WebTerminal's iFrame is visible and is attached to the DOM.`;
-        try { console.warn(m); } catch (e) { console.log(m); }
+        try { console.warn(m); } catch (e) { }
     }
 
     // elements.output.style.width = `${ WIDTH * SYMBOL_WIDTH + scrollBarWidth }px`;