binhend 2.1.16 → 2.1.18

package/index.js

@@ -24,6 +24,7 @@ const createCSD = require('./src/csd');
 const security = require('./src/security');
 const types = require('./src/utils/types');
 const validation = require('./src/utils/validation');
+const typedefs = require('./src/utils/typedefs');
 const Bromise = require('./src/utils/Bromise.js');
 
 /** CLIENT - Frontend */
@@ -46,6 +47,7 @@ module.exports = {
     createCSD,
     security,
     types,
+    typedefs,
     validation,
     Bromise,
     WebBuilder,

package/package.json

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

package/src/types/common.d.ts

@@ -0,0 +1,10 @@
+
+/**
+ * @typedef {Object<string, any>} ObjectType
+ */
+
+/**
+ * @typedef {(Date|string|number)} DateType
+ */
+
+export {};

package/src/types/index.d.ts

@@ -0,0 +1,2 @@
+
+export * from './common.d.ts';

package/src/utils/typedefs.js

@@ -0,0 +1,31 @@
+
+/**
+ * @typedef {Object<string, any>} ObjectType
+ */
+
+/**
+ * Type definition for object accepting any extra properties
+ *
+ * @returns {ObjectType}
+ */
+function ObjectType() { return this; }
+
+
+
+/**
+ * @typedef {(Date|string|number)} DateType
+ */
+
+/**
+ * Type definition for date accepting any valid formats (string, number, date)
+ *
+ * @returns {DateType}
+ */
+function DateType() { return this; }
+
+
+
+module.exports = {
+    ObjectType,
+    DateType
+};

package/src/utils/types.js

@@ -7,6 +7,10 @@ function isObject(input) {
     return typeOf(input) === 'Object';
 }
 
+function mustObject(input, defaultValue = {}) {
+    return isObject(input) ? input : isObject(defaultValue) ? defaultValue : {};
+}
+
 function isEmptyObject(input) {
     return isObject(input) && Object.keys(input).length === 0;
 }
@@ -17,8 +21,8 @@ function isEmptyArray(input) {
     return isArray(input) && input.length === 0;
 }
 
-function mustArray(input, defaultOutput = []) {
-    return isArray(input) ? input : isArray(defaultOutput) ? defaultOutput : [defaultOutput];
+function mustArray(input, defaultValue = []) {
+    return isArray(input) ? input : isArray(defaultValue) ? defaultValue : [];
 }
 
 function isFunction(input) {
@@ -86,6 +90,7 @@ module.exports = {
     typeOf,
     isObject,
     isEmptyObject,
+    mustObject,
     isArray,
     isEmptyArray,
     mustArray,

package/src/utils/validation.js

@@ -71,6 +71,18 @@ function Number(input, options = {}) {
     return Validator(input, types.isNumber, { ...options, type: 'number' });
 }
 
+/**
+ * Validate an input being an integer
+ *
+ * @param {*} input - Input value needs to be validated.
+ * @param {Options} options - Additional options for validation.
+ * @returns {number} - The validated input
+ * @throws {HttpError} - If validation fails
+ */
+function Integer(input, options = {}) {
+    return Validator(input, global.Number.isInteger, { ...options, type: 'integer' });
+}
+
 /**
  * Validate an input being boolean
  *
@@ -136,13 +148,38 @@ function Date(input, options = {}) {
  *
  * @param {*} input - Input value needs to be validated.
  * @param {Options} options - Additional options for validation.
- * @returns {*} - The validated input
+ * @returns {Date|string|number} - The validated input
  * @throws {HttpError} - If validation fails
  */
 function DateLike(input, options = {}) {
     return Validator(input, types.isDateLike, { ...options, type: 'date-like' });
 }
 
+/**
+ * Validate an input being one of the specified enum values
+ *
+ * @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
+ */
+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');
+    }
+
+    var method = validArray ? 'includes' : 'hasOwnProperty';
+
+    return Validator(
+        input, (input) => enumValues[method](input),
+        { ...options, message: options.message || `${input} is not defined in enum` }
+    );
+}
+
 /**
  * Validate an input being defined (not undefined)
  *
@@ -219,12 +256,14 @@ function Validator(input, validate, options = {}) {
 module.exports = {
     String,
     Number,
+    Integer,
     Boolean,
     Array,
     Object,
     Function,
     Date,
     DateLike,
+    Enum,
     Defined,
     NotNull,
     NotNullish,

package/demo.js

@@ -1,45 +0,0 @@
-
-const { HttpCodes, ConfigLoader, WebBuilder, HttpError, validation } = require('./index');
-
-// HttpCodes.ACCEPTED;
-
-// new ConfigLoader({}).cli;
-
-// const builder = new WebBuilder('src', { output: 'build/bundle' });
-
-// builder.bundle();
-
-// throw new HttpError(HttpCodes.BAD_REQUEST, '[BINHEND][VALIDATION] Must be a string.');
-// throw new HttpError(HttpCodes.BAD_REQUEST, '[BINHEND][VALIDATION] MUST BE A STRING.');
-// var typeName = `array`;
-// throw new HttpError(HttpCodes.BAD_REQUEST, `Invalid input: value not passed custom validator.`);
-// throw new HttpError(HttpCodes.BAD_REQUEST, `Invalid input: unknown reason.`);
-// throw new HttpError(HttpCodes.BAD_REQUEST, `Invalid input: value must be type of \`${typeName}\`.`);
-// throw new HttpError(HttpCodes.BAD_REQUEST, `Invalid input: Field "title" must be type of \`${typeName}\`.`);
-
-// validation.String('a', {});
-
-validation.String('a');
-// validation.String(null);
-// validation.String(1, { name: 'myNum', message: 'Require string for this field' });
-
-// validation.Validator('this is me', (input) => {
-//     if (!input.startsWith('It')) validation.throwError(`"title" must start with 'it' or 'It'`)
-//     return input.length < 5;
-// }, { message: '"title" must not exceed max length of 5' })
-
-
-validation.NotNull(1);
-// validation.NotNullish(null, { required: true, default: null });
-// validation.String(null, { required: true, default: 1 });
-
-validation.DateLike('2022-10-29a', { default: new Date().getTime() });
-validation.Date(new Date());
-
-function Abc(a) {
-    this.a = a;
-}
-
-console.log(JSON.stringify(new Abc(123)));
-
-validation.Object(new Abc(123));