@axonlabs/core

Axon.js

like the brain's powerful neural pathways, simple yet strong. 🧠

Axon is a backend library that aims to be simple and powerfull.

Currently Axon is 2X faster than Express. :D please checkout Axon Benchmarks

Latest change: (v0.12.0)

Dependency injection Axon's new feature is dependency injection for class methods and controller functions. support for class constructor and middlewar;es will add soon. How to use:

// class instance
core.registerDependency("dependencyName", new DependencyClass(arg1, arg2));

// class without instance (core will make instance automatically)
core.registerDependency("dependencyName2", DependencyClass);

// function
core.registerDependency("dependencyName3", dependencyFunction);

// Also you can register dependencies with name aliases
core.registerDependency(["depClass", "classDep", "DB"], new DependencyClass());

Use you dependency in controller

// When you want to use dependencies, make sure you enter exact dependency name or alias
// in 3rd argument of controller method or function into the object.
interface IDependencies {
    DB: DependencyClass;
    dependencyName3: (...args: any[]) => any
}

class UserController extends BaseController {
    async index(req: Request<any>, res: Response, { DB, dependencyName3 }: IDependencies) {
        const result = dependencyName3();
        const db = DB.get();
    }
}

// Or functional controller:
const getUsers = async (
    req: Request<any>,
    res: Response, 
    { DB, dependencyName3 }: IDependencies
) => {
    const result = dependencyName3();
    const db = DB.get();
}

router.get("/users/class", [UserController, "index"]);
router.get("/users/function", getUsers);

Past changes:

(v0.11.0)

Class-Based Controllers You can use the new generation of controllers in Axon. In class-based controllers you can use state managing of classes in your application without any instance making. More organized controllers!

class UsersController extends BaseController {
    async index(req: Request<any>, res: Response) {
        return res.status(200).body({});
    }
}

// [Class, Method]
router.get("/users", [UsersController, "index"]);

Your controller class must extends from BaseController, Otherwise the router will throw error.

class UsersController {
    async index(req: Request<any>, res: Response) {
        return res.status(200).body({});
    }
}

router.get("/users", [UsersController, "index"]);

// Error: Controller class must extends from BaseController

(v0.10.0)

Cookie manager added to Axon. You can access cookie manager by importing AxonCookie class in your code. AxonCookie has some static methods for managing cookies easily. Example:
```
import { AxonCookie } from "@axonlabs/core";

AxonCookie.set(res, name, value, options);
AxonCookie.parse(req);
AxonCookie.clear(res, name, options);
```

(v0.9.0)

Plugin system updated.
Project environment state added to core config.
Validation system added to router.

Warning

@mr-mkz/axon deprecated and transferred to @axonlabs/core

Installation 📥

Install Axon.js with npm

  npm install @axonlabs/core

Benchmarks 🧪

You can checkout Axon benchmarks document and results from below link.

Axon Benchmarks

Badges 📛

Features 💡

Simple routing system
Support methods: GET, POST, PUT, PATCH, DELETE, OPTIONS.
Flexible routing system. (You can define routes in another files and then add them to core)
Default core logger
Configurable core
Plugin manager (You can create your own plugins and use them in other projects)
Controllers and Middlewares
Default cors configuration method
Support https server
Auto validation handler (Yup, Zod, Joi)

More features soon...

Roadmap (still thinking) 🚦

Response meta generator.
Auto error detector (maybe)
Default schemas.
Default database connection methods.
Improve plugin system
- Core versioning
- Plugin dependencies
Improve AxonCore
- Cleaner code

Documentation 📚

Currently Axon has a main core and a router class which you can make instance from router class every where you want and then gave the router instance to core to load routes.

More complete examples:

Router 🧭

Methods

Router is stil under constructing and it's not a stable version yet but currently it support this methods:

GET
POST
PUT
PATCH
DELETE
OPTIONS

Validation system

One on the new features of Axon Router is auto validation system. This feature works with Joi, Yup and Zod schema to create validation middlewares automatically without any additional code. Target of this system is speeding up programmers and also using validation systems in middleware instead of controller to prevent additional requests and code in controller.

const authFormSchema = Joi.object({
    username: Joi.string().min(3).required(),
    age: Joi.number().integer().min(0).required()
});

// You can register your validation schema with your options for any target and then
// register it to route after controller
// Also you can write this code directly in route function but it's not really clean.
const validation: ValidationObj[] = [
    {
        schema: authFormSchema, // must be schema of yup, joi or zod
        options: { // must be options of yup, joi or zod based on your schema
            abortEarly: false
        } as Joi.ValidationOptions,
        target: "body" // your validation schema target (body, params, query)
    }
];

Registering validations:

router.post("/users/login", controller, validation);
// or
router.post("/users/login", controller, [
    {
        // your validation config
    }
]);

Router usage example

You can access and create routes with just a few steps.

creating a variable with a optional name and put Router() function in it.

define your routes with methods which you want and controller.

  // route prefix is optional
  const router = Router('prefix'); // easier and newer method
  // or
  // const router = new AxonRouter('prefix');

  const validation: ValidationObj[] = [
      {
          schema: authFormSchema,
          options: {
              abortEarly: false
          } as Joi.ValidationOptions,
          target: "body"
      }
  ];

  router.get(path, controller(req, res), validation);

load your routes in core with loadRoute() function;

  const core = Axon(); // easier and newer method
  // or
  // const core = new AxonCore();

  core.loadRoute(router);

Done, you created your routes successfully :D

Controller 🛂

you have to pass your controller to your route, compute and do your jobs in controller and when you want to response to user (each response, error and success) you must return res with some options which example and description for each option is below.

res.{option}

Options:

status: This option must set to get access to other options. (you can use each option just once)
message: This option will set the response message for example response message of status 200 is OK.
setHeader: You can set header with this option and also you can use this option many times.
body: This option will end request and send response to user so you must use this as last option

Example:

const controller = async (req, res) => {
    return res.status(200).body({
        message: "Hello, World"
    })
}

Middleware 🚓

middleware is a function which runs before running controller for validations or some actions like this and you can use it in two ways.

adding a middleware for special route
- Example:
```
    router.get('/', controller).middleware(async (req, res, next) => next(), timeout = 2000, critical = true);
```
  you can also use multiple middlewares for a route by repeating middleware function and middlewares will run in order.
loading middleware as a global middleware in Axon core.
- Example:
```
    core.globalMiddleware(async (req, res, next) => next(), timeout = 2000, critical = true);
```
  you can also use multiple middlewares in this way by adding middleware functions into an array (suggested method) or repeating this line of code.

Middlewares support a timeout when the process takes too long. You can set a global timeout in the config using a specific key MIDDLEWARE_TIMEOUT. When you set critical to true, the middleware is marked as critical; if encounters an error or returns a timeout error, the request chain will break, resulting in an internal server error (500) sent to the client, and the request will closeAdditionally, the error will be logged in the console. If the middleware is non-critical (false), the core will skip it and continue processing the response to the client, logging a warning in the console afterward.

Types

AxonJs has some types which can help you in developing your applications for auto suggestions of your code editor.

Types detect automatically in Typescript but you need to set types for IDE suggestions in Javascript (Javascript Example).

AxonCoreConfig: Type of core config object for configuration Axon core as you want.
AxonResponseMessage: Type of core config option RESPONSE_MESSAGES.
AxonCorsConfig: Type of core config option CORS.
AxonHttpsConfig: Type of core config option HTTPS.
Request<Params>: Type of controller request param. (IncomingMessage)
Response: Type of controller response param. (ServerResponse)
Headers: Type of response headers. (OutgoingHeaders)
NextFunc: Type of next function param in middleware.
Controller: Type of controller function.
Middleware: Type of middleware function.
HttpMethods: Type of router http methods.
RouterExceptionError: Type of router exceptions.
ValidationObj: Required object for router auto validation process.
ValidationConfig: Config type of AxonValidator. (including joi, yup and zod config options)
ValidationSchema: Schema type of AxonValidator.
ValidationTargets: Target list of AxonValidator.

Axon Core logger (pino & pino-pretty)

AxonJs use pino and pino-pretty for it's logger and you can use this instance of logger with importing it from @axonlabs/core.

Logger configuration options will add to config file as soon as possible.

For more information about the pino logger read official documentation of this library.

import { axonLogger } from "@axonlabs/core";
// or
const { axonLogger } = require("@axonlabs/core");

Plugins must use plugin mode of logger.

Example:

import { axonLogger } from "@axonlabs/core";

axonLogger.plugin("Something to log");
axonLogger.info("Something to log");

Axon Core config

You can config Axon core with creating a file in your project root directory.

Acceptable files:

axon.config.js
axon.config.ts
axon.config.cjs
axon.config.mjs

If you want to have ide suggestions for core config use AxonConfig type.

Configs:

DEBUG: boolean to set debug mode of core. (default false)
LOGGER: boolean to set core logger on or off. (default true)
LOGGER_VERBOSE: boolean to set core logger in verbose mode. (default false)
RESPONSE_MESSAGES: object to change default value of some core responses. (type: AxonResponseMessage)
CORS: object to change core cors settings. (type: AxonCorsConfig)
HTTPS: object to config server for https. (type: AxonHttpsConfig)
MIDDLEWARE_TIMEOUT: variable to set global timeout of waiting for middleware to response or call next function. (ms, default 10000ms)

Running server 🔑

listen method runs your webserver.

If you want to run your server on https, you have to set key and cert file in HTTPS config of core to run https server automatically by core

// put this in config file (axon.config.js .etc)
HTTPS: {
    key: fs.readFileSync(path.join("server.key")),
    cert: fs.readFileSync(path.join("server.crt"))
}

core.listen() has some default values

host: default value of host in 127.0.0.1
port: default value of port is 8000
callback: if you don't set callback function, core will log running message automatically if logger be on in core config.(logger is on in default config)

core.listen("0.0.0.0", 80, () => {
    console.log("server is running on port 80")
});

Closing/Stopping server 🛑

close method closes your webserver.

core.close(); // close all servers
core.close("http"); // close http server
core.close("https"); // close https server

Contributing

Contributions are always welcome!

Authors

@Mr-MKZ