Global

Methods

(async) factory(pkgName) → {Sumba}

Plugin factory.

Never call this function directly!!! It's only-meant to be called by the Bajo framework during plugin initialization.

Parameters:

Name	Type	Description
`pkgName`	string	NPM package name

Source: index.js, line 13

Returns:

Sumba class

Type:: Sumba

Type Definitions

TConfig

Sumba configuration object

Type:

object

Properties

Name Type Attributes Default Description

config

object

{}

Configuration object

Properties

Name Type Attributes Default Description

multiSite

object

{}

Multi-site configuration object

Properties

Name	Type	Attributes	Default	Description
`enabled`	boolean	<optional>	false	Whether multi-site is enabled or not. Default: false
`catchAll`	string	<optional>	'default'	Which site alias to use as the catch-all. Default: 'default'

xSiteAdmins

array

[]

List of cross-site administrators. Format: ":"

waibu

object

{}

Waibu configuration object

Properties

Name	Type	Attributes	Default	Description
`prefix`	string	<optional>	'site'	Waibu prefix
`title`	string	<optional>	'site'	Waibu title

waibuMpa

object

{}

Waibu MPA configuration object

Properties

Name Type Attributes Default Description

auth

object

{}

Waibu MPA authentication configuration object

Properties

Name	Type	Attributes	Default	Description
`methods`	array	<optional>	['session']	Waibu MPA authentication methods. Default: ['session']
`silentOnError`	boolean	<optional>	false	Whether to silently ignore authentication errors or not. Default: false

icon

string

'globe'

Waibu MPA icon. Default: 'globe'

redirect

object

{}

Waibu MPA route redirection

redirectSubRoute

object

{}

Waibu MPA sub-route redirection

waibuRestApi

object

{}

Waibu REST API configuration object

Properties

Name Type Attributes Default Description

auth

object

{}

Waibu REST API authentication configuration object

Properties

Name	Type	Attributes	Default	Description
`methods`	array	<optional>	['basic', 'apiKey', 'jwt']	Waibu REST API authentication methods. Default: ['basic', 'apiKey', 'jwt']
`silentOnError`	boolean	<optional>	false	Whether to silently ignore authentication errors or not. Default: false

waibuStatic

object

{}

Waibu Static configuration object

Properties

Name Type Attributes Default Description

auth

object

{}

Waibu Static authentication configuration object

Properties

Name Type Attributes Default Description

methods array <optional> ['basic', 'apiKey', 'jwt']

basic

object

{}

Waibu Static Basic authentication configuration object

Properties

Name	Type	Attributes	Default	Description
`useUtf8`	boolean	<optional>	true	Whether to use UTF-8 encoding for Basic authentication or not. Default: true
`realm`	boolean	<optional>	true	Whether to use realm for Basic authentication or not. Default: true
`warningMessage`	string	<optional>	'pleaseAuthenticate'	Warning message for Basic authentication. Default: 'pleaseAuthenticate'

silentOnError

boolean

false

Whether to silently ignore authentication errors or not. Default: false

waibuMpa.menuHandler

array

[]

Waibu MPA menu handler

waibuAdmin

object

{}

Waibu Admin configuration object

Properties

Name	Type	Attributes	Default	Description
`menuHandler`	string	<optional>	'sumba:adminMenu'	Waibu Admin menu handler. Default: 'sumba:adminMenu'
`menuCollapsible`	boolean	<optional>	true	Whether the Waibu Admin menu is collapsible or not. Default: true

auth

object

{}

Authentication configuration object

Properties

Name Type Attributes Default Description

apiKey

object

{}

API Key authentication configuration object

Properties

Name	Type	Attributes	Default	Description
`type`	string	<optional>	'Bearer'	API Key authentication type. Default: 'Bearer'
`qsKey`	string	<optional>	'apiKey'	API Key authentication query string key. Default: 'apiKey'
`headerKey`	string	<optional>	'X-Auth-ApiKey'	API Key authentication header key. Default: 'X-Auth-ApiKey'
`algo`	string	<optional>	'sha256'	API Key authentication hashing algorithm. Default: 'sha256'

basic

object

{}

Basic authentication configuration object

jwt

object

{}

JWT authentication configuration object

Properties

Name	Type	Attributes	Default	Description
`type`	string	<optional>	'Bearer'	JWT authentication type. Default: 'Bearer'
`qsKey`	string	<optional>	'token'	JWT authentication query string key. Default: 'token'
`headerKey`	string	<optional>	'X-Auth-Jwt'	JWT authentication header key. Default: 'X-Auth-Jwt'
`secret`	string	<optional>		JWT authentication secret. Default: hard coded value, should be changed in production
`expiresInDur`	string	<optional>	'7d'	JWT authentication token expiration duration. Default: '7d'

redirect

object

{}

Redirection configuration object

Source: lib/config.js, line 6

TTokenBody

Type:

object

Properties

Name	Type	Description
`username`	string	The username of the user
`password`	string	The password of the user

Source: lib/constant.js, line 28

TTokenData

Type:

object

Properties

Name Type Description

data

object

The token data object

Properties

Name	Type	Description
`token`	string	The token string
`expiresAt`	string	The expiration date of the token

success

boolean

Indicates if the operation was successful

statusCode

number

The HTTP status code of the response

Source: lib/constant.js, line 1