@usvc/component-server v0.0.1

@usvc/component-server

Creates a bootstrapped server based on Express.

Scope

• Basic HTTP security
• Support for reading cookies
• Support for issuing cookies
• Parses POST data with Content-Type: application/json correctly
• Parses POST data with Content-Type: application/x-www-form-urlencoded correctly
• Support for Cross-Origin-Resource-Sharing (CORS)
• Support for Content-Security-Policy (CSP) management
• Bundled metrics supporting Prometheus
• Bundled distributed tracing with Zipkin
• Readiness check configuration
• Liveness check configuration

Installation

npm i @usvc/component-server;
# OR
yarn add @usvc/component-server;

Usage

const {createServer} = require('@usvc/component-server');
// OR
import {createServer} from '@usvc/component-server';

Basic

// require as ^
const server = createServer();
const instance = server.listen(() => {
  const {port} = instance.address;
  console.info(`Listening on http://localhost:${port}`)
});

Full Configuration

// require as ^
const server = createServer({
  enableCookies: true,
  enableCors: true,
  enableJsonBody: true,
  enableUrlEncodedBody: true,
  cookies: {
    keys: [],
    name: 'session',
    secret: undefined,
    domain: 'localhost',
    httpOnly: true,
    maxAge: 60e3 * 60,
    path: '/',
  },
  cors: {
    allowedHeaders: undefined,
    credentials: true,
    exposedHeaders: undefined,
    maxAge: ONE_DAY,
    methods: ALL_HTTP_METHODS,
    optionsSuccessStatus: 204,
    preflightContinue: true,
    urls: [],
  },
  csp: {
    childSrc: ['"self"'],
    connectSrc: ['"self"'],
    defaultSrc: ['"self"'],
    disableAndroid: false,
    fontSrc: ['"self"'],
    imgSrc: ['"self"'],
    logger: console,
    logLevel: 'warn',
    objectSrc: ['"none"'],
    reportUri: '/csp-report',
    sandbox: ['allow-forms', 'allow-scripts'],
    scriptSrc: ['"self"'],
    styleSrc: ['"self"'],
  },
  jsonBody: {
    limit: '100kb',
    type: '*/json',
  },
  logger: console,
  metrics: {
    uri: '/metrics',
  },
  middlewares: {},
  urlEncodedBody: {
    limit: '100kb',
    type: '*/x-www-form-urlencoded',
  },
});

const instance = server.listen(() => {
  const {port} = instance.address;
  console.info(`Listening on http://localhost:${port}`)
});

API Documentaiton

.createServer(:options)

Returns a bootstrapped Express server. The :options parameter has the following schema:

Options Documentation

Options for cookies (DataCookiesOptions)

Options for cors (SecurityCorsOptions)

Options for csp (SecurityCspOptions)

Options for jsonBody (DataJsonOptions)

Options for metrics (ObservabilityMetricsOptions)

Options for middlewares (CreateServerHooks)

Options for urlEncodedBody (DataUrlEncodedOptions)

Examples

WIP

Development

WIP

License

This package is licensed under the MIT license.

View the license at LICENSE.

Changelog

0.0.x

0.0.1

• Added cookie sessions
• Added CSP support
• Added server middleware hooks
• Cross Origin Resource Sharing (CORS) support
• Cookie parsing
• Basic HTTP header security
• Parsing of JSON encoded boday data
• Parsing of URL encoded body data

Contributors

Cheers