Simple Express framework

Simple micro framework based on Express, allowing you to prototype APIs blazingly quickly

Micro-framework that let's you create more readable route structure, use simple async functions as route handlers, with clear error handling and run fully functional express app in seconds.

Getting started

Requirements

Modern version of Node (>18 recommended but will probably work on older versions too)
Express (ver 5 recommended but ver 4 is still supported)
(optional) body-parser, cookie-parser, cors, helmet

Install the library

npm i simple-express-framework

Run the hello-world app

import simpleExpress from 'simple-express-framework';

simpleExpress({
  port: 8080,
  routes: [
    ['/hello', {
      get: () => ({ status: 200, body: 'Hello world' }),
    }],
  ],
});

And that's all! Express server, listening on selected port, with reasonable default settings is up and running in seconds!

But there's more! Dive in in the Examples section to see the power of simple and readable route handlers, clear error handling and more - everything just works and is nearly infinitely expandable thanks to plugin support!

Usage

simpleExpress function

You run the app by executing simpleExpress function. All options are optional.

import simpleExpress from 'simple-express-framework';

simpleExpress({
  port: 8080,
  routes,
  expressMiddleware,
  middleware,
  errorHandlers,
  config,
  routeParams,
  app,
  server,
})
  .then(({ app, server }) => console.log('App started :)'))
  .catch(error => console.error('App starting failed :(', error));

simpleExpress config

Simple express accepts the following options:

port: number Port for the app to listen on. Not required, you can run the app without a port (useful for testing)
routes: object|array See Routes
expressMiddleware: array Array of express middlewares (functions accepting req, res, and next as arguments)
middleware: array Array of simpleExpress middlewares (see Handlers)
errorHandlers: array Array of simpleExpress error middlewares (see Error Handlers)
config: object See Config
routeParams: object Object of additional parameters passed to handlers
app: object Custom app to be used (by default new express app is created)
server: object Custom http server to be used (by default new http server is created)

Resolves to an object with the following fields:

app: object Express app
server: object Http server
stats: object SimpleExpress stats object
port: number Port if the app is listening or undefined otherwise
address: object|string|null Server address

Handlers

SimpleExpress handlers are similar to express handlers except they accept one argument: object with the following fields:

body: any Request's body (by default, the json parser is enabled)
query: object Request's query parameters
params: object Route params
method: string Request's method
originalUrl: string Request's original url
protocol: string Request's protocol
xhr: boolean Flag indicating the request is XHR request
get: function Function returning the request header
getHeader: function Alias for get()
locals: object res.locals object for storing data for current request
next: function Express' next function, triggers next middleware
req: object Express' req object
res: object Express' res object

Response objects

Handlers should return falsy value (to not send any response) or the response object:

status: number (default: 200) Response http status code
body: any Response body (By default weill be sent using res.send() method. Can be changed with method field)
headers: object Response headers
redirect: string Url to redirect to
type: string Passes the value to res.type() express method which sets the Content-Type HTTP header to the value received if it contains '/' (e.g. application/json), or determines the mime type by mime.lookup()
method: string Response method, one of the following values:
- json - the response will be sent using res.json method
- send - the response will be sent using res.send method
- default - alias for send
- none - the response will not be sent (useful if you want to send a response manually), the same effect can be achieved by returning falsy value from handler.

Returning error

To pass an error to error handlers, handler can either pass an error to next() function:

({ next }) => {
  next(new Error('Something went wrong'));
};

Or just return an Error object (or instance of a class extending Error)

() => {
  return new Error('Something went wrong');
};

Or throw an Error (or instance of a class extending Error)

() => {
  throw new Error('Something went wrong');
};

Examples of handlers:

({ req, res, params, body, query, originalUrl, protocol, locals, xhr, getHeader, next }) => {
  ...
  return {
    status: 500,
    body: { message: 'Server error' },
    headers: { customHeader: 'customHeaderValue' },
  };
};

({ params, body }) => {
  ...
  return {
    status: 301,
    redirect: '/test',
  };
};

({ params, body }) => {
  ...
  return {
    body: Buffer.from('LoremIpsum')
  };
};

({ res, next }) => {
  ...
  res.sendFile('path/to/file', error => {
    if (error) {
      next(error);
    }
  });
};

Multiple handlers (middlewares)

All handlers can work as middlewares if they trigger next() instead of returning a response. You can pass an array of handlers. They will be executed in order just like express middlewares.

{
  get: [
    ({ getHeader, locals, next }) => {
      const user = verifyToken(getHeader('authentication'))
      if (user) {
        locals.user = user;
        return next();
      }

      // the same as "next(new AuthenticationError('Unauthenticated'))"
      return new AuthenticationError('Unauthenticated');
    },
    ({ locals }) => ({
      body: 'You are logged in as ' + locals.user.username,
    }),
  ]
}

Middlewares can be chained in different ways:

[
  [
    '/foo',
    ({ getHeader, locals, next }) => {
      const user = verifyToken(getHeader('authentication'))
      if (user) {
        locals.user = user;
        return next();
      }

      // the same as "next(new AuthenticationError('Unauthenticated'))"
      return new AuthenticationError('Unauthenticated');
    },
    {
      get: ({ locals }) => ({
        body: 'You are logged in as ' + locals.user.username,
      }),
    }
  ]
]

[
  '/foo',
  [
    ({ getHeader, locals, next }) => {
      const user = verifyToken(getHeader('authentication'))
      if (user) {
        locals.user = user;
        return next();
      }

      // the same as "next(new AuthenticationError('Unauthenticated'))"
      return new AuthenticationError('Unauthenticated');
    },
    {
      get: ({ locals }) => ({
        body: 'You are logged in as ' + locals.user.username,
      }),
    }
  ]
]

Error Handlers

All errors are being caught by the simpleExpress and passed to error handlers. Error handlers are identical to handlers, except they receive error as first argument, and object of handler parameters as second. To pass an error to error handlers you can trigger next() with an error as an argument, throw an error, or return an error in a handler.

Please note, that handler parameters object is exactly the same as in case of handlers, except 'params' field which is for whatever reason stripped by express.

routes: [
  ['/foo', {
    get: () => {
      throw new AuthenticationError();
    }
  }],
  ['/bar', {
    get: () => new AuthenticationError(),
  }],
  ['/baz', {
    get: ({ next }) => next(new AuthenticationError()),
  }]
]

errorHandlers: [
  (error, { next }) => {
    if (error instanceOf AuthenticationError) {
      return {
        status: 401,
        body: 'Unauthorized',
      };
    }

    return error;
  },
  (error) => {
    return {
      status: 500,
      body: 'Ups :('
    };
  }
]

handleError helper

To make it easier for you to handle different types of errors, simpleExpress provides you with handleError helper:

import { handleError } from 'simple-express-framework';

//...

errorHandlers: [
  handleError(
    AuthenticationError,
    (error, { query, body, params, ... }) => ({
      status: 401,
      body: 'Unauthorized',
    })
  ),
  (error) => ({
    status: 500,
    body: 'Ups :('
  }),
]

You can also pass an array of error - errorHandler pairs to handleError helper function

import { handleError } from 'simple-express-framework';

//...

errorHandlers: [
  handleError([
    [AuthenticationError, (error, { query, body, params, ... }) => ({
      status: 401,
      body: 'Unauthorized',
    })],
    [
      (error) => ({
        status: 500,
        body: 'Ups :('
      }),
    ]
  ])
]

import { handleError } from 'simple-express-framework';

//...

errorHandlers: handleError([
  [AuthenticationError, (error, { query, body, params, ... }) => ({
    status: 401,
    body: 'Unauthorized',
  })],
  (error) => ({
    status: 500,
    body: 'Ups :('
  }),
])

Routes

The simpleExpress supports different formats of routes (in first two formats, paths can be either strings or regular expressions):

Array of tuples (recommended)

simpleExpress({
  routes: [
    ['/foo', {
      get: [authenticate, () => ({ body: 'some data' })]
      post: [authenticate, () => ({ status: 201 })]
    }],
    ['/bar/:baz', {
      get: ({ params }) => ({ body: `Got ${params.baz}` })
    }]
  ]
});

Array of objects

simpleExpress({
  routes: [
    {
      path: '/foo',
      handlers: {
        get: [authenticate, () => ({ body: 'some data' })],
        post: [authenticate, () => ({ status: 201 })],
      },
    },
    {
      path: '/bar/:baz',
      handlers: {
        get: ({ params }) => ({ body: `Got ${params.baz}` }),
      },
    },
  ],
});

Object of objects

Warning: Object keys' order is preserved only for string and symbols keys, not for integers (integers, including in strings like "1", will always be before all other keys)!

simpleExpress({
  routes: {
    '/foo': {
      get: [authenticate, () => ({ body: 'some data' })]
      post: [authenticate, () => ({ status: 201 })]
    },
    '/bar/:baz': {
      get: ({ params }) => ({ body: `Got ${params.baz}` }),
    },
  },
});

Reserved object keys

Because object keys can be used as route paths but also as method names (like get, post etc.) or as names like path, handlers and routes here is the list of reserved key names that can't be used as route paths when you use "Object of objects" format:

Please note that all of those can be used with slash at the beginning like /path or /post. Only exactly listed strings are reserved.

path
handlers
routes
use
get
post
put
delete
del
options
patch
head
checkout
copy
lock
merge
mkactivity
mkcol
move
m-search
notify
purge
report
search
subscribe
trace
unlock
unsubscribe

If you need to register a route with one of these strings as path, you can use one of the other route formats.

Config

By default, JSON body parser, cors, cookie parser and helmet middlewares are configured. You can change their configuration or disable them. config object consist of the following fields:

cors: object|false cors config. If set to false, the cors middleware will not by applied.
jsonBodyParser: object|false JSON body parser config. If set to false the body parser middleware will not be applied.
cookieParser: [secret, options]|false Arguments for cookie-parser middleware. If set to false the cookie parser middleware will not be applied.
helmet: object|false Helmet config. If set to false the helmet middleware will not be applied.

Note: Default middlewares are applied only if corresponding libraries are installed. body-parser is an express dependency so it will be installed with it.

Global Middlewares

Global middlewares can be added in middleware field. It is array of handlers (each handlers looks exactly like route handlers, with the same parameters).

simpleExpress({
  port: 8080,
  middleware,
  ...
})

If you need to use express middlewares directly, you can pass them to expressMiddleware array.

Plugins

You can modify the behaviour of simpleExpress with plugins. Each plugin is a factory, that receives simpleExpress config (all parameters passed to simpleExpress function) as parameter, and returns plugin object.

Plugin object is an object of one or more of the following functions:

getHandlerParams
getErrorHandlerParams
mapResponse

Plugins' functions are triggered in the order they appear in the plugins array. In case of mapResponse, not all plugins are necessarily triggered (see details below).

Here is an example of plugin that adds cookies parsed by cookie-parser to handler params.

const cookiesPlugin = (simpleExpressConfig) => ({
  getHandlerParams: params => ({
    ...params,
    cookies: params.req.cookies,
  }),
  getErrorHandlerParams: params => ({
    ...params,
    cookies: params.req.cookies,
  }),
});

simpleExpress({
  port: 8080,
  plugins: [
    cookiesPlugin,
  ],
  ...
});

And yet another plugin, this time, allowing you to serve file easily:

const serveFilePlugin = simpleExpressConfig => ({
  mapResponse: (responseObject, { res }) => {
    if (responseObject.file) {
      res.sendFile(responseObject.file, err => {
        if (err) {
          return next(err)
        }
      })
      return null;
    }

    return responseObject;
  },
});

simpleExpress({
  port: 8080,
  plugins: [
    serveFilePlugin,
  ],
  ...
});

getHandlerParams, getErrorHandlerParams

These functions are triggered for all plugins, in order. Each plugin gets what the previous returned (default handler params are passed to the first plugin in chain) Arguments

handlerParams: object Handler params returned by the previous plugin

Returns

handlerParams: object Handler params passed to the next plugin

mapResponse

Each plugin gets what previous returned (response object returned from handler is passed to the first plugin in chain). Chain can be broken if a plugin returns null or { type: 'none' } object. Also, no plugins are triggered, if handler returned null or { type: 'none' }. That way we prevent sending the response twice by two different plugins.

Arguments

responseObject: object Response object returned by the previous plugin

Returns

responseObject: object Response object passed to the next plugin

Typescript

SimpleExpress is written in typescript and most of the code is fully typed. One exception is the plugin system which does not correctly infer the types resulting in applying the plugins. Below are examples of how to handle that until the issue is fixed.

Type parameters

While most types are going to be correctly inferred, you can also pass the type parameters for additional route params and res.locals object.

import simpleExpress, { Routes } from 'simple-express-framework';

type AdditionalRouteParams = { foo: string };
type Locals = { bar: string };

export const router: Routes<AdditionalRouteParams, Locals> = [
  ['/', {
    get: [
      ({ foo, locals }) => ({ body: `${foo} ${locals.bar}` }),
    ]
  }],
];

// when passing routes with correct types, you can omit the generics in simpleExpress function
simpleExpress({
  routes: router,
});

// but you can also pass them explicitly
simpleExpress<AdditionalRouteParams, Locals>({
  routes: router,
});

mapResponse plugin

This is the most difficult, and for now, the only way is to just use type assertion:

import { ResponseDefinition, Routes } from 'simple-express-framework';

const mapResponse = response => ({
  ...response,
  body: response.alternativeBody,
});
const plugin = () => ({ mapResponse });

const routes: Routes = [
  ['/', {
    get: [
      () => ({ alternativeBody: 'works' } as ResponseDefinition),
    ]
  }],
];

const { app } = await simpleExpress({ routes, plugins: [ plugin ] });

getHandlerParams and getErrorHandlerParams plugins

If you just add new parameters to handlers then you can use type parameter in route like this:

const getHandlerParams = routeParams => ({
  ...routeParams,
  additionalParam: 'works',
});
const plugin = () => ({ getHandlerParams });

const routes: Routes<{ additionalParam: string }> = [
  ['/', {
    get: [
      ({ additionalParam }) => ({ body: additionalParam }),
    ]
  }],
];

const { app } = await simpleExpress({ routes, plugins: [ plugin ] });

In case you remove some parameters from handlers, unfortunately, your routes will not be type-safe:

const getHandlerParams = routeParams => ({
  theOnlyParam: 'works',
});
const plugin = () => ({ getHandlerParams });

const routes: Routes<{ theOnlyParam: string }> = [
  ['/', {
    get: [
      // typescript allows you to use `req` param here although it won't be present at runtime 
      ({ req, theOnlyParam }) => ({ body: theOnlyParam }),
    ]
  }],
];

const { app } = await simpleExpress({ routes, plugins: [ plugin ] });

More usage examples

Hello world

import simpleExpress from 'simple-express-framework';

simpleExpress({
  port: 8080,
  routes: [
    ['/', {
      get: () => ({ body: 'Hello world!' }),
    }],
  ],
})

Simple users CRUD

import simpleExpress from 'simple-express-framework';

import connectDb from './connectDb';
import createUsersRepository from './usersRepository';

const db = connectDb();
const usersRepository = createUsersRepository(db);

simpleExpress({
  port: 8080,
  routeParams: { users: usersRepository },
  routes: [
    ['/users', {
      get: async ({ query: { search }, users }) => {
        const allUsers = await users.getAll(search);

        return {
          body: allUsers,
        };
      },
      post: async ({ body, users }) => {
        const results = await users.create(body);

        return {
          status: 201,
          body: results,
        };
    }],
    ['users/:id', {
      get: async ({ params: { id }, users }) => {
        const user = await users.getById(id);

        if (user) {
          return {
            body: user,
          };
        }

        return {
          status: 404,
          body: 'User not found',
        };
      },
      put: async ({ params: { id }, body, users }) => {
        const { id } = params;
        const result = await users.updateById(id, body);

        if (result) {
          return {
            status: 204,
          };
        }

        return {
          status: 404,
          body: 'User not found',
        };
      },
    }],
  ],
})

Adding authentication

import simpleExpress from 'simple-express-framework';
import verifyToken from 'verifyToken';

simpleExpress({
  port: 8080,
  middleware: [
    ({ get, next }) => {
      if (verifyToken(get('authentication'))) {
        return next();
      }

      return {
        status: 401,
        body: 'Unauthorized',
      };
    },
  ],
  routes: [
    ...
  ],
})

Adding authentication to one route only

import simpleExpress from 'simple-express-framework';
import users from 'users';
import verifyToken from 'verifyToken';

simpleExpress({
  port: 8080,
  routes: [
    ...
    ['/users', {
      get: [
        ({ get, next }) => {
          if (verifyToken(get('authentication'))) {
            return next();
          }

          return {
            status: 401,
            body: 'Unauthorized',
          };
        },
        async ({ query }) => {
          const { search } = query;
          const allUsers = await users.getAll(search);

          return {
            body: allUsers,
          };
        },
      ]
    }],
    ...
  ],
});

Error handling

import simpleExpress from 'simple-express-framework';
import users from 'users';
import NotFoundError from 'errors/NotFoundError';

simpleExpress({
  port: 8080,
  routes: [
    ...
    ['/users/:id', {
      get: async ({ params }) => {
        const { id } = params;
        const user = await users.getById(id);

        if (user) {
          return {
            body: user,
          };
        }

        return new NotFoundError('User not found');
      },
    }],
    ...
  ],
  errorHandlers: [
    (error, { next }) => {
      if (error instanceof NotFoundError) {
        return {
          status: 404,
          body: error.message,
        };
      }

      return error;
    },
    (error) => (){
      status: 500,
      body: error.message || 'Unknown error',
    }),
  ],
});

You can pass the error to next callback, return it or throw. In each case, error handlers will get the error.

const handler = ({ next }) => {
  next(new Error('Error'));
};

const handler = () => {
  return new Error('Error');
};

const handler = () => {
  throw new Error('Error');
};

Disabling default middlewares

import simpleExpress from 'simple-express-framework';

simpleExpress({
  port: 8080,
  config: {
    jsonBodyParser: false,
    cors: false,
    cookieParser: false,
  },
  routes: [
    ...
  ],
});

Applying express middlewares

Cors, JSON body parser and cookie parser are configured by default

import simpleExpress from 'simple-express-framework';
import morgan from 'morgan';

simpleExpress({
  port: 8080,
  expressMiddleware: [
    morgan('combined'),
  ],
  routes: [
    ...
  ],
});

Sending response manually

import simpleExpress from 'simple-express-framework';

simpleExpress({
  port: 8080,
  routes: [
    ['/foo', {
      get: ({ res }) => {
        res.write('<div>Hello foo</div>');
        res.end();
      },
    }],
    ['/bar', {
      get: ({ res }) => {
        res.write('<div>Hello baz</div>');
        res.end();

        return null;
      },
    }],
    ['/baz', {
      get: ({ res }) => {
        res.write('<div>Hello baz</div>');
        res.end();

        return {
          format: none,
        };
      },
    }],
  ],
})

Request validation

Express-validator

import simpleExpress, { wrapMiddleware } from 'simple-express';
const { check, validationResult } = require('express-validator');

const { app } = await simpleExpress({
  port: 8080,
  routes: [
    ['/user', {
      post: [
        wrapMiddleware([
          check('username').isEmail(),
          check('password').isLength({ min: 5 })
        ]),
        ({ req, next }) => {
          const errors = validationResult(req);
          if (!errors.isEmpty()) {
            return res.status(400).json({ errors: errors.array() });
          }

          next();
        },
        () => ({
          body: 'works'
        })
      ],
    }],
  ],
});

Logging

This library uses debug logging utility.

To enable all logs set the following environment variable:

DEBUG=simpleExpress,simpleExpress:*

You can enable only some logs:

DEBUG=simpleExpress: General logs (like "App started on port", or "ERROR: port already in use")
DEBUG=simpleExpress:request: Log all requests with response time
DEBUG=simpleExpress:stats: Simple express statistics, like registered routes, middlewares etc.
DEBUG=simpleExpress:warning: Unimplemented features, deprecations and other warnings

Testing the app

See the demo app for tests examples.

Development

Clone the repository
npm i

Running tests npm run test

Starting demo app npm run demo

Changelog

3.0.0

Moved express to peerDependencies and included support for express 5
Complete rewrite - now the whole codebase is written in typescript
Rewritten build process - now using tsup
Types improvements
Added helmet

2.4.1

Improved typescript typings (added Promise as possible return from handler)

2.4.0

Added typescript typings
Updated dependencies

2.3.0

Added plugins support
Added support for getHandlerParams plugin method
Added support for getErrorHandlerParams plugin method
Added support for mapResponse plugin method

2.2.0

Fixed applying custom config for default middlewares

2.1.0

Added more features to handleError helper (handling unknown error, passing more error - errorHandler pairs)
Added more tests for handleError helper
Added table of contents in readme
Some minor improvements in readme
Small fixes

2.0.4

Added logo

2.0.3

Fixed issue with use method not being supported
Updated tests

2.0.2

DEPRECATION: simpleExpressMiddlewares and middlewares options are deprecated, use middleware instead
DEPRECATION: expressMiddlewares option is deprecated, use expressMiddleware instead
All middlewares can now be nested
Added more tests
Improved readme

2.0.1

improved stats log
updated tests

2.0.0

Added support for nested routes, in many shapes
Updated tests to cover different nested routes schemas
Added type response field
Changed default response method to send
Updated readme
Update demo app - now it's complete application with tests

1.0.3

Exposed res.locals to route handlers and error handlers as "locals"
Added more tests for error handlers

1.0.2

Minor fixes

Name		Name	Last commit message	Last commit date
Latest commit History 49 Commits
dist		dist
src		src
.gitignore		.gitignore
.npmignore		.npmignore
LICENSE		LICENSE
README.md		README.md
logo.png		logo.png
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

License

Lukasz-pluszczewski/simple-express

Folders and files

Latest commit

History

Repository files navigation