@niledatabase/react 4.0.0-alpha.9 → 4.0.0

package/dist/index.d.ts

@@ -1,148 +1,40 @@
-import * as React from 'react';
+import * as React$1 from 'react';
 import React__default from 'react';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { QueryClient } from '@tanstack/react-query';
-import * as next_auth_react from 'next-auth/react';
-import { SignInOptions, LiteralUnion, ClientSafeProvider, SignOutParams, SignOutResponse, SignInAuthorizationParams, SignInResponse, UseSessionOptions } from 'next-auth/react';
+import { IncomingMessage } from 'http';
 import * as class_variance_authority_dist_types from 'class-variance-authority/dist/types';
 import { VariantProps } from 'class-variance-authority';
-import { CreateBasicUserRequest } from '@niledatabase/browser';
-import { CtxOrReq } from 'next-auth/client/_utils';
-import { BuiltInProviderType, RedirectableProviderType } from 'next-auth/providers/index';
 
-type EmailSignInInfo = SignInOptions;
-type SignInSuccess = (response: Response) => void;
-type AllowedAny$3 = any;
-type Props$5 = {
-    redirect?: boolean;
-    onSuccess?: SignInSuccess;
-    onError?: (e: Error, info: EmailSignInInfo) => void;
-    beforeMutate?: (data: AllowedAny$3) => AllowedAny$3;
-    buttonText?: string;
-    client?: QueryClient;
-    callbackUrl?: string;
-    init?: RequestInit;
-};
-
-declare function EmailSigningIn(props: Props$5): React__default.JSX.Element;
-
-declare const buttonVariants: (props?: ({
-    variant?: "default" | "link" | "destructive" | "outline" | "secondary" | "ghost" | null | undefined;
-    size?: "default" | "sm" | "lg" | "icon" | null | undefined;
-} & class_variance_authority_dist_types.ClassProp) | undefined) => string;
-interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement>, VariantProps<typeof buttonVariants> {
-    asChild?: boolean;
-    loading?: boolean;
-}
-
-type EmailError = void | {
-    error: string;
-    ok: boolean;
+interface SignInResponse$1 {
+    error: string | null;
     status: number;
-    url: null | string;
-};
-type AllProps = ButtonProps & {
+    ok: boolean;
+    url: string | null;
+}
+type LiteralUnion<T extends U, U = string> = T | (U & Record<never, never>);
+interface SignInOptions extends Record<string, unknown> {
+    /**
+     * Specify to which URL the user will be redirected after signing in. Defaults to the page URL the sign-in is initiated from.
+     *
+     * [Documentation](https://next-auth.js.org/getting-started/client#specifying-a-callbackurl)
+     */
     callbackUrl?: string;
+    /** [Documentation](https://next-auth.js.org/getting-started/client#using-the-redirect-false-option) */
     redirect?: boolean;
-    email: string;
-    onSent?: () => void;
-    onFailure?: (error: EmailError) => void;
-    buttonText?: string;
-};
-/**
- * This works when the email identity provider is configured in the admin dashboard.
- * @param props callbackUrl: the url to send the user to from their email
- * @param props redirect: redirect to the default (unbranded) 'check your email' page. default is false
- * @param props email:  the email to send to
- * @param props onSent:  called if the email was sent
- * @param props onFailure:  called if there was a reportable
- * @returns a JSX.Element to render
- */
-declare const EmailSignInButton: {
-    ({ callbackUrl, className, variant, size, asChild, redirect, buttonText, email, onFailure, onSent, ...props }: AllProps): React__default.JSX.Element;
-    displayName: string;
-};
-
-declare function useEmailSignIn(params?: Props$5): _tanstack_react_query.UseMutateFunction<Response, Error, next_auth_react.SignInOptions, unknown>;
-
-/**
- * A component for a Google login button, according to their design language.
- * This works when an identity provider is configured in the admin dashboard.
- * @param props callbackUrl: a string to override the URL provided by the context
- * @returns a JSX.Element to render
- */
-declare const GoogleSSOButton: {
-    ({ callbackUrl, className, variant, size, buttonText, asChild, init, ...props }: ButtonProps & {
-        callbackUrl?: string;
-        buttonText?: string;
-        init?: RequestInit;
-    }): React__default.JSX.Element;
-    displayName: string;
-};
-
-declare const AzureSignInButton: {
-    ({ callbackUrl, className, buttonText, variant, size, init, asChild, ...props }: ButtonProps & {
-        callbackUrl?: string;
-        buttonText?: string;
-        init?: RequestInit;
-    }): React__default.JSX.Element;
-    displayName: string;
-};
-
-declare const DiscordSignInButton: {
-    ({ callbackUrl, className, buttonText, variant, size, asChild, init, ...props }: ButtonProps & {
-        callbackUrl?: string;
-        buttonText?: string;
-        init?: RequestInit;
-    }): React__default.JSX.Element;
-    displayName: string;
-};
-
-declare const GitHubSignInButton: {
-    ({ callbackUrl, className, buttonText, variant, size, init, asChild, ...props }: ButtonProps & {
-        callbackUrl?: string;
-        buttonText?: string;
-        init?: RequestInit;
-    }): React__default.JSX.Element;
-    displayName: string;
-};
-
-declare const HubSpotSignInButton: {
-    ({ callbackUrl, className, buttonText, variant, size, init, asChild, ...props }: ButtonProps & {
-        callbackUrl?: string;
-        buttonText?: string;
-        init?: RequestInit;
-    }): React__default.JSX.Element;
-    displayName: string;
-};
-
-declare const LinkedInSignInButton: {
-    ({ callbackUrl, className, buttonText, variant, size, asChild, init, ...props }: ButtonProps & {
-        callbackUrl?: string;
-        buttonText?: string;
-        init?: RequestInit;
-    }): React__default.JSX.Element;
-    displayName: string;
-};
-
-declare const SlackSignInButton: {
-    ({ callbackUrl, className, buttonText, variant, size, init, asChild, ...props }: ButtonProps & {
-        callbackUrl?: string;
-        buttonText?: string;
-        init?: RequestInit;
-    }): React__default.JSX.Element;
-    displayName: string;
-};
-
-declare const XSignInButton: {
-    ({ callbackUrl, className, buttonText, variant, size, init, asChild, ...props }: ButtonProps & {
-        callbackUrl?: string;
-        buttonText?: string;
-        init?: RequestInit;
-    }): React__default.JSX.Element;
-    displayName: string;
-};
-
+}
+type SignInAuthorizationParams = string | string[][] | Record<string, string> | URLSearchParams;
+type ProviderType = 'oauth' | 'email' | 'credentials';
+interface ClientSafeProvider {
+    id: LiteralUnion<BuiltInProviderType>;
+    name: string;
+    type: ProviderType;
+    signinUrl: string;
+    callbackUrl: string;
+}
+type RedirectableProviderType = 'email' | 'credentials';
+type OAuthProviderType = 'linkedin' | 'hubspot' | 'google' | 'azure-ad' | 'slack' | 'github' | 'twitter' | 'discord';
+type BuiltInProviderType = RedirectableProviderType | OAuthProviderType;
 type JWT = {
     email: string;
     sub: string;
@@ -202,6 +94,48 @@ type PartialAuthorizer = null | {
     };
     requestInit?: RequestInit | undefined;
 };
+interface CtxOrReq {
+    req?: Partial<IncomingMessage> & {
+        body?: any;
+    };
+    ctx?: {
+        req: Partial<IncomingMessage> & {
+            body?: any;
+        };
+    };
+}
+interface SignOutParams<R extends boolean = true> {
+    callbackUrl?: string;
+    redirect?: R;
+}
+interface SignOutResponse {
+    url: string;
+}
+
+type EmailSignInInfo = SignInOptions;
+type SignInSuccess = (response: Response) => void;
+type AllowedAny$3 = any;
+type Props$5 = {
+    redirect?: boolean;
+    onSuccess?: SignInSuccess;
+    onError?: (e: Error, info: EmailSignInInfo) => void;
+    beforeMutate?: (data: AllowedAny$3) => AllowedAny$3;
+    buttonText?: string;
+    client?: QueryClient;
+    callbackUrl?: string;
+    init?: RequestInit;
+};
+
+declare function EmailSigningIn(props: Props$5): React__default.JSX.Element;
+
+declare const buttonVariants: (props?: ({
+    variant?: "default" | "link" | "destructive" | "outline" | "secondary" | "ghost" | null | undefined;
+    size?: "default" | "sm" | "lg" | "icon" | null | undefined;
+} & class_variance_authority_dist_types.ClassProp) | undefined) => string;
+interface ButtonProps extends React$1.ButtonHTMLAttributes<HTMLButtonElement>, VariantProps<typeof buttonVariants> {
+    asChild?: boolean;
+    loading?: boolean;
+}
 
 type WarningCode = 'NEXTAUTH_URL' | 'NO_SECRET' | 'TWITTER_OAUTH_2_BETA' | 'DEBUG_ENABLED';
 /**
@@ -277,7 +211,7 @@ declare class Authorizer {
         init?: ResponseInit;
         fetchUrl?: string;
         auth?: Authorizer | PartialAuthorizer;
-    }, authorizationParams?: SignInAuthorizationParams): Promise<P extends RedirectableProviderType ? SignInResponse | undefined : undefined>;
+    }, authorizationParams?: SignInAuthorizationParams): Promise<P extends RedirectableProviderType ? SignInResponse$1 | undefined : undefined>;
     signUp(options: {
         baseUrl?: string;
         init?: ResponseInit;
@@ -300,6 +234,102 @@ declare const getProviders: () => Promise<Record<LiteralUnion<BuiltInProviderTyp
 declare const signOut: typeof authorizer.signOut;
 declare const signIn: typeof authorizer.signIn;
 
+interface SignInResponse {
+    error: string | null;
+    status: number;
+    ok: boolean;
+    url: string | null;
+}
+type SSOButtonProps = {
+    callbackUrl?: string;
+    buttonText?: string;
+    init?: RequestInit;
+    baseUrl?: string;
+    fetchUrl?: string;
+    auth?: Authorizer | PartialAuthorizer;
+    onClick?: (e: React.MouseEvent<HTMLButtonElement, MouseEvent>, res: SignInResponse | undefined) => void;
+};
+
+type EmailError = void | {
+    error: string;
+    ok: boolean;
+    status: number;
+    url: null | string;
+};
+type AllProps = ButtonProps & SSOButtonProps & {
+    callbackUrl?: string;
+    redirect?: boolean;
+    email: string;
+    onSent?: () => void;
+    onFailure?: (error: EmailError) => void;
+    buttonText?: string;
+};
+/**
+ * This works when the email identity provider is configured in the admin dashboard.
+ * @param props callbackUrl: the url to send the user to from their email
+ * @param props redirect: redirect to the default (unbranded) 'check your email' page. default is false
+ * @param props email:  the email to send to
+ * @param props onSent:  called if the email was sent
+ * @param props onFailure:  called if there was a reportable
+ * @returns a JSX.Element to render
+ */
+declare const EmailSignInButton: {
+    ({ callbackUrl, className, variant, size, asChild, redirect, buttonText, email, onFailure, onSent, fetchUrl, baseUrl, auth, ...props }: AllProps): React__default.JSX.Element;
+    displayName: string;
+};
+
+declare function useEmailSignIn(params?: Props$5): _tanstack_react_query.UseMutateFunction<Response, Error, SignInOptions, unknown>;
+
+/**
+ * A component for a Google login button, according to their design language.
+ * This works when an identity provider is configured in the admin dashboard.
+ * @param props callbackUrl: a string to override the URL provided by the context
+ * @returns a JSX.Element to render
+ */
+declare const GoogleSSOButton: {
+    ({ callbackUrl, className, variant, size, buttonText, asChild, init, auth, fetchUrl, baseUrl, ...props }: ButtonProps & SSOButtonProps): React__default.JSX.Element;
+    displayName: string;
+};
+
+declare const AzureSignInButton: {
+    ({ callbackUrl, className, buttonText, variant, size, init, asChild, auth, fetchUrl, baseUrl, ...props }: ButtonProps & SSOButtonProps): React__default.JSX.Element;
+    displayName: string;
+};
+
+declare const DiscordSignInButton: {
+    ({ callbackUrl, className, buttonText, variant, size, asChild, init, auth, fetchUrl, baseUrl, ...props }: ButtonProps & SSOButtonProps): React__default.JSX.Element;
+    displayName: string;
+};
+
+declare const GitHubSignInButton: {
+    ({ callbackUrl, className, buttonText, variant, size, init, asChild, auth, fetchUrl, baseUrl, ...props }: ButtonProps & SSOButtonProps): React__default.JSX.Element;
+    displayName: string;
+};
+
+declare const HubSpotSignInButton: {
+    ({ callbackUrl, className, buttonText, variant, size, init, asChild, auth, fetchUrl, baseUrl, ...props }: ButtonProps & SSOButtonProps): React__default.JSX.Element;
+    displayName: string;
+};
+
+declare const LinkedInSignInButton: {
+    ({ callbackUrl, className, buttonText, variant, size, asChild, init, auth, fetchUrl, baseUrl, ...props }: ButtonProps & SSOButtonProps): React__default.JSX.Element;
+    displayName: string;
+};
+
+declare const SlackSignInButton: {
+    ({ callbackUrl, className, buttonText, variant, size, init, asChild, ...props }: ButtonProps & {
+        callbackUrl?: string;
+        buttonText?: string;
+        init?: RequestInit;
+    }): React__default.JSX.Element;
+    displayName: string;
+};
+
+declare const XSignInButton: {
+    ({ callbackUrl, className, buttonText, variant, size, init, asChild, auth, fetchUrl, baseUrl, ...props }: ButtonProps & SSOButtonProps): React__default.JSX.Element;
+    displayName: string;
+};
+
 type ComponentFetchProps = {
     auth?: Authorizer | PartialAuthorizer;
     init?: RequestInit;
@@ -312,6 +342,12 @@ type PrefetchParams = {
     fetchUrl?: string;
 };
 
+interface CreateBasicUserRequest {
+    email: string;
+    password: string;
+    preferredName?: string;
+    newTenant?: string;
+}
 type SignUpInfo = CreateBasicUserRequest & {
     tenantId?: string;
     fetchUrl?: string;
@@ -353,7 +389,7 @@ type Props$3 = ComponentFetchProps & {
 
 declare function SigningIn({ className, ...props }: Props$3): React__default.JSX.Element;
 
-declare function useSignIn(params?: Props$3): _tanstack_react_query.UseMutateFunction<next_auth_react.SignInResponse | undefined, Error, LoginInfo, any>;
+declare function useSignIn(params?: Props$3): _tanstack_react_query.UseMutateFunction<SignInResponse$1 | undefined, Error, LoginInfo, any>;
 
 type Props$2 = ButtonProps & ComponentFetchProps & {
     redirect?: boolean;
@@ -417,6 +453,11 @@ declare const SessionContext: React__default.Context<{
     data: null | undefined;
     status: "unauthenticated" | "loading";
 } | undefined>;
+interface UseSessionOptions<R extends boolean> {
+    required: R;
+    /** Defaults to `signIn` */
+    onUnauthenticated?: () => void;
+}
 /**
  * React Hook that gives you access
  * to the logged in user's session data.
@@ -527,7 +568,7 @@ declare function ResetPasswordForm(params: Params): React__default.JSX.Element;
 
 declare function useResetPassword(params?: Params): _tanstack_react_query.UseMutateFunction<Response, Error, MutateFnParams, unknown>;
 
-declare const Email: () => React.JSX.Element;
-declare const Password: () => React.JSX.Element;
+declare const Email: () => React$1.JSX.Element;
+declare const Password: () => React$1.JSX.Element;
 
 export { type ActiveSession, type AuthConfig, type AuthState, Authorizer, AzureSignInButton as Azure, DiscordSignInButton as Discord, Email, EmailSigningIn as EmailSignIn, EmailSignInButton, GitHubSignInButton as GitHub, GoogleSSOButton as Google, HubSpotSignInButton as HubSpot, type JWT, LinkedInSignInButton as LinkedIn, type Listener, type ListenerKeys, type ListenerParams, Password, ResetPasswordForm as PasswordResetForm, ResetPasswordForm$1 as PasswordResetRequestForm, type NonErrorSession as Session, SessionContext, SessionProvider, SigningIn as SignInForm, SignOutButton, SigningUp as SignUpForm, SignedIn, SignedOut, SlackSignInButton as Slack, TenantSelector, UserInfo, XSignInButton as X, auth, getCsrfToken, getProviders, getSession, signIn, signOut, useEmailSignIn, useMe, useResetPassword, useSession, useSignIn, useSignUp, useTenantId, useTenants };