two-factor-authentification-tools 0.0.1

package/README.md

@@ -0,0 +1,84 @@
+<!--
+Get your module up and running quickly.
+
+Find and replace all on all files (CMD+SHIFT+F):
+- Name: My Module
+- Package name: my-module
+- Description: My new Nuxt module
+-->
+
+# My Module
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+[![Nuxt][nuxt-src]][nuxt-href]
+
+My new Nuxt module for doing amazing things.
+
+- [✨ &nbsp;Release Notes](/CHANGELOG.md)
+<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
+<!-- - [📖 &nbsp;Documentation](https://example.com) -->
+
+## Features
+
+<!-- Highlight some of the features your module provide here -->
+- ⛰ &nbsp;Foo
+- 🚠 &nbsp;Bar
+- 🌲 &nbsp;Baz
+
+## Quick Setup
+
+Install the module to your Nuxt application with one command:
+
+```bash
+npx nuxt module add my-module
+```
+
+That's it! You can now use My Module in your Nuxt app ✨
+
+
+## Contribution
+
+<details>
+  <summary>Local development</summary>
+  
+  ```bash
+  # Install dependencies
+  npm install
+  
+  # Generate type stubs
+  npm run dev:prepare
+  
+  # Develop with the playground
+  npm run dev
+  
+  # Build the playground
+  npm run dev:build
+  
+  # Run ESLint
+  npm run lint
+  
+  # Run Vitest
+  npm run test
+  npm run test:watch
+  
+  # Release new version
+  npm run release
+  ```
+
+</details>
+
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/my-module/latest.svg?style=flat&colorA=020420&colorB=00DC82
+[npm-version-href]: https://npmjs.com/package/my-module
+
+[npm-downloads-src]: https://img.shields.io/npm/dm/my-module.svg?style=flat&colorA=020420&colorB=00DC82
+[npm-downloads-href]: https://npm.chart.dev/my-module
+
+[license-src]: https://img.shields.io/npm/l/my-module.svg?style=flat&colorA=020420&colorB=00DC82
+[license-href]: https://npmjs.com/package/my-module
+
+[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt
+[nuxt-href]: https://nuxt.com

package/dist/module.d.mts

@@ -0,0 +1,8 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+interface ModuleOptions {
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+export { _default as default };
+export type { ModuleOptions };

package/dist/module.json

@@ -0,0 +1,9 @@
+{
+  "name": "two-authentification-tools-module",
+  "configKey": "myModule",
+  "version": "0.0.1",
+  "builder": {
+    "@nuxt/module-builder": "1.0.2",
+    "unbuild": "3.6.1"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,21 @@
+import { defineNuxtModule, createResolver, addPlugin } from '@nuxt/kit';
+
+const module$1 = defineNuxtModule({
+  meta: {
+    name: "two-authentification-tools-module",
+    configKey: "myModule"
+  },
+  // Default configuration options of the Nuxt module
+  defaults: {
+    enabled: true
+  },
+  setup(_options, _nuxt) {
+    if (!options.enabled) {
+      return;
+    }
+    const resolver = createResolver(import.meta.url);
+    addPlugin(resolver.resolve("./runtime/plugin"));
+  }
+});
+
+export { module$1 as default };

package/dist/runtime/plugin.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("#app").Plugin<Record<string, unknown>> & import("#app").ObjectPlugin<Record<string, unknown>>;
+export default _default;

package/dist/runtime/plugin.js

@@ -0,0 +1,4 @@
+import { defineNuxtPlugin } from "#app";
+export default defineNuxtPlugin((_nuxtApp) => {
+  console.log("Plugin injected by my-module!");
+});

package/dist/runtime/server/adapters/QRCodes.adapters.d.ts

@@ -0,0 +1,2 @@
+import type { QRCodesService } from '../ports/QRCodes.ports.js';
+export declare const QRCodesAdapter: QRCodesService;

package/dist/runtime/server/adapters/QRCodes.adapters.js

@@ -0,0 +1,6 @@
+import QRCode from "qrcode";
+export const QRCodesAdapter = {
+  generateQRCode(data) {
+    return QRCode.toDataURL(data);
+  }
+};

package/dist/runtime/server/adapters/twoFactorAuthentificator.adapters.d.ts

@@ -0,0 +1,2 @@
+import type { TwoFactorAuthentificatorService } from '../ports/twoFactorAuthentificator.ports.js';
+export declare const TwoFactorAuthentificatorAdapter: TwoFactorAuthentificatorService;

package/dist/runtime/server/adapters/twoFactorAuthentificator.adapters.js

@@ -0,0 +1,19 @@
+import { generateURI, generateSecret, verify } from "otplib";
+export const TwoFactorAuthentificatorAdapter = {
+  generateSecret() {
+    return generateSecret();
+  },
+  createKeyURI(userEmail, appName, secret) {
+    return generateURI({
+      issuer: appName,
+      label: userEmail,
+      secret
+    });
+  },
+  async verifyCode(token, secret) {
+    return verify({
+      token,
+      secret
+    });
+  }
+};

package/dist/runtime/server/ports/QRCodes.ports.d.ts

@@ -0,0 +1,3 @@
+export interface QRCodesService {
+    generateQRCode(data: string): Promise<string>;
+}

package/dist/runtime/server/ports/twoFactorAuthentificator.ports.d.ts

@@ -0,0 +1,5 @@
+export interface TwoFactorAuthentificatorService {
+    generateSecret(): string;
+    createKeyURI(userEmail: string, appName: string, secret: string): string;
+    verifyCode(token: string, secret: string): Promise<boolean> | boolean;
+}

package/dist/runtime/server/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../../.nuxt/tsconfig.server.json",
+}

package/dist/runtime/src/twoAuth.service.d.ts

@@ -0,0 +1,10 @@
+export declare const twoAuthService: {
+    activateTwoFactorAuth: (user: {
+        email: string;
+    }) => Promise<{
+        qr: string;
+        secret: string;
+        otpauth: string;
+    }>;
+    verifyTwoFactorCode: (token: string, secret: string) => Promise<boolean>;
+};

package/dist/runtime/src/twoAuth.service.js

@@ -0,0 +1,20 @@
+import { TwoFactorAuthentificatorAdapter } from "../server/adapters/twoFactorAuthentificator.adapters.js";
+import { QRCodesAdapter } from "../server/adapters/QRCodes.adapters.js";
+import { useRuntimeConfig } from "@nuxt/kit";
+const activateTwoFactorAuth = async (user) => {
+  const secret = TwoFactorAuthentificatorAdapter.generateSecret();
+  const otpauth = TwoFactorAuthentificatorAdapter.createKeyURI(
+    user.email,
+    useRuntimeConfig().public.appName || "YourAppName",
+    secret
+  );
+  const qr = await QRCodesAdapter.generateQRCode(otpauth);
+  return { qr, secret, otpauth };
+};
+const verifyTwoFactorCode = async (token, secret) => {
+  return TwoFactorAuthentificatorAdapter.verifyCode(token, secret);
+};
+export const twoAuthService = {
+  activateTwoFactorAuth,
+  verifyTwoFactorCode
+};

package/dist/types.d.mts

@@ -0,0 +1,3 @@
+export { default } from './module.mjs'
+
+export { type ModuleOptions } from './module.mjs'

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "two-factor-authentification-tools",
+  "version": "0.0.1",
+  "description": "My new Nuxt module",
+  "repository": "your-org/my-module",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs"
+    }
+  },
+  "main": "./dist/module.mjs",
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/types.d.mts"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "workspaces": [
+    "playground"
+  ],
+  "scripts": {
+    "prepack": "nuxt-module-build build",
+    "dev": "npm run dev:prepare && nuxt dev playground",
+    "dev:build": "nuxt build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxt prepare playground",
+    "release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^4.4.5",
+    "otplib": "^13.4.0",
+    "qrcode": "^1.5.4"
+  },
+  "devDependencies": {
+    "@nuxt/devtools": "^3.2.4",
+    "@nuxt/eslint-config": "^1.15.2",
+    "@nuxt/module-builder": "^1.0.2",
+    "@nuxt/schema": "^4.4.5",
+    "@nuxt/test-utils": "^4.0.3",
+    "@types/node": "latest",
+    "@types/qrcode": "^1.5.6",
+    "changelogen": "^0.6.2",
+    "eslint": "^10.3.0",
+    "nuxt": "^4.4.5",
+    "typescript": "~6.0.3",
+    "vitest": "^4.1.5",
+    "vue-tsc": "^3.2.8"
+  }
+}