@emeralt/server

Emeralt Node.js HTTP server module

Install

Using npm:

npm install @emeralt/server

or using yarn:

yarn add @emeralt/server

Example

// import server 
import { createEmeraltServer } from '@emeralt/server'

// import plugins - auth, database and storage
import { EmeraltAuthInMemory } from '@emeralt/auth-inmemory'
import { EmeraltDatabaseInMemory } from '@emeralt/database-inmemory'
import { EmeraltStorageInMemory } from '@emeralt/storage-inmemory'

const config: TEmeraltServerConfig = {}

// create server
createEmeraltServer({
  config: config,
  auth: EmeraltAuthInMemory(),
  database: EmeraltDatabaseInMemory(),
  storage: EmeraltStorageInMemory(),
}).then(({ server, plugins }) => {
  // listen on 8080
  server.listen(8080, () => {
    console.log('Listening on 8080')
  })
})

Config

type TEmeraltServerConfig = {
  // server url, used as tarballs url
  url: string

  // default: "development"
  logLevel?: 'silent' | 'development' | 'production'

  // redirect 404, eg. http://registry.npmjs.org
  upstream?: false

  // jsonwebtoken options
  jwt?: {
    // default: "secret"
    secret?: string

    // default: "7d"
    expiresIn?: string | number
  }

  // execute healtcheck in initialization
  // default: true
  initialHealthcheck?: boolean

  // enable specific endpoint
  // default: all true
  endpoints?: {
    ping?: boolean
    search?: boolean
    login?: boolean
    adduser?: boolean
    package?: {
      get?: boolean
      publish?: boolean
    }
    distTags?: {
      get?: boolean
      create?: boolean
      delete?: boolean
    }
    sys?: {
      healthz: boolean
    }
  }
}

Sys endpoints

Additionally, server exposes a number of system endpoints used to manage server itself.

Healthcheck

GET /-/sys/health

Healthcheck verifies that every plugin is healthy and able to serve the server needs. Returns 200 if everything is OK, 503 else

Drop data

PATCH /-/sys/dropdata

Dropdata drops all registry data. Requires authentication.

Architecture