Function

Static Public Summary
public	LOGGEDIN(req: , res: , next: ): Express middleware for blocking non-logged in users
public	async assign(user: , field: , value: , fieldMeta: , loginUser: *)
public	async assign(user: , field: , value: , fieldMeta: , loginUser: , config: )
public	async assign(user: , field: , value: , fieldMeta: , loginUser: , config: )
public	async assign(user: , field: , value: , fieldMeta: , loginUser: , config: )
public	async assign(user: , field: , value: , fieldMeta: , loginUser: *)
public	audit(source: string, event: string, params: string) Fill in method for audit logging
public	bootstrap(app: , config: ): ExpressMiddleware Out boilerplate to make things easier.
public	callback(fn: Function, args: *): Promise Calls a callback caller that calls a callback call for async instead of using promises.
public	checkStrongPassword(password: *): boolean
public	defer(fn: Function, args: *) Call a function later.
public	error(res: Response, message: string \| object, audit: string, extra: string) Return error status and payload as response.
public	escape(content: string): string Encodes unencoded bits of string.
public	failure(settings: object): ExpressMiddlewareFunction Implementation of failure aware rate restriction.
public	generate(length: number): string generate strong password
public	generateId(): string Helper method that generates a new user id.
public	parse(searchMetadata: SearchMetadata, query: Query): ParsedQuery Validate and parse Request.query against what is acceptable from a SearchMetadata specification
public	recaptcha(settings: object): ExpressMiddlewareFunction Implementation of reCAPTCHA rate restriction.
public	reject(res: Response, audit: string, extra: string): * Returns a function that calls res.error
public	resolve(res: Response, promiseObj: Promise, message: string \| object, audit: string, extra: string) Monitors a Promise and returns success or error based on promise outcome.
public	setup(app: Express, config: Config) Library entry point
public	success(res: Response, message: string \| object, audit: string, extra: string) Return success status and payload as response.

Static Public

public LOGGEDIN(req: , res: , next: ): source

import {LOGGEDIN} from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/helper/access.js'

Express middleware for blocking non-logged in users

Params:

Name	Type	Attribute	Description
req	*
res	*
next	*

Return:

public async assign(user: , field: , value: , fieldMeta: , loginUser: *) source

import {assign} from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/fields/default.js'

Params:

Name	Type	Attribute	Description
user	*
field	*
value	*
fieldMeta	*
loginUser	*

public async assign(user: , field: , value: , fieldMeta: , loginUser: , config: ) source

import {assign} from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/fields/password.js'

Params:

Name	Type	Attribute	Description
user	*
field	*
value	*
fieldMeta	*
loginUser	*
config	*

public async assign(user: , field: , value: , fieldMeta: , loginUser: , config: ) source

import {assign} from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/fields/roles.js'

Params:

Name	Type	Attribute	Description
user	*
field	*
value	*
fieldMeta	*
loginUser	*
config	*

public async assign(user: , field: , value: , fieldMeta: , loginUser: , config: ) source

import {assign} from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/fields/strongPassword.js'

Params:

Name	Type	Attribute	Description
user	*
field	*
value	*
fieldMeta	*
loginUser	*
config	*

public async assign(user: , field: , value: , fieldMeta: , loginUser: *) source

import {assign} from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/fields/disabled.js'

Params:

Name	Type	Attribute	Description
user	*
field	*
value	*
fieldMeta	*
loginUser	*

public audit(source: string, event: string, params: string) source

import audit from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/helper/audit.js'

Fill in method for audit logging

Use as req.audit(...) or res.audit(...)

Params:

Name	Type	Attribute	Description
source	string		source of event. e.g. user or ip
event	string		type of event. e.g. user or ip
params	string		data associated with event

public bootstrap(app: , config: ): ExpressMiddleware source

import bootstrap from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/helper/bootstrap.js'

Out boilerplate to make things easier.

Params:

Name	Type	Attribute	Description
app	*
config	*

Return:

ExpressMiddleware

a middleware that will attach a bunch of convenience properties and functions to req and res.

public callback(fn: Function, args: *): Promise source

import callback from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/helper/callback.js'

Calls a callback caller that calls a callback call for async instead of using promises.

Params:

Name	Type	Attribute	Description
fn	Function		function to call
args	*	optional	arguments to call function with

Return:

Promise

It returns a promise which resolves on callback call.

public checkStrongPassword(password: *): boolean source

import {checkStrongPassword} from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/fields/strongPassword.js'

Params:

Name	Type	Attribute	Description
password	*

Return:

boolean

public defer(fn: Function, args: *) source

import defer from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/helper/defer.js'

Call a function later.

Params:

Name	Type	Attribute	Description
fn	Function		function to call
args	*		Can also specify 0 or more arguments to call function with.

public error(res: Response, message: string | object, audit: string, extra: string) source

import error from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/helper/error.js'

Return error status and payload as response.

Params:

Name	Type	Attribute	Description
res	Response		use as res.error(...)
message	string \| object	optional default: 'Failure'	error message to return; if a strig is specified, it will be converted to an error object
audit	string	optional default: false	audit event type
extra	string	optional default: undefined	extra audit payload which may help debug event

public escape(content: string): string source

import escape from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/helper/escape.js'

Encodes unencoded bits of string.

E.g. escape("&&") should return "&&"

Params:

Name	Type	Attribute	Description
content	string		content to encode

Return:

string

public failure(settings: object): ExpressMiddlewareFunction source

import failure from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/restriction/failure.js'

Implementation of failure aware rate restriction.

Will intercept monitor requests. After a certain number of failures, it will block for a duration.

Requires block-failed package.

Params:

Name	Type	Attribute	Description
settings	object	optional	settings for rate restriction, or null to disable
settings.blockAttemptMs	number		duration to monitor failure for
settings.blockAttemptCount	number		number of failures allowed in this duration
settings.blockDurationMs	number		duration to block for

Return:

ExpressMiddlewareFunction

public generate(length: number): string source

import {generate} from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/fields/strongPassword.js'

generate strong password

Params:

Name	Type	Attribute	Description
length	number	optional default: 10	length of password to generate

Return:

string

public generateId(): string source

import generateId from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/helper/generateId.js'

Helper method that generates a new user id.

This method uses current timestamp and random number generator to come up with unique ids.

Return:

string

public parse(searchMetadata: SearchMetadata, query: Query): ParsedQuery source

import parse from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/filters/parse.js'

Validate and parse Request.query against what is acceptable from a SearchMetadata specification

Params:

Name	Type	Attribute	Description
searchMetadata	SearchMetadata
query	Query

Return:

ParsedQuery

will validated and parsed query filters

public recaptcha(settings: object): ExpressMiddlewareFunction source

import recaptcha from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/restriction/recaptcha.js'

Implementation of reCAPTCHA rate restriction.

Will validate recaptcha using req.body.recaptchaResponse value.

Requires node-recaptcha2 package.

Params:

Name	Type	Attribute	Description
settings	object	optional	settings for recaptcha, or null to disable
settings.privateKey	string		also known as secret key
settings.publicKey	string		also known as site key

Return:

ExpressMiddlewareFunction

public reject(res: Response, audit: string, extra: string): * source

import reject from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/helper/reject.js'

Returns a function that calls res.error

Params:

Name	Type	Attribute	Description
res	Response		use as res.reject(...)
audit	string	optional default: false	audit event type
extra	string	optional default: undefined	extra audit payload which may help debug event

Return:

public resolve(res: Response, promiseObj: Promise, message: string | object, audit: string, extra: string) source

import resolve from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/helper/resolve.js'

Monitors a Promise and returns success or error based on promise outcome.

Params:

Name	Type	Attribute	Description
res	Response		use as res.resolve(...)
promiseObj	Promise		Promise objecy to monitor
message	string \| object	optional default: undefined	success or error message to return; if this is not specified, result of promise is returned.
audit	string	optional default: false	audit event type. note that '_SUCCESS' or '_FAILURE' is attached to this type depenidng on outcome
extra	string	optional default: undefined	extra audit payload which may help debug event

public setup(app: Express, config: Config) source

import setup from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/setup.js'

Library entry point

Params:

Name	Type	Attribute	Description
app	Express		result of express()
config	Config		configuration

public success(res: Response, message: string | object, audit: string, extra: string) source

import success from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/helper/success.js'

Return success status and payload as response.

Params:

Name	Type	Attribute	Description
res	Response		use as res.success(...)
message	string \| object	optional default: 'Success'	success message to return
audit	string	optional default: false	audit event type
extra	string	optional default: undefined	extra audit payload which may help debug event

Function

Static Public

public LOGGEDIN(req: *, res: *, next: *): * source

Params:

Return:

public async assign(user: *, field: *, value: *, fieldMeta: *, loginUser: *) source

Params:

public async assign(user: *, field: *, value: *, fieldMeta: *, loginUser: *, config: *) source

Params:

public async assign(user: *, field: *, value: *, fieldMeta: *, loginUser: *, config: *) source

Params:

public async assign(user: *, field: *, value: *, fieldMeta: *, loginUser: *, config: *) source

Params:

public async assign(user: *, field: *, value: *, fieldMeta: *, loginUser: *) source

Params:

public audit(source: string, event: string, params: string) source

Params:

public bootstrap(app: *, config: *): ExpressMiddleware source

Params:

Return:

public callback(fn: Function, args: *): Promise source

Params:

Return:

public checkStrongPassword(password: *): boolean source

Params:

Return:

public defer(fn: Function, args: *) source

Params:

public error(res: Response, message: string | object, audit: string, extra: string) source

Params:

public escape(content: string): string source

Params:

Return:

public failure(settings: object): ExpressMiddlewareFunction source

Params:

Return:

public generate(length: number): string source

Params:

Return:

public generateId(): string source

Return:

public parse(searchMetadata: SearchMetadata, query: Query): ParsedQuery source

Params:

Return:

public recaptcha(settings: object): ExpressMiddlewareFunction source

Params:

Return:

public reject(res: Response, audit: string, extra: string): * source

Params:

Return:

public resolve(res: Response, promiseObj: Promise, message: string | object, audit: string, extra: string) source

Params:

public setup(app: Express, config: Config) source

Params:

public success(res: Response, message: string | object, audit: string, extra: string) source

Params:

public LOGGEDIN(req: , res: , next: ): source

public async assign(user: , field: , value: , fieldMeta: , loginUser: *) source

public async assign(user: , field: , value: , fieldMeta: , loginUser: , config: ) source

public async assign(user: , field: , value: , fieldMeta: , loginUser: , config: ) source

public async assign(user: , field: , value: , fieldMeta: , loginUser: , config: ) source

public async assign(user: , field: , value: , fieldMeta: , loginUser: *) source

public bootstrap(app: , config: ): ExpressMiddleware source