webledger-auth-plugin 1.0.8

package/LICENSE.md

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright 2022 Chimezie Enyinnaya, contributors
+
+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.

package/README.md

@@ -0,0 +1,14 @@
+# webledger-auth-plugin
+AdonisJS-v5 Package
+
+### Install
+```
+npm i webledger-auth-plugin
+```
+
+### Configure
+```
+node ace configure webledger-auth-plugin
+```
+
+[**Instructions**](./instructions.md)

package/build/adonis-typings/AuthService.d.ts

@@ -0,0 +1,26 @@
+declare module '@ioc:AuthService' {
+    export interface AuthServiceI {
+        login(email: string, password: string): any;
+        signup(params: any): any;
+        getUser(uuid: string): any;
+        updateUser(uuid: string, params: any): any;
+        forgotPassword(email: string): any;
+        resendEmailVerification(email: string): any;
+        verifyPin(uuid: string, user_pin: string): any;
+        forgotPin(uuid: string, password: string, user_pin: string): any;
+    }
+    const authService: AuthServiceI;
+    export default authService;
+    export interface AuthServiceConfig {
+        host: string;
+        env: string;
+        type: string;
+        iss: string;
+        secret: string;
+        expiry?: string;
+        timeout?: number;
+        paths?: {
+            [x: string]: string;
+        };
+    }
+}

package/build/adonis-typings/index.d.ts

@@ -0,0 +1 @@
+/// <reference path="AuthService.d.ts" />

package/build/adonis-typings/index.js

@@ -0,0 +1 @@
+/// <reference path="./AuthService.ts" />

package/build/instructions.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+function getStub(...relativePaths) {
+    return (0, path_1.join)(__dirname, 'templates', ...relativePaths);
+}
+function makeConfigFile(projectRoot, sink) {
+    const appProviderPath = (0, path_1.join)('config', 'authService.ts');
+    const template = new sink.files.MustacheFile(projectRoot, appProviderPath, getStub('config/AuthService.txt'));
+    template.overwrite = true;
+    template.commit();
+    sink.logger.action('create').succeeded(appProviderPath);
+}
+async function instructions(projectRoot, _, sink) {
+    makeConfigFile(projectRoot, sink);
+}
+exports.default = instructions;

package/build/instructions.md

@@ -0,0 +1,8 @@
+Congratulations! You have configured `AuthService` package successfully. Make sure to add the following values inside `env.ts` file:
+
+```ts
+AUTH_HOST: Env.schema.string({ format: 'host' }),
+AUTH_ENV: Env.schema.string(),
+AUTH_PRODUCT_TYPE: Env.schema.string(),
+AUTH_JWT_TOKEN: Env.schema.string(),
+```

package/build/providers/AuthServiceProvider.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="@adonisjs/application/build/adonis-typings" />
+import { ApplicationContract } from '@ioc:Adonis/Core/Application';
+export default class AuthServiceProvider {
+    protected app: ApplicationContract;
+    static needsApplication: boolean;
+    constructor(app: ApplicationContract);
+    register(): void;
+}

package/build/providers/AuthServiceProvider.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const AuthService_1 = __importDefault(require("../src/AuthService"));
+class AuthServiceProvider {
+    constructor(app) {
+        this.app = app;
+    }
+    register() {
+        this.app.container.singleton('AuthService', () => {
+            const config = this.app.container.use('Adonis/Core/Config');
+            return new AuthService_1.default(config.get('authService'));
+        });
+    }
+}
+exports.default = AuthServiceProvider;
+AuthServiceProvider.needsApplication = true;

package/build/src/AuthService.d.ts

@@ -0,0 +1,16 @@
+import { AuthServiceConfig, AuthServiceI } from '@ioc:AuthService';
+export default class AuthService implements AuthServiceI {
+    private config;
+    private client;
+    private paths;
+    constructor(config: AuthServiceConfig);
+    private setAuthToken;
+    login(email: string, password: string): Promise<import("axios").AxiosResponse<any, any>>;
+    signup(params: any): Promise<import("axios").AxiosResponse<any, any>>;
+    getUser(uuid: string): Promise<import("axios").AxiosResponse<any, any>>;
+    updateUser(uuid: string, params: any): Promise<import("axios").AxiosResponse<any, any>>;
+    forgotPassword(email: string): Promise<import("axios").AxiosResponse<any, any>>;
+    resendEmailVerification(email: string): Promise<import("axios").AxiosResponse<any, any>>;
+    verifyPin(uuid: string, user_pin: string): Promise<import("axios").AxiosResponse<any, any>>;
+    forgotPin(uuid: string, password: string, user_pin: string): Promise<import("axios").AxiosResponse<any, any>>;
+}

package/build/src/AuthService.js

@@ -0,0 +1,81 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const jsonwebtoken_1 = require("jsonwebtoken");
+class AuthService {
+    constructor(config) {
+        this.config = config;
+        this.paths = {
+            login: '/api/login',
+            signup: '/api/signup',
+            get_user: '/api/users',
+            update_user: '/api/users',
+            forgot_password: '/api/forgot_password',
+            resend_email_verification: '/api/resend_verify_email',
+            verify_pin: '/api/users',
+            forgot_pin: '/api/users',
+        };
+        this.client = axios_1.default.create({ baseURL: config.host });
+        this.client.defaults.timeout = config.timeout || 30000; // default is 30seconds
+        const headers = {
+            'Content-Type': 'application/json',
+            'x-auth-env': config.env,
+            'x-product-type': config.type,
+        };
+        for (const key in headers) {
+            this.client.defaults.headers.common[key] = headers[key];
+        }
+        this.paths = { ...this.paths, ...config.paths };
+    }
+    setAuthToken(sub) {
+        const payload = { env: this.config.env, type: this.config.type, iss: this.config.iss, sub };
+        const jwtAuthToken = (0, jsonwebtoken_1.sign)(payload, this.config.secret, {
+            expiresIn: this.config.expiry || '1m',
+        });
+        this.client.defaults.headers.common['Authorization'] = `Bearer ${jwtAuthToken}`;
+    }
+    login(email, password) {
+        const subject = 'login';
+        this.setAuthToken(subject);
+        return this.client.post(this.paths[subject], { email, password });
+    }
+    signup(params) {
+        const subject = 'signup';
+        this.setAuthToken(subject);
+        return this.client.post(this.paths[subject], params);
+    }
+    getUser(uuid) {
+        const subject = 'get_user';
+        this.setAuthToken(subject);
+        return this.client.get(`${this.paths[subject]}/${uuid}`);
+    }
+    updateUser(uuid, params) {
+        const subject = 'update_user';
+        this.setAuthToken(subject);
+        return this.client.put(`${this.paths[subject]}/${uuid}`, params);
+    }
+    forgotPassword(email) {
+        const subject = 'forgot_password';
+        this.setAuthToken(subject);
+        return this.client.post(this.paths[subject], { email });
+    }
+    resendEmailVerification(email) {
+        const subject = 'resend_email_verification';
+        this.setAuthToken(subject);
+        return this.client.post(this.paths[subject], { email });
+    }
+    verifyPin(uuid, user_pin) {
+        const subject = 'verify_pin';
+        this.setAuthToken(subject);
+        return this.client.post(`${this.paths[subject]}/${uuid}/verify_pin`, { user_pin });
+    }
+    forgotPin(uuid, password, user_pin) {
+        const subject = 'forgot_pin';
+        this.setAuthToken(subject);
+        return this.client.post(`${this.paths[subject]}/${uuid}/forgot_pin`, { password, user_pin });
+    }
+}
+exports.default = AuthService;

package/build/templates/config/AuthService.txt

@@ -0,0 +1,12 @@
+import { AuthServiceConfig } from '@ioc:AuthService'
+import Env from '@ioc:Adonis/Core/Env'
+
+const authServiceConfig: AuthServiceConfig = {
+  host: Env.get('AUTH_HOST'),
+  env: Env.get('AUTH_ENV'),
+  type: Env.get('AUTH_PRODUCT_TYPE'),
+  iss: Env.get('BASE_URL'),
+  secret: Env.get('AUTH_JWT_TOKEN'),
+}
+
+export default authServiceConfig

package/package.json

@@ -0,0 +1,138 @@
+{
+  "name": "webledger-auth-plugin",
+  "version": "1.0.8",
+  "description": "webledger auth service AdonisJS 5 login plugin",
+  "main": "build/providers/AuthServiceProvider.js",
+  "scripts": {
+    "mrm": "mrm --preset=@adonisjs/mrm-preset",
+    "pretest": "npm run lint",
+    "clean": "del-cli build",
+    "copyfiles": "copyfiles \"templates/**/*.txt\" \"instructions.md\" build",
+    "compile": "npm run lint && npm run clean && tsc && npm run copyfiles",
+    "build": "npm run compile",
+    "prepublishOnly": "npm run build",
+    "lint": "eslint . --ext=.ts",
+    "format": "prettier --write .",
+    "commit": "git-cz",
+    "release": "np --message=\"chore(release): %s\"",
+    "version": "npm run build",
+    "sync-labels": "github-label-sync --labels ./node_modules/@adonisjs/mrm-preset/gh-labels.json divamtech/webledger-auth-plugin"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/divamtech/webledger-auth-plugin.git"
+  },
+  "homepage": "https://github.com/divamtech/webledger-auth-plugin#readme",
+  "keywords": [
+    "adonisjs",
+    "adonis"
+  ],
+  "author": "Gaurav D. Sharma",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/divamtech/webledger-auth-plugin/issues"
+  },
+  "devDependencies": {
+    "@adonisjs/core": "^5.7.6",
+    "@adonisjs/mrm-preset": "^5.0.3",
+    "@adonisjs/require-ts": "^2.0.12",
+    "@adonisjs/sink": "^5.4.0",
+    "@types/node": "^18.0.3",
+    "commitizen": "^4.2.4",
+    "copyfiles": "^2.4.1",
+    "cz-conventional-changelog": "^3.3.0",
+    "del-cli": "^4.0.1",
+    "eslint": "^8.19.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-adonis": "^2.1.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "github-label-sync": "^2.2.0",
+    "husky": "^8.0.1",
+    "mrm": "^4.0.0",
+    "np": "^7.6.2",
+    "prettier": "^2.7.1",
+    "typescript": "^4.7.4"
+  },
+  "peerDependencies": {
+    "@adonisjs/core": "^5.7.6"
+  },
+  "mrmConfig": {
+    "core": false,
+    "license": "MIT",
+    "services": [],
+    "minNodeVersion": "16.13.1",
+    "probotApps": []
+  },
+  "types": "build/adonis-typings/index.d.ts",
+  "files": [
+    "build/adonis-typings",
+    "build/src",
+    "build/providers",
+    "build/templates",
+    "build/instructions.js",
+    "build/instructions.md"
+  ],
+  "eslintConfig": {
+    "extends": [
+      "plugin:adonis/typescriptPackage",
+      "prettier"
+    ],
+    "plugins": [
+      "prettier"
+    ],
+    "rules": {
+      "prettier/prettier": [
+        "error",
+        {
+          "endOfLine": "auto"
+        }
+      ]
+    }
+  },
+  "eslintIgnore": [
+    "build"
+  ],
+  "prettier": {
+    "trailingComma": "es5",
+    "semi": false,
+    "singleQuote": true,
+    "useTabs": false,
+    "quoteProps": "consistent",
+    "bracketSpacing": true,
+    "arrowParens": "always",
+    "printWidth": 100
+  },
+  "config": {
+    "commitizen": {
+      "path": "cz-conventional-changelog"
+    }
+  },
+  "np": {
+    "contents": ".",
+    "anyBranch": false
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "adonisjs": {
+    "instructions": "./build/instructions.js",
+    "instructionsMd": "./build/instructions.md",
+    "providers": [
+      "webledger-auth-plugin"
+    ],
+    "types": "webledger-auth-plugin",
+    "templates": {
+      "basePath": "./build/templates",
+      "config": [
+        {
+          "src": "config/AuthService.txt",
+          "dest": "authService"
+        }
+      ]
+    }
+  },
+  "dependencies": {
+    "axios": "^1.7.5",
+    "jsonwebtoken": "^9.0.2"
+  }
+}