@sempervirens/endpoint v0.9.2

Sempervirens Endpoint

Middleware for handling Express routes, it provides an organized way to register multiple Express endpoints, an extendable class for isolating endpoint functionality, standardization for sending success and error objects, and built-in authorization with minimal JWT configuration.

Installation

npm install @sempervirens/endpoint

Usage

The following steps provide minimal usage. It is recommneded to have separate files for each RequestHandler instance, and a separate endpoints file that imports the RequestHandler instances and exports an array of endpoint configurations. Also, while @sempervirens/endpoint may be used independently, or in conjunction with @sempervirens/site-loader, implementation of both is integrated and streamlined in @sempervirens/server.

Non-secure Endpoints

1. Import express and Node http (or use @sempervirens/server).

2. Import registerEndpoints and RequestHandler from @sempervirens/endpoint.

3. Create request handlers.

4. Create an array of endpoint configurations.

5. Create an Express app.

6. Register the endpoints with the app.

7. Start the server.

import express from 'express';
import http from 'http';

import { registerEndpoints, RequestHandler } from '@sempervirens/endpoint';

// Recommended usage, in a separate file
class TestRequestHandler extends RequestHandler {
  constructor({ req, res, data, isSecure }) {
    super({ req, res, data, isSecure });
    if (!this.isAuthorized) return;
    this.#init();
  }
  #init() {
    console.log(this.data);
    // -> { prop1: 'val1' }
    this.res.send('Success');
  }
}

// In another separate file
const endpoints = [
  {
    path: 'GET /api/test',
    handler: TestRequestHandler
    data: { prop1: 'val1' } // Passed into RequestHandler constructor
  }
];

const app = express();
registerEndpoints(app, endpoints);
http.createServer(app).listen(80, () => console.log('Listening'));

Secure Endpoints

Passing isSecure to the endpoint configuration secures the endpoint by requiring a Authorization Bearer ${token} header to be passed in the request. See @sempervirens/authorizer or @sempervirens/server for details.

1. Import express and Node http.

2. Import registerEndpoints and RequestHandler from @sempervirens/endpoint.

3. Import @sempervirens/authorizer.

4. Initialize authorizer;

5. Create request handlers.

6. Create a set of endpoint configurations.

7. Create an Express app.

8. Register the endpoints with the app.

9. Start the server.

import express from 'express';
import http from 'http';
import authorizer from '@sempervirens/authorizer';
import { registerEndpoints, RequestHandler } from '@sempervirens/endpoint';

// See @sempervirens/authorizer or @sempervirens/server for details
const jwtPublicKey = readFileSync('./security/jwt/jwtRS256.key.pub', 'utf8');
const jwtPrivateKey = readFileSync('./security/jwt/jwtRS256.key', 'utf8');
authorizer.init({ jwtPublicKey, jwtPrivateKey });

// Recommended usage, in a separate file
class TestRequestHandler extends RequestHandler {
  constructor({ req, res, data, isSecure }) {
    super({ req, res, data, isSecure });
    if (!this.isAuthorized) return;
    this.#init();
  }
  #init() {
    this.res.send('Success');
  }
}

// In another separate file
const endpoints = [
  {
    path: 'GET /api/test',
    handler: TestRequestHandler,
    isSecure: true
  }
];

const app = express();
registerEndpoints(app, endpoints);
http.createServer(app).listen(80, () => console.log('Listening'));

API

registerEndpoints (single function)

ErrorCodes (enum)

RequestHandler (class)