better-auth-vercel-geolocation 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 weepaho3
+
+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,72 @@
+# better-auth-vercel-geolocation
+
+A [better-auth](https://www.better-auth.com/) plugin that enriches the auth session with Vercel edge geolocation data. On session create and refresh, it reads the [`x-vercel-ip-*` headers](https://vercel.com/docs/edge-network/headers#x-vercel-ip-city) via `@vercel/functions` server-side and writes the configured fields into the session record — no browser permission prompt, no extra API call.
+
+> [!NOTE]
+> Requires deployment on Vercel. In local development, geo fields will be `undefined`.
+
+## Features
+
+- **Zero-config defaults** — stores city, country, countryRegion and flag out of the box
+- **Configurable fields** — pick exactly which [geo fields](https://vercel.com/docs/edge-network/headers#x-vercel-ip-city) you need
+- **Auto-refresh** — optionally updates geo data when the session refreshes
+
+## Installation
+
+```bash
+npm install better-auth-vercel-geolocation
+```
+
+Requires **better-auth** >= 1.4.18 as a peer dependency.
+
+## Quick start
+
+### 1. Add the plugin to your auth config
+
+```ts
+import { betterAuth } from 'better-auth';
+import { geolocation } from 'better-auth-plugin-vercel-geolocation';
+
+export const auth = betterAuth({
+  plugins: [geolocation()],
+});
+```
+
+### 2. Migrate the database
+
+```bash
+npx @better-auth/cli migrate
+```
+
+### 3. Add the client plugin
+
+```ts
+import { createAuthClient } from 'better-auth/react';
+import { geolocationClient } from 'better-auth-plugin-vercel-geolocation/client';
+
+export const authClient = createAuthClient({
+  plugins: [geolocationClient()],
+});
+```
+
+The session now includes geolocation fields:
+
+```ts
+const { data: session } = authClient.useSession();
+
+session.city; // "Hamburg"
+session.country; // "HH"
+session.countryRegion; // "BE"
+session.flag; // "🇩🇪"
+```
+
+## Options
+
+| Option            | Type                     | Default                                  | Description                                   |
+| ----------------- | ------------------------ | ---------------------------------------- | --------------------------------------------- |
+| `fields`          | `GeolocationFieldConfig` | `{ city, country, countryRegion, flag }` | Which fields to store on the session          |
+| `updateOnRefresh` | `boolean`                | `true`                                   | Update geo data when the session is refreshed |
+
+## License
+
+MIT

package/dist/client.cjs

@@ -0,0 +1,10 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const geolocationClient = ()=>{
+    return {
+        id: 'vercel-geolocation',
+        $InferServerPlugin: {}
+    };
+};
+
+exports.geolocationClient = geolocationClient;

package/dist/client.d.cts

@@ -0,0 +1,92 @@
+import * as better_auth from 'better-auth';
+import { Geo } from '@vercel/functions';
+
+type GeolocationField = keyof Geo;
+type GeolocationFieldConfig = Partial<Record<GeolocationField, boolean>>;
+declare const DEFAULT_FIELDS: {
+    readonly city: true;
+    readonly country: true;
+    readonly countryRegion: true;
+    readonly flag: true;
+};
+type DefaultGeolocationFields = typeof DEFAULT_FIELDS;
+type GeoSchemaFields<T extends GeolocationFieldConfig> = {
+    [K in keyof T & GeolocationField as T[K] extends true ? K : never]: {
+        type: 'string';
+        required: false;
+        input: false;
+    };
+};
+type InferGeoSession<T extends GeolocationFieldConfig> = {
+    [K in keyof T & GeolocationField as T[K] extends true ? K : never]?: string | null;
+};
+interface GeolocationPluginOptions<T extends GeolocationFieldConfig = GeolocationFieldConfig> {
+    /**
+     * Which geolocation fields to store on the session.
+     * @default { city: true, country: true, countryRegion: true, flag: true }
+     */
+    fields?: T;
+    /**
+     * Whether to update session geolocation data when the session is refreshed.
+     * @default true
+     */
+    updateOnRefresh?: boolean;
+}
+
+declare const geolocation: <const T extends GeolocationFieldConfig = DefaultGeolocationFields>(options?: GeolocationPluginOptions<T>) => {
+    id: "vercel-geolocation";
+    schema: {
+        session: {
+            fields: GeoSchemaFields<T>;
+        };
+    };
+    $Infer: {
+        Session: {
+            session: InferGeoSession<T>;
+        };
+    };
+    init(): {
+        options: {
+            databaseHooks: {
+                session: {
+                    create: {
+                        before: (session: {
+                            id: string;
+                            createdAt: Date;
+                            updatedAt: Date;
+                            userId: string;
+                            expiresAt: Date;
+                            token: string;
+                            ipAddress?: string | null | undefined;
+                            userAgent?: string | null | undefined;
+                        } & Record<string, unknown>, ctx: better_auth.GenericEndpointContext | null) => Promise<{
+                            data: Record<string, unknown>;
+                        } | undefined>;
+                    };
+                    update: {
+                        before: (session: Partial<{
+                            id: string;
+                            createdAt: Date;
+                            updatedAt: Date;
+                            userId: string;
+                            expiresAt: Date;
+                            token: string;
+                            ipAddress?: string | null | undefined;
+                            userAgent?: string | null | undefined;
+                        }> & Record<string, unknown>, ctx: better_auth.GenericEndpointContext | null) => Promise<{
+                            data: Record<string, unknown>;
+                        } | undefined>;
+                    };
+                };
+            };
+        };
+    };
+};
+
+declare const geolocationClient: <const T extends GeolocationFieldConfig = DefaultGeolocationFields>() => {
+    id: "vercel-geolocation";
+    $InferServerPlugin: ReturnType<typeof geolocation<T>>;
+};
+
+export { geolocationClient };
+//# sourceMappingURL=client.d.cts.map

package/dist/client.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.cts","sources":["../src/types.ts","../src/geolocation.ts","../src/client.ts"],"sourcesContent":["import type { Geo } from '@vercel/functions';\n\nexport type GeolocationField = keyof Geo;\n\nexport type GeolocationFieldConfig = Partial<Record<GeolocationField, boolean>>;\n\nexport const DEFAULT_FIELDS = {\n  city: true,\n  country: true,\n  countryRegion: true,\n  flag: true,\n} as const satisfies GeolocationFieldConfig;\n\nexport type DefaultGeolocationFields = typeof DEFAULT_FIELDS;\n\nexport type GeoSchemaFields<T extends GeolocationFieldConfig> = {\n  [K in keyof T & GeolocationField as T[K] extends true ? K : never]: {\n    type: 'string';\n    required: false;\n    input: false;\n  };\n};\n\nexport type InferGeoSession<T extends GeolocationFieldConfig> = {\n  [K in keyof T & GeolocationField as T[K] extends true\n    ? K\n    : never]?: string | null;\n};\n\nexport interface GeolocationPluginOptions<\n  T extends GeolocationFieldConfig = GeolocationFieldConfig,\n> {\n  /**\n   * Which geolocation fields to store on the session.\n   * @default { city: true, country: true, countryRegion: true, flag: true }\n   */\n  fields?: T;\n  /**\n   * Whether to update session geolocation data when the session is refreshed.\n   * @default true\n   */\n  updateOnRefresh?: boolean;\n}\n","import type { BetterAuthPlugin } from 'better-auth';\n\nimport { geolocation as extractGeo } from '@vercel/functions';\n\nimport {\n  DEFAULT_FIELDS,\n  type DefaultGeolocationFields,\n  type GeolocationField,\n  type GeolocationFieldConfig,\n  type GeolocationPluginOptions,\n  type GeoSchemaFields,\n  type InferGeoSession,\n} from './types';\n\nexport const geolocation = <\n  const T extends GeolocationFieldConfig = DefaultGeolocationFields,\n>(\n  options?: GeolocationPluginOptions<T>,\n) => {\n  const updateOnRefresh = options?.updateOnRefresh ?? true;\n  const fieldConfig = (options?.fields ?? DEFAULT_FIELDS) as T;\n\n  const activeFields = (Object.keys(fieldConfig) as GeolocationField[]).filter(\n    (field) => fieldConfig[field] === true,\n  );\n\n  const schemaFields = Object.fromEntries(\n    activeFields.map((field) => [\n      field,\n      {\n        type: 'string',\n        required: false,\n        input: false,\n      },\n    ]),\n  ) as GeoSchemaFields<T>;\n\n  function applyGeo(\n    session: Record<string, unknown>,\n    request: Request | undefined,\n  ) {\n    if (!request) return;\n\n    const geo = extractGeo(request);\n    for (const field of activeFields) {\n      session[field] = geo[field];\n    }\n    return { data: session };\n  }\n\n  return {\n    id: 'vercel-geolocation',\n    schema: {\n      session: { fields: schemaFields },\n    },\n    $Infer: {\n      Session: {\n        session: {} as InferGeoSession<T>,\n      },\n    },\n    init() {\n      return {\n        options: {\n          databaseHooks: {\n            session: {\n              create: {\n                before: async (session, ctx) => {\n                  return applyGeo(session, ctx?.request);\n                },\n              },\n              update: {\n                before: async (session, ctx) => {\n                  if (!updateOnRefresh) return;\n                  return applyGeo(session, ctx?.request);\n                },\n              },\n            },\n          },\n        },\n      };\n    },\n  } satisfies BetterAuthPlugin;\n};\n","import type { BetterAuthClientPlugin } from 'better-auth/client';\n\nimport type { geolocation } from './geolocation';\nimport type {\n  DefaultGeolocationFields,\n  GeolocationFieldConfig,\n} from './types';\n\nexport const geolocationClient = <\n  const T extends GeolocationFieldConfig = DefaultGeolocationFields,\n>() => {\n  return {\n    id: 'vercel-geolocation',\n    $InferServerPlugin: {} as ReturnType<typeof geolocation<T>>,\n  } satisfies BetterAuthClientPlugin;\n};\n"],"names":[],"mappings":";;;AACO,KAAA,gBAAA,SAAA,GAAA;AACA,KAAA,sBAAA,GAAA,OAAA,CAAA,MAAA,CAAA,gBAAA;AACA,cAAA,cAAA;AACP;AACA;AACA;AACA;AACA;AACO,KAAA,wBAAA,UAAA,cAAA;AACA,KAAA,eAAA,WAAA,sBAAA;AACP,oBAAA,gBAAA;AACA;AACA;AACA;AACA;AACA;AACO,KAAA,eAAA,WAAA,sBAAA;AACP,oBAAA,gBAAA;AACA;AACO,UAAA,wBAAA,WAAA,sBAAA,GAAA,sBAAA;AACP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AC9BO,cAAA,WAAA,mBAAA,sBAAA,GAAA,wBAAA,YAAA,wBAAA;AACP;AACA;AACA;AACA,oBAAA,eAAA;AACA;AACA;AACA;AACA;AACA,qBAAA,eAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,uCAAA,IAAA;AACA,uCAAA,IAAA;AACA;AACA,uCAAA,IAAA;AACA;AACA;AACA;AACA,4BAAA,MAAA,wBAA0D,WAAqB,CAAA,sBAAA,YAAA,OAAA;AAC/E,kCAAA,MAAA;AACA;AACA;AACA;AACA,0CAAA,OAAA;AACA;AACA,uCAAA,IAAA;AACA,uCAAA,IAAA;AACA;AACA,uCAAA,IAAA;AACA;AACA;AACA;AACA,6BAAA,MAAA,wBAA2D,WAAqB,CAAA,sBAAA,YAAA,OAAA;AAChF,kCAAA,MAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AC/CO,cAAA,iBAAA,mBAAA,sBAAA,GAAA,wBAAA;AACP;AACA,wBAAA,UAAA,QAAA,WAAA;AACA;;;;"}

package/dist/client.d.ts

@@ -0,0 +1,92 @@
+import * as better_auth from 'better-auth';
+import { Geo } from '@vercel/functions';
+
+type GeolocationField = keyof Geo;
+type GeolocationFieldConfig = Partial<Record<GeolocationField, boolean>>;
+declare const DEFAULT_FIELDS: {
+    readonly city: true;
+    readonly country: true;
+    readonly countryRegion: true;
+    readonly flag: true;
+};
+type DefaultGeolocationFields = typeof DEFAULT_FIELDS;
+type GeoSchemaFields<T extends GeolocationFieldConfig> = {
+    [K in keyof T & GeolocationField as T[K] extends true ? K : never]: {
+        type: 'string';
+        required: false;
+        input: false;
+    };
+};
+type InferGeoSession<T extends GeolocationFieldConfig> = {
+    [K in keyof T & GeolocationField as T[K] extends true ? K : never]?: string | null;
+};
+interface GeolocationPluginOptions<T extends GeolocationFieldConfig = GeolocationFieldConfig> {
+    /**
+     * Which geolocation fields to store on the session.
+     * @default { city: true, country: true, countryRegion: true, flag: true }
+     */
+    fields?: T;
+    /**
+     * Whether to update session geolocation data when the session is refreshed.
+     * @default true
+     */
+    updateOnRefresh?: boolean;
+}
+
+declare const geolocation: <const T extends GeolocationFieldConfig = DefaultGeolocationFields>(options?: GeolocationPluginOptions<T>) => {
+    id: "vercel-geolocation";
+    schema: {
+        session: {
+            fields: GeoSchemaFields<T>;
+        };
+    };
+    $Infer: {
+        Session: {
+            session: InferGeoSession<T>;
+        };
+    };
+    init(): {
+        options: {
+            databaseHooks: {
+                session: {
+                    create: {
+                        before: (session: {
+                            id: string;
+                            createdAt: Date;
+                            updatedAt: Date;
+                            userId: string;
+                            expiresAt: Date;
+                            token: string;
+                            ipAddress?: string | null | undefined;
+                            userAgent?: string | null | undefined;
+                        } & Record<string, unknown>, ctx: better_auth.GenericEndpointContext | null) => Promise<{
+                            data: Record<string, unknown>;
+                        } | undefined>;
+                    };
+                    update: {
+                        before: (session: Partial<{
+                            id: string;
+                            createdAt: Date;
+                            updatedAt: Date;
+                            userId: string;
+                            expiresAt: Date;
+                            token: string;
+                            ipAddress?: string | null | undefined;
+                            userAgent?: string | null | undefined;
+                        }> & Record<string, unknown>, ctx: better_auth.GenericEndpointContext | null) => Promise<{
+                            data: Record<string, unknown>;
+                        } | undefined>;
+                    };
+                };
+            };
+        };
+    };
+};
+
+declare const geolocationClient: <const T extends GeolocationFieldConfig = DefaultGeolocationFields>() => {
+    id: "vercel-geolocation";
+    $InferServerPlugin: ReturnType<typeof geolocation<T>>;
+};
+
+export { geolocationClient };
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sources":["../src/types.ts","../src/geolocation.ts","../src/client.ts"],"sourcesContent":["import type { Geo } from '@vercel/functions';\n\nexport type GeolocationField = keyof Geo;\n\nexport type GeolocationFieldConfig = Partial<Record<GeolocationField, boolean>>;\n\nexport const DEFAULT_FIELDS = {\n  city: true,\n  country: true,\n  countryRegion: true,\n  flag: true,\n} as const satisfies GeolocationFieldConfig;\n\nexport type DefaultGeolocationFields = typeof DEFAULT_FIELDS;\n\nexport type GeoSchemaFields<T extends GeolocationFieldConfig> = {\n  [K in keyof T & GeolocationField as T[K] extends true ? K : never]: {\n    type: 'string';\n    required: false;\n    input: false;\n  };\n};\n\nexport type InferGeoSession<T extends GeolocationFieldConfig> = {\n  [K in keyof T & GeolocationField as T[K] extends true\n    ? K\n    : never]?: string | null;\n};\n\nexport interface GeolocationPluginOptions<\n  T extends GeolocationFieldConfig = GeolocationFieldConfig,\n> {\n  /**\n   * Which geolocation fields to store on the session.\n   * @default { city: true, country: true, countryRegion: true, flag: true }\n   */\n  fields?: T;\n  /**\n   * Whether to update session geolocation data when the session is refreshed.\n   * @default true\n   */\n  updateOnRefresh?: boolean;\n}\n","import type { BetterAuthPlugin } from 'better-auth';\n\nimport { geolocation as extractGeo } from '@vercel/functions';\n\nimport {\n  DEFAULT_FIELDS,\n  type DefaultGeolocationFields,\n  type GeolocationField,\n  type GeolocationFieldConfig,\n  type GeolocationPluginOptions,\n  type GeoSchemaFields,\n  type InferGeoSession,\n} from './types';\n\nexport const geolocation = <\n  const T extends GeolocationFieldConfig = DefaultGeolocationFields,\n>(\n  options?: GeolocationPluginOptions<T>,\n) => {\n  const updateOnRefresh = options?.updateOnRefresh ?? true;\n  const fieldConfig = (options?.fields ?? DEFAULT_FIELDS) as T;\n\n  const activeFields = (Object.keys(fieldConfig) as GeolocationField[]).filter(\n    (field) => fieldConfig[field] === true,\n  );\n\n  const schemaFields = Object.fromEntries(\n    activeFields.map((field) => [\n      field,\n      {\n        type: 'string',\n        required: false,\n        input: false,\n      },\n    ]),\n  ) as GeoSchemaFields<T>;\n\n  function applyGeo(\n    session: Record<string, unknown>,\n    request: Request | undefined,\n  ) {\n    if (!request) return;\n\n    const geo = extractGeo(request);\n    for (const field of activeFields) {\n      session[field] = geo[field];\n    }\n    return { data: session };\n  }\n\n  return {\n    id: 'vercel-geolocation',\n    schema: {\n      session: { fields: schemaFields },\n    },\n    $Infer: {\n      Session: {\n        session: {} as InferGeoSession<T>,\n      },\n    },\n    init() {\n      return {\n        options: {\n          databaseHooks: {\n            session: {\n              create: {\n                before: async (session, ctx) => {\n                  return applyGeo(session, ctx?.request);\n                },\n              },\n              update: {\n                before: async (session, ctx) => {\n                  if (!updateOnRefresh) return;\n                  return applyGeo(session, ctx?.request);\n                },\n              },\n            },\n          },\n        },\n      };\n    },\n  } satisfies BetterAuthPlugin;\n};\n","import type { BetterAuthClientPlugin } from 'better-auth/client';\n\nimport type { geolocation } from './geolocation';\nimport type {\n  DefaultGeolocationFields,\n  GeolocationFieldConfig,\n} from './types';\n\nexport const geolocationClient = <\n  const T extends GeolocationFieldConfig = DefaultGeolocationFields,\n>() => {\n  return {\n    id: 'vercel-geolocation',\n    $InferServerPlugin: {} as ReturnType<typeof geolocation<T>>,\n  } satisfies BetterAuthClientPlugin;\n};\n"],"names":[],"mappings":";;;AACO,KAAA,gBAAA,SAAA,GAAA;AACA,KAAA,sBAAA,GAAA,OAAA,CAAA,MAAA,CAAA,gBAAA;AACA,cAAA,cAAA;AACP;AACA;AACA;AACA;AACA;AACO,KAAA,wBAAA,UAAA,cAAA;AACA,KAAA,eAAA,WAAA,sBAAA;AACP,oBAAA,gBAAA;AACA;AACA;AACA;AACA;AACA;AACO,KAAA,eAAA,WAAA,sBAAA;AACP,oBAAA,gBAAA;AACA;AACO,UAAA,wBAAA,WAAA,sBAAA,GAAA,sBAAA;AACP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AC9BO,cAAA,WAAA,mBAAA,sBAAA,GAAA,wBAAA,YAAA,wBAAA;AACP;AACA;AACA;AACA,oBAAA,eAAA;AACA;AACA;AACA;AACA;AACA,qBAAA,eAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,uCAAA,IAAA;AACA,uCAAA,IAAA;AACA;AACA,uCAAA,IAAA;AACA;AACA;AACA;AACA,4BAAA,MAAA,wBAA0D,WAAqB,CAAA,sBAAA,YAAA,OAAA;AAC/E,kCAAA,MAAA;AACA;AACA;AACA;AACA,0CAAA,OAAA;AACA;AACA,uCAAA,IAAA;AACA,uCAAA,IAAA;AACA;AACA,uCAAA,IAAA;AACA;AACA;AACA;AACA,6BAAA,MAAA,wBAA2D,WAAqB,CAAA,sBAAA,YAAA,OAAA;AAChF,kCAAA,MAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AC/CO,cAAA,iBAAA,mBAAA,sBAAA,GAAA,wBAAA;AACP;AACA,wBAAA,UAAA,QAAA,WAAA;AACA;;;;"}

package/dist/client.js

@@ -0,0 +1,8 @@
+const geolocationClient = ()=>{
+    return {
+        id: 'vercel-geolocation',
+        $InferServerPlugin: {}
+    };
+};
+
+export { geolocationClient };

package/dist/index.cjs

@@ -0,0 +1,71 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var functions = require('@vercel/functions');
+
+const DEFAULT_FIELDS = {
+    city: true,
+    country: true,
+    countryRegion: true,
+    flag: true
+};
+
+const geolocation = (options)=>{
+    const updateOnRefresh = options?.updateOnRefresh ?? true;
+    const fieldConfig = options?.fields ?? DEFAULT_FIELDS;
+    const activeFields = Object.keys(fieldConfig).filter((field)=>fieldConfig[field] === true);
+    const schemaFields = Object.fromEntries(activeFields.map((field)=>[
+            field,
+            {
+                type: 'string',
+                required: false,
+                input: false
+            }
+        ]));
+    function applyGeo(session, request) {
+        if (!request) return;
+        const geo = functions.geolocation(request);
+        for (const field of activeFields){
+            session[field] = geo[field];
+        }
+        return {
+            data: session
+        };
+    }
+    return {
+        id: 'vercel-geolocation',
+        schema: {
+            session: {
+                fields: schemaFields
+            }
+        },
+        $Infer: {
+            Session: {
+                session: {}
+            }
+        },
+        init () {
+            return {
+                options: {
+                    databaseHooks: {
+                        session: {
+                            create: {
+                                before: async (session, ctx)=>{
+                                    return applyGeo(session, ctx?.request);
+                                }
+                            },
+                            update: {
+                                before: async (session, ctx)=>{
+                                    if (!updateOnRefresh) return;
+                                    return applyGeo(session, ctx?.request);
+                                }
+                            }
+                        }
+                    }
+                }
+            };
+        }
+    };
+};
+
+exports.DEFAULT_FIELDS = DEFAULT_FIELDS;
+exports.geolocation = geolocation;

package/dist/index.d.cts

@@ -0,0 +1,88 @@
+import * as better_auth from 'better-auth';
+import { Geo } from '@vercel/functions';
+
+type GeolocationField = keyof Geo;
+type GeolocationFieldConfig = Partial<Record<GeolocationField, boolean>>;
+declare const DEFAULT_FIELDS: {
+    readonly city: true;
+    readonly country: true;
+    readonly countryRegion: true;
+    readonly flag: true;
+};
+type DefaultGeolocationFields = typeof DEFAULT_FIELDS;
+type GeoSchemaFields<T extends GeolocationFieldConfig> = {
+    [K in keyof T & GeolocationField as T[K] extends true ? K : never]: {
+        type: 'string';
+        required: false;
+        input: false;
+    };
+};
+type InferGeoSession<T extends GeolocationFieldConfig> = {
+    [K in keyof T & GeolocationField as T[K] extends true ? K : never]?: string | null;
+};
+interface GeolocationPluginOptions<T extends GeolocationFieldConfig = GeolocationFieldConfig> {
+    /**
+     * Which geolocation fields to store on the session.
+     * @default { city: true, country: true, countryRegion: true, flag: true }
+     */
+    fields?: T;
+    /**
+     * Whether to update session geolocation data when the session is refreshed.
+     * @default true
+     */
+    updateOnRefresh?: boolean;
+}
+
+declare const geolocation: <const T extends GeolocationFieldConfig = DefaultGeolocationFields>(options?: GeolocationPluginOptions<T>) => {
+    id: "vercel-geolocation";
+    schema: {
+        session: {
+            fields: GeoSchemaFields<T>;
+        };
+    };
+    $Infer: {
+        Session: {
+            session: InferGeoSession<T>;
+        };
+    };
+    init(): {
+        options: {
+            databaseHooks: {
+                session: {
+                    create: {
+                        before: (session: {
+                            id: string;
+                            createdAt: Date;
+                            updatedAt: Date;
+                            userId: string;
+                            expiresAt: Date;
+                            token: string;
+                            ipAddress?: string | null | undefined;
+                            userAgent?: string | null | undefined;
+                        } & Record<string, unknown>, ctx: better_auth.GenericEndpointContext | null) => Promise<{
+                            data: Record<string, unknown>;
+                        } | undefined>;
+                    };
+                    update: {
+                        before: (session: Partial<{
+                            id: string;
+                            createdAt: Date;
+                            updatedAt: Date;
+                            userId: string;
+                            expiresAt: Date;
+                            token: string;
+                            ipAddress?: string | null | undefined;
+                            userAgent?: string | null | undefined;
+                        }> & Record<string, unknown>, ctx: better_auth.GenericEndpointContext | null) => Promise<{
+                            data: Record<string, unknown>;
+                        } | undefined>;
+                    };
+                };
+            };
+        };
+    };
+};
+
+export { DEFAULT_FIELDS, geolocation };
+export type { DefaultGeolocationFields, GeoSchemaFields, GeolocationField, GeolocationFieldConfig, GeolocationPluginOptions, InferGeoSession };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sources":["../src/types.ts","../src/geolocation.ts"],"sourcesContent":["import type { Geo } from '@vercel/functions';\n\nexport type GeolocationField = keyof Geo;\n\nexport type GeolocationFieldConfig = Partial<Record<GeolocationField, boolean>>;\n\nexport const DEFAULT_FIELDS = {\n  city: true,\n  country: true,\n  countryRegion: true,\n  flag: true,\n} as const satisfies GeolocationFieldConfig;\n\nexport type DefaultGeolocationFields = typeof DEFAULT_FIELDS;\n\nexport type GeoSchemaFields<T extends GeolocationFieldConfig> = {\n  [K in keyof T & GeolocationField as T[K] extends true ? K : never]: {\n    type: 'string';\n    required: false;\n    input: false;\n  };\n};\n\nexport type InferGeoSession<T extends GeolocationFieldConfig> = {\n  [K in keyof T & GeolocationField as T[K] extends true\n    ? K\n    : never]?: string | null;\n};\n\nexport interface GeolocationPluginOptions<\n  T extends GeolocationFieldConfig = GeolocationFieldConfig,\n> {\n  /**\n   * Which geolocation fields to store on the session.\n   * @default { city: true, country: true, countryRegion: true, flag: true }\n   */\n  fields?: T;\n  /**\n   * Whether to update session geolocation data when the session is refreshed.\n   * @default true\n   */\n  updateOnRefresh?: boolean;\n}\n","import type { BetterAuthPlugin } from 'better-auth';\n\nimport { geolocation as extractGeo } from '@vercel/functions';\n\nimport {\n  DEFAULT_FIELDS,\n  type DefaultGeolocationFields,\n  type GeolocationField,\n  type GeolocationFieldConfig,\n  type GeolocationPluginOptions,\n  type GeoSchemaFields,\n  type InferGeoSession,\n} from './types';\n\nexport const geolocation = <\n  const T extends GeolocationFieldConfig = DefaultGeolocationFields,\n>(\n  options?: GeolocationPluginOptions<T>,\n) => {\n  const updateOnRefresh = options?.updateOnRefresh ?? true;\n  const fieldConfig = (options?.fields ?? DEFAULT_FIELDS) as T;\n\n  const activeFields = (Object.keys(fieldConfig) as GeolocationField[]).filter(\n    (field) => fieldConfig[field] === true,\n  );\n\n  const schemaFields = Object.fromEntries(\n    activeFields.map((field) => [\n      field,\n      {\n        type: 'string',\n        required: false,\n        input: false,\n      },\n    ]),\n  ) as GeoSchemaFields<T>;\n\n  function applyGeo(\n    session: Record<string, unknown>,\n    request: Request | undefined,\n  ) {\n    if (!request) return;\n\n    const geo = extractGeo(request);\n    for (const field of activeFields) {\n      session[field] = geo[field];\n    }\n    return { data: session };\n  }\n\n  return {\n    id: 'vercel-geolocation',\n    schema: {\n      session: { fields: schemaFields },\n    },\n    $Infer: {\n      Session: {\n        session: {} as InferGeoSession<T>,\n      },\n    },\n    init() {\n      return {\n        options: {\n          databaseHooks: {\n            session: {\n              create: {\n                before: async (session, ctx) => {\n                  return applyGeo(session, ctx?.request);\n                },\n              },\n              update: {\n                before: async (session, ctx) => {\n                  if (!updateOnRefresh) return;\n                  return applyGeo(session, ctx?.request);\n                },\n              },\n            },\n          },\n        },\n      };\n    },\n  } satisfies BetterAuthPlugin;\n};\n"],"names":[],"mappings":";;;AACO,KAAA,gBAAA,SAAA,GAAA;AACA,KAAA,sBAAA,GAAA,OAAA,CAAA,MAAA,CAAA,gBAAA;AACA,cAAA,cAAA;AACP;AACA;AACA;AACA;AACA;AACO,KAAA,wBAAA,UAAA,cAAA;AACA,KAAA,eAAA,WAAA,sBAAA;AACP,oBAAA,gBAAA;AACA;AACA;AACA;AACA;AACA;AACO,KAAA,eAAA,WAAA,sBAAA;AACP,oBAAA,gBAAA;AACA;AACO,UAAA,wBAAA,WAAA,sBAAA,GAAA,sBAAA;AACP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AC9BO,cAAA,WAAA,mBAAA,sBAAA,GAAA,wBAAA,YAAA,wBAAA;AACP;AACA;AACA;AACA,oBAAA,eAAA;AACA;AACA;AACA;AACA;AACA,qBAAA,eAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,uCAAA,IAAA;AACA,uCAAA,IAAA;AACA;AACA,uCAAA,IAAA;AACA;AACA;AACA;AACA,4BAAA,MAAA,wBAA0D,WAAqB,CAAA,sBAAA,YAAA,OAAA;AAC/E,kCAAA,MAAA;AACA;AACA;AACA;AACA,0CAAA,OAAA;AACA;AACA,uCAAA,IAAA;AACA,uCAAA,IAAA;AACA;AACA,uCAAA,IAAA;AACA;AACA;AACA;AACA,6BAAA,MAAA,wBAA2D,WAAqB,CAAA,sBAAA,YAAA,OAAA;AAChF,kCAAA,MAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,88 @@
+import * as better_auth from 'better-auth';
+import { Geo } from '@vercel/functions';
+
+type GeolocationField = keyof Geo;
+type GeolocationFieldConfig = Partial<Record<GeolocationField, boolean>>;
+declare const DEFAULT_FIELDS: {
+    readonly city: true;
+    readonly country: true;
+    readonly countryRegion: true;
+    readonly flag: true;
+};
+type DefaultGeolocationFields = typeof DEFAULT_FIELDS;
+type GeoSchemaFields<T extends GeolocationFieldConfig> = {
+    [K in keyof T & GeolocationField as T[K] extends true ? K : never]: {
+        type: 'string';
+        required: false;
+        input: false;
+    };
+};
+type InferGeoSession<T extends GeolocationFieldConfig> = {
+    [K in keyof T & GeolocationField as T[K] extends true ? K : never]?: string | null;
+};
+interface GeolocationPluginOptions<T extends GeolocationFieldConfig = GeolocationFieldConfig> {
+    /**
+     * Which geolocation fields to store on the session.
+     * @default { city: true, country: true, countryRegion: true, flag: true }
+     */
+    fields?: T;
+    /**
+     * Whether to update session geolocation data when the session is refreshed.
+     * @default true
+     */
+    updateOnRefresh?: boolean;
+}
+
+declare const geolocation: <const T extends GeolocationFieldConfig = DefaultGeolocationFields>(options?: GeolocationPluginOptions<T>) => {
+    id: "vercel-geolocation";
+    schema: {
+        session: {
+            fields: GeoSchemaFields<T>;
+        };
+    };
+    $Infer: {
+        Session: {
+            session: InferGeoSession<T>;
+        };
+    };
+    init(): {
+        options: {
+            databaseHooks: {
+                session: {
+                    create: {
+                        before: (session: {
+                            id: string;
+                            createdAt: Date;
+                            updatedAt: Date;
+                            userId: string;
+                            expiresAt: Date;
+                            token: string;
+                            ipAddress?: string | null | undefined;
+                            userAgent?: string | null | undefined;
+                        } & Record<string, unknown>, ctx: better_auth.GenericEndpointContext | null) => Promise<{
+                            data: Record<string, unknown>;
+                        } | undefined>;
+                    };
+                    update: {
+                        before: (session: Partial<{
+                            id: string;
+                            createdAt: Date;
+                            updatedAt: Date;
+                            userId: string;
+                            expiresAt: Date;
+                            token: string;
+                            ipAddress?: string | null | undefined;
+                            userAgent?: string | null | undefined;
+                        }> & Record<string, unknown>, ctx: better_auth.GenericEndpointContext | null) => Promise<{
+                            data: Record<string, unknown>;
+                        } | undefined>;
+                    };
+                };
+            };
+        };
+    };
+};
+
+export { DEFAULT_FIELDS, geolocation };
+export type { DefaultGeolocationFields, GeoSchemaFields, GeolocationField, GeolocationFieldConfig, GeolocationPluginOptions, InferGeoSession };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sources":["../src/types.ts","../src/geolocation.ts"],"sourcesContent":["import type { Geo } from '@vercel/functions';\n\nexport type GeolocationField = keyof Geo;\n\nexport type GeolocationFieldConfig = Partial<Record<GeolocationField, boolean>>;\n\nexport const DEFAULT_FIELDS = {\n  city: true,\n  country: true,\n  countryRegion: true,\n  flag: true,\n} as const satisfies GeolocationFieldConfig;\n\nexport type DefaultGeolocationFields = typeof DEFAULT_FIELDS;\n\nexport type GeoSchemaFields<T extends GeolocationFieldConfig> = {\n  [K in keyof T & GeolocationField as T[K] extends true ? K : never]: {\n    type: 'string';\n    required: false;\n    input: false;\n  };\n};\n\nexport type InferGeoSession<T extends GeolocationFieldConfig> = {\n  [K in keyof T & GeolocationField as T[K] extends true\n    ? K\n    : never]?: string | null;\n};\n\nexport interface GeolocationPluginOptions<\n  T extends GeolocationFieldConfig = GeolocationFieldConfig,\n> {\n  /**\n   * Which geolocation fields to store on the session.\n   * @default { city: true, country: true, countryRegion: true, flag: true }\n   */\n  fields?: T;\n  /**\n   * Whether to update session geolocation data when the session is refreshed.\n   * @default true\n   */\n  updateOnRefresh?: boolean;\n}\n","import type { BetterAuthPlugin } from 'better-auth';\n\nimport { geolocation as extractGeo } from '@vercel/functions';\n\nimport {\n  DEFAULT_FIELDS,\n  type DefaultGeolocationFields,\n  type GeolocationField,\n  type GeolocationFieldConfig,\n  type GeolocationPluginOptions,\n  type GeoSchemaFields,\n  type InferGeoSession,\n} from './types';\n\nexport const geolocation = <\n  const T extends GeolocationFieldConfig = DefaultGeolocationFields,\n>(\n  options?: GeolocationPluginOptions<T>,\n) => {\n  const updateOnRefresh = options?.updateOnRefresh ?? true;\n  const fieldConfig = (options?.fields ?? DEFAULT_FIELDS) as T;\n\n  const activeFields = (Object.keys(fieldConfig) as GeolocationField[]).filter(\n    (field) => fieldConfig[field] === true,\n  );\n\n  const schemaFields = Object.fromEntries(\n    activeFields.map((field) => [\n      field,\n      {\n        type: 'string',\n        required: false,\n        input: false,\n      },\n    ]),\n  ) as GeoSchemaFields<T>;\n\n  function applyGeo(\n    session: Record<string, unknown>,\n    request: Request | undefined,\n  ) {\n    if (!request) return;\n\n    const geo = extractGeo(request);\n    for (const field of activeFields) {\n      session[field] = geo[field];\n    }\n    return { data: session };\n  }\n\n  return {\n    id: 'vercel-geolocation',\n    schema: {\n      session: { fields: schemaFields },\n    },\n    $Infer: {\n      Session: {\n        session: {} as InferGeoSession<T>,\n      },\n    },\n    init() {\n      return {\n        options: {\n          databaseHooks: {\n            session: {\n              create: {\n                before: async (session, ctx) => {\n                  return applyGeo(session, ctx?.request);\n                },\n              },\n              update: {\n                before: async (session, ctx) => {\n                  if (!updateOnRefresh) return;\n                  return applyGeo(session, ctx?.request);\n                },\n              },\n            },\n          },\n        },\n      };\n    },\n  } satisfies BetterAuthPlugin;\n};\n"],"names":[],"mappings":";;;AACO,KAAA,gBAAA,SAAA,GAAA;AACA,KAAA,sBAAA,GAAA,OAAA,CAAA,MAAA,CAAA,gBAAA;AACA,cAAA,cAAA;AACP;AACA;AACA;AACA;AACA;AACO,KAAA,wBAAA,UAAA,cAAA;AACA,KAAA,eAAA,WAAA,sBAAA;AACP,oBAAA,gBAAA;AACA;AACA;AACA;AACA;AACA;AACO,KAAA,eAAA,WAAA,sBAAA;AACP,oBAAA,gBAAA;AACA;AACO,UAAA,wBAAA,WAAA,sBAAA,GAAA,sBAAA;AACP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AC9BO,cAAA,WAAA,mBAAA,sBAAA,GAAA,wBAAA,YAAA,wBAAA;AACP;AACA;AACA;AACA,oBAAA,eAAA;AACA;AACA;AACA;AACA;AACA,qBAAA,eAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,uCAAA,IAAA;AACA,uCAAA,IAAA;AACA;AACA,uCAAA,IAAA;AACA;AACA;AACA;AACA,4BAAA,MAAA,wBAA0D,WAAqB,CAAA,sBAAA,YAAA,OAAA;AAC/E,kCAAA,MAAA;AACA;AACA;AACA;AACA,0CAAA,OAAA;AACA;AACA,uCAAA,IAAA;AACA,uCAAA,IAAA;AACA;AACA,uCAAA,IAAA;AACA;AACA;AACA;AACA,6BAAA,MAAA,wBAA2D,WAAqB,CAAA,sBAAA,YAAA,OAAA;AAChF,kCAAA,MAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;"}

package/dist/index.js

@@ -0,0 +1,68 @@
+import { geolocation as geolocation$1 } from '@vercel/functions';
+
+const DEFAULT_FIELDS = {
+    city: true,
+    country: true,
+    countryRegion: true,
+    flag: true
+};
+
+const geolocation = (options)=>{
+    const updateOnRefresh = options?.updateOnRefresh ?? true;
+    const fieldConfig = options?.fields ?? DEFAULT_FIELDS;
+    const activeFields = Object.keys(fieldConfig).filter((field)=>fieldConfig[field] === true);
+    const schemaFields = Object.fromEntries(activeFields.map((field)=>[
+            field,
+            {
+                type: 'string',
+                required: false,
+                input: false
+            }
+        ]));
+    function applyGeo(session, request) {
+        if (!request) return;
+        const geo = geolocation$1(request);
+        for (const field of activeFields){
+            session[field] = geo[field];
+        }
+        return {
+            data: session
+        };
+    }
+    return {
+        id: 'vercel-geolocation',
+        schema: {
+            session: {
+                fields: schemaFields
+            }
+        },
+        $Infer: {
+            Session: {
+                session: {}
+            }
+        },
+        init () {
+            return {
+                options: {
+                    databaseHooks: {
+                        session: {
+                            create: {
+                                before: async (session, ctx)=>{
+                                    return applyGeo(session, ctx?.request);
+                                }
+                            },
+                            update: {
+                                before: async (session, ctx)=>{
+                                    if (!updateOnRefresh) return;
+                                    return applyGeo(session, ctx?.request);
+                                }
+                            }
+                        }
+                    }
+                }
+            };
+        }
+    };
+};
+
+export { DEFAULT_FIELDS, geolocation };

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "better-auth-vercel-geolocation",
+  "version": "0.1.0",
+  "description": "A better-auth plugin that enriches sessions with Vercel edge geolocation data.",
+  "license": "MIT",
+  "homepage": "https://github.com/weepaho3/better-auth-vercel-geolocation",
+  "bugs": {
+    "url": "https://github.com/weepaho3/better-auth-vercel-geolocation/issues"
+  },
+  "author": {
+    "name": "weepaho3",
+    "url": "https://github.com/weepaho3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/weepaho3/better-auth-vercel-geolocation.git"
+  },
+  "keywords": [
+    "better-auth",
+    "better-auth-plugin",
+    "vercel",
+    "geolocation",
+    "session",
+    "nextjs"
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./client": {
+      "import": {
+        "types": "./dist/client.d.ts",
+        "default": "./dist/client.js"
+      },
+      "require": {
+        "types": "./dist/client.d.cts",
+        "default": "./dist/client.cjs"
+      }
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "bunchee",
+    "clean": "rm -rf dist",
+    "type-check": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@vercel/functions": "^3.4.3"
+  },
+  "devDependencies": {
+    "bunchee": "^6.9.3",
+    "typescript": "^5.7.2"
+  },
+  "peerDependencies": {
+    "better-auth": "^1.4.18"
+  }
+}