chyz 1.0.13-rc.3 → 1.0.13-rc.4

package/dist/README.md

@@ -1,270 +0,0 @@
-Hızlı şekilde microservis hazırlama için geliştirmeye başladım<br>
-
-Temel olarak yii2 php framework'ten örnekler alındı<br>
-
-Temel olarak basit bir Controller geliştirildi, ayrıca authentication geliştirildi.<br>
-
-Klasör Yapısı<br>
-*---Controllers  <br>
-*---Models<br>
-*---Log<br>
-*---Framework<br>
-index.ts<br>
-
-`##Başlangıç<br>
-yarn start
-
-## index.ts alanlar düzenlenmeli.
-
-```typescript
-require('dotenv-flow').config();
-
-import BaseChyz from "chyz/dist/BaseChyz";
-import Chyz, {DbConnection} from "chyz/dist";
-import {WebUser} from "../web/WebUser";
-import {User} from "./Models/User";
-
-let config = {
-    components: {
-        db: {
-            class: DbConnection,
-            database: process.env.DBDATABASE,
-            username: process.env.DBUSER,
-            password: process.env.DBPASS,
-            options: {
-                host: process.env.DBHOST,
-                dialect: 'postgres',  /* one of 'mysql' | 'mariadb' | 'postgres' | 'mssql' */
-                // disable logging; default: console.log
-                logging: false
-            }
-        },
-        user: {
-            'class': WebUser,
-            'identityClass': User
-        }
-    }
-}
-Chyz.app(config).Start();
-```
-
-## Create Model
-
-Veritabanı işlemleri için model oluşturma, sequelize desteklidir.
-
-```typescript
-import {Model, DataTypes} from "chyz/base/Model";
-
-export class CustomerCLass extends Model {
-    public tableName() {
-        return 'customer';
-    }
-
-    public attributes() {
-        return {
-            username: {
-                type: DataTypes.STRING,
-                allowNull: false,
-                validate: {
-                    notEmpty: true,
-                    len: [4, 255],
-                }
-            },
-            email: {
-                type: DataTypes.STRING,
-                validate: {
-                    isEmail: true
-                }
-            },
-            firstname: {
-                type: DataTypes.STRING,
-                allowNull: false
-            },
-            lastname: {
-                type: DataTypes.STRING,
-            },
-        }
-    }
-
-}
-const Customer= new CustomerCLass();
-export { Customer };
-
-```
-````typescript
-export class ProductsClass extends Model {
-    [x: string]: any;
-
-    tableName() {
-        return 'products';
-    }
-
-    attributes() {
-        return {
-            // Model attributes are defined here
-            title: {
-                type: DataTypes.STRING,
-                allowNull: false
-            },
-            model_id: {
-                type: DataTypes.INTEGER,
-                allowNull: false
-            },
-            properties: {
-                type: DataTypes.STRING,
-                allowNull: false
-            }
-
-        }
-    }
-
-    relations(): Relation[] {
-        return [
-            {
-                type: "hasOne",
-                foreignKey: "id",
-                sourceKey: "customer_id",
-                model: Customer.model()
-            }
-        ]
-    }
-}
-
-const Products = new ProductsClass()
-export {Products}
-````
-
-## Http POST ve GET verilerini model'e yükleme
-
-````typescript
-
-/**
- * post data
- *  {
- *      "Customer":{
- *          "firstname":"cihan",
- *          "lastname":"ozturk"
- *          ....
- *      }
- *  }
- * @type {Customer}
- */
-import {Customer} from "./Customer";
-//Customer Model Create
-let customer: Customer = Customer;
-customer.load(req.body, "Customer");//load customer data
-let cus: any = await customer.save();
-
-
-````
-## Transaction
-Transaction oluşturma
-
-
-```typescript
-    let transaction
-    try {
-        // get transaction
-        transaction = await BaseChyz.getComponent("db").transaction();
-        //Customer Model Create
-        let customer: Customer = new Customer();
-        customer.load(data, "Customer");//load customer data
-        let cus: any = await customer.save({}, {transaction});
-        if (!cus) {
-            throw new ValidationHttpException(customer.errors);
-        }
-    } catch (e) {
-        if (transaction) {
-            await transaction.rollback();
-            BaseChyz.warn("Rollback transaction")
-        }
-        ...
-    }
-```
-
-## Yetkilendirme için kullanıcı modeli
-
-```typescript
-/*
- * Copyright (c) 2021. Chy Bilgisayar Bilisim
- * Author: Cihan Ozturk
- * E-mail: cihan@chy.com.tr
- * Github:https://github.com/cihan53/
- */
-import {IdentityInterface} from "chyz/web/IdentityInterface";
-// @ts-ignore
-import {DataTypes} from "chyz/base";
-import {Model} from "chyz/base";
-import BaseChyz from "chyz/BaseChyz";
-
-const bcrypt = require('bcrypt');
-const JsonWebToken = require("jsonwebtoken");
-
-export class User extends Model implements IdentityInterface {
-    public tableName() {
-        return 'users';
-    }
-    findIdentity(id: number) {
-        throw new Error("Method not implemented.");
-    }
-
-    getId(): number {
-        throw new Error("Method not implemented.");
-    }
-
-    getAuthKey(): string {
-        throw new Error("Method not implemented.");
-    }
-
-    validateAuthKey(authKey: string): boolean {
-        throw new Error("Method not implemented.");
-    }
-
-    public attributes() {
-        return {
-            // Model attributes are defined here
-            username: {
-                type: DataTypes.STRING,
-                allowNull: false
-            },
-            password: {
-                type: DataTypes.STRING,
-                allowNull: false
-            },
-            user_role: {
-                type: DataTypes.STRING,
-                allowNull: false
-            },
-            salt_text: {
-                type: DataTypes.STRING
-                // allowNull defaults to true
-            }
-        }
-    }
-
-    async findIdentityByAccessToken(token, type) {
-        let decoded = JsonWebToken.decode(token, {complete: true})
-        let identity = await this.findOne({where: {id: parseInt(decoded.payload.user)}});
-        if(identity){
-            BaseChyz.debug("Find Identity By AccessToken: User Found", decoded.payload)
-            try {
-                JsonWebToken.verify(token, identity.salt_text);
-                BaseChyz.debug("Find Identity By AccessToken: User Verify Success")
-                return identity;
-            } catch(err) {
-                BaseChyz.debug("Find Identity By AccessToken: User Verify Failed")
-                return null;
-            }
-        }
-        BaseChyz.debug("Find Identity By AccessToken: User Verify Failed")
-        return null;
-    }
-
-
-}
-
-
-
-
-
-
-```

package/dist/log/config/log4js.json

@@ -1,55 +0,0 @@
-{
-  "appenders": {
-    "access": {
-      "type": "dateFile",
-      "filename": "log/access.log",
-      "pattern": "-yyyy-MM-dd",
-      "category": "http",
-      "layout": {
-        "type": "pattern",
-        "pattern": "[%d{yyyy-MM-ddThh.mm.ss.SSS}] [%p] %c [%l] [%f] - %m"
-      }
-    },
-    "app": {
-      "type": "file",
-      "filename": "log/app.log",
-      "maxLogSize": 10485760,
-      "numBackups": 3,
-      "layout": {
-        "type": "pattern",
-        "pattern": "[%d{yyyy-MM-ddThh.mm.ss.SSS}] [%p] %c [%l] [%f] - %m"
-      }
-    },
-    "errorFile": {
-      "type": "file",
-      "filename": "log/errors.log",
-      "layout": {
-        "type": "pattern",
-        "pattern": "[%d{yyyy-MM-ddThh.mm.ss.SSS}] [%p] %c [%l] [%f] - %m"
-      }
-    },
-    "errors": {
-      "type": "logLevelFilter",
-      "level": "ERROR",
-      "appender": "errorFile",
-      "layout": {
-        "type": "pattern",
-        "pattern": "[%d{yyyy-MM-ddThh.mm.ss.SSS}] [%p] %c [%l] [%f] - %m"
-      }
-    },
-    "console": {
-      "type": "stdout"
-    }
-  },
-  "categories": {
-    "default": {
-      "appenders": ["console","app" ,"errors" ],
-      "level": "ALL",
-      "enableCallStack": true
-    },
-    "http": {
-      "level": "INFO",
-      "appenders": [ "access" ]
-    }
-  }
-}

package/dist/package.json

@@ -1,55 +0,0 @@
-{
-  "name": "chyz",
-  "version": "1.0.13-rc.3",
-  "description": "Nodejs MicroServis Framework",
-  "main": "index.js",
-  "scripts": {
-    "dev": "nodemon index.ts",
-    "debug": "ts-node index.ts",
-    "build": "rmdir /S /Q .\\dist && npx tsc && xcopy .\\log .\\dist\\log /e /i /h /Y && copy .\\package.json .\\dist\\package.json && copy .\\README.md .\\dist\\README.md ",
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "postversion": "git push && git push --tags"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/cihan53/Chy-Nodejs-Framework.git"
-  },
-  "author": "Cihan Ozturk",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/cihan53/Chy-Nodejs-Framework/issues"
-  },
-  "homepage": "https://github.com/cihan53/Chy-Nodejs-Framework#readme",
-  "dependencies": {
-    "axios": "^0.23.0",
-    "babel-plugin-transform-decorators-legacy": "^1.3.5",
-    "body-parser": "^1.19.0",
-    "dotenv-flow": "^3.2.0",
-    "express": "^4.17.1",
-    "express-session": "^1.17.2",
-    "glob": "^7.1.7",
-    "ip": "^1.1.5",
-    "jsonwebtoken": "^8.5.1",
-    "lodash": "^4.17.21",
-    "log4js": "^6.3.0",
-    "method-override": "^3.0.0",
-    "passport": "^0.4.1",
-    "pg": "^8.7.1",
-    "pg-hstore": "^2.3.4",
-    "reflect-metadata": "^0.1.13",
-    "sequelize": "^6.6.5"
-  },
-  "devDependencies": {
-    "@types/express": "^4.17.13",
-    "@types/node": "^16.6.1",
-    "@types/validator": "^13.6.3",
-    "nodemon": "^2.0.12",
-    "ts-node": "^10.2.0",
-    "typescript": "^4.3.5"
-  },
-  "keywords": [
-    "Framework",
-    "RespAPI",
-    "microservice"
-  ]
-}

package/filters/AccessControl.ts

@@ -1,64 +0,0 @@
-/*
- * Copyright (c) 2021. Chy Bilgisayar Bilisim
- * Author: Cihan Ozturk
- * E-mail: cihan@chy.com.tr
- * Github:https://github.com/cihan53/
- */
-import BaseChyz from "../BaseChyz";
-import {ForbiddenHttpException} from "../base/ForbiddenHttpException";
-import {ActionFilter} from "../base/ActionFilter";
-import {AccessRule} from "./AccessRule";
-import {WebUser} from "../web/WebUser";
-import Utils from "../requiments/Utils";
-import {NextFunction, Request, Response} from "express";
-
-var _ = require('lodash');
-
-
-export class AccessControl extends ActionFilter {
-
-    public user: any = null;
-    public rules: any;
-
-    public init() {
-        super.init()
-
-        if (this.user == undefined) {
-            this.user = Utils.cloneDeep(BaseChyz.getComponent("user")) ?? new WebUser();
-        }
-
-        this.rules.forEach((rule:any, index:number) => {
-            if (rule === Object(rule)) {
-                this.rules[index] = Utils.createObject(new AccessRule(), rule);
-            }
-        })
-    }
-
-
-    public async beforeAction(action:any, request:Request) {
-        let allow;
-        // @ts-ignore
-        let user = request.user ?? this.user;
-        // @ts-ignore
-        user.identity = request.identity ?? null;
-
-        for (const rulesKey in this.rules) {
-            if ((allow = this.rules[rulesKey].allows(action, user, request))) {
-                return true;
-            } else if (allow === false) {
-                this.denyAccess(user);
-
-                return false;
-            }
-        }
-        this.denyAccess(user);
-        return false;
-    }
-
-    public denyAccess(user: WebUser) {
-        if (user != undefined && user.getIsGuest()) {
-            user.loginRequired();
-        } else throw new ForbiddenHttpException(BaseChyz.t('You are not allowed to perform this action.'));
-    }
-
-}

package/filters/AccessRule.ts

@@ -1,137 +0,0 @@
-/*
- * Copyright (c) 2021. Chy Bilgisayar Bilisim
- * Author: Cihan Ozturk
- * E-mail: cihan@chy.com.tr
- * Github:https://github.com/cihan53/
- */
-import {WebUser} from "../web/WebUser";
-
-var _ = require('lodash');
-import {Component} from "../base/Component";
-import {InvalidConfigException} from "../base/InvalidConfigException";
-import {Request, Response} from "express";
-
-export class AccessRule extends Component {
-
-    /**
-     * @var bool whether this is an 'allow' rule or 'deny' rule.
-     */
-    public allow:any;
-    /**
-     * @var array list of action IDs that this rule applies to. The comparison is case-sensitive.
-     * If not set or empty, it means this rule applies to all actions.
-     */
-    public actions:any;
-
-    /**
-     *  @var array list of the controller IDs that this rule applies to.
-     */
-    public controllers:any;
-
-    /**
-     * - `?`: matches a guest user (not authenticated yet)
-     * - `@`: matches an authenticated user
-     */
-
-    public roles:any;
-
-    /**
-     * @var array list of RBAC (Role-Based Access Control) permissions that this rules applies to.
-     */
-    public permissions:any;
-
-    /**
-     * @var array list of user IP addresses that this rule applies to. An IP address
-     * can contain the wildcard `*` at the end so that it matches IP addresses with the same prefix.
-     * For example, '192.168.*' matches all IP addresses in the segment '192.168.'.
-     * It may also contain a pattern/mask like '172.16.0.0/12' which would match all IPs from the
-     * 20-bit private network block in RFC1918.
-     * If not set or empty, it means this rule applies to all IP addresses.
-     */
-    public ips:any;
-
-
-    public allows(action:any, user:WebUser, request:Request) {
-        if (
-            this.matchAction(action)
-            && this.matchRole(user)
-        ) {
-            return this.allow
-        }
-        //     if (this.matchAction($action)
-        //         && this.matchRole($user)
-        // && this.matchIP($request->getUserIP())
-        // && this.matchVerb($request->getMethod())
-        // && this.matchController($action->controller)
-        // && this.matchCustom($action)
-        // ) {
-        //     return $this->allow ? true : false;
-        // }
-
-        return null;
-    }
-
-    /**
-     * @param Action $action the action
-     * @return bool whether the rule applies to the action
-     */
-    protected matchAction(action:any) {
-        return _.isEmpty(this.actions) || this.actions.includes(action.id);
-    }
-
-    /**
-     * @param Controller $controller the controller
-     * @return bool whether the rule applies to the controller
-     */
-    protected matchController(controller:any) {
-        //     if (empty($this->controllers)) {
-        //         return true;
-        //     }
-        //
-        //     $id = $controller->getUniqueId();
-        //     foreach ($this->controllers as $pattern) {
-        //     if (StringHelper::matchWildcard($pattern, $id)) {
-        //         return true;
-        //     }
-        // }
-
-        return false;
-    }
-
-    protected matchRole(user:any) {
-        let items = _.isEmpty(this.roles) ? [] : this.roles;
-
-        if (!_.isEmpty(this.permissions)) {
-            items = _.merge(items, this.permissions);
-        }
-
-        if (_.isEmpty(items)) {
-            return true;
-        }
-
-
-        if (user === false) {
-            throw new InvalidConfigException('The user application component must be available to specify roles in AccessRule.');
-        }
-
-        for (const itemsKey in items) {
-            let item = items[itemsKey];
-            if (item === '?') {
-                if (user.getIsGuest()) {
-                    return true;
-                }
-            } else if (item === '@') {
-                if (!user.getIsGuest()) {
-                    return true;
-                }
-            } else {
-                //roleparams
-            }
-        }
-
-
-        return false;
-    }
-
-
-}

package/filters/auth/AuthInterface.ts

@@ -1,34 +0,0 @@
-/*
- * Copyright (c) 2021. Chy Bilgisayar Bilisim
- * Author: Cihan Ozturk
- * E-mail: cihan@chy.com.tr
- * Github:https://github.com/cihan53/
- */
-import {Request, Response} from "express";
-
-export interface AuthInterface{
-    /**
-     * Authenticates the current user.
-     * @param User $user
-     * @param Request $request
-     * @param Response $response
-     * @return IdentityInterface the authenticated user identity. If authentication information is not provided, null will be returned.
-     * @throws UnauthorizedHttpException if authentication information is provided but is invalid.
-     */
-     authenticate(user:any, request:Request, response:Response):any;
-
-    /**
-     * Generates challenges upon authentication failure.
-     * For example, some appropriate HTTP headers may be generated.
-     * @param Response $response
-     */
-     challenge(response:Response):Response;
-
-    /**
-     * Handles authentication failure.
-     * The implementation should normally throw UnauthorizedHttpException to indicate authentication failure.
-     * @param Response $response
-     * @throws UnauthorizedHttpException
-     */
-     handleFailure(response:Response):Response;
-}

package/filters/auth/AuthMethod.ts

@@ -1,88 +0,0 @@
-/*
- * Copyright (c) 2021. Chy Bilgisayar Bilisim
- * Author: Cihan Ozturk
- * E-mail: cihan@chy.com.tr
- * Github:https://github.com/cihan53/
- */
-
-import {ActionFilter} from "../../base/ActionFilter";
-import {AuthInterface} from "./AuthInterface";
-import {UnauthorizedHttpException} from "../../base/UnauthorizedHttpException";
-import {WebUser} from "../../web/WebUser";
-import {Request, Response} from "express";
-
-export abstract class AuthMethod extends ActionFilter implements AuthInterface {
-
-    /**
-     * @var User the user object representing the user authentication status. If not set, the `user` application component will be used.
-     */
-    public user: WebUser | undefined;
-
-    /**
-     * @var Request the current request. If not set, the `request` application component will be used.
-     */
-    public request: Request | undefined;
-
-    /**
-     * @var Response the response to be sent. If not set, the `response` application component will be used.
-     */
-    public response: Response | undefined;
-
-
-    public optional = [];
-
-    public async beforeAction(action: any, request: Request, response: Response) {
-        let identity = await this.authenticate(
-            this.user ?? new WebUser(),
-            request,
-            response
-        )
-
-
-        // @ts-ignore
-        request.identity = identity;
-
-        if (identity !== null) {
-            return true;
-        }
-
-        this.challenge(response);
-        this.handleFailure(response);
-        return false;
-    }
-
-    authenticate(user: WebUser, request: Request, response: Response) {
-
-    }
-
-    // @ts-ignore
-    challenge(response: Response): void {
-    }
-
-    // @ts-ignore
-    handleFailure(response: Response) {
-        throw new UnauthorizedHttpException('Your request was made with invalid credentials.');
-    }
-
-    getHeaderByKey(headers: any, findKey: any) {
-        let key = Object.keys(headers).find(key => key.toLowerCase() === findKey.toLowerCase())
-        if (key) {
-            return headers[key];
-        }
-
-        return null
-    }
-
-    patternCheck(headerText:any, pattern:RegExp) {
-        if (pattern) {
-            let matches = headerText.match(pattern)
-            if (matches && matches.length > 0) {
-                return matches;
-            } else {
-                return null
-            }
-        }
-
-        return null
-    }
-}