@galeh/chuka 1.1.2 → 1.1.3

package/package.json

@@ -1,50 +1,41 @@
 {
-  "name": "@galeh/chuka",
-  "version": "1.1.2",
-  "description": "simple yet robust wrapper for expressjs",
-  "scripts": {
-    "build": "./scripts/build.bash",
-    "prepublish": "npm run build"
-  },
-  "keywords": [
-    "chuka",
-    "framework",
-    "web",
-    "http",
-    "rest",
-    "restful",
-    "router",
-    "app",
-    "api"
-  ],
-  "author": "Hojjat Bakhtiyari <dariogaleh@gmail.com>",
-  "license": "MIT",
-  "dependencies": {
-    "express": "^4.18.2",
-    "express-ws": "^5.0.2",
-    "inversify": "^6.0.2",
-    "reflect-metadata": "^0.2.1",
-    "tslib": "^2.6.2",
-    "@types/express": "^4.17.21",
-    "@types/express-ws": "^3.0.4",
-    "@types/ws": "^8.5.10"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "devDependencies": {
-    "@microsoft/api-extractor": "^7.39.0",
-    "ts-loader": "^9.5.1",
-    "typescript": "^5.3.3",
-    "webpack": "^5.89.0",
-    "webpack-cli": "^5.1.4"
-  },
-  "engines": {
-    "node": ">= 12.7"
-  },
-  "sideEffects": false,
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/hgaleh/chuka.git"
-  }
-}
+    "name": "@galeh/chuka",
+    "version": "1.1.3",
+    "description": "simple yet robust wrapper for expressjs",
+    "keywords": [
+        "chuka",
+        "framework",
+        "web",
+        "http",
+        "rest",
+        "restful",
+        "router",
+        "app",
+        "api"
+    ],
+    "author": "Hojjat Bakhtiyari <dariogaleh@gmail.com>",
+    "license": "MIT",
+    "dependencies": {
+        "express": "^4.18.2",
+        "express-ws": "^5.0.2",
+        "inversify": "^6.0.2",
+        "reflect-metadata": "^0.2.1",
+        "tslib": "^2.6.2",
+        "@types/express": "^4.17.21",
+        "@types/express-ws": "^3.0.4",
+        "@types/ws": "^8.5.10"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "engines": {
+        "node": ">= 12.7"
+    },
+    "sideEffects": false,
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/hgaleh/chuka.git"
+    },
+    "type": "commonjs",
+    "main": "index.js"
+}

package/validators.d.ts

@@ -0,0 +1,60 @@
+import { NextFunction } from 'express';
+import { Request as Request_2 } from 'express';
+import { Response as Response_2 } from 'express';
+
+export declare function and<T>(...validationFunctions: Array<Validator<T>>): Validator<T>;
+
+declare class AtomicValidator<T> extends Validator<T> {
+    private implementation;
+    queryField?: keyof T | undefined;
+    constructor(implementation: (subject: T | T[keyof T]) => ValidatorReturn, queryField?: keyof T | undefined);
+    validate(subject: T, selectedField: keyof T): ValidatorReturn;
+}
+
+export declare function bodyValidator<T>(validationLogic: ValidationLogic<T>): Middleware<{
+    body: T;
+}>;
+
+export declare function custom<T>(validator: (obj: T) => ValidatorReturn): Validator<T>;
+
+export declare function isDefined<T>(field?: keyof T): AtomicValidator<T>;
+
+export declare function isNull<T>(field?: keyof T): AtomicValidator<T>;
+
+export declare function isNumber<T>(field?: keyof T): AtomicValidator<T>;
+
+export declare function isString<T>(field?: keyof T): AtomicValidator<T>;
+
+export declare function isUndefined<T>(field?: keyof T): AtomicValidator<T>;
+
+declare type MergePartial<A, B> = {
+    [k in keyof A & keyof B]: (A & B)[k] extends never ? B[k] : 0 extends 1 & (A & B)[k] ? B[k] : (A & B)[k];
+} & Omit<A, keyof B> & Partial<Omit<B, keyof A>>;
+
+declare interface Middleware<T> {
+    (req: MergePartial<Request_2, T>, res: Response_2, next: NextFunction): void;
+}
+
+export declare function not<T>(validationFunction: Validator<T>): Validator<T>;
+
+export declare function notNull<T>(field?: keyof T): AtomicValidator<T>;
+
+export declare function or<T>(...validationFunctions: Array<Validator<T>>): Validator<T>;
+
+declare type RequestField<F extends PropertyKey, T> = Record<F, T>;
+
+declare type UnArray<T> = T extends Array<infer A> ? A : T;
+
+export declare type ValidationLogic<T> = {
+    [k in keyof T as T[k] extends Function ? never : k]?: ValidationLogic<UnArray<T[k]>> | Validator<T>;
+};
+
+declare abstract class Validator<T> {
+    abstract validate(subject: T, selectedField: keyof T): ValidatorReturn;
+}
+
+export declare function validator<T, F extends PropertyKey>(validationLogic: ValidationLogic<T>, requestField: F): Middleware<RequestField<F, T>>;
+
+declare type ValidatorReturn = boolean | Promise<boolean>;
+
+export { }

package/validators.js

@@ -0,0 +1,105 @@
+/*
+ * ATTENTION: The "eval" devtool has been used (maybe by default in mode: "development").
+ * This devtool is neither made for production nor for readable output files.
+ * It uses "eval()" calls to create a separate source file in the browser devtools.
+ * If you are trying to read the output file, select a different devtool (https://webpack.js.org/configuration/devtool/)
+ * or disable the default devtool with "devtool: false".
+ * If you are looking for production-ready output files, see mode: "production" (https://webpack.js.org/configuration/mode/).
+ */
+/******/ var __webpack_modules__ = ({
+
+/***/ "./src/validators/body-validator.ts":
+/*!******************************************!*\
+  !*** ./src/validators/body-validator.ts ***!
+  \******************************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */   bodyValidator: () => (/* binding */ bodyValidator)\n/* harmony export */ });\n/* harmony import */ var ___WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! . */ \"./src/validators/validators.ts\");\n\nfunction bodyValidator(validationLogic) {\n    return (req, res, next) => {\n        (0,___WEBPACK_IMPORTED_MODULE_0__.validator)(validationLogic, 'body')(req, res, next);\n    };\n}\n\n\n//# sourceURL=webpack://@galeh/chuka/./src/validators/body-validator.ts?");
+
+/***/ }),
+
+/***/ "./src/validators/index.ts":
+/*!*********************************!*\
+  !*** ./src/validators/index.ts ***!
+  \*********************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */   and: () => (/* reexport safe */ _validators__WEBPACK_IMPORTED_MODULE_0__.and),\n/* harmony export */   bodyValidator: () => (/* reexport safe */ _body_validator__WEBPACK_IMPORTED_MODULE_1__.bodyValidator),\n/* harmony export */   custom: () => (/* reexport safe */ _validators__WEBPACK_IMPORTED_MODULE_0__.custom),\n/* harmony export */   isDefined: () => (/* reexport safe */ _validators__WEBPACK_IMPORTED_MODULE_0__.isDefined),\n/* harmony export */   isNull: () => (/* reexport safe */ _validators__WEBPACK_IMPORTED_MODULE_0__.isNull),\n/* harmony export */   isNumber: () => (/* reexport safe */ _validators__WEBPACK_IMPORTED_MODULE_0__.isNumber),\n/* harmony export */   isString: () => (/* reexport safe */ _validators__WEBPACK_IMPORTED_MODULE_0__.isString),\n/* harmony export */   isUndefined: () => (/* reexport safe */ _validators__WEBPACK_IMPORTED_MODULE_0__.isUndefined),\n/* harmony export */   not: () => (/* reexport safe */ _validators__WEBPACK_IMPORTED_MODULE_0__.not),\n/* harmony export */   notNull: () => (/* reexport safe */ _validators__WEBPACK_IMPORTED_MODULE_0__.notNull),\n/* harmony export */   or: () => (/* reexport safe */ _validators__WEBPACK_IMPORTED_MODULE_0__.or),\n/* harmony export */   validator: () => (/* reexport safe */ _validators__WEBPACK_IMPORTED_MODULE_0__.validator)\n/* harmony export */ });\n/* harmony import */ var _validators__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./validators */ \"./src/validators/validators.ts\");\n/* harmony import */ var _body_validator__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./body-validator */ \"./src/validators/body-validator.ts\");\n\n\n\n\n//# sourceURL=webpack://@galeh/chuka/./src/validators/index.ts?");
+
+/***/ }),
+
+/***/ "./src/validators/validators.ts":
+/*!**************************************!*\
+  !*** ./src/validators/validators.ts ***!
+  \**************************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */   AtomicValidator: () => (/* binding */ AtomicValidator),\n/* harmony export */   Validator: () => (/* binding */ Validator),\n/* harmony export */   and: () => (/* binding */ and),\n/* harmony export */   andAsync: () => (/* binding */ andAsync),\n/* harmony export */   custom: () => (/* binding */ custom),\n/* harmony export */   isDefined: () => (/* binding */ isDefined),\n/* harmony export */   isNull: () => (/* binding */ isNull),\n/* harmony export */   isNumber: () => (/* binding */ isNumber),\n/* harmony export */   isString: () => (/* binding */ isString),\n/* harmony export */   isUndefined: () => (/* binding */ isUndefined),\n/* harmony export */   not: () => (/* binding */ not),\n/* harmony export */   notNull: () => (/* binding */ notNull),\n/* harmony export */   or: () => (/* binding */ or),\n/* harmony export */   validator: () => (/* binding */ validator)\n/* harmony export */ });\nfunction validator(validationLogic, requestField) {\n    return (req, res, next) => {\n        // @ts-ignore\n        applyValidation(req[requestField], validationLogic).then(errors => {\n            const result = isThereAnyErrors(errors);\n            if (result) {\n                next(errors);\n            }\n            else {\n                next();\n            }\n        }).catch(next);\n    };\n}\nasync function applyValidation(obj, validationLogic) {\n    const validationResult = {};\n    for (const key in validationLogic) {\n        const atomicValidator = validationLogic[key];\n        if (atomicValidator) {\n            if (atomicValidator instanceof Validator) {\n                try {\n                    validationResult[key] = atomicValidator.validate(obj, key);\n                    if (validationResult[key] instanceof Promise) {\n                        validationResult[key] = await validationResult[key];\n                        console.log(`awaited result: ${validationResult[key]}`);\n                    }\n                }\n                catch (err) {\n                    validationResult[key] = false;\n                }\n            }\n            else {\n                if (obj[key] instanceof Array) {\n                    validationResult[key] = obj[key].map(objj => applyValidation(objj, atomicValidator));\n                    if (validationResult[key][0] instanceof Promise) {\n                        validationResult[key] = Promise.all(validationResult[key]);\n                    }\n                }\n                else {\n                    validationResult[key] = applyValidation(obj[key], atomicValidator);\n                    if (validationResult[key] instanceof Promise) {\n                        validationResult[key] = await validationResult[key];\n                    }\n                }\n            }\n        }\n        else {\n            validationResult[key] = true;\n        }\n    }\n    return validationResult;\n}\nfunction isThereAnyErrors(obj) {\n    for (const [key, value] of Object.entries(obj)) {\n        if (value === false) {\n            return true;\n        }\n        else if (typeof value !== 'boolean') {\n            const partialRes = isThereAnyErrors(value);\n            if (partialRes) {\n                return partialRes;\n            }\n        }\n    }\n    return false;\n}\n// type ValidationFunction<T> = (subject: T) => boolean;\nclass Validator {\n}\nclass CustomValidator extends Validator {\n    constructor(validator) {\n        super();\n        this.validator = validator;\n    }\n    validate(subject, selectedField) {\n        return this.validator(subject);\n    }\n}\nfunction custom(validator) {\n    return new CustomValidator(validator);\n}\nclass AtomicValidator extends Validator {\n    constructor(implementation, queryField) {\n        super();\n        this.implementation = implementation;\n        this.queryField = queryField;\n    }\n    validate(subject, selectedField) {\n        return this.implementation(this.queryField ? subject[this.queryField] : subject[selectedField]);\n    }\n}\nfunction isString(field) {\n    return new AtomicValidator((subject) => {\n        return typeof subject === 'string';\n    }, field);\n}\nfunction isNumber(field) {\n    return new AtomicValidator((subject) => {\n        return typeof subject === 'number';\n    }, field);\n}\nfunction isDefined(field) {\n    return new AtomicValidator((subject) => {\n        return subject != undefined;\n    }, field);\n}\nfunction isUndefined(field) {\n    return new AtomicValidator((subject) => {\n        return subject === undefined;\n    }, field);\n}\nfunction isNull(field) {\n    return new AtomicValidator((subject) => {\n        return subject === null;\n    }, field);\n}\nfunction notNull(field) {\n    return new AtomicValidator((subject) => {\n        return subject !== null;\n    }, field);\n}\nclass AndValidator extends Validator {\n    constructor(...validationFunctions) {\n        super();\n        this.validationFunctions = validationFunctions;\n    }\n    validate(subject, selectedField) {\n        return this.validationFunctions.every(eachValidator => eachValidator.validate(subject, selectedField));\n    }\n}\nclass AndValidatorAsync extends Validator {\n    constructor(...validationFunctions) {\n        super();\n        this.validationFunctions = validationFunctions;\n    }\n    async validate(subject, selectedField) {\n        const allPromises = this.validationFunctions.map(eachValidator => eachValidator.validate(subject, selectedField));\n        const allResults = await Promise.all(allPromises);\n        return allResults.every(val => val);\n    }\n}\nclass OrValidator extends Validator {\n    constructor(...validationFunctions) {\n        super();\n        this.validationFunctions = validationFunctions;\n    }\n    validate(subject, selectedField) {\n        return this.validationFunctions.some(eachValidator => eachValidator.validate(subject, selectedField));\n    }\n}\nclass NotValidator extends Validator {\n    constructor(validationFunctions) {\n        super();\n        this.validationFunction = validationFunctions;\n    }\n    validate(subject, selectedField) {\n        return !this.validationFunction.validate(subject, selectedField);\n    }\n}\nfunction and(...validationFunctions) {\n    return new AndValidator(...validationFunctions);\n}\nfunction andAsync(...validationFunctions) {\n    return new AndValidatorAsync(...validationFunctions);\n}\nfunction or(...validationFunctions) {\n    return new OrValidator(...validationFunctions);\n}\nfunction not(validationFunction) {\n    return new NotValidator(validationFunction);\n}\n\n\n//# sourceURL=webpack://@galeh/chuka/./src/validators/validators.ts?");
+
+/***/ })
+
+/******/ });
+/************************************************************************/
+/******/ // The module cache
+/******/ var __webpack_module_cache__ = {};
+/******/ 
+/******/ // The require function
+/******/ function __webpack_require__(moduleId) {
+/******/ 	// Check if module is in cache
+/******/ 	var cachedModule = __webpack_module_cache__[moduleId];
+/******/ 	if (cachedModule !== undefined) {
+/******/ 		return cachedModule.exports;
+/******/ 	}
+/******/ 	// Create a new module (and put it into the cache)
+/******/ 	var module = __webpack_module_cache__[moduleId] = {
+/******/ 		// no module.id needed
+/******/ 		// no module.loaded needed
+/******/ 		exports: {}
+/******/ 	};
+/******/ 
+/******/ 	// Execute the module function
+/******/ 	__webpack_modules__[moduleId](module, module.exports, __webpack_require__);
+/******/ 
+/******/ 	// Return the exports of the module
+/******/ 	return module.exports;
+/******/ }
+/******/ 
+/************************************************************************/
+/******/ /* webpack/runtime/define property getters */
+/******/ (() => {
+/******/ 	// define getter functions for harmony exports
+/******/ 	__webpack_require__.d = (exports, definition) => {
+/******/ 		for(var key in definition) {
+/******/ 			if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {
+/******/ 				Object.defineProperty(exports, key, { enumerable: true, get: definition[key] });
+/******/ 			}
+/******/ 		}
+/******/ 	};
+/******/ })();
+/******/ 
+/******/ /* webpack/runtime/hasOwnProperty shorthand */
+/******/ (() => {
+/******/ 	__webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))
+/******/ })();
+/******/ 
+/******/ /* webpack/runtime/make namespace object */
+/******/ (() => {
+/******/ 	// define __esModule on exports
+/******/ 	__webpack_require__.r = (exports) => {
+/******/ 		if(typeof Symbol !== 'undefined' && Symbol.toStringTag) {
+/******/ 			Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+/******/ 		}
+/******/ 		Object.defineProperty(exports, '__esModule', { value: true });
+/******/ 	};
+/******/ })();
+/******/ 
+/************************************************************************/
+/******/ 
+/******/ // startup
+/******/ // Load entry module and return exports
+/******/ // This entry module can't be inlined because the eval devtool is used.
+/******/ var __webpack_exports__ = __webpack_require__("./src/validators/index.ts");
+/******/ var __webpack_export_target__ = exports;
+/******/ for(var i in __webpack_exports__) __webpack_export_target__[i] = __webpack_exports__[i];
+/******/ if(__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, "__esModule", { value: true });
+/******/ 

package/.github/workflows/webpack.yml

@@ -1,34 +0,0 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
-
-name: Node.js Package
-
-on:
-  push:
-    branches: [ "master" ]
-  pull_request:
-    branches: [ "master" ]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-      - run: npm ci
-
-  publish-npm:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPMTOKEN}}