@nerdfolio/ba-guest-list 0.0.4 → 0.0.6

package/README.md

@@ -2,7 +2,7 @@
 
 Plugin to provide fixed guest list login functionality for [better-auth](https://www.better-auth.com).
 
-Intended use is for development testing and possibly demos with known login names, e.g. login as "Alice" or "Bob". You can use it with a single-input form or binding a name to a submit button. Names are case insensitive.
+Intended use is for development testing and possibly demos with known login names, e.g. login as "Alice" or "Bob". You can use it with a single-input form or binding a name to a submit button. Names are single-word and case-insensitive.
 
 The fixed guest list is defined on the server-side with optional roles so this plugin can also be used for testing roles.
 You can optionally reveal the server guest list to the client (useful for demo login scenarios).
@@ -13,7 +13,7 @@ THIS IS NOT MEANT FOR SECURE PRODUCTION APP!
 
 This plugin does not add any field to the schema as its intended use is temporary for testing and demos.
 
-Internally, the guest name is transformed into an email via a fixed template, e.g. `tom.onguestlist@emaildomain` and that is the way that user will be looked up. For simplicity, the guest names are restricted to be 1-word names.
+Internally, the guest name is transformed into an email via a fixed template, e.g. `tom.onguestlist@emaildomain` and that is the way users will be looked up.
 
 
 # Installation
@@ -24,8 +24,6 @@ pnpm add @nerdfolio/ba-guest-list
 
 ```
 
-# Usage
-
 ## Server-side setup
 
 ```typescript
@@ -39,12 +37,13 @@ export const auth = betterAuth({
 		...otherPlugins,
 		guestList({
 			allowGuests: [
-				// can be array of names or array of {name: string, role?: comma-separated-string}
+				// required: can be array of names or array of {name: string, role?: comma-separated-string}
 				{ name: "Alice", role: "admin" },
 				{ name: "Bob", role: "user" },
 				{ name: "Charlie", role: "user" },
 			],
-			revealNames: true // whether the client can see this list (useful for demos)
+			// optional; whether the client can see this list (useful for demos)
+			revealNames: true
 		})
 	],
 })
@@ -74,22 +73,21 @@ export const authClient = createAuthClient({
 
 ```
 
-## Signin
+# Usage
 
 ```typescript
 
-// authClient is the better-auth client as defined in client-side setup
 // GUEST_NAME has to be in the list of names defined in server-side setup, otherwise login will fail
 authClient.signIn.guestList({
 	name: GUEST_NAME
 })
 ```
 
-If you have enabled `revealNames` in your server-side setup, you can retrieve that list of names on the client side. This may be useful for creating demos with a fixed list of login names. The plugin will
-call a special fetch endpoint and returns either `null` or an array of name strings. When `revealNames` is undefined or false, it returns `null`.
+If you have enabled `revealNames` in your server-side setup, you can retrieve that list of names on the client side via `signIn.guestList.reveal()`. This may be useful for creating demos with a fixed list of login names as client-side hints.
 
 ```typescript
-// just an async so you'll need to use it according to the way your frontend framework andles async
+// just an async so you'll need to use it according to the way
+// your frontend framework handles async
 
 const guestNames = await authClient.signIn.guestList.reveal()
   .then(({ data, error: _e }) => data?.join(", "))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nerdfolio/ba-guest-list",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "Similar to anonymous, but with a name that must be on a guest list. Useful for testing or demo with fixed logins",
   "type": "module",
   "exports": {