@1auth/account-username 0.0.0-alpha.32 → 0.0.0-alpha.34

package/README.md

@@ -0,0 +1,38 @@
+# @1auth/account-username
+Extends `@1auth/account`
+
+## Getting started
+
+**auth.js**
+```javascript
+import accountUsername from "@1auth/account";
+
+export {
+  create as accountUsernameCreate,
+  exists as accountUsernameExists,
+  lookup as accountUsernameLookup,
+  update as accountUsernameUpdate,
+  recover as accountUsernameRecover,
+} from "@1auth/account-username";
+
+account({ store, notify, encryptedFields: ["username",  "privateKey"] });
+accountUsername({
+  usernameBlacklist: ["admin"]
+})
+```
+
+```javascript
+import {accountUsernameCreate} from './auth.js'
+await accountUsernameCreate(sub, username)
+```
+
+## Options
+
+- `maxLength`: Max length of username. Defaults to `32`
+- `usernameBlacklist`: Array of blacklisted words.
+
+## Database table
+
+
+- `username`
+- `digest`: Digest of `username`

package/index.js

@@ -1,83 +1,120 @@
 import {
   getOptions as accountOptions,
-  update as accountUpdate
+  update as accountUpdate,
+  lookup as accountLookup
 } from '@1auth/account'
 
-import { createDigest } from '@1auth/crypto'
+import { createEncryptedDigest, symetricDecryptFields } from '@1auth/crypto'
 
 // Only allow characters that are safe to encode
 // . not allowed because it can be used to declare and extension
-export const regexp = /^[a-z0-9_-]*$/
-export const jsonSchema = {
-  type: 'string',
-  pattern: '^[a-z0-9_-]*$',
-  minLength: 1,
-  maxLength: 32
-}
-
+let usernameBlacklistRegExp
 const options = {
   id: 'username',
-  blacklist: []
-  // minLength: 1,
-  // maxLength: 32
+  allowedCharRegExp: /^[a-z0-9_-]*$/,
+  usernameBlacklist: [],
+  maxLength: 32
 }
 export default (params) => {
   Object.assign(options, accountOptions(), params)
+  if (options.usernameBlacklist.length) {
+    usernameBlacklistRegExp = new RegExp(
+      `(${options.usernameBlacklist.map((value) => value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')).join('|')})`
+    )
+  }
 }
 
 export const exists = async (username) => {
-  const usernameSanitized = __sanitize(username)
+  const usernameSanitized = sanitize(username)
+  const usernameDigest = createEncryptedDigest(usernameSanitized)
   return options.store.exists(options.table, {
-    digest: await createDigest(usernameSanitized)
+    digest: usernameDigest
   })
 }
 
 export const lookup = async (username) => {
-  if (!username) return {}
-  const usernameSanitized = __sanitize(username)
-  return await options.store.select(options.table, {
-    digest: await createDigest(usernameSanitized)
+  const usernameSanitized = sanitize(username)
+  const usernameDigest = createEncryptedDigest(usernameSanitized)
+
+  let item = await options.store.select(options.table, {
+    digest: usernameDigest
   })
+  if (!item) return
+  // must match @1auth/account
+  item = symetricDecryptFields(
+    item,
+    { encryptedKey: item.encryptionKey, sub: item.sub },
+    options.encryptedFields
+  )
+  delete item.encryptionKey
+  delete item.privateKey
+  return item
 }
 
 export const create = async (sub, username) => {
-  const usernameSanitized = __sanitize(username)
-  if (!__validate(usernameSanitized)) {
-    throw new Error('400 invalid characters')
+  const usernameSanitized = sanitize(username)
+  const usernameValidate = validate(usernameSanitized)
+  if (usernameValidate !== true) {
+    throw new Error(`${usernameValidate} invalid username`)
   }
-  if (!__blacklist(usernameSanitized) || (await exists(usernameSanitized))) {
+  const usernameDigest = createEncryptedDigest(usernameSanitized)
+  const usernameExists = await options.store.exists(options.table, {
+    digest: usernameDigest
+  })
+  if (usernameExists) {
     throw new Error('409 Conflict')
   }
+
   await accountUpdate(sub, {
     username,
-    digest: await createDigest(usernameSanitized)
+    digest: usernameDigest
   })
 }
 
 export const update = async (sub, username) => {
   await create(sub, username)
-  await options.notify.trigger('account-username-change')
+  await options.notify.trigger('account-username-change', sub)
 }
 
 export const recover = async (sub) => {
-  const { username } = await options.store.select(options.table, { sub })
-  await options.notify.trigger('account-username-recover', { username })
+  const { username } = await accountLookup(sub)
+  await options.notify.trigger('account-username-recover', sub, { username })
+}
+
+export const sanitize = (value) => {
+  return value
+    .trim()
+    .toLocaleLowerCase()
+    .normalize('NFKD')
+    .replace(/\p{Diacritic}/gu, '')
 }
 
-export const __sanitize = (value) => {
-  return value.trim().toLocaleLowerCase()
+export const validate = (value) => {
+  let valid = true
+  if (valid === true) valid = validateLength(value)
+  if (valid === true) valid = validateAllowedChar(value)
+  if (valid === true) valid = validateBlacklist(value)
+  return valid
+}
+
+export const validateLength = (value) => {
+  if (value.length < 1 && options.maxLength < value.length) {
+    return '400'
+  }
+  return true
 }
 
-export const __validate = (value) => {
-  if (!regexp.test(value)) {
-    return false
+export const validateAllowedChar = (value) => {
+  // TODO URL encode compare
+  if (!options.allowedCharRegExp.test(value)) {
+    return '400'
   }
   return true
 }
 
-export const __blacklist = (value) => {
-  if (options.blacklist.includes(value)) {
-    return false
+export const validateBlacklist = (value) => {
+  if (usernameBlacklistRegExp?.test(value)) {
+    return '409'
   }
   return true
 }

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@1auth/account-username",
-  "version": "0.0.0-alpha.32",
+  "version": "0.0.0-alpha.34",
   "description": "",
   "type": "module",
   "engines": {
-    "node": ">=16"
+    "node": ">=20"
   },
   "engineStrict": true,
   "publishConfig": {
@@ -27,7 +27,7 @@
   ],
   "scripts": {
     "test": "npm run test:unit",
-    "test:unit": "ava"
+    "test:unit": "node --test"
   },
   "license": "MIT",
   "funding": {
@@ -48,8 +48,8 @@
     "url": "https://github.com/willfarrell/1auth/issues"
   },
   "homepage": "https://github.com/willfarrell/1auth",
-  "gitHead": "3750bef3d7e376c48f7d680e5f2181ee809213b9",
+  "gitHead": "c88105a99efd7f3de80795736d6194e52ef465b4",
   "dependencies": {
-    "@1auth/account": "0.0.0-alpha.32"
+    "@1auth/account": "0.0.0-alpha.34"
   }
 }