@mattygt86/daturetech-auth-library 0.0.0-alpha

package/.eslintrc.json

@@ -0,0 +1,34 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+        "semi": [
+            "error",
+            "always"
+        ],
+        "quotes": [
+            "error",
+            "double"
+        ],
+        "@typescript-eslint/no-explicit-any": "warn",
+        "indent": [
+            "error",
+            2
+        ],
+        "no-unused-vars": "warn"
+    }
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 MattyGT
+
+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,132 @@
+```md
+# DatureTech Authentication Library
+
+The **DatureTech Authentication Library** provides an easy-to-use authentication solution for Express.js applications. It integrates with **Auth0** and provides middleware for handling authentication and authorization.
+
+---
+
+## **Features**
+- 🚀 Simple middleware integration for authentication.
+- 🔐 Secure token verification using **Auth0**.
+- ✅ Role-based authorization support.
+- 📦 Lightweight and easy to install.
+
+---
+
+## **Installation**
+You can install the library via **npm**:
+
+```sh
+npm install daturetech-auth-library
+```
+
+If using a local package reference:
+
+```sh
+npm install file:../daturetech-auth-library/dist
+```
+
+---
+
+## **Usage**
+
+### **1. Import the Library**
+In your Express.js application, import and initialize the authentication middleware:
+
+```typescript
+import express from "express";
+import { AuthMiddleware } from "daturetech-auth-library";
+
+const app = express();
+
+// Initialize authentication middleware
+const authMiddleware = new AuthMiddleware({
+  domain: process.env.AUTH0_DOMAIN,
+  audience: process.env.AUTH0_AUDIENCE,
+});
+
+app.use(authMiddleware.protect()); // Apply authentication globally
+
+app.get("/protected-route", authMiddleware.protect(), (req, res) => {
+  res.json({ message: "You have accessed a protected route!" });
+});
+
+app.listen(5000, () => console.log("Server running on port 5000"));
+```
+
+---
+
+## **Configuration**
+Ensure you have the required environment variables set in your `.env` file:
+
+```sh
+AUTH0_DOMAIN=your-auth0-domain
+AUTH0_AUDIENCE=your-auth0-audience
+```
+
+---
+
+## **API Reference**
+
+### `authMiddleware.protect()`
+Middleware function that protects routes by verifying the user's JWT.
+
+```typescript
+app.use(authMiddleware.protect());
+```
+
+### `authMiddleware.checkRole(role: string)`
+Middleware function to restrict access based on user roles.
+
+```typescript
+app.get("/admin", authMiddleware.checkRole("admin"), (req, res) => {
+  res.json({ message: "Welcome, Admin!" });
+});
+```
+
+---
+
+## **Development & Contribution**
+1. Clone the repository:
+   ```sh
+   git clone https://github.com/MattyGT/daturetech-auth-library.git
+   ```
+2. Install dependencies:
+   ```sh
+   npm install
+   ```
+3. Build the library:
+   ```sh
+   npm run build
+   ```
+4. Run tests:
+   ```sh
+   npm test
+   ```
+
+---
+
+## **Publishing the Package**
+To publish updates to **npm**, follow these steps:
+
+1. Bump the version in `package.json`:
+   ```sh
+   npm version patch
+   ```
+2. Publish the package:
+   ```sh
+   npm publish --access public
+   ```
+
+---
+
+## **License**
+This project is licensed under the MIT License.
+
+---
+
+## **Support**
+For issues, please open a GitHub issue in the repository.
+```
+
+This provides a professional and comprehensive `README.md` that covers installation, usage, API references, and contribution guidelines. Let me know if you need any modifications! 🚀

package/dist/auth.abstract.d.ts

@@ -0,0 +1,6 @@
+export declare abstract class AuthProvider {
+    abstract login(email: string, password: string): Promise<void>;
+    abstract resetPassword(email: string): Promise<void>;
+    abstract logout(): Promise<void>;
+}
+//# sourceMappingURL=auth.abstract.d.ts.map

package/dist/auth.abstract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.abstract.d.ts","sourceRoot":"","sources":["../src/auth.abstract.ts"],"names":[],"mappings":"AAAA,8BAAsB,YAAY;IAC9B,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAC9D,QAAQ,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IACpD,QAAQ,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CACnC"}

package/dist/auth.abstract.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthProvider = void 0;
+class AuthProvider {
+}
+exports.AuthProvider = AuthProvider;

package/dist/auth.d.ts

@@ -0,0 +1,11 @@
+export declare class Auth {
+    private provider;
+    constructor(providerName: string, config: {
+        domain: string;
+        clientId: string;
+    });
+    login(email: string, password: string): Promise<void>;
+    resetPassword(email: string): Promise<void>;
+    logout(): Promise<void>;
+}
+//# sourceMappingURL=auth.d.ts.map

package/dist/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAIA,qBAAa,IAAI;IACf,OAAO,CAAC,QAAQ,CAAe;gBAEnB,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE;IAI9E,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAIrC,aAAa,CAAC,KAAK,EAAE,MAAM;IAI3B,MAAM;CAGP"}

package/dist/auth.factory.d.ts

@@ -0,0 +1,9 @@
+import { AuthProvider } from './auth.abstract';
+declare class AuthFactory {
+    static createProvider(providerName: string, config: {
+        domain: string;
+        clientId: string;
+    }): AuthProvider;
+}
+export default AuthFactory;
+//# sourceMappingURL=auth.factory.d.ts.map

package/dist/auth.factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.factory.d.ts","sourceRoot":"","sources":["../src/auth.factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAI/C,cAAM,WAAW;IACf,MAAM,CAAC,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,GAAG,YAAY;CAQxG;AAED,eAAe,WAAW,CAAC"}

package/dist/auth.factory.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const auth0_provider_1 = __importDefault(require("./providers/auth0.provider"));
+// Factory to instantiate the correct provider
+class AuthFactory {
+    static createProvider(providerName, config) {
+        switch (providerName.toLowerCase()) {
+            case 'auth0':
+                return new auth0_provider_1.default(config.domain, config.clientId);
+            default:
+                throw new Error(`Unsupported provider: ${providerName}`);
+        }
+    }
+}
+exports.default = AuthFactory;

package/dist/auth.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Auth = void 0;
+const auth_factory_1 = __importDefault(require("./auth.factory"));
+// Main Auth class
+class Auth {
+    constructor(providerName, config) {
+        this.provider = auth_factory_1.default.createProvider(providerName, config);
+    }
+    login(email, password) {
+        return this.provider.login(email, password);
+    }
+    resetPassword(email) {
+        return this.provider.resetPassword(email);
+    }
+    logout() {
+        return this.provider.logout();
+    }
+}
+exports.Auth = Auth;
+;

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { Auth } from "./auth";
+export default Auth;
+export { Auth0Provider } from "./providers/auth0.provider";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,eAAe,IAAI,CAAC;AACpB,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC"}

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Auth0Provider = void 0;
+const auth_1 = require("./auth");
+exports.default = auth_1.Auth; // Adjust path based on your file structure
+var auth0_provider_1 = require("./providers/auth0.provider"); // If you need direct provider access
+Object.defineProperty(exports, "Auth0Provider", { enumerable: true, get: function () { return auth0_provider_1.Auth0Provider; } });

package/dist/providers/auth0.provider.d.ts

@@ -0,0 +1,11 @@
+import { AuthProvider } from '../auth.abstract';
+export declare class Auth0Provider extends AuthProvider {
+    private domain;
+    private clientId;
+    constructor(domain: string, clientId: string);
+    login(email: string, password: string): Promise<void>;
+    resetPassword(email: string): Promise<void>;
+    logout(): Promise<void>;
+}
+export default Auth0Provider;
+//# sourceMappingURL=auth0.provider.d.ts.map

package/dist/providers/auth0.provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth0.provider.d.ts","sourceRoot":"","sources":["../../src/providers/auth0.provider.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEhD,qBAAa,aAAc,SAAQ,YAAY;IAC7C,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,QAAQ,CAAS;gBAEb,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAMtC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAerD,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAY3C,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAI9B;AAED,eAAe,aAAa,CAAC"}

package/dist/providers/auth0.provider.js

@@ -0,0 +1,61 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Auth0Provider = void 0;
+const axios_1 = __importDefault(require("axios"));
+const auth_abstract_1 = require("../auth.abstract");
+class Auth0Provider extends auth_abstract_1.AuthProvider {
+    constructor(domain, clientId) {
+        super();
+        this.domain = domain;
+        this.clientId = clientId;
+    }
+    login(email, password) {
+        return __awaiter(this, void 0, void 0, function* () {
+            console.log(`Logging in with Auth0: ${email}`);
+            const response = yield axios_1.default.post(`https://${this.domain}/oauth/token`, {
+                client_id: this.clientId,
+                grant_type: 'password',
+                username: email,
+                password: password,
+                audience: `https://${this.domain}/userinfo`,
+                scope: 'openid profile email'
+            }, {
+                headers: { 'Content-Type': 'application/json' }
+            });
+            console.log('Auth0 Login Response:', response.data);
+        });
+    }
+    resetPassword(email) {
+        return __awaiter(this, void 0, void 0, function* () {
+            console.log(`Resetting password with Auth0: ${email}`);
+            const response = yield axios_1.default.post(`https://${this.domain}/dbconnections/change_password`, {
+                client_id: this.clientId,
+                email: email,
+                connection: 'Username-Password-Authentication'
+            }, {
+                headers: { 'Content-Type': 'application/json' }
+            });
+            console.log('Auth0 Reset Password Response:', response.data);
+        });
+    }
+    logout() {
+        return __awaiter(this, void 0, void 0, function* () {
+            console.log(`Logging out from Auth0`);
+            window.location.href = `https://${this.domain}/v2/logout?client_id=${this.clientId}&returnTo=${encodeURIComponent(window.location.origin)}`;
+        });
+    }
+}
+exports.Auth0Provider = Auth0Provider;
+exports.default = Auth0Provider;

package/package.json

@@ -0,0 +1,35 @@
+{
+    "name": "@mattygt86/daturetech-auth-library",
+    "version": "0.0.0-alpha",
+    "description": "A TypeScript authentication library with provider abstraction",
+    "keywords": [
+        "auth"
+    ],
+    "homepage": "https://github.com/MattyGT/daturetech_auth_library#readme",
+    "bugs": {
+        "url": "https://github.com/MattyGT/daturetech_auth_library/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/MattyGT/daturetech_auth_library.git"
+    },
+    "license": "ISC",
+    "author": "Matthew Tyler",
+    "type": "commonjs",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "build": "tsc",
+        "start": "node dist/index.js"
+    },
+    "dependencies": {
+        "axios": "^1.4.0"
+    },
+    "devDependencies": {
+        "@types/node": "^20.0.0",
+        "@typescript-eslint/eslint-plugin": "^8.28.0",
+        "@typescript-eslint/parser": "^8.28.0",
+        "eslint": "^9.23.0",
+        "typescript": "^5.0.0"
+    }
+}

package/src/auth.abstract.ts

@@ -0,0 +1,5 @@
+export abstract class AuthProvider {
+    abstract login(email: string, password: string): Promise<void>;
+    abstract resetPassword(email: string): Promise<void>;
+    abstract logout(): Promise<void>;
+}

package/src/auth.factory.ts

@@ -0,0 +1,16 @@
+import { AuthProvider } from './auth.abstract';
+import Auth0Provider from './providers/auth0.provider';
+
+// Factory to instantiate the correct provider
+class AuthFactory {
+  static createProvider(providerName: string, config: { domain: string; clientId: string }): AuthProvider {
+    switch (providerName.toLowerCase()) {
+      case 'auth0':
+        return new Auth0Provider(config.domain, config.clientId);
+      default:
+        throw new Error(`Unsupported provider: ${providerName}`);
+    }
+  }
+}
+
+export default AuthFactory;

package/src/auth.ts

@@ -0,0 +1,23 @@
+import { AuthProvider } from "./auth.abstract";
+import AuthFactory from "./auth.factory";
+
+// Main Auth class
+export class Auth {
+  private provider: AuthProvider;
+
+  constructor(providerName: string, config: { domain: string; clientId: string }) {
+    this.provider = AuthFactory.createProvider(providerName, config);
+  }
+
+  login(email: string, password: string) {
+    return this.provider.login(email, password);
+  }
+
+  resetPassword(email: string) {
+    return this.provider.resetPassword(email);
+  }
+
+  logout() {
+    return this.provider.logout();
+  }
+};

package/src/index.ts

@@ -0,0 +1,4 @@
+import { Auth } from "./auth";
+
+export default Auth; // Adjust path based on your file structure
+export { Auth0Provider } from "./providers/auth0.provider"; // If you need direct provider access

package/src/providers/auth0.provider.ts

@@ -0,0 +1,47 @@
+import axios from 'axios';
+import { AuthProvider } from '../auth.abstract';
+
+export class Auth0Provider extends AuthProvider {
+  private domain: string;
+  private clientId: string;
+
+  constructor(domain: string, clientId: string) {
+    super();
+    this.domain = domain;
+    this.clientId = clientId;
+  }
+
+  async login(email: string, password: string): Promise<void> {
+    console.log(`Logging in with Auth0: ${email}`);
+    const response = await axios.post(`https://${this.domain}/oauth/token`, {
+      client_id: this.clientId,
+      grant_type: 'password',
+      username: email,
+      password: password,
+      audience: `https://${this.domain}/userinfo`,
+      scope: 'openid profile email'
+    }, {
+      headers: { 'Content-Type': 'application/json' }
+    });
+    console.log('Auth0 Login Response:', response.data);
+  }
+
+  async resetPassword(email: string): Promise<void> {
+    console.log(`Resetting password with Auth0: ${email}`);
+    const response = await axios.post(`https://${this.domain}/dbconnections/change_password`, {
+      client_id: this.clientId,
+      email: email,
+      connection: 'Username-Password-Authentication'
+    }, {
+      headers: { 'Content-Type': 'application/json' }
+    });
+    console.log('Auth0 Reset Password Response:', response.data);
+  }
+
+  async logout(): Promise<void> {
+    console.log(`Logging out from Auth0`);
+    window.location.href = `https://${this.domain}/v2/logout?client_id=${this.clientId}&returnTo=${encodeURIComponent(window.location.origin)}`;
+  }
+}
+
+export default Auth0Provider;

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES6",
+    "module": "CommonJS",
+    "strict": true,
+    "esModuleInterop": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": false,
+    "moduleResolution": "node"
+  },
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}