@nerdfolio/ba-guest-list 0.0.1 → 0.0.3

package/README.md

@@ -1,13 +1,20 @@
 # Better Auth Guest List
-Plugin to provide fixed guest list functionality. Intended use is for development testing and possibly demos with
-know login names, e.g. login as "Alice" or "Bob".
 
-You can use it for logging in by just typing a single-word name or binding that name to a UI button.
+Plugin to provide fixed guest list login functionality for [better-auth](https://www.better-auth.com).
 
-The fixed guest list can be defined on the server-side with roles so this plugin
-can also be used for testing roles.
+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.
+
+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).
+
+THIS IS NOT MEANT FOR SECURE PRODUCTION APP!
+
+# How It Works
+
+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.
 
-As this plugin is only intended to be a temporary aid to development and demo, it does not add any field to the schema. 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.
 
 # Installation
 
@@ -46,7 +53,7 @@ export const auth = betterAuth({
 
 Options:
 
- `allowGuests`: can be an array of names or array of `{name: string, role?: string}`. role uses better-auth convention as a comma-separated string of actual roles.
+ `allowGuests`: can be an array of names or array of `{name: string, role?: string}`. Role follows better-auth convention as a comma-separated string of actual roles.
 
  `revealNames`: is a boolean. When enabled, the client will be able to retrieve the guest names via `client.signIn.guestList.reveal()`. Names may also be returned in api errors during logins. When undefined or disabled, the `reveal()` endpoint will just return `null` and names will not be sent in error messages.
 
@@ -57,7 +64,7 @@ Options:
 
 ```typescript
 
-import { guestListClient } from "@nerdfolio/ba-guest-list/client"
+import { guestListClient } from "@nerdfolio/ba-guest-list"
 
 export const authClient = createAuthClient({
 	plugins: [

package/dist/index.cjs

@@ -20,15 +20,18 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  guestList: () => guestList
+  guestList: () => guestList,
+  guestListClient: () => guestListClient
 });
 module.exports = __toCommonJS(index_exports);
+
+// src/server.ts
 var import_api = require("better-auth/api");
 var import_cookies = require("better-auth/cookies");
-var import_lodash_es = require("lodash-es");
 var import_v4_mini = require("zod/v4-mini");
 
 // src/utils.ts
+var import_lodash_es = require("lodash-es");
 function getOrigin(url) {
   try {
     const parsedUrl = new URL(url);
@@ -37,11 +40,11 @@ function getOrigin(url) {
     return null;
   }
 }
-
-// src/index.ts
 function formatName(name) {
   return (0, import_lodash_es.capitalize)(name.replaceAll(/\s/g, ""));
 }
+
+// src/server.ts
 var guestList = (options) => {
   const ERROR_CODES = {
     NAME_NOT_PROVIDED: "Guest name not provided",
@@ -51,10 +54,13 @@ var guestList = (options) => {
     COULD_NOT_CREATE_SESSION: "Could not create session"
   };
   const guestLookup = Object.fromEntries(
-    (options?.allowGuests ?? []).map((entry) => typeof entry === "string" ? { name: entry, role: "" } : entry).filter((entry) => !!entry && entry.name).map(({ name, role }) => [formatName(name), {
-      name: formatName(name),
-      role: (role ?? "").split(",").map((s) => s.trim()).join(",")
-    }])
+    (options?.allowGuests ?? []).map((entry) => typeof entry === "string" ? { name: entry, role: "" } : entry).filter((entry) => !!entry && entry.name).map(({ name, role }) => [
+      formatName(name),
+      {
+        name: formatName(name),
+        role: (role ?? "").split(",").map((s) => s.trim()).join(",")
+      }
+    ])
   );
   return {
     id: "guest-list",
@@ -178,11 +184,19 @@ var guestList = (options) => {
         }
       )
     },
-    //schema: mergeSchema(schema, options?.schema),
     $ERROR_CODES: ERROR_CODES
   };
 };
+
+// src/client.ts
+var guestListClient = () => {
+  return {
+    id: "guest-list",
+    $InferServerPlugin: {}
+  };
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  guestList
+  guestList,
+  guestListClient
 });

package/dist/index.d.cts

@@ -172,4 +172,9 @@ declare const guestList: (options?: GuestListOptions) => {
     };
 };
 
-export { type GuestListOptions, guestList };
+declare const guestListClient: () => {
+    id: "guest-list";
+    $InferServerPlugin: ReturnType<typeof guestList>;
+};
+
+export { type GuestListOptions, guestList, guestListClient };

package/dist/index.d.ts

@@ -172,4 +172,9 @@ declare const guestList: (options?: GuestListOptions) => {
     };
 };
 
-export { type GuestListOptions, guestList };
+declare const guestListClient: () => {
+    id: "guest-list";
+    $InferServerPlugin: ReturnType<typeof guestList>;
+};
+
+export { type GuestListOptions, guestList, guestListClient };

package/dist/index.mjs

@@ -1,10 +1,10 @@
-// src/index.ts
+// src/server.ts
 import { APIError, createAuthEndpoint } from "better-auth/api";
 import { setSessionCookie } from "better-auth/cookies";
-import { capitalize } from "lodash-es";
 import { z } from "zod/v4-mini";
 
 // src/utils.ts
+import { capitalize } from "lodash-es";
 function getOrigin(url) {
   try {
     const parsedUrl = new URL(url);
@@ -13,11 +13,11 @@ function getOrigin(url) {
     return null;
   }
 }
-
-// src/index.ts
 function formatName(name) {
   return capitalize(name.replaceAll(/\s/g, ""));
 }
+
+// src/server.ts
 var guestList = (options) => {
   const ERROR_CODES = {
     NAME_NOT_PROVIDED: "Guest name not provided",
@@ -27,10 +27,13 @@ var guestList = (options) => {
     COULD_NOT_CREATE_SESSION: "Could not create session"
   };
   const guestLookup = Object.fromEntries(
-    (options?.allowGuests ?? []).map((entry) => typeof entry === "string" ? { name: entry, role: "" } : entry).filter((entry) => !!entry && entry.name).map(({ name, role }) => [formatName(name), {
-      name: formatName(name),
-      role: (role ?? "").split(",").map((s) => s.trim()).join(",")
-    }])
+    (options?.allowGuests ?? []).map((entry) => typeof entry === "string" ? { name: entry, role: "" } : entry).filter((entry) => !!entry && entry.name).map(({ name, role }) => [
+      formatName(name),
+      {
+        name: formatName(name),
+        role: (role ?? "").split(",").map((s) => s.trim()).join(",")
+      }
+    ])
   );
   return {
     id: "guest-list",
@@ -154,10 +157,18 @@ var guestList = (options) => {
         }
       )
     },
-    //schema: mergeSchema(schema, options?.schema),
     $ERROR_CODES: ERROR_CODES
   };
 };
+
+// src/client.ts
+var guestListClient = () => {
+  return {
+    id: "guest-list",
+    $InferServerPlugin: {}
+  };
+};
 export {
-  guestList
+  guestList,
+  guestListClient
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nerdfolio/ba-guest-list",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "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": {
@@ -8,18 +8,15 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
       "require": "./dist/index.cjs"
-    },
-    "./client": {
-      "types": "./dist/client.d.ts",
-      "import": "./dist/client.mjs",
-      "require": "./dist/client.cjs"
     }
   },
   "keywords": [
     "better-auth",
     "better-auth plugin",
     "guest login",
-    "demo login"
+    "demo login",
+    "anonymous login",
+    "auth testing"
   ],
   "author": "taivo@github",
   "license": "ISC",

package/src/client.ts

@@ -1,12 +1,9 @@
 import type { BetterAuthClientPlugin } from "better-auth"
-import type { guestList } from "."
+import type { guestList } from "./server"
 
 export const guestListClient = () => {
 	return {
 		id: "guest-list",
 		$InferServerPlugin: {} as ReturnType<typeof guestList>,
-		// pathMethods: {
-		// 	"/sign-in/guest-list": "POST",
-		// },
 	} satisfies BetterAuthClientPlugin
 }

package/src/index.ts

@@ -1,205 +1,2 @@
-import type { BetterAuthPlugin } from "better-auth"
-import { APIError, createAuthEndpoint } from "better-auth/api"
-import { setSessionCookie } from "better-auth/cookies"
-import { capitalize } from "lodash-es"
-import { z } from "zod/v4-mini"
-import { getOrigin } from "./utils"
-
-type GuestWithRole = {
-	name: string,
-	role: string //comma-separated string
-}
-
-export interface GuestListOptions {
-	/**
-	 * List of accepted guest names
-	 */
-	allowGuests: string[] | GuestWithRole[]
-
-	/**
-	 * When true returns the list of guest names via the guestList.reveal() endpoint and via errors.
-	 * When false returns nothing.
-	 * @default false
-	 */
-	revealNames?: boolean
-
-	/**
-	 * Configure the domain name of the temporary email
-	 * address for the guest users in the database.
-	 * @default "baseURL"
-	 */
-	emailDomainName?: string
-
-	/**
-	 * Custom schema for the anonymous plugin
-	 */
-	// schema?: InferOptionSchema<typeof schema>
-}
-
-function formatName(name: string) {
-	return capitalize(name.replaceAll(/\s/g, ""))
-}
-
-export const guestList = (options?: GuestListOptions) => {
-	const ERROR_CODES = {
-		NAME_NOT_PROVIDED: "Guest name not provided",
-		NAME_NOT_ON_GUEST_LIST: "Your name is not on the guest list",
-		NAME_ONE_WORD_ONLY: "Please only use 1-word names",
-		FAILED_TO_CREATE_USER: "Failed to create user",
-		COULD_NOT_CREATE_SESSION: "Could not create session",
-	} as const
-
-	const guestLookup = Object.fromEntries(
-		(options?.allowGuests ?? [])
-			.map((entry) => typeof entry === "string" ? { name: entry, role: "" } : entry)
-			.filter(entry => !!entry && entry.name)
-			.map(({ name, role }) => [formatName(name), {
-				name: formatName(name),
-				role: (role ?? "").split(",").map(s => s.trim()).join(",")
-			}])
-	)
-
-	return {
-		id: "guest-list",
-		endpoints: {
-			signInGuest: createAuthEndpoint(
-				"/sign-in/guest-list",
-				{
-					method: "POST",
-					body: z.object({
-						name: z.string(),
-					}),
-					metadata: {
-						openapi: {
-							description: "Sign in as a guest with name only",
-							responses: {
-								200: {
-									description: "Sign in as a guest successful",
-									content: {
-										"application/json": {
-											schema: {
-												type: "object",
-												properties: {
-													user: {
-														$ref: "#/components/schemas/User",
-													},
-													session: {
-														$ref: "#/components/schemas/Session",
-													},
-												},
-											},
-										},
-									},
-								},
-							},
-						},
-					},
-				},
-				async (ctx) => {
-					const { name } = ctx.body
-
-					if (!name) {
-						ctx.context.logger.error("Guest name not provided")
-						throw new APIError("UNAUTHORIZED", {
-							message: options?.revealNames
-								? `Guest name not provided. Try: ${JSON.stringify(Object.keys(guestLookup))}` : ERROR_CODES.NAME_NOT_PROVIDED,
-						})
-					}
-
-					if (name.trim().split(/\s+/).length > 1) {
-						ctx.context.logger.error("For simplicity, only one word names are allowed")
-						throw new APIError("UNAUTHORIZED", {
-							message: ERROR_CODES.NAME_ONE_WORD_ONLY,
-						})
-					}
-
-					const cleanedName = formatName(name)
-
-					if (!guestLookup[cleanedName]) {
-						throw new APIError("UNAUTHORIZED", {
-							message: options?.revealNames
-								? `Name not on list. Try: ${JSON.stringify(Object.keys(guestLookup))}`
-								: ERROR_CODES.NAME_NOT_ON_GUEST_LIST,
-						})
-					}
-
-					// generate email based the input name
-					const { emailDomainName = getOrigin(ctx.context.baseURL) } = options ?? {}
-					const email = `${cleanedName.toLowerCase().replaceAll(/\s/g, "")}.onguestlist@${emailDomainName}`
-
-					const found = await ctx.context.internalAdapter.findUserByEmail(email)
-
-					async function createNewUser() {
-						const newUser = await ctx.context.internalAdapter.createUser(
-							{
-								email,
-								emailVerified: false,
-								name: cleanedName,
-								role: guestLookup[cleanedName].role,
-								createdAt: new Date(),
-								updatedAt: new Date(),
-							},
-							ctx
-						)
-						if (!newUser) {
-							throw ctx.error("INTERNAL_SERVER_ERROR", {
-								message: ERROR_CODES.FAILED_TO_CREATE_USER,
-							})
-						}
-
-						return newUser
-					}
-
-					const user = found ? found.user : await createNewUser()
-
-					const session = await ctx.context.internalAdapter.createSession(user.id, ctx, true)
-
-					if (!session) {
-						return ctx.json(null, {
-							status: 400,
-							body: {
-								message: ERROR_CODES.COULD_NOT_CREATE_SESSION,
-							},
-						})
-					}
-					await setSessionCookie(ctx, { session, user })
-
-					return ctx.json({ token: session.token, user })
-				}
-			),
-
-			revealGuestList: createAuthEndpoint(
-				"/sign-in/guest-list/reveal",
-				{
-					method: "GET",
-					metadata: {
-						openapi: {
-							description: "Reveal guest list if 'revealNames' is enabled. Empty array otherwise",
-							responses: {
-								200: {
-									description: "List of allowed guest names or empty array",
-									content: {
-										"application/json": {
-											schema: {
-												type: "array",
-												items: {
-													type: "string",
-												},
-											},
-										},
-									},
-								},
-							},
-						},
-					},
-				},
-				async (ctx) => {
-					return ctx.json(options?.revealNames ? Object.keys(guestLookup) : [])
-				}
-			)
-		},
-
-		//schema: mergeSchema(schema, options?.schema),
-		$ERROR_CODES: ERROR_CODES,
-	} satisfies BetterAuthPlugin
-}
+export { guestList, type GuestListOptions } from "./server"
+export { guestListClient } from "./client"

package/src/server.ts

@@ -0,0 +1,200 @@
+import type { BetterAuthPlugin } from "better-auth"
+import { APIError, createAuthEndpoint } from "better-auth/api"
+import { setSessionCookie } from "better-auth/cookies"
+import { z } from "zod/v4-mini"
+import { formatName, getOrigin } from "./utils"
+
+type GuestWithRole = {
+	name: string
+	role: string //comma-separated string
+}
+
+export interface GuestListOptions {
+	/**
+	 * List of accepted guest names
+	 */
+	allowGuests: string[] | GuestWithRole[]
+
+	/**
+	 * When true returns the list of guest names via the guestList.reveal() endpoint and via errors.
+	 * When false returns nothing.
+	 * @default false
+	 */
+	revealNames?: boolean
+
+	/**
+	 * Configure the domain name of the temporary email
+	 * address for the guest users in the database.
+	 * @default "baseURL"
+	 */
+	emailDomainName?: string
+}
+
+export const guestList = (options?: GuestListOptions) => {
+	const ERROR_CODES = {
+		NAME_NOT_PROVIDED: "Guest name not provided",
+		NAME_NOT_ON_GUEST_LIST: "Your name is not on the guest list",
+		NAME_ONE_WORD_ONLY: "Please only use 1-word names",
+		FAILED_TO_CREATE_USER: "Failed to create user",
+		COULD_NOT_CREATE_SESSION: "Could not create session",
+	} as const
+
+	const guestLookup = Object.fromEntries(
+		(options?.allowGuests ?? [])
+			.map((entry) => (typeof entry === "string" ? { name: entry, role: "" } : entry))
+			.filter((entry) => !!entry && entry.name)
+			.map(({ name, role }) => [
+				formatName(name),
+				{
+					name: formatName(name),
+					role: (role ?? "")
+						.split(",")
+						.map((s) => s.trim())
+						.join(","),
+				},
+			])
+	)
+
+	return {
+		id: "guest-list",
+		endpoints: {
+			signInGuest: createAuthEndpoint(
+				"/sign-in/guest-list",
+				{
+					method: "POST",
+					body: z.object({
+						name: z.string(),
+					}),
+					metadata: {
+						openapi: {
+							description: "Sign in as a guest with name only",
+							responses: {
+								200: {
+									description: "Sign in as a guest successful",
+									content: {
+										"application/json": {
+											schema: {
+												type: "object",
+												properties: {
+													user: {
+														$ref: "#/components/schemas/User",
+													},
+													session: {
+														$ref: "#/components/schemas/Session",
+													},
+												},
+											},
+										},
+									},
+								},
+							},
+						},
+					},
+				},
+				async (ctx) => {
+					const { name } = ctx.body
+
+					if (!name) {
+						ctx.context.logger.error("Guest name not provided")
+						throw new APIError("UNAUTHORIZED", {
+							message: options?.revealNames
+								? `Guest name not provided. Try: ${JSON.stringify(Object.keys(guestLookup))}`
+								: ERROR_CODES.NAME_NOT_PROVIDED,
+						})
+					}
+
+					if (name.trim().split(/\s+/).length > 1) {
+						ctx.context.logger.error("For simplicity, only one word names are allowed")
+						throw new APIError("UNAUTHORIZED", {
+							message: ERROR_CODES.NAME_ONE_WORD_ONLY,
+						})
+					}
+
+					const cleanedName = formatName(name)
+
+					if (!guestLookup[cleanedName]) {
+						throw new APIError("UNAUTHORIZED", {
+							message: options?.revealNames
+								? `Name not on list. Try: ${JSON.stringify(Object.keys(guestLookup))}`
+								: ERROR_CODES.NAME_NOT_ON_GUEST_LIST,
+						})
+					}
+
+					// generate email based the input name
+					const { emailDomainName = getOrigin(ctx.context.baseURL) } = options ?? {}
+					const email = `${cleanedName.toLowerCase().replaceAll(/\s/g, "")}.onguestlist@${emailDomainName}`
+
+					const found = await ctx.context.internalAdapter.findUserByEmail(email)
+
+					async function createNewUser() {
+						const newUser = await ctx.context.internalAdapter.createUser(
+							{
+								email,
+								emailVerified: false,
+								name: cleanedName,
+								role: guestLookup[cleanedName].role,
+								createdAt: new Date(),
+								updatedAt: new Date(),
+							},
+							ctx
+						)
+						if (!newUser) {
+							throw ctx.error("INTERNAL_SERVER_ERROR", {
+								message: ERROR_CODES.FAILED_TO_CREATE_USER,
+							})
+						}
+
+						return newUser
+					}
+
+					const user = found ? found.user : await createNewUser()
+
+					const session = await ctx.context.internalAdapter.createSession(user.id, ctx, true)
+
+					if (!session) {
+						return ctx.json(null, {
+							status: 400,
+							body: {
+								message: ERROR_CODES.COULD_NOT_CREATE_SESSION,
+							},
+						})
+					}
+					await setSessionCookie(ctx, { session, user })
+
+					return ctx.json({ token: session.token, user })
+				}
+			),
+
+			revealGuestList: createAuthEndpoint(
+				"/sign-in/guest-list/reveal",
+				{
+					method: "GET",
+					metadata: {
+						openapi: {
+							description: "Reveal guest list if 'revealNames' is enabled. Empty array otherwise",
+							responses: {
+								200: {
+									description: "List of allowed guest names or empty array",
+									content: {
+										"application/json": {
+											schema: {
+												type: "array",
+												items: {
+													type: "string",
+												},
+											},
+										},
+									},
+								},
+							},
+						},
+					},
+				},
+				async (ctx) => {
+					return ctx.json(options?.revealNames ? Object.keys(guestLookup) : [])
+				}
+			),
+		},
+		$ERROR_CODES: ERROR_CODES,
+	} satisfies BetterAuthPlugin
+}

package/src/utils.ts

@@ -1,3 +1,5 @@
+import { capitalize } from "lodash-es"
+
 export function getOrigin(url: string) {
 	try {
 		const parsedUrl = new URL(url)
@@ -5,4 +7,8 @@ export function getOrigin(url: string) {
 	} catch (_error) {
 		return null
 	}
+}
+
+export function formatName(name: string) {
+	return capitalize(name.replaceAll(/\s/g, ""))
 }

package/tsup.config.ts

@@ -1,7 +1,7 @@
 import { type Options, defineConfig } from "tsup"
 
 const libCfg = {
-	entry: ["src/index.ts", "src/client.ts"],
+	entry: ["src/index.ts"],
 	splitting: false,
 	target: "node22",
 	format: ["esm", "cjs"],

package/dist/client.cjs

@@ -1,38 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/client.ts
-var client_exports = {};
-__export(client_exports, {
-  guestListClient: () => guestListClient
-});
-module.exports = __toCommonJS(client_exports);
-var guestListClient = () => {
-  return {
-    id: "guest-list",
-    $InferServerPlugin: {}
-    // pathMethods: {
-    // 	"/sign-in/guest-list": "POST",
-    // },
-  };
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  guestListClient
-});

package/dist/client.d.cts

@@ -1,10 +0,0 @@
-import { guestList } from './index.cjs';
-import 'better-auth';
-import 'zod/v4-mini';
-
-declare const guestListClient: () => {
-    id: "guest-list";
-    $InferServerPlugin: ReturnType<typeof guestList>;
-};
-
-export { guestListClient };

package/dist/client.d.ts

@@ -1,10 +0,0 @@
-import { guestList } from './index.js';
-import 'better-auth';
-import 'zod/v4-mini';
-
-declare const guestListClient: () => {
-    id: "guest-list";
-    $InferServerPlugin: ReturnType<typeof guestList>;
-};
-
-export { guestListClient };

package/dist/client.mjs

@@ -1,13 +0,0 @@
-// src/client.ts
-var guestListClient = () => {
-  return {
-    id: "guest-list",
-    $InferServerPlugin: {}
-    // pathMethods: {
-    // 	"/sign-in/guest-list": "POST",
-    // },
-  };
-};
-export {
-  guestListClient
-};