@neondatabase/auth 0.1.0-beta.1 → 0.1.0-beta.10

package/dist/next/index.d.mts

@@ -1,3 +1,4 @@
+import { n as BetterAuthSession, r as BetterAuthUser } from "../better-auth-types-BSQToNou.mjs";
 import * as better_auth_client0 from "better-auth/client";
 import * as better_auth_client_plugins0 from "better-auth/client/plugins";
 import * as jose0 from "jose";
@@ -10,7 +11,26 @@ import * as nanostores0 from "nanostores";
 type Params = {
   path: string[];
 };
-declare const toNextJsHandler: (baseUrl: string) => {
+/**
+ *
+ * An API route handler to handle the auth requests from the client and proxy them to the Neon Auth.
+ *
+ * @returns A Next.js API handler functions those can be used in a Next.js route.
+ *
+ * @example
+ *
+ * Mount the `authApiHandler` to an API route. Create a route file inside `/api/auth/[...all]/route.ts` directory.
+ *  And add the following code:
+ *
+ * ```ts
+ *
+ * import { authApiHandler } from '@neondatabase/auth/next';
+ *
+ * export const { GET, POST } = authApiHandler();
+ * ```
+ *
+ */
+declare function authApiHandler(): {
   GET: (request: Request, {
     params
   }: {
@@ -41,23 +61,50 @@ declare const toNextJsHandler: (baseUrl: string) => {
 //#region src/next/middleware/index.d.ts
 type NeonAuthMiddlewareOptions = {
   loginUrl?: string;
-  /**
-   * The Neon Auth base URL
-   *  Defaults to `process.env.NEON_AUTH_BASE_URL`
-   *
-   * If not provided, and if not in the environment, the middleware will throw an error.
-   *
-   * @throws {Error} If the authURL is not provided and not in the environment.
-   */
-  authBaseUrl?: string;
 };
-declare const neonAuthMiddleware: ({
-  loginUrl,
-  authBaseUrl
-}: NeonAuthMiddlewareOptions) => (request: NextRequest) => Promise<NextResponse<unknown>>;
+/**
+ * A Next.js middleware to protect routes from unauthenticated requests and refresh the session if required.
+ *
+ * @param loginUrl - The URL to redirect to when the user is not authenticated.
+ * @returns A middleware function that can be used in the Next.js app.
+ *
+ * @example
+ * ```ts
+ * import { neonAuthMiddleware } from "@neondatabase/auth/next"
+ *
+ * export default neonAuthMiddleware({
+ *   loginUrl: '/auth/sign-in',
+ * });
+ * ```
+ */
+declare function neonAuthMiddleware({
+  loginUrl
+}: NeonAuthMiddlewareOptions): (request: NextRequest) => Promise<NextResponse<unknown>>;
+//#endregion
+//#region src/next/auth/session.d.ts
+type SessionData = {
+  session: BetterAuthSession;
+  user: BetterAuthUser;
+} | {
+  session: null;
+  user: null;
+};
+/**
+ * A utility function to be used in react server components fetch the session details from the Neon Auth API, if session token is available in cookie.
+ *
+ * @returns - `{ session: Session, user: User }` | `{ session: null, user: null}`.
+ *
+ * @example
+ * ```ts
+ * import { neonAuth } from "@neondatabase/auth/next"
+ *
+ * const { session, user } = await neonAuth()
+ * ```
+ */
+declare const neonAuth: () => Promise<SessionData>;
 //#endregion
 //#region src/next/index.d.ts
-declare const createAuthClient: () => {
+declare function createAuthClient(): {
   useActiveOrganization: () => {
     data: better_auth0.Prettify<{
       id: string;
@@ -351,15 +398,7 @@ declare const createAuthClient: () => {
         ipAddress?: string | null | undefined;
         userAgent?: string | null | undefined;
       };
-      user: {
-        id: string;
-        createdAt: Date;
-        updatedAt: Date;
-        email: string;
-        emailVerified: boolean;
-        name: string;
-        image?: string | null | undefined;
-      };
+      user: better_auth_client_plugins0.UserWithRole;
     }, {
       code?: string | undefined;
       message?: string | undefined;
@@ -990,7 +1029,7 @@ declare const createAuthClient: () => {
         email?: string | undefined;
       } | undefined;
       fetchOptions?: FetchOptions | undefined;
-    }> | undefined, data_1?: FetchOptions | undefined) => Promise<_better_fetch_fetch0.BetterFetchResponse<{
+    }> | undefined, data_1?: FetchOptions | undefined) => Promise<_better_fetch_fetch0.BetterFetchResponse<(Omit<{
       id: string;
       organizationId: string;
       email: string;
@@ -999,7 +1038,18 @@ declare const createAuthClient: () => {
       inviterId: string;
       expiresAt: Date;
       createdAt: Date;
-    }[], {
+    } & {
+      organization: {
+        id: string;
+        name: string;
+        slug: string;
+        createdAt: Date;
+        logo?: string | null | undefined | undefined;
+        metadata?: any;
+      };
+    }, "organization"> & {
+      organizationName: string;
+    })[], {
       code?: string | undefined;
       message?: string | undefined;
     }, FetchOptions["throw"] extends true ? true : false>>;
@@ -1283,156 +1333,6 @@ declare const createAuthClient: () => {
       message?: string | undefined;
     }, FetchOptions["throw"] extends true ? true : false>>;
   };
-} & {
-  signIn: {
-    phoneNumber: <FetchOptions extends better_auth0.ClientFetchOption<Partial<{
-      phoneNumber: string;
-      password: string;
-      rememberMe?: boolean | undefined;
-    }> & Record<string, any>, Partial<Record<string, any>> & Record<string, any>, Record<string, any> | undefined>>(data_0: better_auth0.Prettify<{
-      phoneNumber: string;
-      password: string;
-      rememberMe?: boolean | undefined;
-    } & {
-      fetchOptions?: FetchOptions | undefined;
-    }>, data_1?: FetchOptions | undefined) => Promise<_better_fetch_fetch0.BetterFetchResponse<{
-      token: string;
-      user: better_auth_client_plugins0.UserWithPhoneNumber;
-    }, {
-      code?: string | undefined;
-      message?: string | undefined;
-    }, FetchOptions["throw"] extends true ? true : false>>;
-  };
-} & {
-  phoneNumber: {
-    sendOtp: <FetchOptions extends better_auth0.ClientFetchOption<Partial<{
-      phoneNumber: string;
-    }> & Record<string, any>, Partial<Record<string, any>> & Record<string, any>, Record<string, any> | undefined>>(data_0: better_auth0.Prettify<{
-      phoneNumber: string;
-    } & {
-      fetchOptions?: FetchOptions | undefined;
-    }>, data_1?: FetchOptions | undefined) => Promise<_better_fetch_fetch0.BetterFetchResponse<{
-      message: string;
-    }, {
-      code?: string | undefined;
-      message?: string | undefined;
-    }, FetchOptions["throw"] extends true ? true : false>>;
-  };
-} & {
-  phoneNumber: {
-    verify: <FetchOptions extends better_auth0.ClientFetchOption<Partial<{
-      phoneNumber: string;
-      code: string;
-      disableSession?: boolean | undefined;
-      updatePhoneNumber?: boolean | undefined;
-    }> & Record<string, any>, Partial<Record<string, any>> & Record<string, any>, Record<string, any> | undefined>>(data_0: better_auth0.Prettify<{
-      phoneNumber: string;
-      code: string;
-      disableSession?: boolean | undefined;
-      updatePhoneNumber?: boolean | undefined;
-    } & {
-      fetchOptions?: FetchOptions | undefined;
-    }>, data_1?: FetchOptions | undefined) => Promise<_better_fetch_fetch0.BetterFetchResponse<NonNullable<{
-      status: boolean;
-      token: string;
-      user: better_auth_client_plugins0.UserWithPhoneNumber;
-    } | {
-      status: boolean;
-      token: null;
-      user: better_auth_client_plugins0.UserWithPhoneNumber;
-    }>, {
-      code?: string | undefined;
-      message?: string | undefined;
-    }, FetchOptions["throw"] extends true ? true : false>>;
-  };
-} & {
-  phoneNumber: {
-    requestPasswordReset: <FetchOptions extends better_auth0.ClientFetchOption<Partial<{
-      phoneNumber: string;
-    }> & Record<string, any>, Partial<Record<string, any>> & Record<string, any>, Record<string, any> | undefined>>(data_0: better_auth0.Prettify<{
-      phoneNumber: string;
-    } & {
-      fetchOptions?: FetchOptions | undefined;
-    }>, data_1?: FetchOptions | undefined) => Promise<_better_fetch_fetch0.BetterFetchResponse<{
-      status: boolean;
-    }, {
-      code?: string | undefined;
-      message?: string | undefined;
-    }, FetchOptions["throw"] extends true ? true : false>>;
-  };
-} & {
-  phoneNumber: {
-    resetPassword: <FetchOptions extends better_auth0.ClientFetchOption<Partial<{
-      otp: string;
-      phoneNumber: string;
-      newPassword: string;
-    }> & Record<string, any>, Partial<Record<string, any>> & Record<string, any>, Record<string, any> | undefined>>(data_0: better_auth0.Prettify<{
-      otp: string;
-      phoneNumber: string;
-      newPassword: string;
-    } & {
-      fetchOptions?: FetchOptions | undefined;
-    }>, data_1?: FetchOptions | undefined) => Promise<_better_fetch_fetch0.BetterFetchResponse<{
-      status: boolean;
-    }, {
-      code?: string | undefined;
-      message?: string | undefined;
-    }, FetchOptions["throw"] extends true ? true : false>>;
-  };
-} & {
-  signIn: {
-    magicLink: <FetchOptions extends better_auth0.ClientFetchOption<Partial<{
-      email: string;
-      name?: string | undefined;
-      callbackURL?: string | undefined;
-      newUserCallbackURL?: string | undefined;
-      errorCallbackURL?: string | undefined;
-    }> & Record<string, any>, Partial<Record<string, any>> & Record<string, any>, Record<string, any> | undefined>>(data_0: better_auth0.Prettify<{
-      email: string;
-      name?: string | undefined;
-      callbackURL?: string | undefined;
-      newUserCallbackURL?: string | undefined;
-      errorCallbackURL?: string | undefined;
-    } & {
-      fetchOptions?: FetchOptions | undefined;
-    }>, data_1?: FetchOptions | undefined) => Promise<_better_fetch_fetch0.BetterFetchResponse<{
-      status: boolean;
-    }, {
-      code?: string | undefined;
-      message?: string | undefined;
-    }, FetchOptions["throw"] extends true ? true : false>>;
-  };
-} & {
-  magicLink: {
-    verify: <FetchOptions extends better_auth0.ClientFetchOption<never, Partial<{
-      token: string;
-      callbackURL?: string | undefined;
-      errorCallbackURL?: string | undefined;
-      newUserCallbackURL?: string | undefined;
-    }> & Record<string, any>, Record<string, any> | undefined>>(data_0: better_auth0.Prettify<{
-      query: {
-        token: string;
-        callbackURL?: string | undefined;
-        errorCallbackURL?: string | undefined;
-        newUserCallbackURL?: string | undefined;
-      };
-      fetchOptions?: FetchOptions | undefined;
-    }>, data_1?: FetchOptions | undefined) => Promise<_better_fetch_fetch0.BetterFetchResponse<{
-      token: string;
-      user: {
-        id: string;
-        email: string;
-        emailVerified: boolean;
-        name: string;
-        image: string | null | undefined;
-        createdAt: Date;
-        updatedAt: Date;
-      };
-    }, {
-      code?: string | undefined;
-      message?: string | undefined;
-    }, FetchOptions["throw"] extends true ? true : false>>;
-  };
 } & {
   signIn: {
     social: <FetchOptions extends better_auth0.ClientFetchOption<Partial<{
@@ -1518,9 +1418,7 @@ declare const createAuthClient: () => {
       image?: string | undefined;
       callbackURL?: string | undefined;
       fetchOptions?: FetchOptions | undefined;
-    } & {} & {} & {} & {} & {} & {
-      phoneNumber?: string | null | undefined;
-    }>, data_1?: FetchOptions | undefined) => Promise<_better_fetch_fetch0.BetterFetchResponse<NonNullable<{
+    } & {} & {} & {} & {}>, data_1?: FetchOptions | undefined) => Promise<_better_fetch_fetch0.BetterFetchResponse<NonNullable<{
       token: null;
       user: {
         id: string;
@@ -1676,9 +1574,7 @@ declare const createAuthClient: () => {
     image?: (string | null) | undefined;
     name?: string | undefined;
     fetchOptions?: FetchOptions | undefined;
-  } & Partial<{} & {} & {} & {} & {} & {
-    phoneNumber?: string | null | undefined;
-  }>> | undefined, data_1?: FetchOptions | undefined) => Promise<_better_fetch_fetch0.BetterFetchResponse<{
+  } & Partial<{} & {} & {} & {}>> | undefined, data_1?: FetchOptions | undefined) => Promise<_better_fetch_fetch0.BetterFetchResponse<{
     status: boolean;
   }, {
     code?: string | undefined;
@@ -1957,8 +1853,6 @@ declare const createAuthClient: () => {
       banReason?: string | null | undefined;
       banExpires?: Date | null | undefined;
       isAnonymous: boolean | null | undefined;
-      phoneNumber?: string | null | undefined;
-      phoneNumberVerified?: boolean | null | undefined;
     };
     session: {
       id: string;
@@ -2118,8 +2012,6 @@ declare const createAuthClient: () => {
         banReason?: string | null | undefined;
         banExpires?: Date | null | undefined;
         isAnonymous: boolean | null | undefined;
-        phoneNumber?: string | null | undefined;
-        phoneNumberVerified?: boolean | null | undefined;
       };
       session: {
         id: string;
@@ -2156,8 +2048,6 @@ declare const createAuthClient: () => {
         banReason?: string | null | undefined;
         banExpires?: Date | null | undefined;
         isAnonymous: boolean | null | undefined;
-        phoneNumber?: string | null | undefined;
-        phoneNumberVerified?: boolean | null | undefined;
       };
       session: {
         id: string;
@@ -2264,6 +2154,7 @@ declare const createAuthClient: () => {
     readonly YOU_ARE_NOT_ALLOWED_TO_UPDATE_USERS: "You are not allowed to update users";
     readonly YOU_CANNOT_REMOVE_YOURSELF: "You cannot remove yourself";
     readonly YOU_ARE_NOT_ALLOWED_TO_SET_NON_EXISTENT_VALUE: "You are not allowed to set a non-existent role value";
+    readonly YOU_CANNOT_IMPERSONATE_ADMINS: "You cannot impersonate admins";
     readonly YOU_ARE_NOT_ALLOWED_TO_CREATE_A_NEW_ORGANIZATION: "You are not allowed to create a new organization";
     readonly YOU_HAVE_REACHED_THE_MAXIMUM_NUMBER_OF_ORGANIZATIONS: "You have reached the maximum number of organizations";
     readonly ORGANIZATION_ALREADY_EXISTS: "Organization already exists";
@@ -2326,15 +2217,6 @@ declare const createAuthClient: () => {
     readonly INVALID_EMAIL_FORMAT: "Email was not generated in a valid format";
     readonly COULD_NOT_CREATE_SESSION: "Could not create session";
     readonly ANONYMOUS_USERS_CANNOT_SIGN_IN_AGAIN_ANONYMOUSLY: "Anonymous users cannot sign in again anonymously";
-    readonly INVALID_PHONE_NUMBER: "Invalid phone number";
-    readonly PHONE_NUMBER_EXIST: "Phone number already exists";
-    readonly PHONE_NUMBER_NOT_EXIST: "phone number isn't registered";
-    readonly INVALID_PHONE_NUMBER_OR_PASSWORD: "Invalid phone number or password";
-    readonly UNEXPECTED_ERROR: "Unexpected error";
-    readonly OTP_NOT_FOUND: "OTP not found";
-    readonly PHONE_NUMBER_NOT_VERIFIED: "Phone number not verified";
-    readonly PHONE_NUMBER_CANNOT_BE_UPDATED: "Phone number cannot be updated";
-    readonly SEND_OTP_NOT_IMPLEMENTED: "sendOTP not implemented";
     readonly USER_NOT_FOUND: "User not found";
     readonly FAILED_TO_CREATE_SESSION: "Failed to create session";
     readonly FAILED_TO_UPDATE_USER: "Failed to update user";
@@ -2360,4 +2242,4 @@ declare const createAuthClient: () => {
   };
 };
 //#endregion
-export { createAuthClient, neonAuthMiddleware, toNextJsHandler };
+export { authApiHandler, createAuthClient, neonAuth, neonAuthMiddleware };