@difizen/libro-terminal 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Difizen Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# libro-widget

package/es/configuration.js

@@ -0,0 +1,226 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+var _dec, _class;
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+import { isOSX, isWindows, singleton } from '@difizen/mana-app';
+export var DEFAULT_TERMINAL_RENDERER_TYPE = 'canvas';
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function isTerminalRendererType(arg) {
+  return typeof arg === 'string' && (arg === 'canvas' || arg === 'dom');
+}
+export var terminalEnableCopy = {
+  id: 'terminal.enableCopy',
+  schema: {
+    type: 'boolean'
+  },
+  description: 'Enable ctrl-c (cmd-c on macOS) to copy selected text',
+  defaultValue: true
+};
+export var terminalEnablePaste = {
+  id: 'terminal.enablePaste',
+  schema: {
+    type: 'boolean'
+  },
+  description: 'Enable ctrl-v (cmd-v on macOS) to paste from clipboard',
+  defaultValue: true
+};
+export var terminalIntegratedFontFamily = {
+  id: 'terminal.integrated.fontFamily',
+  schema: {
+    type: 'string'
+  },
+  description: "Controls the font family of the terminal, this defaults to `#editor.fontFamily#`'s value.",
+  defaultValue: isOSX ? "Menlo, Monaco, 'Courier New', monospace" : isWindows ? "Consolas, 'Courier New', monospace" : "'Droid Sans Mono', 'monospace', monospace"
+};
+export var terminalIntegratedFontSize = {
+  id: 'terminal.integrated.fontSize',
+  schema: {
+    type: 'number',
+    minimum: 6
+  },
+  description: 'Controls the font size in pixels of the terminal.',
+  defaultValue: 12
+};
+export var terminalIntegratedFontWeight = {
+  id: 'terminal.integrated.fontWeight',
+  schema: {
+    type: 'string'
+  },
+  // enum: ['normal', 'bold', '100', '200', '300', '400', '500', '600', '700', '800', '900'],
+  description: 'The font weight to use within the terminal for non-bold text. Accepts "normal" and "bold" keywords or numbers between 1 and 1000.',
+  defaultValue: 'normal'
+};
+export var terminalIntegratedFontWeightBold = {
+  id: 'terminal.integrated.fontWeightBold',
+  schema: {
+    type: 'string'
+  },
+  // enum: ['normal', 'bold', '100', '200', '300', '400', '500', '600', '700', '800', '900'],
+  description: 'The font weight to use within the terminal for bold text. Accepts "normal" and "bold" keywords or numbers between 1 and 1000.',
+  defaultValue: 'bold'
+};
+export var terminalIntegratedDrawBoldTextInBrightColors = {
+  id: 'terminal.integrated.drawBoldTextInBrightColors',
+  description: 'Controls whether bold text in the terminal will always use the "bright" ANSI color variant.',
+  schema: {
+    type: 'boolean'
+  },
+  defaultValue: true
+};
+export var terminalIntegratedLetterSpacing = {
+  id: 'terminal.integrated.letterSpacing',
+  description: 'Controls the letter spacing of the terminal, this is an integer value which represents the amount of additional pixels to add between characters.',
+  schema: {
+    type: 'number'
+  },
+  defaultValue: 1
+};
+export var terminalIntegratedLineHeight = {
+  id: 'terminal.integrated.lineHeight',
+  description: 'Controls the line height of the terminal, this number is multiplied by the terminal font size to get the actual line-height in pixels.',
+  schema: {
+    type: 'number',
+    minimum: 1
+  },
+  defaultValue: 1
+};
+export var terminalIntegratedScrollback = {
+  id: 'terminal.integrated.scrollback',
+  description: 'Controls the maximum amount of lines the terminal keeps in its buffer.',
+  schema: {
+    type: 'number'
+  },
+  defaultValue: 1000
+};
+export var terminalIntegratedFastScrollSensitivity = {
+  id: 'terminal.integrated.fastScrollSensitivity',
+  description: 'Scrolling speed multiplier when pressing `Alt`.',
+  schema: {
+    type: 'number'
+  },
+  defaultValue: 5
+};
+export var terminalIntegratedRendererType = {
+  id: 'terminal.integrated.rendererType',
+  description: 'Controls how the terminal is rendered.',
+  schema: {
+    type: 'string'
+  },
+  // enum: ['canvas', 'dom'],
+  defaultValue: 'canvas'
+};
+export var terminalIntegratedCopyOnSelection = {
+  id: 'terminal.integrated.copyOnSelection',
+  description: 'Controls whether text selected in the terminal will be copied to the clipboard.',
+  schema: {
+    type: 'boolean'
+  },
+  defaultValue: false
+};
+export var terminalIntegratedCursorBlinking = {
+  id: 'terminal.integrated.cursorBlinking',
+  description: 'Controls whether the terminal cursor blinks.',
+  schema: {
+    type: 'boolean'
+  },
+  defaultValue: false
+};
+export var terminalIntegratedCursorStyle = {
+  id: 'terminal.integrated.cursorStyle',
+  description: 'Controls the style of terminal cursor.',
+  // enum: ['block', 'underline', 'line'],
+  defaultValue: 'block',
+  schema: {
+    type: 'string'
+  }
+};
+export var terminalIntegratedCursorWidth = {
+  id: 'terminal.integrated.cursorWidth',
+  description: 'Controls the width of the cursor when `#terminal.integrated.cursorStyle#` is set to `line`.',
+  schema: {
+    type: 'number'
+  },
+  defaultValue: 1
+};
+export var terminalIntegratedShellWindows = {
+  id: 'terminal.integrated.shell.windows',
+  schema: {
+    type: 'string'
+  },
+  // typeDetails: { isFilepath: true },
+  description: "The path of the shell that the terminal uses on Windows. (defaultValue: '{0}').",
+  defaultValue: undefined
+};
+export var terminalIntegratedShellOsx = {
+  id: 'terminal.integrated.shell.osx',
+  schema: {
+    type: 'string'
+  },
+  description: "The path of the shell that the terminal uses on macOS (defaultValue: '{0}'}).",
+  defaultValue: undefined
+};
+export var terminalIntegratedShellLinux = {
+  id: 'terminal.integrated.shell.linux',
+  schema: {
+    type: 'string'
+  },
+  description: "The path of the shell that the terminal uses on Linux (defaultValue: '{0}'}).",
+  defaultValue: undefined
+};
+export var terminalIntegratedShellArgsWindows = {
+  id: 'terminal.integrated.shellArgs.windows',
+  schema: {
+    type: 'string'
+  },
+  description: 'The command line arguments to use when on the Windows terminal.',
+  defaultValue: []
+};
+export var terminalIntegratedShellArgsOsx = {
+  id: 'terminal.integrated.shellArgs.osx',
+  schema: {
+    type: 'string'
+  },
+  description: 'The command line arguments to use when on the macOS terminal.',
+  defaultValue: ['-l']
+};
+export var terminalIntegratedShellArgsLinux = {
+  id: 'terminal.integrated.shellArgs.linux',
+  schema: {
+    type: 'string'
+  },
+  description: 'The command line arguments to use when on the Linux terminal.',
+  defaultValue: []
+};
+export var terminalIntegratedConfirmOnExit = {
+  id: 'terminal.integrated.confirmOnExit',
+  schema: {
+    type: 'string'
+  },
+  description: 'Controls whether to confirm when the window closes if there are active terminal sessions.',
+  // enum: ['never', 'always', 'hasChildProcesses'],
+  // enumDescriptions: [
+  //     nls.localize('theia/terminal/confirmCloseNever', 'Never confirm.'),
+  //     nls.localize('theia/terminal/confirmCloseAlways', 'Always confirm if there are terminals.'),
+  //     nls.localize('theia/terminal/confirmCloseChildren', 'Confirm if there are any terminals that have child processes.'),
+  // ],
+  defaultValue: 'never'
+};
+export var TerminalConfiguration = (_dec = singleton(), _dec(_class = /*#__PURE__*/function () {
+  function TerminalConfiguration() {
+    _classCallCheck(this, TerminalConfiguration);
+    this.configs = [terminalEnableCopy, terminalEnablePaste, terminalIntegratedFontFamily, terminalIntegratedFontSize, terminalIntegratedFontWeight, terminalIntegratedFontWeightBold, terminalIntegratedDrawBoldTextInBrightColors, terminalIntegratedLetterSpacing, terminalIntegratedLineHeight, terminalIntegratedScrollback, terminalIntegratedFastScrollSensitivity, terminalIntegratedRendererType, terminalIntegratedCopyOnSelection, terminalIntegratedCursorBlinking, terminalIntegratedCursorStyle, terminalIntegratedCursorWidth, terminalIntegratedShellWindows, terminalIntegratedShellOsx, terminalIntegratedShellLinux, terminalIntegratedShellArgsWindows, terminalIntegratedShellArgsOsx, terminalIntegratedShellArgsLinux, terminalIntegratedConfirmOnExit];
+  }
+  _createClass(TerminalConfiguration, [{
+    key: "get",
+    value: function get(key) {
+      var _this$configs$find;
+      return (_this$configs$find = this.configs.find(function (item) {
+        return item.id === key;
+      })) === null || _this$configs$find === void 0 ? void 0 : _this$configs$find.defaultValue;
+    }
+  }]);
+  return TerminalConfiguration;
+}()) || _class);

package/es/connection.d.ts

@@ -0,0 +1,108 @@
+/// <reference types="node" resolution-mode="require"/>
+import type { ISettings } from '@difizen/libro-kernel';
+import type { Disposable, Disposed, Event } from '@difizen/mana-app';
+import { Emitter } from '@difizen/mana-app';
+import { TerminalOption } from './protocol.js';
+import type { TerminalMessage, TerminalModel, TerminalConnectionStatus } from './protocol.js';
+import { TerminalRestAPI } from './restapi.js';
+export declare class TerminalConnection implements Disposable, Disposed {
+    protected _onDisposed: Emitter<void>;
+    protected _messageReceived: Emitter<TerminalMessage>;
+    protected _connectionStatus: TerminalConnectionStatus;
+    protected _connectionStatusChanged: Emitter<TerminalConnectionStatus>;
+    protected _name: string;
+    protected _reconnectTimeout?: NodeJS.Timeout;
+    protected _ws?: WebSocket;
+    protected _noOp: () => void;
+    protected _reconnectLimit: number;
+    protected _reconnectAttempt: number;
+    protected _pendingMessages: TerminalMessage[];
+    terminalRestAPI: TerminalRestAPI;
+    disposed: boolean;
+    /**
+     * Construct a new terminal session.
+     */
+    constructor(options: TerminalOption & {
+        name: string;
+    });
+    /**
+     * A signal emitted when a message is received from the server.
+     */
+    get messageReceived(): Event<TerminalMessage>;
+    get onDisposed(): Event<void>;
+    /**
+     * Get the name of the terminal session.
+     */
+    get name(): string;
+    /**
+     * Get the model for the terminal session.
+     */
+    get model(): TerminalModel;
+    /**
+     * The server settings for the session.
+     */
+    readonly serverSettings: ISettings;
+    /**
+     * Dispose of the resources held by the session.
+     */
+    dispose(): void;
+    /**
+     * Send a message to the terminal session.
+     *
+     * #### Notes
+     * If the connection is down, the message will be queued for sending when
+     * the connection comes back up.
+     */
+    send(message: TerminalMessage): void;
+    /**
+     * Send a message on the websocket, or possibly queue for later sending.
+     *
+     * @param queue - whether to queue the message if it cannot be sent
+     */
+    _sendMessage(message: TerminalMessage, queue?: boolean): void;
+    /**
+     * Send pending messages to the kernel.
+     */
+    protected _sendPending(): void;
+    toDisposeOnReconnect: Disposable | undefined;
+    /**
+     * Reconnect to a terminal.
+     */
+    reconnect(): Promise<void>;
+    /**
+     * Attempt a connection if we have not exhausted connection attempts.
+     */
+    _reconnect(): void;
+    /**
+     * Forcefully clear the socket state.
+     *
+     * #### Notes
+     * This will clear all socket state without calling any handlers and will
+     * not update the connection status. If you call this method, you are
+     * responsible for updating the connection status as needed and recreating
+     * the socket if you plan to reconnect.
+     */
+    protected _clearSocket(): void;
+    /**
+     * Shut down the terminal session.
+     */
+    shutdown(): Promise<void>;
+    /**
+     * Create the terminal websocket connection and add socket status handlers.
+     *
+     * #### Notes
+     * You are responsible for updating the connection status as appropriate.
+     */
+    protected _createSocket: () => void;
+    protected _onWSMessage: (event: MessageEvent) => void;
+    protected _onWSClose: (event: CloseEvent) => void;
+    /**
+     * Handle connection status changes.
+     */
+    protected _updateConnectionStatus(connectionStatus: TerminalConnectionStatus): void;
+    protected _errorIfDisposed(): void;
+    get connectionStatusChanged(): Event<TerminalConnectionStatus>;
+    get connectionStatus(): TerminalConnectionStatus;
+}
+export declare function getRandomIntInclusive(min: number, max: number): number;
+//# sourceMappingURL=connection.d.ts.map

package/es/connection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connection.d.ts","sourceRoot":"","sources":["../src/connection.ts"],"names":[],"mappings":";AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAGrE,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAG5C,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EACV,eAAe,EACf,aAAa,EACb,wBAAwB,EAEzB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C,qBACa,kBAAmB,YAAW,UAAU,EAAE,QAAQ;IAC7D,SAAS,CAAC,WAAW,gBAAuB;IAC5C,SAAS,CAAC,gBAAgB,2BAAkC;IAC5D,SAAS,CAAC,iBAAiB,EAAE,wBAAwB,CAAgB;IACrE,SAAS,CAAC,wBAAwB,oCAA2C;IAC7E,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC,OAAO,CAAa;IACzD,SAAS,CAAC,GAAG,CAAC,EAAE,SAAS,CAAa;IACtC,SAAS,CAAC,KAAK,aAEb;IACF,SAAS,CAAC,eAAe,SAAK;IAC9B,SAAS,CAAC,iBAAiB,SAAK;IAChC,SAAS,CAAC,gBAAgB,EAAE,eAAe,EAAE,CAAM;IAC1B,eAAe,EAAE,eAAe,CAAC;IAE1D,QAAQ,UAAS;IAEjB;;OAEG;gBACiC,OAAO,EAAE,cAAc,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;IAK9E;;OAEG;IACH,IAAI,eAAe,IAAI,KAAK,CAAC,eAAe,CAAC,CAE5C;IAED,IAAI,UAAU,IAAI,KAAK,CAAC,IAAI,CAAC,CAE5B;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,aAAa,CAEzB;IAED;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAC;IAEnC;;OAEG;IACH,OAAO,IAAI,IAAI;IASf;;;;;;OAMG;IACH,IAAI,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IAIpC;;;;OAIG;IACH,YAAY,CAAC,OAAO,EAAE,eAAe,EAAE,KAAK,UAAO,GAAG,IAAI;IAc1D;;OAEG;IACH,SAAS,CAAC,YAAY,IAAI,IAAI;IAa9B,oBAAoB,EAAE,UAAU,GAAG,SAAS,CAAC;IAC7C;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IA6B1B;;OAEG;IACH,UAAU,IAAI,IAAI;IA+BlB;;;;;;;;OAQG;IACH,SAAS,CAAC,YAAY,IAAI,IAAI;IAY9B;;OAEG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAK/B;;;;;OAKG;IACH,SAAS,CAAC,aAAa,aAiCrB;IAGF,SAAS,CAAC,YAAY,UAAW,YAAY,UAsB3C;IAEF,SAAS,CAAC,UAAU,UAAW,UAAU,UAKvC;IAEF;;OAEG;IACH,SAAS,CAAC,uBAAuB,CAAC,gBAAgB,EAAE,wBAAwB,GAAG,IAAI;IAsBnF,SAAS,CAAC,gBAAgB;IAM1B,IAAI,uBAAuB,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAE7D;IAED,IAAI,gBAAgB,IAAI,wBAAwB,CAE/C;CACF;AAED,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAItE"}