kuzzle 2.20.3 → 2.21.1

package/lib/service/storage/elasticsearch.js

@@ -681,7 +681,7 @@ class ElasticSearch extends Service {
     index,
     collection,
     content,
-    { id, refresh, userId = null } = {}
+    { id, refresh, userId = null, injectKuzzleMeta = true } = {}
   ) {
     assertIsObject(content);
 
@@ -697,12 +697,14 @@ class ElasticSearch extends Service {
     assertWellFormedRefresh(esRequest);
 
     // Add metadata
-    esRequest.body._kuzzle_info = {
-      author: getKuid(userId),
-      createdAt: Date.now(),
-      updatedAt: null,
-      updater: null,
-    };
+    if (injectKuzzleMeta) {
+      esRequest.body._kuzzle_info = {
+        author: getKuid(userId),
+        createdAt: Date.now(),
+        updatedAt: null,
+        updater: null,
+      };
+    }
 
     debug("Create document: %o", esRequest);
 
@@ -789,7 +791,7 @@ class ElasticSearch extends Service {
     collection,
     id,
     content,
-    { refresh, userId = null, retryOnConflict } = {}
+    { refresh, userId = null, retryOnConflict, injectKuzzleMeta = true } = {}
   ) {
     const esRequest = {
       _source: true,
@@ -804,11 +806,13 @@ class ElasticSearch extends Service {
     assertNoRouting(esRequest);
     assertWellFormedRefresh(esRequest);
 
-    // Add metadata
-    esRequest.body.doc._kuzzle_info = {
-      updatedAt: Date.now(),
-      updater: getKuid(userId),
-    };
+    if (injectKuzzleMeta) {
+      // Add metadata
+      esRequest.body.doc._kuzzle_info = {
+        updatedAt: Date.now(),
+        updater: getKuid(userId),
+      };
+    }
 
     debug("Update document: %o", esRequest);
 
@@ -841,7 +845,13 @@ class ElasticSearch extends Service {
     collection,
     id,
     content,
-    { defaultValues = {}, refresh, userId = null, retryOnConflict } = {}
+    {
+      defaultValues = {},
+      refresh,
+      userId = null,
+      retryOnConflict,
+      injectKuzzleMeta = true,
+    } = {}
   ) {
     const esRequest = {
       _source: true,
@@ -863,14 +873,16 @@ class ElasticSearch extends Service {
     const user = getKuid(userId);
     const now = Date.now();
 
-    esRequest.body.doc._kuzzle_info = {
-      updatedAt: now,
-      updater: user,
-    };
-    esRequest.body.upsert._kuzzle_info = {
-      author: user,
-      createdAt: now,
-    };
+    if (injectKuzzleMeta) {
+      esRequest.body.doc._kuzzle_info = {
+        updatedAt: now,
+        updater: user,
+      };
+      esRequest.body.upsert._kuzzle_info = {
+        author: user,
+        createdAt: now,
+      };
+    }
 
     debug("Upsert document: %o", esRequest);
 
@@ -904,7 +916,7 @@ class ElasticSearch extends Service {
     collection,
     id,
     content,
-    { refresh, userId = null } = {}
+    { refresh, userId = null, injectKuzzleMeta = true } = {}
   ) {
     const alias = this._getAlias(index, collection);
     const esRequest = {
@@ -917,13 +929,15 @@ class ElasticSearch extends Service {
     assertNoRouting(esRequest);
     assertWellFormedRefresh(esRequest);
 
-    // Add metadata
-    esRequest.body._kuzzle_info = {
-      author: getKuid(userId),
-      createdAt: Date.now(),
-      updatedAt: Date.now(),
-      updater: getKuid(userId),
-    };
+    if (injectKuzzleMeta) {
+      // Add metadata
+      esRequest.body._kuzzle_info = {
+        author: getKuid(userId),
+        createdAt: Date.now(),
+        updatedAt: Date.now(),
+        updater: getKuid(userId),
+      };
+    }
 
     try {
       const { body: exists } = await this._client.exists({ id, index: alias });

package/lib/types/events/EventGenericDocument.d.ts

@@ -1,4 +1,4 @@
-import { KuzzleRequest, KDocument, JSONObject } from "../../../";
+import { KuzzleRequest, KDocument, JSONObject, PipeEventHandler } from "../../../";
 /**
  * Events with documents only having the `_id`
  */
@@ -23,4 +23,24 @@ export type EventGenericDocumentAfterWrite<KDocumentContent = JSONObject> = Even
 export type EventGenericDocumentBeforeUpdate<KDocumentContent = JSONObject> = EventGenericDocument<"beforeUpdate", KDocumentContent>;
 export type EventGenericDocumentAfterUpdate<KDocumentContent = JSONObject> = EventGenericDocument<"afterUpdate", KDocumentContent>;
 export type EventGenericDocumentAfterGet<KDocumentContent = JSONObject> = EventGenericDocument<"afterGet", KDocumentContent>;
+export type EventGenericDocumentInjectMetadata = {
+    name: `generic:document:injectMetadata`;
+    args: [
+        {
+            /**
+             * Kuzzle Request that triggered the event
+             */
+            request: KuzzleRequest;
+            /**
+             * Metadata of the document
+             */
+            metadata: JSONObject;
+            /**
+             * Default metadata of the document.
+             * Only used when calling document:upsert.
+             */
+            defaultMetadata?: JSONObject;
+        }
+    ];
+} & PipeEventHandler;
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
-  "version": "2.20.3",
+  "version": "2.21.1",
   "description": "Kuzzle is an open-source solution that handles all the data management through a secured API, with a large choice of protocols.",
   "bin": "bin/start-kuzzle-server",
   "scripts": {

package/lib/types/DebugModule.d.ts

@@ -1,24 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import EventEmitter from "events";
-import Inspector from "inspector";
-export type DebugModuleOptions = {
-    methods?: string[];
-    events?: string[];
-};
-export declare abstract class DebugModule extends EventEmitter {
-    name: string;
-    methods: string[];
-    events: string[];
-    /**
-     * Called when the module is loaded, after the debugger has been enabled
-     */
-    abstract init(inspector: Inspector.Session): Promise<void>;
-    /**
-     * Called when the module should be cleaned up.
-     * - After the Debug Controller has been disabled
-     * - Before the debugger is disconnected
-     */
-    abstract cleanup(): Promise<void>;
-    constructor(name: string, options?: DebugModuleOptions);
-}

package/lib/types/DebugModule.js

@@ -1,39 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DebugModule = void 0;
-const events_1 = __importDefault(require("events"));
-class DebugModule extends events_1.default {
-    constructor(name, options = {}) {
-        super();
-        this.name = name;
-        this.methods = options.methods || [];
-        this.events = options.events || [];
-        if (!this.name || this.name.length === 0) {
-            throw new Error("DebugModule should have a name");
-        }
-        if (this.name.charAt(0) !== this.name.charAt(0).toUpperCase()) {
-            throw new Error(`Debug Module name "${name}" should start with an uppercase letter`);
-        }
-        for (const event of this.events) {
-            if (event.length === 0) {
-                throw new Error(`Event name should not be empty for "${name}"`);
-            }
-            if (event.charAt(0) !== event.charAt(0).toLowerCase()) {
-                throw new Error(`Event name "${event}" should start with a lowercase letter for module "${name}"`);
-            }
-        }
-        for (const method of this.methods) {
-            if (method.length === 0) {
-                throw new Error(`Method name should not be empty for Debug Module "${name}"`);
-            }
-            if (method.charAt(0) !== method.charAt(0).toLowerCase()) {
-                throw new Error(`Method name "${method}" should start with a lowercase letter for module "${name}"`);
-            }
-        }
-    }
-}
-exports.DebugModule = DebugModule;
-//# sourceMappingURL=DebugModule.js.map