kuzzle 2.19.2 → 2.19.3

package/lib/api/controllers/collectionController.js

@@ -19,36 +19,37 @@
  * limitations under the License.
  */
 
-'use strict';
+"use strict";
 
-const kerror = require('../../kerror');
-const { isPlainObject } = require('../../util/safeObject');
-const { NativeController } = require('./baseController');
+const kerror = require("../../kerror");
+const { isPlainObject } = require("../../util/safeObject");
+const { NativeController } = require("./baseController");
 
 /**
  * @class CollectionController
  */
 class CollectionController extends NativeController {
-  constructor () {
+  constructor() {
     super([
-      'create',
-      'delete',
-      'deleteSpecifications',
-      'exists',
-      'getMapping',
-      'getSpecifications',
-      'list',
-      'refresh',
-      'scrollSpecifications',
-      'searchSpecifications',
-      'truncate',
-      'update',
-      'updateMapping',
-      'updateSpecifications',
-      'validateSpecifications',
+      "create",
+      "delete",
+      "deleteSpecifications",
+      "exists",
+      "getMapping",
+      "getSpecifications",
+      "list",
+      "refresh",
+      "scrollSpecifications",
+      "searchSpecifications",
+      "truncate",
+      "update",
+      "updateMapping",
+      "updateSpecifications",
+      "validateSpecifications",
     ]);
 
-    this.defaultScrollTTL = global.kuzzle.config.services.storageEngine.defaults.scrollTTL;
+    this.defaultScrollTTL =
+      global.kuzzle.config.services.storageEngine.defaults.scrollTTL;
   }
 
   /**
@@ -57,18 +58,21 @@ class CollectionController extends NativeController {
    * @param {Request} request
    * @returns {Promise.<Object>}
    */
-  async updateMapping (request) {
-    request.addDeprecation('2.1.0',
-      'This action has been deprecated since Kuzzle version 2.1.0. This feature might be removed in a future major version. To update a collection, use this API action instead: "collection:update".');
+  async updateMapping(request) {
+    request.addDeprecation(
+      "2.1.0",
+      'This action has been deprecated since Kuzzle version 2.1.0. This feature might be removed in a future major version. To update a collection, use this API action instead: "collection:update".'
+    );
 
     const { index, collection } = request.getIndexAndCollection();
     const mappings = request.getBody();
 
     const updated = await this.ask(
-      'core:storage:public:mappings:update',
+      "core:storage:public:mappings:update",
       index,
       collection,
-      mappings);
+      mappings
+    );
 
     return this._filterMappingResponse(updated);
   }
@@ -79,16 +83,16 @@ class CollectionController extends NativeController {
    * @param {Request} request
    * @returns {Promise.<Object>}
    */
-  async getMapping (request) {
-    const
-      { index, collection } = request.getIndexAndCollection(),
-      includeKuzzleMeta = request.getBoolean('includeKuzzleMeta');
+  async getMapping(request) {
+    const { index, collection } = request.getIndexAndCollection(),
+      includeKuzzleMeta = request.getBoolean("includeKuzzleMeta");
 
     const mapping = await this.ask(
-      'core:storage:public:mappings:get',
+      "core:storage:public:mappings:get",
       index,
       collection,
-      { includeKuzzleMeta });
+      { includeKuzzleMeta }
+    );
 
     return this._filterMappingResponse(mapping);
   }
@@ -99,20 +103,22 @@ class CollectionController extends NativeController {
    * @param {Request} request
    * @returns {Promise.<Object>}
    */
-  getSpecifications (request) {
+  getSpecifications(request) {
     const { index, collection } = request.getIndexAndCollection();
 
-    return global.kuzzle.internalIndex.get('validations', `${index}#${collection}`)
-      .then(response => response._source)
-      .catch(error => {
+    return global.kuzzle.internalIndex
+      .get("validations", `${index}#${collection}`)
+      .then((response) => response._source)
+      .catch((error) => {
         if (error.status === 404) {
           throw kerror.getFrom(
             error,
-            'validation',
-            'assert',
-            'not_found',
+            "validation",
+            "assert",
+            "not_found",
             index,
-            collection);
+            collection
+          );
         }
 
         throw error;
@@ -125,24 +131,20 @@ class CollectionController extends NativeController {
    * @param {Request} request
    * @returns {Promise.<Object>}
    */
-  async searchSpecifications (request) {
+  async searchSpecifications(request) {
     const { from, size, scrollTTL, searchBody } = request.getSearchParams();
 
-    if (! isPlainObject(searchBody)) {
-      throw kerror.get(
-        'api',
-        'assert',
-        'invalid_type',
-        'body.query',
-        'object');
+    if (!isPlainObject(searchBody)) {
+      throw kerror.get("api", "assert", "invalid_type", "body.query", "object");
     }
 
     this.assertNotExceedMaxFetch(size - from);
 
     const { hits, scrollId, total } = await global.kuzzle.internalIndex.search(
-      'validations',
+      "validations",
       searchBody,
-      { from, scroll: scrollTTL, size });
+      { from, scroll: scrollTTL, size }
+    );
 
     return { hits, scrollId, total };
   }
@@ -153,16 +155,16 @@ class CollectionController extends NativeController {
    * @param {Request} request
    * @returns {Promise.<object>}
    */
-  async scrollSpecifications (request) {
-    const
-      ttl = request.getString('scroll', this.defaultScrollTTL),
-      id = request.getString('scrollId');
+  async scrollSpecifications(request) {
+    const ttl = request.getString("scroll", this.defaultScrollTTL),
+      id = request.getString("scrollId");
 
-    return global.kuzzle.internalIndex.scroll(id, ttl)
+    return global.kuzzle.internalIndex
+      .scroll(id, ttl)
       .then(({ scrollId, hits, total }) => ({
         hits,
         scrollId,
-        total
+        total,
       }));
   }
 
@@ -172,7 +174,7 @@ class CollectionController extends NativeController {
    * @param {Request} request
    * @returns {Promise.<Object>}
    */
-  async updateSpecifications (request) {
+  async updateSpecifications(request) {
     const { index, collection } = request.getIndexAndCollection();
     const specifications = request.getBody();
 
@@ -180,26 +182,29 @@ class CollectionController extends NativeController {
       index,
       collection,
       specifications,
-      true);
+      true
+    );
 
-    if (! isValid) {
+    if (!isValid) {
       throw kerror.get(
-        'validation',
-        'assert',
-        'invalid_specifications',
-        errors.join('\n\t- '));
+        "validation",
+        "assert",
+        "invalid_specifications",
+        errors.join("\n\t- ")
+      );
     }
 
     await global.kuzzle.internalIndex.createOrReplace(
-      'validations',
+      "validations",
       `${index}#${collection}`,
       {
         collection,
         index,
         validation: specifications,
-      });
+      }
+    );
 
-    await global.kuzzle.internalIndex.refreshCollection('validations');
+    await global.kuzzle.internalIndex.refreshCollection("validations");
     await global.kuzzle.validation.curateSpecification();
 
     return specifications;
@@ -211,14 +216,13 @@ class CollectionController extends NativeController {
    * @param {Request} request
    * @returns {Promise.<Object>}
    */
-  async deleteSpecifications (request) {
+  async deleteSpecifications(request) {
     const { index, collection } = request.getIndexAndCollection();
     const specificationsId = `${index}#${collection}`;
 
     try {
-      await global.kuzzle.internalIndex.delete('validations', specificationsId);
-    }
-    catch (error) {
+      await global.kuzzle.internalIndex.delete("validations", specificationsId);
+    } catch (error) {
       if (error.status === 404) {
         return {
           acknowledged: true,
@@ -228,11 +232,11 @@ class CollectionController extends NativeController {
       throw error;
     }
 
-    await global.kuzzle.internalIndex.refreshCollection('validations');
+    await global.kuzzle.internalIndex.refreshCollection("validations");
     await global.kuzzle.validation.curateSpecification();
 
     return {
-      acknowledged: true
+      acknowledged: true,
     };
   }
 
@@ -242,28 +246,23 @@ class CollectionController extends NativeController {
    * @param {Request} request
    * @returns {Promise.<Object>}
    */
-  validateSpecifications (request) {
-    const
-      { index, collection } = request.getIndexAndCollection(),
+  validateSpecifications(request) {
+    const { index, collection } = request.getIndexAndCollection(),
       specifications = request.getBody();
 
-    return global.kuzzle.validation.validateFormat(
-      index,
-      collection,
-      specifications,
-      true
-    )
+    return global.kuzzle.validation
+      .validateFormat(index, collection, specifications, true)
       .then(({ isValid, errors }) => {
-        if (! isValid) {
+        if (!isValid) {
           return {
-            description: 'Some errors with provided specifications.',
+            description: "Some errors with provided specifications.",
             details: errors,
-            valid: false
+            valid: false,
           };
         }
 
         return {
-          valid: true
+          valid: true,
         };
       });
   }
@@ -274,13 +273,17 @@ class CollectionController extends NativeController {
    * @param {KuzzleRequest} request
    * @returns {Promise.<Object>}
    */
-  async truncate (request) {
+  async truncate(request) {
     const { index, collection } = request.getIndexAndCollection();
 
-    await this.ask('core:storage:public:collection:truncate', index, collection);
+    await this.ask(
+      "core:storage:public:collection:truncate",
+      index,
+      collection
+    );
 
     return {
-      acknowledged: true
+      acknowledged: true,
     };
   }
 
@@ -288,35 +291,44 @@ class CollectionController extends NativeController {
    * @param {Request} request
    * @returns {Promise.<Object>}
    */
-  async list (request) {
+  async list(request) {
     const index = request.getIndex();
-    const from = request.getInteger('from', 0);
-    const size = request.getInteger('size', 0);
-    const type = request.getString('type', 'all');
+    const from = request.getInteger("from", 0);
+    const size = request.getInteger("size", 0);
+    const type = request.getString("type", "all");
 
-    if (! ['all', 'stored', 'realtime'].includes(type)) {
-      throw kerror.get('api', 'assert', 'invalid_argument', '"all", "stored", "realtime"');
+    if (!["all", "stored", "realtime"].includes(type)) {
+      throw kerror.get(
+        "api",
+        "assert",
+        "invalid_argument",
+        '"all", "stored", "realtime"'
+      );
     }
 
     if (request.input.args.type) {
-      request.addDeprecation('2.10.2',
-        'The "type" argument and this route returning a list of realtime collections have both been deprecated since Kuzzle version 2.10.1. This feature might be removed in a future major version. To get a list of realtime collections, use this API action instead: "realtime:list".');
+      request.addDeprecation(
+        "2.10.2",
+        'The "type" argument and this route returning a list of realtime collections have both been deprecated since Kuzzle version 2.10.1. This feature might be removed in a future major version. To get a list of realtime collections, use this API action instead: "realtime:list".'
+      );
     }
 
     let collections = [];
 
-    if (type === 'realtime' || type === 'all') {
-      const list = await this.ask('core:realtime:collections:get', index);
-      collections = list.map(name => ({ name, type: 'realtime' }));
+    if (type === "realtime" || type === "all") {
+      const list = await this.ask("core:realtime:collections:get", index);
+      collections = list.map((name) => ({ name, type: "realtime" }));
     }
 
-    if (type !== 'realtime') {
+    if (type !== "realtime") {
       const publicCollections = await this.ask(
-        'core:storage:public:collection:list',
-        index);
+        "core:storage:public:collection:list",
+        index
+      );
 
       collections = collections.concat(
-        publicCollections.map(name => ({ name, type: 'stored' })));
+        publicCollections.map((name) => ({ name, type: "stored" }))
+      );
     }
 
     collections.sort((a, b) => {
@@ -333,10 +345,10 @@ class CollectionController extends NativeController {
    * @param {Request} request
    * @returns {Promise.<boolean>}
    */
-  exists (request) {
+  exists(request) {
     const { index, collection } = request.getIndexAndCollection();
 
-    return this.ask('core:storage:public:collection:exist', index, collection);
+    return this.ask("core:storage:public:collection:exist", index, collection);
   }
 
   /**
@@ -346,7 +358,7 @@ class CollectionController extends NativeController {
    * @param {Request} request
    * @returns {Promise.<Object>}
    */
-  async create (request) {
+  async create(request) {
     const body = request.getBody({});
     const { index, collection } = request.getIndexAndCollection();
 
@@ -355,18 +367,20 @@ class CollectionController extends NativeController {
     // @deprecated sending directly the mappings is deprecated since 2.1.0
     if (body.properties || body.dynamic || body._meta) {
       config.mappings = body;
-      request.addDeprecation('2.1.0',
-        'Using "properties", "dynamic" or "_meta" fields in the body has been deprecated since Kuzzle version 2.1.0. This feature might be removed in a future major version. Use "settings" and "mappings" fields instead');
-    }
-    else {
+      request.addDeprecation(
+        "2.1.0",
+        'Using "properties", "dynamic" or "_meta" fields in the body has been deprecated since Kuzzle version 2.1.0. This feature might be removed in a future major version. Use "settings" and "mappings" fields instead'
+      );
+    } else {
       config = body;
     }
 
     await this.ask(
-      'core:storage:public:collection:create',
+      "core:storage:public:collection:create",
       index,
       collection,
-      config);
+      config
+    );
 
     return { acknowledged: true };
   }
@@ -377,16 +391,16 @@ class CollectionController extends NativeController {
    * @param {Request} request
    * @returns {Promise.<Object>}
    */
-  async update (request) {
-    const
-      config = request.getBody({}),
+  async update(request) {
+    const config = request.getBody({}),
       { index, collection } = request.getIndexAndCollection();
 
     await this.ask(
-      'core:storage:public:collection:update',
+      "core:storage:public:collection:update",
       index,
       collection,
-      config);
+      config
+    );
 
     return null;
   }
@@ -397,10 +411,10 @@ class CollectionController extends NativeController {
    * @param {Request} request
    * @returns {Promise.<null>}
    */
-  async refresh (request) {
+  async refresh(request) {
     const { index, collection } = request.getIndexAndCollection();
 
-    await this.ask('core:storage:public:collection:refresh', index, collection);
+    await this.ask("core:storage:public:collection:refresh", index, collection);
 
     return null;
   }
@@ -413,15 +427,14 @@ class CollectionController extends NativeController {
    *
    * @returns {Promise.<null>}
    */
-  async delete (request) {
+  async delete(request) {
     const { index, collection } = request.getIndexAndCollection();
 
-    await this.ask('core:storage:public:collection:delete', index, collection);
+    await this.ask("core:storage:public:collection:delete", index, collection);
 
     return null;
   }
 
-
   /**
    * Uses from and size to paginate response results
    * If type is "all", stored collections are prioritary
@@ -431,12 +444,11 @@ class CollectionController extends NativeController {
    * @param {Object} response
    * @returns {Object} { collections, from, size }
    */
-  _paginateCollections (from, size, response) {
+  _paginateCollections(from, size, response) {
     if (from || size) {
       if (from) {
         response.from = Number.parseInt(from);
-      }
-      else {
+      } else {
         response.from = 0;
       }
 
@@ -447,8 +459,7 @@ class CollectionController extends NativeController {
           response.from,
           response.from + response.size
         );
-      }
-      else {
+      } else {
         response.collections = response.collections.slice(response.from);
       }
     }
@@ -461,11 +472,11 @@ class CollectionController extends NativeController {
    * @param  {Object} mapping - raw ES mapping
    * @returns {Object}
    */
-  _filterMappingResponse (mapping) {
+  _filterMappingResponse(mapping) {
     return {
       _meta: mapping._meta,
       dynamic: mapping.dynamic,
-      properties: mapping.properties
+      properties: mapping.properties,
     };
   }
 }

package/lib/api/controllers/debugController.d.ts

@@ -1,5 +1,5 @@
-import { KuzzleRequest } from '../request';
-import { NativeController } from './baseController';
+import { KuzzleRequest } from "../request";
+import { NativeController } from "./baseController";
 /**
  * @class DebugController
  */