Introduce the public module

demo/main.js

@@ -170,7 +170,7 @@ function initOptions(term) {
     fontWeight: ['normal', 'bold', '100', '200', '300', '400', '500', '600', '700', '800', '900'],
     fontWeightBold: ['normal', 'bold', '100', '200', '300', '400', '500', '600', '700', '800', '900']
   };
-  var options = Object.keys(term.options);
+  var options = Object.keys(term._core.options);
   var booleanOptions = [];
   var numberOptions = [];
   options.filter(o => blacklistedOptions.indexOf(o) === -1).forEach(o => {
@@ -241,8 +241,8 @@ function initOptions(term) {
 function updateTerminalSize() {
   var cols = parseInt(document.getElementById(`opt-cols`).value, 10);
   var rows = parseInt(document.getElementById(`opt-rows`).value, 10);
-  var width = (cols * term.renderer.dimensions.actualCellWidth + term.viewport.scrollBarWidth).toString() + 'px';
-  var height = (rows * term.renderer.dimensions.actualCellHeight).toString() + 'px';
+  var width = (cols * term._core.renderer.dimensions.actualCellWidth + term._core.viewport.scrollBarWidth).toString() + 'px';
+  var height = (rows * term._core.renderer.dimensions.actualCellHeight).toString() + 'px';
   terminalContainer.style.width = width;
   terminalContainer.style.height = height;
   term.fit();

package.json

@@ -2,7 +2,7 @@
   "name": "xterm",
   "description": "Full xterm terminal, in your browser",
   "version": "3.4.0",
-  "main": "lib/Terminal.js",
+  "main": "lib/public/Terminal.js",
   "types": "typings/xterm.d.ts",
   "repository": "https://github.com/xtermjs/xterm.js",
   "license": "MIT",

src/Terminal.ts

@@ -751,9 +751,9 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
    * Apply the provided addon on the `Terminal` class.
    * @param addon The addon to apply.
    */
-  public static applyAddon(addon: any): void {
-    addon.apply(Terminal);
-  }
+  // public static applyAddon(addon: any): void {
+  //   addon.apply(Terminal);
+  // }
 
   /**
    * XTerm mouse events

src/addons/fit/fit.ts

@@ -37,10 +37,10 @@ export function proposeGeometry(term: Terminal): IGeometry {
   const elementPaddingVer = elementPadding.top + elementPadding.bottom;
   const elementPaddingHor = elementPadding.right + elementPadding.left;
   const availableHeight = parentElementHeight - elementPaddingVer;
-  const availableWidth = parentElementWidth - elementPaddingHor - (<any>term).viewport.scrollBarWidth;
+  const availableWidth = parentElementWidth - elementPaddingHor - (<any>term)._core.viewport.scrollBarWidth;
   const geometry = {
-    cols: Math.floor(availableWidth / (<any>term).renderer.dimensions.actualCellWidth),
-    rows: Math.floor(availableHeight / (<any>term).renderer.dimensions.actualCellHeight)
+    cols: Math.floor(availableWidth / (<any>term)._core.renderer.dimensions.actualCellWidth),
+    rows: Math.floor(availableHeight / (<any>term)._core.renderer.dimensions.actualCellHeight)
   };
   return geometry;
 }
@@ -50,7 +50,7 @@ export function fit(term: Terminal): void {
   if (geometry) {
     // Force a full render
     if (term.rows !== geometry.rows || term.cols !== geometry.cols) {
-      (<any>term).renderer.clear();
+      (<any>term)._core.renderer.clear();
       term.resize(geometry.cols, geometry.rows);
     }
   }

src/addons/search/Interfaces.ts

@@ -5,14 +5,17 @@
 
 import { Terminal } from 'xterm';
 
-export interface ISearchAddonTerminal extends Terminal {
-  __searchHelper?: ISearchHelper;
-
-  // TODO: Reuse ITerminal from core
+// TODO: Don't rely on this private API
+export interface ITerminalCore {
   buffer: any;
   selectionManager: any;
 }
 
+export interface ISearchAddonTerminal extends Terminal {
+  __searchHelper?: ISearchHelper;
+  _core: ITerminalCore;
+}
+
 export interface ISearchHelper {
   findNext(term: string): boolean;
   findPrevious(term: string): boolean;

src/addons/search/SearchHelper.ts

@@ -35,14 +35,14 @@ export class SearchHelper implements ISearchHelper {
 
     let result: ISearchResult;
 
-    let startRow = this._terminal.buffer.ydisp;
-    if (this._terminal.selectionManager.selectionEnd) {
+    let startRow = this._terminal._core.buffer.ydisp;
+    if (this._terminal._core.selectionManager.selectionEnd) {
       // Start from the selection end if there is a selection
-      startRow = this._terminal.selectionManager.selectionEnd[1];
+      startRow = this._terminal._core.selectionManager.selectionEnd[1];
     }
 
     // Search from ydisp + 1 to end
-    for (let y = startRow + 1; y < this._terminal.buffer.ybase + this._terminal.rows; y++) {
+    for (let y = startRow + 1; y < this._terminal._core.buffer.ybase + this._terminal.rows; y++) {
       result = this._findInLine(term, y);
       if (result) {
         break;
@@ -76,10 +76,10 @@ export class SearchHelper implements ISearchHelper {
 
     let result: ISearchResult;
 
-    let startRow = this._terminal.buffer.ydisp;
-    if (this._terminal.selectionManager.selectionStart) {
+    let startRow = this._terminal._core.buffer.ydisp;
+    if (this._terminal._core.selectionManager.selectionStart) {
       // Start from the selection end if there is a selection
-      startRow = this._terminal.selectionManager.selectionStart[1];
+      startRow = this._terminal._core.selectionManager.selectionStart[1];
     }
 
     // Search from ydisp + 1 to end
@@ -92,7 +92,7 @@ export class SearchHelper implements ISearchHelper {
 
     // Search from the top to the current ydisp
     if (!result) {
-      for (let y = this._terminal.buffer.ybase + this._terminal.rows - 1; y > startRow; y--) {
+      for (let y = this._terminal._core.buffer.ybase + this._terminal.rows - 1; y > startRow; y--) {
         result = this._findInLine(term, y);
         if (result) {
           break;
@@ -111,11 +111,11 @@ export class SearchHelper implements ISearchHelper {
    * @return The search result if it was found.
    */
   private _findInLine(term: string, y: number): ISearchResult {
-    const lowerStringLine = this._terminal.buffer.translateBufferLineToString(y, true).toLowerCase();
+    const lowerStringLine = this._terminal._core.buffer.translateBufferLineToString(y, true).toLowerCase();
     const lowerTerm = term.toLowerCase();
     let searchIndex = lowerStringLine.indexOf(lowerTerm);
     if (searchIndex >= 0) {
-      const line = this._terminal.buffer.lines.get(y);
+      const line = this._terminal._core.buffer.lines.get(y);
       for (let i = 0; i < searchIndex; i++) {
         const charData = line[i];
         // Adjust the searchIndex to normalize emoji into single chars
@@ -147,8 +147,8 @@ export class SearchHelper implements ISearchHelper {
     if (!result) {
       return false;
     }
-    this._terminal.selectionManager.setSelection(result.col, result.row, result.term.length);
-    this._terminal.scrollLines(result.row - this._terminal.buffer.ydisp);
+    this._terminal._core.selectionManager.setSelection(result.col, result.row, result.term.length);
+    this._terminal.scrollLines(result.row - this._terminal._core.buffer.ydisp);
     return true;
   }
 }

src/addons/winptyCompat/Interfaces.ts

@@ -5,6 +5,10 @@
 
 import { Terminal } from 'xterm';
 
-export interface IWinptyCompatAddonTerminal extends Terminal {
+export interface ITerminalCore {
   buffer: any;
 }
+
+export interface IWinptyCompatAddonTerminal extends Terminal {
+  _core: ITerminalCore;
+}

src/public/Terminal.ts

@@ -0,0 +1,139 @@
+import { Terminal as ITerminalApi, ITerminalOptions, IMarker, IDisposable, ILinkMatcherOptions, ITheme } from 'xterm';
+import { ITerminal } from '../Types';
+import { Terminal as TerminalCore } from '../Terminal';
+
+export class Terminal implements ITerminalApi {
+  private _core: ITerminal;
+
+  constructor(options?: ITerminalOptions) {
+    this._core = new TerminalCore(options);
+  }
+
+  public get element(): HTMLElement { return this._core.element; }
+  public get textarea(): HTMLTextAreaElement { return this._core.textarea; }
+  public get rows(): number { return this._core.rows; }
+  public get cols(): number { return this._core.cols; }
+  public get markers(): IMarker[] { return this._core.markers; }
+  public blur(): void {
+    this._core.blur();
+  }
+  public focus(): void {
+    this._core.focus();
+  }
+  public on(type: 'blur' | 'focus' | 'linefeed' | 'selection', listener: () => void): void;
+  public on(type: 'data', listener: (...args: any[]) => void): void;
+  public on(type: 'key', listener: (key?: string, event?: KeyboardEvent) => void): void;
+  public on(type: 'keypress' | 'keydown', listener: (event?: KeyboardEvent) => void): void;
+  public on(type: 'refresh', listener: (data?: { start: number; end: number; }) => void): void;
+  public on(type: 'resize', listener: (data?: { cols: number; rows: number; }) => void): void;
+  public on(type: 'scroll', listener: (ydisp?: number) => void): void;
+  public on(type: 'title', listener: (title?: string) => void): void;
+  public on(type: string, listener: (...args: any[]) => void): void;
+  public on(type: any, listener: any): void {
+    this._core.on(type, listener);
+  }
+  public off(type: string, listener: (...args: any[]) => void): void {
+    this._core.off(type, listener);
+  }
+  public emit(type: string, data?: any): void {
+    this._core.emit(type, data);
+  }
+  public addDisposableListener(type: string, handler: (...args: any[]) => void): IDisposable {
+    return this.addDisposableListener(type, handler);
+  }
+  public resize(columns: number, rows: number): void {
+    this._core.resize(columns, rows);
+  }
+  public writeln(data: string): void {
+    this._core.writeln(data);
+  }
+  public open(parent: HTMLElement): void {
+    this._core.open(parent);
+  }
+  public attachCustomKeyEventHandler(customKeyEventHandler: (event: KeyboardEvent) => boolean): void {
+    this._core.attachCustomKeyEventHandler(customKeyEventHandler);
+  }
+  public registerLinkMatcher(regex: RegExp, handler: (event: MouseEvent, uri: string) => void, options?: ILinkMatcherOptions): number {
+    return this._core.registerLinkMatcher(regex, handler, options);
+  }
+  public deregisterLinkMatcher(matcherId: number): void {
+    this._core.deregisterLinkMatcher(matcherId);
+  }
+  public addMarker(cursorYOffset: number): IMarker {
+    return this._core.addMarker(cursorYOffset);
+  }
+  public hasSelection(): boolean {
+    return this._core.hasSelection();
+  }
+  public getSelection(): string {
+    return this._core.getSelection();
+  }
+  public clearSelection(): void {
+    this._core.clearSelection();
+  }
+  public selectAll(): void {
+    this._core.selectAll();
+  }
+  public selectLines(start: number, end: number): void {
+    this._core.selectLines(start, end);
+  }
+  public dispose(): void {
+    this._core.dispose();
+  }
+  public destroy(): void {
+    this._core.destroy();
+  }
+  public scrollLines(amount: number): void {
+    this._core.scrollLines(amount);
+  }
+  public scrollPages(pageCount: number): void {
+    this._core.scrollPages(pageCount);
+  }
+  public scrollToTop(): void {
+    this._core.scrollToTop();
+  }
+  public scrollToBottom(): void {
+    this._core.scrollToBottom();
+  }
+  public scrollToLine(line: number): void {
+    this._core.scrollToLine(line);
+  }
+  public clear(): void {
+    this._core.clear();
+  }
+  public write(data: string): void {
+    this._core.write(data);
+  }
+  public getOption(key: 'bellSound' | 'bellStyle' | 'cursorStyle' | 'fontFamily' | 'fontWeight' | 'fontWeightBold' | 'rendererType' | 'termName'): string;
+  public getOption(key: 'allowTransparency' | 'cancelEvents' | 'convertEol' | 'cursorBlink' | 'debug' | 'disableStdin' | 'enableBold' | 'macOptionIsMeta' | 'rightClickSelectsWord' | 'popOnBell' | 'screenKeys' | 'useFlowControl' | 'visualBell'): boolean;
+  public getOption(key: 'colors'): string[];
+  public getOption(key: 'cols' | 'fontSize' | 'letterSpacing' | 'lineHeight' | 'rows' | 'tabStopWidth' | 'scrollback'): number;
+  public getOption(key: 'handler'): (data: string) => void;
+  public getOption(key: string): any;
+  public getOption(key: any): any {
+    return this._core.getOption(key);
+  }
+  public setOption(key: 'bellSound' | 'fontFamily' | 'termName', value: string): void;
+  public setOption(key: 'fontWeight' | 'fontWeightBold', value: 'normal' | 'bold' | '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900'): void;
+  public setOption(key: 'bellStyle', value: 'none' | 'visual' | 'sound' | 'both'): void;
+  public setOption(key: 'cursorStyle', value: 'block' | 'underline' | 'bar'): void;
+  public setOption(key: 'allowTransparency' | 'cancelEvents' | 'convertEol' | 'cursorBlink' | 'debug' | 'disableStdin' | 'enableBold' | 'macOptionIsMeta' | 'rightClickSelectsWord' | 'popOnBell' | 'screenKeys' | 'useFlowControl' | 'visualBell', value: boolean): void;
+  public setOption(key: 'colors', value: string[]): void;
+  public setOption(key: 'fontSize' | 'letterSpacing' | 'lineHeight' | 'tabStopWidth' | 'scrollback', value: number): void;
+  public setOption(key: 'handler', value: (data: string) => void): void;
+  public setOption(key: 'theme', value: ITheme): void;
+  public setOption(key: 'cols' | 'rows', value: number): void;
+  public setOption(key: string, value: any): void;
+  public setOption(key: any, value: any): void {
+    this._core.setOption(key, value);
+  }
+  public refresh(start: number, end: number): void {
+    this._core.refresh(start, end);
+  }
+  public reset(): void {
+    this._core.reset();
+  }
+  public static applyAddon(addon: any): void {
+    addon.apply(Terminal);
+  }
+}

src/xterm.ts

@@ -5,6 +5,6 @@
  * This file is the entry point for browserify.
  */
 
-import { Terminal } from './Terminal';
+import { Terminal } from './public/Terminal';
 
 module.exports = Terminal;