bscript-cli 1.0.0

package/BScript.js

@@ -0,0 +1,233 @@
+const CMDPermissions = require('./SRC/CMDPermissions')
+const EventEmitter = require('node:events');
+const Runner = require('@beiser/bscript-runner').Runner;
+const { readDirRecursive, delay } = require('./SRC/utils/utils');
+const TCC = require('./TerminalCommandController');
+const fs = require('fs');
+const path = require('path');
+
+var runInNewContext = require('vm').runInNewContext;
+
+module.exports = class CMD extends EventEmitter{
+	constructor(options={}) {
+		super();
+		// Terminal Command Controller
+		this.started = options.started??true;
+
+		this._commands = { };
+		this._commandHistoryLimit = 10;
+		this.commandHistory = [];
+		this._historyPos = -1;
+		this.returnCode = 1;
+
+		this._perUpdateInterval = null;
+		this.perrmissionsKeys={...CMDPermissions, ...options.perrmissionsKeys??{}};
+		this.commandsPaths=[__dirname + '/commands', ...options.commandsPaths??[], process.cwd() + "/commands"]
+		this.cmdRootPermissions = [...options.cmdRootPermissions??[]];
+		this.cmdPermissionsHistory = [[CMDPermissions.default, ...options.historyFirstPermissions??[]], ...options.cmdPermissionsHistory??[]];
+		this.commandController = new TCC(
+			{
+				defaultCommandPrefix: " <help>? ",
+				stdinEmmiter: process.stdin,
+				CMD: this
+			}
+		);
+	}
+	loader = async (func) => {
+		this.returnCode = -1
+	  let _loaderAnimation = async () => {  
+	    var iteractions = 8
+	    while(iteractions > 0) {
+	      switch(iteractions % 4) {
+	        case 4:
+	          this.commandController.ClearLine();
+	          this.commandController.CursorTo(0);
+	          this.commandController.Write("Loading");
+	        break;
+	        case 3:
+	          this.commandController.ClearLine();
+	          this.commandController.CursorTo(0);
+	          this.commandController.Write("Loading.");
+	        break;
+	        case 2:
+	          this.commandController.ClearLine();
+	          this.commandController.CursorTo(0);
+	          this.commandController.Write("Loading..");
+	        break;
+	        case 1:
+	          this.commandController.ClearLine();
+	          this.commandController.CursorTo(0);
+	          this.commandController.Write("Loading...");
+	        break;
+	      }
+	      await delay(200);
+	      iteractions--;
+	    }
+	  }
+	  var loaderOn = true;
+	  var loaderContinue = false;
+	  const startAnimation = async () => {
+	      loaderOn = true;
+	      loaderContinue = false;
+	      while(loaderOn) {
+	        await _loaderAnimation();
+	      }
+	      loaderContinue = true;
+	  };
+	  startAnimation();
+	  const waitForPromise = async (onStop) => {
+	    loaderOn = false;
+	    return await new Promise(res=> { 
+	      const interval = setInterval(()=>{ 
+	        if(loaderContinue) {
+	          clearInterval(interval);
+	          (async () => {
+	            res(await onStop());
+	            startAnimation();
+	          })()
+	        } 
+	      }, 500)
+	    });
+	  }
+	  const conAnimation = async () => {
+	    loaderOn = false;
+	    await new Promise(res=>setInterval(()=>{ if(loaderContinue) { res() } }, 500));
+	    this.returnCode = 1;
+	  }
+	  return await new Promise(res => func( () => conAnimation().then(res), waitForPromise, startAnimation ) )
+	}
+	updateCommands() {
+		this._commands = {};
+		const cmdPermission = [...this.cmdPermissionsHistory[this.cmdPermissionsHistory.length-1], ...this.cmdRootPermissions]
+
+		const commandFiles = this.commandsPaths.filter(fs.existsSync).map(path => 
+			readDirRecursive(path)
+				.filter((file) => file.endsWith('.js'))
+		).flat(1)
+		let uniqueKey = 0;
+		for (const file of commandFiles) {
+			delete require.cache[file];
+			var _module = new module.constructor();
+			_module.paths = module.paths;
+		    var sandbox = {}
+			Object.getOwnPropertyNames(global).map((k)=>{
+				sandbox[k] = global[k];
+			})
+			sandbox.require = require
+			sandbox.exports = [];
+			sandbox.CMDPermissions = this.perrmissionsKeys;
+			sandbox.__filename = __filename;
+			sandbox.__dirname = __dirname;
+			sandbox.__commandDir = path.dirname(file);
+			sandbox.__rootDir = require.main.path;
+			sandbox.module = _module;
+			sandbox.global = {};
+			
+			var content = fs.readFileSync(file, 'utf8');
+			runInNewContext(content, sandbox, { filename: file });
+
+			const command = _module.exports;
+			if((command.perms == undefined ? true : cmdPermission.some(currentPerm => command.perms.includes(currentPerm))) && !cmdPermission.some(currentPerm => command.excludePerms ? command.excludePerms.includes(currentPerm) : false))
+				if(Array.isArray(command.name)) {
+					command.name.map(commandName => this.createCommand({ name: commandName, execute: command.execute, description: command.description, syntax: command.syntax, uniqueKey: uniqueKey}));
+				} else {
+					this.createCommand({ name: command.name, execute: command.execute, description: command.description, syntax: command.syntax, uniqueKey: uniqueKey});
+				}
+			uniqueKey += 1;
+		}
+	}
+	pushToCommandHistory(cmd) {
+		if(this.commandHistory[this.commandHistory.length - 1] == cmd)
+			return;
+		this.commandHistory.push(cmd);
+		
+		if(this.commandHistory.length > this._commandHistoryLimit) {
+			this.commandHistory.shift();
+		}
+	}
+    createCommand({ name, execute, description = "", syntax, uniqueKey }) {
+        this._commands[name] = { execute, description, syntax, uniqueKey };
+    }
+    removeCommand(name) {
+    	delete this._commands[name]
+    }
+    bscript(run, options=this.options) {
+    	if(!run)
+    		return;
+    	const bScriptRunner = new Runner(this, options)
+    	bScriptRunner.Create(run)
+    	return bScriptRunner.executer;
+    }
+	async Start() {
+		this.updateCommands();
+		this.started = true;
+		this._perUpdateInterval = setInterval(() => this.emit("perUpdate"), 300);
+		while(true) {
+			await this.waitForPerUpdate();
+			if(this.returnCode == 1){
+				const value = await this.Input(this.commandController.defaultCommandPrefix);
+				if(value)
+				{
+					this.pushToCommandHistory(value);
+					this.bscript(value)();
+				}
+			}
+		}
+		this.on("perUpdate", onPerUpdate);
+	}
+	Stop() {
+		this.started = false;
+		process.stdout.clearLine();
+  		process.stdout.cursorTo(0);
+  		clearInterval(this._perUpdateInterval);
+	}
+	async waitForPerUpdate() {
+		await new Promise(res => this.once('perUpdate', res));
+	}
+	async Input(prefix = " > ") {
+		this.returnCode = -1;
+		await this.waitForPerUpdate();
+		this.returnCode = 0;
+		const nativePrefix = this.commandController.defaultCommandPrefix;
+		this.commandController.defaultCommandPrefix = prefix;
+
+		this.commandController.InitInput(true);
+
+		this.commandController.stdinVal = "";
+		this.commandController.col = 0;
+
+		this.commandController.CursorTo(0);
+		this.commandController.WriteCommand("");
+
+		let onData = async (inputStdin) => {
+			this.returnCode = this.commandController.OnData(inputStdin);
+		}
+
+		this.commandController.SetStdinListener('data', onData);
+		
+
+		return await new Promise(res => {
+			let exit = () => {
+				this.commandController.defaultCommandPrefix = nativePrefix;
+				this.commandController.RemoveStdinListener('data', onData);
+				this.removeListener('perUpdate', perUpdate);
+				this.commandController.InitInput(false);
+			}
+			let perUpdate = async () => {
+				switch(this.returnCode) {
+					case 1:
+						exit();
+						res(this.commandController.stdinVal);
+						break;
+					case -1: // breaking
+						exit();
+						this.commandController.ClearLine();
+				  		this.commandController.CursorTo(0);
+						res(undefined);
+						break;
+				}
+			}
+			this.on('perUpdate', perUpdate)
+		})
+	}
+}

package/Docs/BScript/BSCRIPT-REFERENCE-CLI.md

@@ -0,0 +1,502 @@
+# BSCRIPT-REFERENCE-CLI
+
+Complete reference of all built-in BScript CLI commands.
+
+---
+
+# Contents
+
+- [Core Types](#core-types)
+- [Variables](#variables)
+- [JavaScript Interop](#javascript-interop)
+- [Execution](#execution)
+- [Input / Output](#input--output)
+- [Scripts](#scripts)
+- [Utilities](#utilities)
+- [Debug](#debug)
+
+---
+
+# Core Types
+
+## bool
+
+Creates a boolean value.
+
+### Syntax
+
+```bscript
+bool <value>
+```
+
+### Returns
+
+`bool`
+
+### Example
+
+```bscript
+print ${bool true}
+print ${bool false}
+```
+
+---
+
+## num
+
+Creates a numeric value.
+
+### Syntax
+
+```bscript
+num <number>
+```
+
+### Returns
+
+`number`
+
+### Example
+
+```bscript
+print ${num 100}
+```
+
+---
+
+## str
+
+Creates a string by concatenating all arguments.
+
+### Syntax
+
+```bscript
+str <value...>
+```
+
+### Returns
+
+`string`
+
+### Example
+
+```bscript
+print ${str Hello World}
+```
+
+---
+
+## object
+
+Creates a BScript object.
+
+### Syntax
+
+```bscript
+object <value>
+```
+
+### Returns
+
+`object`
+
+### Example
+
+```bscript
+object ${array
+(
+    name = John
+    age = 20
+)}
+```
+
+---
+
+## raw
+
+Returns a raw value without its BScript wrapper.
+
+### Syntax
+
+```bscript
+raw <value>
+```
+
+### Returns
+
+Raw value.
+
+### Example
+
+```bscript
+raw ${str Hello}
+```
+
+---
+
+## jstype
+
+Wraps a JavaScript object as a JS type.
+
+### Syntax
+
+```bscript
+jstype <value>
+```
+
+### Returns
+
+`jstype`
+
+---
+
+# Variables
+
+## \$arg
+
+Returns a function argument.
+
+### Syntax
+
+```bscript
+$arg <index>
+```
+
+### Returns
+
+Argument value.
+
+### Example
+
+```bscript
+$arg 0
+```
+
+---
+
+## \$val
+
+Reads a stored variable.
+
+### Syntax
+
+```bscript
+$val <name>
+```
+
+### Returns
+
+Stored value.
+
+### Variable existence
+
+```bscript
+$val exist <name>
+```
+
+Returns
+
+```text
+bool
+```
+
+---
+
+## ref
+
+Creates a reference to an object property.
+
+### Syntax
+
+```bscript
+ref <path>
+```
+
+or
+
+```bscript
+ref <object> <path>
+```
+
+### Returns
+
+`ref`
+
+### Example
+
+```bscript
+ref player.health
+```
+
+---
+
+# JavaScript Interop
+
+## js
+
+Imports a JavaScript module using Node.js require().
+
+### Syntax
+
+```bscript
+js <module>
+```
+
+### Returns
+
+JavaScript module.
+
+### Example
+
+```bscript
+js fs
+```
+
+---
+
+## js_new
+
+Creates a new JavaScript class instance.
+
+### Syntax
+
+```bscript
+js_new <class> <arguments...>
+```
+
+### Returns
+
+JavaScript object.
+
+### Example
+
+```bscript
+js_new ${js Date}
+```
+
+---
+
+## eval
+
+Evaluates JavaScript code.
+
+Alias:
+
+- evaluate
+
+### Syntax
+
+```bscript
+eval <javascript>
+```
+
+### Returns
+
+Evaluation result.
+
+### Example
+
+```bscript
+eval "1 + 2"
+```
+
+---
+
+# Execution
+
+## run
+
+Executes a BScript function.
+
+### Syntax
+
+```bscript
+run <function> <arguments...>
+```
+
+### Returns
+
+Function result.
+
+---
+
+## await
+
+Awaits a Promise.
+
+### Syntax
+
+```bscript
+await <promise>
+```
+
+or
+
+```bscript
+await run <function>
+```
+
+### Returns
+
+Resolved value.
+
+---
+
+## delay
+
+Pauses execution.
+
+### Syntax
+
+```bscript
+delay <milliseconds>
+```
+
+### Returns
+
+Promise.
+
+### Example
+
+```bscript
+delay 1000
+```
+
+---
+
+# Input / Output
+
+## print
+
+Prints values to the console.
+
+### Syntax
+
+```bscript
+print <value...>
+```
+
+### Example
+
+```bscript
+print Hello World
+```
+
+---
+
+## Input
+
+Reads user input.
+
+### Syntax
+
+```bscript
+Input <prompt>
+```
+
+### Returns
+
+User input.
+
+### Example
+
+```bscript
+Input Enter your name:
+```
+
+---
+
+# Scripts
+
+## import
+
+Loads another BScript file inside a new runner and returns its exported value.
+
+### Syntax
+
+```bscript
+import <path>
+```
+
+### Returns
+
+Exported value.
+
+### Example
+
+```bscript
+import scripts/math.bs
+```
+
+---
+
+## script
+
+Executes another BScript file.
+
+### Syntax
+
+```bscript
+script <path>
+```
+
+### Returns
+
+Nothing.
+
+### Example
+
+```bscript
+script scripts/start.bs
+```
+
+---
+
+# Utilities
+
+## help
+
+Displays every registered command.
+
+### Syntax
+
+```bscript
+help
+```
+
+---
+
+# Debug
+
+## clear
+
+Clears the console.
+
+### Syntax
+
+```bscript
+clear
+```
+
+---
+
+## update-commands
+
+Reloads all registered commands.
+
+### Syntax
+
+```bscript
+update-commands
+```
+
+---
+
+# Notes
+
+- All commands are registered as modules.
+- Commands may return native JavaScript objects or BScript values.
+- JavaScript interoperability is available through `js`, `js_new`, `eval`, and `jstype`.
+- `await` automatically resolves BScript Promise values.
+- `import` executes a separate BScript runner and returns its exported value.
+- `script` executes another script without returning exports.