better-auth-university 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jaren Goldberg
+
+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

@@ -0,0 +1,31 @@
+# Better Auth University Plugin
+
+A university plugin for Better Auth that allows restriction of email domains.
+
+## Installation
+
+```bash
+npm install better-auth-university
+```
+
+## Setup
+
+To use the Better Auth University Plugin, you need to configure it with a list of universities and their associated email domains. You can also specify allowed email domains for user registration. If you would like a comprehensive list of universities, consider going to the [university-domains-list](https://github.com/Hipo/university-domains-list) for options of obtaining the data. There is a world_universities_and_domains.json which can be easily passed to the `university` parameter.
+
+```typescript
+import { universityResolver } from "better-auth-university";
+
+const plugin = universityResolver({
+  universities: [
+    {
+      name: "Massachusetts Institute of Technology",
+      domains: ["mit.edu"],
+      web_pages: ["http://web.mit.edu/"],
+      country: "United States",
+      alpha_two_code: "US",
+      "state-province": "Massachusetts",
+    },
+  ],
+  allowedEmailDomains: [".edu", ".ac.uk"],
+});
+```

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import { BetterAuthPlugin } from 'better-auth';
+export interface University {
+    id: string;
+    name: string;
+    domain: string;
+}
+export interface UniversityData {
+    name: string;
+    domains: string[];
+    web_pages: string[];
+    country: string;
+    alpha_two_code: string;
+    "state-province": string | null;
+}
+export interface UniversityResolverOptions {
+    universities: UniversityData[];
+    /**
+     * List of allowed email domains or extensions.
+     *
+     * Examples: ['.edu', '.ac.uk', 'mit.edu']
+     * If not provided, defaults to ['.edu'].
+     *
+     * Pass `['*']` to allow all domains.
+     */
+    allowedEmailDomains?: string[];
+}
+export declare const universityResolver: (options: UniversityResolverOptions) => BetterAuthPlugin;

package/dist/index.js

@@ -0,0 +1,69 @@
+import { createAuthMiddleware, APIError } from 'better-auth/api';
+import { mergeSchema } from 'better-auth/db';
+import { getSchema } from './schema.js';
+export const universityResolver = (options) => {
+    const allowedDomains = options.allowedEmailDomains || ['.edu'];
+    const allowAll = allowedDomains.includes('*');
+    return {
+        id: 'university-resolver',
+        schema: mergeSchema(getSchema()),
+        hooks: {
+            before: [
+                {
+                    matcher: (context) => {
+                        return context.path === '/sign-up/email';
+                    },
+                    handler: createAuthMiddleware(async (context) => {
+                        const { email } = context.body;
+                        if (!email || typeof email !== 'string') {
+                            return;
+                        }
+                        if (!allowAll) {
+                            const isValid = allowedDomains.some(domain => email.endsWith(domain));
+                            if (!isValid) {
+                                throw new APIError("BAD_REQUEST", {
+                                    message: `Email must end with one of the following: ${allowedDomains.join(', ')}`
+                                });
+                            }
+                        }
+                        const emailDomain = email.split('@')[1];
+                        const adapter = context.context.adapter;
+                        let university = await adapter.findOne({
+                            model: "university",
+                            where: [
+                                {
+                                    field: "domain",
+                                    value: emailDomain
+                                }
+                            ]
+                        });
+                        if (!university) {
+                            const found = options.universities.find(university => university.domains.includes(emailDomain));
+                            if (found) {
+                                university = await adapter.create({
+                                    model: "university",
+                                    data: {
+                                        name: found.name,
+                                        domain: emailDomain,
+                                    }
+                                });
+                            }
+                            else {
+                                university = await adapter.create({
+                                    model: "university",
+                                    data: {
+                                        name: emailDomain,
+                                        domain: emailDomain,
+                                    }
+                                });
+                            }
+                        }
+                        if (university) {
+                            context.body.universityId = university.id;
+                        }
+                    })
+                }
+            ]
+        },
+    };
+};

package/dist/schema.d.ts

@@ -0,0 +1,31 @@
+export declare const getSchema: () => {
+    user: {
+        fields: {
+            universityId: {
+                type: "string";
+                required: false;
+                defaultValue: null;
+                returned: true;
+                references: {
+                    model: string;
+                    field: string;
+                };
+            };
+        };
+    };
+    university: {
+        fields: {
+            name: {
+                type: "string";
+                required: true;
+                returned: true;
+            };
+            domain: {
+                type: "string";
+                required: true;
+                unique: true;
+                returned: true;
+            };
+        };
+    };
+};

package/dist/schema.js

@@ -0,0 +1,33 @@
+export const getSchema = () => {
+    return {
+        user: {
+            fields: {
+                universityId: {
+                    type: "string",
+                    required: false,
+                    defaultValue: null,
+                    returned: true,
+                    references: {
+                        model: "university",
+                        field: "id",
+                    },
+                },
+            },
+        },
+        university: {
+            fields: {
+                name: {
+                    type: "string",
+                    required: true,
+                    returned: true,
+                },
+                domain: {
+                    type: "string",
+                    required: true,
+                    unique: true,
+                    returned: true,
+                },
+            },
+        },
+    };
+};

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "better-auth-university",
+  "version": "0.1.0",
+  "description": "A university plugin for Better Auth that allows restriction of email domains.",
+  "author": "Jaren Goldberg <fyrlex@gmail.com>",
+  "main": "dist/index.js",
+  "type": "module",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/LuyxLLC/better-auth-university.git"
+  },
+  "keywords": [
+    "better-auth",
+    "auth",
+    "plugin",
+    "university"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/LuyxLLC/better-auth-university/issues"
+  },
+  "homepage": "https://github.com/LuyxLLC/better-auth-university#readme",
+  "peerDependencies": {
+    "better-auth": "^1.4.5"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  }
+}