@difizen/libro-terminal 0.1.0 → 0.1.2

package/es/view.d.ts

@@ -1,17 +1,18 @@
 /// <reference types="react" resolution-mode="require"/>
-import { BaseView, DisposableCollection, Emitter } from '@difizen/mana-app';
-import type { RendererType } from 'xterm';
+import { Disposable, DisposableCollection, Emitter } from '@difizen/mana-app';
+import type { ITerminalOptions } from 'xterm';
 import { Terminal } from 'xterm';
 import { FitAddon } from 'xterm-addon-fit';
 import type { CursorStyle, TerminalRendererType } from './configuration.js';
 import { TerminalConfiguration } from './configuration.js';
 import type { TerminalConnection } from './connection.js';
 import { TerminalManager } from './manager.js';
-import type { TerminalMessage } from './protocol.js';
-import { TerminalViewOption } from './protocol.js';
+import type { TerminalMessage, TerminalViewOption } from './protocol.js';
+import 'xterm/css/xterm.css';
+import { BaseStatefulView } from './stateful-view.js';
 import { TerminalThemeService } from './theme-service.js';
 export declare const TerminalComponent: import("react").ForwardRefExoticComponent<import("react").RefAttributes<HTMLDivElement>>;
-export declare class LibroTerminalView extends BaseView {
+export declare class LibroTerminalView extends BaseStatefulView {
     protected term: Terminal;
     view: import("react").ForwardRefExoticComponent<import("react").RefAttributes<HTMLDivElement>>;
     protected options: TerminalViewOption;
@@ -22,38 +23,39 @@ export declare class LibroTerminalView extends BaseView {
     protected readonly themeService: TerminalThemeService;
     protected readonly terminalManager: TerminalManager;
     protected readonly toDisposeOnConnect: DisposableCollection;
-    protected readonly onDidOpenEmitter: Emitter<void>;
-    readonly onDidOpen: import("@difizen/mana-app").Event<void>;
-    protected readonly onDidOpenFailureEmitter: Emitter<void>;
-    readonly onDidOpenFailure: import("@difizen/mana-app").Event<void>;
+    protected readonly onDidOpenEmitter: Emitter<boolean>;
+    readonly onDidOpen: import("@difizen/mana-app").Event<boolean>;
+    protected readonly onDidOpenFailureEmitter: Emitter<unknown>;
     protected readonly onSizeChangedEmitter: Emitter<{
         cols: number;
         rows: number;
     }>;
-    readonly onSizeChanged: import("@difizen/mana-app").Event<{
-        cols: number;
-        rows: number;
-    }>;
     protected readonly onDataEmitter: Emitter<string>;
-    readonly onData: import("@difizen/mana-app").Event<string>;
     protected readonly onKeyEmitter: Emitter<{
         key: string;
         domEvent: KeyboardEvent;
     }>;
-    readonly onKey: import("@difizen/mana-app").Event<{
-        key: string;
-        domEvent: KeyboardEvent;
-    }>;
     protected readonly onDidCloseEmitter: Emitter<LibroTerminalView>;
-    readonly onDidClose: import("@difizen/mana-app").Event<LibroTerminalView>;
+    protected readonly onTitleChangeEmitter: Emitter<string>;
     protected connection?: TerminalConnection;
-    constructor(options: TerminalViewOption);
-    protected createConnection: () => Promise<void>;
+    protected restoreObj?: object;
+    protected _isReady: boolean;
+    protected onReadyEmitter: Emitter<boolean>;
+    constructor(options: TerminalViewOption, // 这里是 server需要的配置
+    config: TerminalConfiguration, themeService: TerminalThemeService, terminalManager: TerminalManager);
+    afterRestore(): void;
+    initConnection(): Promise<TerminalConnection>;
+    storeState(): object;
+    restoreState(oldState: object): void;
+    dispose(): void;
+    protected createConnection: () => Promise<TerminalConnection>;
     /**
      * Handle a message from the terminal session.
      */
-    protected onMessage(msg: TerminalMessage): void;
-    protected initialConnection(): void;
+    protected onMessage: (msg: TerminalMessage) => void;
+    protected initOnceAfterConnected(dispose: Disposable): void;
+    protected initialCommand: () => void;
+    protected initialTitle(): void;
     protected createTerm: () => void;
     protected get enableCopy(): boolean;
     protected get enablePaste(): boolean;
@@ -69,10 +71,59 @@ export declare class LibroTerminalView extends BaseView {
      *
      * @param terminalRendererType desired terminal renderer type
      */
-    protected getTerminalRendererType: (terminalRendererType?: string | TerminalRendererType) => RendererType;
+    protected getTerminalRendererType: (terminalRendererType?: string | TerminalRendererType) => TerminalRendererType;
+    onViewMount(): void;
+    onViewUnmount(): void;
+    /**
+     * Refresh the terminal session.
+     *
+     * #### Notes
+     * Failure to reconnect to the session should be caught appropriately
+     */
+    refresh: () => Promise<void>;
     protected resizeTerminal: () => void;
+    /**
+     * Set the size of the terminal in the session.
+     */
+    protected setSessionSize(): void;
     onViewResize: () => void;
+    protected processResize: () => void;
     protected open: () => void;
+    protected hasWebGLContext(): boolean;
+    /**
+     * Create a xterm.js terminal
+     */
+    protected createTerminal(options: ITerminalOptions): [Terminal, FitAddon];
+    protected addRenderer(term: Terminal): void;
+    readonly onDidOpenFailure: import("@difizen/mana-app").Event<unknown>;
+    readonly onSizeChanged: import("@difizen/mana-app").Event<{
+        cols: number;
+        rows: number;
+    }>;
+    readonly onData: import("@difizen/mana-app").Event<string>;
+    readonly onKey: import("@difizen/mana-app").Event<{
+        key: string;
+        domEvent: KeyboardEvent;
+    }>;
+    readonly onDidClose: import("@difizen/mana-app").Event<LibroTerminalView>;
+    readonly onTitleChange: import("@difizen/mana-app").Event<string>;
+    /**
+     * Terminal is ready event
+     */
+    get name(): string;
+    onReady: import("@difizen/mana-app").Event<boolean>;
+    /**
+     * Check if terminal has any text selected.
+     */
+    hasSelection(): boolean;
+    /**
+     * Paste text into terminal.
+     */
+    paste(data: string): void;
+    /**
+     * Get selected text from terminal.
+     */
+    getSelection(): string | null;
     scrollLineUp: () => void;
     scrollLineDown: () => void;
     scrollToTop: () => void;
@@ -80,6 +131,7 @@ export declare class LibroTerminalView extends BaseView {
     scrollPageUp: () => void;
     scrollPageDown: () => void;
     resetTerminal: () => void;
-    writeLine: (text: string) => void;
+    writeLine: (data: string) => void;
+    write: (data: string | Uint8Array) => void;
 }
 //# sourceMappingURL=view.d.ts.map

package/es/view.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../src/view.tsx"],"names":[],"mappings":";AAEA,OAAO,EACL,QAAQ,EAOR,oBAAoB,EACpB,OAAO,EACR,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C,OAAO,KAAK,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAK5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE1D,eAAO,MAAM,iBAAiB,0FAU5B,CAAC;AAEH,qBAEa,iBAAkB,SAAQ,QAAQ;IAC7C,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC;IAChB,IAAI,2FAAqB;IAClC,SAAS,CAAC,OAAO,EAAE,kBAAkB,CAAC;IACtC,SAAS,CAAC,UAAU,UAAS;IAC7B,SAAS,CAAC,WAAW,SAAM;IAC3B,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE7B,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC;IAEjD,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,oBAAoB,CAAC;IAEtD,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;IAEpD,SAAS,CAAC,QAAQ,CAAC,kBAAkB,uBAA8B;IAEnE,SAAS,CAAC,QAAQ,CAAC,gBAAgB,gBAAuB;IAC1D,QAAQ,CAAC,SAAS,0CAA+B;IAEjD,SAAS,CAAC,QAAQ,CAAC,uBAAuB,gBAAuB;IACjE,QAAQ,CAAC,gBAAgB,0CAAsC;IAE/D,SAAS,CAAC,QAAQ,CAAC,oBAAoB;cAC/B,MAAM;cACN,MAAM;OACT;IACL,QAAQ,CAAC,aAAa;cAHd,MAAM;cACN,MAAM;OAE2C;IAEzD,SAAS,CAAC,QAAQ,CAAC,aAAa,kBAAyB;IACzD,QAAQ,CAAC,MAAM,4CAA4B;IAE3C,SAAS,CAAC,QAAQ,CAAC,YAAY;aACxB,MAAM;kBACD,aAAa;OACpB;IACL,QAAQ,CAAC,KAAK;aAHP,MAAM;kBACD,aAAa;OAEgB;IACzC,SAAS,CAAC,QAAQ,CAAC,iBAAiB,6BAAoC;IACxE,QAAQ,CAAC,UAAU,uDAAgC;IAEnD,SAAS,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAC;gBAEF,OAAO,EAAE,kBAAkB;IAoDnE,SAAS,CAAC,gBAAgB,sBASxB;IAEF;;OAEG;IACH,SAAS,CAAC,SAAS,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI;IAe/C,SAAS,CAAC,iBAAiB;IAgB3B,SAAS,CAAC,UAAU,aA4BlB;IACF,SAAS,KAAK,UAAU,IAAI,OAAO,CAElC;IAED,SAAS,KAAK,WAAW,IAAI,OAAO,CAEnC;IACD,SAAS,KAAK,eAAe,IAAI,OAAO,CAEvC;IAED,SAAS,CAAC,gBAAgB,UAAW,aAAa,KAAG,OAAO,CAa1D;IACF;;;OAGG;IACH,SAAS,CAAC,cAAc,QAAO,WAAW,CAGxC;IACF;;;;OAIG;IACH,SAAS,CAAC,uBAAuB,0BACR,MAAM,GAAG,oBAAoB,KACnD,YAAY,CAKb;IAEF,SAAS,CAAC,cAAc,QAAO,IAAI,CAKjC;IAEO,YAAY,QAAO,IAAI,CAM9B;IAEF,SAAS,CAAC,IAAI,QAAO,IAAI,CAoBvB;IAEF,YAAY,QAAO,IAAI,CAErB;IAEF,cAAc,QAAO,IAAI,CAEvB;IAEF,WAAW,QAAO,IAAI,CAEpB;IAEF,cAAc,QAAO,IAAI,CAEvB;IAEF,YAAY,QAAO,IAAI,CAErB;IAEF,cAAc,QAAO,IAAI,CAEvB;IAEF,aAAa,QAAO,IAAI,CAEtB;IAEF,SAAS,SAAU,MAAM,KAAG,IAAI,CAE9B;CACH"}
+{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../src/view.tsx"],"names":[],"mappings":";AACA,OAAO,EACL,UAAU,EACV,oBAAoB,EACpB,OAAO,EAUR,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,OAAO,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEjC,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAI3C,OAAO,KAAK,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAEL,qBAAqB,EAEtB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACzE,OAAO,qBAAqB,CAAC;AAC7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE1D,eAAO,MAAM,iBAAiB,0FAc5B,CAAC;AAEH,qBAEa,iBAAkB,SAAQ,gBAAgB;IACrD,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC;IAChB,IAAI,2FAAqB;IAClC,SAAS,CAAC,OAAO,EAAE,kBAAkB,CAAC;IACtC,SAAS,CAAC,UAAU,UAAS;IAC7B,SAAS,CAAC,WAAW,SAAM;IAC3B,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC7B,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC;IACjD,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,oBAAoB,CAAC;IACtD,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;IAEpD,SAAS,CAAC,QAAQ,CAAC,kBAAkB,uBAA8B;IAEnE,SAAS,CAAC,QAAQ,CAAC,gBAAgB,mBAA0B;IAC7D,QAAQ,CAAC,SAAS,6CAA+B;IAEjD,SAAS,CAAC,QAAQ,CAAC,uBAAuB,mBAA0B;IAEpE,SAAS,CAAC,QAAQ,CAAC,oBAAoB;cAC/B,MAAM;cACN,MAAM;OACT;IAEL,SAAS,CAAC,QAAQ,CAAC,aAAa,kBAAyB;IAEzD,SAAS,CAAC,QAAQ,CAAC,YAAY;aACxB,MAAM;kBACD,aAAa;OACpB;IAEL,SAAS,CAAC,QAAQ,CAAC,iBAAiB,6BAAoC;IAExE,SAAS,CAAC,QAAQ,CAAC,oBAAoB,kBAAyB;IAEhE,SAAS,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAE1C,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE9B,SAAS,CAAC,QAAQ,UAAS;IAE3B,SAAS,CAAC,cAAc,mBAA0B;gBAG5B,OAAO,EAAE,kBAAkB,EAAE,kBAAkB;IACpC,MAAM,EAAE,qBAAqB,EAC9B,YAAY,EAAE,oBAAoB,EACvC,eAAe,EAAE,eAAe;IAsGlD,YAAY;IAmBf,cAAc;IAWpB,UAAU,IAAI,MAAM;IAIpB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAO3B,OAAO,IAAI,IAAI;IASxB,SAAS,CAAC,gBAAgB,oCAGxB;IAEF;;OAEG;IACH,SAAS,CAAC,SAAS,QAAS,eAAe,UAazC;IAEF,SAAS,CAAC,sBAAsB,CAAC,OAAO,EAAE,UAAU;IAkBpD,SAAS,CAAC,cAAc,aAOtB;IAGF,SAAS,CAAC,YAAY;IAStB,SAAS,CAAC,UAAU,aA2BlB;IAEF,SAAS,KAAK,UAAU,IAAI,OAAO,CAElC;IAED,SAAS,KAAK,WAAW,IAAI,OAAO,CAEnC;IAED,SAAS,KAAK,eAAe,IAAI,OAAO,CAEvC;IAED,SAAS,CAAC,gBAAgB,UAAW,aAAa,KAAG,OAAO,CAe1D;IACF;;;OAGG;IACH,SAAS,CAAC,cAAc,QAAO,WAAW,CAGxC;IACF;;;;OAIG;IACH,SAAS,CAAC,uBAAuB,0BACR,MAAM,GAAG,oBAAoB,KACnD,oBAAoB,CAKrB;IAEO,WAAW,IAAI,IAAI;IAInB,aAAa,IAAI,IAAI;IAI9B;;;;;OAKG;IACI,OAAO,QAAa,QAAQ,IAAI,CAAC,CAKtC;IAEF,SAAS,CAAC,cAAc,QAAO,IAAI,CAEjC;IAEF;;OAEG;IACH,SAAS,CAAC,cAAc,IAAI,IAAI;IAcvB,YAAY,QAAO,IAAI,CAU9B;IAEF,SAAS,CAAC,aAAa,aAIrB;IAEF,SAAS,CAAC,IAAI,QAAO,IAAI,CA2BvB;IAEF,SAAS,CAAC,eAAe,IAAI,OAAO;IAiBpC;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,gBAAgB,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC;IASzE,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IAc3C,SAAgB,gBAAgB,6CAAsC;IACtE,SAAgB,aAAa;cAncrB,MAAM;cACN,MAAM;OAkckD;IAChE,SAAgB,MAAM,4CAA4B;IAClD,SAAgB,KAAK;aA9bd,MAAM;kBACD,aAAa;OA6buB;IAChD,SAAgB,UAAU,uDAAgC;IAC1D,SAAgB,aAAa,4CAAmC;IAChE;;OAEG;IACH,IAAW,IAAI,WAEd;IAEM,OAAO,6CAA6B;IAE3C;;OAEG;IACI,YAAY,IAAI,OAAO;IAO9B;;OAEG;IACI,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAMhC;;OAEG;IACI,YAAY,IAAI,MAAM,GAAG,IAAI;IAO7B,YAAY,QAAO,IAAI,CAE5B;IAEK,cAAc,QAAO,IAAI,CAE9B;IAEK,WAAW,QAAO,IAAI,CAE3B;IAEK,cAAc,QAAO,IAAI,CAE9B;IAEK,YAAY,QAAO,IAAI,CAE5B;IAEK,cAAc,QAAO,IAAI,CAE9B;IAEK,aAAa,QAAO,IAAI,CAE7B;IAEK,SAAS,SAAU,MAAM,KAAG,IAAI,CAErC;IAEK,KAAK,SAAU,MAAM,GAAG,UAAU,KAAG,IAAI,CAE9C;CACH"}