Kuzzle common objects

Common objects shared to various Kuzzle components and plugins.

Table of contents:

• Request
  • new Request(data, [options])
  • Attributes
  • Methods
    • serialize()
    • setError(error)
    • clearError()
    • setResult(result, [options = null])
    • addDeprecation(version, message)
  • Example
• RequestResponse
  • Attributes
  • Methods
    • getHeader(name)
    • removeHeader(name)
    • setHeader(name, value)
    • setHeaders(headers)
• RequestContext
  • new RequestContext([options])
  • Attributes
• RequestInput
  • new RequestInput(data)
  • Attributes
• KuzzleError
• BadRequestError
• ExternalServiceError
• ForbiddenError
• GatewayTimeoutError
• InternalError
• NotFoundError
• PartialError
• PluginImplementationError
• ServiceUnavailableError
• SizeLimitError
• UnauthorizedError

Request

This constructor is used to transform an API request into a standardized Kuzzle request.

new Request(data, [options])

Arguments

Name	Type	Description
data	object	Passed to RequestInput constructor
options	object	Optional initialization parameters

options may contain the following attributes:

Name	Type	Description
connection	object	Passed to RequestContext constructor
error	KuzzleError or Error	Invokes setError at initialization
requestId	string	Initializes the id property
result	(varies)	Invokes setResult at initialization
status	integer	HTTP error code
token	object	Passed to RequestContext constructor
user	object	Passed to RequestContext constructor

Attributes

Read-only

Name	Type	Description
timestamp	integer	Request creation timestamp

Writable

Name	Type	default	Description
id	string	Auto-generated UUID	Request unique identifier
status	integer	102	HTTP status code

Any undefined attribute from the list above will be set to null.

Please refer to our API Reference for a complete list of controllers-actions and their purposes.

Getters

Name	Type	Description
context	RequestContext	RequestContext object
error	KuzzleError	null
input	RequestInput	RequestInput object
response	RequestResponse	Response view of the request, standardized as the expected Kuzzle API response
result	(varies)	null
deprecations	object[]	undefined

Methods

serialize()

Serializes the Request object into a pair of POJOs that can be sent across the network, and then used to rebuild another equivalent Request object.

Example

let foo = request.serialize();
let bar = new Request(foo.data, foo.options);

setError(error)

Adds an error to the request, and sets the request's status to the error one.

Arguments

Name	Type	Description
error	KuzzleError or Error	Error object to set

If a KuzzleError is provided, the request's status attribute is set to the error one.

Otherwise, the provided error is encapsulated into a InternalError object, and the request's status is set to 500.

clearError()

Clear error from request: set error to null and set status to 200.

setResult(result, [options = null])

Sets the request's result.

Arguments

Name	Type	Description
result	(varies)	Request's result
options	object	Optional parameters

The options argument may contain the following properties:

Name	Type	Description	Default
status	integer	HTTP status code	200
headers	object	Protocol specific headers	null
raw	boolean	Asks Kuzzle to send the provided result directly, instead of encapsulating it in a Kuzzle response	false

Example

const Request = require('kuzzle-common-objects').Request;
 
let request = new Request({
  controller: 'document',
  action: 'create',
  index: 'foo',
  collection: 'bar',
  _id: 'some document ID',
  body: {
    document: 'content'
  },
  volatile: {
    some: 'volatile data'
  },
  foo: 'bar'
});
 
console.dir(request.serialize(), {depth: null});

Result:

{ 
  data: { 
    timestamp: 1482143102957,
    requestId: '26d4ec6d-aafb-4ef8-951d-47666e5cf3ba',
    jwt: null,
    volatile: { some: 'volatile data' },
    body: { document: 'content' },
    controller: 'document',
    action: 'create',
    index: 'foo',
    collection: 'bar',
    _id: 'some document ID',
    foo: 'bar' 
  },
  options: { 
    connection: {
      id: null,
      protocol: null,
      ips: [],
      misc: {}
    },
   result: null,
   error: null,
   status: 102 
  } 
}

addDeprecation(version, message)

Adds a deprecation on the request object allowing to notify when a controller or an action is deprecated for a specific version of Kuzzle

::: info Deprecation messages in request responses will only be added during development stages, i.e. if the NODE_ENV environment variable is set to development. :::

Arguments

Name	Type	Description
version	string	target version of the deprecation
message	string	description of the deprecation

Example

let request = new Request({});
request.addDeprecation('1.0.0', 'You should now use Kuzzle v2')
console.log(request.deprecations) // [{ version: '1.0.0', message: 'You should now use Kuzzle v2' }]

RequestResponse

This object is not exposed and can only be retrieved using the Request.response getter.

Network protocol specific headers can be added to the response. If the protocol can handle them, these headers will be used to configure the response sent to the client.
As Kuzzle supports the HTTP protocol natively, this object handles HTTP headers special cases. Other network protocols headers are stored in raw format, and protocol plugins need to handle their own specific headers manually.

Header names are case insensitive.

Example

if (request.context.connection.protocol === 'http') {
  request.response.setHeader('Content-Type', 'text/plain');
}

Attributes

Writable

Name	Type	Description
error	KuzzleError	Response error, or null
result	*	Response result, or null
status	integer	Response HTTP status code

Getters

Name	Type	Description
action	string	Parent request invoked controller action
collection	string	Parent request data collection
controller	string	Parent request invoked controller
headers	object	An object describing all currently registered headers on that response
index	string	Parent request data index
volatile	object	Parent request volatile data
requestId	string	Parent request unique identifier
deprecations	object[]	Deprecations

Methods

getHeader(name)

Returns the value registered for the response header name

Arguments

Name	Type	Description
name	string	Header name

removeHeader(name)

Removes header name from the response headers.

setHeader(name, value)

Adds a header name with value value to the response headers.

Arguments

Name	Type	Description
name	string	Header name
value	string	Header value

For standard headers, if name already exists, then the provided value will be concatenated to the existing value, separated by a comma.

As Kuzzle implements HTTP natively, this behavior changes for some HTTP specific headers, to comply with the norm. For instance set-cookie values are amended in an array, and other headers like user-agent or host can store only 1 value.

setHeaders(headers)

Adds multiple items to the response headers.

Arguments

Name	Type	Description
headers	object	An object describing the headers to set

The setHeader method will be called for each item of the headers argument.

RequestContext

This constructor is used to create a connection context used by Request.

new RequestContext([options])

Arguments

Name	Type	Description
options	object	Optional initialization parameters

options may contain the following attributes:

Name	Type	Description
connection	object	Connection information
token	object	Kuzzle internal authorization token object
user	object	Kuzzle internal user info object

Attributes

Writable

Name	Type	Description
connection	object	Connection information
connectionId	string	(deprecated use connection.id instead) Client's connection unique ID
protocol	string	(deprecated use connection.protocol instead) Network protocol name
token	object	Kuzzle internal authorization token object
user	object	Kuzzle internal user info object

RequestContext.Connection object format

Name	Type	Description
id	string	Connection unique identifier
protocol	string	Protocol name (e.g. 'http', 'websocket', 'mqtt', ...)
ips	array	Array of known IP addresses for the connection
misc	object	Contain additional connection properties, depending on the connection's protocol used (for instance, input HTTP headers)

RequestInput

Contains the request's input data

new RequestInput(data)

Arguments

Name	Type	Description
data	object	Standardized API request (see Websocket requests for instance)

data may contain some or all of the following attributes:

Name	Type	Description
_id	string	Document unique identifier
action	string	Kuzzle action to perform
body	object	Contains request specific data (document content, search queries, ...)
collection	string	Data collection
controller	string	Kuzzle controller handling the action to perform
index	string	Data index
volatile	object	Client's request specific volatile data
jwt	string	JWT Authentication token

Other attributes may be defined and will automatically be added to the args object.

Attributes

Writable

Name	Type	Default	Description
action	string	null	Controller's action to execute
args	object	(empty)	Contains specific request arguments
body	object	null	Request's body (for instance, the content of a document)
headers	object	request input headers (e.g. HTTP headers for HTTP or Websocket protocols)
controller	string	null	Kuzzle's controller to invoke
volatile	object	null	Request volatile data
resource._id	string	null	Document unique identifier
resource.collection	string	null	Data collection
resource.index	string	null	Data index
jwt	string	null	JWT Authentication token

KuzzleError

Inherits from Error. Abstract class inherited by Kuzzle error objects.

This class should only be used to create new Kuzzle error objects.

BadRequestError

Status Code: 400

Used to notify about badly formed requests.

const { { BadRequestError } = require('kuzzle-common-objects');
 
throw new BadRequestError('error message');

ExternalServiceError

Status Code: 500

Used when an external service answers to a request with an error other than a bad request or a service unavailable one.

const { ExternalServiceError } = require('kuzzle-common-objects');
 
throw new ExternalServiceError('error message');

ForbiddenError

Status Code: 403

Used when a user tries to use resources beyond his access rights.

const { ForbiddenError } = require('kuzzle-common-objects');
 
throw new ForbiddenError('error message');

GatewayTimeoutError

Status Code: 504

Used when a plugin takes too long to perform a task.

const { GatewayTimeoutError } = require('kuzzle-common-objects');
 
throw new GatewayTimeoutError('error message');

InternalError

Status Code: 500

Standard generic error. Used mainly for uncatched exceptions.

const { InternalError } = require('kuzzle-common-objects');
 
throw new InternalError('error message');

NotFoundError

Status Code: 404

Used when asked resources cannot be found.

const { NotFoundError } = require('kuzzle-common-objects');
 
throw new NotFoundError('error message');

PartialError

Status Code: 206

Used when a request only partially succeeded.

The constructor takes an additional array argument containing a list of failed parts.

const { PartialError } = require('kuzzle-common-objects');
 
throw new PartialError('error message', [{this: 'failed'}, {andThis: 'failed too'}]);

PluginImplementationError

Status Code: 500

Used when a plugin fails.

const { PluginImplementationError } = require('kuzzle-common-objects');
 
throw new PluginImplementationError('error message');

ServiceUnavailableError

Status Code: 503

Used when a service cannot respond because it is temporarily unavailable.

const { ServiceUnavailableError } = require('kuzzle-common-objects');
 
throw new ServiceUnavailableError('error message');

SizeLimitError

Status Code: 413

Used to notify about requests exceeding maximum limits.

const { SizeLimitError } = require('kuzzle-common-objects');
 
throw new SizeLimitError('error message');

UnauthorizedError

Status Code: 401

Used when a user fails a login attempt.

const { UnauthorizedError } = require('kuzzle-common-objects');
 
throw new UnauthorizedError('error message');