kuzzle 2.19.2 → 2.19.3

package/lib/types/PasswordPolicy.d.ts

@@ -22,7 +22,7 @@ export declare type PasswordPolicy = {
      * Can be either set to a wildcar (`"*""`) to match all users or to an
      * object containing at least of the following property.
      */
-    appliesTo: '*' | {
+    appliesTo: "*" | {
         /**
          * Array of user kuids the policy applies to.
          */

package/lib/types/Plugin.d.ts

@@ -1,9 +1,9 @@
-import { PluginContext } from '../core/plugin/pluginContext';
-import { ControllerDefinition } from './ControllerDefinition';
-import { PluginManifest } from './PluginManifest';
-import { StrategyDefinition } from './StrategyDefinition';
-import { EventHandler } from './EventHandler';
-import { JSONObject } from '../../index';
+import { PluginContext } from "../core/plugin/pluginContext";
+import { ControllerDefinition } from "./ControllerDefinition";
+import { PluginManifest } from "./PluginManifest";
+import { StrategyDefinition } from "./StrategyDefinition";
+import { EventHandler } from "./EventHandler";
+import { JSONObject } from "../../index";
 /**
  * Allows to define plugins controllers and actions
  */

package/lib/types/Plugin.js

@@ -54,9 +54,9 @@ class Plugin {
      * @param manifest Manifest containing the required kuzzleVersion number
      */
     constructor(manifest) {
-        if (!(0, safeObject_1.has)(manifest, 'kuzzleVersion')) {
+        if (!(0, safeObject_1.has)(manifest, "kuzzleVersion")) {
             // eslint-disable-next-line new-cap
-            throw kerror.get('plugin', 'manifest', 'missing_version');
+            throw kerror.get("plugin", "manifest", "missing_version");
         }
         this._manifest = manifest;
     }

package/lib/types/Policy.d.ts

@@ -1,4 +1,4 @@
-import { PolicyRestrictions, OptimizedPolicyRestrictions } from './PolicyRestrictions';
+import { PolicyRestrictions, OptimizedPolicyRestrictions } from "./PolicyRestrictions";
 /**
  * Policy definition for a role
  * and its restrictions

package/lib/types/RequestPayload.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from '../../index';
+import { JSONObject } from "../../index";
 /**
  * Kuzzle API request payload
  *

package/lib/types/ResponsePayload.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from '../../index';
+import { JSONObject } from "../../index";
 export declare type ResponseErrorPayload = {
     /**
      * Error human readable identifier

package/lib/types/Token.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from 'kuzzle-sdk';
+import { JSONObject } from "kuzzle-sdk";
 /**
  * Kuzzle authentication token.
  */

package/lib/types/User.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from 'kuzzle-sdk';
+import { JSONObject } from "kuzzle-sdk";
 /**
  * Kuzzle user.
  */

package/lib/types/config/DumpConfiguration.d.ts

@@ -5,25 +5,25 @@ export declare type DumpConfiguration = {
     enabled: boolean;
     history: {
         /**
-          * @default 3
-          */
+         * @default 3
+         */
         coredump: number;
         /**
-          * @default 5
-        */
+         * @default 5
+         */
         reports: number;
     };
     /**
      * @default './dump/'
-    */
+     */
     path: string;
     /**
      * @default 'gcore'
-    */
+     */
     gcore: string;
     /**
      * @default 'YYYYMMDD-HHmmss'
-    */
+     */
     dateFormat: string;
     handledErrors: {
         /**
@@ -32,7 +32,7 @@ export declare type DumpConfiguration = {
         enabled: boolean;
         /**
          * @default ['RangeError','TypeError','KuzzleError','InternalError'],
-        */
+         */
         whitelist: string[];
         /**
          * @default 600000

package/lib/types/config/HttpConfiguration.d.ts

@@ -38,6 +38,6 @@ export declare type HttpConfiguration = {
      *   configuration contains a wildcard ("*").
      *
      * @default true
-    */
+     */
     cookieAuthentication: boolean;
 };

package/lib/types/config/KuzzleConfiguration.d.ts

@@ -1,4 +1,4 @@
-import { ServerConfiguration, ServicesConfiguration, SecurityConfiguration, HttpConfiguration, PluginsConfiguration, LimitsConfiguration, DumpConfiguration } from '../index';
+import { ServerConfiguration, ServicesConfiguration, SecurityConfiguration, HttpConfiguration, PluginsConfiguration, LimitsConfiguration, DumpConfiguration } from "../index";
 export interface IKuzzleConfiguration {
     realtime: {
         /**

package/lib/types/config/LimitsConfiguration.d.ts

@@ -77,14 +77,14 @@ export declare type LimitsConfiguration = {
      */
     subscriptionMinterms: number;
     /**
-      * Maximum number of different subscription rooms.
-      * (i.e. different index+collection+filters subscription configurations)
-      *
-      * Depends primarily on available memory.
-      *
-      * If set to 0, an unlimited number of rooms can be created.
-      *
-      * @default 1000000
+     * Maximum number of different subscription rooms.
+     * (i.e. different index+collection+filters subscription configurations)
+     *
+     * Depends primarily on available memory.
+     *
+     * If set to 0, an unlimited number of rooms can be created.
+     *
+     * @default 1000000
      */
     subscriptionRooms: number;
     /**

package/lib/types/config/PluginsConfiguration.d.ts

@@ -1,5 +1,5 @@
-import { JSONObject } from '../../../index';
-import { PasswordPolicy } from '../index';
+import { JSONObject } from "../../../index";
+import { PasswordPolicy } from "../index";
 export declare type PluginsConfiguration = {
     /**
      * Common configuration for all plugins.
@@ -73,7 +73,7 @@ export declare type PluginsConfiguration = {
      *
      * @see https://github.com/kuzzleio/kuzzle-plugin-logger
      */
-    'kuzzle-plugin-logger': {
+    "kuzzle-plugin-logger": {
         /**
          * Winston transport services declaration
          */
@@ -113,7 +113,7 @@ export declare type PluginsConfiguration = {
      *
      * @see https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local/
      */
-    'kuzzle-plugin-auth-passport-local': {
+    "kuzzle-plugin-auth-passport-local": {
         /**
          * One of the supported encryption algorithms
          * (run crypto.getHashes() to get the complete list).

package/lib/types/config/SecurityConfiguration.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
-import { JSONObject } from '../../../index';
-import { RoleDefinition, ProfileDefinition } from '../index';
+import { JSONObject } from "../../../index";
+import { RoleDefinition, ProfileDefinition } from "../index";
 export declare type SecurityConfiguration = {
     /**
      * Debugger configuration
@@ -20,85 +20,85 @@ export declare type SecurityConfiguration = {
      */
     restrictedProfileIds: string[];
     /**
-    * @deprecated Use `security.authToken` instead.
-    */
+     * @deprecated Use `security.authToken` instead.
+     */
     jwt?: JSONObject;
     /**
-    * Configuration for the npm package jsonwebtoken
-    * who handle Kuzzle Authentication Token.
-    *
-    * @see https://github.com/auth0/node-jsonwebtoken
-    */
+     * Configuration for the npm package jsonwebtoken
+     * who handle Kuzzle Authentication Token.
+     *
+     * @see https://github.com/auth0/node-jsonwebtoken
+     */
     authToken: {
         /**
-        * Hash/encryption method used to sign the token.
-        *
-        * @default "HS256"
-        */
+         * Hash/encryption method used to sign the token.
+         *
+         * @default "HS256"
+         */
         algorithm: string;
         /**
-        * Token default expiration time.
-        *
-        * @see https://www.npmjs.com/package/ms
-        *
-        * @default "1h"
-        */
+         * Token default expiration time.
+         *
+         * @see https://www.npmjs.com/package/ms
+         *
+         * @default "1h"
+         */
         expiresIn: string;
         /**
-        * Duration in ms during which a renewed token is still considered valid.
-        *
-        * @default 1000
-        */
+         * Duration in ms during which a renewed token is still considered valid.
+         *
+         * @default 1000
+         */
         gracePeriod: number;
         /**
-        * Maximum duration in milliseconds a token can be requested to be valid.
-        *
-        * If set to -1, no maximum duration is set.
-        *
-        * @default -1
-        */
+         * Maximum duration in milliseconds a token can be requested to be valid.
+         *
+         * If set to -1, no maximum duration is set.
+         *
+         * @default -1
+         */
         maxTTL: number;
         /**
-        * String or buffer data containing either the secret for HMAC
-        * algorithms, or the PEM encoded private key for RSA and ECDSA.
-        *
-        * If left to null, Kuzzle will autogenerate a random
-        * seed (can only be used with HMAC algorithms).
-        *
-        * @default null
-        */
+         * String or buffer data containing either the secret for HMAC
+         * algorithms, or the PEM encoded private key for RSA and ECDSA.
+         *
+         * If left to null, Kuzzle will autogenerate a random
+         * seed (can only be used with HMAC algorithms).
+         *
+         * @default null
+         */
         secret: string | Buffer;
     };
     apiKey: {
         /**
-        * Maximum duration in milliseconds a token can be requested to be valid.
-        *
-        * If set to -1, no maximum duration is set.
-        *
-        * @default -1
-        */
+         * Maximum duration in milliseconds a token can be requested to be valid.
+         *
+         * If set to -1, no maximum duration is set.
+         *
+         * @default -1
+         */
         maxTTL: number;
     };
     /**
-    * The default role defines permissions for all users,
-    * until an administrator configures the backend rights.
-    *
-    * By default, all users are granted all permissions.
-    *
-    * @default
-    *
-    * {
-    *   "role": {
-    *      "controllers": {
-    *        "*": {
-    *          "actions": {
-    *            "*": true
-    *          }
-    *        }
-    *      }
-    *    }
-    *  }
-    */
+     * The default role defines permissions for all users,
+     * until an administrator configures the backend rights.
+     *
+     * By default, all users are granted all permissions.
+     *
+     * @default
+     *
+     * {
+     *   "role": {
+     *      "controllers": {
+     *        "*": {
+     *          "actions": {
+     *            "*": true
+     *          }
+     *        }
+     *      }
+     *    }
+     *  }
+     */
     default: {
         role: RoleDefinition;
     };

package/lib/types/config/ServerConfiguration.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from '../../../index';
+import { JSONObject } from "../../../index";
 export declare type ServerConfiguration = {
     /**
      * The maximum size of an incoming request.
@@ -10,14 +10,14 @@ export declare type ServerConfiguration = {
      */
     maxRequestSize: string;
     /**
-    * The listening port for HTTP and WebSocket protocols.
-    *
-    * @default 7512
-    */
+     * The listening port for HTTP and WebSocket protocols.
+     *
+     * @default 7512
+     */
     port: number;
     /**
-    * Configuration section for Kuzzle access logs.
-    */
+     * Configuration section for Kuzzle access logs.
+     */
     logs: {
         /**
         * An array of Winston transports configurations to output access
@@ -42,39 +42,39 @@ export declare type ServerConfiguration = {
         */
         transports: JSONObject[];
         /**
-        * Access log format.
-        *
-        * Currently supported are "combined" (=Apache combined logs format)
-        * and "logstash".
-        *
-        * "logstash" will output the whole request input to JSON, ready to
-        * be consumed by logstash agent.
-        *
-        * @default "combined"
-        */
-        accessLogFormat: 'combined' | 'logstash';
+         * Access log format.
+         *
+         * Currently supported are "combined" (=Apache combined logs format)
+         * and "logstash".
+         *
+         * "logstash" will output the whole request input to JSON, ready to
+         * be consumed by logstash agent.
+         *
+         * @default "combined"
+         */
+        accessLogFormat: "combined" | "logstash";
         /**
-        * The offset to use as the client ip, from the FORWARDED-FOR chain,
-        * beginning from the right (0 = the ip address of the last
-        * client|proxy which connected to Kuzzle.
-        *
-        * @default 0
-        */
+         * The offset to use as the client ip, from the FORWARDED-FOR chain,
+         * beginning from the right (0 = the ip address of the last
+         * client|proxy which connected to Kuzzle.
+         *
+         * @default 0
+         */
         accessLogIpOffset: number;
     };
     /**
-    * protocols accepted by Kuzzle.
-    * protocols can be extended and configured in this section.
-    */
+     * protocols accepted by Kuzzle.
+     * protocols can be extended and configured in this section.
+     */
     protocols: {
         http: {
             /**
-            * Enable support for compressed requests, using the Content-Encoding header
-            * Currently supported compression algorithms:  gzip, deflate, identity
-            * Note: "identity" is always an accepted value, even if compression support is disabled
-            *
-            * @default true
-            */
+             * Enable support for compressed requests, using the Content-Encoding header
+             * Currently supported compression algorithms:  gzip, deflate, identity
+             * Note: "identity" is always an accepted value, even if compression support is disabled
+             *
+             * @default true
+             */
             allowCompression: boolean;
             /**
              * Set to "false" to disable HTTP support
@@ -99,16 +99,16 @@ export declare type ServerConfiguration = {
         };
         mqtt: {
             /**
-            * Set to true to enable MQTT support
-            *
-            * @default false
-            */
+             * Set to true to enable MQTT support
+             *
+             * @default false
+             */
             enabled: boolean;
             /**
-            * Allow MQTT pub/sub capabilities or restrict to Kuzzle requests only
-            *
-            * @default false
-            */
+             * Allow MQTT pub/sub capabilities or restrict to Kuzzle requests only
+             *
+             * @default false
+             */
             allowPubSub: boolean;
             /**
              * Switches responseTopic back to a regular public topic
@@ -136,9 +136,9 @@ export declare type ServerConfiguration = {
              */
             responseTopic: string;
             /**
-            * Constructor options passed to underlying MQTT server.
-            * See aedes documentation for further reference: https://github.com/moscajs/aedes
-            */
+             * Constructor options passed to underlying MQTT server.
+             * See aedes documentation for further reference: https://github.com/moscajs/aedes
+             */
             server: {
                 /**
                  * @default 1883
@@ -160,13 +160,13 @@ export declare type ServerConfiguration = {
              */
             enabled: boolean;
             /**
-            * The maximum time (in milliseconds) without sending or receiving a message from a client.
-            * Once reached, the client's socket is forcibly closed.
-            * If a client socket is inactive for too long, the server will send a PING request before closing the socket.
-            * Minimum value: 1000 (but it's strongly advised to not set a value this low to forcibly close idle client sockets)
-            *
-            * @default 60000
-            */
+             * The maximum time (in milliseconds) without sending or receiving a message from a client.
+             * Once reached, the client's socket is forcibly closed.
+             * If a client socket is inactive for too long, the server will send a PING request before closing the socket.
+             * Minimum value: 1000 (but it's strongly advised to not set a value this low to forcibly close idle client sockets)
+             *
+             * @default 60000
+             */
             idleTimeout: number;
             /**
              * Enable/Disable per message compression
@@ -175,10 +175,10 @@ export declare type ServerConfiguration = {
              */
             compression: boolean;
             /**
-            * The maximum number of messages per second a single socket can
-            * submit to the server.
-            * @default 0
-            */
+             * The maximum number of messages per second a single socket can
+             * submit to the server.
+             * @default 0
+             */
             rateLimit: number;
             /**
              * Set to "true" to enable realtime notifications like "TokenExpired" notifications

package/lib/types/config/ServicesConfiguration.d.ts

@@ -1,4 +1,4 @@
-import { PublicCacheRedisConfiguration, InternalCacheConfiguration, StorageEngineElasticsearch } from '../index';
+import { PublicCacheRedisConfiguration, InternalCacheConfiguration, StorageEngineElasticsearch } from "../index";
 export declare type ServicesConfiguration = {
     common: {
         /**
@@ -23,7 +23,7 @@ export declare type ServicesConfiguration = {
     memoryStorage: PublicCacheRedisConfiguration;
     /**
      * The database engine used for Kuzzle internal index
-    */
+     */
     internalIndex: {
         /**
          * Maximum amount of time (in milliseconds)

package/lib/types/config/internalCache/InternalCacheRedisConfiguration.d.ts

@@ -70,8 +70,8 @@ export declare type InternalCacheConfiguration = {
      */
     /**
      * @default 'redis'
-    */
-    backend: 'redis';
+     */
+    backend: "redis";
     clusterOptions: {
         /**
          * @default true
@@ -80,7 +80,7 @@ export declare type InternalCacheConfiguration = {
     };
     /**
      * @default 0
-    */
+     */
     database: number;
     node: {
         /**
@@ -98,14 +98,14 @@ export declare type InternalCacheConfiguration = {
      *    See Redis client constructor available options:
      *    https://github.com/luin/ioredis/blob/master/API.md#new-redisport-host-options
      *
-    */
+     */
     options?: Record<string, unknown>;
     /**
-    * Only available when using a Redis Cluster config.
-    * Use with caution: if set to true, it makes Kuzzle skip DNS validation for TLS certificates
-    * This is the only way to connect to an AWS Elasticache Cluster with TLS encryption.
-    *  See: https://github.com/luin/ioredis#special-note-aws-elasticache-clusters-with-tls
-    * @default false
-    */
+     * Only available when using a Redis Cluster config.
+     * Use with caution: if set to true, it makes Kuzzle skip DNS validation for TLS certificates
+     * This is the only way to connect to an AWS Elasticache Cluster with TLS encryption.
+     *  See: https://github.com/luin/ioredis#special-note-aws-elasticache-clusters-with-tls
+     * @default false
+     */
     overrideDnsLookup: boolean;
 };

package/lib/types/config/publicCache/PublicCacheRedisConfiguration.d.ts

@@ -2,7 +2,7 @@ export declare type PublicCacheRedisConfiguration = {
     /**
      * @default 'redis'
      */
-    backend: 'redis';
+    backend: "redis";
     clusterOptions: {
         /**
          * @default true
@@ -10,8 +10,8 @@ export declare type PublicCacheRedisConfiguration = {
         enableReadyCheck: boolean;
     };
     /**
-    * @default 5
-    */
+     * @default 5
+     */
     database: number;
     node: {
         /**