Merge branch 'master' of https://github.com/sugoiJS/Core

Author: o-b-one

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 sugoiJS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,149 @@
+# @Sugoi\core
+
+![Sugoi logo](https://www.sugoijs.com/assets/logo_inverse.png)
+
+
+## Introduction
+SugoiJS is a minimal modular framework,
+
+which gives you the ability to use only what you need, fast.
+
+this is a standalone module that can be functional separately (as all of the SugoiJS modules).
+
+## Installation
+
+> npm install --save @sugoi/core
+
+
+## Policies (Guards)
+
+SugoiJS provides policy which can be use for guarding any function on the server.
+
+The Policies use by two simple steps:
+
+#### @Policy(policyId?:string)
+
+This decorator register the function as policy validator.
+
+This decorated function will be later can be use for guard our functions.
+
+> policyId?: string - The id which will be use as an alias for calling this function, default is ${class name}.${function name}
+
+#### @UsePolicy(policy: TPolicy|string, failedResponseCode: number = 400, ...policyMeta: any[])
+
+This decorator declare the function guarded by policy.
+
+> policy:TPolicy| string  - For set the ref policy, use the policy Id from previous section nor anonymous function reference.
+
+> failedResponseCode: number - The code which will be under the exception in case the value does not meet the criterias.
+
+> policyMeta: any[] - Any further payload data which should pass to the policy.
+
+### Pre-defined policies:
+
+@sugoi\core provide pre-defined policy for validating function arguments:
+
+    ValidateSchemaPolicy(failedResponseCode: number = 400, ...policyMeta: TValidateSchemaMeta[])
+
+> failedResponseCode: number  - The code which will be under the exception in case the value does not meet the criterias.
+
+> policyMeta: TValidateSchemaMeta - Meta data for validation
+
+    {
+        schema: {[prop:string]:ComparableSchema|ComparableSchema}, - Comperable schema
+        argIndex?: number, - Function argument index - default is 0
+        keyInArg?: string  - Key in argument
+    }
+
+Example:
+Schema -
+
+    {
+        role:{
+            text:string//with regex  /([A-Z])+/i
+        }
+    }
+
+Usage -
+
+    @ValidateSchemaPolicy(400, {
+            schema: {
+                "role": ComparableSchema.ofType(
+                    {text: ComparableSchema.ofType(SchemaTypes.STRING).setRegex("([A-Z])+", "i")}
+                )
+            },
+            argIndex: 0
+        })
+
+
+### Build your own policies:
+
+Policy can be any function of type TPolicy
+
+>   TPolicy = (policyData?:{functionArgs: any[], policyMeta: any[]})=>(Promise < (true|any) > | (true|any))
+
+When result is boolean `true` means the data is valid, all the other values will be shown on the exception
+
+### Policy full example:
+
+    class Validators{
+
+        @Policy() //register this function as policy using the class name and function name, same as use @Policy("Validators.myNumberValidation")
+        static myNumberValidation(policyData:{functionArgs: any[], policyMeta: {argIndexToValidate:number,maxValue:number}[]}): true|any{
+            const myMeta = policyMeta[0];
+            //those are the meta data values which passed to the decorator itself while using @UsePolicy()
+            const argIndexToValidate = myMeta.argIndexToValidate;
+            const maxValue = myMeta.maxValue;
+
+            if(policyData.functionArgs[argIndexToValidate] < maxValue){
+                return true; //Is valid, continue to the function/next policy
+            }else{
+                return policyData.functionArgs[argToValidate]; //so we will be able to identify the issue on the exception
+            }
+        }
+    }
+
+    @UsePolicy("Validators.myNumberValidation",{argIndexToValidate:0,maxValue:5})
+    lowerThan5NumberLogger(myNumber){
+        console.log(`number is lower the 5! ${myNumber}`);
+    }
+
+## Container
+
+SugoiJS re-exports [Inversify container class](https://github.com/inversify/InversifyJS/blob/master/wiki/container_api.md)
+for support singleton injectable (autowire) services.
+
+By using Containers you can achieve singleton services solutions for request\application liftime.
+
+
+## Exceptions
+
+SugoiJS provides base abstract exception(error) class which can be extended and used for exceptions handling
+
+    SugoiError:{
+        code:number;
+        message:string;
+        data:Array<any>;
+    }
+
+Feel free to extend this class to identify your own error by:
+
+    switch(err.constructor.name){
+        case "MySugoiError":
+            //handled error
+            break;
+        default:
+            throw err;
+    }
+
+Or by:
+
+    if( err instanceof MySugoiError){
+        //handled error
+    }else{
+        throw err;
+    }
+
+## Documentation
+
+You can find further information on [Sugoi official website](http://www.sugoijs.com)

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-minimal