@1auth/account-username 0.0.0-beta.1 → 0.0.0-beta.2

package/README.md

@@ -0,0 +1,44 @@
+<div align="center">
+  <h1>@1auth/account-username</h1>
+  <!--<img alt="1auth logo" src="https://raw.githubusercontent.com/willfarrell/1auth/main/docs/img/logo.svg"/>-->
+  <p><strong>Username validation and management for account authentication</strong></p>
+<p>
+  <a href="https://github.com/willfarrell/1auth/actions/workflows/test-unit.yml"><img src="https://github.com/willfarrell/1auth/actions/workflows/test-unit.yml/badge.svg" alt="GitHub Actions unit test status"></a>
+  <a href="https://github.com/willfarrell/1auth/actions/workflows/test-dast.yml"><img src="https://github.com/willfarrell/1auth/actions/workflows/test-dast.yml/badge.svg" alt="GitHub Actions dast test status"></a>
+  <a href="https://github.com/willfarrell/1auth/actions/workflows/test-perf.yml"><img src="https://github.com/willfarrell/1auth/actions/workflows/test-perf.yml/badge.svg" alt="GitHub Actions perf test status"></a>
+  <a href="https://github.com/willfarrell/1auth/actions/workflows/test-sast.yml"><img src="https://github.com/willfarrell/1auth/actions/workflows/test-sast.yml/badge.svg" alt="GitHub Actions SAST test status"></a>
+  <a href="https://github.com/willfarrell/1auth/actions/workflows/test-lint.yml"><img src="https://github.com/willfarrell/1auth/actions/workflows/test-lint.yml/badge.svg" alt="GitHub Actions lint test status"></a>
+  <br/>
+  <a href="https://www.npmjs.com/package/@1auth/account-username"><img alt="npm version" src="https://img.shields.io/npm/v/@1auth/account-username.svg"></a>
+  <a href="https://packagephobia.com/result?p=@1auth/account-username"><img src="https://packagephobia.com/badge?p=@1auth/account-username" alt="npm install size"></a>
+  <a href="https://www.npmjs.com/package/@1auth/account-username">
+  <img alt="npm weekly downloads" src="https://img.shields.io/npm/dw/@1auth/account-username.svg"></a>
+  <a href="https://www.npmjs.com/package/@1auth/account-username#provenance">
+  <img alt="npm provenance" src="https://img.shields.io/badge/provenance-Yes-brightgreen"></a>
+  <br/>
+  <a href="https://scorecard.dev/viewer/?uri=github.com/willfarrell/1auth"><img src="https://api.scorecard.dev/projects/github.com/willfarrell/1auth/badge" alt="Open Source Security Foundation (OpenSSF) Scorecard"></a>
+  <a href="https://slsa.dev"><img src="https://slsa.dev/images/gh-badge-level3.svg" alt="SLSA 3"></a>
+  <a href="https://github.com/willfarrell/1auth/blob/main/docs/CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg"></a>
+  <a href="https://biomejs.dev"><img alt="Checked with Biome" src="https://img.shields.io/badge/Checked_with-Biome-60a5fa?style=flat&logo=biome"></a>
+  <a href="https://conventionalcommits.org"><img alt="Conventional Commits" src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white"></a>
+</p>
+<p>You can read the documentation at: <a href="https://1auth.js.org">https://1auth.js.org</a></p>
+</div>
+
+## Install
+
+```bash
+npm install @1auth/account-username
+```
+
+## Documentation and examples
+
+For documentation and examples, refer to the main [1auth monorepo on GitHub](https://github.com/willfarrell/1auth) or the [1auth website](https://1auth.js.org).
+
+## Contributing
+
+Everyone is very welcome to contribute to this repository. Feel free to [raise issues](https://github.com/willfarrell/1auth/issues) or to [submit Pull Requests](https://github.com/willfarrell/1auth/pulls).
+
+## License
+
+Licensed under [MIT License](LICENSE). Copyright (c) 2020-2026 [will Farrell](https://github.com/willfarrell) and [contributors](https://github.com/willfarrell/1auth/graphs/contributors).

package/index.js

@@ -9,7 +9,7 @@ import {
 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
+// not allowed because it can be used to declare an extension
 let usernameBlacklistRegExp;
 const options = {
 	id: "username",
@@ -18,8 +18,8 @@ const options = {
 	minLength: 1,
 	maxLength: 32,
 };
-export default (params) => {
-	Object.assign(options, accountOptions(), params);
+export default (opt = {}) => {
+	Object.assign(options, accountOptions(), opt);
 	if (options.usernameBlacklist.length) {
 		usernameBlacklistRegExp = new RegExp(
 			`(${options.usernameBlacklist.map((value) => value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")).join("|")})`,
@@ -30,7 +30,7 @@ export default (params) => {
 export const exists = async (username) => {
 	const usernameSanitized = sanitize(username);
 	const usernameDigest = createSeasonedDigest(usernameSanitized);
-	return options.store.exists(options.table, {
+	return await options.store.exists(options.table, {
 		digest: usernameDigest,
 	});
 };
@@ -115,7 +115,7 @@ export const validateLength = (value) => {
 };
 
 export const validateAllowedChar = (value) => {
-	// TODO URL encode compare
+	// allowedCharRegExp only permits URL-safe chars, no encoding needed
 	if (!options.allowedCharRegExp.test(value)) {
 		return "400 Bad Request";
 	}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@1auth/account-username",
-	"version": "0.0.0-beta.1",
-	"description": "",
+	"version": "0.0.0-beta.2",
+	"description": "Username validation and management for account authentication",
 	"type": "module",
 	"engines": {
 		"node": ">=24"
@@ -12,18 +12,14 @@
 	},
 	"main": "./index.js",
 	"module": "./index.js",
+	"sideEffects": false,
 	"exports": {
 		".": {
-			"import": {
-				"types": "./index.d.ts",
-				"default": "./index.js"
-			}
+			"import": "./index.js"
 		}
 	},
-	"types": "index.d.ts",
 	"files": [
-		"index.js",
-		"index.d.ts"
+		"index.js"
 	],
 	"scripts": {
 		"test": "npm run test:unit",
@@ -34,7 +30,14 @@
 		"type": "github",
 		"url": "https://github.com/sponsors/willfarrell"
 	},
-	"keywords": [],
+	"keywords": [
+		"1auth",
+		"OWASP",
+		"ASVS",
+		"account",
+		"username",
+		"identity"
+	],
 	"author": {
 		"name": "1auth contributors",
 		"url": "https://github.com/willfarrell/1auth/graphs/contributors"
@@ -50,6 +53,7 @@
 	"homepage": "https://github.com/willfarrell/1auth",
 	"gitHead": "7a6c0fbb8ab71d6a2171e678697de9f237568431",
 	"dependencies": {
-		"@1auth/account": "0.0.0-beta.1"
+		"@1auth/account": "0.0.0-beta.2",
+		"@1auth/crypto": "0.0.0-beta.2"
 	}
 }