kuzzle 2.27.1 → 2.27.3

package/README.md

@@ -48,13 +48,19 @@ Check out our [support plans](https://kuzzle.io/pricing/).
 The easiest way to start a Kuzzle application is to use [Kourou](https://github.com/kuzzleio/kourou):
 
 ```bash
-npx kourou app:scaffold playground
+kourou app:scaffold playground
 
  🚀 Kourou - Scaffolds a new Kuzzle application
 
-  ✔ Creating and rendering application files
+generic
+  ✔ Checking destination
+  ✔ Prepare temporary folder
+  ✔ Cloning template repository
+  ✔ Copying template files
+  ✔ Cleaning up
 
- [✔] Scaffolding complete! Use cd playground && npm run docker npm install install dependencies and then npm run docker:dev to run your application!
+ [✔] Scaffolding complete!
+ [✔] Use cd playground && docker compose up -d to start your Kuzzle stack.
 ```
 
 Then you need to run Kuzzle services, Elasticsearch and Redis: `kourou app:start-services`
@@ -123,7 +129,7 @@ Check our [contributing documentation](./CONTRIBUTING.md) to know about our codi
 
 ## Join our community
 
-* Follow us on [twitter](https://twitter.com/kuzzleio) to get latest news
+* Follow us on [𝕏 (Twitter)](https://twitter.com/kuzzleio) to get latest news
 * Register to our monthly [newsletter](http://eepurl.com/bxRxpr) to get highlighed news
 * Visit our [blog](https://blog.kuzzle.io/) to be informed about what we are doing
 * Come chat with us on [Discord](http://join.discord.kuzzle.io)
@@ -139,8 +145,8 @@ First of all make sure that you have at least `4GB` of ram allocated to your vm
 
 Run the following command to install all the dependencies in your container:
 ```bash
-npm run docker:install
+docker compose run kuzzle_node_1 npm ci
 ```
 
-finally run the command `docker-compose up` to launch your kuzzle stack.
+Finally, run the command `docker compose up` to start your Kuzzle stack.
 

package/lib/api/controllers/adminController.js

@@ -81,7 +81,7 @@ class AdminController extends NativeController {
         "api",
         "process",
         "action_locked",
-        "Kuzzle is already reseting roles, profiles and users."
+        "Kuzzle is already reseting roles, profiles and users.",
       );
     }
 
@@ -92,22 +92,22 @@ class AdminController extends NativeController {
 
       result.deletedUsers = await this.ask(
         "core:security:user:truncate",
-        options
+        options,
       );
       result.deletedProfiles = await this.ask(
         "core:security:profile:truncate",
-        options
+        options,
       );
       result.deletedRoles = await this.ask(
         "core:security:role:truncate",
-        options
+        options,
       );
 
       await global.kuzzle.internalIndex.createInitialSecurities();
 
       await this.ask(
         "core:cache:internal:del",
-        `${BACKEND_IMPORT_KEY}:permissions`
+        `${BACKEND_IMPORT_KEY}:permissions`,
       );
     } finally {
       await mutex.unlock();
@@ -127,7 +127,7 @@ class AdminController extends NativeController {
         "api",
         "process",
         "action_locked",
-        "Kuzzle is already reseting all indexes."
+        "Kuzzle is already reseting all indexes.",
       );
     }
 
@@ -137,7 +137,7 @@ class AdminController extends NativeController {
 
       await this.ask(
         "core:cache:internal:del",
-        `${BACKEND_IMPORT_KEY}:mappings`
+        `${BACKEND_IMPORT_KEY}:mappings`,
       );
 
       return { acknowledge: true };
@@ -168,7 +168,7 @@ class AdminController extends NativeController {
         "api",
         "process",
         "action_locked",
-        "Kuzzle is already shutting down."
+        "Kuzzle is already shutting down.",
       );
     }
 
@@ -193,7 +193,7 @@ class AdminController extends NativeController {
       request.getRefresh("wait_for"),
       global.kuzzle.ask("core:storage:public:mappings:import", mappings, {
         rawMappings: true,
-      })
+      }),
     );
   }
 

package/lib/api/controllers/bulkController.js

@@ -55,7 +55,7 @@ class BulkController extends NativeController {
       index,
       collection,
       bulkData,
-      options
+      options,
     );
 
     if (strict && errors.length) {
@@ -64,7 +64,7 @@ class BulkController extends NativeController {
         "process",
         "incomplete_multiple_request",
         "import",
-        errors
+        errors,
       );
     }
 
@@ -92,7 +92,7 @@ class BulkController extends NativeController {
       collection,
       id,
       content,
-      { injectKuzzleMeta: false, refresh }
+      { injectKuzzleMeta: false, refresh },
     );
 
     if (notify) {
@@ -100,7 +100,7 @@ class BulkController extends NativeController {
         "core:realtime:document:notify",
         request,
         actionEnum.WRITE,
-        result
+        result,
       );
     }
 
@@ -126,7 +126,7 @@ class BulkController extends NativeController {
       index,
       collection,
       documents,
-      { injectKuzzleMeta: false, limits: false, refresh }
+      { injectKuzzleMeta: false, limits: false, refresh },
     );
 
     if (strict && errors.length) {
@@ -135,7 +135,7 @@ class BulkController extends NativeController {
         "process",
         "incomplete_multiple_request",
         "write",
-        errors
+        errors,
       );
     }
 
@@ -146,7 +146,7 @@ class BulkController extends NativeController {
         "core:realtime:document:mNotify",
         request,
         actionEnum.WRITE,
-        items
+        items,
       );
     }
 
@@ -178,7 +178,7 @@ class BulkController extends NativeController {
       index,
       collection,
       query,
-      { fetch: false, refresh, size: -1 }
+      { fetch: false, refresh, size: -1 },
     );
 
     return { deleted };
@@ -202,7 +202,7 @@ class BulkController extends NativeController {
       collection,
       query,
       changes,
-      { refresh }
+      { refresh },
     );
   }
 }

package/lib/api/controllers/collectionController.js

@@ -61,7 +61,7 @@ class CollectionController extends NativeController {
   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".'
+      '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();
@@ -71,7 +71,7 @@ class CollectionController extends NativeController {
       "core:storage:public:mappings:update",
       index,
       collection,
-      mappings
+      mappings,
     );
 
     return this._filterMappingResponse(updated);
@@ -91,7 +91,7 @@ class CollectionController extends NativeController {
       "core:storage:public:mappings:get",
       index,
       collection,
-      { includeKuzzleMeta }
+      { includeKuzzleMeta },
     );
 
     return this._filterMappingResponse(mapping);
@@ -117,7 +117,7 @@ class CollectionController extends NativeController {
             "assert",
             "not_found",
             index,
-            collection
+            collection,
           );
         }
 
@@ -143,7 +143,7 @@ class CollectionController extends NativeController {
     const { hits, scrollId, total } = await global.kuzzle.internalIndex.search(
       "validations",
       searchBody,
-      { from, scroll: scrollTTL, size }
+      { from, scroll: scrollTTL, size },
     );
 
     return { hits, scrollId, total };
@@ -182,7 +182,7 @@ class CollectionController extends NativeController {
       index,
       collection,
       specifications,
-      true
+      true,
     );
 
     if (!isValid) {
@@ -190,7 +190,7 @@ class CollectionController extends NativeController {
         "validation",
         "assert",
         "invalid_specifications",
-        errors.join("\n\t- ")
+        errors.join("\n\t- "),
       );
     }
 
@@ -201,7 +201,7 @@ class CollectionController extends NativeController {
         collection,
         index,
         validation: specifications,
-      }
+      },
     );
 
     await global.kuzzle.internalIndex.refreshCollection("validations");
@@ -279,7 +279,7 @@ class CollectionController extends NativeController {
     await this.ask(
       "core:storage:public:collection:truncate",
       index,
-      collection
+      collection,
     );
 
     return {
@@ -302,14 +302,14 @@ class CollectionController extends NativeController {
         "api",
         "assert",
         "invalid_argument",
-        '"all", "stored", "realtime"'
+        '"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".'
+        '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".',
       );
     }
 
@@ -323,11 +323,11 @@ class CollectionController extends NativeController {
     if (type !== "realtime") {
       const publicCollections = await this.ask(
         "core:storage:public:collection:list",
-        index
+        index,
       );
 
       collections = collections.concat(
-        publicCollections.map((name) => ({ name, type: "stored" }))
+        publicCollections.map((name) => ({ name, type: "stored" })),
       );
     }
 
@@ -369,7 +369,7 @@ class CollectionController extends NativeController {
       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'
+        '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;
@@ -379,7 +379,7 @@ class CollectionController extends NativeController {
       "core:storage:public:collection:create",
       index,
       collection,
-      config
+      config,
     );
 
     return { acknowledged: true };
@@ -399,7 +399,7 @@ class CollectionController extends NativeController {
       "core:storage:public:collection:update",
       index,
       collection,
-      config
+      config,
     );
 
     return null;
@@ -457,7 +457,7 @@ class CollectionController extends NativeController {
 
         response.collections = response.collections.slice(
           response.from,
-          response.from + response.size
+          response.from + response.size,
         );
       } else {
         response.collections = response.collections.slice(response.from);