Kaeon United (pronounced "KAI-on") is a multi-purpose API designed to provide a unified interface to all of the major software development tools defined in the Kaeon United Specification.
\r\n\r\nThe functionality that Kaeon United provides includes but is not limited to:
\r\n\r\nA free hosting service for serverless apps.
\r\nA script that provides dynamic client side access to CommonJS.
\r\nAn npx CLI for various programming languages.
\r\nA CommonJS module that provides access to various JavaScript utilities.
\r\nAs an extension of said functionality, the API provides utilities for the following languages:
\r\n\r\nThe Kaeon FUSION programming language.
\r\nA C and C++ hybrid language called United C.
\r\nA machine code editing format called Character Separated Binary, or CSB for short.
\r\nAn enhanced version of JavaScript called:
\r\nUnited JavaScript is a minor modification to vanilla JavaScript with the following key attributes:
\r\n\r\nCommonJS shall be available regardless of the environment the program is running in.
\r\nEven in the browser,\r\nthe CommonJS require function shall accept dynamically generated module paths.
\r\nCommonJS shall allow cross origin access to online modules via their URLs in both the browser and node.
\r\nThe CommonJS require function shall allow for an optional second argument,\r\nan options object which shall allow said function to reload modules,\r\nto execute modules in the global scope,\r\nto load modules from strings in memory,\r\nand to load modules asynchronously.
\r\nIf running in node,\r\nand the CommonJS require function is given the alias of an npm module which has not yet been installed,\r\nthe program shall install said module at runtime.
\r\n"await" calls shall be usable at the root level of the program,\r\noutside of async functions.
\r\nAs an example,\r\nobserve the following code:
\r\n\r\nvar puppeteer = require('puppeteer');\r\n\r\nvar browser = await puppeteer.launch();\r\nvar page = await browser.newPage();\r\n\r\nawait page.goto('https://www.npmjs.com/package/kaeon-united');\r\nawait page.screenshot({path: 'screenshot.png'});\r\n\r\nawait browser.close();\r\nThis code is a slightly modified version of the sample code provided on the puppeteer npm page.
\r\n\r\nIf one were to place it into a file called \"test.js\" located in an otherwise empty directory,\r\nwith puppeteer not installed either locally or globally,\r\nand were to execute the following command:
\r\n\r\nnpx kaeon-united js open test.js\r\nthen puppeteer,\r\nalong with several other dependencies,\r\nwould be automatically installed locally,\r\nand the program would proceed to run normally,\r\ndespite the awaits beings located outside of async functions.
\r\n\r\nAfter the program had finished running,\r\na screenshot of the Kaeon United npm page would appear in the directory from which the command was executed.
\r\n\r\nKaeon United is implemented as a single file,\r\nbut it's written in such a way that its functionality differs according to how it's referenced.
\r\n\r\nTo use Kaeon United as a script,\r\nreference it via jsDelivr or another similar service.
\r\n\r\nKaeon United can be accessed through jsDelivr on its npm repository via the following URL:
\r\n\r\nhttps://cdn.jsdelivr.net/npm/kaeon-united@1.0.88/KaeonUnited.jsAs a script,\r\nKaeon United shall provide access to the United JavaScript version of CommonJS in the browser.
\r\n\r\nKaeon United is available on npm under the alias "kaeon-united",\r\nand as such,\r\nit may be used as a command line utility via npx.
\r\n\r\nA Kaeon United CLI command follows this general format:
\r\n\r\nnpx kaeon-united [(1) operation] [(2*) \"open\" / \"read\"] [(3*) file / data] [(4*) export path / argument 1] [(5+*) argument 2+]An asterisk indicates that the argument may or may not be necessary depending on the operation
\r\n\r\nAll Kaeon United CLI commands operate on data which must either be imported from a file or specified literally.
\r\n\r\nThe first argument specifies which operation to perform.
\r\n\r\nThe second argument specifies whether the provided data will be imported from a file,\r\nin which case the argument shall be "open",\r\nor specified literally,\r\nin which case the argument shall be "read".
\r\n\r\nThe third argument shall either specify the path to the file from which to import the data if the second argument was "open",\r\nor shall specify the literal data if the second argument was "read".
\r\n\r\nIf a file path is specified,\r\nit may be in the form of a URL to a raw text file stored online.
\r\n\r\nThe fourth argument shall specify a file path to export any output of the operation to.
\r\n\r\nKaeon United operations are separated into the two categories,\r\nprocessor operations and translator operations.
\r\n\r\nProcessor operations,\r\neach of which are associated with a specific programming language,\r\nmay or may not have the second and third arguments,\r\nand the third argument may be followed by an indefinite number of other arguments.
\r\n\r\nIf arguments two and three are provided,\r\nthen they shall take the specified data and execute it as code in their respective language,\r\nwith any additional arguments passed to said code as command line arguments.\r\nIf arguments two and three are not provided,\r\nthen they shall open a REPL for their respective language.
\r\n\r\nTranslator operations,\r\neach of which are associated with two specific programming languages,\r\nan input language and an output language,\r\nmust have the second and third arguments,\r\nand may or may not use a fourth argument to specify an export path.
\r\n\r\nThey shall take the data specified by the second and third arguments as code in their respective input language and convert it to code in their respective output language.
\r\n\r\nIf the fourth argument is present,\r\nthey shall write the output to the file path specified by said argument,\r\nand if not,\r\nthey shall write the output to the console.
\r\n\r\nThe operations that Kaeon United supports are "js",\r\n"process",\r\n"parse",\r\n"preprocess",\r\n"ucc",\r\n"assemble",\r\nand "disassemble".
\r\n\r\nThe js operation is a processor operation for United JavaScript.
\r\n\r\nThe process operation is a processor operation for Kaeon FUSION.
\r\n\r\nThe parse operation is a translator operation where ONE+ is the input language and ONE is the output language.
\r\n\r\nThe preprocess operation is a translator operation where the Universal Preprocessor is the input language and raw text is the output language.
\r\n\r\nThe UCC operation is a translator operation where United C is the input language and C is the output language.
\r\n\r\nThe UCC operation should specify the input as a file path using "read".
\r\n\r\nThe UCC operation requires both gcc and make to be installed.
\r\n\r\nThe assemble operation is a translator operation where CSB is the input language and binary is the output language.
\r\n\r\nThe disassemble operation is a translator operation where binary is the input language and CSB is the output language.
\r\n\r\nThe disassemble operation should specify the input as a file path using "read".
\r\n\r\nIf using United JavaScript through Kaeon United's CDN,\r\nScript,\r\nor CLI modes,\r\nthen Kaeon United may be imported as a CommonJS style module through the KaeonUnited require function via the alias "Kaeon United" and "kaeon-united".
\r\n\r\nSaid module shall take the form of a function which,\r\nwhen called with a string argument,\r\nshall return a module from the Kaeon Utilities with an alias matching said argument.
\r\n\r\nCalling said function without a string argument shall return a JSON object specfying the aliases of all modules available through the function.\r\n\r\nFor example:
\r\n\r\nvar io = require(\"kaeon-united\")(\"io\");shall load the io module and store it in a variable called "io", and:
\r\n\r\nconsole.log(require(\"kaeon-united\")());shall print the aforementioned JSON object.
\r\n\r\nThe imported module may act also as a Kaeon FUSION interface,\r\nwhich shall load the most important Kaeon FUSION modules, including the standard module.
\r\n\r\nFor example:
\r\n\r\nUse: Kaeon United; Log Line: 'Hello, world!'shall log "Hello, world!" to the console.
\r\n\r\nFor any questions or comments, please email the following address: kaeon.ace@gmail.com
\r\n\r\nThe ability for Kaeon United to reference certain dependencies and utilities is dependent on a public CORS proxy.
","readmeFilename":"README.md","homepage":"https://gitlab.com/kaeon/kaeon-united/"}