pear-terminal 2.0.0-rc.1 → 2.0.0

package/index.js

@@ -3,7 +3,6 @@ const readline = require('bare-readline')
 const tty = require('bare-tty')
 const fs = require('bare-fs')
 const os = require('bare-os')
-const Realm = require('bare-realm')
 const { Writable: BareWritable, Readable: BareReadable } = require('bare-stream')
 const { Writable, Readable } = require('streamx')
 const hypercoreid = require('hypercore-id-encoding')
@@ -150,21 +149,16 @@ const stdio = new (class Stdio {
 class Interact {
   static rx =
     /[\x1B\x9B][[\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\d/#&.:=?%@~_]+)*|[a-zA-Z\d]+(?:;[-a-zA-Z\d/#&.:=?%@~_]*)*)?\x07)|(?:(?:\d{1,4}(?:;\d{0,4})*)?[\dA-PR-TZcf-nq-uy=><~]))/g // eslint-disable-line no-control-regex
-
   constructor(header, params, opts = {}) {
     this._header = header
     this._params = params
     this._defaults = opts.defaults || {}
-    this._load =
-      opts.load ??
-      (() => {
-        throw new Error('provide a load function to load params strings')
-      })
 
     const mask = (data, cb) => {
       if (data.length > 4) {
-        const prompt = this._prompt
-        const regex = new RegExp(`(${prompt})([\\x20-\\x7E]+)`, 'g')
+        // is full line
+        const prompt = this._rl._prompt
+        const regex = new RegExp(`(${prompt})([\\x20-\\x7E]+)`, 'g') // match printable chars after prompt
         const masked = data
           .toString()
           .replace(regex, (_, prompt, pwd) => prompt + '*'.repeat(pwd.length))
@@ -180,117 +174,46 @@ class Interact {
       output: opts.masked ? new Writable({ write: mask }) : stdio.out
     })
     this._rl.on('close', () => {
-      console.log()
+      console.log() // newline
     })
     stdio.in?.setMode?.(tty.constants.MODE_RAW)
   }
 
-  run(opts) {
-    const out = new Readable()
-    this._run(opts, out)
-    return out
-  }
-
-  async _run(opts, out) {
+  async run(opts) {
     try {
-      if (opts?.autosubmit) {
-        const res = this.#autosubmit()
-        out.push({ type: 'autosubmit', value: res })
-        out.push(null)
-        return
-      }
-
-      stdio.out.write(this._header)
-      await this._loop(this._params, out, [], null)
-      out.push({ tag: 'final', data: { success: true } })
-      out.push(null)
-    } catch (err) {
-      out.destroy(err)
+      return await this.#run(opts)
     } finally {
       if (stdio.inAttached) stdio.in.destroy()
     }
   }
 
-  async _loop(params, out, trail, field) {
-    params = Array.isArray(params) ? params : [params]
-    while (params.length) {
-      const param = params.shift()
-      while (true) {
-        const done = await this._next(param, out, trail, field)
-        if (done) break
-      }
-    }
-  }
-
-  async _next(param, out, trail, field) {
+  async #run(opts = {}) {
+    if (opts.autosubmit) return this.#autosubmit()
+    stdio.out.write(this._header)
+    const fields = {}
+    const shave = {}
     const defaults = this._defaults
-    const deflt = defaults[param.name] ?? param.default
-    const selection = Array.isArray(param.select)
-
-    let answer = selection
-      ? await this.#select(param.prompt, param.select)
-      : typeof param.params === 'string'
-        ? ''
-        : await this.#input(`${param.prompt}${param.delim || ':'}${deflt && ' (' + deflt + ')'} `)
-
-    if (answer.length === 0) answer = defaults[param.name] ?? deflt
-
-    let choice = null
-    let tag = 'input'
-
-    if (selection) {
-      const ix = Number(answer) || 0
-      const selected = param.select[ix] ?? param.select[0]
-      choice = selected.prompt ?? selected.name ?? String(ix)
-      param.params = selected.params
-      answer = param.params
-      tag = 'select'
-    } else if (typeof param.params === 'string') {
-      answer = param.params
-    }
-
-    if (typeof param.validation === 'string') {
-      const realm = new Realm()
-      param.validation = realm.evaluate(param.validation)
-      realm.destroy()
-    }
-
-    if (param.validation && !(await param.validation(answer))) {
-      stdio.out.write(param.msg + '\n')
-      return false
-    }
-
-    if (typeof answer === 'string') answer = answer.replace(this.constructor.rx, '')
-
-    const base = param.name === field ? trail : trail.concat(param.name)
-    const isGroup = typeof param.params === 'string'
-
-    if (selection) {
-      const selected = base.concat(choice)
-      out.push({ tag, data: { trail: selected, name: choice, answer } })
-      if (isGroup) {
-        out.push({ tag: 'enter', data: { trail: selected, name: param.name, answer: answer } })
-        param.params = await this._load(param.params)
-        await this._loop(param.params, out, selected, choice)
-        out.push({ tag: 'exit', data: { trail: selected, name: param.name, answer: answer } })
+    while (this._params.length) {
+      const param = this._params.shift()
+      while (true) {
+        const deflt = defaults[param.name] ?? param.default
+        let answer = await this.#input(
+          `${param.prompt}${param.delim || ':'}${deflt && ' (' + deflt + ')'} `
+        )
+        if (answer.length === 0) answer = defaults[param.name] ?? deflt
+        if (!param.validation || (await param.validation(answer))) {
+          if (typeof answer === 'string') answer = answer.replace(this.constructor.rx, '')
+          fields[param.name] = answer
+          if (Array.isArray(param.shave) && param.shave.every((ix) => typeof ix === 'number')) {
+            shave[param.name] = param.shave
+          }
+          break
+        } else {
+          stdio.out.write(param.msg + '\n')
+        }
       }
-      return true
-    }
-
-    if (isGroup) {
-      out.push({ tag: 'enter', data: { trail: base, name: param.name, answer } })
-      param.params = await this._load(param.params)
-      await this._loop(param.params, out, base, param.name)
-      out.push({ tag: 'exit', data: { trail: base, name: param.name, answer } })
-      return true
     }
-
-    const shave =
-      Array.isArray(param.shave) && param.shave.every((ix) => typeof ix === 'number')
-        ? param.shave
-        : undefined
-    out.push({ tag, data: { trail: base, name: param.name, answer, shave } })
-    return true
+    return { fields, shave }
   }
 
   #autosubmit() {
@@ -307,19 +230,13 @@ class Interact {
     return { fields, shave }
   }
 
-  async #select(prompt, select) {
-    return (
-      (await this.#input(
-        prompt + ' [' + select.map(({ prompt }, index) => index + ':' + prompt).join(' ') + ']\n> '
-      )) || '0'
-    )
-  }
-
   async #input(prompt) {
     stdio.out.write(prompt)
-    this._prompt = prompt
+    this._rl._prompt = prompt
     const answer = await new Promise((resolve, reject) => {
-      this._rl.once('data', (data) => resolve(data))
+      this._rl.once('data', (data) => {
+        resolve(data)
+      })
       stdio.in?.once('data', (data) => {
         if (data.length === 1 && data[0] === 3) {
           reject(ERR_SIGINT('^C exit'))
@@ -327,7 +244,7 @@ class Interact {
         }
       })
     })
-    return answer.toString().trim()
+    return answer.toString().trim() // remove return char
   }
 }
 
@@ -359,7 +276,13 @@ function indicator(value, type = 'success') {
   if (type === 'diff') {
     return value === 0 ? ansi.yellow('~') : value === 1 ? ansi.green('+') : ansi.red('-')
   }
-  return value < 0 ? ansi.cross + ' ' : value > 0 ? ansi.tick + ' ' : ansi.gray('- ')
+  return value < 0
+    ? ansi.cross + ' '
+    : value === 1
+      ? ansi.tick + ' '
+      : value > 1
+        ? ''
+        : ansi.gray('- ')
 }
 
 const outputter =
@@ -374,11 +297,12 @@ const outputter =
           stdio.out.write(ansi.showCursor())
         })
       : null
-    if (typeof opts === 'boolean') opts = { json: opts }
+    if (typeof opts === 'boolean' || typeof opts === 'function') opts = { json: opts }
     const { json = false, log } = opts
     const promise = opwait(stream, ({ tag, data }) => {
       if (json) {
-        const str = JSON.stringify({ cmd, tag, data })
+        const replacer = typeof json === 'function' ? json : null
+        const str = JSON.stringify({ cmd, tag, data }, replacer)
         if (log) log(str)
         else print(str)
         return
@@ -409,7 +333,7 @@ const outputter =
           }
           let msg = Array.isArray(message) ? message.join('\n') : message
           if (tag === 'final') {
-            msg += '\n'
+            if (!result.nonl) msg += '\n'
             if (asTTY) {
               stdio.out.write(ansi.showCursor())
               dereg(false)
@@ -485,7 +409,7 @@ async function trust(ipc, key, cmd) {
     }
   ])
 
-  await opwait(interact.run())
+  await interact.run()
   await ipc.permit({ key })
   print('\n' + ansi.tick + ' pear://' + z32 + ' is now trusted\n')
   print(act[cmd] + '\n')
@@ -493,7 +417,7 @@ async function trust(ipc, key, cmd) {
   Bare.exit()
 }
 
-async function password(ipc, key, cmd) {
+async function passperm(ipc, key, cmd) {
   const z32 = hypercoreid.normalize(key)
 
   const explain = {
@@ -527,7 +451,7 @@ async function password(ipc, key, cmd) {
     dialog,
     [
       {
-        name: 'password',
+        name: 'value',
         default: '',
         prompt: ask,
         delim,
@@ -537,12 +461,9 @@ async function password(ipc, key, cmd) {
     ],
     { masked: true }
   )
-  let password = null
-  await opwait(interact.run(), ({ tag, data }) => {
-    if (tag === 'input' && data.name === 'password') password = data.answer
-  })
+  const { fields } = await interact.run()
   print(`\n${ansi.key} Hashing password...`)
-  await ipc.permit({ key, password })
+  await ipc.permit({ key, password: fields.value })
   print('\n' + ansi.tick + ' ' + message[cmd] + '\n')
   await ipc.close()
   Bare.exit()
@@ -551,7 +472,7 @@ async function password(ipc, key, cmd) {
 function permit(ipc, info, cmd) {
   const key = info.key
   if (info.encrypted) {
-    return password(ipc, key, cmd)
+    return passperm(ipc, key, cmd)
   } else {
     return trust(ipc, key, cmd)
   }
@@ -560,7 +481,7 @@ function permit(ipc, info, cmd) {
 async function confirm(dialog, ask, delim, validation, msg) {
   const interact = new Interact(dialog, [
     {
-      name: 'confirm',
+      name: 'value',
       default: '',
       prompt: ask,
       delim,
@@ -568,55 +489,40 @@ async function confirm(dialog, ask, delim, validation, msg) {
       msg
     }
   ])
-  await opwait(interact.run())
+  await interact.run()
 }
 
-function explain(bail = {}) {
-  if (!bail.reason && bail.err) {
-    const known = errors.known()
-    if (known.includes(bail.err.code) === false) {
-      print(
-        errors.ERR_UNKNOWN(
-          'Unknown [ code: ' + (bail.err.code || '(none)') + ' ] ' + bail.err.stack
-        ),
-        false
-      )
-      Bare.exit(1)
-    }
-  }
-  const messageUsage = (bail) => bail.err.message
-  const messageOnly = (bail) => bail.err.message
-  const opFail = (cmd) => cmd.err.info.message
-  const codemap = new Map([
-    ['UNKNOWN_FLAG', (bail) => 'Unrecognized Flag: --' + bail.flag.name],
-    [
-      'UNKNOWN_ARG',
-      (bail) => 'Unrecognized Argument at index ' + bail.arg.index + ' with value ' + bail.arg.value
-    ],
-    ['MISSING_ARG', (bail) => bail.arg.value],
-    ['INVALID', messageUsage],
-    ['ERR_INVALID_INPUT', messageUsage],
-    ['ERR_LEGACY', messageOnly],
-    ['ERR_INVALID_TEMPLATE', messageOnly],
-    ['ERR_DIR_NONEMPTY', messageOnly],
-    ['ERR_OPERATION_FAILED', opFail]
-  ])
-  const nouse = [messageOnly, opFail]
-  const code = codemap.has(bail.err?.code) ? bail.err.code : bail.reason
-  const ref = codemap.get(code)
-  const reason = codemap.has(code) ? (codemap.get(code)(bail) ?? bail.reason) : bail.reason
-  Bare.exitCode = 1
-
-  print(reason, false)
 
-  if (nouse.some((fn) => fn === ref) || codemap.has(code) === false) return
 
-  print('\n' + bail.command.usage())
+function password(prompt = 'Password: ') {
+  return new Promise((resolve) => {
+    const stdin = new tty.ReadStream(0)
+    const stdout = new tty.WriteStream(1)
+    let str = ''
+
+    stdin.setRawMode(true)
+    stdout.write(prompt)
+
+    stdin.on('data', (chunk) => {
+      const c = chunk[0]
+      if (c === 3) {
+        stdout.write('^C\n')
+        process.exit(130)
+      } else if (c === 13 || c === 10) {
+        stdin.setRawMode(false)
+        stdin.destroy()
+        stdout.write('\n')
+        return resolve(str)
+      } else if (c === 127 || c < 32) return
+      str += String.fromCharCode(c)
+      stdout.write('*')
+    })
+  })
 }
 
 module.exports = {
-  explain,
   usage,
+  password,
   permit,
   stdio,
   ansi,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pear-terminal",
-  "version": "2.0.0-rc.1",
+  "version": "2.0.0",
   "main": "index.js",
   "type": "commonjs",
   "description": "Pear Terminal User Interface library",
@@ -16,7 +16,8 @@
     "format": "prettier --write .",
     "lint": "prettier --check . && lunte",
     "test:gen": "brittle -r test/all.js test/*.test.js",
-    "test": "brittle-bare test/all.js"
+    "test": "brittle-bare test/all.js",
+    "test:bare": "brittle-bare test/all.js"
   },
   "devDependencies": {
     "bare-module": "^5.0.2",
@@ -32,7 +33,6 @@
     "bare-events": "^2.6.1",
     "bare-fs": "^4.2.0",
     "bare-readline": "^1.0.9",
-    "bare-realm": "^2.0.0",
     "bare-stream": "^2.7.0",
     "bare-tty": "^5.0.2",
     "hypercore-id-encoding": "^1.3.0",