@openfort/react 0.0.2 → 0.0.4

package/README.md

@@ -10,22 +10,18 @@
       Documentation
     </a>
     <span> | </span>
-    <a href="https://www.openfort.io/docs/reference/api/authentication">
-      API Docs
-    </a>
-    <span> | </span>
     <a href="https://x.com/openfort_hq">
       X
     </a>
-        <span> | </span>
-    <a href="https://create-next-app.openfort.xyz/">
+   <span> | </span>
+    <a href="https://playground.openfort.io/">
       Demo
     </a>
   </h4>
 </div>
 
 
-# Openfort Kit
+# Openfort React SDK
 
 [![Downloads](https://img.shields.io/npm/dm/@openfort/react.svg)](https://www.npmjs.com/package/@openfort/react)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
@@ -48,29 +44,29 @@ and much more...
 
 ### New app
 
-Get started with `create` Openfortkit + [wagmi](https://wagmi.sh/) + [viem](https://viem.sh) project by running one of the following in your terminal:
+Get started with `create` Openfort + [wagmi](https://wagmi.sh/) + [viem](https://viem.sh) project by running one of the following in your terminal:
 
 #### npm
 
 ```sh
-npx create openfortkit
+npx create openfort
 ```
 
 #### yarn
 
 ```sh
-yarn create openfortkit
+yarn create openfort
 ```
 
 #### pnpm
 
 ```sh
-pnpm create openfortkit
+pnpm create openfort
 ```
 
-### Import `OpenfortKit` to your project
+### Import `Openfort` to your project
 
-Add OpenfortKit to your already existing project.
+Add Openfort to your already existing project.
 
 #### npm
 
@@ -90,25 +86,21 @@ yarn add @openfort/react @tanstack/react-query wagmi viem
 pnpm add @openfort/react @tanstack/react-query wagmi viem
 ```
 
-## Documentation
-
-You can find the full OpenfortKit documentation in the Family docs [here]().
-
 ## Examples
 
-There are various runnable examples included in this repository in the [examples folder](https://github.com/openfort-xyz/openfort-kit/tree/main/examples):
+There are various runnable examples included in this repository in the [examples folder](https://github.com/openfort-xyz/openfort-react/tree/main/examples):
 
-- [Create React App Example (TypeScript)](https://github.com/openfort-xyz/openfort-kit/tree/main/examples/cra)
-- [Next.js Example (TypeScript)](https://github.com/openfort-xyz/openfort-kit/tree/main/examples/nextjs)
-- [Vite Example (TypeScript)](https://github.com/openfort-xyz/openfort-kit/tree/main/examples/vite)
+- [Create React App Example (TypeScript)](https://github.com/openfort-xyz/openfort-react/tree/main/examples/cra)
+- [Next.js Example (TypeScript)](https://github.com/openfort-xyz/openfort-react/tree/main/examples/nextjs)
+- [Vite Example (TypeScript)](https://github.com/openfort-xyz/openfort-react/tree/main/examples/vite)
 
 ### Running Examples Locally
 
-Clone the FortKit project and install the necessary dependencies:
+Clone the project and install the necessary dependencies:
 
 ```sh
-$ git clone git@github.com:openfort-xyz/openfort-kit.git
-$ cd openfort-kit
+$ git clone git@github.com:openfort-xyz/openfort-react.git
+$ cd openfort
 $ yarn install
 ```
 
@@ -128,8 +120,8 @@ $ yarn dev:cra # Create React App
 
 ## License
 
-See [LICENSE](https://github.com/openfort-xyz/openfort-kit/blob/main/LICENSE) for more information.
+See [LICENSE](https://github.com/openfort-xyz/openfort-react/blob/main/LICENSE) for more information.
 
 ## Credits
 
-OpenfortKit is a fork of [Connectkit](https://github.com/openfort-xyz/openfort-kit) developed by [Family](https://family.co). We're grateful to them for making Connectkit fast, beautiful and open-source.
+Openfort is a fork of [Connectkit](https://github.com/openfort-xyz/openfort-react) developed by [Family](https://family.co). We're grateful to them for making Connectkit fast, beautiful and open-source.

package/build/components/ConnectButton/index.d.ts

@@ -17,7 +17,7 @@ type ConnectButtonRendererProps = {
         ensName?: string;
     }) => React.ReactNode;
 };
-type OpenfortKitButtonProps = {
+type OpenfortButtonProps = {
     label?: string;
     showBalance?: boolean;
     showAvatar?: boolean;
@@ -26,8 +26,8 @@ type OpenfortKitButtonProps = {
     customTheme?: CustomTheme;
     onClick?: (open: () => void) => void;
 };
-export declare function OpenfortKitButton({ label, showBalance, showAvatar, theme, mode, customTheme, onClick, }: OpenfortKitButtonProps): import("react/jsx-runtime").JSX.Element | null;
-export declare namespace OpenfortKitButton {
+export declare function OpenfortButton({ label, showBalance, showAvatar, theme, mode, customTheme, onClick, }: OpenfortButtonProps): import("react/jsx-runtime").JSX.Element | null;
+export declare namespace OpenfortButton {
     var Custom: React.FC<ConnectButtonRendererProps>;
 }
 export {};

package/build/components/Openfort/{OpenfortKit.d.ts → OpenfortProvider.d.ts}

@@ -10,7 +10,7 @@ type OpenfortProviderProps = {
     walletConfig?: OpenfortWalletConfig;
 } & useConnectCallbackProps;
 /**
- * OpenfortProvider component provides context and configuration for OpenfortKit.
+ * OpenfortProvider component provides context and configuration for Openfort.
  * It must be used within a WagmiProvider.
  *
  * @param {React.ReactNode} children - The child components to be wrapped by the provider.

package/build/components/Openfort/context.d.ts

@@ -34,5 +34,5 @@ export type ContextValue = {
     uiConfig?: OpenfortUIOptionsExtended;
     walletConfig?: OpenfortWalletConfig;
 } & useConnectCallbackProps;
-export declare const OpenfortKitContext: React.Context<ContextValue | null>;
+export declare const Openfortcontext: React.Context<ContextValue | null>;
 export {};

package/build/components/Openfort/types.d.ts

@@ -1,7 +1,7 @@
 import React, { ReactNode } from 'react';
 import { CustomAvatarProps, CustomTheme, Languages, Mode, Theme } from '../../types';
 import { RecoveryMethod } from '@openfort/openfort-js';
-import { CoreOpenfortProviderProps } from '../../openfort/OpenfortProvider';
+import { CoreOpenfortProviderProps } from '../../openfort/CoreOpenfortProvider';
 export declare const routes: {
     readonly PROVIDERS: "providers";
     readonly SOCIAL_PROVIDERS: "socialProviders";
@@ -84,7 +84,7 @@ export type OpenfortOptions = {
     termsOfServiceUrl?: string;
     privacyPolicyUrl?: string;
     logo?: React.ReactNode;
-    openfortUrlOverrides?: CoreOpenfortProviderProps['overrides'];
+    overrides?: CoreOpenfortProviderProps['overrides'];
 };
 export type ConnectUIOptions = {
     theme?: Theme;

package/build/components/Openfort/useOpenfort.d.ts

@@ -0,0 +1 @@
+export declare const useOpenfort: () => import("./context").ContextValue;

package/build/hooks/openfort/auth/useAuthCallback.d.ts

@@ -1,39 +1,24 @@
 import { OpenfortHookOptions, OpenfortError } from "../../../types";
 import { AuthProvider } from "../../../components/Openfort/types";
-import { UserWallet } from "../useWallets";
-import { type AuthPlayerResponse as OpenfortUser } from '@openfort/openfort-js';
-type CallbackResult = StoreCredentialsResult | EmailVerificationResult;
-type EmailVerificationResult = {
-    type: "verifyEmail";
-    email?: string;
-    error?: OpenfortError;
-};
-type StoreCredentialsResult = {
+import { CreateWalletPostAuthOptions } from "./useCreateWalletPostAuth";
+import { EmailVerificationResult } from "./useEmailAuth";
+import { StoreCredentialsResult } from "./useOAuth";
+type CallbackResult = (StoreCredentialsResult & {
     type: "storeCredentials";
-    user?: OpenfortUser;
-    wallet?: UserWallet;
-    error?: OpenfortError;
-};
-type VerifyEmailOptions = {
-    email: string;
-    state: string;
-} & OpenfortHookOptions<EmailVerificationResult>;
-type StoreCredentialsOptions = {
-    player: string;
-    accessToken: string;
-    refreshToken: string;
-} & OpenfortHookOptions<StoreCredentialsResult>;
+}) | (EmailVerificationResult & {
+    type: "verifyEmail";
+});
 type UseAuthCallbackOptions = {
-    automaticallyHandleCallback?: boolean;
-} & OpenfortHookOptions<CallbackResult>;
-export declare const useAuthCallback: ({ automaticallyHandleCallback, ...hookOptions }?: UseAuthCallbackOptions) => {
+    enabled?: boolean;
+} & OpenfortHookOptions<CallbackResult> & CreateWalletPostAuthOptions;
+export declare const useAuthCallback: ({ enabled, ...hookOptions }?: UseAuthCallbackOptions) => {
+    email: string | null;
+    provider: AuthProvider | null;
+    verifyEmail: (options: import("./useEmailAuth").VerifyEmailOptions) => Promise<EmailVerificationResult>;
+    storeCredentials: ({ player, accessToken, refreshToken, ...options }: import("./useOAuth").StoreCredentialsOptions) => Promise<StoreCredentialsResult>;
     isLoading: boolean;
     isError: boolean;
     isSuccess: boolean;
     error: OpenfortError | null | undefined;
-    email: string | null;
-    provider: AuthProvider | null;
-    verifyEmail: ({ email, state, ...options }: VerifyEmailOptions) => Promise<EmailVerificationResult>;
-    storeCredentials: ({ player, accessToken, refreshToken, ...options }: StoreCredentialsOptions) => Promise<StoreCredentialsResult>;
 };
 export {};

package/build/hooks/openfort/auth/useCreateWalletPostAuth.d.ts

@@ -1,5 +1,16 @@
+export type CreateWalletPostAuthOptions = {
+    /**
+     * @default true
+     * It will log out the user if there is an error while trying to create a wallet (automatic recovery).
+     */
+    logoutOnError?: boolean;
+    /**
+     *
+     */
+    automaticRecovery?: boolean;
+};
 export declare const useCreateWalletPostAuth: () => {
-    tryUseWallet: () => Promise<{
+    tryUseWallet: ({ logoutOnError: signOutOnError, automaticRecovery }: CreateWalletPostAuthOptions) => Promise<{
         error?: import("../../..").OpenfortError;
         wallet?: import("../useWallets").UserWallet;
     }>;

package/build/hooks/openfort/auth/useEmailAuth.d.ts

@@ -1,5 +1,6 @@
 import { type AuthPlayerResponse as OpenfortUser } from '@openfort/openfort-js';
 import { OpenfortHookOptions, OpenfortError } from "../../../types";
+import { CreateWalletPostAuthOptions } from './useCreateWalletPostAuth';
 import { UserWallet } from '../useWallets';
 export type EmailAuthResult = {
     error?: OpenfortError;
@@ -11,13 +12,13 @@ export type SignInEmailOptions = {
     email: string;
     password: string;
     emailVerificationRedirectTo?: string;
-} & OpenfortHookOptions<EmailAuthResult>;
+} & OpenfortHookOptions<EmailAuthResult> & CreateWalletPostAuthOptions;
 export type SignUpEmailOptions = {
     email: string;
     password: string;
     name?: string;
     emailVerificationRedirectTo?: string;
-} & OpenfortHookOptions<EmailAuthResult>;
+} & OpenfortHookOptions<EmailAuthResult> & CreateWalletPostAuthOptions;
 export type RequestResetPasswordOptions = {
     email: string;
     emailVerificationRedirectTo?: string;
@@ -32,9 +33,17 @@ export type LinkEmailOptions = {
     password: string;
     emailVerificationRedirectTo?: string;
 } & OpenfortHookOptions<EmailAuthResult>;
+export type VerifyEmailOptions = {
+    email: string;
+    state: string;
+} & OpenfortHookOptions<EmailVerificationResult>;
+export type EmailVerificationResult = {
+    email?: string;
+    error?: OpenfortError;
+};
 export type UseEmailHookOptions = {
     emailVerificationRedirectTo?: string;
-} & OpenfortHookOptions<EmailAuthResult>;
+} & OpenfortHookOptions<EmailAuthResult | EmailVerificationResult> & CreateWalletPostAuthOptions;
 export declare const useEmailAuth: (hookOptions?: UseEmailHookOptions) => {
     requiresEmailVerification: boolean;
     isAwaitingInput: boolean;
@@ -44,6 +53,7 @@ export declare const useEmailAuth: (hookOptions?: UseEmailHookOptions) => {
     error: OpenfortError | null | undefined;
     signInEmail: (options: SignInEmailOptions) => Promise<EmailAuthResult>;
     signUpEmail: (options: SignUpEmailOptions) => Promise<EmailAuthResult>;
+    verifyEmail: (options: VerifyEmailOptions) => Promise<EmailVerificationResult>;
     linkEmail: (options: LinkEmailOptions) => Promise<EmailAuthResult>;
     requestResetPassword: (options: RequestResetPasswordOptions) => Promise<EmailAuthResult>;
     resetPassword: (options: ResetPasswordOptions) => Promise<EmailAuthResult>;

package/build/hooks/openfort/auth/useGuestAuth.d.ts

@@ -1,12 +1,13 @@
 import { type AuthPlayerResponse as OpenfortUser } from '@openfort/openfort-js';
 import { OpenfortHookOptions, OpenfortError } from "../../../types";
+import { CreateWalletPostAuthOptions } from "./useCreateWalletPostAuth";
 import { UserWallet } from "../useWallets";
 export type GuestHookResult = {
     error?: OpenfortError;
     user?: OpenfortUser;
     wallet?: UserWallet;
 };
-export type GuestHookOptions = OpenfortHookOptions<OpenfortUser>;
+export type GuestHookOptions = OpenfortHookOptions<GuestHookResult> & CreateWalletPostAuthOptions;
 export declare const useGuestAuth: (hookOptions?: GuestHookOptions) => {
     isLoading: boolean;
     isError: boolean;

package/build/hooks/openfort/auth/useOAuth.d.ts

@@ -1,15 +1,28 @@
-import { AuthProvider } from '../../../components/Openfort/types';
+import { OAuthProvider } from '@openfort/openfort-js';
 import { OpenfortHookOptions, OpenfortError } from '../../../types';
+import { CreateWalletPostAuthOptions } from './useCreateWalletPostAuth';
+import { UserWallet } from "../useWallets";
+import { type AuthPlayerResponse as OpenfortUser } from '@openfort/openfort-js';
 export type InitializeOAuthOptions = {
-    provider: AuthProvider;
+    provider: OAuthProvider;
     redirectTo?: string;
-} & OpenfortHookOptions;
-export type AuthHookOptions = {
-    redirectTo?: string;
-} & OpenfortHookOptions;
+} & OpenfortHookOptions<InitOAuthReturnType>;
 export type InitOAuthReturnType = {
     error?: OpenfortError;
 };
+export type StoreCredentialsResult = {
+    user?: OpenfortUser;
+    wallet?: UserWallet;
+    error?: OpenfortError;
+};
+export type StoreCredentialsOptions = {
+    player: string;
+    accessToken: string;
+    refreshToken: string;
+} & OpenfortHookOptions<StoreCredentialsResult> & CreateWalletPostAuthOptions;
+export type AuthHookOptions = {
+    redirectTo?: string;
+} & OpenfortHookOptions<StoreCredentialsResult | InitOAuthReturnType> & CreateWalletPostAuthOptions;
 export declare const useOAuth: (hookOptions?: AuthHookOptions) => {
     isLoading: boolean;
     isError: boolean;
@@ -17,4 +30,5 @@ export declare const useOAuth: (hookOptions?: AuthHookOptions) => {
     error: OpenfortError | null | undefined;
     initOAuth: (options: InitializeOAuthOptions) => Promise<InitOAuthReturnType>;
     linkOauth: (options: InitializeOAuthOptions) => Promise<InitOAuthReturnType>;
+    storeCredentials: ({ player, accessToken, refreshToken, ...options }: StoreCredentialsOptions) => Promise<StoreCredentialsResult>;
 };

package/build/hooks/openfort/useStatus.d.ts

@@ -1,4 +1,4 @@
-export declare enum OpenfortKitStatus {
+export declare enum OpenfortStatus {
     DISCONNECTED = 0,
     NEEDS_RECOVERY = 1,
     LOADING = 2,

package/build/hooks/openfort/useWallets.d.ts

@@ -1,15 +1,17 @@
+import { RecoveryMethod } from "@openfort/openfort-js";
 import { Hex } from "viem";
 import { Connector } from "wagmi";
 import { embeddedWalletId } from "../../constants/openfort";
 import { OpenfortError, OpenfortHookOptions } from "../../types";
 export type UserWallet = {
-    address?: `0x${string}`;
+    address?: Hex;
     connectorType?: string;
     walletClientType?: string;
     connector?: Connector;
     id: string;
     isAvailable: boolean;
-    isActive: boolean;
+    isActive?: boolean;
+    isConnecting?: boolean;
 };
 type SetActiveWalletResult = {
     error?: OpenfortError;
@@ -23,26 +25,35 @@ type SetActiveWalletOptions = ({
 } | {
     connector: typeof embeddedWalletId;
     password?: string;
+} | {
+    connector: Connector;
 })) & OpenfortHookOptions<SetActiveWalletResult>;
 type CreateWalletResult = SetActiveWalletResult;
 type CreateWalletOptions = {
     password?: string;
 } & OpenfortHookOptions<CreateWalletResult>;
+type RecoverEmbeddedWalletResult = SetActiveWalletResult;
+type SetRecoveryOptions = {
+    recoveryMethod: RecoveryMethod;
+    recoveryPassword?: string;
+} & OpenfortHookOptions<CreateWalletResult>;
 type WalletOptions = OpenfortHookOptions<SetActiveWalletResult | CreateWalletResult>;
 export declare function useWallets(hookOptions?: WalletOptions): {
     exportPrivateKey: () => Promise<string>;
-    isLoading: boolean;
+    error: OpenfortError | null | undefined;
     isError: boolean;
     isSuccess: boolean;
-    error: OpenfortError | null | undefined;
+    isCreating: boolean;
+    isConnecting: boolean;
     wallets: UserWallet[];
     availableWallets: import("../../wallets/useWallets").WalletProps[];
     activeWallet: UserWallet | undefined;
-    setActiveWallet: (options: SetActiveWalletOptions | string) => Promise<SetActiveWalletResult>;
+    setRecovery: (params: SetRecoveryOptions) => Promise<RecoverEmbeddedWalletResult>;
     createWallet: ({ password, ...options }?: CreateWalletOptions) => Promise<{
         error: OpenfortError;
     } | {
         wallet: UserWallet;
     }>;
+    setActiveWallet: (options: SetActiveWalletOptions | string) => Promise<SetActiveWalletResult>;
 };
 export {};

package/build/index.d.ts

@@ -1,17 +1,17 @@
-export { OPENFORTKIT_VERSION } from './version';
+export { OPENFORT_VERSION } from './version';
 export * from './types';
 export { default as getDefaultConfig } from './defaultConfig';
 export { default as getDefaultConnectors } from './defaultConnectors';
 export { wallets } from './wallets';
 export { AuthProvider, } from './components/Openfort/types';
-export { OpenfortKitContext, } from './components/Openfort/context';
-export { OpenfortProvider, } from './components/Openfort/OpenfortKit';
-export { OpenfortKitButton } from './components/ConnectButton';
+export { Openfortcontext, } from './components/Openfort/context';
+export { OpenfortProvider, } from './components/Openfort/OpenfortProvider';
+export { OpenfortButton } from './components/ConnectButton';
 export { default as Avatar } from './components/Common/Avatar';
 export { default as ChainIcon } from './components/Common/Chain';
 export { useChains } from './hooks/useChains';
 export { useChainIsSupported } from './hooks/useChainIsSupported';
-export { useStatus, OpenfortKitStatus } from './hooks/openfort/useStatus';
+export { useStatus, OpenfortStatus } from './hooks/openfort/useStatus';
 export { useUser } from './hooks/openfort/useUser';
 export { useUI } from "./hooks/openfort/useUI";
 export { useWallets, UserWallet } from "./hooks/openfort/useWallets";