diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..261e4de --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1 @@ +Merge `from_banch` into `to_branch` (`from_type` into `to_type` branch) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..070792a --- /dev/null +++ b/.gitignore @@ -0,0 +1,15 @@ +# packages / package files +node_modules +yarn.lock +package-lock.json +pnpm-lock.yaml + +# log files +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# build files +dist diff --git a/CODES.txt b/CODES.txt new file mode 100644 index 0000000..61033b8 --- /dev/null +++ b/CODES.txt @@ -0,0 +1,52 @@ +AUTH STATUS CODES + +CODE -> INTERCEPT -> HTTP -> DESCRIPTION +0 -> 0 -> ANY -> AUTH OK +1 -> 0 -> 400 -> ACCESSTOKEN MISSING +2 -> 0 -> 403 -> THE ACCESSTOKEN IS INVALID +5 -> 0 -> 500 -> SERVER ERROR + +10 -> 0 -> 201 -> REGISTER SUCCESSFULL +11 -> 0 -> 403 -> REGISTER ROUTE DISABLED +12 -> 0 -> 400 -> EMAIL, USERNAME OR PASSWORD MISSING +13 -> 0 -> 406 -> THE EMAIL IS MALFORMATED +14 -> 0 -> 406 -> THE PASSWORD IS TO WEAK +15 -> 0 -> 403 -> THE EMAIL IS ALREDY USED (in unsensitive mode) +16 -> 0 -> 403 -> THE USERNAME IS ALREDY USED (in unsensitive mode) +17 -> 0 -> 403 -> THE LOGIN IS ALREDY USED (in sensitive mode) +... +19 -> CUSTOM -> 403 -> THE REQUEST TO REGISTER WAS INTERCEPTED + +20 -> 0 -> 201 -> LOGIN SUCCESSFULL +21 -> 0 -> 403 -> LOGIN ROUTE DISABLED +22 -> 0 -> 400 -> LOGIN OR PASSWORD MISSING +23 -> 0 -> 404 -> USER WAS NOT FOUND (in unsensitive mode) +24 -> 0 -> 403 -> PASSWORD IS INCORRECT (in unsensitive mode) +25 -> 0 -> 403 -> USER WAS NOT FOUND OR PASSWORD IS INCORRECT (in sensitive mode) +... +29 -> CUSTOM -> 403 -> THE REQUEST TO LOGIN WAS INTERCEPTED + +30 -> 0 -> 200 -> LOGOUT SUCCESSFULL +31 -> 0 -> 403 -> LOGOUT ROUTE DISABLED +32 -> 0 -> 400 -> REFRESHTOKEN MISSING +33 -> 0 -> 403 -> THE REFRESHTOKEN IS INVALID +34 -> 0 -> 404 -> THE REFRESHTOKEN DOES NOT EXIST +... +39 -> CUSTOM -> 403 -> THE REQUEST TO LOGOUT WAS INTERCEPTED + +40 -> 0 -> 201 -> REFRESH SUCCESSFULL +41 -> 0 -> 403 -> REFRESH ROUTE DISABLED +42 -> 0 -> 400 -> REFRESHTOKEN MISSING +43 -> 0 -> 403 -> THE REFRESHTOKEN IS INVALID +44 -> 0 -> 404 -> THE REFRESHTOKEN DOES NOT EXIST +... +49 -> CUSTOM -> 403 -> THE REQUEST TO REFRESH WAS INTERCEPTED + +50 -> 0 -> 200 -> CHECK SUCCESSFULL +51 -> 0 -> 403 -> CHECK ROUTE DISABLED +52 -> 0 -> 400 -> ACCESSTOKEN OR REFRESHTOKEN MISSING +53 -> 0 -> 403 -> THE REFRESHTOKEN IS INVALID +54 -> 0 -> 404 -> THE REFRESHTOKEN DOES NOT EXIST +55 -> 0 -> 403 -> THE ACCESSTOKEN IS INVALID +... +59 -> CUSTOM -> 403 -> THE REQUEST TO CHECK WAS INTERCEPTED diff --git a/packages/template/LICENSE b/packages/template/LICENSE new file mode 100644 index 0000000..6868a4d --- /dev/null +++ b/packages/template/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 @auth-tools + +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. diff --git a/packages/template/local/index.ts b/packages/template/local/index.ts new file mode 100644 index 0000000..e69de29 diff --git a/packages/template/package.json b/packages/template/package.json new file mode 100644 index 0000000..37a86c8 --- /dev/null +++ b/packages/template/package.json @@ -0,0 +1,28 @@ +{ + "name": "@auth-tools/template", + "version": "0.0.0", + "description": "A structured authentication protocol for Javascript. (template)", + "main": "dist/index.js", + "repository": "https://github.com/auth-tools/auth-tools", + "author": "Laurenz Rausche ", + "license": "MIT", + "private": false, + "scripts": { + "build": "npm run build:remove && tsc", + "build:remove": "rimraf build", + "local": "npm run build && ts-node-dev --respawn local/index.ts", + "prepublish": "npm run build", + "remove": "npm run build:remove && rimraf node_modules yarn.lock package-lock.json pnpm-lock.yaml" + }, + "dependencies": {}, + "devDependencies": { + "@auth-tools/template": "link:.", + "rimraf": "^5.0.5", + "ts-node-dev": "^2.0.0", + "typescript": "^5.4.5" + }, + "peerDependencies": {}, + "files": [ + "dist" + ] +} diff --git a/packages/template/src/index.ts b/packages/template/src/index.ts new file mode 100644 index 0000000..e69de29 diff --git a/packages/template/tsconfig.json b/packages/template/tsconfig.json new file mode 100644 index 0000000..ce1e038 --- /dev/null +++ b/packages/template/tsconfig.json @@ -0,0 +1,19 @@ +{ + "compilerOptions": { + "target": "ES2016", + "lib": ["ES2016"], + "module": "CommonJS", + "moduleResolution": "Node", + "declaration": true, + "declarationMap": true, + "sourceMap": true, + "outDir": "dist", + "esModuleInterop": true, + "forceConsistentCasingInFileNames": true, + "strict": true, + "noUnusedLocals": true, + "noUnusedParameters": true, + "skipLibCheck": true + }, + "include": ["src/**/*"] +}