semantic rename and update docs

README.md

@@ -1 +1,89 @@
 # foronce
+
+- [foronce](#foronce)
+  - [Usage](#usage)
+    - [Examples](#examples)
+      - [One Time Email Validation](#one-time-email-validation)
+  - [API](#api)
+
+> TOTP in a few functions
+
+## Usage
+
+- Install the `foronce` library
+
+```sh
+; npm install foronce
+```
+
+### Examples
+
+#### One Time Email Validation
+
+```ts
+import { generateTOTPSecret, totp, isTOTPValid } from 'foronce'
+
+app.post('/login', (req, res) => {
+  const email = req.body.email
+  const secret = generateTOTPSecret()
+
+  const user = new User()
+  user.email = email
+  user.OTPSecret = secret
+  await user.save()
+
+  const otp = totp(secret)
+
+  EmailProvider.sendLoginEmail(email, otp)
+})
+
+app.post('/verify', (req, res) => {
+  const { email, otp } = req.body
+  const user = await User.find({
+    where: {
+      email: email,
+    },
+  })
+
+  if (!isTOTPValid(user.OTPSecret, otp)) {
+    res.status(400)
+    res.send({ message: 'Invalid OTP' })
+    return
+  }
+
+  res.send(generateLoginToken(user))
+  return
+})
+```
+
+## API
+
+```ts
+export function totp(
+  secret: string,
+  when?: number,
+  options?: {
+    period?: number
+    algorithm?: 'sha1' | 'sha256' | 'sha512'
+  }
+): string
+
+export function isTOTPValid(
+  secret: string,
+  token: string,
+  options?: {
+    period?: number
+    algorithm?: 'sha1' | 'sha256' | 'sha512'
+  }
+): boolean
+
+export function generateTOTPURL(
+  secret: string,
+  options: {
+    company: string
+    email: string
+  }
+): string
+
+export function generateTOTPSecret(num?: number): string
+```

package.json

@@ -1,6 +1,7 @@
 {
   "name": "foronce",
   "version": "0.0.2",
+  "description": "TOTP in a few functions",
   "repository": "[email protected]:dumbjs/foronce.git",
   "license": "MIT",
   "author": "Reaper <[email protected]>",
@@ -39,10 +40,6 @@
     "*.{js,css,md,json}": "prettier --write"
   },
   "prettier": "@barelyhuman/prettier-config",
-  "dependencies": {
-    "hi-base32": "^0.5.1",
-    "uncrypto": "^0.1.3"
-  },
   "devDependencies": {
     "@barelyhuman/prettier-config": "^1.0.0",
     "@types/node": "^20.10.8",

src/index.js

@@ -49,7 +49,7 @@ export function totp(secret, when = floor(Date.now() / 1000), options = {}) {
  * @param {"sha1" | "sha256" | "sha512"} [options.algorithm] (default: sha512)
  * @returns {boolean}
  */
-export function validateTOTP(secret, token, options = {}) {
+export function isTOTPValid(secret, token, options = {}) {
   const _options = Object.assign({ period: 30, algorithm: 'sha512' }, options)
   for (let index = -2; index < 3; index += 1) {
     const fromSys = totp(secret, Date.now() / 1000 + index, _options)