miqro 6.3.0 → 7.0.1

package/src/common/assets.ts

@@ -1,128 +0,0 @@
-//import { createRequire } from 'node:module';
-import { Logger, MinimalLogger } from "@miqro/core";
-import { chmodSync, constants, existsSync, mkdirSync, readFileSync, unlinkSync, writeFileSync } from "node:fs";
-import { getAsset as seaGetAsset, isSea } from "node:sea";
-import { dirname, resolve } from "node:path";
-import { calculateChecksum, calculateChecksumFromBuffer } from "./checksum.js";
-import { arch, cwd, platform } from "node:process";
-import { fileURLToPath } from 'node:url';
-import { initESBuild } from "./esbuild.js";
-import { initJSXJS } from "./jsx.js";
-//const require = createRequire(import.meta.url);
-
-export const __package_dirname = import.meta.url ? resolve(dirname(fileURLToPath(import.meta.url)), "..", "..", "..", "..") : null;
-
-const ASSETS_ROUTER = {
-  "lib.cjs": "build/lib.cjs",
-  "version.tag": "sea/version.tag",
-  "node.version.tag": "sea/node.version.tag",
-  "esbuild.version.tag": "sea/esbuild.version.tag",
-  "postject.base64.cjs": "build/postject.base64.cjs",
-  "sea.basic.config.json": "sea/basic-config.json",
-  "node.sh": "sea/node.sh",
-  "install-nodejs.sh": "sea/install-nodejs.sh",
-  "compile.base64.sh": "sea/basic-compile.base64.sh",
-  "sign-remove.sh": "sea/sign-remove.sh",
-  "sign-add.sh": "sea/sign-add.sh",
-  "app.sh": "sea/app.sh",
-  "jsx.dom.js": "build/jsx.dom.js",
-  "types.json": "sea/types.json",
-  "editor-assets/editor.bundle.js": "build/editor.bundle.js",
-  "editor-assets/style.css": "build/style.css",
-  "editor-assets/font.ttf": "build/font.ttf"
-}
-
-export function getAsset(key: string): ArrayBuffer {
-  if (isSea()) {
-    return seaGetAsset(key);
-  } else {
-    if (!ASSETS_ROUTER[key]) {
-      if (key === "esbuild-binary") {
-        if (__package_dirname === null) {
-          return readFileSync(resolve(`./sea/esbuild`));
-        } else {
-          //return readFileSync(resolve(__package_dirname, `./node_modules/@esbuild/${platform}-${arch}/bin/esbuild`));
-          const esBinaryPath = resolve(dirname(import.meta.resolve(`esbuild`).substring("file://".length)), "..", "..", "@esbuild", `${platform}-${arch}`);
-          return readFileSync(resolve(esBinaryPath, "bin", "esbuild"));
-        }
-      } else {
-        throw new Error("asset not registered!");
-      }
-    }
-    return readFileSync(resolve(__package_dirname, ASSETS_ROUTER[key]));
-  }
-}
-
-export function getVersion() {
-  const VERSION = !isSea() ? "" : Buffer.from(getAsset("version.tag")).toString().trim();
-  const NODE_VERSION = !isSea() ? "" : Buffer.from(getAsset("node.version.tag")).toString().trim();
-  const ESBUILD_VERSION = !isSea() ? "" : Buffer.from(getAsset("esbuild.version.tag")).toString().trim();
-  return {
-    VERSION,
-    NODE_VERSION,
-    ESBUILD_VERSION
-  }
-}
-
-export async function initAssets(logger: Logger) {
-  const { VERSION, NODE_VERSION, ESBUILD_VERSION } = getVersion();
-  if (isSea()) {
-    logger.debug("version [%s]", VERSION);
-    logger.debug("Node.js version [%s]", NODE_VERSION);
-    logger.debug("esbuild version [%s]", ESBUILD_VERSION);
-  }
-  logger.debug("platform [%s-%s]", platform, arch);
-  await Promise.all([initJSXJS(logger), initESBuild(logger)]);
-}
-
-export async function initTypes(logger: MinimalLogger) {
-  const typesJSON = JSON.parse(Buffer.from(getAsset("types.json")).toString("utf-8"));
-  await Promise.all(Object.keys(typesJSON).map(typeFile =>
-    initAsset(logger, resolve(cwd(), "." + typeFile), Buffer.from(typesJSON[typeFile], "base64"))
-  ));
-}
-
-export async function validateAsset(logger: MinimalLogger | undefined, path: string, internalChecksum: string): Promise<boolean> {
-  mkdirSync(dirname(path), {
-    recursive: true
-  });
-  if (existsSync(path)) {
-    logger?.trace("validating [%s]", path);
-    const checksum = await calculateChecksum(path);
-    //const internalChecksum = await calculateChecksumFromBuffer(buffer);
-    if (internalChecksum !== checksum) {
-      logger?.trace("invalid [%s] checksum", path);
-      return false;
-    } else {
-      logger?.trace("validated [%s]", path);
-      return true;
-    }
-  } else {
-    logger?.trace("invalid [%s] doesnt exists", path);
-    return false;
-  }
-}
-
-export async function initAsset(logger: MinimalLogger, path: string, buffer: Buffer, executable?: boolean, checksum?: Promise<string>, logInstallasInfo = true) {
-  const valid = await validateAsset(logger, path, checksum === undefined ? await calculateChecksumFromBuffer(buffer) : await checksum);
-  if (existsSync(path)) {
-    if (!valid) {
-      logger.info("updating [%s]", path);
-      unlinkSync(path);
-      writeFileSync(path, buffer);
-      if (executable) {
-        chmodSync(path, constants.S_IXUSR | constants.S_IRUSR | constants.S_IWUSR);
-      }
-    }
-  } else {
-    if (!logInstallasInfo) {
-      logger.debug("installing [%s]", path);
-    } else {
-      logger.info("installing [%s]", path);
-    }
-    writeFileSync(path, buffer);
-    if (executable) {
-      chmodSync(path, constants.S_IXUSR | constants.S_IRUSR | constants.S_IWUSR);
-    }
-  }
-}

package/src/common/checksum.ts

@@ -1,58 +0,0 @@
-import { createHash } from "node:crypto";
-import { createReadStream } from "node:fs";
-import { Readable } from "node:stream";
-
-/**
- * 
- * @param {string} filePath 
- * @returns {Promise<string>} the checksum
- */
-export async function calculateChecksum(filePath: string): Promise<string> {
-  return calculateChecksumFromStream(createReadStream(filePath));
-}
-
-/**
- * 
- * @param {string} filePath 
- * @returns {Promise<string>} the checksum
- */
-export async function calculateChecksumFromStream(input: Readable): Promise<string> {
-  return new Promise<string>((resolve, reject) => {
-    try {
-      const hash = createHash('sha256');
-      input.on('readable', () => {
-        // Only one element is going to be produced by the
-        // hash stream.
-        const data = input.read();
-        if (data)
-          hash.update(data);
-        else {
-          //log(`${hash.digest('hex')} ${filename}`);
-          resolve(hash.digest('hex').toString());
-        }
-      });
-      input.on("error", (e) => {
-        reject(e);
-      });
-    } catch (e) {
-      reject(e);
-    }
-  });
-}
-
-/**
- * 
- * @param {string} filePath 
- * @returns {Promise<string>} the checksum
- */
-export async function calculateChecksumFromBuffer(buffer: Buffer): Promise<string> {
-  return new Promise<string>((resolve, reject) => {
-    try {
-      const hash = createHash('sha256');
-      hash.update(buffer);
-      resolve(hash.digest('hex').toString());
-    } catch (e) {
-      reject(e);
-    }
-  });
-}

package/src/common/constants.ts

@@ -1,18 +0,0 @@
-export const EXIT_CODES = {
-  BAD_ARGUMENTS: 10,
-  NORMAL_EXIT: 0,
-  GLOBALS_ALTERED: 80,
-  ABNORMAL: 98,
-  ABNORMAL_UNCONTROLLED: 99,
-  TEST_FAILED: 30,
-}
-
-export const CLEAR_JSX_CACHE = (process.env["CLEAR_JSX_CACHE"] !== undefined ? process.env["CLEAR_JSX_CACHE"] : "1") === "1";
-
-export const EDITOR_CONFIG_KEY = "$$editor$$";
-
-export const HOT_RELOAD_PATH = "/hot-reload";
-
-//export const SERVER_IDENTIFIER = cluster.isPrimary ? "SERVER" : process.env["CLUSTER_NODE_NUMBER"] ? `WORKER_${process.env["CLUSTER_NODE_NUMBER"]}` : "WORKER";
-
-//export const DB_IDENTIFIER = cluster.isPrimary ? "DATABASE" : process.env["CLUSTER_NODE_NUMBER"] ? `WORKER_${process.env["CLUSTER_NODE_NUMBER"]}_DATABASE` : "WORKER_DATABASE";

package/src/common/content-type.ts

@@ -1,84 +0,0 @@
-export const DEFAULT_CONTENT_TYPE = "application/octet-stream";
-
-export const CONTENT_TYPE_MAP: {
-  [key: string]: string | undefined;
-} = {
-  ".aac": "audio/aac",
-  ".abw": "application/x-abiword",
-  ".arc": "application/x-freearc",
-  ".avif": "image/avif",
-  ".avi": "video/x-msvideo",
-  ".azw": "application/vnd.amazon.ebook",
-  ".bin": "application/octet-stream",
-  ".bmp": "image/bmp",
-  ".bz": "application/x-bzip",
-  ".bz2": "application/x-bzip2",
-  ".cda": "application/x-cdf",
-  ".csh": "application/x-csh",
-  ".css": "text/css",
-  ".csv": "text/csv",
-  ".doc": "application/msword",
-  ".docx": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
-  ".eot": "application/vnd.ms-fontobject",
-  ".epub": "application/epub+zip",
-  ".gz": "application/gzip",
-  ".gif": "image/gif",
-  ".htm": "text/html",
-  ".html": "text/html",
-  ".ico": "image/vnd.microsoft.icon",
-  ".ics": "text/calendar",
-  ".jar": "application/java-archive",
-  ".jpeg": "image/jpeg",
-  ".jpg": "image/jpeg",
-  ".js": "text/javascript",
-  ".json": "application/json",
-  ".jsonld": "application/ld+json",
-  ".mid": "audio/midi audio/x-midi",
-  ".midi": "audio/midi audio/x-midi",
-  ".mjs": "text/javascript",
-  ".mp3": "audio/mpeg",
-  ".mp4": "video/mp4",
-  ".mpeg": "video/mpeg",
-  ".mpkg": "application/vnd.apple.installer+xml",
-  ".odp": "application/vnd.oasis.opendocument.presentation",
-  ".ods": "application/vnd.oasis.opendocument.spreadsheet",
-  ".odt": "application/vnd.oasis.opendocument.text",
-  ".oga": "audio/ogg",
-  ".ogv": "video/ogg",
-  ".ogx": "application/ogg",
-  ".opus": "audio/opus",
-  ".otf": "font/otf",
-  ".png": "image/png",
-  ".pdf": "application/pdf",
-  ".php": "application/x-httpd-php",
-  ".ppt": "application/vnd.ms-powerpoint",
-  ".pptx": "application/vnd.openxmlformats-officedocument.presentationml.presentation",
-  ".rar": "application/vnd.rar",
-  ".rtf": "application/rtf",
-  ".sh": "application/x-sh",
-  ".svg": "image/svg+xml",
-  ".swf": "application/x-shockwave-flash",
-  ".tar": "application/x-tar",
-  ".tif": "image/tiff",
-  ".tiff": "image/tiff",
-  ".ts": "video/mp2t",
-  ".ttf": "font/ttf",
-  ".txt": "text/plain",
-  ".vsd": "application/vnd.visio",
-  ".wav": "audio/wav",
-  ".weba": "audio/webm",
-  ".webm": "video/webm",
-  ".webp": "image/webp",
-  ".md": "text/markdown",
-  ".woff": "font/woff",
-  ".woff2": "font/woff2",
-  ".xhtml": "application/xhtml+xml",
-  ".xls": "application/vnd.ms-excel",
-  ".xlsx": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
-  ".xml": "application/xml",
-  ".xul": "application/vnd.mozilla.xul+xml",
-  ".zip": "application/zip",
-  ".3gp": "video/3gpp; audio/3gpp",
-  ".3g2": "video/3gpp2; audio/3gpp2",
-  ".7z": "application/x-7z-compressed"
-};

package/src/common/esbuild.ts

@@ -1,94 +0,0 @@
-import { exec } from "node:child_process";
-import { getAsset, initAsset, validateAsset } from "./assets.js";
-import { Logger } from "@miqro/core";
-import { getESBuildBinaryPath } from "./paths.js";
-import { dirname } from "node:path";
-import { calculateChecksumFromBuffer } from "./checksum.js";
-
-let esbuildBinaryBuffer = null; // Buffer.from(getAsset("esbuild-binary"));
-let esbuildBinaryChecksumPromise = null; // calculateChecksumFromBuffer(esbuildBinaryBuffer);
-
-export async function validateESBuild(logger?: Logger) {
-  return validateAsset(logger, getESBuildBinaryPath(), await esbuildBinaryChecksumPromise);
-}
-
-export async function initESBuild(logger: Logger) {
-  esbuildBinaryBuffer = esbuildBinaryBuffer ? esbuildBinaryBuffer : Buffer.from(getAsset("esbuild-binary"));
-  esbuildBinaryChecksumPromise = esbuildBinaryChecksumPromise ? esbuildBinaryChecksumPromise : calculateChecksumFromBuffer(esbuildBinaryBuffer);
-  return initAsset(logger, getESBuildBinaryPath(), esbuildBinaryBuffer, true, esbuildBinaryChecksumPromise, false);
-}
-
-const NODEJS_EXTERNAL = [
-  "node:cluster",
-  "node:assert",
-  "node:util",
-  "node:path",
-  "node:fs",
-  "node:crypto",
-  "node:http",
-  "node:https",
-  "node:os",
-  "node:dns",
-  "node:string_decoder",
-  "node:stream",
-  "node:http2",
-  "node:net",
-  "node:worker_threads",
-  "node:process",
-  "child_process",
-  "node:child_process",
-  "core",
-  "globals",
-  "jsx.globals",
-  "server.globals",
-  "browser.globals",
-  "sqlite3",
-  "pg"
-];
-
-export async function esBuild(options: {
-  platform?: string;
-  entryPoints: [string];
-  bundle?: boolean;
-  jsxFactory?: string;
-  jsxFragment?: string;
-  minify?: boolean;
-  outfile?: string;
-}, logger?: Logger): Promise<{
-  outputFiles: {
-    path: string;
-    contents: any;
-  }[]
-}> {
-  return new Promise(async (resolve, reject) => {
-    try {
-      //const logger = getLogger(`${SERVER_IDENTIFIER}_ESBUILD`);
-      const valid = await validateESBuild(logger);
-      const esBuildCMD = `${getESBuildBinaryPath()} "${options.entryPoints[0]}" ${NODEJS_EXTERNAL.map(e => `--external:${e}`).join(" ")} --loader:.js=jsx --jsx-factory=${options.jsxFactory} --jsx-fragment=${options.jsxFragment} ${options.bundle ? " --bundle" : ""}${options.minify ? " --minify" : ""}${options.outfile ? ` --outfile="${options.outfile}"` : ""}${options.platform ? ` --platform=${options.platform}` : ""}`;
-      logger?.trace(esBuildCMD);
-      if (!valid) {
-        const err = new Error(`esbuild installation at [${getESBuildBinaryPath()}] tampered`);
-        reject(err);
-      } else {
-        exec(esBuildCMD, {
-          maxBuffer: 1024 * 1000 * 2000,
-          cwd: dirname(options.entryPoints[0])
-        }, (err, stdout, _stderr) => {
-          if (err) {
-            reject(err);
-          } else {
-            resolve({
-              outputFiles: [{
-                path: "",
-                contents: stdout
-              }]
-            });
-          }
-        });
-      }
-    } catch (e) {
-      logger?.error(e);
-      reject(e);
-    }
-  });
-}

package/src/common/exit.ts

@@ -1,91 +0,0 @@
-import { existsSync, rmdirSync, unlinkSync } from "node:fs";
-//import { notifiyServerStop, notifiyServerUnLoad } from "../services/server.js";
-import { getESBuildBinaryPath, getJSXJSPath, JSX_TMP_DIR } from "./paths.js";
-import { CLEAR_JSX_CACHE } from "./constants.js";
-import { resolve } from "node:path";
-import { EXIT_CODES } from "./constants.js";
-import { Miqro } from "../services/app.js";
-
-function cleanJSX(app: Miqro) {
-  app.logger?.trace("trying to clean up esbuild installation at [%s]", getESBuildBinaryPath());
-  if (existsSync(getESBuildBinaryPath())) {
-    unlinkSync(getESBuildBinaryPath());
-  }
-  if (CLEAR_JSX_CACHE) {
-    app.logger?.trace("trying to clean up jsx.js installation at [%s]", getJSXJSPath());
-    if (existsSync(getJSXJSPath())) {
-      unlinkSync(getJSXJSPath());
-    }
-    const buildParendDir = resolve(JSX_TMP_DIR, String(process.pid));
-    app.logger?.trace("trying to clean up jsx build/import folders at [%s]", buildParendDir);
-    const buildDir = resolve(buildParendDir, "build");
-    const importDir = resolve(buildParendDir, "import");
-    if (existsSync(buildDir)) {
-      rmdirSync(buildDir);
-    }
-    if (existsSync(importDir)) {
-      rmdirSync(importDir);
-    }
-    if (existsSync(buildParendDir)) {
-      rmdirSync(buildParendDir);
-    }
-  }
-}
-
-export function setupExitHandlers(app: Miqro) {
-  let exceptionOccured = false;
-
-  process.on('uncaughtException', async function (err) {
-    app.logger?.error('Caught exception: ' + err);
-    app.logger?.error(err);
-    exceptionOccured = true;
-    /*if (app.server) {
-      notifiyServerConfigSync(app, "unload");
-      notifiyServerConfigSync(app, "stop");
-      app.webSocketManager.disconnectAll();
-      app.dbManager.closeAll();
-    }*/
-    cleanJSX(app);
-    if (app.server) {
-      app.stop();
-    }
-    process.exit(EXIT_CODES.ABNORMAL_UNCONTROLLED);
-  });
-
-  process.on('exit', async function (code) {
-    if (exceptionOccured) {
-      app.logger?.error('Exception occured');
-    } else {
-      /*if (app.server) {
-        notifiyServerConfigSync(app, "unload");
-        notifiyServerConfigSync(app, "stop");
-        app.webSocketManager.disconnectAll();
-        app.dbManager.closeAll();
-      }*/
-      cleanJSX(app);
-      if (app.server) {
-        app.stop();
-      }
-    }
-  });
-
-  process.on("SIGTERM", function () {
-    app.logger?.info('SIGTERM received');
-    process.exit(EXIT_CODES.ABNORMAL_UNCONTROLLED);
-  });
-
-  process.on('SIGHUP', function () {
-    app.logger?.info('SIGHUP received');
-    process.exit(EXIT_CODES.ABNORMAL_UNCONTROLLED);
-  });
-
-  /*process.on('SIGKILL', function () {
-    server.logger.info('SIGKILL received');
-    process.exit(EXIT_CODES.ABNORMAL_UNCONTROLLED);
-  });*/
-
-  process.on('SIGINT', function () {
-    app.logger?.info('SIGINT received');
-    process.exit(EXIT_CODES.ABNORMAL_UNCONTROLLED);
-  });
-}

package/src/common/fs.ts

@@ -1,82 +0,0 @@
-import { mkdir, rmdir, unlink, writeFile } from "node:fs";
-import { basename, extname } from "node:path";
-
-export function describeFilePath(filePath: string) {
-  const ext = extname(filePath);
-  const fileName = basename(filePath);
-  const name = fileName.substring(0, fileName.length - ext.length);
-  const subExt = extname(name);
-  const subName = name.substring(0, name.length - subExt.length);
-  return {
-    ext,
-    fileName,
-    name,
-    subExt,
-    subName,
-    filePath
-  };
-}
-
-export async function mkdirASync(path: string, options?: Partial<{ recursive: true; }>) {
-  return new Promise<void>((resolve, reject) => {
-    try {
-      mkdir(path, options, (err) => {
-        if (err) {
-          reject(err);
-        } else {
-          resolve();
-        }
-      });
-    } catch (e) {
-      reject(e);
-    }
-  })
-}
-
-export async function writeFileASync(path: string, body?) {
-  return new Promise<void>((resolve, reject) => {
-    try {
-      writeFile(path, body, (err) => {
-        if (err) {
-          reject(err);
-        } else {
-          resolve();
-        }
-      });
-    } catch (e) {
-      reject(e);
-    }
-  });
-}
-
-export async function rmdirASync(path: string) {
-  return new Promise<void>((resolve, reject) => {
-    try {
-      rmdir(path, (err) => {
-        if (err) {
-          reject(err);
-        } else {
-          resolve();
-        }
-      });
-    } catch (e) {
-      reject(e);
-    }
-  });
-}
-
-export async function unlinkASync(path: string) {
-  return new Promise<void>((resolve, reject) => {
-    try {
-      unlink(path, (err) => {
-        if (err) {
-          reject(err);
-        } else {
-          resolve();
-        }
-      });
-    } catch (e) {
-      reject(e);
-    }
-  });
-}

package/src/common/help.ts

@@ -1,61 +0,0 @@
-//import { basename } from "node:path";
-
-export const BIN_NAME = "miqro"; //,basename(process.argv[0]);
-
-export const usage = `usage: ${BIN_NAME} [...FLAGS] --service app/
-
-==examples==
-
-${BIN_NAME} --watch --service front/
-PORT=8181 ${BIN_NAME} --service api/ --service front/
-${BIN_NAME} --test --service front/
-${BIN_NAME} --inflate --service front/
-${BIN_NAME} --generate-doc --generate-doc-out API.md --service front/
-CLUSTER_COUNT=10 ${BIN_NAME}-cluster --service api/`;
-
-export const help = `
-==flags==
-
--v, --version\n\toutputs the version number
--h, --help\n\toutputs this page.
---watch\n\tuse to auto reload the server when files change.
---hot-reload\n\tenables the hot-reload functionality use with --watch.
---test\n\trun the tests for a service.
---migrate-up\n\tmigrations up.
---migrate-down\n\tmigrations down.
---inflate\n\tinflates the application.
---inflate-dir\n\tto set the output directory of the --inflate command. default value is inflated/.
---editor\n\truns the application with a built-in editor.
---generate-doc\n\tgenerates a documentation for the api endpoints of the service.
---generate-doc-out\n\tthe output file for the generated documentation. default value is API.md.
---generate-doc-type\n\tthe format of the generated documentation. it can be JSON or MD. default value is MD.
---generate-doc-all\n\toutputs all the server routes in the documentation output.
---compile\n\tinflates the application and tries to create a NODE SEA binary.
---inflate-sea\n\tinflates the application with sea compilation scripts.
---install-tsconfig\n\tcreates a tsconfig.json configured to use with --install-types.
---install-types\n\tcreates and updates the .types/ folder use together with --install-tsconfig.
---install-miqrojson\n\tcreates a default miqro.json file.
---disable-miqrojson\n\tdisables the load of miqro.json file.
---log-file\n\toverrides the default log file from LOG_FILE.
---browser\n\toverrides the default browser from BROWSER.
---config\n\toverrides the default miqro.json path.
---port\n\toverrides the default port from PORT.
---name\n\toverrides the default name of the server.
---https\n\tserves the server in https instead of http
---https-key\n\tpoint to a server.key file for https.
---https-cert\n\tpoint to a server.cert file for https.
---https-redirect\n\tserves an aditional http server that redirects to https. it needs a port number.
---inflate-parallel\n\tsets the max parallel esbuild instances. defaults to 1.
-
-==environment variables==
-
-PORT\n\toverride the default 8080 port.
-BROWSER\n\toverride the default browser. change to none to disable.".
-LOG_FILE\n\toverride the default ./server.log file
-DB\n\tenable the server.db features
-DB_STORAGE\n\toverride the default local db location ./db.sqlite3
-DB_DIALECT\n\toverride the default node:sqlite
-DB_CONNECTION\n\toverride the default connection url
-CLEAR_JSX_CACHE\n\tset to 1 or 0 to enable or disable the clearing of the esbuild cache defaults to 1.
-JSX_TMP\n\tset custom location of esbuild builds defaults to /tmp/jsx_tmp.
-`;