rqlite-js 2.5.2 → 2.5.5

package/.eslintrc

@@ -16,5 +16,5 @@
     "semi": [2, "never"],
     "space-before-function-paren": [2, "always"]
   },
-  "parser": "babel-eslint"
+  "parser": "@babel/eslint-parser"
 }

package/.travis.yml

@@ -13,8 +13,8 @@ cache:
     - "node_modules"
 
 before_install:
-  - docker pull rqlite/rqlite:5.5.0
-  - docker run -d -p 4001:4001 -p 4002:4002 --name=rqlite-js rqlite/rqlite:5.5.0
+  - docker pull rqlite/rqlite:5.12.1
+  - docker run -d -p 4001:4001 -p 4002:4002 --name=rqlite-js rqlite/rqlite:5.12.1
 
 script:
   - npm run build-all

package/es6/api/client/index.js

@@ -5,6 +5,11 @@
 import HttpRequest from '../../http-request'
 import { HTTP_METHOD_GET, HTTP_METHOD_POST } from '../../http-request/http-methods'
 
+/**
+ * @typedef HttpRequestOptions
+ * @type {import('../../http-request').HttpRequestOptions}
+ */
+
 /**
  * Create the base HTTP query options from RQLite API options
  * @param {Object} [options={}] The RQLite API options
@@ -40,7 +45,8 @@ export default class ApiClient extends HttpRequest {
   /**
    * Perform a RQLite data API get request
    * @param {String} path The path for the request i.e. /db/query
-   * @param {Object} [options={}] RQLite API options
+   * @param {String} sql The SQL query
+   * @param {HttpRequestOptions} [options={}] RQLite API options
    */
   async get (path, sql, options = {}) {
     const { useLeader } = options
@@ -58,8 +64,8 @@ export default class ApiClient extends HttpRequest {
   /**
    * Perform a RQLite data API post request
    * @param {String} path The path for the request i.e. /db/query
-   * @param {String[]|String} path The path for the request i.e. /db/query
-   * @param {Object} [options={}] RQLite API options
+   * @param {String} sql The SQL query
+   * @param {HttpRequestOptions} [options={}] RQLite API options
    */
   async post (path, sql, options = {}) {
     const { useLeader } = options

package/es6/api/data/index.js

@@ -34,12 +34,42 @@ export const CONSISTENCY_LEVEL_STRONG = 'strong'
  */
 export const CONSISTENCY_LEVEL_WEAK = 'weak'
 
+/**
+ * @typedef HttpRequestOptions
+ * @type {import('../../http-request').HttpRequestOptions}
+ */
+
+/**
+ * Data request base options
+ * @typedef DataRequestBaseOptions
+ * @type {Object}
+ * @property {Boolean} [raw] If true return the raw http response from
+ * RQLite response
+ */
+
+/**
+ * Data query request base options
+ * @typedef QueryRequestBaseOptions
+ * @type {Object}
+ * @property {String} level The api consistency level
+ */
+
+/**
+ * Data query request options
+ * @typedef QueryRequestOptions
+ * @type {HttpRequestOptions & DataRequestBaseOptions & QueryRequestBaseOptions}
+ */
+
+/**
+ * Data execute request options
+ * @typedef ExecuteRequestOptions
+ * @type {HttpRequestOptions & DataRequestBaseOptions}
+ */
+
 /**
  * Send an RQLite query API request to the RQLite server
  * @param {String} sql The SQL string to excute on the server
- * @param {Object} [options={}] RQLite api options
- * @param {Object} [options.raw] If true return the raw http resposne from
- * RQLite response
+ * @param {DataRequestBaseOptions} [options={}] RQLite api options
  */
 function handleResponse (response, options = {}) {
   const { raw } = options
@@ -57,9 +87,7 @@ export default class DataApiClient extends ApiClient {
   /**
    * Send an RQLite query API request to the RQLite server
    * @param {String} sql The SQL string to excute on the server
-   * @param {Object} [options={}] RQLite api options
-   * @param {Object} [options.raw] If true return the raw http resposne from
-   * RQLite response
+   * @param {QueryRequestOptions} [options={}] RQLite api options
    */
   async query (sql, options = {}) {
     const { level } = options
@@ -86,7 +114,7 @@ export default class DataApiClient extends ApiClient {
   /**
    * Send an RQLite execute API request to the RQLite server
    * @param {String} sql The SQL string to excute on the server
-   * @param {Object} [options={}] RQLite api options
+   * @param {ExecuteRequestOptions} [options={}] RQLite execute api options
    */
   async execute (sql, options = {}) {
     const response = await super.post(PATH_EXECUTE, sql, options)

package/es6/api/results/data-result-error.js

@@ -8,6 +8,12 @@
  * API call
  */
 export default class DataResultError extends Error {
+  constructor (...args) {
+    super(...args)
+    this.name = this.constructor.name
+    this.code = this.constructor.name
+  }
+
   /**
    * Get the result data error as plain object
    * @returns {Object} The data as an object

package/es6/api/results/data-result.js

@@ -10,8 +10,9 @@
 export default class DataResult {
   /**
    * The time the results query took to complete
+   * @type {Number}
    */
-  time = 0
+  time = 0.0
 
   /**
    * The last insert id
@@ -23,7 +24,7 @@ export default class DataResult {
    * The rows affected
    * @type {Number}
    */
-  rowsAffected
+  rowsAffected = 0
 
   /**
    * An array of DataResult and/or DataResultError instances
@@ -49,8 +50,8 @@ export default class DataResult {
     if (typeof valuesIndex !== 'undefined' && !Number.isFinite(valuesIndex)) {
       throw new Error('The valuesIndex argument is required to be a finite number when provided')
     }
-    this.time = result.time
-    this.rowsAffected = result.rows_affected
+    this.time = parseFloat(result.time || 0.0)
+    this.rowsAffected = parseInt(result.rows_affected || 0, 10)
     this.lastInsertId = result.last_insert_id
     // Map the values array to an object where columns are the properties
     if (Number.isFinite(valuesIndex)) {
@@ -76,7 +77,7 @@ export default class DataResult {
 
   /**
    * Get the time the result took
-   * @returns {Number}
+   * @returns {Number} The time the query took
    */
   getTime () {
     return this.time

package/es6/api/results/data-results.js

@@ -12,8 +12,9 @@ export default class DataResults {
   /**
    * The time the results took to return from the
    * RQLite api
+   * @type {Number}
    */
-  time = 0
+  time = 0.0
 
   /**
    * The results which is an empty arry to start
@@ -23,8 +24,9 @@ export default class DataResults {
 
   /**
    * The data result list constructor
-   * @param {Array} data The data object sent from a RQLite API response
-   * @param {Number} time The time the API response took to complete
+   * @param {Object} data The data object sent from a RQLite API response
+   * @param {Number} data.time The time the API response took to complete
+   * @param {Object[{error:String,values:Object}]} data.results The results array
    */
   constructor (data) {
     this.setApiData(data)
@@ -41,7 +43,7 @@ export default class DataResults {
     if (!data.results) {
       throw new Error('The data object is required to have a results property')
     }
-    this.time = data.time || 0
+    this.time = parseFloat(data.time || 0.0)
     const { results = [] } = data
     this.results = results.reduce((acc, result) => {
       // If there is an error property this is an error
@@ -77,7 +79,7 @@ export default class DataResults {
 
   /**
    * Get the time the results took
-   * @param {Number}
+   * @returns {Number} The time the query took
    */
   getTime () {
     return this.time
@@ -113,7 +115,7 @@ export default class DataResults {
    * @returns {String} A JSON string
    */
   toString () {
-    const list = this.results.map((result) => result.toString())
+    const list = this.results.map((result) => result.toObject())
     return JSON.stringify(list)
   }
 }

package/es6/api/status/index.js

@@ -38,7 +38,7 @@ export default class StatusApiClient extends ApiClient {
    * Get the RQLite server status for all hosts as an array of object with
    * the host and their status
    * @param {Object} [options={}] RQLite api options
-   * @param {Object} [options.raw] If true return the raw http resposne from
+   * @param {Object} [options.raw] If true return the raw http response from
    * RQLite response
    * @returns {StatusAllHostsResponse[]} An array of http response for the provide hosts
    */

package/es6/http-request/content-types.js

@@ -1,4 +1,4 @@
 export const CONTENT_TYPE_TEXT_PLAIN = 'text/plain'
-export const CONTENT_TYPE_APPLICATION_JSON = 'application/json;charset=utf-8'
+export const CONTENT_TYPE_APPLICATION_JSON = 'application/json'
 export const CONTENT_TYPE_APPLICATION_X_WWW_FORM_URLENCODED = 'application/x-www-form-urlencoded'
 export const CONTENT_TYPE_APPLICATION_OCTET_STREAM = 'application/octet-stream'

package/es6/http-request/index.js

@@ -20,6 +20,41 @@ import {
   RETRYABLE_STATUS_CODES,
 } from './retryable'
 
+/**
+ * RQliteJS HTTP Request options
+ * @typedef HttpRequestOptions
+ * @type {Object}
+ * @property {Object} [auth] A object for user authentication
+ * @property {String} [auth.username] The username for authentication
+ * @property {String} [auth.password] The username for authentication
+ * @property {Object} [body] The body of the HTTP request
+ * @property {Object} [headers={}] HTTP headers to send with the request
+ * @property {String} [httpMethod=HTTP_METHOD_GET] The HTTP method for the request
+ * i.e. GET or POST
+ * @property {Object} [query] An object with the query to send with the HTTP request
+ * @property {Boolean} [stream=false] When true the returned value is a request object with
+ * stream support instead of a request-promise result
+ * @property {Number} [timeout=DEAULT_TIMEOUT] Optional timeout to override default
+ * @property {String} uri The uri for the request which can be a relative path to use
+ * the currently active host or a full i.e. http://localhost:4001/db/query which is used
+ * literally
+ * @property {Boolean} [useLeader=false] When true the request will use the master host, the
+ * first host in this.hosts, this is ideal for write operations to skip the redirect
+ * @property {Number} [retries] The number of retries, defaults to the number of
+ * hosts times 3
+ * @property {Number} [maxRedirects=10] The maximum number of HTTP redirects to follow before
+ * throwing an error
+ * @property {Number} [attempt=0] The current attempt count when retrying or redirecting
+ * @property {Number} [retryAttempt=0] The current attempt based on retry logic
+ * @property {Number} [redirectAttempt=0] The current attempt based on redirect logic
+ * @property {Number} [attemptHostIndex] When in a retry state the host index of the last
+ * attempt which is used to get the next host index
+ * @property {import('http').Agent} [httpAgent] An option http agent, useful for
+ * keepalive pools using plain HTTP
+ * @property {import('https').Agent} [httpsAgent] An option http agent, useful
+ * for keepalive pools using SSL
+ */
+
 /**
  * The default timeout value
  */
@@ -536,36 +571,7 @@ export default class HttpRequest {
 
   /**
    * Perform an HTTP request using the provided options
-   * @param {Object} [options={}] Options for the HTTP client
-   * @param {Object} [options.auth] A object for user authentication
-   * @param {String} [options.auth.username] The username for authentication
-   * @param {String} [options.auth.password] The username for authentication
-   * @param {Object} [options.body] The body of the HTTP request
-   * @param {Object} [options.headers={}] HTTP headers to send with the request
-   * @param {String} [options.httpMethod=HTTP_METHOD_GET] The HTTP method for the request
-   * i.e. GET or POST
-   * @param {Object} [options.query] An object with the query to send with the HTTP request
-   * @param {Boolean} [options.stream=false] When true the returned value is a request object with
-   * stream support instead of a request-promise result
-   * @param {Number} [options.timeout=DEAULT_TIMEOUT] Optional timeout to override default
-   * @param {String} options.uri The uri for the request which can be a relative path to use
-   * the currently active host or a full i.e. http://localhost:4001/db/query which is used
-   * literally
-   * @param {Boolean} [options.useLeader=false] When true the request will use the master host, the
-   * first host in this.hosts, this is ideal for write operations to skip the redirect
-   * @param {Number} [options.retries] The number of retries, defaults to the number of
-   * hosts times 3
-   * @param {Number} [options.maxRedirects=10] The maximum number of HTTP redirects to follow before
-   * throwing an error
-   * @param {Number} [options.attempt=0] The current attempt count when retrying or redirecting
-   * @param {Number} [options.retryAttempt=0] The current attempt based on retry logic
-   * @param {Number} [options.redirectAttempt=0] The current attempt based on redirect logic
-   * @param {Number} [options.attemptHostIndex] When in a retry state the host index of the last
-   * attempt which is used to get the next host index
-   * @param {import('http').Agent} [options.httpAgent] An option http agent, useful for
-   * keepalive pools using plain HTTP
-   * @param {import('https').Agent} [options.httpsAgent] An option http agent, useful
-   * for keepalive pools using SSL
+   * @param {HttpRequestOptions} [options={}] Options for the HTTP client
    * @returns {Promise<{status: Number, body: Object|String}>} An object with a status and body
    * property when stream is false and a stream when the stream option is true
    * @throws {ERROR_HTTP_REQUEST_MAX_REDIRECTS} When the maximum number of redirect has been reached
@@ -670,7 +676,9 @@ export default class HttpRequest {
       }
       if (retryable && retryAttempt < retries) {
         const waitTime = getWaitTimeExponential(retryAttempt, exponentailBackoffBase)
-        const delayPromise = new Promise((resolve) => setTimeout(resolve, waitTime))
+        const delayPromise = new Promise((resolve) => {
+          setTimeout(resolve, waitTime)
+        })
         await delayPromise
         return this.fetch({
           ...options,
@@ -685,7 +693,7 @@ export default class HttpRequest {
 
   /**
    * Perform an HTTP GET request
-   * @param {Object} [options={}] The options
+   * @param {HttpRequestOptions} [options={}] The options
    * @see this.fetch() for options
    */
   async get (options = {}) {
@@ -694,7 +702,7 @@ export default class HttpRequest {
 
   /**
    * Perform an HTTP POST request
-   * @param {Object} [options={}] The options
+   * @param {HttpRequestOptions} [options={}] The options
    * @see this.fetch() for options
    */
   async post (options = {}) {

package/lib/api/backup/index.js

@@ -1,4 +1,4 @@
-"use strict";var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");Object.defineProperty(exports, "__esModule", { value: true });exports.default = exports.BACKUP_DATA_FORMAT_DUMP = exports.BACKUP_DATA_FORMAT_SQL = exports.PATH_BACKUP = exports.PATH_LOAD = void 0;var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+"use strict";var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");Object.defineProperty(exports, "__esModule", { value: true });exports.default = exports.PATH_LOAD = exports.PATH_BACKUP = exports.BACKUP_DATA_FORMAT_SQL = exports.BACKUP_DATA_FORMAT_DUMP = void 0;var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
 
 

package/lib/api/backup/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../es6/api/backup/index.js"],"names":["PATH_LOAD","PATH_BACKUP","BACKUP_DATA_FORMAT_SQL","BACKUP_DATA_FORMAT_DUMP","BackupApiClient","HttpRequest","backup","format","stream","headers","Accept","CONTENT_TYPE_APPLICATION_OCTET_STREAM","query","fmt","undefined","json","uri","useLeader","load","data","body","CONTENT_TYPE_TEXT_PLAIN"],"mappings":";;;;AAIA;AACA,gE,CALA;AACA;AACA;AACA,G,CAIA;AACA;AACA,GACO,MAAMA,SAAS,GAAG,UAAlB;;AAEP;AACA;AACA,G;AACO,MAAMC,WAAW,GAAG,YAApB;;AAEP;AACA;AACA,G;AACO,MAAMC,sBAAsB,GAAG,KAA/B;;AAEP;AACA;AACA,G;AACO,MAAMC,uBAAuB,GAAG,MAAhC;;AAEP;AACA;AACA,G;AACe,MAAMC,eAAN,SAA8BC,oBAA9B,CAA0C;AACvD;AACF;AACA;AACA;AACA;AACQC,EAAAA,MAAN,CAAcC,MAAM,GAAGJ,uBAAvB,EAAgD;AAC9C,YAAMK,MAAM,GAAG,gCAAU;AACvBC,QAAAA,OAAO,EAAE;AACP;AACAC,UAAAA,MAAM,EAAEC,mDAFD,EADc;;AAKvBC,QAAAA,KAAK,EAAE,EAAEC,GAAG,EAAEN,MAAM,KAAKL,sBAAX,GAAoCK,MAApC,GAA6CO,SAApD,EALgB;AAMvBC,QAAAA,IAAI,EAAE,KANiB;AAOvBP,QAAAA,MAAM,EAAE,IAPe;AAQvBQ,QAAAA,GAAG,EAAEf,WARkB;AASvBgB,QAAAA,SAAS,EAAE,IATY,EAAV,CAAf;;AAWA,aAAOT,MAAP,CAZ8C;AAa/C;;AAED;AACF;AACA;AACA;AACA;AACA;AACQU,EAAAA,IAAN,CAAYC,IAAZ,EAAkBZ,MAAM,GAAGL,sBAA3B,EAAmD;AACjD,aAAO,kCAAW;AAChBkB,QAAAA,IAAI,EAAED,IADU;AAEhBV,QAAAA,OAAO,EAAE;AACP;AACA,0BAAgBF,MAAM,KAAKL,sBAAX,GAAoCmB,qCAApC,GAA8DV,mDAFvE,EAFO;;AAMhBI,QAAAA,IAAI,EAAE,KANU;AAOhBP,QAAAA,MAAM,EAAE,IAPQ;AAQhBQ,QAAAA,GAAG,EAAEhB,SARW;AAShBiB,QAAAA,SAAS,EAAE,IATK,EAAX,CAAP,CADiD;;AAYlD,GAvCsD,C","sourcesContent":["/**\n * Backup api client to perform RQLite back and load operations\n * @module api/backup\n */\nimport HttpRequest from '../../http-request'\nimport { CONTENT_TYPE_APPLICATION_OCTET_STREAM, CONTENT_TYPE_TEXT_PLAIN } from '../../http-request/content-types'\n\n/**\n * The RQLite load api path\n */\nexport const PATH_LOAD = '/db/load'\n\n/**\n * The RQLite backup api path\n */\nexport const PATH_BACKUP = '/db/backup'\n\n/**\n * Use plain SQL dump as the back up format\n */\nexport const BACKUP_DATA_FORMAT_SQL = 'sql'\n\n/**\n * Use sqlite3 dump as the back up format\n */\nexport const BACKUP_DATA_FORMAT_DUMP = 'dump'\n\n/**\n * Backup api client to perform RQLite back up and load operations\n */\nexport default class BackupApiClient extends HttpRequest {\n  /**\n   * Perform a SQL dump backup from the RQLite server\n   * @param {String} [format=BACKUP_DATA_FORMAT_DUMP] The backup data format\n   * @returns {Stream} The response stream\n   */\n  async backup (format = BACKUP_DATA_FORMAT_DUMP) {\n    const stream = super.get({\n      headers: {\n        // Always sends application/octet-stream from the server in RQLite v4.x\n        Accept: CONTENT_TYPE_APPLICATION_OCTET_STREAM,\n      },\n      query: { fmt: format === BACKUP_DATA_FORMAT_SQL ? format : undefined },\n      json: false,\n      stream: true,\n      uri: PATH_BACKUP,\n      useLeader: true,\n    })\n    return stream\n  }\n\n  /**\n   * Perform a SQL restore by sending data the RQLite server\n   * @param {Buffer|String} data The data to be loaded\n   * @param {String} [format=BACKUP_DATA_FORMAT_SQL] The backup data format\n   * @returns {Stream} The response stream\n   */\n  async load (data, format = BACKUP_DATA_FORMAT_SQL) {\n    return super.post({\n      body: data,\n      headers: {\n        // eslint-disable-next-line max-len\n        'Content-Type': format === BACKUP_DATA_FORMAT_SQL ? CONTENT_TYPE_TEXT_PLAIN : CONTENT_TYPE_APPLICATION_OCTET_STREAM,\n      },\n      json: false,\n      stream: true,\n      uri: PATH_LOAD,\n      useLeader: true,\n    })\n  }\n}\n"],"file":"index.js"}
+{"version":3,"file":"index.js","names":["PATH_LOAD","PATH_BACKUP","BACKUP_DATA_FORMAT_SQL","BACKUP_DATA_FORMAT_DUMP","BackupApiClient","HttpRequest","backup","format","stream","headers","Accept","CONTENT_TYPE_APPLICATION_OCTET_STREAM","query","fmt","undefined","json","uri","useLeader","load","data","body","CONTENT_TYPE_TEXT_PLAIN"],"sources":["../../../es6/api/backup/index.js"],"sourcesContent":["/**\n * Backup api client to perform RQLite back and load operations\n * @module api/backup\n */\nimport HttpRequest from '../../http-request'\nimport { CONTENT_TYPE_APPLICATION_OCTET_STREAM, CONTENT_TYPE_TEXT_PLAIN } from '../../http-request/content-types'\n\n/**\n * The RQLite load api path\n */\nexport const PATH_LOAD = '/db/load'\n\n/**\n * The RQLite backup api path\n */\nexport const PATH_BACKUP = '/db/backup'\n\n/**\n * Use plain SQL dump as the back up format\n */\nexport const BACKUP_DATA_FORMAT_SQL = 'sql'\n\n/**\n * Use sqlite3 dump as the back up format\n */\nexport const BACKUP_DATA_FORMAT_DUMP = 'dump'\n\n/**\n * Backup api client to perform RQLite back up and load operations\n */\nexport default class BackupApiClient extends HttpRequest {\n  /**\n   * Perform a SQL dump backup from the RQLite server\n   * @param {String} [format=BACKUP_DATA_FORMAT_DUMP] The backup data format\n   * @returns {Stream} The response stream\n   */\n  async backup (format = BACKUP_DATA_FORMAT_DUMP) {\n    const stream = super.get({\n      headers: {\n        // Always sends application/octet-stream from the server in RQLite v4.x\n        Accept: CONTENT_TYPE_APPLICATION_OCTET_STREAM,\n      },\n      query: { fmt: format === BACKUP_DATA_FORMAT_SQL ? format : undefined },\n      json: false,\n      stream: true,\n      uri: PATH_BACKUP,\n      useLeader: true,\n    })\n    return stream\n  }\n\n  /**\n   * Perform a SQL restore by sending data the RQLite server\n   * @param {Buffer|String} data The data to be loaded\n   * @param {String} [format=BACKUP_DATA_FORMAT_SQL] The backup data format\n   * @returns {Stream} The response stream\n   */\n  async load (data, format = BACKUP_DATA_FORMAT_SQL) {\n    return super.post({\n      body: data,\n      headers: {\n        // eslint-disable-next-line max-len\n        'Content-Type': format === BACKUP_DATA_FORMAT_SQL ? CONTENT_TYPE_TEXT_PLAIN : CONTENT_TYPE_APPLICATION_OCTET_STREAM,\n      },\n      json: false,\n      stream: true,\n      uri: PATH_LOAD,\n      useLeader: true,\n    })\n  }\n}\n"],"mappings":";;;;AAIA;AACA,gE,CALA;AACA;AACA;AACA,G,CAIA;AACA;AACA,GACO,MAAMA,SAAS,GAAG,UAAlB;;AAEP;AACA;AACA,G;AACO,MAAMC,WAAW,GAAG,YAApB;;AAEP;AACA;AACA,G;AACO,MAAMC,sBAAsB,GAAG,KAA/B;;AAEP;AACA;AACA,G;AACO,MAAMC,uBAAuB,GAAG,MAAhC;;AAEP;AACA;AACA,G;AACe,MAAMC,eAAN,SAA8BC,oBAA9B,CAA0C;EACvD;AACF;AACA;AACA;AACA;EACQC,MAAM,CAAEC,MAAM,GAAGJ,uBAAX,EAAoC;MAC9C,MAAMK,MAAM,GAAG,gCAAU;QACvBC,OAAO,EAAE;UACP;UACAC,MAAM,EAAEC,mDAFD,EADc;;QAKvBC,KAAK,EAAE,EAAEC,GAAG,EAAEN,MAAM,KAAKL,sBAAX,GAAoCK,MAApC,GAA6CO,SAApD,EALgB;QAMvBC,IAAI,EAAE,KANiB;QAOvBP,MAAM,EAAE,IAPe;QAQvBQ,GAAG,EAAEf,WARkB;QASvBgB,SAAS,EAAE,IATY,EAAV,CAAf;;MAWA,OAAOT,MAAP,CAZ8C;EAa/C;;EAED;AACF;AACA;AACA;AACA;AACA;EACQU,IAAI,CAAEC,IAAF,EAAQZ,MAAM,GAAGL,sBAAjB,EAAyC;MACjD,OAAO,kCAAW;QAChBkB,IAAI,EAAED,IADU;QAEhBV,OAAO,EAAE;UACP;UACA,gBAAgBF,MAAM,KAAKL,sBAAX,GAAoCmB,qCAApC,GAA8DV,mDAFvE,EAFO;;QAMhBI,IAAI,EAAE,KANU;QAOhBP,MAAM,EAAE,IAPQ;QAQhBQ,GAAG,EAAEhB,SARW;QAShBiB,SAAS,EAAE,IATK,EAAX,CAAP,CADiD;;EAYlD,CAvCsD,C"}

package/lib/api/client/index.js

@@ -3,7 +3,12 @@
 
 
 var _httpRequest = _interopRequireDefault(require("../../http-request"));
-var _httpMethods = require("../../http-request/http-methods");function ownKeys(object, enumerableOnly) {var keys = Object.keys(object);if (Object.getOwnPropertySymbols) {var symbols = Object.getOwnPropertySymbols(object);if (enumerableOnly) symbols = symbols.filter(function (sym) {return Object.getOwnPropertyDescriptor(object, sym).enumerable;});keys.push.apply(keys, symbols);}return keys;}function _objectSpread(target) {for (var i = 1; i < arguments.length; i++) {var source = arguments[i] != null ? arguments[i] : {};if (i % 2) {ownKeys(Object(source), true).forEach(function (key) {(0, _defineProperty2.default)(target, key, source[key]);});} else if (Object.getOwnPropertyDescriptors) {Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));} else {ownKeys(Object(source)).forEach(function (key) {Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));});}}return target;}
+var _httpMethods = require("../../http-request/http-methods");function ownKeys(object, enumerableOnly) {var keys = Object.keys(object);if (Object.getOwnPropertySymbols) {var symbols = Object.getOwnPropertySymbols(object);enumerableOnly && (symbols = symbols.filter(function (sym) {return Object.getOwnPropertyDescriptor(object, sym).enumerable;})), keys.push.apply(keys, symbols);}return keys;}function _objectSpread(target) {for (var i = 1; i < arguments.length; i++) {var source = null != arguments[i] ? arguments[i] : {};i % 2 ? ownKeys(Object(source), !0).forEach(function (key) {(0, _defineProperty2.default)(target, key, source[key]);}) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) {Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));});}return target;}
+
+/**
+ * @typedef HttpRequestOptions
+ * @type {import('../../http-request').HttpRequestOptions}
+ */
 
 /**
  * Create the base HTTP query options from RQLite API options
@@ -17,13 +22,13 @@ var _httpMethods = require("../../http-request/http-methods");function ownKeys(o
  * for RQLite v4 and lower
  * @returns {Object} The HTTP query
  */
-function createQuery(options = {}) {const
-  level = options.level,pretty = options.pretty,timings = options.timings,atomic = options.atomic,transaction = options.transaction;
+function createQuery(options = {}) {
+  const level = options.level,pretty = options.pretty,timings = options.timings,atomic = options.atomic,transaction = options.transaction;
 
   // Remove all undefined values
   const query = { level, pretty, timings, atomic, transaction };
-  return Object.entries(query).reduce((acc, entry) => {const _entry = (0, _slicedToArray2.default)(
-    entry, 2),key = _entry[0],val = _entry[1];
+  return Object.entries(query).reduce((acc, entry) => {
+    const _entry = (0, _slicedToArray2.default)(entry, 2),key = _entry[0],val = _entry[1];
     // Only take defined values
     if (typeof val !== 'undefined') {
       acc[key] = val;
@@ -40,10 +45,11 @@ class ApiClient extends _httpRequest.default {
   /**
    * Perform a RQLite data API get request
    * @param {String} path The path for the request i.e. /db/query
-   * @param {Object} [options={}] RQLite API options
+   * @param {String} sql The SQL query
+   * @param {HttpRequestOptions} [options={}] RQLite API options
    */
-  get(path, sql, options = {}) {var _superprop_getGet = () => super.get,_this = this;return (0, _asyncToGenerator2.default)(function* () {const
-      useLeader = options.useLeader;
+  get(path, sql, options = {}) {var _superprop_getGet = () => super.get,_this = this;return (0, _asyncToGenerator2.default)(function* () {
+      const useLeader = options.useLeader;
       if (!path) {
         throw new Error('The path argument is required');
       }
@@ -58,11 +64,11 @@ class ApiClient extends _httpRequest.default {
   /**
    * Perform a RQLite data API post request
    * @param {String} path The path for the request i.e. /db/query
-   * @param {String[]|String} path The path for the request i.e. /db/query
-   * @param {Object} [options={}] RQLite API options
+   * @param {String} sql The SQL query
+   * @param {HttpRequestOptions} [options={}] RQLite API options
    */
-  post(path, sql, options = {}) {var _superprop_getPost = () => super.post,_this2 = this;return (0, _asyncToGenerator2.default)(function* () {const
-      useLeader = options.useLeader;
+  post(path, sql, options = {}) {var _superprop_getPost = () => super.post,_this2 = this;return (0, _asyncToGenerator2.default)(function* () {
+      const useLeader = options.useLeader;
       if (!path) {
         throw new Error('The path argument is required');
       }

package/lib/api/client/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../es6/api/client/index.js"],"names":["createQuery","options","level","pretty","timings","atomic","transaction","query","Object","entries","reduce","acc","entry","key","val","ApiClient","HttpRequest","get","path","sql","useLeader","Error","uri","httpMethod","HTTP_METHOD_GET","q","post","HTTP_METHOD_POST","body","Array","isArray"],"mappings":";;;;AAIA;AACA,8D;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,WAAT,CAAsBC,OAAO,GAAG,EAAhC,EAAoC;AACjCC,EAAAA,KADiC,GACeD,OADf,CACjCC,KADiC,CAC1BC,MAD0B,GACeF,OADf,CAC1BE,MAD0B,CAClBC,OADkB,GACeH,OADf,CAClBG,OADkB,CACTC,MADS,GACeJ,OADf,CACTI,MADS,CACDC,WADC,GACeL,OADf,CACDK,WADC;;AAGzC;AACA,QAAMC,KAAK,GAAG,EAAEL,KAAF,EAASC,MAAT,EAAiBC,OAAjB,EAA0BC,MAA1B,EAAkCC,WAAlC,EAAd;AACA,SAAOE,MAAM,CAACC,OAAP,CAAeF,KAAf,EAAsBG,MAAtB,CAA6B,CAACC,GAAD,EAAMC,KAAN,KAAgB;AAC/BA,IAAAA,KAD+B,KAC3CC,GAD2C,aACtCC,GADsC;AAElD;AACA,QAAI,OAAOA,GAAP,KAAe,WAAnB,EAAgC;AAC9BH,MAAAA,GAAG,CAACE,GAAD,CAAH,GAAWC,GAAX;AACD;AACD,WAAOH,GAAP;AACD,GAPM,EAOJ,EAPI,CAAP;AAQD;;AAED;AACA;AACA;AACA;AACe,MAAMI,SAAN,SAAwBC,oBAAxB,CAAoC;AACjD;AACF;AACA;AACA;AACA;AACQC,EAAAA,GAAN,CAAWC,IAAX,EAAiBC,GAAjB,EAAsBlB,OAAO,GAAG,EAAhC,EAAoC;AAC1BmB,MAAAA,SAD0B,GACZnB,OADY,CAC1BmB,SAD0B;AAElC,UAAI,CAACF,IAAL,EAAW;AACT,cAAM,IAAIG,KAAJ,CAAU,+BAAV,CAAN;AACD;AACD,aAAO,gCAAU;AACfD,QAAAA,SADe;AAEfE,QAAAA,GAAG,EAAEJ,IAFU;AAGfK,QAAAA,UAAU,EAAEC,4BAHG;AAIfjB,QAAAA,KAAK,kCAAOP,WAAW,CAACC,OAAD,CAAlB,SAA6BwB,CAAC,EAAEN,GAAhC,GAJU,EAAV,CAAP,CALkC;;AAWnC;;AAED;AACF;AACA;AACA;AACA;AACA;AACQO,EAAAA,IAAN,CAAYR,IAAZ,EAAkBC,GAAlB,EAAuBlB,OAAO,GAAG,EAAjC,EAAqC;AAC3BmB,MAAAA,SAD2B,GACbnB,OADa,CAC3BmB,SAD2B;AAEnC,UAAI,CAACF,IAAL,EAAW;AACT,cAAM,IAAIG,KAAJ,CAAU,+BAAV,CAAN;AACD;AACD,aAAO,kCAAW;AAChBD,QAAAA,SADgB;AAEhBE,QAAAA,GAAG,EAAEJ,IAFW;AAGhBK,QAAAA,UAAU,EAAEI,6BAHI;AAIhBpB,QAAAA,KAAK,EAAEP,WAAW,CAACC,OAAD,CAJF;AAKhB2B,QAAAA,IAAI,EAAEC,KAAK,CAACC,OAAN,CAAcX,GAAd,IAAqBA,GAArB,GAA2B,CAACA,GAAD,CALjB,EAAX,CAAP,CALmC;;AAYpC,GArCgD,C","sourcesContent":["/**\n * Base API client for RQLite which abstracts the HTTP calls\n * @module api/client\n */\nimport HttpRequest from '../../http-request'\nimport { HTTP_METHOD_GET, HTTP_METHOD_POST } from '../../http-request/http-methods'\n\n/**\n * Create the base HTTP query options from RQLite API options\n * @param {Object} [options={}] The RQLite API options\n * @param {String} [options.level] The consistency level\n * @param {String} [options.pretty] Pretty print the response body\n * @param {String} [options.timings] Provide query timings\n * @param {String} [options.atomic] Treat all commands in the request as a single transaction\n * for RQLite v5 and higher\n * @param {String} [options.transaction] Treat all commands in the request as a single transaction\n * for RQLite v4 and lower\n * @returns {Object} The HTTP query\n */\nexport function createQuery (options = {}) {\n  const { level, pretty, timings, atomic, transaction } = options\n\n  // Remove all undefined values\n  const query = { level, pretty, timings, atomic, transaction }\n  return Object.entries(query).reduce((acc, entry) => {\n    const [key, val] = entry\n    // Only take defined values\n    if (typeof val !== 'undefined') {\n      acc[key] = val\n    }\n    return acc\n  }, {})\n}\n\n/**\n * Base API client for RQLite which abstracts the HTTP calls\n * from the user\n */\nexport default class ApiClient extends HttpRequest {\n  /**\n   * Perform a RQLite data API get request\n   * @param {String} path The path for the request i.e. /db/query\n   * @param {Object} [options={}] RQLite API options\n   */\n  async get (path, sql, options = {}) {\n    const { useLeader } = options\n    if (!path) {\n      throw new Error('The path argument is required')\n    }\n    return super.get({\n      useLeader,\n      uri: path,\n      httpMethod: HTTP_METHOD_GET,\n      query: { ...createQuery(options), q: sql },\n    })\n  }\n\n  /**\n   * Perform a RQLite data API post request\n   * @param {String} path The path for the request i.e. /db/query\n   * @param {String[]|String} path The path for the request i.e. /db/query\n   * @param {Object} [options={}] RQLite API options\n   */\n  async post (path, sql, options = {}) {\n    const { useLeader } = options\n    if (!path) {\n      throw new Error('The path argument is required')\n    }\n    return super.post({\n      useLeader,\n      uri: path,\n      httpMethod: HTTP_METHOD_POST,\n      query: createQuery(options),\n      body: Array.isArray(sql) ? sql : [sql],\n    })\n  }\n}\n"],"file":"index.js"}
+{"version":3,"file":"index.js","names":["createQuery","options","level","pretty","timings","atomic","transaction","query","Object","entries","reduce","acc","entry","key","val","ApiClient","HttpRequest","get","path","sql","useLeader","Error","uri","httpMethod","HTTP_METHOD_GET","q","post","HTTP_METHOD_POST","body","Array","isArray"],"sources":["../../../es6/api/client/index.js"],"sourcesContent":["/**\n * Base API client for RQLite which abstracts the HTTP calls\n * @module api/client\n */\nimport HttpRequest from '../../http-request'\nimport { HTTP_METHOD_GET, HTTP_METHOD_POST } from '../../http-request/http-methods'\n\n/**\n * @typedef HttpRequestOptions\n * @type {import('../../http-request').HttpRequestOptions}\n */\n\n/**\n * Create the base HTTP query options from RQLite API options\n * @param {Object} [options={}] The RQLite API options\n * @param {String} [options.level] The consistency level\n * @param {String} [options.pretty] Pretty print the response body\n * @param {String} [options.timings] Provide query timings\n * @param {String} [options.atomic] Treat all commands in the request as a single transaction\n * for RQLite v5 and higher\n * @param {String} [options.transaction] Treat all commands in the request as a single transaction\n * for RQLite v4 and lower\n * @returns {Object} The HTTP query\n */\nexport function createQuery (options = {}) {\n  const { level, pretty, timings, atomic, transaction } = options\n\n  // Remove all undefined values\n  const query = { level, pretty, timings, atomic, transaction }\n  return Object.entries(query).reduce((acc, entry) => {\n    const [key, val] = entry\n    // Only take defined values\n    if (typeof val !== 'undefined') {\n      acc[key] = val\n    }\n    return acc\n  }, {})\n}\n\n/**\n * Base API client for RQLite which abstracts the HTTP calls\n * from the user\n */\nexport default class ApiClient extends HttpRequest {\n  /**\n   * Perform a RQLite data API get request\n   * @param {String} path The path for the request i.e. /db/query\n   * @param {String} sql The SQL query\n   * @param {HttpRequestOptions} [options={}] RQLite API options\n   */\n  async get (path, sql, options = {}) {\n    const { useLeader } = options\n    if (!path) {\n      throw new Error('The path argument is required')\n    }\n    return super.get({\n      useLeader,\n      uri: path,\n      httpMethod: HTTP_METHOD_GET,\n      query: { ...createQuery(options), q: sql },\n    })\n  }\n\n  /**\n   * Perform a RQLite data API post request\n   * @param {String} path The path for the request i.e. /db/query\n   * @param {String} sql The SQL query\n   * @param {HttpRequestOptions} [options={}] RQLite API options\n   */\n  async post (path, sql, options = {}) {\n    const { useLeader } = options\n    if (!path) {\n      throw new Error('The path argument is required')\n    }\n    return super.post({\n      useLeader,\n      uri: path,\n      httpMethod: HTTP_METHOD_POST,\n      query: createQuery(options),\n      body: Array.isArray(sql) ? sql : [sql],\n    })\n  }\n}\n"],"mappings":";;;;AAIA;AACA,8D;;AAEA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,WAAT,CAAsBC,OAAO,GAAG,EAAhC,EAAoC;EACzC,MAAQC,KAAR,GAAwDD,OAAxD,CAAQC,KAAR,CAAeC,MAAf,GAAwDF,OAAxD,CAAeE,MAAf,CAAuBC,OAAvB,GAAwDH,OAAxD,CAAuBG,OAAvB,CAAgCC,MAAhC,GAAwDJ,OAAxD,CAAgCI,MAAhC,CAAwCC,WAAxC,GAAwDL,OAAxD,CAAwCK,WAAxC;;EAEA;EACA,MAAMC,KAAK,GAAG,EAAEL,KAAF,EAASC,MAAT,EAAiBC,OAAjB,EAA0BC,MAA1B,EAAkCC,WAAlC,EAAd;EACA,OAAOE,MAAM,CAACC,OAAP,CAAeF,KAAf,EAAsBG,MAAtB,CAA6B,CAACC,GAAD,EAAMC,KAAN,KAAgB;IAClD,4CAAmBA,KAAnB,KAAOC,GAAP,aAAYC,GAAZ;IACA;IACA,IAAI,OAAOA,GAAP,KAAe,WAAnB,EAAgC;MAC9BH,GAAG,CAACE,GAAD,CAAH,GAAWC,GAAX;IACD;IACD,OAAOH,GAAP;EACD,CAPM,EAOJ,EAPI,CAAP;AAQD;;AAED;AACA;AACA;AACA;AACe,MAAMI,SAAN,SAAwBC,oBAAxB,CAAoC;EACjD;AACF;AACA;AACA;AACA;AACA;EACQC,GAAG,CAAEC,IAAF,EAAQC,GAAR,EAAalB,OAAO,GAAG,EAAvB,EAA2B;MAClC,MAAQmB,SAAR,GAAsBnB,OAAtB,CAAQmB,SAAR;MACA,IAAI,CAACF,IAAL,EAAW;QACT,MAAM,IAAIG,KAAJ,CAAU,+BAAV,CAAN;MACD;MACD,OAAO,gCAAU;QACfD,SADe;QAEfE,GAAG,EAAEJ,IAFU;QAGfK,UAAU,EAAEC,4BAHG;QAIfjB,KAAK,kCAAOP,WAAW,CAACC,OAAD,CAAlB,SAA6BwB,CAAC,EAAEN,GAAhC,GAJU,EAAV,CAAP,CALkC;;EAWnC;;EAED;AACF;AACA;AACA;AACA;AACA;EACQO,IAAI,CAAER,IAAF,EAAQC,GAAR,EAAalB,OAAO,GAAG,EAAvB,EAA2B;MACnC,MAAQmB,SAAR,GAAsBnB,OAAtB,CAAQmB,SAAR;MACA,IAAI,CAACF,IAAL,EAAW;QACT,MAAM,IAAIG,KAAJ,CAAU,+BAAV,CAAN;MACD;MACD,OAAO,kCAAW;QAChBD,SADgB;QAEhBE,GAAG,EAAEJ,IAFW;QAGhBK,UAAU,EAAEI,6BAHI;QAIhBpB,KAAK,EAAEP,WAAW,CAACC,OAAD,CAJF;QAKhB2B,IAAI,EAAEC,KAAK,CAACC,OAAN,CAAcX,GAAd,IAAqBA,GAArB,GAA2B,CAACA,GAAD,CALjB,EAAX,CAAP,CALmC;;EAYpC,CAtCgD,C"}

package/lib/api/data/index.js

@@ -1,10 +1,10 @@
-"use strict";var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");Object.defineProperty(exports, "__esModule", { value: true });exports.default = exports.CONSISTENCY_LEVEL_WEAK = exports.CONSISTENCY_LEVEL_STRONG = exports.CONSISTENCY_LEVEL_NONE = exports.PATH_EXECUTE = exports.PATH_QUERY = void 0;var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+"use strict";var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");Object.defineProperty(exports, "__esModule", { value: true });exports.default = exports.PATH_QUERY = exports.PATH_EXECUTE = exports.CONSISTENCY_LEVEL_WEAK = exports.CONSISTENCY_LEVEL_STRONG = exports.CONSISTENCY_LEVEL_NONE = void 0;var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
 
 
 
 var _client = _interopRequireDefault(require("../client"));
-var _results = require("../results");function ownKeys(object, enumerableOnly) {var keys = Object.keys(object);if (Object.getOwnPropertySymbols) {var symbols = Object.getOwnPropertySymbols(object);if (enumerableOnly) symbols = symbols.filter(function (sym) {return Object.getOwnPropertyDescriptor(object, sym).enumerable;});keys.push.apply(keys, symbols);}return keys;}function _objectSpread(target) {for (var i = 1; i < arguments.length; i++) {var source = arguments[i] != null ? arguments[i] : {};if (i % 2) {ownKeys(Object(source), true).forEach(function (key) {(0, _defineProperty2.default)(target, key, source[key]);});} else if (Object.getOwnPropertyDescriptors) {Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));} else {ownKeys(Object(source)).forEach(function (key) {Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));});}}return target;}
+var _results = require("../results");function ownKeys(object, enumerableOnly) {var keys = Object.keys(object);if (Object.getOwnPropertySymbols) {var symbols = Object.getOwnPropertySymbols(object);enumerableOnly && (symbols = symbols.filter(function (sym) {return Object.getOwnPropertyDescriptor(object, sym).enumerable;})), keys.push.apply(keys, symbols);}return keys;}function _objectSpread(target) {for (var i = 1; i < arguments.length; i++) {var source = null != arguments[i] ? arguments[i] : {};i % 2 ? ownKeys(Object(source), !0).forEach(function (key) {(0, _defineProperty2.default)(target, key, source[key]);}) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) {Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));});}return target;}
 
 /**
  * The RQLite query api path
@@ -34,16 +34,46 @@ const CONSISTENCY_LEVEL_STRONG = 'strong';
  */exports.CONSISTENCY_LEVEL_STRONG = CONSISTENCY_LEVEL_STRONG;
 const CONSISTENCY_LEVEL_WEAK = 'weak';
 
+/**
+ * @typedef HttpRequestOptions
+ * @type {import('../../http-request').HttpRequestOptions}
+ */
+
+/**
+ * Data request base options
+ * @typedef DataRequestBaseOptions
+ * @type {Object}
+ * @property {Boolean} [raw] If true return the raw http response from
+ * RQLite response
+ */
+
+/**
+ * Data query request base options
+ * @typedef QueryRequestBaseOptions
+ * @type {Object}
+ * @property {String} level The api consistency level
+ */
+
+/**
+ * Data query request options
+ * @typedef QueryRequestOptions
+ * @type {HttpRequestOptions & DataRequestBaseOptions & QueryRequestBaseOptions}
+ */
+
+/**
+ * Data execute request options
+ * @typedef ExecuteRequestOptions
+ * @type {HttpRequestOptions & DataRequestBaseOptions}
+ */
+
 /**
  * Send an RQLite query API request to the RQLite server
  * @param {String} sql The SQL string to excute on the server
- * @param {Object} [options={}] RQLite api options
- * @param {Object} [options.raw] If true return the raw http resposne from
- * RQLite response
+ * @param {DataRequestBaseOptions} [options={}] RQLite api options
  */exports.CONSISTENCY_LEVEL_WEAK = CONSISTENCY_LEVEL_WEAK;
-function handleResponse(response, options = {}) {const
-  raw = options.raw;const
-  body = response.body;
+function handleResponse(response, options = {}) {
+  const raw = options.raw;
+  const body = response.body;
   if (raw) {
     return response;
   }
@@ -57,13 +87,11 @@ class DataApiClient extends _client.default {
   /**
    * Send an RQLite query API request to the RQLite server
    * @param {String} sql The SQL string to excute on the server
-   * @param {Object} [options={}] RQLite api options
-   * @param {Object} [options.raw] If true return the raw http resposne from
-   * RQLite response
+   * @param {QueryRequestOptions} [options={}] RQLite api options
    */
-  query(sql, options = {}) {var _superprop_getPost = () => super.post,_superprop_getGet = () => super.get,_this = this;return (0, _asyncToGenerator2.default)(function* () {const
-      level = options.level;let
-      useLeader = options.useLeader;
+  query(sql, options = {}) {var _superprop_getPost = () => super.post,_superprop_getGet = () => super.get,_this = this;return (0, _asyncToGenerator2.default)(function* () {
+      const level = options.level;
+      let useLeader = options.useLeader;
       // Weak and strong consistency will be redirect to the master anyway
       // so skip the redirect HTTP response and got right to the master
       if (level !== CONSISTENCY_LEVEL_NONE) {
@@ -86,7 +114,7 @@ class DataApiClient extends _client.default {
   /**
    * Send an RQLite execute API request to the RQLite server
    * @param {String} sql The SQL string to excute on the server
-   * @param {Object} [options={}] RQLite api options
+   * @param {ExecuteRequestOptions} [options={}] RQLite execute api options
    */
   execute(sql, options = {}) {var _superprop_getPost2 = () => super.post,_this2 = this;return (0, _asyncToGenerator2.default)(function* () {
       const response = yield _superprop_getPost2().call(_this2, PATH_EXECUTE, sql, options);

package/lib/api/data/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../es6/api/data/index.js"],"names":["PATH_QUERY","PATH_EXECUTE","CONSISTENCY_LEVEL_NONE","CONSISTENCY_LEVEL_STRONG","CONSISTENCY_LEVEL_WEAK","handleResponse","response","options","raw","body","DataResults","DataApiClient","ApiClient","query","sql","level","useLeader","Array","isArray","setNextActiveHostIndex","execute"],"mappings":";;;;;AAKA;AACA,qC;;AAEA;AACA;AACA;AACO,MAAMA,UAAU,GAAG,WAAnB;;AAEP;AACA;AACA,G;AACO,MAAMC,YAAY,GAAG,aAArB;;AAEP;AACA;AACA;AACA,G;AACO,MAAMC,sBAAsB,GAAG,MAA/B;;AAEP;AACA;AACA;AACA,G;AACO,MAAMC,wBAAwB,GAAG,QAAjC;;AAEP;AACA;AACA;AACA,G;AACO,MAAMC,sBAAsB,GAAG,MAA/B;;AAEP;AACA;AACA;AACA;AACA;AACA;AACA,G;AACA,SAASC,cAAT,CAAyBC,QAAzB,EAAmCC,OAAO,GAAG,EAA7C,EAAiD;AACvCC,EAAAA,GADuC,GAC/BD,OAD+B,CACvCC,GADuC;AAEvCC,EAAAA,IAFuC,GAE9BH,QAF8B,CAEvCG,IAFuC;AAG/C,MAAID,GAAJ,EAAS;AACP,WAAOF,QAAP;AACD;AACD,SAAO,IAAII,oBAAJ,CAAgBD,IAAhB,CAAP;AACD;;AAED;AACA;AACA;AACe,MAAME,aAAN,SAA4BC,eAA5B,CAAsC;AACnD;AACF;AACA;AACA;AACA;AACA;AACA;AACQC,EAAAA,KAAN,CAAaC,GAAb,EAAkBP,OAAO,GAAG,EAA5B,EAAgC;AACtBQ,MAAAA,KADsB,GACZR,OADY,CACtBQ,KADsB;AAExBC,MAAAA,SAFwB,GAEVT,OAFU,CAExBS,SAFwB;AAG9B;AACA;AACA,UAAID,KAAK,KAAKb,sBAAd,EAAsC;AACpCc,QAAAA,SAAS,GAAG,IAAZ;AACD;AACD,UAAIV,QAAJ;AACA,UAAIW,KAAK,CAACC,OAAN,CAAcJ,GAAd,CAAJ,EAAwB;AACtBR,QAAAA,QAAQ,SAAS,iCAAWN,UAAX,EAAuBc,GAAvB,kCAAiCP,OAAjC,SAA0CS,SAA1C,IAAjB;AACD,OAFD,MAEO;AACLV,QAAAA,QAAQ,SAAS,gCAAUN,UAAV,EAAsBc,GAAtB,kCAAgCP,OAAhC,SAAyCS,SAAzC,IAAjB;AACD;AACD;AACA;AACA,UAAI,CAACA,SAAL,EAAgB;AACd,QAAA,KAAI,CAACG,sBAAL;AACD;AACD,aAAOd,cAAc,CAACC,QAAD,EAAWC,OAAX,CAArB,CAnB8B;AAoB/B;;AAED;AACF;AACA;AACA;AACA;AACQa,EAAAA,OAAN,CAAeN,GAAf,EAAoBP,OAAO,GAAG,EAA9B,EAAkC;AAChC,YAAMD,QAAQ,SAAS,mCAAWL,YAAX,EAAyBa,GAAzB,EAA8BP,OAA9B,CAAvB;AACA,aAAOF,cAAc,CAACC,QAAD,EAAWC,OAAX,CAArB,CAFgC;AAGjC,GAtCkD,C","sourcesContent":["/**\n * Data api client to perform RQLite data operations such\n * as query and execute\n * @module api/data\n */\nimport ApiClient from '../client'\nimport { DataResults } from '../results'\n\n/**\n * The RQLite query api path\n */\nexport const PATH_QUERY = '/db/query'\n\n/**\n * The RQLite execute api path\n */\nexport const PATH_EXECUTE = '/db/execute'\n\n/**\n * Read query consistency level none which means\n * any node can respond\n */\nexport const CONSISTENCY_LEVEL_NONE = 'none'\n\n/**\n * Read query consistency strong which must come from\n * the master node\n */\nexport const CONSISTENCY_LEVEL_STRONG = 'strong'\n\n/**\n * Read query consistency weak which must come from\n * the master node\n */\nexport const CONSISTENCY_LEVEL_WEAK = 'weak'\n\n/**\n * Send an RQLite query API request to the RQLite server\n * @param {String} sql The SQL string to excute on the server\n * @param {Object} [options={}] RQLite api options\n * @param {Object} [options.raw] If true return the raw http resposne from\n * RQLite response\n */\nfunction handleResponse (response, options = {}) {\n  const { raw } = options\n  const { body } = response\n  if (raw) {\n    return response\n  }\n  return new DataResults(body)\n}\n\n/**\n * Data api client to perform RQLite queries\n */\nexport default class DataApiClient extends ApiClient {\n  /**\n   * Send an RQLite query API request to the RQLite server\n   * @param {String} sql The SQL string to excute on the server\n   * @param {Object} [options={}] RQLite api options\n   * @param {Object} [options.raw] If true return the raw http resposne from\n   * RQLite response\n   */\n  async query (sql, options = {}) {\n    const { level } = options\n    let { useLeader } = options\n    // Weak and strong consistency will be redirect to the master anyway\n    // so skip the redirect HTTP response and got right to the master\n    if (level !== CONSISTENCY_LEVEL_NONE) {\n      useLeader = true\n    }\n    let response\n    if (Array.isArray(sql)) {\n      response = await super.post(PATH_QUERY, sql, { ...options, useLeader })\n    } else {\n      response = await super.get(PATH_QUERY, sql, { ...options, useLeader })\n    }\n    // If round robin is true try and balance selects across hosts when\n    // the master node is not queried directly\n    if (!useLeader) {\n      this.setNextActiveHostIndex()\n    }\n    return handleResponse(response, options)\n  }\n\n  /**\n   * Send an RQLite execute API request to the RQLite server\n   * @param {String} sql The SQL string to excute on the server\n   * @param {Object} [options={}] RQLite api options\n   */\n  async execute (sql, options = {}) {\n    const response = await super.post(PATH_EXECUTE, sql, options)\n    return handleResponse(response, options)\n  }\n}\n"],"file":"index.js"}
+{"version":3,"file":"index.js","names":["PATH_QUERY","PATH_EXECUTE","CONSISTENCY_LEVEL_NONE","CONSISTENCY_LEVEL_STRONG","CONSISTENCY_LEVEL_WEAK","handleResponse","response","options","raw","body","DataResults","DataApiClient","ApiClient","query","sql","level","useLeader","Array","isArray","setNextActiveHostIndex","execute"],"sources":["../../../es6/api/data/index.js"],"sourcesContent":["/**\n * Data api client to perform RQLite data operations such\n * as query and execute\n * @module api/data\n */\nimport ApiClient from '../client'\nimport { DataResults } from '../results'\n\n/**\n * The RQLite query api path\n */\nexport const PATH_QUERY = '/db/query'\n\n/**\n * The RQLite execute api path\n */\nexport const PATH_EXECUTE = '/db/execute'\n\n/**\n * Read query consistency level none which means\n * any node can respond\n */\nexport const CONSISTENCY_LEVEL_NONE = 'none'\n\n/**\n * Read query consistency strong which must come from\n * the master node\n */\nexport const CONSISTENCY_LEVEL_STRONG = 'strong'\n\n/**\n * Read query consistency weak which must come from\n * the master node\n */\nexport const CONSISTENCY_LEVEL_WEAK = 'weak'\n\n/**\n * @typedef HttpRequestOptions\n * @type {import('../../http-request').HttpRequestOptions}\n */\n\n/**\n * Data request base options\n * @typedef DataRequestBaseOptions\n * @type {Object}\n * @property {Boolean} [raw] If true return the raw http response from\n * RQLite response\n */\n\n/**\n * Data query request base options\n * @typedef QueryRequestBaseOptions\n * @type {Object}\n * @property {String} level The api consistency level\n */\n\n/**\n * Data query request options\n * @typedef QueryRequestOptions\n * @type {HttpRequestOptions & DataRequestBaseOptions & QueryRequestBaseOptions}\n */\n\n/**\n * Data execute request options\n * @typedef ExecuteRequestOptions\n * @type {HttpRequestOptions & DataRequestBaseOptions}\n */\n\n/**\n * Send an RQLite query API request to the RQLite server\n * @param {String} sql The SQL string to excute on the server\n * @param {DataRequestBaseOptions} [options={}] RQLite api options\n */\nfunction handleResponse (response, options = {}) {\n  const { raw } = options\n  const { body } = response\n  if (raw) {\n    return response\n  }\n  return new DataResults(body)\n}\n\n/**\n * Data api client to perform RQLite queries\n */\nexport default class DataApiClient extends ApiClient {\n  /**\n   * Send an RQLite query API request to the RQLite server\n   * @param {String} sql The SQL string to excute on the server\n   * @param {QueryRequestOptions} [options={}] RQLite api options\n   */\n  async query (sql, options = {}) {\n    const { level } = options\n    let { useLeader } = options\n    // Weak and strong consistency will be redirect to the master anyway\n    // so skip the redirect HTTP response and got right to the master\n    if (level !== CONSISTENCY_LEVEL_NONE) {\n      useLeader = true\n    }\n    let response\n    if (Array.isArray(sql)) {\n      response = await super.post(PATH_QUERY, sql, { ...options, useLeader })\n    } else {\n      response = await super.get(PATH_QUERY, sql, { ...options, useLeader })\n    }\n    // If round robin is true try and balance selects across hosts when\n    // the master node is not queried directly\n    if (!useLeader) {\n      this.setNextActiveHostIndex()\n    }\n    return handleResponse(response, options)\n  }\n\n  /**\n   * Send an RQLite execute API request to the RQLite server\n   * @param {String} sql The SQL string to excute on the server\n   * @param {ExecuteRequestOptions} [options={}] RQLite execute api options\n   */\n  async execute (sql, options = {}) {\n    const response = await super.post(PATH_EXECUTE, sql, options)\n    return handleResponse(response, options)\n  }\n}\n"],"mappings":";;;;;AAKA;AACA,qC;;AAEA;AACA;AACA;AACO,MAAMA,UAAU,GAAG,WAAnB;;AAEP;AACA;AACA,G;AACO,MAAMC,YAAY,GAAG,aAArB;;AAEP;AACA;AACA;AACA,G;AACO,MAAMC,sBAAsB,GAAG,MAA/B;;AAEP;AACA;AACA;AACA,G;AACO,MAAMC,wBAAwB,GAAG,QAAjC;;AAEP;AACA;AACA;AACA,G;AACO,MAAMC,sBAAsB,GAAG,MAA/B;;AAEP;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA,G;AACA,SAASC,cAAT,CAAyBC,QAAzB,EAAmCC,OAAO,GAAG,EAA7C,EAAiD;EAC/C,MAAQC,GAAR,GAAgBD,OAAhB,CAAQC,GAAR;EACA,MAAQC,IAAR,GAAiBH,QAAjB,CAAQG,IAAR;EACA,IAAID,GAAJ,EAAS;IACP,OAAOF,QAAP;EACD;EACD,OAAO,IAAII,oBAAJ,CAAgBD,IAAhB,CAAP;AACD;;AAED;AACA;AACA;AACe,MAAME,aAAN,SAA4BC,eAA5B,CAAsC;EACnD;AACF;AACA;AACA;AACA;EACQC,KAAK,CAAEC,GAAF,EAAOP,OAAO,GAAG,EAAjB,EAAqB;MAC9B,MAAQQ,KAAR,GAAkBR,OAAlB,CAAQQ,KAAR;MACA,IAAMC,SAAN,GAAoBT,OAApB,CAAMS,SAAN;MACA;MACA;MACA,IAAID,KAAK,KAAKb,sBAAd,EAAsC;QACpCc,SAAS,GAAG,IAAZ;MACD;MACD,IAAIV,QAAJ;MACA,IAAIW,KAAK,CAACC,OAAN,CAAcJ,GAAd,CAAJ,EAAwB;QACtBR,QAAQ,SAAS,iCAAWN,UAAX,EAAuBc,GAAvB,kCAAiCP,OAAjC,SAA0CS,SAA1C,IAAjB;MACD,CAFD,MAEO;QACLV,QAAQ,SAAS,gCAAUN,UAAV,EAAsBc,GAAtB,kCAAgCP,OAAhC,SAAyCS,SAAzC,IAAjB;MACD;MACD;MACA;MACA,IAAI,CAACA,SAAL,EAAgB;QACd,KAAI,CAACG,sBAAL;MACD;MACD,OAAOd,cAAc,CAACC,QAAD,EAAWC,OAAX,CAArB,CAnB8B;EAoB/B;;EAED;AACF;AACA;AACA;AACA;EACQa,OAAO,CAAEN,GAAF,EAAOP,OAAO,GAAG,EAAjB,EAAqB;MAChC,MAAMD,QAAQ,SAAS,mCAAWL,YAAX,EAAyBa,GAAzB,EAA8BP,OAA9B,CAAvB;MACA,OAAOF,cAAc,CAACC,QAAD,EAAWC,OAAX,CAArB,CAFgC;EAGjC,CApCkD,C"}

package/lib/api/results/data-result-error.js

@@ -8,6 +8,12 @@
  * API call
  */
 class DataResultError extends Error {
+  constructor(...args) {
+    super(...args);
+    this.name = this.constructor.name;
+    this.code = this.constructor.name;
+  }
+
   /**
    * Get the result data error as plain object
    * @returns {Object} The data as an object

package/lib/api/results/data-result-error.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../es6/api/results/data-result-error.js"],"names":["DataResultError","Error","toObject","error","message","toString","JSON","stringify"],"mappings":"qGAAA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACe,MAAMA,eAAN,SAA8BC,KAA9B,CAAoC;AACjD;AACF;AACA;AACA;AACEC,EAAAA,QAAQ,GAAI;AACV,WAAO,EAAEC,KAAK,EAAE,KAAKC,OAAd,EAAP;AACD;;AAED;AACF;AACA;AACA;AACEC,EAAAA,QAAQ,GAAI;AACV,WAAOC,IAAI,CAACC,SAAL,CAAe,KAAKL,QAAL,EAAf,CAAP;AACD,GAfgD,C","sourcesContent":["/**\n * Class for handling RQLite data api result error\n * @module api/results/data-results\n */\n\n/**\n * A class that represents one data error result from an RQLite query or execute\n * API call\n */\nexport default class DataResultError extends Error {\n  /**\n   * Get the result data error as plain object\n   * @returns {Object} The data as an object\n   */\n  toObject () {\n    return { error: this.message }\n  }\n\n  /**\n   * Convert the result data error to a JSON string\n   * @returns {String} The JSON string for the data object\n   */\n  toString () {\n    return JSON.stringify(this.toObject())\n  }\n}\n"],"file":"data-result-error.js"}
+{"version":3,"file":"data-result-error.js","names":["DataResultError","Error","constructor","args","name","code","toObject","error","message","toString","JSON","stringify"],"sources":["../../../es6/api/results/data-result-error.js"],"sourcesContent":["/**\n * Class for handling RQLite data api result error\n * @module api/results/data-results\n */\n\n/**\n * A class that represents one data error result from an RQLite query or execute\n * API call\n */\nexport default class DataResultError extends Error {\n  constructor (...args) {\n    super(...args)\n    this.name = this.constructor.name\n    this.code = this.constructor.name\n  }\n\n  /**\n   * Get the result data error as plain object\n   * @returns {Object} The data as an object\n   */\n  toObject () {\n    return { error: this.message }\n  }\n\n  /**\n   * Convert the result data error to a JSON string\n   * @returns {String} The JSON string for the data object\n   */\n  toString () {\n    return JSON.stringify(this.toObject())\n  }\n}\n"],"mappings":"qGAAA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACe,MAAMA,eAAN,SAA8BC,KAA9B,CAAoC;EACjDC,WAAW,CAAE,GAAGC,IAAL,EAAW;IACpB,MAAM,GAAGA,IAAT;IACA,KAAKC,IAAL,GAAY,KAAKF,WAAL,CAAiBE,IAA7B;IACA,KAAKC,IAAL,GAAY,KAAKH,WAAL,CAAiBE,IAA7B;EACD;;EAED;AACF;AACA;AACA;EACEE,QAAQ,GAAI;IACV,OAAO,EAAEC,KAAK,EAAE,KAAKC,OAAd,EAAP;EACD;;EAED;AACF;AACA;AACA;EACEC,QAAQ,GAAI;IACV,OAAOC,IAAI,CAACC,SAAL,CAAe,KAAKL,QAAL,EAAf,CAAP;EACD,CArBgD,C"}