@1auth/account-username 0.0.0-alpha.9 → 0.0.0-beta.1

package/index.js

@@ -1,83 +1,130 @@
+// Copyright 2003 - 2026 will Farrell, and 1Auth contributors.
+// SPDX-License-Identifier: MIT
 import {
-  getOptions as accountOptions,
-  update as accountUpdate
-} from '@1auth/account'
+	lookup as accountLookup,
+	getOptions as accountOptions,
+	update as accountUpdate,
+} from "@1auth/account";
 
-import { createDigest } from '@1auth/crypto'
+import { createSeasonedDigest, symmetricDecryptFields } 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
-}
-
+// not allowed because it can be used to declare and extension
+let usernameBlacklistRegExp;
 const options = {
-  id: 'username',
-  blacklist: []
-  //minLength: 1,
-  //maxLength: 32
-}
+	id: "username",
+	allowedCharRegExp: /^[a-z0-9_-]*$/,
+	usernameBlacklist: [],
+	minLength: 1,
+	maxLength: 32,
+};
 export default (params) => {
-  Object.assign(options, accountOptions(), 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)
-  return options.store.exists(options.table, {
-    digest: await createDigest(usernameSanitized)
-  })
-}
+	const usernameSanitized = sanitize(username);
+	const usernameDigest = createSeasonedDigest(usernameSanitized);
+	return options.store.exists(options.table, {
+		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 = createSeasonedDigest(usernameSanitized);
+
+	let item = await options.store.select(options.table, {
+		digest: usernameDigest,
+	});
+	if (!item) return;
+	// must match @1auth/account
+	item = symmetricDecryptFields(
+		item,
+		{ encryptedKey: item.encryptionKey, sub: item.sub },
+		options.encryptedFields,
+	);
+	item.encryptionKey = undefined;
+	return item;
+};
 
 export const create = async (sub, username) => {
-  const usernameSanitized = __sanitize(username)
-  if (!__validate(usernameSanitized)) {
-    throw new Error('400 invalid characters')
-  }
-  if (!__blacklist(usernameSanitized) || (await exists(usernameSanitized))) {
-    throw new Error('409 Conflict')
-  }
-  await accountUpdate(sub, {
-    username,
-    digest: await createDigest(usernameSanitized)
-  })
-}
+	if (!sub || typeof sub !== "string") {
+		throw new Error("401 Unauthorized", { cause: { sub } });
+	}
+	const usernameSanitized = sanitize(username);
+	const usernameValidate = validate(usernameSanitized);
+	if (usernameValidate !== true) {
+		throw new Error(usernameValidate, {
+			cause: { username, usernameSanitized },
+		});
+	}
+	const usernameDigest = createSeasonedDigest(usernameSanitized);
+	const usernameExists = await options.store.exists(options.table, {
+		digest: usernameDigest,
+	});
+	if (usernameExists) {
+		throw new Error("409 Conflict", { cause: { username, usernameSanitized } });
+	}
+
+	await accountUpdate(sub, {
+		value: username,
+		digest: usernameDigest,
+	});
+};
 
 export const update = async (sub, username) => {
-  await create(sub, username)
-  await options.notify.trigger('account-username-change')
-}
+	await create(sub, username);
+	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 { value: username } = await accountLookup(sub);
+	await options.notify.trigger("account-username-recover", sub, { username });
+};
+
+export const sanitize = (value) => {
+	if (!value || typeof value !== "string") {
+		throw new Error("400 Bad Request", { cause: { value } });
+	}
+	return value
+		.trim()
+		.toLocaleLowerCase()
+		.normalize("NFKD")
+		.replace(/\p{Diacritic}/gu, "");
+};
+
+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 __sanitize = (value) => {
-  return value.trim().toLocaleLowerCase()
-}
+export const validateLength = (value) => {
+	if (value.length < options.minLength || options.maxLength < value.length) {
+		return "400 Bad Request";
+	}
+	return true;
+};
 
-export const __validate = (value) => {
-  if (!regexp.test(value)) {
-    return false
-  }
-  return true
-}
+export const validateAllowedChar = (value) => {
+	// TODO URL encode compare
+	if (!options.allowedCharRegExp.test(value)) {
+		return "400 Bad Request";
+	}
+	return true;
+};
 
-export const __blacklist = (value) => {
-  if (options.blacklist.includes(value)) {
-    return false
-  }
-  return true
-}
+export const validateBlacklist = (value) => {
+	if (usernameBlacklistRegExp?.test(value)) {
+		return "409 Conflict";
+	}
+	return true;
+};

package/package.json

@@ -1,55 +1,55 @@
 {
-  "name": "@1auth/account-username",
-  "version": "0.0.0-alpha.9",
-  "description": "",
-  "type": "module",
-  "engines": {
-    "node": ">=16"
-  },
-  "engineStrict": true,
-  "publishConfig": {
-    "access": "public"
-  },
-  "main": "./index.js",
-  "module": "./index.js",
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./index.d.ts",
-        "default": "./index.js"
-      }
-    }
-  },
-  "types": "index.d.ts",
-  "files": [
-    "index.js",
-    "index.d.ts"
-  ],
-  "scripts": {
-    "test": "npm run test:unit",
-    "test:unit": "ava"
-  },
-  "license": "MIT",
-  "funding": {
-    "type": "github",
-    "url": "https://github.com/sponsors/willfarrell"
-  },
-  "keywords": [],
-  "author": {
-    "name": "1auth contributors",
-    "url": "https://github.com/willfarrell/1auth/graphs/contributors"
-  },
-  "repository": {
-    "type": "git",
-    "url": "github:willfarrell/1auth",
-    "directory": "packages/account-username"
-  },
-  "bugs": {
-    "url": "https://github.com/willfarrell/1auth/issues"
-  },
-  "homepage": "https://github.com/willfarrell/1auth",
-  "gitHead": "d21e1013f55ed05af4daf980bc4dfdfd52538792",
-  "dependencies": {
-    "@1auth/account": "0.0.0-alpha.9"
-  }
+	"name": "@1auth/account-username",
+	"version": "0.0.0-beta.1",
+	"description": "",
+	"type": "module",
+	"engines": {
+		"node": ">=24"
+	},
+	"engineStrict": true,
+	"publishConfig": {
+		"access": "public"
+	},
+	"main": "./index.js",
+	"module": "./index.js",
+	"exports": {
+		".": {
+			"import": {
+				"types": "./index.d.ts",
+				"default": "./index.js"
+			}
+		}
+	},
+	"types": "index.d.ts",
+	"files": [
+		"index.js",
+		"index.d.ts"
+	],
+	"scripts": {
+		"test": "npm run test:unit",
+		"test:unit": "node --test"
+	},
+	"license": "MIT",
+	"funding": {
+		"type": "github",
+		"url": "https://github.com/sponsors/willfarrell"
+	},
+	"keywords": [],
+	"author": {
+		"name": "1auth contributors",
+		"url": "https://github.com/willfarrell/1auth/graphs/contributors"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/willfarrell/1auth.git",
+		"directory": "packages/account-username"
+	},
+	"bugs": {
+		"url": "https://github.com/willfarrell/1auth/issues"
+	},
+	"homepage": "https://github.com/willfarrell/1auth",
+	"gitHead": "7a6c0fbb8ab71d6a2171e678697de9f237568431",
+	"dependencies": {
+		"@1auth/account": "0.0.0-beta.1"
+	}
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 will Farrell
-
-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.