koatty_validation 1.0.10 → 1.2.0

package/.vscode/launch.json

@@ -0,0 +1,81 @@
+{
+  "configurations": [
+    {
+      "name": "Launch Koatty Project",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${workspaceRoot}/src/App.ts"
+      ],
+      "runtimeArgs": [
+        "--nolazy",
+        "-r",
+        "ts-node/register"
+      ],
+      "envFile": "/Users/richen/Workspace/.env",
+      "sourceMaps": true,
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "neverOpen"
+    },
+    {
+      "name": "Launch GoPackage",
+      "type": "go",
+      "request": "launch",
+      "mode": "auto",
+      "program": "${workspaceFolder}/main.go",
+      "envFile": "/Users/richen/Workspace/.env",
+      "args": []
+    },
+    {
+      "name": "Launch Java Project",
+      "type": "java",
+      "request": "launch",
+      "mainClass": "",
+      "envFile": "/Users/richen/Workspace/.env"
+    },
+    {
+      "name": "Launch Node.js Project",
+      "type": "node",
+      "request": "launch",
+      "mode": "auto",
+      "program": "${workspaceFolder}/app.js",
+      "envFile": "/Users/richen/Workspace/.env",
+      "args": []
+    },
+    {
+      "name": "Launch Typescript Project",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${workspaceRoot}/src/index.ts"
+      ],
+      "runtimeArgs": [
+        "--nolazy",
+        "-r",
+        "ts-node/register"
+      ],
+      "envFile": "/Users/richen/Workspace/.env",
+      "sourceMaps": true,
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "neverOpen"
+    },
+    {
+      "type": "node",
+      "name": "vscode-jest-tests",
+      "request": "launch",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "disableOptimisticBPs": true,
+      "program": "${workspaceFolder}/node_modules/.bin/jest",
+      "cwd": "${workspaceFolder}",
+      "args": [
+        "--config",
+        "jest.config.js",
+        "--runInBand",
+        "--watchAll=false"
+      ]
+    }
+  ]
+}

package/CHANGELOG.md

@@ -2,8 +2,8 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-### [1.0.10](https://github.com/koatty/koatty_validation/compare/v1.0.8...v1.0.10) (2021-11-25)
+## [1.2.0](https://github.com/koatty/koatty_validation/compare/v1.1.0...v1.2.0) (2022-02-25)
 
-### [1.0.8](https://github.com/koatty/koatty_validation/compare/v1.0.6...v1.0.8) (2021-11-23)
+## [1.1.0](https://github.com/koatty/koatty_validation/compare/v1.0.12...v1.1.0) (2022-02-16)
 
-### [1.0.6](https://github.com/koatty/koatty_validation/compare/v1.0.4...v1.0.6) (2021-11-20)
+## [2.0.0](https://github.com/koatty/koatty_validation/compare/v1.0.12...v2.0.0) (2022-02-16)

package/README.md

@@ -1,5 +1,5 @@
 # koatty_validation
-Validation Util for Koatty and ThinkORM. Based on class-validator, extended parameter type checking and restricted attribute functions.
+Validation Util for Koatty. Based on class-validator, extended parameter type checking and restricted attribute functions.
 
 
 # User Decorators
@@ -22,11 +22,11 @@ Validation Util for Koatty and ThinkORM. Based on class-validator, extended para
 * @IsIn
 * @IsNotIn
 * @IsDate
-* @Min
-* @Max
-* @Length
+* @Gt
+* @Gte
+* @Lt
+* @Lte
   
-
 * @Valid
 * @Validated
 
@@ -60,35 +60,41 @@ export class UserDTO {
 
 ## FunctionValidator
 
-* FunctionValidator.IsCnName
-* FunctionValidator.IsIdNumber
-* FunctionValidator.IsZipCode
-* FunctionValidator.IsMobile
-* FunctionValidator.IsPlateNumber
-* FunctionValidator.IsEmail
-* FunctionValidator.IsIP
-* FunctionValidator.IsPhoneNumber
-* FunctionValidator.IsUrl
-* FunctionValidator.IsHash
-* FunctionValidator.IsNotEmpty
-* FunctionValidator.Equals
-* FunctionValidator.NotEquals
-* FunctionValidator.Contains
-* FunctionValidator.IsIn
-* FunctionValidator.IsNotIn
-* FunctionValidator.IsDate
-* FunctionValidator.Min
-* FunctionValidator.Max
-* FunctionValidator.Length
+* IsCnName
+* IsIdNumber
+* IsZipCode
+* IsMobile
+* IsPlateNumber
+* IsEmail
+* IsIP
+* IsPhoneNumber
+* IsUrl
+* IsHash
+* IsNotEmpty
+* Equals
+* NotEquals
+* Contains
+* IsIn
+* IsNotIn
+* IsDate
+* Gt
+* Gte
+* Lt
+* Lte
+
+exp:
 
 ```js
-if (!FunctionValidator.IsNotEmpty(data)) {
-    console.log('error');
-}
+const str = "";
+// throw Error
+FunctionValidator.IsNotEmpty(str, "cannot be empty");
+FunctionValidator.Contains(str, {message: "must contain s", value: "s"});
 ```
 
 ## ClassValidator
 
+exp:
+
 ```js
 class SchemaClass {
     @IsDefined

package/dist/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2020, Koatty
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/dist/README.md

@@ -0,0 +1,112 @@
+# koatty_validation
+Validation Util for Koatty. Based on class-validator, extended parameter type checking and restricted attribute functions.
+
+
+# User Decorators
+
+* @IsDefined
+* @IsCnName
+* @IsIdNumber
+* @IsZipCode
+* @IsMobile
+* @IsPlateNumber
+* @IsEmail
+* @IsIP
+* @IsPhoneNumber
+* @IsUrl
+* @IsHash
+* @IsNotEmpty
+* @Equals
+* @NotEquals
+* @Contains
+* @IsIn
+* @IsNotIn
+* @IsDate
+* @Gt
+* @Gte
+* @Lt
+* @Lte
+  
+* @Valid
+* @Validated
+
+
+
+```js
+
+export class Controller {
+
+    Test(@Valid("IsNotEmpty", "can not be empty!!") id: number){
+        //todo
+    }
+
+    @Validated() // use dto validation
+    TestDto(user: UserDTO) {
+
+    }
+}
+
+export class UserDTO {
+    @IsNotEmpty({ message: "can not be empty!!" })
+    phoneNum: string;
+
+    @IsCnName({ message: "must be cn name"})
+    userName: string;
+}
+
+```
+
+# Validator for manual
+
+## FunctionValidator
+
+* IsCnName
+* IsIdNumber
+* IsZipCode
+* IsMobile
+* IsPlateNumber
+* IsEmail
+* IsIP
+* IsPhoneNumber
+* IsUrl
+* IsHash
+* IsNotEmpty
+* Equals
+* NotEquals
+* Contains
+* IsIn
+* IsNotIn
+* IsDate
+* Gt
+* Gte
+* Lt
+* Lte
+
+exp:
+
+```js
+const str = "";
+// throw Error
+FunctionValidator.IsNotEmpty(str, "cannot be empty");
+FunctionValidator.Contains(str, {message: "must contain s", value: "s"});
+```
+
+## ClassValidator
+
+exp:
+
+```js
+class SchemaClass {
+    @IsDefined
+    id: number;
+    
+    @IsNotEmpty
+    name: string;
+}
+
+
+ClassValidator.valid(SchemaClass, {name: ''}).catch(err => {
+    console.log(err);
+})
+```
+