binhend 2.3.3 → 2.3.4

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "binhend",
-    "version": "2.3.3",
+    "version": "2.3.4",
     "description": "",
     "main": "index.js",
     "author": "Nguyen Duc Binh",

package/packages/validation/src/typeValidation.js

@@ -5,9 +5,9 @@ const types = require('@binhend/types');
  * @typedef {Object} Options
  * @property {string=} message - Any custom error message
  * @property {string=} type - Expected type name of value, e.g. string, number, array, etc.
- * @property {string=} name - The variable/property name holding value
- * @property {boolean=} required - The variable/property name holding value
- * @property {*=} default - The variable/property name holding value
+ * @property {string=} name - The name of variable/property holding value
+ * @property {boolean=} required - The value must not be null or undefined
+ * @property {*=} default - The default value being used if null or undefined
  */
 
 /**
@@ -109,15 +109,46 @@ function Array(input, options = {}) {
 /**
  * Validate an input being an object (non-array)
  *
- * @param {*} input - Input value needs to be validated.
- * @param {Options} options - Additional options for validation.
- * @returns {Object} - The validated input
+ * @template {Record<string, any>} [T={}]
+ * @template {Record<string, any>} [O={}]
+ * 
+ * @param {T=} input - Input value needs to be validated.
+ * @param {Options & { optional?: O }} options - Options for validation with extra option { optional } for listing optional properties.
+ * @returns {T & O & Record<string, any>} - The validated input
  * @throws {HttpError} - If validation fails
  */
 function Object(input, options = {}) {
     return Validator(input, types.isObject, { ...options, type: 'object' });
 }
 
+/**
+ * Return an object fragment with a specific key
+ * only if the key exists AND validation is passed.
+ *
+ * @template {string} K
+ * @template V
+ * @param {K} key - A property name
+ * @param {*} object - Any target that may have properties (objects or primitives)
+ * @param {((value: any, options: Options) => V)} [validator] - An optional validation function
+ * @param {Options=} options - Options for validation.
+ * @returns {{ [P in K]?: V }}
+ */
+function Prop(key, object, validator, options) {
+    var value = object != null ? object[key] : undefined;
+
+    if (validator instanceof Function) {
+        value = validator(value, { ...options, name: key });
+    }
+
+    if (object == null || !Object.prototype.hasOwnProperty.call(object, key)) {
+        return /** @type {{ [P in K]?: V }} */ ({});
+    }
+
+    return /** @type {{ [P in K]?: V }} */ ({
+        [key]: value
+    });
+}
+
 /**
  * Validate an input being a function
  *
@@ -273,6 +304,7 @@ module.exports = {
     Boolean,
     Array,
     Object,
+    Prop,
     Function,
     AsyncFunction,
     Date,