@checodo/better-auth-waitlist 0.0.0-stage → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @checodo/better-auth-waitlist
+
+## 0.1.0
+
+### Minor Changes
+
+- 5f427b0: First release: gate sign-ups behind a waitlist with admin approval and invite codes.

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Clas Heinemeyer
+
+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.

package/README.md

@@ -1,3 +1,56 @@
-# Temporary Holding Version
+# @checodo/better-auth-waitlist
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Gate sign-up behind a waitlist in [better-auth](https://better-auth.com): double opt-in, admin approval, invite codes, and a gate that covers every sign-up method.
+
+A community plugin, not made by the better-auth team. It looks and works
+like better-auth's own plugins: a server plugin, a typed client plugin,
+error codes, and database tables.
+
+## Install
+
+```bash
+npm install @checodo/better-auth-waitlist
+```
+
+Requires `better-auth` and `@better-auth/core` 1.7.20 or a later 1.x
+release (peer dependencies). ESM only.
+
+## Usage
+
+```ts
+// auth.ts
+import { betterAuth } from "better-auth";
+import { waitlist } from "@checodo/better-auth-waitlist";
+
+export const auth = betterAuth({
+  plugins: [
+    waitlist({
+      sendConfirmationEmail: async ({ email, token }) => {
+        // email a link to your confirm page with the token
+      },
+      sendInvite: async ({ email, inviteCode }) => {
+        // email the invite code once an admin approves the entry
+      },
+    }),
+  ],
+});
+```
+
+```ts
+// auth-client.ts
+import { createAuthClient } from "better-auth/client";
+import { waitlistClient } from "@checodo/better-auth-waitlist/client";
+
+export const authClient = createAuthClient({ plugins: [waitlistClient()] });
+```
+
+Create the plugin's tables with the better-auth CLI:
+
+```bash
+npx auth@latest migrate
+```
+
+## Documentation
+
+Every option, endpoint, error code, and table:
+[docs](https://github.com/checodo/better-auth-plugins/blob/main/apps/docs/content/docs/waitlist.mdx).

package/dist/client.d.ts

@@ -0,0 +1,48 @@
+import { r as WAITLIST_ERROR_CODES, t as WaitlistPlugin } from "./index-iWyjVJuS.js";
+/**
+ * Client companion to `waitlist()`. Adds `authClient.waitlist.join`,
+ * `confirm`, `getStatus`, `leave`, `checkInvite`, and the admin endpoints
+ * (`listEntries`, `getStats`, `approveEntries`, `rejectEntry`,
+ * `deleteEntry`, `createInvite`), typed from the server plugin.
+ *
+ * @example
+ * ```ts
+ * import { createAuthClient } from "better-auth/client";
+ * import { waitlistClient } from "@checodo/better-auth-waitlist/client";
+ *
+ * export const authClient = createAuthClient({
+ *   plugins: [waitlistClient()],
+ * });
+ *
+ * await authClient.waitlist.join({ email: "ada@example.com" });
+ * ```
+ */
+export declare const waitlistClient: () => {
+  id: "waitlist";
+  $InferServerPlugin: WaitlistPlugin;
+  pathMethods: {
+    "/waitlist/join": "POST";
+    "/waitlist/confirm": "POST";
+    "/waitlist/get-status": "GET";
+    "/waitlist/leave": "POST";
+    "/waitlist/check-invite": "GET";
+    "/waitlist/list-entries": "GET";
+    "/waitlist/get-stats": "GET";
+    "/waitlist/approve-entries": "POST";
+    "/waitlist/reject-entry": "POST";
+    "/waitlist/delete-entry": "POST";
+    "/waitlist/create-invite": "POST";
+  };
+  $ERROR_CODES: {
+    EMAIL_NOT_APPROVED: import("better-auth").RawError<"EMAIL_NOT_APPROVED">;
+    INVITE_CODE_REQUIRED: import("better-auth").RawError<"INVITE_CODE_REQUIRED">;
+    INVALID_INVITE_CODE: import("better-auth").RawError<"INVALID_INVITE_CODE">;
+    INVALID_TOKEN: import("better-auth").RawError<"INVALID_TOKEN">;
+    WAITLIST_FULL: import("better-auth").RawError<"WAITLIST_FULL">;
+    ENTRY_NOT_FOUND: import("better-auth").RawError<"ENTRY_NOT_FOUND">;
+    METADATA_TOO_LARGE: import("better-auth").RawError<"METADATA_TOO_LARGE">;
+    YOU_ARE_NOT_ALLOWED_TO_MANAGE_WAITLIST: import("better-auth").RawError<"YOU_ARE_NOT_ALLOWED_TO_MANAGE_WAITLIST">;
+  };
+};
+export { WAITLIST_ERROR_CODES };
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","names":[],"sources":["../src/client.ts"],"mappings":";;;;;;;;;;;;;;;;;;;qBAsBa;;EAGiB,oBAAA"}

package/dist/client.js

@@ -0,0 +1,43 @@
+import { t as WAITLIST_ERROR_CODES } from "./error-codes-DHbT2S8_.js";
+// src/client.ts
+/**
+* Client companion to `waitlist()`. Adds `authClient.waitlist.join`,
+* `confirm`, `getStatus`, `leave`, `checkInvite`, and the admin endpoints
+* (`listEntries`, `getStats`, `approveEntries`, `rejectEntry`,
+* `deleteEntry`, `createInvite`), typed from the server plugin.
+*
+* @example
+* ```ts
+* import { createAuthClient } from "better-auth/client";
+* import { waitlistClient } from "@checodo/better-auth-waitlist/client";
+*
+* export const authClient = createAuthClient({
+*   plugins: [waitlistClient()],
+* });
+*
+* await authClient.waitlist.join({ email: "ada@example.com" });
+* ```
+*/
+const waitlistClient = () => {
+	return {
+		id: "waitlist",
+		$InferServerPlugin: {},
+		pathMethods: {
+			"/waitlist/join": "POST",
+			"/waitlist/confirm": "POST",
+			"/waitlist/get-status": "GET",
+			"/waitlist/leave": "POST",
+			"/waitlist/check-invite": "GET",
+			"/waitlist/list-entries": "GET",
+			"/waitlist/get-stats": "GET",
+			"/waitlist/approve-entries": "POST",
+			"/waitlist/reject-entry": "POST",
+			"/waitlist/delete-entry": "POST",
+			"/waitlist/create-invite": "POST"
+		},
+		$ERROR_CODES: WAITLIST_ERROR_CODES
+	};
+};
+export { WAITLIST_ERROR_CODES, waitlistClient };
+
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","names":[],"sources":["../src/client.ts"],"sourcesContent":["import type { BetterAuthClientPlugin } from \"better-auth/client\";\nimport { WAITLIST_ERROR_CODES } from \"./error-codes\";\nimport type { WaitlistPlugin } from \"./index\";\n\n/**\n * Client companion to `waitlist()`. Adds `authClient.waitlist.join`,\n * `confirm`, `getStatus`, `leave`, `checkInvite`, and the admin endpoints\n * (`listEntries`, `getStats`, `approveEntries`, `rejectEntry`,\n * `deleteEntry`, `createInvite`), typed from the server plugin.\n *\n * @example\n * ```ts\n * import { createAuthClient } from \"better-auth/client\";\n * import { waitlistClient } from \"@checodo/better-auth-waitlist/client\";\n *\n * export const authClient = createAuthClient({\n *   plugins: [waitlistClient()],\n * });\n *\n * await authClient.waitlist.join({ email: \"ada@example.com\" });\n * ```\n */\nexport const waitlistClient = () => {\n  return {\n    id: \"waitlist\",\n    $InferServerPlugin: {} as WaitlistPlugin,\n    pathMethods: {\n      \"/waitlist/join\": \"POST\",\n      \"/waitlist/confirm\": \"POST\",\n      \"/waitlist/get-status\": \"GET\",\n      \"/waitlist/leave\": \"POST\",\n      \"/waitlist/check-invite\": \"GET\",\n      \"/waitlist/list-entries\": \"GET\",\n      \"/waitlist/get-stats\": \"GET\",\n      \"/waitlist/approve-entries\": \"POST\",\n      \"/waitlist/reject-entry\": \"POST\",\n      \"/waitlist/delete-entry\": \"POST\",\n      \"/waitlist/create-invite\": \"POST\",\n    },\n    $ERROR_CODES: WAITLIST_ERROR_CODES,\n  } satisfies BetterAuthClientPlugin;\n};\n\nexport { WAITLIST_ERROR_CODES } from \"./error-codes\";\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAsBA,MAAa,uBAAuB;CAClC,OAAO;EACL,IAAI;EACJ,oBAAoB,CAAC;EACrB,aAAa;GACX,kBAAkB;GAClB,qBAAqB;GACrB,wBAAwB;GACxB,mBAAmB;GACnB,0BAA0B;GAC1B,0BAA0B;GAC1B,uBAAuB;GACvB,6BAA6B;GAC7B,0BAA0B;GAC1B,0BAA0B;GAC1B,2BAA2B;EAC7B;EACA,cAAc;CAChB;AACF"}

package/dist/error-codes-DHbT2S8_.js

@@ -0,0 +1,15 @@
+import { defineErrorCodes } from "@better-auth/core/utils/error-codes";
+// src/error-codes.ts
+const WAITLIST_ERROR_CODES = defineErrorCodes({
+	EMAIL_NOT_APPROVED: "This email has not been approved to sign up yet",
+	INVITE_CODE_REQUIRED: "An invite code is required to sign up",
+	INVALID_INVITE_CODE: "This invite code is invalid or has expired",
+	INVALID_TOKEN: "This link is invalid or has expired",
+	WAITLIST_FULL: "The waitlist is full",
+	ENTRY_NOT_FOUND: "No waitlist entry was found with this id",
+	METADATA_TOO_LARGE: "The metadata is too large",
+	YOU_ARE_NOT_ALLOWED_TO_MANAGE_WAITLIST: "You are not allowed to manage the waitlist"
+});
+export { WAITLIST_ERROR_CODES as t };
+
+//# sourceMappingURL=error-codes-DHbT2S8_.js.map

package/dist/error-codes-DHbT2S8_.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-codes-DHbT2S8_.js","names":[],"sources":["../src/error-codes.ts"],"sourcesContent":["import { defineErrorCodes } from \"@better-auth/core/utils/error-codes\";\n\nexport const WAITLIST_ERROR_CODES = defineErrorCodes({\n  EMAIL_NOT_APPROVED: \"This email has not been approved to sign up yet\",\n  INVITE_CODE_REQUIRED: \"An invite code is required to sign up\",\n  INVALID_INVITE_CODE: \"This invite code is invalid or has expired\",\n  INVALID_TOKEN: \"This link is invalid or has expired\",\n  WAITLIST_FULL: \"The waitlist is full\",\n  ENTRY_NOT_FOUND: \"No waitlist entry was found with this id\",\n  METADATA_TOO_LARGE: \"The metadata is too large\",\n  YOU_ARE_NOT_ALLOWED_TO_MANAGE_WAITLIST: \"You are not allowed to manage the waitlist\",\n});\n\nexport type WaitlistErrorCode = keyof typeof WAITLIST_ERROR_CODES;\n"],"mappings":";;AAEA,MAAa,uBAAuB,iBAAiB;CACnD,oBAAoB;CACpB,sBAAsB;CACtB,qBAAqB;CACrB,eAAe;CACf,eAAe;CACf,iBAAiB;CACjB,oBAAoB;CACpB,wCAAwC;AAC1C,CAAC"}