binhend 2.3.5 → 2.3.7

package/package.json

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

package/packages/validation/src/typeValidation.js

@@ -10,6 +10,17 @@ const types = require('@binhend/types');
  * @property {*=} default - The default value being used if null or undefined
  */
 
+/**
+ * Type options used in validation functions.
+ *
+ * @param {object} input - Options for validation.
+ * @returns {Options}
+ * @throws {HttpError}
+ */
+function Options(input = {}) {
+    return input;
+}
+
 /**
  * Throw error by default for invalid input.
  * A `HttpError` is thrown for `router` sending response to client.
@@ -287,7 +298,7 @@ function AsyncFunction(input, options = {}) {
     return Validator(input, (input) => input instanceof AsyncFunctionConstructor, { ...options, type: 'async function' });
 }
 
-const AsyncFunctionConstructor = global.Object.getPrototypeOf(async function() {}).constructor;
+const AsyncFunctionConstructor = global.Object.getPrototypeOf(async function () { }).constructor;
 
 /**
  * Validate an input being a date
@@ -314,30 +325,49 @@ function DateLike(input, options = {}) {
 }
 
 /**
- * Validate an input being one of the specified enum values
+ * Validate an input being one of allowed values
  *
+ * @template {string | number | boolean | symbol | bigint} T
  * @param {*} input - Input value needs to be validated.
- * @param {Array|Object} enumValues - Array of allowed values or object whose keys are allowed values
- * @param {Options} options - Additional options for validation.
- * @returns {*} - The validated input
- * @throws {HttpError} - If validation fails
+ * @param {readonly T[]} enumValues - Array of allowed values.
+ * @param {Options} options - Options for validation.
+ * @returns {T} - The validated input.
+ * @throws {HttpError} - If validation fails.
  */
 function Enum(input, enumValues, options = {}) {
-    var validArray = types.isArray(enumValues),
-        validObject = types.isObject(enumValues);
-
-    if (!(validArray || validObject)) {
-        throwError('Enum validator requires an array or object of allowed values');
+    if (!types.isArray(enumValues)) {
+        throwError('Enum validator requires an array of allowed values');
     }
 
-    var method = validArray ? 'includes' : 'hasOwnProperty';
-
     return Validator(
-        input, (input) => enumValues[method](input),
-        { ...options, message: options.message || `${input} is not defined in enum` }
+        input, (input) => enumValues.includes(input),
+        { ...options, message: options?.message || `${options?.name || 'Value'} {${input}} is not defined in ${options?.type || 'Enum'}` }
     );
 }
 
+/**
+ * Return all keys of an object.
+ * Returns an array of names of the enumerable properties and methods of an object.
+ *
+ * @template {{ [key: PropertyKey]: any }} T
+ * @param {T} object - An object with keys and values
+ * @returns {(keyof T)[]} - List of all keys
+ */
+function Keys(object) {
+    return global.Object.keys(object);
+}
+
+/**
+ * Returns an array of values owned by the enumerable properties of an object.
+ * 
+ * @template {{ [key: PropertyKey]: any }} T
+ * @param {T} object
+ * @returns {T[keyof T][]}
+ */
+function Values(object) {
+    return global.Object.values(object);
+}
+
 /**
  * Validate an input being defined (not undefined)
  *
@@ -388,6 +418,8 @@ function Validator(input, validate, options = {}) {
         return input;
     }
 
+    options = { ...options }; // prevent options being null
+
     // use default value (options.default - must also be valid) if has, when input is invalid
     if (options.hasOwnProperty('default') && validate(options.default)) {
         return options.default;
@@ -425,10 +457,11 @@ module.exports = {
     AsyncFunction,
     Date,
     DateLike,
-    Enum,
+    Enum, Keys, Values,
     Defined,
     NotNull,
     NotNullish,
     Validator,
-    throwError
+    throwError,
+    Options
 };