@coderich/sandman 0.0.4 → 0.0.6

package/index.js

@@ -1 +1,5 @@
-module.exports = require('./src/app');
+const Sandman = require('./src/Sandman');
+
+module.exports = (configDir) => {
+  return new Sandman(configDir);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coderich/sandman",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "main": "index.js",
   "publishConfig": {
     "access": "public"
@@ -15,9 +15,10 @@
     "dev": "coderich-dev"
   },
   "dependencies": {
-    "@coderich/config": "2.2.4",
+    "@coderich/config": "2.2.5",
     "@coderich/util": "2.1.3",
     "chokidar": "4.0.3",
+    "lodash.clonedeep": "4.5.0",
     "lodash.merge": "4.6.2"
   },
   "devDependencies": {

package/src/ConfigClient.js

@@ -1,25 +1,124 @@
-const FS = require('fs');
 const Path = require('path');
+const Chokidar = require('chokidar');
 const Config = require('@coderich/config');
+const Util = require('@coderich/util');
+
+const dataSymbol = Symbol('dataSymbol');
 
 module.exports = class ConfigClient extends Config {
-  mergeConfigDir(dir) {
-    const ignored = (parsed) => {
-      if (parsed.name.startsWith('.')) return true;
-      const stat = FS.statSync(Path.join(parsed.dir, `${parsed.name}${parsed.ext}`));
-      if (stat?.isDirectory()) return false;
-      return !['.yml', '.yaml'].includes(parsed.ext.toLowerCase());
-    };
-
-    const arr = Config.dirPaths(dir, ignored);
-
-    const yaml = arr.reduce((prev, { paths, data }) => {
-      const path = paths.join('.');
-      if (!path.length) return prev.concat(data);
-      const indented = data.split('\n').map(line => (line.trim() ? `  ${line}` : line)).join('\n');
-      return prev.concat(`${path}:\n${indented}`);
-    }, '');
-
-    return this.merge(Config.parseYaml(yaml));
+  #configDir; #mergeData = {};
+
+  constructor(configDir) {
+    super();
+    this.#configDir = configDir;
+    this.mergeDir();
+  }
+
+  get(key, ...args) {
+    const data = super.get(key, ...args);
+    const flatData = key === undefined ? Util.flatten(data) : Util.flatten({ [key]: data });
+    const apiKeys = Array.from(new Set(Object.keys(flatData).map(k => k.substring(0, Math.max(k.indexOf('.request'), 0))).filter(Boolean)));
+
+    apiKeys.forEach((apiKey) => {
+      Reflect.ownKeys(this.#mergeData).forEach((mergeKey) => {
+        if (mergeKey === dataSymbol) flatData[apiKey] = { ...this.#mergeData[dataSymbol], ...flatData[apiKey] };
+        else if (apiKey.startsWith(mergeKey)) flatData[apiKey] = { ...this.#mergeData[mergeKey][dataSymbol], ...flatData[apiKey] };
+      });
+    });
+
+    const unflatData = Util.unflatten(flatData);
+    const rawData = key === undefined ? unflatData : Util.get(unflatData, key);
+    super.set(dataSymbol, rawData);
+    return super.get(dataSymbol);
+  }
+
+  mergeDir(dir = this.#configDir) {
+    return this.merge(Config.parseDir(dir, (...args) => this.#ignore(...args)));
+  }
+
+  watch(dir = this.#configDir) {
+    const watcher = Chokidar.watch(dir, {
+      awaitWriteFinish: true,
+      ignoreInitial: true,
+      ignored: filepath => this.#ignore(this.#normalizeWatcherPath(filepath)),
+    });
+
+    watcher.on('all', (event, path) => {
+      const { key } = this.#normalizeWatcherPath(path);
+
+      if (['add', 'change'].includes(event)) {
+        const api = Config.parseFile(path);
+        if (key) this.set(key, api);
+        else this.merge(api); // index.yaml
+        // if (api.request) this.emit('save', { key, api });
+      } else if (['unlink', 'unlinkDir'].includes(event)) {
+        this.del(key);
+      }
+    });
+  }
+
+  #ignore({ name, filepath, paths }) {
+    if (name.startsWith('.')) return true;
+
+    if (name.startsWith('+')) {
+      const path = paths.slice(0, -1).join('.');
+      const request = Util.flatten(Config.parseFile(filepath));
+      if (path) this.#mergeData[path] = { [dataSymbol]: request };
+      else this.#mergeData[dataSymbol] = request;
+      return true;
+    }
+
+    return false;
   }
+
+  #normalizeWatcherPath = (filepath) => {
+    const parsed = Path.parse(filepath);
+    const folder = filepath.substring(this.#configDir.length + 1, filepath.length - parsed.ext.length);
+    const paths = folder.split('/').filter(el => el && el !== 'index');
+    const key = paths.join('.');
+    return { ...parsed, filepath, paths, key };
+  };
+
+  // exports.decorateRequest = (mergeData, key, request) => {
+  //   const toMerge = key.split('.').reduce((prev, k, i, arr) => {
+  //     const $key = arr.slice(0, i).join('.');
+  //     return Merge({}, prev, mergeData[$key]?.request);
+  //   }, Merge({}, mergeData.request));
+
+  //   return Merge({}, toMerge, request);
+  // };
+
+  // #get(key, ...rest) {
+  //   const { config } = this.#configClient.toObject();
+  //   const value = get(config, key);
+
+  //   if (value?.request) {
+  //     const $request = FetchService.decorateRequest(this.#mergeData, key, value.request);
+  //     const request = this.#configClient.resolve({ vars: value.request.vars }).set(resolveSymbol, $request).get(resolveSymbol);
+  //     this.#configClient.del(resolveSymbol);
+  //     return Merge({}, value, { request });
+  //   }
+
+  //   return this.#configClient.get(key, ...rest);
+  // }
+
+  // mergeConfigDir(dir) {
+  //   const ignored = (parsed) => {
+  //     if (parsed.name.startsWith('.')) return true;
+  //     const stat = FS.statSync(Path.join(parsed.dir, `${parsed.name}${parsed.ext}`));
+  //     if (stat?.isDirectory()) return false;
+  //     return !['.yml', '.yaml'].includes(parsed.ext.toLowerCase());
+  //   };
+
+  //   const arr = Config.dirPaths(dir, ignored);
+
+  //   const yaml = arr.reduce((prev, { paths, data }) => {
+  //     const path = paths.join('.');
+  //     if (!path.length) return prev.concat(data);
+  //     const indented = data.split('\n').map(line => (line.trim() ? `  ${line}` : line)).join('\n');
+  //     return prev.concat(`${path}:\n${indented}`);
+  //   }, '');
+
+  //   return this.merge(Config.parseYaml(yaml));
+  // }
 };

package/src/FetchService.js

@@ -1,64 +1,46 @@
-const Merge = require('lodash.merge');
-
-function shq(s) { return `'${String(s).replace(/'/g, `'"'"'`)}'`; }
-
-exports.fetch = (req) => {
-  return new Promise((resolve, reject) => {
-    const { url, ...params } = exports.normalizeRequest({ ...req });
-
-    fetch(url, params).then(async (res) => {
-      const ct = res.headers.get('content-type') || '';
-      const data = await (ct.includes('application/json') ? res.json() : res.text());
-      return { res, data };
-    }).then(resolve).catch(reject);
+exports.fetch = (request) => {
+  return fetch(request).then(async (response) => {
+    const ct = response.headers.get('content-type') || '';
+    const data = await (ct.includes('application/json') ? response.json() : response.text());
+    return { response, data };
   });
 };
 
 exports.normalizeRequest = (req) => {
-  req.path ??= '';
-  req.method ??= 'get'; req.headers ??= {}; req.params ??= {};
-  req.url += req.path;
-  req.url = Object.entries(req.params).reduce((url, [key, value]) => { url.searchParams.append(key, value); return url; }, new URL(req.url)).toString();
+  req.path ??= ''; req.method ??= 'get'; req.headers ??= {}; req.params ??= {};
+  req.url = Object.entries(req.params).reduce((url, [key, value]) => { url.searchParams.append(key, value); return url; }, new URL(`${req.url}${req.path}`)).toString();
   req.headers = Object.entries(req.headers).reduce((prev, [key, value]) => Object.assign(prev, { [key.toLowerCase()]: value }), {});
   const [contentType] = req.headers['content-type']?.split(';') || [];
-  const { data } = req; delete req.data;
-  if (data == null) return req;
 
-  switch (contentType) {
-    case 'application/json': {
-      req.body = JSON.stringify(data);
-      break;
-    }
-    case 'application/x-www-form-urlencoded': {
-      req.body = new URLSearchParams(data).toString();
-      break;
-    }
-    case 'multipart/form-data': {
-      delete req.headers['content-type'];
-      // req.duplex = 'half';
-      req.body = Object.entries(data).reduce((form, [key, value]) => {
-        form.append(key, value);
-        return form;
-      }, new FormData());
-      break;
-    }
-    default: {
-      req.body = data;
-      break;
+  if (req.data) {
+    switch (contentType) {
+      case 'application/json': {
+        req.body = JSON.stringify(req.data);
+        break;
+      }
+      case 'application/x-www-form-urlencoded': {
+        req.body = new URLSearchParams(req.data).toString();
+        break;
+      }
+      case 'multipart/form-data': {
+        delete req.headers['content-type'];
+        req.body = new FormData();
+        Object.entries(req.data).forEach(([key, value]) => req.body.append(key, value));
+        break;
+      }
+      default: {
+        req.body = req.data;
+        break;
+      }
     }
   }
 
-  return req;
+  delete req.data; delete req.params;
+  const { url, ...params } = req;
+  return new Request(url, params);
 };
 
-exports.decorateRequest = (mergeData, key, request) => {
-  const toMerge = key.split('.').reduce((prev, k, i, arr) => {
-    const $key = arr.slice(0, i).join('.');
-    return Merge({}, prev, mergeData[$key]?.request);
-  }, Merge({}, mergeData.request));
-
-  return Merge({}, toMerge, request);
-};
+exports.shq = s => `'${String(s).replace(/'/g, "'\\''")}'`;
 
 exports.toCURL = (request, { pretty = true, redactAuth = false } = {}) => {
   if (!request) return '<no request>';
@@ -89,18 +71,17 @@ exports.toCURL = (request, { pretty = true, redactAuth = false } = {}) => {
   // body (skip for GET)
   if (data != null && !/^GET$/i.test(method)) {
     if (typeof data === 'string') {
-      parts.push('--data-raw', shq(data));
+      parts.push('--data-raw', exports.shq(data));
     } else if (data instanceof URLSearchParams) {
-      parts.push('-H', shq('Content-Type: application/x-www-form-urlencoded'));
-      parts.push('--data', shq(data.toString()));
+      parts.push('-H', exports.shq('Content-Type: application/x-www-form-urlencoded'));
+      parts.push('--data', exports.shq(data.toString()));
     } else if (typeof data === 'object') {
-      // JSON by default
       const hasCT = Object.keys(hdrs).some(h => /^content-type$/i.test(h));
-      if (!hasCT) parts.push('-H', shq('Content-Type: application/json'));
-      parts.push('--data-raw', shq(JSON.stringify(data)));
+      if (!hasCT) parts.push('-H', exports.shq('Content-Type: application/json'));
+      parts.push('--data-raw', exports.shq(JSON.stringify(data)));
     }
   }
 
-  parts.push(shq(full.toString()));
+  parts.push(exports.shq(full.toString()));
   return pretty ? parts.join(' \\\n  ') : parts.join(' ');
 };

package/src/ReadlineService.js

@@ -0,0 +1,85 @@
+const Readline = require('readline');
+const { get, flatten } = require('@coderich/util');
+
+exports.createInterface = (cli, configClient) => {
+  const captureInfo = {
+    line: '',
+    lastToken: '',
+    candidates: [],
+    tabCounter: 0,
+    candidateIndex: -1,
+    captureCandidates: false,
+  };
+
+  const readline = Readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+    terminal: true,
+    completer: (line) => {
+      // Show available CLI commands
+      if (!line) return [Object.keys(cli), line];
+
+      const tokens = line.split(' ');
+      const lastToken = tokens.at(-1);
+      const paths = lastToken.split('.');
+      const path = paths.at(-1);
+
+      // Specific request.data selector
+      if (lastToken.startsWith('.')) {
+        const api = configClient.get(tokens.at(-2));
+        if (!api?.request) return [[], path];
+        const dataPath = ['request'].concat(paths.slice(1, -1)).join('.');
+        const data = get(api, dataPath, {});
+        return [Object.keys(data).filter(k => k.toLowerCase().startsWith(path.toLowerCase())), path];
+      }
+
+      //
+      const flatKeys = Object.keys(flatten(configClient.get()));
+
+      // These keys follow the typing of the user
+      const startsWithCandidates = Array.from(new Set(flatKeys.map((flatKey) => {
+        return flatKey.split('.').slice(0, paths.length).join('.');
+      }))).filter((c) => {
+        return c.toLowerCase().startsWith(lastToken.toLowerCase());
+      }); // .map(p => p.split('.').at(-1)); // Here!
+
+      // These are shortcut keys to requests
+      const requestKeyCandidates = Array.from(new Set(flatKeys.map((flatKey) => {
+        const keys = flatKey.split('.');
+        const index = keys.indexOf('request');
+        return index && flatKey.split('.').slice(0, index).join('.');
+        // const typedPath = keys.slice(0, paths.length - 1).join('.');
+        // const autocompletePath = keys.slice(paths.length - 1, index).join('.');
+        // return index > 0 && lastToken.toLowerCase().startsWith(typedPath.toLowerCase()) && autocompletePath;
+      }).filter(Boolean))).filter((c) => {
+        return c.toLowerCase().includes(lastToken.toLowerCase());
+        // return c.toLowerCase().includes(path.toLowerCase());
+      });
+
+      const candidates = Array.from(new Set(startsWithCandidates.concat(requestKeyCandidates)));
+      if (captureInfo.captureCandidates) { captureInfo.candidates = candidates; captureInfo.line = line; captureInfo.lastToken = lastToken; captureInfo.candidateIndex = -1; }
+      if (candidates.length === 1 && candidates[0] === lastToken) return [[], lastToken];
+      return [candidates, lastToken];
+    },
+  });
+
+  process.stdin.on('keypress', (ch, key) => {
+    if (key && key.name === 'tab') captureInfo.tabCounter++; else captureInfo.tabCounter = 0;
+    captureInfo.captureCandidates = captureInfo.tabCounter === 2;
+
+    if (key && key.name === 'escape') {
+      readline.line = '';
+      Readline.cursorTo(process.stdout, 0);
+      Readline.clearLine(process.stdout, 0);
+      readline.prompt();
+    } else if (captureInfo.tabCounter > 2 && captureInfo.candidates.length) {
+      const candidate = captureInfo.candidates[captureInfo.candidateIndex = ++captureInfo.candidateIndex % captureInfo.candidates.length];
+      const value = captureInfo.line.replace(captureInfo.lastToken, candidate);
+      readline.line = value;
+      readline.cursor = value.length;
+      readline.prompt(true);
+    }
+  });
+
+  return readline;
+};

package/src/Sandman.js

@@ -1,27 +1,17 @@
-const Path = require('path');
-const Merge = require('lodash.merge');
-const Readline = require('readline');
-const Chokidar = require('chokidar');
 const EventEmitter = require('events');
-const { get, flatten } = require('@coderich/util');
+const ReadlineService = require('./ReadlineService');
 const FetchService = require('./FetchService');
 const ConfigClient = require('./ConfigClient');
 
-const resolveSymbol = Symbol('resolve');
-
 module.exports = class Sandman extends EventEmitter {
-  #configClient; #configDir; #options; #watcher; #readline; #mergeData = {}; #cli;
-  #captureCandidates = false; #candidates = []; #tabCounter = 0; #candidateIndex; #line; #lastToken;
+  #configClient; #options; #readline; #cli; #cliCounter = 0;
 
   constructor(configDir, options) {
     super();
-    this.#configDir = configDir;
     this.#options = options;
-    this.#configClient = new ConfigClient().merge(ConfigClient.parseDir(configDir, arg => this.#ignore(arg)));
-    this.#createInterface();
-    this.#createWatcher();
+    this.#configClient = new ConfigClient(configDir);
     this.#createCLI();
-    this.#prompt();
+    this.#readline = ReadlineService.createInterface(this.#cli, this.#configClient);
 
     this.#readline.on('line', async (line) => {
       if (!line) return this.#readline.prompt();
@@ -30,6 +20,8 @@ module.exports = class Sandman extends EventEmitter {
       const value = await Promise.resolve(this.#cli[info.cmd](...info.args)).catch(e => e);
       return this.emit(cmd, value);
     });
+
+    this.#prompt();
   }
 
   cli() {
@@ -45,50 +37,38 @@ module.exports = class Sandman extends EventEmitter {
   }
 
   #run(key) {
-    const api = this.#get(key, {});
+    const api = this.#configClient.get(key, {});
     if (!api?.request) return this.emit('error', { key, error: `Request "${key}" Not Found` });
-    this.emit('request', { key, api });
+    this.emit('api', { api, key });
+    const request = FetchService.normalizeRequest(api.request);
+    this.emit('request', { request, api, key });
 
-    return FetchService.fetch(api.request).then(({ res, data }) => {
-      this.emit('response', { key, api, res, data });
-      return { key, api, res, data };
+    return FetchService.fetch(request).then(({ response, data }) => {
+      this.emit('response', { response, api, key, data });
+      return { response, api, key, data };
     }).catch((error) => {
       this.emit('error', { key, api, error });
       return Promise.reject(error);
     }).then((results) => {
-      return results.res.ok ? results : Promise.reject(results);
+      return results.response.ok ? results : Promise.reject(results);
     });
   }
 
   #prompt() {
     this.#readline.setPrompt(this.#configClient.get('prompt'));
-    this.#readline.prompt();
+    this.#readline.prompt(true);
     return this;
   }
 
-  #get(key, ...rest) {
-    const { config } = this.#configClient.toObject();
-    const value = get(config, key);
-
-    if (value?.request) {
-      const $request = FetchService.decorateRequest(this.#mergeData, key, value.request);
-      const request = this.#configClient.set(resolveSymbol, $request).get(resolveSymbol);
-      this.#configClient.del(resolveSymbol);
-      return Merge({}, value, { request });
-    }
-
-    return this.#configClient.get(key, ...rest);
-  }
-
   #createCLI() {
     const self = this;
 
     this.#cli = new Proxy({
       run: (...args) => this.#run(...args),
-      get: (...args) => this.#get(...args),
+      get: (...args) => this.#configClient.get(...args),
       set: (key = '', value = null) => this.#configClient.set(key, value),
       del: (key = '') => this.#configClient.del(key),
-      curl: key => FetchService.toCURL(this.#get(key, {}).request),
+      curl: key => FetchService.toCURL(this.#configClient.get(key, {}).request),
       quit: () => process.exit(),
     }, {
       get(obj, prop, receiver) {
@@ -96,9 +76,12 @@ module.exports = class Sandman extends EventEmitter {
 
         if (typeof value === 'function') {
           return (...args) => {
+            self.#cliCounter++;
             self.#readline.pause();
-            const result = value(...args);
-            Promise.resolve().then(() => result).catch(() => null).finally(() => self.#prompt());
+            const result = value.apply(this, args);
+            Promise.resolve(result).catch(() => null).finally(() => setImmediate(() => {
+              if (--self.#cliCounter === 0) self.#prompt();
+            }));
             return result;
           };
         }
@@ -107,121 +90,4 @@ module.exports = class Sandman extends EventEmitter {
       },
     });
   }
-
-  #createInterface() {
-    this.#readline = Readline.createInterface({
-      input: process.stdin,
-      output: process.stdout,
-      terminal: true,
-      completer: (line) => {
-        // Show available CLI commands
-        if (!line) return [Object.keys(this.#cli), line];
-
-        const tokens = line.split(' ');
-        const lastToken = tokens.at(-1);
-        const paths = lastToken.split('.');
-        const path = paths.at(-1);
-
-        // Specific request.data selector
-        if (lastToken.startsWith('.')) {
-          const api = this.#get(tokens.at(-2));
-          if (!api?.request) return [[], path];
-          const dataPath = ['request'].concat(paths.slice(1, -1)).join('.');
-          const data = get(api, dataPath, {});
-          return [Object.keys(data).filter(k => k.toLowerCase().startsWith(path.toLowerCase())), path];
-        }
-
-        //
-        const flatKeys = Object.keys(flatten(this.#configClient.get()));
-
-        // These keys follow the typing of the user
-        const startsWithCandidates = Array.from(new Set(flatKeys.map((flatKey) => {
-          return flatKey.split('.').slice(0, paths.length).join('.');
-        }))).filter((c) => {
-          return c.toLowerCase().startsWith(lastToken.toLowerCase());
-        }); // .map(p => p.split('.').at(-1)); // Here!
-
-        // These are shortcut keys to requests
-        const requestKeyCandidates = Array.from(new Set(flatKeys.map((flatKey) => {
-          const keys = flatKey.split('.');
-          const index = keys.indexOf('request');
-          return index && flatKey.split('.').slice(0, index).join('.');
-          // const typedPath = keys.slice(0, paths.length - 1).join('.');
-          // const autocompletePath = keys.slice(paths.length - 1, index).join('.');
-          // return index > 0 && lastToken.toLowerCase().startsWith(typedPath.toLowerCase()) && autocompletePath;
-        }).filter(Boolean))).filter((c) => {
-          return c.toLowerCase().includes(lastToken.toLowerCase());
-          // return c.toLowerCase().includes(path.toLowerCase());
-        });
-
-        const candidates = Array.from(new Set(startsWithCandidates.concat(requestKeyCandidates)));
-        if (this.#captureCandidates) { this.#candidates = candidates; this.#line = line; this.#lastToken = lastToken; this.#candidateIndex = -1; }
-        if (candidates.length === 1 && candidates[0] === lastToken) return [[], lastToken];
-        return [candidates, lastToken];
-      },
-    });
-
-    process.stdin.on('keypress', (ch, key) => {
-      if (key && key.name === 'tab') this.#tabCounter++; else this.#tabCounter = 0;
-      this.#captureCandidates = this.#tabCounter === 2;
-
-      if (key && key.name === 'escape') {
-        this.#readline.line = '';
-        Readline.cursorTo(process.stdout, 0);
-        Readline.clearLine(process.stdout, 0);
-        this.#readline.prompt();
-      } else if (this.#tabCounter > 2 && this.#candidates.length) {
-        const candidate = this.#candidates[this.#candidateIndex = ++this.#candidateIndex % this.#candidates.length];
-        const value = this.#line.replace(this.#lastToken, candidate);
-        this.#readline.line = value;
-        this.#readline.cursor = value.length;
-        this.#readline.prompt(true);
-      }
-    });
-  }
-
-  #createWatcher() {
-    this.#watcher = Chokidar.watch(this.#configDir, {
-      awaitWriteFinish: true,
-      ignoreInitial: true,
-      ignored: filepath => this.#ignore(this.#normalizeWatcherPath(filepath)),
-    });
-
-    this.#watcher.on('all', (event, path) => {
-      const { key } = this.#normalizeWatcherPath(path);
-
-      if (['add', 'change'].includes(event)) {
-        const api = ConfigClient.parseFile(path);
-        if (key) this.#configClient.set(key, api);
-        else this.#configClient.merge(api); // index.yaml
-        if (api.request) this.emit('save', { key, api });
-        this.#prompt();
-      } else if (['unlink', 'unlinkDir'].includes(event)) {
-        this.#configClient.del(key);
-        this.#prompt();
-      }
-    });
-  }
-
-  #ignore({ name, filepath, paths }) {
-    if (name.startsWith('.')) return true;
-
-    if (name.startsWith('+')) {
-      const request = ConfigClient.parseFile(filepath);
-      const key = paths.slice(0, -1).join('.');
-      if (key) this.#mergeData[key] = { request };
-      else this.#mergeData.request = request;
-      return true;
-    }
-
-    return false;
-  }
-
-  #normalizeWatcherPath = (filepath) => {
-    const parsed = Path.parse(filepath);
-    const folder = filepath.substring(this.#configDir.length + 1, filepath.length - parsed.ext.length);
-    const paths = folder.split('/').filter(el => el && el !== 'index');
-    const key = paths.join('.');
-    return { ...parsed, filepath, paths, key };
-  };
 };

package/src/app.js

@@ -1,5 +0,0 @@
-const Sandman = require('./Sandman');
-
-module.exports = (configDir) => {
-  return new Sandman(configDir);
-};