@fourt/sdk 1.0.0 → 1.1.1

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { getWebAuthnAttestation, TSignedRequest, TurnkeyClient } from '@turnkey/http';
 import { U as User, A as AtLeastOne } from './index-Cy_WMhHm.js';
+import { getWebAuthnAttestation, TSignedRequest, TurnkeyClient } from '@turnkey/http';
 import * as viem_account_abstraction from 'viem/account-abstraction';
 import * as viem from 'viem';
 import { LocalAccount, Client, SignableMessage, Hex, TypedData, TypedDataDefinition, SerializeTransactionFn, TransactionSerializable, IsNarrowable, TransactionSerialized, GetTransactionType } from 'viem';
@@ -7,7 +7,8 @@ import { toLightSmartAccount } from 'permissionless/accounts';
 
 declare enum SessionType {
     Email = "email",
-    Passkeys = "passkeys"
+    Passkeys = "passkeys",
+    OAuth = "oauth"
 }
 /**
  * A store for the session state.
@@ -196,11 +197,26 @@ type EmailInitializeAuthParams = {
     redirectUrl: string;
     expirationSeconds?: number;
 };
-type EmailCompleteAuthWithBundleParams = {
+type CompleteAuthWithBundleParams = {
     bundle: string;
     subOrgId: string;
+    sessionType: SessionType;
     isNewUser?: boolean;
 };
+type OAuthConfiguration = {
+    common: {
+        redirectUrl: string;
+    };
+    google?: {
+        id: string;
+    };
+    facebook?: {
+        id: string;
+    };
+    apple?: {
+        id: string;
+    };
+};
 type WebSignerClientConstructorParams = SignerClientInheritedConstructorParams<{
     webauthn: {
         rpId: string;
@@ -209,18 +225,20 @@ type WebSignerClientConstructorParams = SignerClientInheritedConstructorParams<{
         iframeElementId?: string;
         iframeContainerId?: string;
     };
+    oauth?: OAuthConfiguration;
 }>;
 /**
  * A signer client for web applications.
  */
 declare class WebSignerClient extends SignerClient {
     private readonly _stampers;
+    readonly oauthConfiguration: WebSignerClientConstructorParams['oauth'];
     /**
      * Initializes a new instance of the `WebSignerClient` class.
      *
      * @param {WebSignerClientConstructorParams} params params for the constructor
      */
-    constructor({ configuration, webauthn, iframe, }: WebSignerClientConstructorParams);
+    constructor({ configuration, webauthn, iframe, oauth, }: WebSignerClientConstructorParams);
     signRawMessage<Into extends string>(msg: string): Promise<Into>;
     logout(): Promise<void>;
     /**
@@ -240,6 +258,7 @@ declare class WebSignerClient extends SignerClient {
      * @param {EmailInitializeAuthParams} params Params needed for the initialization of the auth process
      */
     emailAuth(params: EmailInitializeAuthParams): Promise<void>;
+    getIframePublicKey(): Promise<string>;
     /**
      * Signs in a user with email.
      *
@@ -249,9 +268,9 @@ declare class WebSignerClient extends SignerClient {
     /**
      * Completes the authentication process with a credential bundle.
      *
-     * @param {EmailCompleteAuthWithBundleParams} params params for the completion of the auth process
+     * @param {CompleteAuthWithBundleParams} params params for the completion of the auth process
      */
-    completeAuthWithBundle({ bundle, subOrgId, }: EmailCompleteAuthWithBundleParams): Promise<void>;
+    completeAuthWithBundle({ bundle, subOrgId, sessionType, }: CompleteAuthWithBundleParams): Promise<void>;
     /**
      * Creates a passkey account using the webauthn stamper.
      *
@@ -274,56 +293,6 @@ declare class WebSignerClient extends SignerClient {
     private _initIframeStamper;
 }
 
-type CurrentUserToLightSmartAccountParams = {
-    owner: LocalAccount;
-    client: Client;
-};
-declare class ViemModule {
-    private readonly _signerClient;
-    constructor(_signerClient: SignerClient);
-    toLocalAccount(): Promise<LocalAccount>;
-    toSmartAccount({ client, owner, }: CurrentUserToLightSmartAccountParams): ReturnType<typeof toLightSmartAccount<'0.7'>>;
-    getPaymasterClient(): Promise<{
-        account: undefined;
-        batch?: viem.ClientConfig["batch"] | undefined;
-        cacheTime: number;
-        ccipRead?: viem.ClientConfig["ccipRead"] | undefined;
-        chain: undefined;
-        key: string;
-        name: string;
-        pollingInterval: number;
-        request: viem.EIP1193RequestFn<viem.PaymasterRpcSchema>;
-        transport: viem.TransportConfig<"http", viem.EIP1193RequestFn> & {
-            fetchOptions?: viem.HttpTransportConfig["fetchOptions"] | undefined;
-            url?: string | undefined;
-        };
-        type: string;
-        uid: string;
-        getPaymasterData: (parameters: viem_account_abstraction.GetPaymasterDataParameters) => Promise<viem_account_abstraction.GetPaymasterDataReturnType>;
-        getPaymasterStubData: (parameters: viem_account_abstraction.GetPaymasterStubDataParameters) => Promise<viem_account_abstraction.GetPaymasterStubDataReturnType>;
-        extend: <const client extends {
-            [x: string]: unknown;
-            account?: undefined;
-            batch?: undefined;
-            cacheTime?: undefined;
-            ccipRead?: undefined;
-            chain?: undefined;
-            key?: undefined;
-            name?: undefined;
-            pollingInterval?: undefined;
-            request?: undefined;
-            transport?: undefined;
-            type?: undefined;
-            uid?: undefined;
-        } & viem.ExactPartial<Pick<viem.PublicActions<viem.HttpTransport, undefined, undefined>, "call" | "createContractEventFilter" | "createEventFilter" | "estimateContractGas" | "estimateGas" | "getBlock" | "getBlockNumber" | "getChainId" | "getContractEvents" | "getEnsText" | "getFilterChanges" | "getGasPrice" | "getLogs" | "getTransaction" | "getTransactionCount" | "getTransactionReceipt" | "prepareTransactionRequest" | "readContract" | "sendRawTransaction" | "simulateContract" | "uninstallFilter" | "watchBlockNumber" | "watchContractEvent"> & Pick<viem.WalletActions<undefined, undefined>, "sendTransaction" | "writeContract">>>(fn: (client: Client<viem.HttpTransport, undefined, undefined, viem.PaymasterRpcSchema, viem_account_abstraction.PaymasterActions>) => client) => Client<viem.HttpTransport, undefined, undefined, viem.PaymasterRpcSchema, { [K in keyof client]: client[K]; } & viem_account_abstraction.PaymasterActions>;
-    }>;
-    signMessage(msg: SignableMessage): Promise<Hex>;
-    signTypedData<TTypedData extends TypedData | Record<string, unknown>, TPrimaryType extends keyof TTypedData | 'EIP712Domain' = keyof TTypedData>(params: TypedDataDefinition<TTypedData, TPrimaryType>): Promise<Hex>;
-    signTransaction<serializer extends SerializeTransactionFn<TransactionSerializable> = SerializeTransactionFn<TransactionSerializable>, transaction extends Parameters<serializer>[0] = Parameters<serializer>[0]>(transaction: transaction, options?: {
-        serializer?: serializer | undefined;
-    } | undefined): Promise<IsNarrowable<TransactionSerialized<GetTransactionType<transaction>>, Hex> extends true ? TransactionSerialized<GetTransactionType<transaction>> : Hex>;
-}
-
 /**
  * A module for interacting with the Email authentication methods.
  * Available through the `auth.email` property on a `FourtWebSigner` instance.
@@ -341,10 +310,10 @@ declare class EmailModule {
     /**
      * Completes authentication with bundle after user receives the bundle and subOrgId as URL params.
      *
-     * @param params {EmailCompleteAuthWithBundleParams} params received as URL params necessary to complete authentication process.
+     * @param params {CompleteAuthWithBundleParams} params received as URL params necessary to complete authentication process.
      * @returns {Promise<void>} promise that completes the authentication process.
      */
-    complete(params: EmailCompleteAuthWithBundleParams): Promise<void>;
+    complete(params: Pick<CompleteAuthWithBundleParams, 'subOrgId' | 'bundle'>): Promise<void>;
 }
 
 /**
@@ -363,6 +332,48 @@ declare class PasskeysModule {
     signIn(params: WebauthnSignInParams): Promise<void>;
 }
 
+declare class GoogleModule {
+    private readonly _webSignerClient;
+    constructor(_webSignerClient: WebSignerClient);
+    /**
+     *
+     * @returns
+     */
+    init(): Promise<string>;
+}
+
+declare class FacebookModule {
+    private readonly _webSignerClient;
+    constructor(_webSignerClient: WebSignerClient);
+    init(): Promise<string>;
+}
+
+declare class AppleModule {
+    private readonly _webSignerClient;
+    constructor(_webSignerClient: WebSignerClient);
+    /**
+     *
+     * @returns
+     */
+    init(): Promise<string>;
+}
+
+type CompleteParams = {
+    bundle: string;
+    subOrgId: string;
+};
+declare class OAuthModule {
+    private readonly _webSignerClient;
+    private readonly _googleModule;
+    private readonly _facebookModule;
+    private readonly _appleModule;
+    constructor(_webSignerClient: WebSignerClient);
+    get google(): GoogleModule;
+    get facebook(): FacebookModule;
+    get apple(): AppleModule;
+    complete({ bundle, subOrgId }: CompleteParams): Promise<void>;
+}
+
 /**
  * A module for interacting with the authentication methods.
  * Available through the `auth` property on a `FourtWebSigner` instance.
@@ -371,6 +382,7 @@ declare class AuthModule {
     private readonly _webSignerClient;
     private readonly _passkeys;
     private readonly _email;
+    private readonly _oauth;
     /**
      * Initializes a new instance of the `AuthModule` class.
      *
@@ -385,6 +397,7 @@ declare class AuthModule {
      * A module for interacting with the Passkeys authentication methods.
      */
     get email(): EmailModule;
+    get oauth(): OAuthModule;
 }
 
 /**
@@ -413,9 +426,59 @@ declare class UserModule {
     logout(): Promise<void>;
 }
 
+type CurrentUserToLightSmartAccountParams = {
+    owner: LocalAccount;
+    client: Client;
+};
+declare class ViemModule {
+    private readonly _signerClient;
+    constructor(_signerClient: SignerClient);
+    toLocalAccount(): Promise<LocalAccount>;
+    toSmartAccount({ client, owner, }: CurrentUserToLightSmartAccountParams): ReturnType<typeof toLightSmartAccount<'0.7'>>;
+    getPaymasterClient(): Promise<{
+        account: undefined;
+        batch?: viem.ClientConfig["batch"] | undefined;
+        cacheTime: number;
+        ccipRead?: viem.ClientConfig["ccipRead"] | undefined;
+        chain: undefined;
+        key: string;
+        name: string;
+        pollingInterval: number;
+        request: viem.EIP1193RequestFn<viem.PaymasterRpcSchema>;
+        transport: viem.TransportConfig<"http", viem.EIP1193RequestFn> & {
+            fetchOptions?: viem.HttpTransportConfig["fetchOptions"] | undefined;
+            url?: string | undefined;
+        };
+        type: string;
+        uid: string;
+        getPaymasterData: (parameters: viem_account_abstraction.GetPaymasterDataParameters) => Promise<viem_account_abstraction.GetPaymasterDataReturnType>;
+        getPaymasterStubData: (parameters: viem_account_abstraction.GetPaymasterStubDataParameters) => Promise<viem_account_abstraction.GetPaymasterStubDataReturnType>;
+        extend: <const client extends {
+            [x: string]: unknown;
+            account?: undefined;
+            batch?: undefined;
+            cacheTime?: undefined;
+            ccipRead?: undefined;
+            chain?: undefined;
+            key?: undefined;
+            name?: undefined;
+            pollingInterval?: undefined;
+            request?: undefined;
+            transport?: undefined;
+            type?: undefined;
+            uid?: undefined;
+        } & viem.ExactPartial<Pick<viem.PublicActions<viem.HttpTransport, undefined, undefined>, "call" | "createContractEventFilter" | "createEventFilter" | "estimateContractGas" | "estimateGas" | "getBlock" | "getBlockNumber" | "getChainId" | "getContractEvents" | "getEnsText" | "getFilterChanges" | "getGasPrice" | "getLogs" | "getTransaction" | "getTransactionCount" | "getTransactionReceipt" | "prepareTransactionRequest" | "readContract" | "sendRawTransaction" | "simulateContract" | "uninstallFilter" | "watchBlockNumber" | "watchContractEvent"> & Pick<viem.WalletActions<undefined, undefined>, "sendTransaction" | "writeContract">>>(fn: (client: Client<viem.HttpTransport, undefined, undefined, viem.PaymasterRpcSchema, viem_account_abstraction.PaymasterActions>) => client) => Client<viem.HttpTransport, undefined, undefined, viem.PaymasterRpcSchema, { [K in keyof client]: client[K]; } & viem_account_abstraction.PaymasterActions>;
+    }>;
+    signMessage(msg: SignableMessage): Promise<Hex>;
+    signTypedData<TTypedData extends TypedData | Record<string, unknown>, TPrimaryType extends keyof TTypedData | 'EIP712Domain' = keyof TTypedData>(params: TypedDataDefinition<TTypedData, TPrimaryType>): Promise<Hex>;
+    signTransaction<serializer extends SerializeTransactionFn<TransactionSerializable> = SerializeTransactionFn<TransactionSerializable>, transaction extends Parameters<serializer>[0] = Parameters<serializer>[0]>(transaction: transaction, options?: {
+        serializer?: serializer | undefined;
+    } | undefined): Promise<IsNarrowable<TransactionSerialized<GetTransactionType<transaction>>, Hex> extends true ? TransactionSerialized<GetTransactionType<transaction>> : Hex>;
+}
+
 type FourtWebSignerConstructorParams = {
     configuration: SignerClientConstructorParams['configuration'];
-    auth: Pick<WebSignerClientConstructorParams, 'webauthn' | 'iframe'>;
+    auth: Pick<WebSignerClientConstructorParams, 'webauthn' | 'iframe' | 'oauth'>;
 };
 /**
  * A client for interacting with the Fourt Web Signer.
@@ -444,7 +507,7 @@ declare class FourtWebSigner {
      *
      * @param {FourtWebSignerConstructorParams} params the required parameters to initialize the client
      */
-    constructor({ configuration, auth: { webauthn, iframe }, }: FourtWebSignerConstructorParams);
+    constructor({ configuration, auth: { webauthn, iframe, oauth }, }: FourtWebSignerConstructorParams);
     /**
      * A module for interacting with the Viem library.
      */