kuzzle 2.17.6 → 2.18.0

package/lib/types/ResponsePayload.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/types/StrategyDefinition.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/types/Token.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/types/User.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/types/index.d.ts

@@ -2,7 +2,6 @@ export * from './Plugin';
 export * from './Controller';
 export * from './ControllerDefinition';
 export * from './ControllerRights';
-export * from './RequestPayload';
 export * from './ResponsePayload';
 export * from './Deprecation';
 export * from './EventHandler';

package/lib/types/index.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *
@@ -38,7 +38,6 @@ __exportStar(require("./Plugin"), exports);
 __exportStar(require("./Controller"), exports);
 __exportStar(require("./ControllerDefinition"), exports);
 __exportStar(require("./ControllerRights"), exports);
-__exportStar(require("./RequestPayload"), exports);
 __exportStar(require("./ResponsePayload"), exports);
 __exportStar(require("./Deprecation"), exports);
 __exportStar(require("./EventHandler"), exports);

package/lib/util/array.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/util/assertType.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/util/asyncStore.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/util/debug.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/util/deprecate.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/util/didYouMean.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/util/dump-collection.d.ts

@@ -1,3 +1,38 @@
 import { JSONObject } from '../../index';
 import { HttpStream } from '../types';
+/**
+ * Flatten an object transform:
+ * {
+ *  title: "kuzzle",
+ *  info : {
+ *    tag: "news"
+ *  }
+ * }
+ *
+ * Into an object like:
+ * {
+ *  title: "kuzzle",
+ *  info.tag: news
+ * }
+ *
+ * @param {Object} target the object we have to flatten
+ * @returns {Object} the flattened object
+ */
+export declare function flattenObject(target: JSONObject): JSONObject;
+/**
+ * Extract fields from mapping by removing the properties from es mapping
+ *
+ * @param mapping
+ * @returns
+ */
+export declare function extractMappingFields(mapping: JSONObject): any;
+/**
+ * An iteration-order-safe version of lodash.values
+ *
+ * @param object The object containing the values
+ * @param fields The field names to pick in the right order
+ * @returns The values in the same order as the fields
+ * @see https://lodash.com/docs/4.17.15#values
+ */
+export declare function pickValues(object: any, fields: string[]): any[];
 export declare function dumpCollectionDocuments(index: string, collection: string, query?: any, format?: string, fields?: string[], options?: JSONObject): HttpStream;

package/lib/util/dump-collection.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.dumpCollectionDocuments = void 0;
+exports.dumpCollectionDocuments = exports.pickValues = exports.extractMappingFields = exports.flattenObject = void 0;
 const ndjson_1 = __importDefault(require("ndjson"));
 const get_1 = __importDefault(require("lodash/get"));
 const isObject_1 = __importDefault(require("lodash/isObject"));
@@ -56,6 +56,7 @@ function flattenObject(target) {
     flattenStep(output, target);
     return output;
 }
+exports.flattenObject = flattenObject;
 function flattenStep(output, object, prev = null) {
     const keys = Object.keys(object);
     for (let i = 0; i < keys.length; i++) {
@@ -63,8 +64,8 @@ function flattenStep(output, object, prev = null) {
         const value = object[key];
         const newKey = prev ? prev + '.' + key : key;
         if (Object.prototype.toString.call(value) === '[object Object]') {
-            output[newKey] = value;
             flattenStep(output, value, newKey);
+            continue;
         }
         output[newKey] = value;
     }
@@ -77,19 +78,20 @@ function flattenStep(output, object, prev = null) {
  */
 function extractMappingFields(mapping) {
     const newMapping = {};
+    if (mapping.properties) {
+        return extractMappingFields(mapping.properties);
+    }
     for (const key of Object.keys(mapping)) {
-        if (key === 'properties' && (0, isObject_1.default)(mapping[key])) {
-            newMapping[key] = extractMappingFields(mapping[key]);
-        }
-        else if ((0, isObject_1.default)(mapping[key]) && mapping[key].type) {
+        if ((0, isObject_1.default)(mapping[key]) && mapping[key].type) {
             newMapping[key] = mapping[key].type;
         }
-        else {
-            newMapping[key] = mapping[key];
+        else if ((0, isObject_1.default)(mapping[key])) {
+            newMapping[key] = extractMappingFields(mapping[key]);
         }
     }
     return newMapping;
 }
+exports.extractMappingFields = extractMappingFields;
 /**
  * An iteration-order-safe version of lodash.values
  *
@@ -101,6 +103,7 @@ function extractMappingFields(mapping) {
 function pickValues(object, fields) {
     return fields.map(f => formatValueForCSV((0, get_1.default)(object, f)));
 }
+exports.pickValues = pickValues;
 /**
  * Formats the value for correct CSV output, avoiding to return
  * values that would badly serialize in CSV.

package/lib/util/extractFields.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/util/inflector.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/util/koncordeCompat.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/util/memoize.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/util/mutex.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/util/name-generator.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/util/promback.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/util/requestAssertions.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/util/safeObject.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/util/stackTrace.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *
@@ -21,33 +21,72 @@
 
 'use strict';
 
+const util = require('util');
+
+const MARKER = '>';
+const PADDING = '  ';
+
 /**
-  * Hilight user code
-  *
-  * e.g.
-  *     at BackendController._add (/home/kuzzle/lib/core/application/backend.ts:261:28)
-  *     at BackendController.register (/home/kuzzle/lib/core/application/backend.ts:187:10)
-  * >  at registerFoo (/home/aschen/projets/app/test.ts:12:18)
-  * >  at init (/home/aschen/projets/app/test.ts:8:3)
-  *     at Module._compile (internal/modules/cjs/loader.js:1133:30)
-  */
+ * Hilight user code
+ *
+ * e.g.
+ *       at BackendController._add (/home/kuzzle/lib/core/application/backend.ts:261:28)
+ *       at BackendController.register (/home/kuzzle/lib/core/application/backend.ts:187:10)
+ * >>>>  at registerFoo (/home/aschen/projets/app/test.ts:12:18)
+ * >>>>  at init (/home/aschen/projets/app/test.ts:8:3)
+ *       at Module._compile (internal/modules/cjs/loader.js:1133:30)
+ */
 function hilightUserCode (line) {
   // ignore first line (error message) or already enhanced
-  if (! line.includes(' at ') || line.startsWith('>')) {
+  if (! line.includes(' at ') || line.startsWith(MARKER)) {
     return line;
   }
 
-  if ( line.includes('kuzzle/lib/') // ignore kuzzle code
-    || (line.indexOf('at /') === -1 && line.charAt(line.indexOf('(') + 1) !== '/') // ignore node internal
-    || line.includes('node_modules') // ignore dependencies
-  ) {
-    return '   ' + line;
+  const isKuzzleCode = line.includes('kuzzle/lib/');
+  const isNodeCode = ! line.includes('at /')
+                  && ! line.includes('at async /')
+                  && line.charAt(line.indexOf('(') + 1) !== '/';
+  const isModuleCode = line.includes('node_modules');
+  if (isKuzzleCode || isNodeCode || isModuleCode) {
+    return PADDING + line;
   }
 
   // hilight user code
-  return '>' + line;
+  return MARKER + line;
+}
+
+/**
+ * utility method: must be invoked by all protocols to remove stack traces
+ * from payloads before sending them
+ * @param  {Error|Object} data - expected: plain error object or serialized
+ *                               request response
+ * @returns {*} return the data minus the stack trace
+ */
+function removeStacktrace (data) {
+  if (util.types.isNativeError(data)) {
+    if (global.NODE_ENV !== 'development') {
+      data.stack = undefined;
+    }
+    else {
+      data.stack = data.stack.split('\n').map(hilightUserCode).join('\n');
+    }
+  }
+  else if (data && data.content && data.content.error) {
+    // @todo v3: stack should be removed only for "production" env
+    if (global.NODE_ENV !== 'development') {
+      data.content.error.stack = undefined;
+    }
+    else {
+      data.content.error.stack = data.content.error.stack
+        ? data.content.error.stack.split('\n').map(hilightUserCode).join('\n')
+        : undefined;
+    }
+  }
+
+  return data;
 }
 
 module.exports = {
   hilightUserCode,
+  removeStacktrace,
 };

package/lib/util/wildcard.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *