sonolus-express

sonolus-express

TypeScript based developer toolkit for Sonolus servers with Express.js.

Links

• Sonolus Website
• Sonolus Wiki
• sonolus-pack

Features

• Setup all necessary routes automatically, compliant with Sonolus server specifications.
• Provide handlers to interact with each route.
• Load packs created by sonolus-pack.

Installation

npm install sonolus-express

A compatible version of sonolus-core is also required as peer dependency. If it isn't installed automatically, you can do so with:

npm install sonolus-core

Example

const port = 3000
const app = express()

new Sonolus(app).load('pack')

app.listen(port, () => {
    console.log('Server listening at port', port)
})

Documentation

Sonolus

constructor(app, options)

Create a Sonolus server on app with options.

• app: Express.js app.
• options.basePath: base path of the Sonolus server (should not have ending /).
• options.authentication: if Sonolus server requires authentication.
• options.sessionAddress: session address to be used in authentication.
• options.sessionDuration: session duration to be used in authentication.
• options.fallbackLocale: fallback locale when user's preferred locale cannot be used.
• options.mode: share link handling mode, can be custom, redirect, or spa.
• options.spaRoot: root of static SPA files to serve when options.mode is spa.
• options.levels: configurations for levels.
• options.skins: configurations for skins.
• options.backgrounds: configurations for backgrounds.
• options.effects: configurations for effects.
• options.particles: configurations for particles.
• options.engines: configurations for engines.

sessionAddress

Session address. As passed in from constructor(app, options).

router

Express router.

Installing more routes under options.basePath may not work due to SPA mode catch all routes. Instead install onto router rather than the original Express app.

db

Sonolus database. Can be modified to dynamically add/remove/reorder items.

• db.levels: levels.
• db.skins: skins.
• db.backgrounds: backgrounds.
• db.effects: effects.
• db.particles: particles.
• db.engines: engines.

load(path)

Load a pack created by sonolus-pack.

• path: file path to the pack.

add(type, data, hash?)

Add a resource. Returns SRL which can be used to access the resource.

• type: resource type.
• data: data (Buffer) or file path (string) to the data.
• hash: (optional) hash of the resource, will be calculated automatically when omitted.

localize(text, locale)

Localize text using target and fallback locales.

• text: text to localize.
• locale: target locale.

createSessionHandler

Handler for creating an authentication session.

findSessionHandler

Handler for finding an authentication session.

checkSessionHandler

Handler for checking an authentication session.

serverInfoHandler

Handler for requesting server info. Defaults to defaultServerInfoHandler.

levelListHandler

Handler for requesting level list. Defaults to defaultLevelListHandler.

skinListHandler

Handler for requesting skin list. Defaults to defaultSkinListHandler.

backgroundListHandler

Handler for requesting background list. Defaults to defaultBackgroundListHandler.

effectListHandler

Handler for requesting effect list. Defaults to defaultEffectListHandler.

particleListHandler

Handler for requesting particle list. Defaults to defaultParticleListHandler.

engineListHandler

Handler for requesting engine list. Defaults to defaultEngineListHandler.

levelDetailsHandler

Handler for requesting level details. Defaults to defaultLevelDetailsHandler.

skinDetailsHandler

Handler for requesting skin details. Defaults to defaultSkinDetailsHandler.

backgroundDetailsHandler

Handler for requesting background details. Defaults to defaultBackgroundDetailsHandler.

effectDetailsHandler

Handler for requesting effect details. Defaults to defaultEffectDetailsHandler.

particleDetailsHandler

Handler for requesting particle details. Defaults to defaultParticleDetailsHandler.

engineDetailsHandler

Handler for requesting engine details. Defaults to defaultEngineDetailsHandler.

filterLevelInfosByKeywords(infos, keywords)

Filter level infos by keywords on name, rating, title, artists, author, and description.

• infos: level infos.
• keywords: keywords.

filterSkinInfosByKeywords(infos, keywords)

Filter skin infos by keywords on name, title, subtitle, author, and description.

• infos: skin infos.
• keywords: keywords.

filterBackgroundInfosByKeywords(infos, keywords)

Filter background infos by keywords on name, title, subtitle, author, and description.

• infos: background infos.
• keywords: keywords.

filterEffectInfosByKeywords(infos, keywords)

Filter effect infos by keywords on name, title, subtitle, author, and description.

• infos: effect infos.
• keywords: keywords.

filterParticleInfosByKeywords(infos, keywords)

Filter particle infos by keywords on name, title, subtitle, author, and description.

• infos: particle infos.
• keywords: keywords.

filterEngineInfosByKeywords(infos, keywords)

Filter engine infos by keywords on name, title, subtitle, author, and description.

• infos: engine infos.
• keywords: keywords.

filterInfosByKeywords(infos, props, keywords)

Filter item infos by keywords on specified props.

Recommended to use functions for the specific info type instead.

• infos: item infos.
• props: props to filter keywords on.
• keywords: keywords.

paginateInfos(infos, page, perPage)

Paginate item infos by page and per page size.

• infos: item infos.
• page: page.
• perPage: per page size, defaults to 20.

Using meta in TypeScript

Use declaration merging:

declare module 'sonolus-core' {
    interface LevelInfo {
        meta: {
            // user-defined meta information
        }
    }
}