te.js 1.2.0 → 1.2.1

package/example/targets/index.target.js

@@ -1,11 +1,10 @@
-import { Target } from 'te.js';
-
-const target = new Target();
-
-target.register('/hello', (ammo) => {
-  throw new Error('Error thrown to demonstrate robust error handling of te.js');
-  ammo.fire({
-    status: 200,
-    body: 'Hello, World!'
-  });
-});
+import { Target, listAllEndpoints } from 'te.js';
+
+const target = new Target();
+
+target.register('/', (ammo) => {
+  ammo.fire({
+    status: 200,
+    body: listAllEndpoints(true),
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "te.js",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "A nodejs framework",
   "type": "module",
   "main": "te.js",

package/server/targets/registry.js

@@ -1,44 +1,55 @@
-import isMiddlewareValid from './middleware-validator.js';
-
-class TargetRegistry {
-  constructor() {
-    if (TargetRegistry.instance) {
-      return TargetRegistry.instance;
-    }
-
-    TargetRegistry.instance = this;
-
-    // TODO - Add a default target
-    this.targets = [];
-    this.globalMiddlewares = [];
-  }
-
-  addGlobalMiddleware() {
-    if (!arguments) return;
-
-    const middlewares = [...arguments];
-    const validMiddlewares = middlewares.filter(isMiddlewareValid);
-    this.globalMiddlewares = this.globalMiddlewares.concat(validMiddlewares);
-  }
-
-  /**
-   * @param {Array || Object} targets
-   */
-  register(targets) {
-    if (Array.isArray(targets)) {
-      this.targets = this.targets.concat(targets);
-    } else {
-      this.targets.push(targets);
-    }
-  }
-
-  aim(method, endpoint) {
-    return this.targets.find((target) => {
-      return (
-        target.endpoint === endpoint
-      );
-    });
-  }
-}
-
-export default TargetRegistry;
+import isMiddlewareValid from './middleware-validator.js';
+
+class TargetRegistry {
+  constructor() {
+    if (TargetRegistry.instance) {
+      return TargetRegistry.instance;
+    }
+
+    TargetRegistry.instance = this;
+
+    // TODO - Add a default target
+    this.targets = [];
+    this.globalMiddlewares = [];
+  }
+
+  addGlobalMiddleware() {
+    if (!arguments) return;
+
+    const middlewares = [...arguments];
+    const validMiddlewares = middlewares.filter(isMiddlewareValid);
+    this.globalMiddlewares = this.globalMiddlewares.concat(validMiddlewares);
+  }
+
+  /**
+   * @param {Array || Object} targets
+   */
+  register(targets) {
+    if (Array.isArray(targets)) {
+      this.targets = this.targets.concat(targets);
+    } else {
+      this.targets.push(targets);
+    }
+  }
+
+  aim(method, endpoint) {
+    return this.targets.find((target) => {
+      return target.endpoint === endpoint;
+    });
+  }
+
+  getAllEndpoints(grouped) {
+    if (grouped) {
+      return this.targets.reduce((acc, target) => {
+        const group = target.endpoint.split('/')[1];
+        if (!acc[group]) acc[group] = [];
+        acc[group].push(target.endpoint);
+        return acc;
+      }, {});
+    } else {
+      return this.targets.map((target) => target.endpoint);
+    }
+  }
+}
+
+export default TargetRegistry;

package/te.js

@@ -1,129 +1,135 @@
-import { createServer } from 'node:http';
-
-import { env, setEnv } from 'tej-env';
-import TejLogger from 'tej-logger';
-import database from './database/index.js';
-
-import TargetRegistry from './server/targets/registry.js';
-
-import { loadConfigFile, standardizeObj } from './utils/configuration.js';
-
-import targetHandler from './server/handler.js';
-import { findTargetFiles } from './utils/auto-register.js';
-import { pathToFileURL } from 'node:url';
-
-const logger = new TejLogger('Tejas');
-const targetRegistry = new TargetRegistry();
-
-class Tejas {
-  /*
-   * Constructor for Tejas
-   * @param {Object} args - Arguments for Tejas
-   * @param {Number} args.port - Port to run Tejas on
-   * @param {Boolean} args.log.http_requests - Whether to log incoming HTTP requests
-   * @param {Boolean} args.log.exceptions - Whether to log exceptions
-   * @param {String} args.db.type - Database type. It can be 'mongodb', 'mysql', 'postgres', 'sqlite'
-   * @param {String} args.db.uri - Connection URI string for the database
-   */
-  constructor(args) {
-    if (Tejas.instance) return Tejas.instance;
-    Tejas.instance = this;
-
-    this.generateConfiguration(args);
-    this.registerTargetsDir();
-  }
-
-  /*
-   * Connect to a database
-   * @param {Object}
-   * @param {String} args.db - Database type. It can be 'mongodb', 'mysql', 'postgres', 'sqlite'
-   * @param {String} args.uri - Connection URI string for the database
-   * @param {Object} args.options - Options for the database connection
-   */
-  connectDatabase(args) {
-    const db = env('DB_TYPE');
-    const uri = env('DB_URI');
-
-    if (!db) return;
-    if (!uri) {
-      logger.error(
-        `Tejas could not connect to ${db} as it couldn't find a connection URI. See our documentation for more information.`,
-        false,
-      );
-      return;
-    }
-
-    const connect = database[db];
-    if (!connect) {
-      logger.error(
-        `Tejas could not connect to ${db} as it is not supported. See our documentation for more information.`,
-        false,
-      );
-      return;
-    }
-
-    connect(uri, {}, (error) => {
-      if (error) {
-        logger.error(
-          `Tejas could not connect to ${db}. Error: ${error}`,
-          false,
-        );
-        return;
-      }
-
-      logger.info(`Tejas connected to ${db} successfully.`);
-    });
-  }
-
-  generateConfiguration(options) {
-    const configVars = standardizeObj(loadConfigFile());
-    const envVars = standardizeObj(process.env);
-    const userVars = standardizeObj(options);
-
-    const config = { ...configVars, ...envVars, ...userVars };
-    for (const key in config) {
-      if (config.hasOwnProperty(key)) {
-        setEnv(key, config[key]);
-      }
-    }
-
-    // Load defaults
-    if (!env('PORT')) setEnv('PORT', 1403);
-  }
-
-  midair() {
-    if (!arguments) return;
-    targetRegistry.addGlobalMiddleware(...arguments);
-  }
-
-  registerTargetsDir() {
-    findTargetFiles().then((targetFiles) => {
-      if (targetFiles) {
-        for (const file of targetFiles) {
-          import(pathToFileURL(`${file.path}/${file.name}`));
-        }
-      }
-
-    }).catch((err) => {
-      logger.error(
-        `Tejas could not register target files. Error: ${err}`,
-        false,
-      );
-    });
-  }
-
-  takeoff() {
-    this.engine = createServer(targetHandler);
-    this.engine.listen(env('PORT'), () => {
-      logger.info(`Took off from port ${env('PORT')}`);
-      this.connectDatabase();
-    });
-  }
-}
-
-export {default as Target} from './server/target.js';
-export {default as TejFileUploader} from './server/files/uploader.js';
-export default Tejas;
-
-// TODO Ability to register a target (route) from tejas instance
-// TODO tejas as CLI tool
+import { createServer } from 'node:http';
+
+import { env, setEnv } from 'tej-env';
+import TejLogger from 'tej-logger';
+import database from './database/index.js';
+
+import TargetRegistry from './server/targets/registry.js';
+
+import { loadConfigFile, standardizeObj } from './utils/configuration.js';
+
+import targetHandler from './server/handler.js';
+import { findTargetFiles } from './utils/auto-register.js';
+import { pathToFileURL } from 'node:url';
+
+const logger = new TejLogger('Tejas');
+const targetRegistry = new TargetRegistry();
+
+class Tejas {
+  /*
+   * Constructor for Tejas
+   * @param {Object} args - Arguments for Tejas
+   * @param {Number} args.port - Port to run Tejas on
+   * @param {Boolean} args.log.http_requests - Whether to log incoming HTTP requests
+   * @param {Boolean} args.log.exceptions - Whether to log exceptions
+   * @param {String} args.db.type - Database type. It can be 'mongodb', 'mysql', 'postgres', 'sqlite'
+   * @param {String} args.db.uri - Connection URI string for the database
+   */
+  constructor(args) {
+    if (Tejas.instance) return Tejas.instance;
+    Tejas.instance = this;
+
+    this.generateConfiguration(args);
+    this.registerTargetsDir();
+  }
+
+  /*
+   * Connect to a database
+   * @param {Object}
+   * @param {String} args.db - Database type. It can be 'mongodb', 'mysql', 'postgres', 'sqlite'
+   * @param {String} args.uri - Connection URI string for the database
+   * @param {Object} args.options - Options for the database connection
+   */
+  connectDatabase(args) {
+    const db = env('DB_TYPE');
+    const uri = env('DB_URI');
+
+    if (!db) return;
+    if (!uri) {
+      logger.error(
+        `Tejas could not connect to ${db} as it couldn't find a connection URI. See our documentation for more information.`,
+        false,
+      );
+      return;
+    }
+
+    const connect = database[db];
+    if (!connect) {
+      logger.error(
+        `Tejas could not connect to ${db} as it is not supported. See our documentation for more information.`,
+        false,
+      );
+      return;
+    }
+
+    connect(uri, {}, (error) => {
+      if (error) {
+        logger.error(
+          `Tejas could not connect to ${db}. Error: ${error}`,
+          false,
+        );
+        return;
+      }
+
+      logger.info(`Tejas connected to ${db} successfully.`);
+    });
+  }
+
+  generateConfiguration(options) {
+    const configVars = standardizeObj(loadConfigFile());
+    const envVars = standardizeObj(process.env);
+    const userVars = standardizeObj(options);
+
+    const config = { ...configVars, ...envVars, ...userVars };
+    for (const key in config) {
+      if (config.hasOwnProperty(key)) {
+        setEnv(key, config[key]);
+      }
+    }
+
+    // Load defaults
+    if (!env('PORT')) setEnv('PORT', 1403);
+  }
+
+  midair() {
+    if (!arguments) return;
+    targetRegistry.addGlobalMiddleware(...arguments);
+  }
+
+  registerTargetsDir() {
+    findTargetFiles()
+      .then((targetFiles) => {
+        if (targetFiles) {
+          for (const file of targetFiles) {
+            import(pathToFileURL(`${file.path}/${file.name}`));
+          }
+        }
+      })
+      .catch((err) => {
+        logger.error(
+          `Tejas could not register target files. Error: ${err}`,
+          false,
+        );
+      });
+  }
+
+  takeoff() {
+    this.engine = createServer(targetHandler);
+    this.engine.listen(env('PORT'), () => {
+      logger.info(`Took off from port ${env('PORT')}`);
+      this.connectDatabase();
+    });
+  }
+}
+
+const listAllEndpoints = (grouped = false) => {
+  return targetRegistry.getAllEndpoints(grouped);
+};
+
+export { default as Target } from './server/target.js';
+export { default as TejFileUploader } from './server/files/uploader.js';
+export { listAllEndpoints };
+export default Tejas;
+
+// TODO Ability to register a target (route) from tejas instance
+// TODO tejas as CLI tool