fix: #16: types for commands API (#18)

* fix: #16: types for commands API

* fix: merged terminal and terminalInstance into one type

Author: fumblehool

src/api/evalCommand.ts

@@ -1,7 +1,7 @@
-import { Terminal } from '../types'
+import { TerminalInstance } from '../types'
 import { dispatchEvent, TerminalEvent } from '../helpers/events'
 
-const evalCommand = (cmd: string, instance: Terminal) => {
+const evalCommand = (cmd: string, instance: TerminalInstance) => {
   const { print } = instance
   const splitCommand = cmd.split(' ')
   const command = splitCommand[0]

src/api/init.ts

@@ -1,4 +1,4 @@
-import { Terminal, TerminalSettings } from '../types'
+import { TerminalInstance, TerminalSettings } from '../types'
 import buildTree from '../helpers/tree'
 import print from './print'
 import evalCommand from './evalCommand'
@@ -26,7 +26,7 @@ const initTerminal = ({
   }
   const { commandContainer, input, inputContainer } = buildTree(host, prompt)
 
-  const terminal: Terminal = {
+  const terminal: TerminalInstance = {
     history: [],
     lastHistoryIndex: 0,
     isProcessRunning: false,

src/api/process.ts

@@ -1,15 +1,15 @@
-import { Terminal } from '../types'
+import { TerminalInstance } from '../types'
 import { dispatchEvent, TerminalEvent } from '../helpers/events'
 import { toggleInput } from '../helpers/dom'
 
-export const startProcess = (terminal: Terminal) => {
+export const startProcess = (terminal: TerminalInstance) => {
   const { settings: { host } } = terminal
   toggleInput(terminal)
   terminal.isProcessRunning = true
   dispatchEvent(TerminalEvent.ON_PROCESS_START, host)
 }
 
-export const stopProcess = (terminal: Terminal) => {
+export const stopProcess = (terminal: TerminalInstance) => {
   const { input, settings: { host } } = terminal
   toggleInput(terminal, true)
   terminal.isProcessRunning = false

src/api/typeText.ts

@@ -1,8 +1,8 @@
-import { Terminal } from '../types'
+import { TerminalInstance } from '../types'
 import { startProcess, stopProcess } from './process'
 import { create } from '../helpers/dom'
 
-const typeText = (text: string, speed: number, terminal: Terminal, callback?: () => void) => {
+const typeText = (text: string, speed: number, terminal: TerminalInstance, callback?: () => void) => {
   startProcess(terminal)
   const line = create('p')
   terminal.commandContainer.append(line)

src/helpers/dom.ts

@@ -1,4 +1,4 @@
-import { Terminal } from '../types'
+import { TerminalInstance } from '../types'
 
 export const create = (tagName: string, className?: string, content?: string) => {
   const element = document.createElement(tagName)
@@ -7,7 +7,7 @@ export const create = (tagName: string, className?: string, content?: string) =>
   return element
 }
 
-export const toggleInput = (terminal: Terminal, enable = false) => {
+export const toggleInput = (terminal: TerminalInstance, enable = false) => {
   // Has to be done in order to preserve the focus on terminal click when disabled
   terminal.input.readOnly = !enable
   terminal.inputContainer.style.opacity = enable ? '' : '0'

src/helpers/help.ts

@@ -1,6 +1,6 @@
-import { Terminal, TerminalCommand } from '../types'
+import { TerminalInstance, TerminalCommand } from '../types'
 
-const createHelp = (terminal: Terminal): TerminalCommand => ({
+const createHelp = (terminal: TerminalInstance): TerminalCommand => ({
   name: 'help',
   description: 'shows a full list of all available commands',
   func: ({ print }) => {

src/helpers/history.ts

@@ -1,6 +1,6 @@
-import { Terminal } from '../types'
+import { TerminalInstance } from '../types'
 
-export const populateHistory = (instance: Terminal) => {
+export const populateHistory = (instance: TerminalInstance) => {
   const { input: { value }, history, settings: { historyLength } } = instance
   if (value === history[0]) {
     return
@@ -13,7 +13,7 @@ export const populateHistory = (instance: Terminal) => {
   instance.lastHistoryIndex = 0
 }
 
-export const searchHistory = (instance: Terminal, isDown?: boolean) => {
+export const searchHistory = (instance: TerminalInstance, isDown?: boolean) => {
   const { history, lastHistoryIndex } = instance
   const endOfHistory = history.length - 1
   let newIndex: number

src/helpers/keyboard.ts

@@ -1,10 +1,10 @@
-import { Terminal } from '../types'
+import { TerminalInstance } from '../types'
 import evalCommand from '../api/evalCommand'
 import { populateHistory, searchHistory } from './history'
 import { stopProcess } from '../api/process'
 import { dispatchEvent, TerminalEvent } from './events'
 
-export const attachKeyboardListener = (host: HTMLElement, instance: Terminal) => {
+export const attachKeyboardListener = (host: HTMLElement, instance: TerminalInstance) => {
   const { input, print } = instance
   host.addEventListener('keyup', ({ key, ctrlKey }) => {
     if (ctrlKey && key === 'c' && instance.isProcessRunning) {

src/types/index.ts

@@ -1,32 +1,3 @@
-export type TerminalInstance = {
-  print: (text: string, isCommand?: boolean) => void
-  run: (cmd: string) => void
-  start: () => void
-  stop: () => void
-  type: (text: string, speed?: number, callback?: () => void) => void
-  isProcessRunning: boolean
-}
-export type TerminalCommand = {
-  name: string
-  description: string
-  argDescriptions?: string[]
-  func: (terminal: TerminalInstance, ...args: string[]) => void
-}
-
-export type TerminalSettings = {
-  host: HTMLElement,
-  commands: Record<string, TerminalCommand>
-  welcomeMessage?: string,
-  prompt?: string
-  historyLength?: number
-  enableHelp?: boolean
-}
-
-export type Terminal = {
-  settings: TerminalSettings
-  commandContainer: HTMLElement
-  inputContainer: HTMLElement
-  input: HTMLInputElement
-  history: string[]
-  lastHistoryIndex: number
-} & TerminalInstance
+export * from './terminal'
+export * from './terminalCommand'
+export * from './terminalSettings'

src/types/terminal.ts

@@ -0,0 +1,16 @@
+import { TerminalSettings } from './terminalSettings'
+
+export type TerminalInstance = {
+  settings: TerminalSettings
+  commandContainer: HTMLElement
+  inputContainer: HTMLElement
+  input: HTMLInputElement
+  history: string[]
+  lastHistoryIndex: number
+  print: (text: string, isCommand?: boolean) => void
+  run: (cmd: string) => void
+  start: () => void
+  stop: () => void
+  type: (text: string, speed?: number, callback?: () => void) => void
+  isProcessRunning: boolean
+}

src/types/terminalCommand.ts

@@ -0,0 +1,8 @@
+import { TerminalInstance } from './terminal'
+
+export type TerminalCommand = {
+  name: string
+  description: string
+  argDescriptions?: string[]
+  func: (terminal: TerminalInstance, ...args: string[]) => void
+}

src/types/terminalInstance.ts

@@ -0,0 +1,10 @@
+import { TerminalCommand } from './terminalCommand'
+
+export type TerminalSettings = {
+  host: HTMLElement,
+  commands: Record<string, TerminalCommand>
+  welcomeMessage?: string,
+  prompt?: string
+  historyLength?: number
+  enableHelp?: boolean
+}