@x/serverless NPM

@x/serverless

@x/serverless for Node.js and the browser in a simple package.

For @x/serverless documentation, visit https://danderson00.gitlab.io/serverless/.

Getting Started

Install Dependencies

yarn add @x/serverless @x/serverless.react sqlite3

Start Application

npx xsl

This starts both the host and the react development server. The following command line options are available:

Option		Type	Default	Description
--help	-h	boolean		Show help
--version		boolean		Show version number
--config		string	"xsl"	Path to JS or JSON config file
--port	-p	integer	3001	TCP port number to listen on
--scope	-s	string		Property name that can participate in scopes. Multiple can be specified
--sqliteFile	-f	string		Path to a SQLite database to use
--vocabulary	-v	string	"src/vocabulary"	Path to a file containing vocabulary definitions
--constraints	-c	string	"src/constraints"	Path to a file containing constraint definitions
--types	-t	string	"src/types"	Path to a file containing type declarations
--strictApi		boolean		Enforce strict vocabulary API surface
--strictTypes		boolean		Enforce explicit message types
--requireSsl		boolean		Allows disabling of SSL requirement for production
--auth0Domain		boolean		Enable auth0 authentication with the provided domain
--authSecret		boolean		Secret to use for signing authentication tokens
--startDevelopmentServer		boolean		Start react development server
--watch		boolean		Watch for changes to configuration files and reload on change

For alternate ways of starting the host, including using other database providers, see the section below.

Configure Consumer

For applications bootstrapped with create-react-app, replace the contents of src/index.js with the following:

import React from 'react'
import ReactDOM from 'react-dom'
import consumer from '@x/serverless'
import { Provider } from '@x/serverless.react'
import App from './App'

consumer().connect()
  .then(host => ReactDOM.render(
    <Provider host={host}><App /></Provider>,
    document.getElementById('root')
  ))

Vocabulary can also be passed in as a prop to the Provider component.

An options object can also be passed to the consumer factory. Options are as follows:

Name	Type	Description
url	string	The websocket URL of the host to connect to
reconnectDelay	number	Time in milliseconds between reconnect attempts. Defaults to 1000ms
log	object	Logging configuration options. `level` property can be `error`, `warn`, `debug`, `trace` or `none`

Any components in your application can now use the higher order components and hooks from the @x/serverless.react library.

Host Startup / Configuration Options

The example here uses npx to invoke the @x/serverless command line interface. A number of other options are available for starting and configuring the host.

Installing Globally

The @x/serverless package can be installed globally by executing:

npm i -g @x/serverless
# or
yarn global add @x/serverless

This makes the CLI available globally throughout your system and can be invoked without npx.

Using a Configuration File

Configuration options can be specified in a Javascript or JSON file. By default, this file is called xsl.js. The full set of options can be found here.

Starting the Host Programmatically

The host process can be started from any Node.js module.

const host = require('@x/serverless')
const vocabulary = require('./vocabulary')

host({
  port: 1234,
  scopes: ['orderId', 'productId'],
  storage: { client: 'sqlite3', connection: { filename: 'data.sqlite' } },
  vocabulary
})

Any database supported by knex can be used and should be configured accordingly here. An in-memory instance of the sqlite provider is used by default, but the sqlite3 package must be installed separately.

@x/log @x/socket @x/socket.auth @x/socket.files @x/socket.serverless @x/store.sql @x/serverless.devtools @x/serverless.host bufferutil cross-spawn express greenlock greenlock-express utf-8-validate ws yargs

0.4.18

4 years ago

0.4.17

4 years ago