@niledatabase/react 3.1.0-alpha.0 → 4.0.0-alpha.0

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import * as React$1 from 'react';
+import * as React from 'react';
 import React__default from 'react';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { QueryClient } from '@tanstack/react-query';
@@ -9,7 +9,6 @@ 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';
-import * as next_auth_providers from 'next-auth/providers';
 
 type EmailSignInInfo = SignInOptions;
 type SignInSuccess = (response: Response) => void;
@@ -31,7 +30,7 @@ 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> {
+interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement>, VariantProps<typeof buttonVariants> {
     asChild?: boolean;
     loading?: boolean;
 }
@@ -116,67 +115,6 @@ declare const XSignInButton: React__default.ForwardRefExoticComponent<ButtonProp
     init?: RequestInit;
 } & React__default.RefAttributes<HTMLButtonElement>>;
 
-type ComponentFetchProps = {
-    init?: RequestInit;
-};
-type PrefetchParams = {
-    baseUrl?: string;
-    disableQuery?: boolean;
-    init?: RequestInit;
-    client?: QueryClient;
-    fetchUrl?: string;
-};
-
-type SignUpInfo = CreateBasicUserRequest & {
-    tenantId?: string;
-    fetchUrl?: string;
-    callbackUrl?: string;
-    newTenantName?: string;
-};
-type AllowedAny$2 = any;
-type Props$3 = PrefetchParams & {
-    onSuccess?: (response: Response, formValues: SignUpInfo) => void;
-    onError?: (e: Error, info: SignUpInfo) => void;
-    beforeMutate?: (data: AllowedAny$2) => AllowedAny$2;
-    buttonText?: string;
-    callbackUrl?: string;
-    createTenant?: string | boolean;
-    className?: string;
-};
-
-declare function SigningUp({ className, ...props }: Props$3): React__default.JSX.Element;
-
-declare function useSignUp<T extends SignUpInfo>(params: Props$3, client?: QueryClient): _tanstack_react_query.UseMutateFunction<Response, Error, SignUpInfo, unknown>;
-
-type AllowedAny$1 = any;
-type LoginInfo = {
-    email: string;
-    password: string;
-};
-type LoginSuccess = (response: AllowedAny$1, formValues: LoginInfo, ...args: AllowedAny$1) => void;
-interface Props$2 {
-    beforeMutate?: (data: AllowedAny$1) => AllowedAny$1;
-    onSuccess?: LoginSuccess;
-    onError?: (error: Error, data: AllowedAny$1) => void;
-    callbackUrl?: string;
-    client?: QueryClient;
-    className?: string;
-    init?: RequestInit;
-    baseUrl?: string;
-    fetchUrl?: string;
-}
-
-declare function SigningIn({ className, ...props }: Props$2): React__default.JSX.Element;
-
-declare function useSignIn(params?: Props$2): _tanstack_react_query.UseMutateFunction<next_auth_react.SignInResponse | undefined, Error, LoginInfo, any>;
-
-declare const SignOutButton: React__default.ForwardRefExoticComponent<ButtonProps & ComponentFetchProps & {
-    redirect?: boolean;
-    callbackUrl?: string;
-    buttonText?: string;
-    baseUrl?: string;
-} & React__default.RefAttributes<HTMLButtonElement>>;
-
 type JWT = {
     email: string;
     sub: string;
@@ -216,10 +154,24 @@ type ListenerParams = {
 };
 type Listener = (callback: ListenerParams) => void;
 type ListenerKeys = 'basePath' | 'baseUrl' | 'lastSync' | 'getSession' | 'session' | 'loading';
-type AuthConfig = {
-    basePath: string;
-    baseUrl: string;
-    listenerKeys: Array<ListenerKeys>;
+type AuthConfig = Config & {
+    listenerKeys?: Array<ListenerKeys>;
+};
+type Config = {
+    basePath?: string;
+    baseUrl?: string;
+    init?: RequestInit;
+};
+type PartialAuthorizer = null | {
+    state?: {
+        baseUrl?: string;
+        session?: {
+            user?: {
+                email?: string | undefined;
+            };
+        };
+    };
+    requestInit?: RequestInit | undefined;
 };
 
 type WarningCode = 'NEXTAUTH_URL' | 'NO_SECRET' | 'TWITTER_OAUTH_2_BETA' | 'DEBUG_ENABLED';
@@ -243,9 +195,6 @@ interface LoggerInstance extends Record<string, (...args: any) => any> {
     debug: (code: string, metadata: unknown) => void;
 }
 
-type FetchInit = CtxOrReq & {
-    init?: RequestInit;
-};
 type GetSessionParams = CtxOrReq & {
     event?: 'storage' | 'timer' | 'hidden' | string;
     triggerEvent?: boolean;
@@ -253,47 +202,28 @@ type GetSessionParams = CtxOrReq & {
     baseUrl?: string;
     init?: RequestInit;
 };
-interface SessionProviderProps {
-    children: React.ReactNode;
-    session?: NileSession;
-    baseUrl?: string;
-    basePath?: string;
-    /**
-     * A time interval (in seconds) after which the session will be re-fetched.
-     * If set to `0` (default), the session is not polled.
-     */
-    refetchInterval?: number;
-    /**
-     * `SessionProvider` automatically refetches the session when the user switches between windows.
-     * This option activates this behaviour if set to `true` (default).
-     */
-    refetchOnWindowFocus?: boolean;
-    /**
-     * Set to `false` to stop polling when the device has no internet access offline (determined by `navigator.onLine`)
-     *
-     * [`navigator.onLine` documentation](https://developer.mozilla.org/en-US/docs/Web/API/NavigatorOnLine/onLine)
-     */
-    refetchWhenOffline?: false;
-}
 declare enum State {
     SESSION = "getSession"
 }
 declare class Authorizer {
     state: AuthState;
     logger: LoggerInstance;
-    init?: RequestInit;
+    requestInit?: RequestInit;
     addListener: (cb: Listener) => void;
     removeListener: (cb: Listener) => void;
     status: null | State;
     constructor(config?: AuthConfig);
     sync(event?: 'storage' | 'timer' | 'hidden' | 'poll' | 'visibilitychange'): Promise<void>;
     set baseUrl(val: string);
+    get baseUrl(): string;
+    configure(config?: Config): this;
+    sanitize(): PartialAuthorizer;
     initialize(params?: {
         baseUrl?: string;
         session?: NonErrorSession | null | undefined;
     }): Promise<void>;
     get apiBaseUrl(): string;
-    fetchData<T = any>(path: string, { ctx, req, init }?: FetchInit): Promise<T | undefined>;
+    fetchData<T = any>(url: string, init?: RequestInit): Promise<T | undefined>;
     fetchFormData<T = {
         url: string;
     }>(url: string, init: RequestInit): Promise<{
@@ -302,21 +232,175 @@ declare class Authorizer {
         ok: boolean;
         url: string;
     } | undefined>;
-    getProviders(params?: FetchInit): Promise<Record<LiteralUnion<BuiltInProviderType>, ClientSafeProvider> | undefined>;
-    getCsrfToken(params?: FetchInit): Promise<string | undefined>;
+    getProviders(): Promise<Record<LiteralUnion<BuiltInProviderType>, ClientSafeProvider> | undefined>;
+    getCsrfToken(): Promise<string | undefined>;
     getSession(params?: GetSessionParams): Promise<NonErrorSession>;
-    refreshSession(params: any): Promise<NonErrorSession>;
+    refreshSession(): Promise<NonErrorSession>;
     signOut<R extends boolean = true>(options?: SignOutParams<R> & {
         baseUrl?: string;
-        init?: RequestInit;
+        auth?: Authorizer | PartialAuthorizer;
         fetchUrl?: string;
     }): Promise<R extends true ? undefined : SignOutResponse>;
     signIn<P extends RedirectableProviderType | undefined = undefined>(provider?: LiteralUnion<P extends RedirectableProviderType ? P | BuiltInProviderType : BuiltInProviderType>, options?: SignInOptions & {
         baseUrl?: string;
         init?: ResponseInit;
         fetchUrl?: string;
+        auth?: Authorizer | PartialAuthorizer;
     }, authorizationParams?: SignInAuthorizationParams): Promise<P extends RedirectableProviderType ? SignInResponse | undefined : undefined>;
+    signUp(options: {
+        baseUrl?: string;
+        init?: ResponseInit;
+        fetchUrl?: string;
+        newTenantName?: string;
+        createTenant?: string | boolean;
+        email: string;
+        password: string;
+        auth?: Authorizer | PartialAuthorizer;
+        tenantId?: string;
+        callbackUrl?: string;
+        redirect?: boolean;
+    }): Promise<any>;
+}
+declare const authorizer: Authorizer;
+declare const auth: Authorizer;
+declare const getSession: (params?: GetSessionParams) => Promise<NonErrorSession>;
+declare const getCsrfToken: () => Promise<string | undefined>;
+declare const getProviders: () => Promise<Record<LiteralUnion<BuiltInProviderType>, ClientSafeProvider> | undefined>;
+declare const signOut: typeof authorizer.signOut;
+declare const signIn: typeof authorizer.signIn;
+
+type ComponentFetchProps = {
+    auth?: Authorizer | PartialAuthorizer;
+    init?: RequestInit;
+};
+type PrefetchParams = {
+    baseUrl?: string;
+    disableQuery?: boolean;
+    init?: RequestInit;
+    client?: QueryClient;
+    fetchUrl?: string;
+};
+
+type SignUpInfo = CreateBasicUserRequest & {
+    tenantId?: string;
+    fetchUrl?: string;
+    callbackUrl?: string;
+    newTenantName?: string;
+};
+type AllowedAny$2 = any;
+type Props$3 = PrefetchParams & {
+    onSuccess?: (response: Response, formValues: SignUpInfo) => void;
+    onError?: (e: Error, info: SignUpInfo) => void;
+    beforeMutate?: (data: AllowedAny$2) => AllowedAny$2;
+    buttonText?: string;
+    callbackUrl?: string;
+    createTenant?: string | boolean;
+    className?: string;
+    redirect?: boolean;
+};
+
+declare function SigningUp({ className, ...props }: Props$3): React__default.JSX.Element;
+
+declare function useSignUp<T extends SignUpInfo>(params: Props$3, client?: QueryClient): _tanstack_react_query.UseMutateFunction<any, Error, SignUpInfo, unknown>;
+
+type AllowedAny$1 = any;
+type LoginInfo = {
+    email: string;
+    password: string;
+};
+type LoginSuccess = (response: AllowedAny$1, formValues: LoginInfo, ...args: AllowedAny$1) => void;
+type Props$2 = ComponentFetchProps & {
+    beforeMutate?: (data: AllowedAny$1) => AllowedAny$1;
+    onSuccess?: LoginSuccess;
+    onError?: (error: Error, data: AllowedAny$1) => void;
+    callbackUrl?: string;
+    client?: QueryClient;
+    className?: string;
+    baseUrl?: string;
+    fetchUrl?: string;
+};
+
+declare function SigningIn({ className, ...props }: Props$2): React__default.JSX.Element;
+
+declare function useSignIn(params?: Props$2): _tanstack_react_query.UseMutateFunction<next_auth_react.SignInResponse | undefined, Error, LoginInfo, any>;
+
+declare const SignOutButton: React__default.ForwardRefExoticComponent<ButtonProps & ComponentFetchProps & {
+    redirect?: boolean;
+    callbackUrl?: string;
+    buttonText?: string;
+    baseUrl?: string;
+} & React__default.RefAttributes<HTMLButtonElement>>;
+
+interface SessionProviderProps {
+    children: React__default.ReactNode;
+    session?: NileSession;
+    baseUrl?: string;
+    basePath?: string;
+    /**
+     * A time interval (in seconds) after which the session will be re-fetched.
+     * If set to `0` (default), the session is not polled.
+     */
+    refetchInterval?: number;
+    /**
+     * `SessionProvider` automatically refetches the session when the user switches between windows.
+     * This option activates this behaviour if set to `true` (default).
+     */
+    refetchOnWindowFocus?: boolean;
+    /**
+     * Set to `false` to stop polling when the device has no internet access offline (determined by `navigator.onLine`)
+     *
+     * [`navigator.onLine` documentation](https://developer.mozilla.org/en-US/docs/Web/API/NavigatorOnLine/onLine)
+     */
+    refetchWhenOffline?: false;
 }
+type UpdateSession = (data?: any) => Promise<NonErrorSession | null | undefined>;
+type SessionContextValue<R extends boolean = false> = R extends true ? {
+    update: UpdateSession;
+    data: NonErrorSession;
+    status: 'authenticated';
+} | {
+    update: UpdateSession;
+    data: null | undefined;
+    status: 'loading';
+} : {
+    update: UpdateSession;
+    data: NonErrorSession;
+    status: 'authenticated';
+} | {
+    update: UpdateSession;
+    data: null | undefined;
+    status: 'unauthenticated' | 'loading';
+};
+declare const SessionContext: React__default.Context<{
+    update: UpdateSession;
+    data: NonErrorSession;
+    status: "authenticated";
+} | {
+    update: UpdateSession;
+    data: null | undefined;
+    status: "unauthenticated" | "loading";
+} | undefined>;
+/**
+ * React Hook that gives you access
+ * to the logged in user's session data.
+ *
+ * [Documentation](https://next-auth.js.org/getting-started/client#usesession)
+ */
+declare function useSession<R extends boolean>(options?: UseSessionOptions<R>): SessionContextValue<R>;
+/**
+ * Signs the user out, by removing the session cookie.
+ * Automatically adds the CSRF token to the request.
+ *
+ * [Documentation](https://next-auth.js.org/getting-started/client#signout)
+ */
+/**
+ * Provider to wrap the app in to make session data available globally.
+ * Can also be used to throttle the number of requests to the endpoint
+ * `/api/auth/session`.
+ *
+ * [Documentation](https://next-auth.js.org/getting-started/client#sessionprovider)
+ */
+declare function SessionProvider(props: SessionProviderProps): React__default.JSX.Element;
 
 declare function SignedIn({ children, session: startSession, ...props }: SessionProviderProps & {
     className?: string;
@@ -405,63 +489,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$1.JSX.Element;
-declare const Password: () => React$1.JSX.Element;
-
-declare const authorizer: Authorizer;
-declare const auth: Authorizer;
-declare const getSession: (params?: GetSessionParams) => Promise<NonErrorSession>;
-declare const getCsrfToken: (params?: FetchInit) => Promise<string | undefined>;
-declare const getProviders: (params?: FetchInit) => Promise<Record<next_auth_react.LiteralUnion<next_auth_providers.BuiltInProviderType>, next_auth_react.ClientSafeProvider> | undefined>;
-declare const signOut: typeof authorizer.signOut;
-declare const signIn: typeof authorizer.signIn;
-type UpdateSession = (data?: any) => Promise<NonErrorSession | null | undefined>;
-type SessionContextValue<R extends boolean = false> = R extends true ? {
-    update: UpdateSession;
-    data: NonErrorSession;
-    status: 'authenticated';
-} | {
-    update: UpdateSession;
-    data: null | undefined;
-    status: 'loading';
-} : {
-    update: UpdateSession;
-    data: NonErrorSession;
-    status: 'authenticated';
-} | {
-    update: UpdateSession;
-    data: null | undefined;
-    status: 'unauthenticated' | 'loading';
-};
-declare const SessionContext: React__default.Context<{
-    update: UpdateSession;
-    data: NonErrorSession;
-    status: "authenticated";
-} | {
-    update: UpdateSession;
-    data: null | undefined;
-    status: "unauthenticated" | "loading";
-} | undefined>;
-/**
- * React Hook that gives you access
- * to the logged in user's session data.
- *
- * [Documentation](https://next-auth.js.org/getting-started/client#usesession)
- */
-declare function useSession<R extends boolean>(options?: UseSessionOptions<R>): SessionContextValue<R>;
-/**
- * Signs the user out, by removing the session cookie.
- * Automatically adds the CSRF token to the request.
- *
- * [Documentation](https://next-auth.js.org/getting-started/client#signout)
- */
-/**
- * Provider to wrap the app in to make session data available globally.
- * Can also be used to throttle the number of requests to the endpoint
- * `/api/auth/session`.
- *
- * [Documentation](https://next-auth.js.org/getting-started/client#sessionprovider)
- */
-declare function SessionProvider(props: SessionProviderProps): React__default.JSX.Element;
+declare const Email: () => React.JSX.Element;
+declare const Password: () => React.JSX.Element;
 
-export { AzureSignInButton as Azure, DiscordSignInButton as Discord, Email, EmailSigningIn as EmailSignIn, EmailSignInButton, GitHubSignInButton as GitHub, GoogleSSOButton as Google, HubSpotSignInButton as HubSpot, LinkedInSignInButton as LinkedIn, Password, ResetPasswordForm as PasswordResetForm, ResetPasswordForm$1 as PasswordResetRequestForm, 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 };
+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 };