miniframe-router/src.ts/base.ts

Simple router for Express.js, making routes and controllers easy to manage.

import { Router, RequestHandler } from "express";

const DEFAULT_CONTROLLERS_PATH = "src/controllers";

let globalRouter: Router | null = null;
let currentScope: string | null = null;
let scopeMiddlewares: RequestHandler[] = [];
let controllersPath: string = DEFAULT_CONTROLLERS_PATH;

export const getRouter = () => {
  if (!globalRouter) {
    globalRouter = Router();
  }

  return globalRouter;
};

export const resetRouter = () => {
  globalRouter = null;
  currentScope = null;
  scopeMiddlewares = [];
  controllersPath = DEFAULT_CONTROLLERS_PATH;
};

export const setRouterCotrollersPath = (path: string) =>
  (controllersPath = path);

export const getRouterCotrollersPath = () => controllersPath;

// Store current routing scope
export const setRouterScope = (scope: string | null) => {
  currentScope = scope;
};

// Get current routing scope
export const getRouterScope = () => currentScope;

// Get current scope middlewares
export const getScopeMiddlewares = () => scopeMiddlewares;

// Set scope middlewares
export const setScopeMiddlewares = (middlewares: RequestHandler[]) => {
  scopeMiddlewares = middlewares;
};

type ScopeOptions = {
  withMiddlewares?: RequestHandler[];
};

export const routeScope = (
  scope: string,
  routesDefinitionCallback: () => void,
  options: ScopeOptions = {}
) => {
  const router = Router();
  const originalRouter = globalRouter;
  const originalScopeMiddlewares = scopeMiddlewares;

  // Temporarily replace global router with a new one
  globalRouter = router;

  // Set current scope and its middlewares
  setRouterScope(scope);
  setScopeMiddlewares(options.withMiddlewares || []);

  // Execute callback that will add routes to the new router
  routesDefinitionCallback();

  // Restore original router, scope and middlewares
  globalRouter = originalRouter;
  setRouterScope(null);
  setScopeMiddlewares(originalScopeMiddlewares);

  // Mount scoped router to the main router with scope prefix
  getRouter().use(`/${scope}`, router);
};